yard-mongoid 0.0.2 → 0.0.3.pre

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+Gemfile.lock

data/Gemfile

@@ -1,6 +1,9 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in yard-mongoid.gemspec
 gemspec
 
-gem 'yard', '~> 0.6.1'
+group :development do
+  gem 'rake'
+  gem 'mongoid', '~> 3.0'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+© 2011-2013 Alexander Semyonov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/yard/mongoid.rb

@@ -1,8 +1,7 @@
+require 'yard/mongoid/version'
 module YARD
   module Mongoid
-    autoload :VERSION,    'yard/mongoid/version'
-    autoload :Extensions, 'yard/mongoid/extensions'
-    autoload :Helpers,    'yard/mongoid/helpers'
+    MONGOID_FIELDS = 'Mongoid Fields'
   end
 end
 

data/lib/yard/mongoid/extensions.rb

@@ -13,7 +13,7 @@ module YARD
           end
         end
 
-        return namespace
+        namespace
       end
     end
   end

data/lib/yard/mongoid/field_handler.rb

@@ -1,3 +1,6 @@
+require 'yard/mongoid/extensions'
+require 'yard/mongoid/helpers'
+
 module YARD
   module Mongoid
     class FieldHandler < YARD::Handlers::Ruby::AttributeHandler
@@ -7,23 +10,57 @@ module YARD
       handles method_call(:field)
 
       def process
-        nobj = effected_namespace
-        mscope = scope
-        name = statement.parameters[0].last
+        name       = statement.parameters[0].last
 
         if name.type == :symbol
           name = name.source[1..-1]
 
-          #register_field_getter(nobj, name, mscope)
-          register_field_setter(nobj, name, mscope)
-          register_field_presence(nobj, name, mscope)
-          register_field_change(nobj, name, mscope)
-          register_field_changed(nobj, name, mscope)
-          register_field_was(nobj, name, mscope)
-          register_field_reset(nobj, name, mscope)
+          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

@@ -10,12 +10,17 @@ module YARD
       # @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)
+      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}"
-          o.docstring = "Returns the value of attribute #{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
 
@@ -26,6 +31,7 @@ module YARD
       # @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)"
@@ -41,6 +47,7 @@ module YARD
       # @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}?"
@@ -54,6 +61,7 @@ module YARD
       # @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"
@@ -67,6 +75,7 @@ module YARD
       # @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?"
@@ -80,6 +89,7 @@ module YARD
       # @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"
@@ -93,6 +103,7 @@ module YARD
       # @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}!"

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

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

data/lib/yard/mongoid/version.rb

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

data/yard-mongoid.gemspec

@@ -1,21 +1,23 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "yard/mongoid/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'yard/mongoid/version'
 
 Gem::Specification.new do |s|
-  s.name        = "yard-mongoid"
+  s.name        = 'yard-mongoid'
   s.version     = Yard::Mongoid::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Alexander Semyonov"]
-  s.email       = ["al@semyonov.us"]
-  s.homepage    = "http://rubygems.org/gems/yard-mongoid"
+  s.authors     = ['Alexander Semyonov']
+  s.email       = %w(al@semyonov.us)
+  s.homepage    = 'http://rubygems.org/gems/yard-mongoid'
   s.summary     = %q{A Yard plugin for parsing Mongoid model syntax.}
   s.description = %q{Once yard-mongoid is installed, YARD will automatically load the plugin when ever the `yard doc` utility is ran on a project.}
 
-  s.rubyforge_project = "yard-mongoid"
+  s.rubyforge_project = 'yard-mongoid'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = %w(lib)
+
+  s.add_dependency 'yard', '~> 0.8.4'
 end

metadata

@@ -1,37 +1,43 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: yard-mongoid
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.0.3.pre
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Alexander Semyonov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-08 00:00:00 +04:00
-default_executable: 
-dependencies: []
-
-description: Once yard-mongoid is installed, YARD will automatically load the plugin when ever the `yard doc` utility is ran on a project.
-email: 
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+description: Once yard-mongoid is installed, YARD will automatically load the plugin
+  when ever the `yard doc` utility is ran on a project.
+email:
 - al@semyonov.us
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
+- MIT-LICENSE
 - Rakefile
 - lib/yard-mongoid.rb
 - lib/yard/mongoid.rb
@@ -41,39 +47,29 @@ files:
 - lib/yard/mongoid/legacy/field_handler.rb
 - lib/yard/mongoid/version.rb
 - yard-mongoid.gemspec
-has_rdoc: true
 homepage: http://rubygems.org/gems/yard-mongoid
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: yard-mongoid
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Yard plugin for parsing Mongoid model syntax.
 test_files: []
-
+has_rdoc: 

data/Gemfile.lock

@@ -1,16 +0,0 @@
-PATH
-  remote: .
-  specs:
-    yard-mongoid (0.0.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    yard (0.6.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  yard (~> 0.6.1)
-  yard-mongoid!