yard-mongoid 0.0.3.pre → 0.0.3

data/Gemfile

@@ -6,4 +6,8 @@ gemspec
 group :development do
   gem 'rake'
   gem 'mongoid', '~> 3.0'
+  gem 'yard-activerecord' # Needed for some code examples
+  gem 'yard-activerecord2' # Needed for some code examples
+  gem 'yard-rails' # Needed for some code examples
+  gem 'yard-delegate' # Needed for some code examples
 end

data/lib/yard/{mongoid → handlers/ruby/mongoid}/extensions.rb

@@ -1,4 +1,4 @@
-module YARD
+module YARD::Handlers::Ruby
   module Mongoid
     module Extensions
     protected

data/lib/yard/handlers/ruby/mongoid/field_handler.rb

@@ -0,0 +1,149 @@
+require 'yard'
+require 'yard/handlers/ruby/mongoid/extensions'
+require 'yard/handlers/ruby/mongoid/helpers'
+
+module YARD::Handlers::Ruby
+  module Mongoid
+    class FieldHandler < YARD::Handlers::Ruby::AttributeHandler
+      include Extensions
+      include YARD::Handlers::Ruby::Mongoid::Helpers
+
+      MONGOID_FIELDS = 'Fields'
+
+      namespace_only
+
+      handles method_call(:field)
+
+      def process
+        name = statement.parameters[0].last
+
+        if name.type == :symbol
+          name = name.source[1..-1]
+
+          add_field_getter(effected_namespace, name, class_name, default_value)
+          add_field_setter(effected_namespace, name, class_name)
+          #register_field_presence(effected_namespace, name, scope)
+          #register_field_change(effected_namespace, name, scope)
+          #register_field_changed(effected_namespace, name, scope)
+          #register_field_was(effected_namespace, name, scope)
+          #register_field_reset(effected_namespace, name, scope)
+        end
+      end
+
+      protected
+
+      def class_name
+        return @class_name if instance_variable_defined?(:@class_name)
+
+        if statement.parameters.size > 2
+          statement.parameters[1].source.split(/,\s*/).each do |key_and_value|
+            if key_and_value =~ hash_args[:type]
+              @class_name = $2
+              break
+            end
+          end
+          @class_name = 'true, false' if @class_name == 'Boolean'
+        end
+        @class_name ||= 'String'
+      end
+
+      def default_value
+        return @default_value if instance_variable_defined?(:@default_value)
+
+        if statement.parameters.size > 2
+          statement.parameters[1].source.split(/,\s*/).each do |key_and_value|
+            if key_and_value =~ /(:default\s*=>|default:)\s*(.+)\s*$/
+              @default_value = $2
+              break
+            end
+          end
+        end
+        @default_value ||= nil
+      end
+
+      protected
+
+      def hash_args
+        @hash_args ||= Hash.new do |hash, key|
+          hash[key] = /(:#{key.to_s}\s*=>|#{key.to_s}:\s)\s*([A-Z][A-Za-z0-9]*)/
+        end
+      end
+
+      # @yieldparam [YARD::CodeObjects::MethodObject]
+      def add_field_method(namespace, name, &block)
+        register YARD::CodeObjects::MethodObject.new(namespace, name, :instance) do |mo|
+          mo.group = MONGOID_FIELDS
+          mo.visibility ||= :public
+          mo.source = statement.source
+          mo.dynamic = true
+          mo.signature = "def #{name}"
+          mo.docstring = '' if mo.docstring.empty?
+          block.call(mo) if block_given?
+        end
+      end
+
+      # Creates and registers a new +name+ method in +namespace+
+      # with an instance or class +scope+
+      # @param [NamespaceObject] namespace the namespace
+      # @param [String, Symbol] name the method name
+      def add_field_getter(namespace, name, type = 'Object', default_value = nil)
+        add_field_method(namespace, name) do |o|
+          default_value = "(defaults to: +#{default_value}+) " if default_value
+          o.docstring.add_tag get_tag(:return, default_value, type)
+        end
+      end
+
+      # Creates and registers a new +name+= method in +namespace+
+      # with an instance or class +scope+
+      # @param [NamespaceObject] namespace the namespace
+      # @param [String, Symbol] name the method name
+      def add_field_setter(namespace, name, type = 'Object')
+        add_field_method(namespace, "#{name}=") do |o|
+          o.parameters = [[name, nil]]
+          o.docstring.add_tag get_tag(:return, nil, type)
+          o.docstring.add_tag get_tag(:param, "new #{name}", type, name)
+        end
+      end
+
+      # Creates and registers a new +name+? method in +namespace+
+      # with an instance or class +scope+
+      # @param [NamespaceObject] namespace the namespace
+      # @param [String, Symbol] name the method name
+      def add_field_presence(namespace, name)
+        add_field_method(namespace, "#{name}?")
+      end
+
+      # Creates and registers a new +name+_change method in +namespace+
+      # with an instance or class +scope+
+      # @param [NamespaceObject] namespace the namespace
+      # @param [String, Symbol] name the method name
+      def add_field_change(namespace, name)
+        add_field_method(namespace, "#{name}_change")
+      end
+
+      # Creates and registers a new +name+_changed? method in +namespace+
+      # with an instance or class +scope+
+      # @param [NamespaceObject] namespace the namespace
+      # @param [String, Symbol] name the method name
+      def add_field_changed(namespace, name)
+        add_field_method(namespace, "#{name}_changed?")
+      end
+
+      # Creates and registers a new +name+_was method in +namespace+
+      # with an instance or class +scope+
+      # @param [NamespaceObject] namespace the namespace
+      # @param [String, Symbol] name the method name
+      def register_field_was(namespace, name)
+        add_field_method(namespace, "#{name}_was")
+      end
+
+      # Creates and registers a new reset_+name+! method in +namespace+
+      # with an instance or class +scope+
+      # @param [NamespaceObject] namespace the namespace
+      # @param [String, Symbol] name the method name
+      def register_field_reset(namespace, name)
+        add_field_method(namespace, "reset_#{name}!")
+      end
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/helpers.rb

@@ -0,0 +1,18 @@
+require 'yard/tags/tag'
+
+module YARD
+  module Handlers
+    module Ruby
+      module Mongoid
+        module Helpers
+          # @param [Symbol] tag
+          # @param [String] text
+          # @param [String] return_classes
+          def get_tag(tag, text, return_classes = [], name=nil)
+            YARD::Tags::Tag.new(tag, text, [return_classes].flatten, name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/relations/base.rb

@@ -0,0 +1,56 @@
+require 'yard'
+require 'active_support/inflector'
+require 'yard/handlers/ruby/mongoid/helpers'
+
+module YARD::Handlers::Ruby::Mongoid
+  module Relations
+    class Base < YARD::Handlers::Ruby::MethodHandler
+      include YARD::Handlers::Ruby::Mongoid::Helpers
+      namespace_only
+
+      def process
+        namespace.groups << group_name unless namespace.groups.include? group_name
+
+        object           = YARD::CodeObjects::MethodObject.new(namespace, method_name)
+        object.group     = group_name
+        object.docstring = return_description
+        object.docstring.add_tag get_tag(:return, '', class_name)
+        object.docstring.add_tag get_tag(:see, "http://mongoid.org/en/mongoid/docs/relations.html##{statement.method_name(true).to_s}")
+        object.dynamic = true
+        register object
+      end
+
+      def group_name
+        'Mongoid Relations'
+      end
+
+      private
+      def method_name
+        call_params[0]
+      end
+
+      def class_name(singularize = false)
+        param_size = statement.parameters.size
+        if param_size > 2
+          i = 1
+          while i < param_size - 1
+            # May want to evaluate doing it this way
+            statement.parameters[i].jump(:hash).source =~ /(:class_name\s*=>|class_name:)\s*["']([^"']+)["']/
+            return $2 if $2
+            i += 1
+          end
+        end
+
+        if singularize
+          method_name.camelize.singularize
+        else
+          method_name.camelize
+        end
+      end
+
+      def return_description
+        "An array of associated #{method_name}."
+      end
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/relations/belongs_to_handler.rb

@@ -0,0 +1,16 @@
+require 'yard/handlers/ruby/mongoid/relations/singular_handler'
+
+module YARD::Handlers::Ruby::Mongoid::Relations
+  class BelongsToHandler < SingularHandler
+    handles method_call(:belongs_to)
+
+    def group_name
+      'Belongs to'
+    end
+
+    private
+    def return_description
+      ''
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/relations/has_and_belongs_to_many_handler.rb

@@ -0,0 +1,16 @@
+require 'yard/handlers/ruby/mongoid/relations/plural_handler'
+
+module YARD::Handlers::Ruby::Mongoid::Relations
+  class HasManyHandler < PluralHandler
+    handles method_call(:has_and_belongs_to_many)
+
+    def group_name
+      'Has and belongs to many'
+    end
+
+    private
+    def return_description
+      ''
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/relations/has_many_handler.rb

@@ -0,0 +1,16 @@
+require 'yard/handlers/ruby/mongoid/relations/plural_handler'
+
+module YARD::Handlers::Ruby::Mongoid::Relations
+  class HasManyHandler < PluralHandler
+    handles method_call(:has_many)
+
+    def group_name
+      'Has many'
+    end
+
+    private
+    def return_description
+      ''
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/relations/has_one_handler.rb

@@ -0,0 +1,16 @@
+require 'yard/handlers/ruby/mongoid/relations/singular_handler'
+
+module YARD::Handlers::Ruby::Mongoid::Relations
+  class HasOneHandler < SingularHandler
+    handles method_call(:has_one)
+
+    def group_name
+      'Has one'
+    end
+
+    private
+    def return_description
+      ''
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/relations/plural_handler.rb

@@ -0,0 +1,14 @@
+require 'yard/handlers/ruby/mongoid/relations/base'
+
+module YARD::Handlers::Ruby::Mongoid::Relations
+  class PluralHandler < Base
+    def class_name
+      "Array<#{super(true)}>"
+    end
+
+    private
+    def return_description
+      "An array of associated #{method_name.humanize}"
+    end
+  end
+end

data/lib/yard/handlers/ruby/mongoid/relations/singular_handler.rb

@@ -0,0 +1,14 @@
+require 'yard/handlers/ruby/mongoid/relations/base'
+
+module YARD::Handlers::Ruby::Mongoid::Relations
+  class SingularHandler < Base
+    def class_name
+      super(false)
+    end
+
+    private
+    def return_description
+      "An associated {#{method_name.humanize}}"
+    end
+  end
+end

data/lib/yard/mongoid.rb

@@ -1,9 +1,17 @@
+require 'yard'
 require 'yard/mongoid/version'
+
 module YARD
-  module Mongoid
-    MONGOID_FIELDS = 'Mongoid Fields'
+  module Handlers
+    module Ruby
+      module Mongoid
+      end
+    end
   end
 end
 
-require 'yard/mongoid/field_handler'
-require 'yard/mongoid/legacy/field_handler'
+require 'yard/handlers/ruby/mongoid/field_handler'
+require 'yard/handlers/ruby/mongoid/relations/belongs_to_handler'
+require 'yard/handlers/ruby/mongoid/relations/has_one_handler'
+require 'yard/handlers/ruby/mongoid/relations/has_many_handler'
+require 'yard/handlers/ruby/mongoid/relations/has_and_belongs_to_many_handler'

data/lib/yard/mongoid/version.rb

@@ -1,5 +1,5 @@
 module Yard
   module Mongoid
-    VERSION = '0.0.3.pre'
+    VERSION = '0.0.3'
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yard-mongoid
 version: !ruby/object:Gem::Version
-  version: 0.0.3.pre
-  prerelease: 6
+  version: 0.0.3
+  prerelease: 
 platform: ruby
 authors:
 - Alexander Semyonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -40,11 +40,17 @@ files:
 - MIT-LICENSE
 - Rakefile
 - lib/yard-mongoid.rb
+- lib/yard/handlers/ruby/mongoid/extensions.rb
+- lib/yard/handlers/ruby/mongoid/field_handler.rb
+- lib/yard/handlers/ruby/mongoid/helpers.rb
+- lib/yard/handlers/ruby/mongoid/relations/base.rb
+- lib/yard/handlers/ruby/mongoid/relations/belongs_to_handler.rb
+- lib/yard/handlers/ruby/mongoid/relations/has_and_belongs_to_many_handler.rb
+- lib/yard/handlers/ruby/mongoid/relations/has_many_handler.rb
+- lib/yard/handlers/ruby/mongoid/relations/has_one_handler.rb
+- lib/yard/handlers/ruby/mongoid/relations/plural_handler.rb
+- lib/yard/handlers/ruby/mongoid/relations/singular_handler.rb
 - lib/yard/mongoid.rb
-- lib/yard/mongoid/extensions.rb
-- lib/yard/mongoid/field_handler.rb
-- lib/yard/mongoid/helpers.rb
-- lib/yard/mongoid/legacy/field_handler.rb
 - lib/yard/mongoid/version.rb
 - yard-mongoid.gemspec
 homepage: http://rubygems.org/gems/yard-mongoid
@@ -62,9 +68,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: yard-mongoid
 rubygems_version: 1.8.23

data/lib/yard/mongoid/field_handler.rb

@@ -1,66 +0,0 @@
-require 'yard/mongoid/extensions'
-require 'yard/mongoid/helpers'
-
-module YARD
-  module Mongoid
-    class FieldHandler < YARD::Handlers::Ruby::AttributeHandler
-      include Extensions
-      include Helpers
-
-      handles method_call(:field)
-
-      def process
-        name       = statement.parameters[0].last
-
-        if name.type == :symbol
-          name = name.source[1..-1]
-
-          register_field_getter(effected_namespace, name, scope, class_name, default_value)
-          register_field_setter(effected_namespace, name, scope)
-          register_field_presence(effected_namespace, name, scope)
-          register_field_change(effected_namespace, name, scope)
-          register_field_changed(effected_namespace, name, scope)
-          register_field_was(effected_namespace, name, scope)
-          register_field_reset(effected_namespace, name, scope)
-          super
-        end
-      end
-
-      protected
-
-      def class_name
-        return @class_name if instance_variable_defined?(:@class_name)
-
-        if statement.parameters.size > 2
-          statement.parameters[1].source.split(/,\s*/).each do |key_and_value|
-            if key_and_value =~ hash_args[:type]
-              @class_name = $2
-              break
-            end
-          end
-        end
-        @class_name ||= 'String'
-      end
-
-      def default_value
-        return @default_value if instance_variable_defined?(:@default_value)
-
-        if statement.parameters.size > 2
-          statement.parameters[1].source.split(/,\s*/).each do |key_and_value|
-            if key_and_value =~ /(:default\s*=>|default:)\s*(.+)\s*$/
-              @default_value = $2
-              break
-            end
-          end
-        end
-        @default_value ||= nil
-      end
-
-      protected
-
-      def hash_args
-        @hash_args ||= Hash.new { |hash, key| hash[key] = /(:#{key.to_s}\s*=>|#{key.to_s}:)\s*([A-Z][A-Za-z0-9]*)/ }
-      end
-    end
-  end
-end

data/lib/yard/mongoid/helpers.rb

@@ -1,114 +0,0 @@
-module YARD
-  module Mongoid
-    module Helpers
-      def register_new_method_object(namespace, name, scope = :instance, &block)
-        register self.class.const_get(:MethodObject).new(namespace, name, scope, &block)
-      end
-
-      # Creates and registers a new +name+ method in +namespace+
-      # with an instance or class +scope+
-      # @param [NamespaceObject] namespace the namespace
-      # @param [String, Symbol] name the method name
-      # @param [Symbol] scope +:instance+ or +:class+
-      def register_field_getter(namespace, name, scope = :instance, type = 'Object', default_value = nil)
-        register_new_method_object(namespace, name, scope) do |o|
-          o.group = MONGOID_FIELDS
-          o.visibility = :public
-          o.source = statement.source
-          o.signature = "def #{name}"
-        end.tap do |o|
-          docstring = o.docstring.empty? ? "Field #{name}" : o.docstring
-          docstring += "\n@return [#{type}] "
-          docstring += "(defaults to: +#{default_value}+) " if default_value
-          o.docstring = docstring
-        end
-      end
-
-      # Creates and registers a new +name+= method in +namespace+
-      # with an instance or class +scope+
-      # @param [NamespaceObject] namespace the namespace
-      # @param [String, Symbol] name the method name
-      # @param [Symbol] scope +:instance+ or +:class+
-      def register_field_setter(namespace, name, scope = :instance)
-        register_new_method_object(namespace, "#{name}=", scope) do |o|
-          o.group = MONGOID_FIELDS
-          o.visibility = :public
-          o.source = statement.source
-          o.signature = "def #{name}=(value)"
-          o.parameters = [['value', nil]]
-          o.docstring = "Sets the attribute #{name}\n@param value the value to set the attribute #{name} to."
-        end
-      end
-
-      # Creates and registers a new +name+? method in +namespace+
-      # with an instance or class +scope+
-      # @param [NamespaceObject] namespace the namespace
-      # @param [String, Symbol] name the method name
-      # @param [Symbol] scope +:instance+ or +:class+
-      def register_field_presence(namespace, name, scope = :instance)
-        register_new_method_object(namespace, "#{name}?", scope) do |o|
-          o.group = MONGOID_FIELDS
-          o.visibility = :public
-          o.source = statement.source
-          o.signature = "def #{name}?"
-        end
-      end
-
-      # Creates and registers a new +name+_change method in +namespace+
-      # with an instance or class +scope+
-      # @param [NamespaceObject] namespace the namespace
-      # @param [String, Symbol] name the method name
-      # @param [Symbol] scope +:instance+ or +:class+
-      def register_field_change(namespace, name, scope = :instance)
-        register_new_method_object(namespace, "#{name}_change", scope) do |o|
-          o.group = MONGOID_FIELDS
-          o.visibility = :public
-          o.source = statement.source
-          o.signature = "def #{name}_change"
-        end
-      end
-
-      # Creates and registers a new +name+_changed? method in +namespace+
-      # with an instance or class +scope+
-      # @param [NamespaceObject] namespace the namespace
-      # @param [String, Symbol] name the method name
-      # @param [Symbol] scope +:instance+ or +:class+
-      def register_field_changed(namespace, name, scope = :instance)
-        register_new_method_object(namespace, "#{name}_changed?", scope) do |o|
-          o.group = MONGOID_FIELDS
-          o.visibility = :public
-          o.source = statement.source
-          o.signature = "def #{name}_changed?"
-        end
-      end
-
-      # Creates and registers a new +name+_was method in +namespace+
-      # with an instance or class +scope+
-      # @param [NamespaceObject] namespace the namespace
-      # @param [String, Symbol] name the method name
-      # @param [Symbol] scope +:instance+ or +:class+
-      def register_field_was(namespace, name, scope = :instance)
-        register_new_method_object(namespace, "#{name}_was", scope) do |o|
-          o.group = MONGOID_FIELDS
-          o.visibility = :public
-          o.source = statement.source
-          o.signature = "def #{name}_was"
-        end
-      end
-
-      # Creates and registers a new reset_+name+! method in +namespace+
-      # with an instance or class +scope+
-      # @param [NamespaceObject] namespace the namespace
-      # @param [String, Symbol] name the method name
-      # @param [Symbol] scope +:instance+ or +:class+
-      def register_field_reset(namespace, name, scope = :instance)
-        register_new_method_object(namespace, "reset_#{name}!", scope) do |o|
-          o.group = MONGOID_FIELDS
-          o.visibility = :public
-          o.source = statement.source
-          o.signature = "def reset_#{name}!"
-        end
-      end
-    end
-  end
-end

data/lib/yard/mongoid/legacy/field_handler.rb

@@ -1,26 +0,0 @@
-require 'yard/mongoid/helpers'
-
-module YARD
-  module Mongoid
-    module Legacy
-      class FieldHandler < YARD::Handlers::Ruby::Legacy::AttributeHandler
-        include YARD::Mongoid::Helpers
-
-        handles /\Afield\s+:/
-
-        def process
-          name = statement.tokens[2,1].to_s[1..-1]
-
-          register_field_getter(namespace, name, scope)
-          #register_field_setter(namespace, name, scope)
-          #register_field_presence(namespace, name, scope)
-          #register_field_change(namespace, name, scope)
-          #register_field_changed(namespace, name, scope)
-          #register_field_was(namespace, name, scope)
-          #register_field_reset(namespace, name, scope)
-          #super
-        end
-      end
-    end
-  end
-end