etude_for_ruby 0.1.4 → 0.2.3

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/legacy/yield_handler.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-# (see Ruby::YieldHandler)
-class YARD::Handlers::Ruby::Legacy::YieldHandler < YARD::Handlers::Ruby::Legacy::Base
-  handles TkYIELD
-
-  process do
-    return unless owner.is_a?(MethodObject) # Only methods yield
-    return if owner.has_tag? :yield         # Don't override yield tags
-    return if owner.has_tag? :yieldparam    # Same thing.
-
-    yieldtag = YARD::Tags::Tag.new(:yield, "", [])
-    tokval_list(statement.tokens[2..-1], Token).each do |item|
-      item = item.inspect unless item.is_a?(String)
-      if item == "self"
-        yieldtag.types << '_self'
-        owner.add_tag YARD::Tags::Tag.new(:yieldparam,
-          "the object that the method was called on", owner.namespace.path, '_self')
-      elsif item == "super"
-        yieldtag.types << '_super'
-        owner.add_tag YARD::Tags::Tag.new(:yieldparam,
-          "the result of the method from the superclass", nil, '_super')
-      else
-        yieldtag.types << item
-      end
-    end
-
-    owner.add_tag(yieldtag) unless yieldtag.types.empty?
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/method_condition_handler.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-# Handles a conditional inside a method
-class YARD::Handlers::Ruby::MethodConditionHandler < YARD::Handlers::Ruby::Base
-  handles :if_mod, :unless_mod
-
-  process do
-    parse_block(statement.then_block, :owner => owner)
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/method_handler.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-# Handles a method definition
-class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
-  handles :def, :defs
-
-  process do
-    meth = statement.method_name(true).to_s
-    args = format_args
-    blk = statement.block
-    nobj = namespace
-    mscope = scope
-    if statement.type == :defs
-      if statement[0][0].type == :ident
-        raise YARD::Parser::UndocumentableError, 'method defined on object instance'
-      end
-      nobj = P(namespace, statement[0].source) if statement[0][0].type == :const
-      mscope = :class
-    end
-
-    nobj = P(namespace, nobj.value) while nobj.type == :constant
-    obj = register MethodObject.new(nobj, meth, mscope) do |o|
-      o.signature = method_signature
-      o.explicit = true
-      o.parameters = args
-    end
-
-    # delete any aliases referencing old method
-    nobj.aliases.each do |aobj, name|
-      next unless name == obj.name
-      nobj.aliases.delete(aobj)
-    end if nobj.is_a?(NamespaceObject)
-
-    if obj.constructor?
-      unless obj.has_tag?(:return)
-        obj.add_tag(YARD::Tags::Tag.new(:return,
-          "a new instance of #{namespace.name}", namespace.name.to_s))
-      end
-    elsif mscope == :class && obj.docstring.blank? && %w(inherited included
-        extended method_added method_removed method_undefined).include?(meth)
-      obj.add_tag(YARD::Tags::Tag.new(:private, nil))
-    elsif meth.to_s =~ /\?$/
-      if obj.tag(:return) && (obj.tag(:return).types || []).empty?
-        obj.tag(:return).types = ['Boolean']
-      elsif obj.tag(:return).nil?
-        unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
-          obj.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
-        end
-      end
-    end
-
-    if obj.has_tag?(:option)
-      # create the options parameter if its missing
-      obj.tags(:option).each do |option|
-        expected_param = option.name
-        unless obj.tags(:param).find {|x| x.name == expected_param }
-          new_tag = YARD::Tags::Tag.new(:param, "a customizable set of options", "Hash", expected_param)
-          obj.add_tag(new_tag)
-        end
-      end
-    end
-
-    info = obj.attr_info
-    if info
-      if meth.to_s =~ /=$/ # writer
-        info[:write] = obj if info[:read]
-      elsif info[:write]
-        info[:read] = obj
-      end
-    end
-
-    parse_block(blk, :owner => obj) # mainly for yield/exceptions
-  end
-
-  def format_args
-    args = statement.parameters
-
-    params = []
-
-    if args.unnamed_required_params
-      params += args.unnamed_required_params.map {|a| [a.source, nil] }
-    end
-
-    if args.unnamed_optional_params
-      params += args.unnamed_optional_params.map do |a|
-        [a[0].source, a[1].source]
-      end
-    end
-
-    params << ['*' + args.splat_param.source, nil] if args.splat_param
-
-    if args.unnamed_end_params
-      params += args.unnamed_end_params.map {|a| [a.source, nil] }
-    end
-
-    if args.named_params
-      params += args.named_params.map do |a|
-        [a[0].source, a[1] ? a[1].source : nil]
-      end
-    end
-
-    if args.double_splat_param
-      params << ['**' + args.double_splat_param.source, nil]
-    end
-
-    params << ['&' + args.block_param.source, nil] if args.block_param
-
-    params
-  end
-
-  def method_signature
-    method_name = statement.method_name(true)
-    if statement.parameters.any? {|e| e }
-      "def #{method_name}(#{statement.parameters.source})"
-    else
-      "def #{method_name}"
-    end
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/mixin_handler.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-# Handles the 'include' statement to mixin a module in the instance scope
-class YARD::Handlers::Ruby::MixinHandler < YARD::Handlers::Ruby::Base
-  handles method_call(:include)
-  namespace_only
-
-  process do
-    errors = []
-    statement.parameters(false).reverse.each do |mixin|
-      begin
-        process_mixin(mixin)
-      rescue YARD::Parser::UndocumentableError => err
-        errors << err.message
-      end
-    end
-    unless errors.empty?
-      msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
-      raise YARD::Parser::UndocumentableError, "mixin#{msg} for class #{namespace.path}"
-    end
-  end
-
-  protected
-
-  def process_mixin(mixin)
-    raise YARD::Parser::UndocumentableError unless mixin.ref?
-    raise YARD::Parser::UndocumentableError if mixin.first.type == :ident
-
-    case obj = Proxy.new(namespace, mixin.source)
-    when ConstantObject # If a constant is included, use its value as the real object
-      obj = Proxy.new(namespace, obj.value, :module)
-    else
-      obj = Proxy.new(namespace, mixin.source, :module)
-    end
-
-    namespace.mixins(scope).unshift(obj) unless namespace.mixins(scope).include?(obj)
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/module_function_handler.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-# Handles module_function calls to turn methods into public class methods.
-# Also creates a private instance copy of the method.
-class YARD::Handlers::Ruby::ModuleFunctionHandler < YARD::Handlers::Ruby::Base
-  handles method_call(:module_function)
-  namespace_only
-
-  process do
-    return if statement.jump(:ident) == statement
-    case statement.type
-    when :var_ref, :vcall
-      self.scope = :module
-    when :fcall, :command
-      statement[1].traverse do |node|
-        case node.type
-        when :symbol; name = node.first.source
-        when :string_content; name = node.source
-        else next
-        end
-        instance_method = MethodObject.new(namespace, name)
-        class_method = MethodObject.new(namespace, name, :module)
-        instance_method.copy_to(class_method)
-        class_method.visibility = :public
-      end
-    end
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/module_handler.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-# Handles the declaration of a module
-class YARD::Handlers::Ruby::ModuleHandler < YARD::Handlers::Ruby::Base
-  handles :module
-  namespace_only
-
-  process do
-    modname = statement[0].source
-    mod = register ModuleObject.new(namespace, modname)
-    parse_block(statement[1], :namespace => mod)
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/private_class_method_handler.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-# Sets visibility of a class method to private.
-class YARD::Handlers::Ruby::PrivateClassMethodHandler < YARD::Handlers::Ruby::Base
-  include YARD::Handlers::Ruby::DecoratorHandlerMethods
-
-  handles method_call(:private_class_method)
-  namespace_only
-
-  process do
-    process_decorator :scope => :class do |method|
-      method.visibility = :private if method.respond_to? :visibility=
-    end
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/private_constant_handler.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-module YARD
-  module Handlers
-    module Ruby
-      # Sets visibility of a constant (class, module, const)
-      class PrivateConstantHandler < YARD::Handlers::Ruby::Base
-        handles method_call(:private_constant)
-        namespace_only
-
-        process do
-          errors = []
-          statement.parameters.each do |param|
-            next unless AstNode === param
-            begin
-              privatize_constant(param)
-            rescue UndocumentableError => err
-              errors << err.message
-            end
-          end
-          unless errors.empty?
-            msg = errors.size == 1 ? ": #{errors[0]}" : "s: #{errors.join(", ")}"
-            raise UndocumentableError, "private constant#{msg} for #{namespace.path}"
-          end
-        end
-
-        private
-
-        def privatize_constant(node)
-          if node.literal? || (node.type == :var_ref && node[0].type == :const)
-            node = node.jump(:tstring_content, :const)
-            const = Proxy.new(namespace, node[0])
-            ensure_loaded!(const)
-            const.visibility = :private
-          else
-            raise UndocumentableError, "invalid argument to private_constant: #{node.source}"
-          end
-        rescue NamespaceMissingError
-          raise UndocumentableError, "private visibility set on unrecognized constant: #{node[0]}"
-        end
-      end
-    end
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/public_class_method_handler.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-# Sets visibility of a class method to public.
-class YARD::Handlers::Ruby::PublicClassMethodHandler < YARD::Handlers::Ruby::Base
-  include YARD::Handlers::Ruby::DecoratorHandlerMethods
-
-  handles method_call(:public_class_method)
-  namespace_only
-
-  process do
-    process_decorator :scope => :class do |method|
-      method.visibility = :public if method.respond_to? :visibility
-    end
-  end
-end

