yard-mongoid 0.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yard-mongoid.gemspec
+gemspec
+
+gem 'yard', '~> 0.6.1'

data/Gemfile.lock

@@ -0,0 +1,16 @@
+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!

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/yard/mongoid/extensions.rb

@@ -0,0 +1,20 @@
+module YARD
+  module Mongoid
+    module Extensions
+    protected
+      def effected_namespace
+        if statement.type == :command_call
+          context = statement.jump(:var_ref)
+
+          unless context.source == 'self'
+            return ensure_loaded!(
+              Registry.resolve(namespace, context.source)
+            )
+          end
+        end
+
+        return namespace
+      end
+    end
+  end
+end

data/lib/yard/mongoid/field_handler.rb

@@ -0,0 +1,29 @@
+module YARD
+  module Mongoid
+    class FieldHandler < YARD::Handlers::Ruby::AttributeHandler
+      include Extensions
+      include Helpers
+
+      handles method_call(:field)
+
+      def process
+        nobj = effected_namespace
+        mscope = scope
+        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)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/yard/mongoid/helpers.rb

@@ -0,0 +1,103 @@
+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)
+        register_new_method_object(namespace, name, scope) do |o|
+          o.visibility = :public
+          o.source = statement.source
+          o.signature = "def #{name}"
+          o.docstring = "Returns the value of attribute #{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
+      # @param [Symbol] scope +:instance+ or +:class+
+      def register_field_setter(namespace, name, scope = :instance)
+        register_new_method_object(namespace, "#{name}=", scope) do |o|
+          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.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.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.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.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.visibility = :public
+          o.source = statement.source
+          o.signature = "def reset_#{name}!"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module YARD
+  module Mongoid
+    module Legacy
+      class FieldHandler < YARD::Handlers::Ruby::Legacy::AttributeHandler
+        include 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
+        end
+      end
+    end
+  end
+end

data/lib/yard/mongoid/version.rb

@@ -0,0 +1,5 @@
+module Yard
+  module Mongoid
+    VERSION = "0.0.2"
+  end
+end

data/lib/yard/mongoid.rb

@@ -0,0 +1,10 @@
+module YARD
+  module Mongoid
+    autoload :VERSION,    'yard/mongoid/version'
+    autoload :Extensions, 'yard/mongoid/extensions'
+    autoload :Helpers,    'yard/mongoid/helpers'
+  end
+end
+
+require 'yard/mongoid/field_handler'
+require 'yard/mongoid/legacy/field_handler'

data/lib/yard-mongoid.rb

@@ -0,0 +1 @@
+require 'yard/mongoid'

data/yard-mongoid.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yard/mongoid/version"
+
+Gem::Specification.new do |s|
+  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.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.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"]
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: yard-mongoid
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+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: 
+- al@semyonov.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/yard-mongoid.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
+has_rdoc: true
+homepage: http://rubygems.org/gems/yard-mongoid
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: yard-mongoid
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Yard plugin for parsing Mongoid model syntax.
+test_files: []
+