etude_for_ruby 0.1.0 → 0.1.4

data/vendor/bundle/ruby/2.4.0/gems/yard-0.9.8/lib/yard/cli/command.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require 'optparse'
+
+module YARD
+  module CLI
+    # Abstract base class for CLI utilities. Provides some helper methods for
+    # the option parser
+    #
+    # @abstract
+    # @since 0.6.0
+    class Command
+      # Helper method to run the utility on an instance.
+      # @see #run
+      def self.run(*args) new.run(*args) end
+
+      def description; '' end
+
+      protected
+
+      # Adds a set of common options to the tail of the OptionParser
+      #
+      # @param [OptionParser] opts the option parser object
+      # @return [void]
+      def common_options(opts)
+        opts.separator ""
+        opts.separator "Other options:"
+        opts.on('-e', '--load FILE', 'A Ruby script to load before running command.') do |file|
+          load_script(file)
+        end
+        opts.on('--plugin PLUGIN', 'Load a YARD plugin (gem with `yard-\' prefix)') do |name|
+          # Not actually necessary to load here, this is done at boot in YARD::Config.load_plugins
+          # YARD::Config.load_plugin(name)
+        end
+        opts.on('--legacy', 'Use old style Ruby parser and handlers. ',
+                            '  Always on in 1.8.x.') do
+          YARD::Parser::SourceParser.parser_type = :ruby18
+        end
+        opts.on('--safe', 'Enable safe mode for this instance') do
+          # Parsed in YARD::Config.load
+        end
+        opts.on_tail('-q', '--quiet', 'Show no warnings.') { log.level = Logger::ERROR }
+        opts.on_tail('--verbose', 'Show more information.') { log.level = Logger::INFO }
+        opts.on_tail('--debug', 'Show debugging information.') { log.level = Logger::DEBUG }
+        opts.on_tail('--backtrace', 'Show stack traces') { log.show_backtraces = true }
+        opts.on_tail('-v', '--version', 'Show version.') { log.puts "yard #{YARD::VERSION}"; exit }
+        opts.on_tail('-h', '--help', 'Show this help.')  { log.puts opts; exit }
+      end
+
+      # Parses the option and gracefully handles invalid switches
+      #
+      # @param [OptionParser] opts the option parser object
+      # @param [Array<String>] args the arguments passed from input. This
+      #   array will be modified.
+      # @return [void]
+      def parse_options(opts, args)
+        opts.parse!(args)
+      rescue OptionParser::ParseError => err
+        unrecognized_option(err)
+        args.shift if args.first && args.first[0, 1] != '-'
+        retry
+      end
+
+      # Loads a Ruby script. If <tt>Config.options[:safe_mode]</tt> is enabled,
+      # this method will do nothing.
+      #
+      # @param [String] file the path to the script to load
+      # @since 0.6.2
+      def load_script(file)
+        return if YARD::Config.options[:safe_mode]
+        load(file)
+      rescue LoadError => load_exception
+        log.error "The file `#{file}' could not be loaded:\n#{load_exception}"
+        exit
+      end
+
+      # Callback when an unrecognize option is parsed
+      #
+      # @param [OptionParser::ParseError] err the exception raised by the
+      #   option parser
+      def unrecognized_option(err)
+        log.warn "Unrecognized/#{err.message}"
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.4.0/gems/yard-0.9.8/lib/yard/cli/command_parser.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+module YARD
+  module CLI
+    # This class parses a command name out of the +yard+ CLI command and calls
+    # that command in the form:
+    #
+    #   $ yard command_name [options]
+    #
+    # If no command or arguments are specified, or if the arguments immediately
+    # begin with a +--opt+ (not +--help+), the {default_command} will be used
+    # (which itself defaults to +:doc+).
+    #
+    # == Adding a Command
+    #
+    # To add a custom command via plugin, create a mapping in {commands} from
+    # the Symbolic command name to the {Command} class that implements the
+    # command. To implement a command, see the documentation for the {Command}
+    # class.
+    #
+    # @see Command
+    # @see commands
+    # @see default_command
+    class CommandParser
+      class << self
+        # @return [Hash{Symbol => Command}] the mapping of command names to
+        #   command classes to parse the user command.
+        attr_accessor :commands
+
+        # @return [Symbol] the default command name to use when no options
+        #   are specified or
+        attr_accessor :default_command
+      end
+
+      self.commands = SymbolHash[
+        :config  => Config,
+        :diff    => Diff,
+        :display => Display,
+        :doc     => Yardoc,
+        :gems    => Gems,
+        :graph   => Graph,
+        :help    => Help,
+        :list    => List,
+        :markups => MarkupTypes,
+        :ri      => YRI,
+        :server  => Server,
+        :stats   => Stats,
+        :i18n    => I18n
+      ]
+
+      self.default_command = :doc
+
+      # Convenience method to create a new CommandParser and call {#run}
+      # @return (see #run)
+      def self.run(*args) new.run(*args) end
+
+      def initialize
+        log.show_backtraces = false
+      end
+
+      # Runs the {Command} object matching the command name of the first
+      # argument.
+      # @return [void]
+      def run(*args)
+        unless args == ['--help']
+          if args.empty? || args.first =~ /^-/
+            command_name = self.class.default_command
+          else
+            command_name = args.first.to_sym
+            args.shift
+          end
+          if commands.key?(command_name)
+            return commands[command_name].run(*args)
+          end
+        end
+        list_commands
+      end
+
+      private
+
+      def commands; self.class.commands end
+
+      def list_commands
+        log.puts "Usage: yard <command> [options]"
+        log.puts
+        log.puts "Commands:"
+        commands.keys.sort_by(&:to_s).each do |command_name|
+          command = commands[command_name].new
+          log.puts "%-8s %s" % [command_name, command.description]
+        end
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.4.0/gems/yard-0.9.8/lib/yard/cli/config.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+module YARD
+  module CLI
+    # CLI command to view or edit configuration options
+    # @since 0.6.2
+    class Config < Command
+      # @return [Symbol, nil] the key to view/edit, if any
+      attr_accessor :key
+
+      # @return [Array, nil] the list of values to set (or single value), if modifying
+      attr_accessor :values
+
+      # @return [Boolean] whether to reset the {#key}
+      attr_accessor :reset
+
+      # @return [Boolean] whether the value being set should be inside a list
+      attr_accessor :as_list
+
+      # @return [Boolean] whether to append values to existing key
+      attr_accessor :append
+
+      # @return [String, nil] command to use when configuring ~/.gemrc file.
+      #   If the string is nil, configuration should not occur.
+      attr_accessor :gem_install_cmd
+
+      def initialize
+        super
+        self.key = nil
+        self.values = []
+        self.reset = false
+        self.append = false
+        self.as_list = false
+        self.gem_install_cmd = nil
+      end
+
+      def description
+        'Views or edits current global configuration'
+      end
+
+      def run(*args)
+        optparse(*args)
+        if gem_install_cmd
+          configure_gemrc
+        elsif key
+          if reset || !values.empty?
+            modify_item
+          else
+            view_item
+          end
+        else
+          list_configuration
+        end
+      end
+
+      private
+
+      def configure_gemrc
+        return unless gem_install_cmd
+
+        require 'rubygems'
+
+        ['install', :install, 'gem', :gem].find do |cmd|
+          conf = Gem.configuration[cmd] || ""
+          next if conf.empty? && cmd != :gem
+
+          conf = conf.split(/\s+/)
+          conf.delete_if {|c| c =~ /^--(no-)?document\b/ } # scrub doc args
+          conf |= ["--document=#{gem_install_cmd}"]
+          conf = conf.join(' ')
+
+          Gem.configuration[cmd] = conf
+          Gem.configuration.write
+          log.puts "Updated #{Gem.configuration.path || '~/.gemrc'}: '#{cmd}: #{conf}'"
+          true
+        end
+      end
+
+      def modify_item
+        if reset
+          log.debug "Resetting #{key}"
+          YARD::Config.options[key] = YARD::Config::DEFAULT_CONFIG_OPTIONS[key]
+        else
+          log.debug "Setting #{key} to #{values.inspect}"
+          items = encode_values
+          current_items = YARD::Config.options[key]
+          items = [current_items].flatten + [items].flatten if append
+          YARD::Config.options[key] = items
+        end
+        YARD::Config.save
+      end
+
+      def view_item
+        log.debug "Viewing #{key}"
+        log.puts YARD::Config.options[key].inspect
+      end
+
+      def list_configuration
+        log.debug "Listing configuration"
+        require 'yaml'
+        log.puts YAML.dump(YARD::Config.options).sub(/\A--.*\n/, '').gsub(/\n\n/, "\n")
+      end
+
+      def encode_values
+        if values.size == 1 && !as_list
+          encode_value(values.first)
+        else
+          values.map {|v| encode_value(v) }
+        end
+      end
+
+      def encode_value(value)
+        case value
+        when /^-?\d+/; value.to_i
+        when "true"; true
+        when "false"; false
+        else value
+        end
+      end
+
+      def optparse(*args)
+        list = false
+        self.as_list = false
+        self.append = false
+        opts = OptionParser.new
+        opts.banner = "Usage: yard config [options] [item [value ...]]"
+        opts.separator ""
+        opts.separator "Example: yard config load_plugins true"
+        opts.separator ""
+        opts.separator "Views and sets configuration items. If an item is provided"
+        opts.separator "With no value, the item is viewed. If a value is provided,"
+        opts.separator "the item is modified. Specifying no item is equivalent to --list."
+        opts.separator "If you specify multiple space delimited values, these are"
+        opts.separator "parsed as an array of values."
+        opts.separator ""
+        opts.separator "Note that `true` and `false` are reserved words."
+        opts.separator ""
+        opts.separator "---------------------------------------------------------"
+        opts.separator ""
+        opts.separator "Configuring RubyGems support:"
+        opts.separator ""
+        opts.separator "YARD can automatically generate the YRI index or HTML"
+        opts.separator "documentation in a `gem install` by adding the following"
+        opts.separator "to your ~/.gemrc file:"
+        opts.separator ""
+        opts.separator "    gem: \"--document=yri\""
+        opts.separator ""
+        opts.separator "Note: you can add 'yard' to also generate HTML docs."
+        opts.separator "  You can also add 'ri' to continue generating RDoc."
+        opts.separator ""
+        opts.separator "You can also run the following command to configure this"
+        opts.separator "behavior automatically:"
+        opts.separator ""
+        opts.separator "    $ yard config --gem-install-yri"
+        opts.separator ""
+        opts.separator "Add --gem-install-yard to also generate HTML."
+        opts.separator ""
+        opts.separator "---------------------------------------------------------"
+        opts.separator ""
+        opts.separator "General options:"
+
+        opts.on('-l', '--list', 'List current configuration') do
+          list = true
+        end
+        opts.on('-r', '--reset', 'Resets the specific item to default') do
+          self.reset = true
+        end
+
+        opts.separator ""
+        opts.separator "Modifying keys:"
+
+        opts.on('-a', '--append', 'Appends items to existing key values') do
+          self.append = true
+        end
+        opts.on('--as-list', 'Forces the value(s) to be wrapped in an array') do
+          self.as_list = true
+        end
+
+        opts.separator ""
+        opts.separator "Add RubyGems install hook:"
+
+        opts.on('--gem-install-yri', 'Configures ~/.gemrc to run yri on a gem install') do
+          self.gem_install_cmd = 'yri' if gem_install_cmd != 'yard'
+        end
+
+        opts.on('--gem-install-yard', 'Configures ~/.gemrc to run yard on a gem install') do
+          self.gem_install_cmd = 'yard'
+        end
+
+        common_options(opts)
+        parse_options(opts, args)
+        args = [] if list
+        self.key = args.shift.to_sym if args.size >= 1
+        self.values = args if args.size >= 1
+        args
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.4.0/gems/yard-0.9.8/lib/yard/cli/diff.rb

