yard-rails 0.1.0 → 0.3.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7
+
+script: rake

data/ChangeLog.md

@@ -1,3 +1,14 @@
+### 0.3.0 / 2012-08-01
+
+* Fix broken support for `attr_accessible`
+* Add support for `attr_protected`
+
+
+### 0.2.0 / 2011-11-10
+
+* Add `attr_accessible`
+
+
 ### 0.1.0 / 2011-10-02
 
 * Initial release:

data/Gemfile.lock

@@ -2,23 +2,27 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.1.3)
-    gemcutter (0.7.0)
+    gemcutter (0.7.1)
     git (1.2.5)
-    jeweler (1.6.4)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.9.2)
+      rdoc
+    json (1.7.4)
+    rake (0.9.2.2)
     rdiscount (1.6.8)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    yard (0.7.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    yard (0.8.2.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -19,6 +19,10 @@ For older versions of YARD, all plugins are loaded automatically.
 
 Parses the following statements:
 
+    attr_accessible :attr
+
+    attr_protected :attr
+
     cattr_reader :attr
 
     cattr_writer :attr
@@ -31,6 +35,9 @@ Parses the following statements:
 
     mattr_accessor :attr
 
+If you know of more Rails-specific DSL that should be included in this plugin,
+feel free to create an issue here on GitHub, and I'll be happy to include it.
+
 ## Requirements
 
 * [yard](http://yardoc.org) >= 0.4.0

data/Rakefile

@@ -22,16 +22,15 @@ Jeweler::Tasks.new do |gem|
   gem.authors = ['Charles H. Pence']
   gem.has_rdoc = 'yard'
 end
+Jeweler::RubygemsDotOrgTasks.new
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:rspec) do |spec|
-  # The automatic bundler detecton causes trouble on my
-  # development machine.
-  spec.skip_bundler = true
   spec.rspec_opts = ['--options', '.specopts']
 end
 
 task :test => :rspec
+task :spec => :rspec
 task :default => :rspec
 
 require 'yard'

data/VERSION

@@ -1,2 +1,2 @@
-0.1.0
+0.3.0
 

data/lib/yard-rails/attr_accessible_handler.rb

@@ -0,0 +1,17 @@
+
+module YARD
+  module Rails
+    class AttrAccessibleHandler < YARD::Handlers::Ruby::AttributeHandler
+      handles method_call(:attr_accessible)
+      handles method_call(:attr_protected)
+      namespace_only
+      
+      def process
+        # HACK: Must set the name to attr_accessor to make the attribute
+        # show up as read/write.
+        statement[0] = YARD::Parser::Ruby::AstNode.node_class_for(:ident).new(:ident, ["attr_accessor"])
+        super
+      end
+    end
+  end
+end

data/lib/yard-rails/legacy/attr_accessible_handler.rb

@@ -0,0 +1,18 @@
+
+module YARD
+  module Rails
+    module Legacy
+      class AttrAccessibleHandler < YARD::Handlers::Ruby::Legacy::AttributeHandler
+        handles /\Aattr_(accessible|protected)(?:\s|\()/
+        namespace_only
+        
+        def process
+          # HACK: Must set the name to attr_accessor to make the attribute
+          # show up as read/write.
+          statement.tokens.first.set_text('attr_accessor')
+          super
+        end
+      end
+    end
+  end
+end

data/lib/yard-rails.rb

@@ -1,2 +1,5 @@
 require 'yard-rails/class_attribute_handler'
 require 'yard-rails/legacy/class_attribute_handler'
+
+require 'yard-rails/attr_accessible_handler'
+require 'yard-rails/legacy/attr_accessible_handler'

data/spec/attr_accessible_handler_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'helpers/examples'
+
+require 'yard-rails/attr_accessible_handler'
+require 'yard-rails/legacy/attr_accessible_handler'
+
+describe "AttrAccessibleHandler" do
+  include Helpers::Examples
+
+  describe "valid" do
+    before(:all) do
+      parse_file :attr_accessible_protected
+    end
+
+    it "should define reader instance method for the attr_accessible method" do
+      yard('SimpleAttrAccessible#test_attribute').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer instance method for the attr_accessible method" do
+      yard('SimpleAttrAccessible#test_attribute=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define reader instance method for the attr_protected method" do
+      yard('SimpleAttrAccessible#other_attribute').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer instance method for the attr_protected method" do
+      yard('SimpleAttrAccessible#other_attribute=').should be_instance_of(CodeObjects::MethodObject)
+    end
+  end
+
+  describe "legacy" do
+    before(:all) do
+      parse_file :attr_accessible_protected, true
+    end
+
+    it "should define reader instance method for the attr_accessible method" do
+      yard('SimpleAttrAccessible#test_attribute').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer instance method for the attr_accessible method" do
+      yard('SimpleAttrAccessible#test_attribute=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define reader instance method for the attr_protected method" do
+      yard('SimpleAttrAccessible#other_attribute').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer instance method for the attr_protected method" do
+      yard('SimpleAttrAccessible#other_attribute=').should be_instance_of(CodeObjects::MethodObject)
+    end
+  end
+end
+

data/spec/helpers/examples/attr_accessible_protected.rb.txt

@@ -0,0 +1,5 @@
+class SimpleAttrAccessible
+  attr_accessible :test_attribute
+
+  attr_protected :other_attribute
+end

data/yard-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "yard-rails"
-  s.version = "0.1.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Charles H. Pence"]
-  s.date = "2011-10-02"
+  s.date = "2012-08-01"
   s.description = "Rails includes several bits of custom markup (such as the new \"cattr_*\" methods).  This plugin for YARD adds support for this custom markup, which otherwise is parsed incorrectly."
   s.email = "charles@charlespence.net"
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".gemtest",
     ".specopts",
+    ".travis.yml",
     ".yardopts",
     "ChangeLog.md",
     "Gemfile",
@@ -29,10 +30,14 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/yard-rails.rb",
+    "lib/yard-rails/attr_accessible_handler.rb",
     "lib/yard-rails/class_attribute_handler.rb",
+    "lib/yard-rails/legacy/attr_accessible_handler.rb",
     "lib/yard-rails/legacy/class_attribute_handler.rb",
+    "spec/attr_accessible_handler_spec.rb",
     "spec/class_attribute_handler_spec.rb",
     "spec/helpers/examples.rb",
+    "spec/helpers/examples/attr_accessible_protected.rb.txt",
     "spec/helpers/examples/simple_cattrs.rb.txt",
     "spec/spec_helper.rb",
     "tasks/yard.rb",
@@ -41,7 +46,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/cpence/yard-rails"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.23"
   s.summary = "A YARD plugin for parsing custom Rails syntax."
 
   if s.respond_to? :specification_version then
@@ -52,12 +57,14 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<gemcutter>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<gemcutter>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
@@ -65,6 +72,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<gemcutter>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-02 00:00:00.000000000Z
+date: 2012-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157121280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157121280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2157120780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157120780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157120280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,31 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157120280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2157119740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gemcutter
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157119740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2157119220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +101,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157119220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rails includes several bits of custom markup (such as the new "cattr_*"
   methods).  This plugin for YARD adds support for this custom markup, which otherwise
   is parsed incorrectly.
@@ -79,6 +120,7 @@ extra_rdoc_files:
 files:
 - .gemtest
 - .specopts
+- .travis.yml
 - .yardopts
 - ChangeLog.md
 - Gemfile
@@ -88,10 +130,14 @@ files:
 - Rakefile
 - VERSION
 - lib/yard-rails.rb
+- lib/yard-rails/attr_accessible_handler.rb
 - lib/yard-rails/class_attribute_handler.rb
+- lib/yard-rails/legacy/attr_accessible_handler.rb
 - lib/yard-rails/legacy/class_attribute_handler.rb
+- spec/attr_accessible_handler_spec.rb
 - spec/class_attribute_handler_spec.rb
 - spec/helpers/examples.rb
+- spec/helpers/examples/attr_accessible_protected.rb.txt
 - spec/helpers/examples/simple_cattrs.rb.txt
 - spec/spec_helper.rb
 - tasks/yard.rb
@@ -109,6 +155,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 461217869406545283
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A YARD plugin for parsing custom Rails syntax.