Separate parsing and processing of options.

$:.unshift File.dirname(File.dirname(__FILE__)) + "/lib"

require 'jsduck/app'

require 'jsduck/options/manager'

require 'jsduck/options/parser'

require 'jsduck/options/processor'

opts = JsDuck::Options::Manager.new

exit_code = JsDuck::App.new(opts.parse(ARGV)).run

opts = JsDuck::Options::Parser.new.parse(ARGV)

JsDuck::Options::Processor.new.process!(opts)

exit_code = JsDuck::App.new(opts).run

exit exit_code

require 'optparse'

module JsDuck

  module Options

    # JSDuck version of OptionParser

    #

    # Enhanced with ability to output options help in two ways:

    #

    # - short list of all options (with the built-in #help method)

    # - long description of one option (with the added #help_single method)

    #

    class HelpfulParser < ::OptionParser

      def initialize

        @full_options_index = {}

        super

      end

      # Override the #on method to do some pre-processing on its

      # parameters before passing them to the original #on method.

      #

      # Options are defined as usual:

      #

      #     opts.on("-v", "--version", Type, "First line of description.",

      #             "Second line of description.",

      #             "Third line of description.")

      #

      # But only the first line of description will be passed to

      # original #on method - meaning that #help method will also only

      # list this first line.

      #

      # The remaining lines are saved to a separate place and can be

      # retrieved through asking for full docs for an option with

      # #help_single method.

      #

      def on(*opts, &block)

        core = []

        keys = []

        desc = []

        desc_started = false

        opts.each do |o|

          if desc_started

            desc << o

          elsif String === o

            if o =~ /^-/

              core << o

              keys << o

            else

              core << o

              desc << o

              desc_started = true

            end

          else

            core << o

          end

        end

        full = {:keys => keys, :desc => desc}

        keys.each do |op|

          each_index_key(op) {|k| @full_options_index[k] = full }

        end

        super(*core, &block)

      end

      # Helper that turns option name like --images=PATH into list of

      # keys by which we index the options:

      #

      #     "--images=PATH" --> ["--images", "images"]

      #

      # For options containing "[no-]" all the alternative forms are expanded:

      #

      #     "--[no-]seo"    --> ["--[no-]seo", "[no-]seo", "--seo", "seo", "--no-seo", "no-seo"]

      #

      def each_index_key(option_name)

        key = option_name.sub(/\[?=.*/, '')

        plain_key = key.sub(/^-*/, '')

        [key, plain_key].each do |k|

          yield k

          if k =~ /\[no-\]/

            yield k.sub(/\[no-\]/, '')

            yield k.sub(/\[no-\]/, 'no-')

          end

        end

      end

      # Returns long help text for a single option.

      def help_single(option_name)

        o = @full_options_index[option_name] || {:keys => [option_name], :desc => ["No such option. See --help=help"]}

        r = []

        r << ""

        r << "    " + o[:keys].join(", ")

        r << ""

        o[:desc].each do |line|

          r << "            " + line

        end

        r << ""

        r << ""

        return r.join("\n")

      end

    end

  end

end

require 'jsduck/logger'

require 'jsduck/util/json'

require 'jsduck/util/os'

require 'jsduck/util/io'

require 'jsduck/util/parallel'

require 'jsduck/tag_registry'

require 'jsduck/js/ext_patterns'

require 'jsduck/warning/parser'

require 'jsduck/version'

module JsDuck

  module Options

    # Handles setting different settings based on the commend line

    # options and also processes some of the options (like #footer and

    # #input_files). Finally it also validates them.

    class Processor

      # Processes and applies the parsed command line options.

      # It modifies the values of #footer and #input_files options.

      def process!(opts)

        @opts = opts

        # Apply the various options.

        configure_input_files

        configure_footer

        configure_logger

        configure_parallel

        configure_tags

        configure_json

        configure_encoding

        configure_ext_patterns

        validate

        @opts

      end

      private

      def configure_input_files

        @opts.input_files = expand_files(@opts.input_files)

        exclude_files!(@opts.input_files, @opts.exclude)

      end

      # Expands directories and .jsb3 files in given list of filenames

      def expand_files(unexpanded_files)

        unexpanded_files.map {|fname| expand_filename(fname) }.flatten

      end

      # When file is a directory, scans all JS, CSS, SCSS files in there.

      # When file is a .jsb3 file, extracts list of files from it.

      # Otherwise returns array with this same input filename.

      def expand_filename(fname)

        files = []

        if File.exists?(fname)

          if File.directory?(fname)

            Dir[fname+"/**/*.{js,css,scss}"].each {|f| files << f }

          elsif fname =~ /\.jsb3$/

            extract_jsb_files(fname).each {|fn| read_filenames(fn) }

          else

            files << fname

          end

        else

          Logger.warn(nil, "File not found", fname)

        end

        files

      end

      # Extracts files of first build in jsb file

      def extract_jsb_files(jsb_file)

        json = Util::Json.read(jsb_file)

        basedir = File.dirname(jsb_file)

        return json["builds"][0]["packages"].map do |package_id|

          package = json["packages"].find {|p| p["id"] == package_id }

          (package ? package["files"] : []).map do |file|

            File.expand_path(basedir + "/" + file["path"] + file["name"])

          end

        end.flatten

      end

      # Removes the files matching exclude_paths from list of files

      def exclude_files!(files, exclude_paths)

        exclude_paths.each do |exclude_path|

          exclude_re = Regexp.new('\A' + Regexp.escape(exclude_path))

          files.reject! {|f| f =~ exclude_re }

        end

      end

      def configure_footer

        @opts.footer = format_footer(@opts.footer)

      end

      # Replace special placeholders in footer text

      def format_footer(text)

        jsduck = "<a href='https://github.com/senchalabs/jsduck'>JSDuck</a>"

        date = Time.new.strftime('%a %d %b %Y %H:%M:%S')

        text.gsub(/\{VERSION\}/, JsDuck::VERSION).gsub(/\{JSDUCK\}/, jsduck).gsub(/\{DATE\}/, date)

      end

      def configure_logger

        Logger.verbose = true if @opts.verbose

        Logger.colors = @opts.color unless @opts.color.nil?

        # Enable all warnings except the following:

        Logger.set_warning(:all, true)

        Logger.set_warning(:link_auto, false)

        Logger.set_warning(:param_count, false)

        Logger.set_warning(:fires, false)

        Logger.set_warning(:nodoc, false)

        begin

          @opts.warnings.each do |warning|

            Warning::Parser.new(warning).parse.each do |w|

              Logger.set_warning(w[:type], w[:enabled], w[:path], w[:params])

            end

          end

        rescue Warning::WarnException => e

          Logger.warn(nil, e.message)

        end

      end

      # Turns multiprocessing off by default in Windows.

      # When --processes option used, sets the number of processes.

      def configure_parallel

        Util::Parallel.in_processes = 0 if Util::OS::windows?

        Util::Parallel.in_processes = @opts.processes if @opts.processes

      end

      def configure_tags

        if @opts.tags.length > 0

          TagRegistry.reconfigure(@opts.tags)

        else

          # Ensure the TagRegistry get instantiated just once.

          # Otherwise the parallel processing causes multiple requests

          # to initialize the TagRegistry, resulting in loading the Tag

          # definitions multiple times.

          TagRegistry.instance

        end

        # The tooltip of @new can now be configured.

        TagRegistry.get_by_name(:new).init_tooltip!(@opts)

      end

      def configure_json

        Util::Json.pretty = true if @opts.pretty_json

        JsDuck::Util::IO.encoding = @opts.encoding if @opts.encoding

        Js::ExtPatterns.set(@opts.ext_namespaces) if @opts.ext_namespaces

      end

      def configure_encoding

        JsDuck::Util::IO.encoding = @opts.encoding if @opts.encoding

      end

      def configure_ext_patterns

        Js::ExtPatterns.set(@opts.ext_namespaces) if @opts.ext_namespaces

      end

      # Runs checks on the options

      def validate

        if @opts.input_files.length == 0 && !@opts.welcome && !@opts.guides && !@opts.videos && !@opts.examples

          Logger.fatal("You should specify some input files, otherwise there's nothing I can do :(")

          exit(1)

        elsif @opts.output_dir == :stdout && !@opts.export

          Logger.fatal("Output to STDOUT only works when using --export option")

          exit(1)

        elsif ![nil, :full, :api, :examples].include?(@opts.export)

          Logger.fatal("Unknown export format: #{@export}")

          exit(1)

        elsif @opts.output_dir != :stdout

          if !@opts.output_dir

            Logger.fatal("You should also specify an output directory, where I could write all this amazing documentation")

            exit(1)

          elsif File.exists?(@opts.output_dir) && !File.directory?(@opts.output_dir)

            Logger.fatal("The output directory is not really a directory at all :(")

            exit(1)

          elsif !File.exists?(File.dirname(@opts.output_dir))

            Logger.fatal("The parent directory for #{@opts.output_dir} doesn't exist")

            exit(1)

          elsif !@opts.export && !File.exists?(@opts.template_dir + "/extjs")

            Logger.fatal("Oh noes!  The template directory does not contain extjs/ directory :(")

            Logger.fatal("Please copy ExtJS over to template/extjs or create symlink.")

            Logger.fatal("For example:")

            Logger.fatal("    $ cp -r /path/to/ext-4.0.0 " + @opts.template_dir + "/extjs")

            exit(1)

          elsif !@opts.export && !File.exists?(@opts.template_dir + "/resources/css")

            Logger.fatal("Oh noes!  CSS files for custom ExtJS theme missing :(")

            Logger.fatal("Please compile SASS files in template/resources/sass with compass.")

            Logger.fatal("For example:")

            Logger.fatal("    $ compass compile " + @opts.template_dir + "/resources/sass")

            exit(1)

          end

        end

      end

    end

  end

end