yard-rails 0.1.0

data/.specopts

@@ -0,0 +1 @@
+--color --format documentation

data/.yardopts

@@ -0,0 +1,5 @@
+--markup markdown
+--title 'yard-rails Documentation'
+--protected
+--files ChangeLog.md,LICENSE.txt
+

data/ChangeLog.md

@@ -0,0 +1,5 @@
+### 0.1.0 / 2011-10-02
+
+* Initial release:
+  * Parse `{c,m}attr_*` Rails constructs as class attributes
+

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gem 'yard', :group => [:development, :runtime]
+
+group(:development) do
+  gem 'rake'
+  gem 'jeweler'
+  gem 'gemcutter'
+end
+
+group(:doc) do
+  case RUBY_PLATFORM
+  when 'java'
+    gem 'maruku'
+  else
+    gem 'rdiscount'
+  end
+end
+
+gem 'rspec', :group => [:development, :test]
+
+

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    gemcutter (0.7.0)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gemcutter
+  jeweler
+  rake
+  rdiscount
+  rspec
+  yard

data/LICENSE.txt

@@ -0,0 +1,24 @@
+
+Copyright (c) 2011 Charles H. Pence
+
+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/README.md

@@ -0,0 +1,49 @@
+# yard-rails
+
+* [github.com/cpence/yard-rails](http://github.com/cpence/yard-rails/)
+* [github.com/cpence/yard-rails/issues](http://github.com/cpence/yard-rails/issues)
+* Charles Pence (charles at charlespence.net)
+
+## Description
+
+A YARD plugin for parsing the custom Ruby syntax added by Rails.
+
+If you are using YARD >= 0.6, you will need to enable the plugin manually.  Add
+the following line to your `.yardopts` file:
+
+    --plugin yard-rails
+
+For older versions of YARD, all plugins are loaded automatically.
+
+## Features
+
+Parses the following statements:
+
+    cattr_reader :attr
+
+    cattr_writer :attr
+
+    cattr_accessor :attr
+
+    mattr_reader :attr
+
+    mattr_writer :attr
+
+    mattr_accessor :attr
+
+## Requirements
+
+* [yard](http://yardoc.org) >= 0.4.0
+
+## Install
+
+    $ sudo gem install yard-rails
+
+## License
+
+See LICENSE.txt for license information.
+
+## Thanks
+
+Thanks to Postmodern's `yard-dm` gem, which provided much of the framework
+I've used to package `yard-rails`.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:development, :doc)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = 'yard-rails'
+  gem.license = 'MIT'
+  gem.summary = %Q{A YARD plugin for parsing custom Rails syntax.}
+  gem.description = %Q{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.}
+  gem.email = 'charles@charlespence.net'
+  gem.homepage = 'http://github.com/cpence/yard-rails'
+  gem.authors = ['Charles H. Pence']
+  gem.has_rdoc = 'yard'
+end
+
+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 :default => :rspec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1,2 @@
+0.1.0
+

data/lib/yard-rails.rb

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

data/lib/yard-rails/class_attribute_handler.rb

@@ -0,0 +1,25 @@
+require 'yard/parser/ruby/ast_node'
+
+module YARD
+  module Rails
+    class ClassAttributeHandler < YARD::Handlers::Ruby::AttributeHandler
+      handles method_call(:cattr_accessor)
+      handles method_call(:cattr_reader)
+      handles method_call(:cattr_writer)
+      handles method_call(:mattr_accessor)
+      handles method_call(:mattr_reader)
+      handles method_call(:mattr_writer)
+      namespace_only
+      
+      def process
+        # HACK: Strip the [c,m] off of the front of the method, so that
+        # AttributeHandler will be able to correctly detect the resulting
+        # method as read/write.
+        name = statement[0].source[1..-1]
+        statement[0] = YARD::Parser::Ruby::AstNode.node_class_for(:ident).new(:ident, [name])
+
+        push_state(:scope => :class) { super }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+
+module YARD
+  module Rails
+    module Legacy
+      class ClassAttributeHandler < YARD::Handlers::Ruby::Legacy::AttributeHandler
+        handles /\A[cm]attr_(reader|writer|accessor)(?:\s|\()/
+        namespace_only
+        
+        def process
+          # HACK: Strip the [c,m] off of the front of the method, so that
+          # AttributeHandler will be able to correctly detect the resulting
+          # method as read/write.
+          new_text = statement.tokens.first.text.to_s[1..-1]
+          statement.tokens.first.set_text(new_text)
+
+          push_state(:scope => :class) { super }
+        end
+      end
+    end
+  end
+end

data/spec/class_attribute_handler_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'helpers/examples'
+
+require 'yard-rails/class_attribute_handler'
+require 'yard-rails/legacy/class_attribute_handler'
+
+describe "ClassAttributeHandler" do
+  include Helpers::Examples
+
+  describe "valid" do
+    before(:all) do
+      parse_file :simple_cattrs
+    end
+
+    it "should define a class method for the cattr_reader method" do
+      yard('SimpleCattrs.num_widgets').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define a class method for the cattr_writer method" do
+      yard('SimpleCattrs.widget_destination=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define reader class method for the cattr_accessor method" do
+      yard('SimpleCattrs.widget_type').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer class method for the cattr_accessor method" do
+      yard('SimpleCattrs.widget_type=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define a class method for the mattr_reader method" do
+      yard('SimpleCattrs.num_sprockets').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define a class method for the mattr_writer method" do
+      yard('SimpleCattrs.sprocket_destination=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define reader class method for the mattr_accessor method" do
+      yard('SimpleCattrs.sprocket_type').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer class method for the mattr_accessor method" do
+      yard('SimpleCattrs.sprocket_type=').should be_instance_of(CodeObjects::MethodObject)
+    end
+  end
+
+  describe "legacy" do
+    before(:all) do
+      parse_file :simple_cattrs, true
+    end
+
+    it "should define a class method for the cattr_reader method" do
+      yard('SimpleCattrs.num_widgets').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define a class method for the cattr_writer method" do
+      yard('SimpleCattrs.widget_destination=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define reader class method for the cattr_accessor method" do
+      yard('SimpleCattrs.widget_type').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer class method for the cattr_accessor method" do
+      yard('SimpleCattrs.widget_type=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define a class method for the mattr_reader method" do
+      yard('SimpleCattrs.num_sprockets').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define a class method for the mattr_writer method" do
+      yard('SimpleCattrs.sprocket_destination=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define reader class method for the mattr_accessor method" do
+      yard('SimpleCattrs.sprocket_type').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should define writer class method for the mattr_accessor method" do
+      yard('SimpleCattrs.sprocket_type=').should be_instance_of(CodeObjects::MethodObject)
+    end
+  end
+end
+

data/spec/helpers/examples.rb

@@ -0,0 +1,24 @@
+require 'yard'
+
+module Helpers
+  module Examples
+    EXAMPLES_DIR = File.expand_path(File.join(File.dirname(__FILE__),'examples'))
+
+    def parse_file(file, legacy = false, thisfile = __FILE__)
+      YARD::Registry.clear
+
+      if legacy
+        YARD::Parser::SourceParser.parser_type = :ruby18
+      else
+        YARD::Parser::SourceParser.parser_type = :ruby
+      end
+
+      path = File.join(Helpers::Examples::EXAMPLES_DIR, "#{file}.rb.txt")
+      YARD::Parser::SourceParser.parse(path)
+    end
+
+    def yard(name)
+      YARD::Registry.at(name)
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+class SimpleCattrs
+  cattr_reader :num_widgets
+  cattr_writer :widget_destination
+  cattr_accessor :widget_type
+
+  mattr_reader :num_sprockets
+  mattr_writer :sprocket_destination
+  mattr_accessor :sprocket_type
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:runtime, :test)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec'
+require 'yard'
+
+include YARD

data/tasks/yard.rb

@@ -0,0 +1,7 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+task :docs => :yard

data/yard-rails.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "yard-rails"
+  s.version = "0.1.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.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 = [
+    "ChangeLog.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".gemtest",
+    ".specopts",
+    ".yardopts",
+    "ChangeLog.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/yard-rails.rb",
+    "lib/yard-rails/class_attribute_handler.rb",
+    "lib/yard-rails/legacy/class_attribute_handler.rb",
+    "spec/class_attribute_handler_spec.rb",
+    "spec/helpers/examples.rb",
+    "spec/helpers/examples/simple_cattrs.rb.txt",
+    "spec/spec_helper.rb",
+    "tasks/yard.rb",
+    "yard-rails.gemspec"
+  ]
+  s.homepage = "http://github.com/cpence/yard-rails"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A YARD plugin for parsing custom Rails syntax."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yard>, [">= 0"])
+      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<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<rspec>, [">= 0"])
+    end
+  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<rspec>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: yard-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Charles H. Pence
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2157121280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157121280
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2157120780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157120780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157120280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157120280
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2157119740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157119740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157119220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157119220
+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.
+email: charles@charlespence.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- .gemtest
+- .specopts
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/yard-rails.rb
+- lib/yard-rails/class_attribute_handler.rb
+- lib/yard-rails/legacy/class_attribute_handler.rb
+- spec/class_attribute_handler_spec.rb
+- spec/helpers/examples.rb
+- spec/helpers/examples/simple_cattrs.rb.txt
+- spec/spec_helper.rb
+- tasks/yard.rb
+- yard-rails.gemspec
+homepage: http://github.com/cpence/yard-rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A YARD plugin for parsing custom Rails syntax.
+test_files: []