yard-parameters 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,9 @@
+doc
+pkg
+tmp/*
+.DS_Store
+.yardoc
+*.db
+*.log
+*.swp
+*~

data/.specopts

@@ -0,0 +1 @@
+--colour --format specdoc

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'YARD Parameters Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,5 @@
+### 0.1.0 / 2010-02-18
+
+* Initial release:
+  * Parses `parameter :name` methods.
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (c) 2010 Hal Brodigan
+
+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,36 @@
+# yard-parameters
+
+* [github.com/postmodern/yard-parameters](http://github.com/postmodern/yard-parameters)
+* [github.com/postmodern/yard-parameters/issues](http://github.com/postmodern/yard-parameters/issues)
+
+## Description
+
+yard-parameters is a plugin for YARD for parsing
+[parameters](http://parameters.rubyforge.org).
+
+## Features
+
+* Parses `parameter :name` class method-calls.
+
+## Requirements
+
+* [yard](http://yardoc.org/) >= 0.4.0
+
+## Install
+
+    $ sudo gem install yard-parameters
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "yard-parameters"
+    gem.summary = %Q{A plugin for YARD for parsing parameters.}
+    gem.description = %Q{yard-parameters is a plugin for YARD for parsing parameters.}
+    gem.email = "postmodern.mod3@gmail.com"
+    gem.homepage = "http://github.com/postmodern/yard-parameters"
+    gem.authors = ["postmodern"]
+    gem.add_dependency "yard", ">= 0.4.0"
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.has_rdoc = 'yard'
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs += ['lib', 'spec']
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options', '.specopts']
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: gem install yard"
+  end
+end

data/VERSION

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

data/lib/yard-parameters/legacy/parameter_handler.rb

@@ -0,0 +1,45 @@
+require 'yard'
+
+module YARD
+  module Parameters
+    module Legacy
+      class ParameterHandler < YARD::Handlers::Ruby::Legacy::Base
+
+        handles /\Aparameter\s+:/
+
+        def process
+          nobj = namespace
+          mscope = scope
+          name = statement.tokens[2,1].to_s[1..-1]
+
+          register MethodObject.new(nobj, name, :class) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{nobj}.#{name}"
+          end
+
+          register MethodObject.new(nobj, "#{name}=", :class) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{nobj}.#{name}=(value)"
+            o.parameters = [['value', nil]]
+          end
+
+          register MethodObject.new(nobj, name, mscope) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{name}"
+          end
+
+          register MethodObject.new(nobj, "#{name}=", mscope) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{name}=(value)"
+            o.parameters = [['value', nil]]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/yard-parameters/legacy.rb

@@ -0,0 +1 @@
+require 'yard-parameters/legacy/parameter_handler'

data/lib/yard-parameters/parameter_handler.rb

@@ -0,0 +1,47 @@
+require 'yard'
+
+module YARD
+  module Parameters
+    class ParameterHandler < YARD::Handlers::Ruby::Base
+
+      handles method_call(:parameter)
+
+      def process
+        nobj = namespace
+        mscope = scope
+        name = statement.parameters[0].first
+
+        if name.type == :symbol
+          name = name.source[1..-1]
+
+          register MethodObject.new(nobj, name, :class) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{nobj}.#{name}"
+          end
+
+          register MethodObject.new(nobj, "#{name}=", :class) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{nobj}.#{name}=(value)"
+            o.parameters = [['value', nil]]
+          end
+
+          register MethodObject.new(nobj, name, mscope) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{name}"
+          end
+
+          register MethodObject.new(nobj, "#{name}=", mscope) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{name}=(value)"
+            o.parameters = [['value', nil]]
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/yard-parameters.rb

@@ -0,0 +1,2 @@
+require 'yard-parameters/parameter_handler'
+require 'yard-parameters/legacy'

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

@@ -0,0 +1,5 @@
+class BadParameter
+
+  parameter = parameter.to_s.to_sym
+
+end

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

@@ -0,0 +1,7 @@
+class SimpleParameter
+
+  include Parameters
+
+  parameter :x
+
+end

data/spec/helpers/examples.rb

@@ -0,0 +1,18 @@
+require 'yard'
+
+module Helpers
+  module Examples
+    EXAMPLES_DIR = File.expand_path(File.join(File.dirname(__FILE__),'examples'))
+
+    def parse_file(file, thisfile = __FILE__)
+      YARD::Registry.clear
+
+      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/parameter_handler_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'helpers/examples'
+
+require 'yard-parameters/parameter_handler'
+require 'yard-parameters/legacy/parameter_handler'
+
+describe "ParameterHandler" do
+  include Helpers::Examples
+
+  describe "valid" do
+    before(:all) do
+      parse_file :simple_parameter
+    end
+
+    it "should register a class reader method for the parameter" do
+      yard('SimpleParameter.x').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should register a class writer method for the parameter" do
+      yard('SimpleParameter.x=').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should register a instance reader method for the parameter" do
+      yard('SimpleParameter#x').should be_instance_of(CodeObjects::MethodObject)
+    end
+
+    it "should register a instance writer method for the parameter" do
+      yard('SimpleParameter#x=').should be_instance_of(CodeObjects::MethodObject)
+    end
+  end
+
+  describe "invalid" do
+    before(:all) do
+      parse_file :bad_parameter
+    end
+
+    it "should not register class reader methods for variables" do
+      yard('BadParameter.x').should be_nil
+    end
+
+    it "should not register class writer methods for variables" do
+      yard('BadParameter.x=').should be_nil
+    end
+
+    it "should not register instance reader methods for variables" do 
+      yard('BadParameter#x').should be_nil
+    end
+
+    it "should not register instance writer methods for variables" do
+      yard('BadParameter#x=').should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+gem 'rspec', '>=1.3.0'
+require 'spec'
+
+gem 'yard', '>=0.4.0'
+require 'yard'
+
+include YARD

data/yard-parameters.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yard-parameters}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["postmodern"]
+  s.date = %q{2010-02-18}
+  s.description = %q{yard-parameters is a plugin for YARD for parsing parameters.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".gitignore",
+    ".specopts",
+    ".yardopts",
+    "ChangeLog.md",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/yard-parameters.rb",
+    "lib/yard-parameters/legacy.rb",
+    "lib/yard-parameters/legacy/parameter_handler.rb",
+    "lib/yard-parameters/parameter_handler.rb",
+    "spec/helpers/examples.rb",
+    "spec/helpers/examples/bad_parameter.rb.txt",
+    "spec/helpers/examples/simple_parameter.rb.txt",
+    "spec/parameter_handler_spec.rb",
+    "spec/spec_helper.rb",
+    "yard-parameters.gemspec"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/yard-parameters}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A plugin for YARD for parsing parameters.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/helpers/examples.rb",
+    "spec/parameter_handler_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yard>, [">= 0.4.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<yard>, [">= 0.4.0"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0.4.0"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+  end
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: yard-parameters
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+description: yard-parameters is a plugin for YARD for parsing parameters.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .gitignore
+- .specopts
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/yard-parameters.rb
+- lib/yard-parameters/legacy.rb
+- lib/yard-parameters/legacy/parameter_handler.rb
+- lib/yard-parameters/parameter_handler.rb
+- spec/helpers/examples.rb
+- spec/helpers/examples/bad_parameter.rb.txt
+- spec/helpers/examples/simple_parameter.rb.txt
+- spec/parameter_handler_spec.rb
+- spec/spec_helper.rb
+- yard-parameters.gemspec
+has_rdoc: yard
+homepage: http://github.com/postmodern/yard-parameters
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A plugin for YARD for parsing parameters.
+test_files: 
+- spec/spec_helper.rb
+- spec/helpers/examples.rb
+- spec/parameter_handler_spec.rb