data/vendor/bundle/ruby/2.2.0/gems/yard-0.9.8/lib/yard/handlers/ruby/struct_handler_methods.rb

@@ -1,143 +0,0 @@
-# frozen_string_literal: true
-# Helper methods to parse @attr_* tags on a class.
-#
-# @deprecated The use of +@attr+ tags are deprecated since 0.8.0 in favour of
-#   the +@!attribute+ directive. This module should not be relied on.
-# @since 0.5.6
-module YARD::Handlers::Ruby::StructHandlerMethods
-  include YARD::CodeObjects
-
-  # Extracts the user's defined @member tag for a given class and its member. Returns
-  # nil if the user did not define a @member tag for this struct entry.
-  #
-  # @param [ClassObject] klass the class whose tags we're searching
-  # @param [String] member the name of the struct member we need
-  # @param [Symbol] type reader method, or writer method?
-  # @return [Tags::Tag, nil] the tag matching the request, or nil if not found
-  def member_tag_for_member(klass, member, type = :read)
-    specific_tag = type == :read ? :attr_reader : :attr_writer
-    (klass.tags(specific_tag) + klass.tags(:attr)).find {|tag| tag.name == member }
-  end
-
-  # Retrieves all members defined in @attr* tags
-  #
-  # @param [ClassObject] klass the class with the attributes
-  # @return [Array<String>] the list of members defined as attributes on the class
-  def members_from_tags(klass)
-    tags = klass.tags(:attr) + klass.tags(:attr_reader) + klass.tags(:attr_writer)
-    tags.map(&:name).uniq
-  end
-
-  # Determines whether to create an attribute method based on the class's
-  # tags.
-  #
-  # @param [ClassObject] klass the class whose tags we're searching
-  # @param [String] member the name of the struct member we need
-  # @param [Symbol] type (:read) reader method, or writer method?
-  # @return [Boolean] should the attribute be created?
-  def create_member_method?(klass, member, type = :read)
-    return true if (klass.tags(:attr) + klass.tags(:attr_reader) + klass.tags(:attr_writer)).empty?
-    return true if member_tag_for_member(klass, member, type)
-    return !member_tag_for_member(klass, member, :write) if type == :read
-    !member_tag_for_member(klass, member, :read)
-  end
-
-  # Gets the return type for the member in a nicely formatted string. Used
-  # to be injected into auto-generated docstrings.
-  #
-  # @param [Tags::Tag] member_tag the tag object to check for types
-  # @return [String] the user-declared type of the struct member, or [Object] if
-  #   the user did not define a type for this member.
-  def return_type_from_tag(member_tag)
-    member_tag && member_tag.types ? member_tag.types : "Object"
-  end
-
-  # Creates the auto-generated docstring for the getter method of a struct's
-  # member. This is used so the generated documentation will look just like that
-  # of an attribute defined using attr_accessor.
-  #
-  # @param [ClassObject] klass the class whose members we're working with
-  # @param [String] member the name of the member we're generating documentation for
-  # @return [String] a docstring to be attached to the getter method for this member
-  def add_reader_tags(klass, new_method, member)
-    member_tag = member_tag_for_member(klass, member, :read)
-    return_type = return_type_from_tag(member_tag)
-    getter_doc_text = member_tag ? member_tag.text : "Returns the value of attribute #{member}"
-    new_method.docstring.replace(getter_doc_text)
-    new_method.add_tag YARD::Tags::Tag.new(:return, "the current value of #{member}", return_type)
-  end
-
-  # Creates the auto-generated docstring for the setter method of a struct's
-  # member. This is used so the generated documentation will look just like that
-  # of an attribute defined using attr_accessor.
-  #
-  # @param [ClassObject] klass the class whose members we're working with
-  # @param [String] member the name of the member we're generating documentation for
-  # @return [String] a docstring to be attached to the setter method for this member
-  def add_writer_tags(klass, new_method, member)
-    member_tag = member_tag_for_member(klass, member, :write)
-    return_type = return_type_from_tag(member_tag)
-    setter_doc_text = member_tag ? member_tag.text : "Sets the attribute #{member}"
-    new_method.docstring.replace(setter_doc_text)
-    new_method.add_tag YARD::Tags::Tag.new(:param, "the value to set the attribute #{member} to.", return_type, "value")
-    new_method.add_tag YARD::Tags::Tag.new(:return, "the newly set value", return_type)
-  end
-
-  # Creates and registers a class object with the given name and superclass name.
-  # Returns it for further use.
-  #
-  # @param [String] classname the name of the class
-  # @param [String] superclass the name of the superclass
-  # @return [ClassObject] the class object for further processing/method attaching
-  def create_class(classname, superclass)
-    register ClassObject.new(namespace, classname) do |o|
-      o.superclass = superclass if superclass
-      o.superclass.type = :class if o.superclass.is_a?(Proxy)
-    end
-  end
-
-  # Creates the setter (writer) method and attaches it to the class as an attribute.
-  # Also sets up the docstring to prettify the documentation output.
-  #
-  # @param [ClassObject] klass the class to attach the method to
-  # @param [String] member the name of the member we're generating a method for
-  def create_writer(klass, member)
-    # We want to convert these members into attributes just like
-    # as if they were declared using attr_accessor.
-    new_meth = register MethodObject.new(klass, "#{member}=", :instance) do |o|
-      o.parameters = [['value', nil]]
-      o.signature ||= "def #{member}=(value)"
-      o.source ||= "#{o.signature}\n  @#{member} = value\nend"
-    end
-    add_writer_tags(klass, new_meth, member)
-    klass.attributes[:instance][member][:write] = new_meth
-  end
-
-  # Creates the getter (reader) method and attaches it to the class as an attribute.
-  # Also sets up the docstring to prettify the documentation output.
-  #
-  # @param [ClassObject] klass the class to attach the method to
-  # @param [String] member the name of the member we're generating a method for
-  def create_reader(klass, member)
-    new_meth = register MethodObject.new(klass, member, :instance) do |o|
-      o.signature ||= "def #{member}"
-      o.source ||= "#{o.signature}\n  @#{member}\nend"
-    end
-    add_reader_tags(klass, new_meth, member)
-    klass.attributes[:instance][member][:read] = new_meth
-  end
-
-  # Creates the given member methods and attaches them to the given ClassObject.
-  #
-  # @param [ClassObject] klass the class to generate attributes for
-  # @param [Array<String>] members a list of member names
-  def create_attributes(klass, members)
-    # For each parameter, add reader and writers
-    members.each do |member|
-      next if klass.attributes[:instance][member]
-      klass.attributes[:instance][member] = SymbolHash[:read => nil, :write => nil]
-      create_writer klass, member if create_member_method?(klass, member, :write)
-      create_reader klass, member if create_member_method?(klass, member, :read)
-    end
-  end
-end