climine 0.0.6 → 0.0.7

data/vendor/bundle/ruby/2.1.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/attribute_handler.rb

@@ -0,0 +1,60 @@
+# (see Ruby::AttributeHandler)
+class YARD::Handlers::Ruby::Legacy::AttributeHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles /\Aattr(?:_(?:reader|writer|accessor))?(?:\s|\()/
+  namespace_only
+
+  process do
+    begin
+      attr_type   = statement.tokens.first.text.to_sym
+      symbols     = tokval_list statement.tokens[2..-1], :attr, TkTRUE, TkFALSE
+      read, write = true, false
+    rescue SyntaxError
+      raise YARD::Parser::UndocumentableError, attr_type
+    end
+
+    # Change read/write based on attr_reader/writer/accessor
+    case attr_type
+    when :attr
+      # In the case of 'attr', the second parameter (if given) isn't a symbol.
+      write = symbols.pop if symbols.size == 2
+    when :attr_accessor
+      write = true
+    when :attr_reader
+      # change nothing
+    when :attr_writer
+      read, write = false, true
+    end
+
+    # Add all attributes
+    symbols.each do |name|
+      namespace.attributes[scope][name] = SymbolHash[:read => nil, :write => nil]
+
+      # Show their methods as well
+      {:read => name, :write => "#{name}="}.each do |type, meth|
+        if (type == :read ? read : write)
+          o = MethodObject.new(namespace, meth, scope)
+          if type == :write
+            o.parameters = [['value', nil]]
+            src = "def #{meth}(value)"
+            full_src = "#{src}\n  @#{name} = value\nend"
+            doc = "Sets the attribute #{name}\n@param value the value to set the attribute #{name} to."
+          else
+            src = "def #{meth}"
+            full_src = "#{src}\n  @#{name}\nend"
+            doc = "Returns the value of attribute #{name}"
+          end
+          o.source ||= full_src
+          o.signature ||= src
+          register(o)
+          o.docstring = doc if o.docstring.blank?(false)
+
+          # Regsiter the object explicitly
+          namespace.attributes[scope][name][type] = o
+        elsif obj = namespace.children.find {|o| o.name == meth.to_sym && o.scope == scope }
+          # register an existing method as attribute
+          namespace.attributes[scope][name][type] = obj
+        end
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.1.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/base.rb

@@ -0,0 +1,250 @@
+module YARD
+  module Handlers
+    module Ruby::Legacy
+      # This is the base handler for the legacy parser. To implement a legacy
+      # handler, subclass this class.
+      #
+      # @abstract (see Ruby::Base)
+      class Base < Handlers::Base
+        # For tokens like TkDEF, TkCLASS, etc.
+        include YARD::Parser::Ruby::Legacy::RubyToken
+
+        # @return [Boolean] whether or not a {Parser::Ruby::Legacy::Statement} object should be handled
+        #   by this handler.
+        def self.handles?(stmt)
+          handlers.any? do |a_handler|
+            case a_handler
+            when String
+              stmt.tokens.first.text == a_handler
+            when Regexp
+              stmt.tokens.to_s =~ a_handler
+            else
+              a_handler == stmt.tokens.first.class
+            end
+          end
+        end
+
+        # Parses a statement's block with a set of state values. If the
+        # statement has no block, nothing happens. A description of state
+        # values can be found at {Handlers::Base#push_state}
+        #
+        # @param [Hash] opts State options
+        # @option opts (see Handlers::Base#push_state)
+        # @see Handlers::Base#push_state #push_state
+        def parse_block(opts = {})
+          push_state(opts) do
+            if statement.block
+              blk = Parser::Ruby::Legacy::StatementList.new(statement.block)
+              parser.process(blk)
+            end
+          end
+        end
+
+        def call_params
+          if statement.tokens.first.is_a?(TkDEF)
+            extract_method_details.last.map {|param| param.first }
+          else
+            tokens = statement.tokens[1..-1]
+            tokval_list(tokens, :attr, :identifier, TkId).map do |value|
+              value.to_s
+            end
+          end
+        end
+
+        def caller_method
+          if statement.tokens.first.is_a?(TkIDENTIFIER)
+            statement.tokens.first.text
+          elsif statement.tokens.first.is_a?(TkDEF)
+            extract_method_details.first
+          else
+            nil
+          end
+        end
+
+        private
+
+        # Extracts method information for macro expansion only
+        #
+        # @todo This is a duplicate implementation of {MethodHandler}. Refactor.
+        # @return [Array<String,Array<Array<String>>>] the method name followed by method
+        #   arguments (name and optional value)
+        def extract_method_details
+          if statement.tokens.to_s =~ /^def\s+(#{METHODMATCH})(?:(?:\s+|\s*\()(.*)(?:\)\s*$)?)?/m
+            meth, args = $1, $2
+            meth.gsub!(/\s+/,'')
+            args = tokval_list(Parser::Ruby::Legacy::TokenList.new(args), :all)
+            args.map! {|a| k, v = *a.split('=', 2); [k.strip, (v ? v.strip : nil)] } if args
+            if meth =~ /(?:#{NSEPQ}|#{CSEPQ})([^#{NSEP}#{CSEPQ}]+)$/
+              meth = $`
+            end
+            return meth, args
+          end
+        end
+
+        # The string value of a token. For example, the return value for the symbol :sym
+        # would be :sym. The return value for a string +"foo #{ bar}"+ would be the literal
+        # +"foo #{ bar}"+ without any interpolation. The return value of the identifier
+        # 'test' would be the same value: 'test'. Here is a list of common types and
+        # their return values:
+        #
+        # @example
+        #   tokval(TokenList.new('"foo"').first) => "foo"
+        #   tokval(TokenList.new(':foo').first) => :foo
+        #   tokval(TokenList.new('CONSTANT').first, RubyToken::TkId) => "CONSTANT"
+        #   tokval(TokenList.new('identifier').first, RubyToken::TkId) => "identifier"
+        #   tokval(TokenList.new('3.25').first) => 3.25
+        #   tokval(TokenList.new('/xyz/i').first) => /xyz/i
+        #
+        # @param [Token] token The token of the class
+        #
+        # @param [Array<Class<Token>>, Symbol] accepted_types
+        #   The allowed token types that this token can be. Defaults to [{TkVal}].
+        #   A list of types would be, for example, [+TkSTRING+, +TkSYMBOL+], to return
+        #   the token's value if it is either of those types. If +TkVal+ is accepted,
+        #   +TkNode+ is also accepted.
+        #
+        #   Certain symbol keys are allowed to specify multiple types in one fell swoop.
+        #   These symbols are:
+        #     :string       => +TkSTRING+, +TkDSTRING+, +TkDXSTRING+ and +TkXSTRING+
+        #     :attr         => +TkSYMBOL+ and +TkSTRING+
+        #     :identifier   => +TkIDENTIFIER, +TkFID+ and +TkGVAR+.
+        #     :number       => +TkFLOAT+, +TkINTEGER+
+        #
+        # @return [Object] if the token is one of the accepted types, in its real value form.
+        #   It should be noted that identifiers and constants are kept in String form.
+        # @return [nil] if the token is not any of the specified accepted types
+        def tokval(token, *accepted_types)
+          accepted_types = [TkVal] if accepted_types.empty?
+          accepted_types.push(TkNode) if accepted_types.include? TkVal
+
+          if accepted_types.include?(:attr)
+            accepted_types.push(TkSTRING, TkSYMBOL)
+          end
+
+          if accepted_types.include?(:string)
+            accepted_types.push(TkSTRING, TkDSTRING, TkXSTRING, TkDXSTRING)
+          end
+
+          if accepted_types.include?(:identifier)
+            accepted_types.push(TkIDENTIFIER, TkFID, TkGVAR)
+          end
+
+          if accepted_types.include?(:number)
+            accepted_types.push(TkFLOAT, TkINTEGER)
+          end
+
+          return unless accepted_types.any? {|t| t === token }
+
+          case token
+          when TkSTRING, TkDSTRING, TkXSTRING, TkDXSTRING
+            token.text[1..-2]
+          when TkSYMBOL
+            token.text[1..-1].to_sym
+          when TkFLOAT
+            token.text.to_f
+          when TkINTEGER
+            token.text.to_i
+          when TkREGEXP
+            token.text =~ /\A\/(.+)\/([^\/])\Z/
+            Regexp.new($1, $2)
+          when TkTRUE
+            true
+          when TkFALSE
+            false
+          when TkNIL
+            nil
+          else
+            token.text
+          end
+        end
+
+        # Returns a list of symbols or string values from a statement.
+        # The list must be a valid comma delimited list, and values
+        # will only be returned to the end of the list only.
+        #
+        # Example:
+        #   attr_accessor :a, 'b', :c, :d => ['a', 'b', 'c', 'd']
+        #   attr_accessor 'a', UNACCEPTED_TYPE, 'c' => ['a', 'c']
+        #
+        # The tokval list of a {Parser::Ruby::Legacy::TokenList} of the above
+        # code would be the {#tokval} value of :a, 'b',
+        # :c and :d.
+        #
+        # It should also be noted that this function stops immediately at
+        # any ruby keyword encountered:
+        #   "attr_accessor :a, :b, :c if x == 5"  => ['a', 'b', 'c']
+        #
+        # @param [TokenList] tokenlist The list of tokens to process.
+        # @param [Array<Class<Token>>] accepted_types passed to {#tokval}
+        # @return [Array<String>] the list of tokvalues in the list.
+        # @return [Array<EMPTY>] if there are no symbols or Strings in the list
+        # @see #tokval
+        def tokval_list(tokenlist, *accepted_types)
+          return [] unless tokenlist
+          out = [[]]
+          parencount, beforeparen = 0, 0
+          needcomma = false
+          seen_comma = true
+          tokenlist.each do |token|
+            tokval = accepted_types == [:all] ? token.text : tokval(token, *accepted_types)
+            parencond = !out.last.empty? && tokval != nil
+            #puts "#{seen_comma.inspect} #{parencount} #{token.class.class_name} #{out.inspect}"
+            case token
+            when TkCOMMA
+              if parencount == 0
+                out << [] unless out.last.empty?
+                needcomma = false
+                seen_comma = true
+              else
+                out.last << token.text if parencond
+              end
+            when TkLPAREN
+              if seen_comma
+                beforeparen += 1
+              else
+                parencount += 1
+                out.last << token.text if parencond
+              end
+            when TkRPAREN
+              if beforeparen > 0
+                beforeparen -= 1
+              else
+                out.last << token.text if parencount > 0 && tokval != nil
+                parencount -= 1
+              end
+            when TkLBRACE, TkLBRACK, TkDO
+              parencount += 1
+              out.last << token.text if tokval != nil
+            when TkRBRACE, TkRBRACK, TkEND
+              out.last << token.text if tokval != nil
+              parencount -= 1
+            else
+              break if TkKW === token && ![TkTRUE, TkFALSE, TkSUPER, TkSELF, TkNIL].include?(token.class)
+
+              seen_comma = false unless TkWhitespace === token
+              if parencount == 0
+                next if needcomma
+                next if TkWhitespace === token
+                if tokval != nil
+                  out.last << tokval
+                else
+                  out.last.clear
+                  needcomma = true
+                end
+              elsif parencond
+                needcomma = true
+                out.last << token.text
+              end
+            end
+
+            if beforeparen == 0 && parencount < 0
+              break
+            end
+          end
+          # Flatten any single element lists
+          out.map {|e| e.empty? ? nil : (e.size == 1 ? e.pop : e.flatten.join) }.compact
+        end
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.1.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/class_condition_handler.rb

@@ -0,0 +1,83 @@
+# (see Ruby::ClassConditionHandler)
+# @since 0.5.4
+class YARD::Handlers::Ruby::Legacy::ClassConditionHandler < YARD::Handlers::Ruby::Legacy::Base
+  namespace_only
+  handles TkIF, TkELSIF, TkUNLESS
+
+  process do
+    condition = parse_condition
+    if condition == nil
+      # Parse both blocks if we're unsure of the condition
+      parse_then_block
+      parse_else_block
+    elsif condition
+      parse_then_block
+    else
+      parse_else_block
+    end
+  end
+
+  protected
+
+  # Parses the condition part of the if/unless statement
+  #
+  # @return [true, false, nil] true if the condition can be definitely
+  #   parsed to true, false if not, and nil if the condition cannot be
+  #   parsed with certainty (it's dynamic)
+  # @since 0.5.5
+  def parse_condition
+    condition = nil
+
+    # Right now we can handle very simple unary conditions like:
+    #   if true
+    #   if false
+    #   if 0
+    #   if 100 (not 0)
+    #   if defined? SOME_CONSTANT
+    #
+    # The last case will do a lookup in the registry and then one
+    # in the Ruby world (using eval).
+    case statement.tokens[1..-1].to_s.strip
+    when /^(\d+)$/
+      condition = $1 != "0"
+    when /^defined\?\s*\(?(.+?)\)?$/
+      # defined? keyword used, let's see if we can look up the name
+      # in the registry, then we'll try using Ruby's powers. eval() is not
+      # *too* dangerous here since code is not actually executed.
+      name = $1
+      obj = YARD::Registry.resolve(namespace, name, true)
+      begin
+        condition = true if obj || Object.instance_eval("defined? #{name}")
+      rescue SyntaxError, NameError
+        condition = false
+      end
+    when "true"
+      condition = true
+    when "false"
+      condition = false
+    end
+
+    if TkUNLESS === statement.tokens.first
+      condition = !condition if condition != nil
+    end
+    condition
+  end
+
+  # @since 0.5.5
+  def parse_then_block
+    parse_block(:visibility => visibility)
+  end
+
+  # @since 0.5.5
+  def parse_else_block
+    return unless statement.block
+    stmtlist = YARD::Parser::Ruby::Legacy::StatementList
+    stmtlist.new(statement.block).each do |stmt|
+      if TkELSE === stmt.tokens.first
+        push_state(:visibility => visibility) do
+          parser.process(stmtlist.new(stmt.block))
+        end
+      end
+    end
+  end
+end

data/vendor/bundle/ruby/2.1.0/gems/yard-0.8.7.3/lib/yard/handlers/ruby/legacy/class_handler.rb

@@ -0,0 +1,111 @@
+# (see Ruby::ClassHandler)
+class YARD::Handlers::Ruby::Legacy::ClassHandler < YARD::Handlers::Ruby::Legacy::Base
+  include YARD::Handlers::Ruby::StructHandlerMethods
+  handles TkCLASS
+  namespace_only
+
+  process do
+    if statement.tokens.to_s =~ /^class\s+(#{NAMESPACEMATCH})\s*(?:<\s*(.+)|\Z)/m
+      classname = $1
+      superclass_def = $2
+      superclass = parse_superclass($2)
+      classname = classname.gsub(/\s/, '')
+      if superclass == "Struct"
+        is_a_struct = true
+        superclass = struct_superclass_name(superclass_def)
+        create_struct_superclass(superclass, superclass_def)
+      end
+      undocsuper = superclass_def && superclass.nil?
+
+      klass = register ClassObject.new(namespace, classname) do |o|
+        o.superclass = superclass if superclass
+        o.superclass.type = :class if o.superclass.is_a?(Proxy)
+      end
+      if is_a_struct
+        parse_struct_subclass(klass, superclass_def)
+      elsif klass
+        create_attributes(klass, members_from_tags(klass))
+      end
+      parse_block(:namespace => klass)
+
+      if undocsuper
+        raise YARD::Parser::UndocumentableError, 'superclass (class was added without superclass)'
+      end
+    elsif statement.tokens.to_s =~ /^class\s*<<\s*([\w\:\s]+)/
+      classname = $1.gsub(/\s/, '')
+      proxy = Proxy.new(namespace, classname)
+
+      # Allow constants to reference class names
+      if ConstantObject === proxy
+        if proxy.value =~ /\A#{NAMESPACEMATCH}\Z/
+          proxy = Proxy.new(namespace, proxy.value)
+        else
+          raise YARD::Parser::UndocumentableError, "constant class reference '#{classname}'"
+        end
+      end
+
+      if classname == "self"
+        parse_block(:namespace => namespace, :scope => :class)
+      elsif classname[0,1] =~ /[A-Z]/
+        register ClassObject.new(namespace, classname) if Proxy === proxy
+        parse_block(:namespace => proxy, :scope => :class)
+      else
+        raise YARD::Parser::UndocumentableError, "class '#{classname}'"
+      end
+    else
+      raise YARD::Parser::UndocumentableError, "class: #{statement.tokens}"
+    end
+  end
+
+  private
+
+  # Extracts the parameter list from the Struct.new declaration and returns it
+  # formatted as a list of member names. Expects the user will have used symbols
+  # to define the struct member names
+  #
+  # @param [String] superstring the string declaring the superclass
+  # @return [Array<String>] a list of member names
+  def extract_parameters(superstring)
+    paramstring = superstring.match(/\A(O?Struct)\.new\((.*?)\)/)[2]
+    paramstring.split(",").select {|x| x.strip[0,1] == ":"}.map {|x| x.strip[1..-1] } # the 1..-1 chops the leading :
+  end
+
+  def create_struct_superclass(superclass, superclass_def)
+    return if superclass == "Struct"
+    the_super = register ClassObject.new(P("Struct"), superclass[8..-1]) do |o|
+      o.superclass = "Struct"
+    end
+    parse_struct_subclass(the_super, superclass_def)
+    the_super
+  end
+
+  def struct_superclass_name(superclass)
+    if match = superclass.match(/\A(Struct)\.new\((.*?)\)/)
+      paramstring = match[2].split(",")
+      first = paramstring.first.strip
+      if first[0,1] =~ /['"]/ && first[-1,1] =~ /['"]/ && first !~ /\#\{/
+        return "Struct::#{first[1..-2]}"
+      end
+    end
+    "Struct"
+  end
+
+  def parse_struct_subclass(klass, superclass_def)
+    # Bounce if there's no parens
+    return unless superclass_def =~ /O?Struct\.new\((.*?)\)/
+    members = extract_parameters(superclass_def)
+    create_attributes(klass, members)
+  end
+
+  def parse_superclass(superclass)
+    case superclass
+    when /\A(#{NAMESPACEMATCH})(?:\s|\Z)/,
+         /\A(Struct|OStruct)\.new/,
+         /\ADelegateClass\((.+?)\)\s*\Z/,
+         /\A(#{NAMESPACEMATCH})\(/
+      $1
+    when "self"
+      namespace.path
+    end
+  end
+end