@@ -0,0 +1,270 @@
+# frozen_string_literal: true
+require 'tmpdir'
+require 'fileutils'
+require 'open-uri'
+
+module YARD
+  module CLI
+    # CLI command to return the objects that were added/removed from 2 versions
+    # of a project (library, gem, working copy).
+    # @since 0.6.0
+    class Diff < Command
+      def initialize
+        super
+        @list_all = false
+        @use_git = false
+        @compact = false
+        @modified = true
+        @verifier = Verifier.new
+        @old_git_commit = nil
+        @old_path = Dir.pwd
+        log.show_backtraces = true
+      end
+
+      def description
+        'Returns the object diff of two gems or .yardoc files'
+      end
+
+      def run(*args)
+        registry = optparse(*args).map do |gemfile|
+          if @use_git
+            load_git_commit(gemfile)
+            all_objects
+          elsif load_gem_data(gemfile)
+            log.info "Found #{gemfile}"
+            all_objects
+          else
+            log.error "Cannot find gem #{gemfile}"
+            nil
+          end
+        end.compact
+
+        return if registry.size != 2
+
+        first_object = nil
+        [["Added objects", "A", added_objects(*registry)],
+            ["Modified objects", "M", modified_objects(*registry)],
+            ["Removed objects", "D", removed_objects(*registry)]].each do |name, short, objects|
+          next if short == "M" && @modified == false
+          next if objects.empty?
+          last_object = nil
+          all_objects_notice = false
+          log.puts name + ":" unless @compact
+          objects.sort_by(&:path).each do |object|
+            if !@list_all && last_object && object.parent == last_object
+              log.print " (...)" unless all_objects_notice
+              all_objects_notice = true
+              next
+            elsif @compact
+              log.puts if first_object
+            else
+              log.puts
+            end
+            all_objects_notice = false
+            log.print "" + (@compact ? "#{short} " : "  ") +
+                      object.path + " (#{object.file}:#{object.line})"
+            last_object = object
+            first_object = true
+          end
+          unless @compact
+            log.puts; log.puts
+          end
+        end
+        log.puts if @compact
+      end
+
+      private
+
+      def all_objects
+        return Registry.all if @verifier.expressions.empty?
+        @verifier.run(Registry.all)
+      end
+
+      def added_objects(registry1, registry2)
+        registry2.reject {|o| registry1.find {|o2| o2.path == o.path } }
+      end
+
+      def modified_objects(registry1, registry2)
+        registry1.select do |obj|
+          case obj
+          when CodeObjects::MethodObject
+            registry2.find {|o| obj == o && o.source != obj.source }
+          when CodeObjects::ConstantObject
+            registry2.find {|o| obj == o && o.value != obj.value }
+          end
+        end.compact
+      end
+
+      def removed_objects(registry1, registry2)
+        registry1.reject {|o| registry2.find {|o2| o2.path == o.path } }
+      end
+
+      def load_git_commit(commit)
+        Registry.clear
+        commit_path = 'git_commit' + commit.gsub(/\W/, '_')
+        tmpdir = File.join(Dir.tmpdir, commit_path)
+        log.info "Expanding #{commit} to #{tmpdir}..."
+        Dir.chdir(@old_path)
+        FileUtils.mkdir_p(tmpdir)
+        FileUtils.cp_r('.', tmpdir)
+        Dir.chdir(tmpdir)
+        log.info("git says: " + `git reset --hard #{commit}`.chomp)
+        generate_yardoc(tmpdir)
+      ensure
+        Dir.chdir(@old_path)
+        cleanup(commit_path)
+      end
+
+      def load_gem_data(gemfile)
+        require_rubygems
+        Registry.clear
+
+        # First check for argument as .yardoc file
+        [File.join(gemfile, '.yardoc'), gemfile].each do |yardoc|
+          log.info "Searching for .yardoc db at #{yardoc}"
+          next unless File.directory?(yardoc)
+          Registry.load_yardoc(yardoc)
+          Registry.load_all
+          return true
+        end
+
+        # Next check installed RubyGems
+        gemfile_without_ext = gemfile.sub(/\.gem$/, '')
+        log.info "Searching for installed gem #{gemfile_without_ext}"
+        YARD::GemIndex.each.find do |spec|
+          next unless spec.full_name == gemfile_without_ext
+          yardoc = Registry.yardoc_file_for_gem(spec.name, "= #{spec.version}")
+          if yardoc
+            Registry.load_yardoc(yardoc)
+            Registry.load_all
+          else
+            log.enter_level(Logger::ERROR) do
+              olddir = Dir.pwd
+              Gems.run(spec.name, spec.version.to_s)
+              Dir.chdir(olddir)
+            end
+          end
+          return true
+        end
+
+        # Look for local .gem file
+        gemfile += '.gem' unless gemfile =~ /\.gem$/
+        log.info "Searching for local gem file #{gemfile}"
+        if File.exist?(gemfile)
+          File.open(gemfile, 'rb') do |io|
+            expand_and_parse(gemfile, io)
+          end
+          return true
+        end
+
+        # Remote gemfile from rubygems.org
+        url = "http://rubygems.org/downloads/#{gemfile}"
+        log.info "Searching for remote gem file #{url}"
+        begin
+          open(url) {|io| expand_and_parse(gemfile, io) }
+          return true
+        rescue OpenURI::HTTPError
+          nil # noop
+        end
+        false
+      end
+
+      def expand_and_parse(gemfile, io)
+        dir = expand_gem(gemfile, io)
+        generate_yardoc(dir)
+        cleanup(gemfile)
+      end
+
+      def generate_yardoc(dir)
+        Dir.chdir(dir) do
+          log.enter_level(Logger::ERROR) { Yardoc.run('-n', '--no-save') }
+        end
+      end
+
+      def expand_gem(gemfile, io)
+        tmpdir = File.join(Dir.tmpdir, gemfile)
+        FileUtils.mkdir_p(tmpdir)
+        log.info "Expanding #{gemfile} to #{tmpdir}..."
+
+        if Gem::VERSION >= '2.0.0'
+          require 'rubygems/package/tar_reader'
+          reader = Gem::Package::TarReader.new(io)
+          reader.each do |pkg|
+            next unless pkg.full_name == 'data.tar.gz'
+            Zlib::GzipReader.wrap(pkg) do |gzio|
+              tar = Gem::Package::TarReader.new(gzio)
+              tar.each do |entry|
+                file = File.join(tmpdir, entry.full_name)
+                FileUtils.mkdir_p(File.dirname(file))
+                File.open(file, 'wb') do |out|
+                  out.write(entry.read)
+                  begin
+                    out.fsync
+                  rescue NotImplementedError
+                    nil # noop
+                  end
+                end
+              end
+            end
+            break
+          end
+        else
+          Gem::Package.open(io) do |pkg|
+            pkg.each do |entry|
+              pkg.extract_entry(tmpdir, entry)
+            end
+          end
+        end
+
+        tmpdir
+      end
+
+      def require_rubygems
+        require 'rubygems'
+        require 'rubygems/package'
+      rescue LoadError => e
+        log.error "Missing RubyGems, cannot run this command."
+        raise(e)
+      end
+
+      def cleanup(gemfile)
+        dir = File.join(Dir.tmpdir, gemfile)
+        log.info "Cleaning up #{dir}..."
+        FileUtils.rm_rf(dir)
+      end
+
+      def optparse(*args)
+        opts = OptionParser.new
+        opts.banner = "Usage: yard diff [options] oldgem newgem"
+        opts.separator ""
+        opts.separator "Example: yard diff yard-0.5.6 yard-0.5.8"
+        opts.separator ""
+        opts.separator "If the files don't exist locally, they will be grabbed using the `gem fetch`"
+        opts.separator "command. If the gem is a .yardoc directory, it will be used. Finally, if the"
+        opts.separator "gem name matches an installed gem (full name-version syntax), that gem will be used."
+
+        opts.on('-a', '--all', 'List all objects, even if they are inside added/removed module/class') do
+          @list_all = true
+        end
+        opts.on('--compact', 'Show compact results') { @compact = true }
+        opts.on('--git', 'Compare versions from two git commit/branches') do
+          @use_git = true
+        end
+        opts.on('--query QUERY', 'Only diff filtered objects') do |query|
+          @verifier.add_expressions(query)
+        end
+        opts.on('--no-modified', 'Ignore modified objects') do
+          @modified = false
+        end
+        common_options(opts)
+        parse_options(opts, args)
+        unless args.size == 2
+          log.puts opts.banner
+          exit(0)
+        end
+
+        args
+      end
+    end
+  end
+end