nutshell-crm 0.0.1 → 0.0.2

data/vendor/bundle/gems/yard-0.7.4/lib/yard/handlers/ruby/legacy/private_constant_handler.rb

@@ -0,0 +1,21 @@
+# (see Ruby::PrivateConstantHandler)
+class YARD::Handlers::Ruby::Legacy::PrivateConstantHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles /\Aprivate_constant(\s|\(|$)/
+  namespace_only
+
+  process do
+    tokval_list(statement.tokens[2..-1], :attr, TkCONSTANT).each do |name|
+      privatize_constant name
+    end
+  end
+
+  private
+
+  def privatize_constant(name)
+    const = Proxy.new(namespace, name)
+    ensure_loaded!(const)
+    const.visibility = :private
+  rescue NamespaceMissingError
+    raise UndocumentableError, "private visibility set on unrecognized constant: #{name}"
+  end
+end

data/vendor/bundle/gems/yard-0.7.4/lib/yard/handlers/ruby/legacy/visibility_handler.rb

@@ -0,0 +1,16 @@
+# (see Ruby::VisibilityHandler)
+class YARD::Handlers::Ruby::Legacy::VisibilityHandler < YARD::Handlers::Ruby::Legacy::Base
+  handles /\A(protected|private|public)(\s|\(|$)/
+  namespace_only
+
+  process do
+    vis = statement.tokens.first.text
+    if statement.tokens.size == 1
+      self.visibility = vis
+    else
+      tokval_list(statement.tokens[2..-1], :attr).each do |name|
+        MethodObject.new(namespace, name, scope) {|o| o.visibility = vis }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# (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.docstring.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.docstring.add_tag YARD::Tags::Tag.new(:yieldparam,
+          "the result of the method from the superclass", nil, '_super')
+      else
+        yieldtag.types << item
+      end
+    end
+
+    owner.docstring.add_tag(yieldtag) unless yieldtag.types.empty?
+  end
+end

data/vendor/bundle/gems/yard-0.7.4/lib/yard/handlers/ruby/macro_handler.rb

@@ -0,0 +1,40 @@
+module YARD
+  module Handlers
+    module Ruby
+      # Handles a macro (dsl-style method)
+      class MacroHandler < Base
+        include CodeObjects
+        include MacroHandlerMethods
+        handles method_call
+        namespace_only
+        
+        IGNORE_METHODS = Hash[*%w(alias alias_method autoload attr attr_accessor 
+          attr_reader attr_writer extend include public private protected 
+          private_constant).map {|n| [n, true] }.flatten]
+        
+        process do
+          globals.__attached_macros ||= {}
+          if !globals.__attached_macros[caller_method]
+            return if IGNORE_METHODS[caller_method]
+            return if !statement.comments || statement.comments.empty?
+          end
+          
+          @macro, @docstring = nil, Docstring.new(statement.comments)
+          find_or_create_macro(@docstring)
+          return if !@macro && !statement.comments_hash_flag && @docstring.tags.size == 0
+          @docstring = expanded_macro_or_docstring
+          name = method_name
+          raise UndocumentableError, "method, missing name" if name.nil? || name.empty?
+          tmp_scope = sanitize_scope
+          tmp_vis = sanitize_visibility
+          object = MethodObject.new(namespace, name, tmp_scope)
+          register(object)
+          object.visibility = tmp_vis
+          object.dynamic = true
+          object.signature = method_signature
+          create_attribute_data(object)
+        end
+      end
+    end
+  end
+end

data/vendor/bundle/gems/yard-0.7.4/lib/yard/handlers/ruby/macro_handler_methods.rb

@@ -0,0 +1,130 @@
+module YARD
+  module Handlers
+    module Ruby
+      module MacroHandlerMethods
+        include CodeObjects
+        include Parser
+        
+        def find_or_create_macro(docstring)
+          return @macro if @macro
+          return if @macro = super(docstring)
+
+          # Look for implicit macros
+          (globals.__attached_macros[caller_method] || []).each do |macro|
+            namespace.inheritance_tree.each do |obj|
+              break(@macro = macro) if obj == macro.method_object.namespace
+            end
+          end
+        end
+        
+        def expanded_macro_or_docstring
+          return @docstring unless @macro
+          all_params = ([caller_method] + call_params).compact
+          data = MacroObject.apply_macro(@macro, @docstring, all_params, statement.source)
+          Docstring.new(data)
+        end
+        
+        def expand_macro(object, macro)
+          if @docstring
+            object.docstring = @docstring
+            object.docstring.tags.each do |tag|
+              tag.object = object if tag.respond_to?(:object=)
+            end
+          else
+            super(object, macro)
+          end
+        end
+        
+        def sanitize_scope
+          tmp_scope = @docstring.tag(:scope) ? @docstring.tag(:scope).text : ''
+          %w(class instance).include?(tmp_scope) ? tmp_scope.to_sym : scope
+        end
+
+        def sanitize_visibility
+          vis = @docstring.tag(:visibility) ? @docstring.tag(:visibility).text : ''
+          %w(public protected private).include?(vis) ? vis.to_sym : visibility
+        end
+
+        def create_attribute_data(object)
+          return unless object.docstring.tag(:attribute)
+          ensure_loaded!(namespace)
+          clean_name = object.name.to_s.sub(/=$/, '')
+          namespace.attributes[object.scope][clean_name] ||= SymbolHash[:read => nil, :write => nil]
+          if attribute_readable?
+            namespace.attributes[object.scope][clean_name][:read] = object
+          end
+          if attribute_writable?
+            if object.name.to_s[-1,1] == '='
+              writer = object
+            else
+              writer = MethodObject.new(namespace, object.name.to_s + '=', object.scope)
+              register(writer)
+              writer.signature = "def #{object.name}=(value)"
+              writer.visibility = object.visibility
+              writer.dynamic = true
+            end
+            namespace.attributes[object.scope][clean_name][:write] = writer
+          end
+        end
+        
+        def method_name
+          name = nil
+          [:method, :attribute, :overload].each do |tag_name|
+            if tag = @docstring.tag(tag_name)
+              name = tag.send(tag_name == :attribute ? :text : :name).to_s
+              if tag_name == :method && name =~ /\(|\s/
+                overload = Tags::OverloadTag.new(:overload, name)
+                @docstring.add_tag(overload)
+              end
+              break
+            end
+          end
+          name = nil if name =~ /\A\s*\Z/
+          name ||= call_params.first
+          return unless name
+          if name =~ /\A\s*([^\(; \t]+)/
+            name = $1
+          end
+          if @docstring.tag(:attribute) && !attribute_readable?
+            name = name + '='
+          end
+          name
+        end
+
+        def method_signature
+          if @docstring.tag(:method)
+            name = @docstring.tag(:method).name
+          elsif @docstring.tag(:overload)
+            name = @docstring.tag(:overload).signature
+          elsif @docstring.tag(:attribute)
+            name = @docstring.tag(:attribute).text
+            name += '=(value)' if !attribute_readable?
+          else
+            name = method_name
+          end
+          name = nil if name =~ /\A\s*\Z/
+          name ||= call_params.first
+          name =~ /^def\b/ ? name : "def #{name}"
+        end
+
+        private
+
+        def attribute_writable?
+          if @docstring.tag(:attribute) 
+            types = @docstring.tag(:attribute).types
+            return types ? types.join.include?('w') : true
+          end
+          false
+        end
+
+        def attribute_readable?
+          if @docstring.tag(:attribute) 
+            types = @docstring.tag(:attribute).types
+            return types ? (types.join =~ /(?!w)r/ ? true : false) : true
+          end
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# 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/gems/yard-0.7.4/lib/yard/handlers/ruby/method_handler.rb

@@ -0,0 +1,94 @@
+# Handles a method definition
+class YARD::Handlers::Ruby::MethodHandler < YARD::Handlers::Ruby::Base
+  handles :def, :defs
+
+  process do
+    nobj = namespace
+    mscope = scope
+    if statement.type == :defs
+      if statement[0][0].type == :ident
+        raise YARD::Parser::UndocumentableError, 'method defined on object instance'
+      end
+      meth = statement[2][0]
+      nobj = P(namespace, statement[0].source) if statement[0][0].type == :const
+      args = format_args(statement[3])
+      blk = statement[4]
+      mscope = :class
+    else
+      meth = statement[0][0]
+      args = format_args(statement[1])
+      blk = statement[2]
+    end
+
+    nobj = P(namespace, nobj.value) while nobj.type == :constant
+    obj = register MethodObject.new(nobj, meth, mscope) do |o|
+      o.visibility = visibility
+      o.source = statement.source
+      o.signature = method_signature(meth)
+      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 mscope == :instance && meth == "initialize"
+      unless obj.has_tag?(:return)
+        obj.docstring.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.docstring.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?
+        obj.docstring.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
+      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.docstring.add_tag(new_tag)
+        end
+      end
+    end
+
+    if info = obj.attr_info
+      if meth.to_s =~ /=$/ # writer
+        info[:write] = obj if info[:read]
+      else
+        info[:read] = obj if info[:write]
+      end
+    end
+
+    parse_block(blk, :owner => obj) # mainly for yield/exceptions
+  end
+
+  def format_args(args)
+    args = args.jump(:params)
+    params = []
+    params += args.required_params.map {|a| [a.source, nil] } if args.required_params
+    params += args.optional_params.map {|a| [a[0].source, a[1].source] } if args.optional_params
+    params << ["*" + args.splat_param.source, nil] if args.splat_param
+    params += args.required_end_params.map {|a| [a.source, nil] } if args.required_end_params
+    params << ["&" + args.block_param.source, nil] if args.block_param
+    params
+  end
+
+  def method_signature(method_name)
+    if statement[1]
+      "def #{method_name}(#{statement[1].jump(:params).source})"
+    else
+      "def #{method_name}"
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# 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).each do |mixin|
+      begin
+        process_mixin(mixin)
+      rescue YARD::Parser::UndocumentableError => err
+        errors << err.message
+      end
+    end
+    if errors.size > 0
+      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 Proxy
+      obj.type = :module
+    when ConstantObject # If a constant is included, use its value as the real object
+      obj = Proxy.new(namespace, obj.value)
+    end
+
+    namespace.mixins(scope).unshift(obj) unless namespace.mixins(scope).include?(obj)
+  end
+end

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

@@ -0,0 +1,11 @@
+# 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/gems/yard-0.7.4/lib/yard/handlers/ruby/private_constant_handler.rb

@@ -0,0 +1,36 @@
+# Sets visibility of a constant (class, module, const)
+class YARD::Handlers::Ruby::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
+    if errors.size > 0
+      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

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

@@ -0,0 +1,140 @@
+# Helper methods to parse @attr_* tags on a class.
+#
+# @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 {|t| t.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
+    return !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 [ClassObject] klass the class whose tags we're searching
+  # @param [String] member the name of the struct member whose return type we need
+  # @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.docstring.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.docstring.add_tag YARD::Tags::Tag.new(:param, "the value to set the attribute #{member} to.", return_type, "value")
+    new_method.docstring.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|
+      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