yard-activerecord 0.0.7 → 0.0.8

data/README.md

@@ -73,3 +73,10 @@ methods simply as aliases for the associated object.
 The plugin will add class methods for any scopes you have defined in your
 models.
 
+
+## Other useful plugins ##
+
+Check out:
+ 
+  * [https://github.com/ogeidix/yard-rails-plugin](https://github.com/ogeidix/yard-rails-plugin)
+

data/lib/yard-activerecord/associations/base.rb

@@ -6,7 +6,6 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
     namespace_only
 
     def process
-      group_name = "Active Record Associations"
       namespace.groups << group_name unless namespace.groups.include? group_name
 
       object           = YARD::CodeObjects::MethodObject.new(namespace, method_name)
@@ -18,6 +17,10 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
       register object
     end
 
+    def group_name
+      "Active Record Associations"
+    end
+
     private
     def method_name
       call_params[0]
@@ -36,9 +39,9 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
         end
       end
       if singularize == true
-        ActiveSupport::Inflector.singularize method_name.capitalize
+        method_name.camelize.singularize
       else
-        method_name.capitalize
+        method_name.camelize
       end
     end
 

data/lib/yard-activerecord/associations/belongs_to_handler.rb

@@ -4,9 +4,13 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
   class BelongsToHandler < SingularHandler
     handles method_call(:belongs_to)
 
+    def group_name
+      'Belongs to'
+    end
+
     private
     def return_description
-      "#{namespace} <b>belongs to</b> a #{class_name}"
+      ''
     end
   end
 end

data/lib/yard-activerecord/associations/has_and_belongs_to_many_handler.rb

@@ -4,8 +4,13 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
   class HasAndBelongsToManyHandler < PluralHandler
     handles method_call(:has_and_belongs_to_many)
 
+    def group_name
+      'Has and belongs to many'
+    end
+
+    private
     def return_description
-      "#{namespace} <b>has and belongs to many</b> #{method_name}"
+      ''
     end
   end
 end

data/lib/yard-activerecord/associations/has_many_handler.rb

@@ -4,8 +4,13 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
   class HasManyHandler < PluralHandler
     handles method_call(:has_many)
 
+    def group_name
+      'Has many'
+    end
+
+    private
     def return_description
-      "#{namespace} <b>has many</b> #{method_name}"
+      ''
     end
   end
 end

data/lib/yard-activerecord/associations/has_one_handler.rb

@@ -4,8 +4,13 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
   class HasOneHandler < SingularHandler
     handles method_call(:has_one)
 
+    def group_name
+      'Has one'
+    end
+
+    private
     def return_description
-      "#{namespace} <b>has one</b> #{method_name}"
+      ''
     end
   end
 end

data/lib/yard-activerecord/associations/plural_handler.rb

@@ -5,9 +5,10 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
     def class_name
       "Array<#{super(true)}>"
     end
-  
+
+    private
     def return_description
-      "An array of associated #{method_name}"
+      "An array of associated #{method_name.humanize}"
     end
   end
 end

data/lib/yard-activerecord/associations/singular_handler.rb

@@ -5,9 +5,10 @@ module YARD::Handlers::Ruby::ActiveRecord::Associations
     def class_name
       super(false)
     end
-  
+
+    private  
     def return_description
-      "An associated #{method_name}"
+      "An associated {#{method_name.humanize}}"
     end
   end
 end

data/lib/yard-activerecord/delegations/delegate_handler.rb

@@ -6,12 +6,17 @@ module YARD::Handlers::Ruby::ActiveRecord::Delegations
     namespace_only
 
     def process
-      params = call_params
-      class_name = params.pop.capitalize
+      params = statement.parameters
+      params.pop # we shouldn't have a block, so pop that off
+      params.map! { |p| p.source }
+      options, params = params.partition { |v| v =~ /\=\>|\:\s/ }
+      class_name = options.detect { |v| v =~ /to\:\s|\:to \=\>/ } unless options.length == 0
+      class_name = class_name.to_s.gsub(/\A.*\:/,'').capitalize
       params.each do |method_name|
+        method_name.gsub!(/[\:\'\"]/,'')
         object = YARD::CodeObjects::MethodObject.new(namespace, method_name)
         object.group = "Delegated Instance Attributes"
-        object.docstring = "Please refer to {#{class_name}##{method_name}}"
+        object.docstring = "Alias for {#{class_name}##{method_name}}"
         object.docstring.add_tag get_tag(:return,
             "{#{class_name}##{method_name}}", 'Object')
         object.docstring.add_tag get_tag(:see,
@@ -28,4 +33,4 @@ module YARD::Handlers::Ruby::ActiveRecord::Delegations
       YARD::Tags::Tag.new(tag, text, [return_classes].flatten)
     end
   end
-end
+end

data/lib/yard-activerecord/fields/field_handler.rb

@@ -5,18 +5,16 @@ module YARD::Handlers::Ruby::ActiveRecord::Fields
     handles method_call(:integer)
     handles method_call(:float)
     handles method_call(:boolean)
+    handles method_call(:timestamp)
     handles method_call(:datetime)
+    handles method_call(:date)
   
     def process
       return unless statement.namespace.jump(:ident).source == 't'
       method_name = call_params.first
-      class_name = caller_method.capitalize
       
       return if method_name['_id'] # Skip all id fields, associations will handle that
       
-      if class_name == "Datetime"
-        class_name = "DateTime"
-      end
       ensure_loaded! P(globals.klass)
       namespace = P(globals.klass)
       return if namespace.nil?
@@ -40,11 +38,21 @@ module YARD::Handlers::Ruby::ActiveRecord::Fields
     end
   
     def description(method_name)
-      "Database field value of #{method_name}. Defined in {file:db/schema.rb}"
+      '' # "Database field value of #{method_name}. Defined in {file:db/schema.rb}"
     end
   
     def get_tag(tag, text, return_classes)
       YARD::Tags::Tag.new(:return, text, [return_classes].flatten)
     end
+
+    private
+
+    def class_name
+      if ['datetime', 'timestamp'].include?(caller_method)
+        'DateTime'
+      else
+        caller_method.capitalize
+      end
+    end
   end
 end

data/lib/yard-activerecord/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module ActiveRecord
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors: