yard-method-decorators 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yard-method-decorators.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremy Friesen
+
+MIT License
+
+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,31 @@
+# Yard::MethodDecorators
+
+A YARD plugin for the
+[method decorators gem](http://rubygems.org/gems/method_decorators).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yard-method-decorators'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-method-decorators
+
+## Usage
+
+    $ yardoc -p templates_custom \
+      -e lib/yard-method-decorators.rb example/example_code.rb
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/example/example_code.rb

@@ -0,0 +1,11 @@
+# Run `yardoc -p templates_custom -e lib/yard-method-decorators.rb example/example_code.rb`
+require 'method_decorators'
+
+class HelloWorld
+  extend MethodDecorators
+  +Precondition.new {|p1, p2| p1.is_a?(Integer) && p2.is_a?(Integer)}
+  +Memoize
+  def adder(value1,value2)
+    value1 + value2
+  end
+end

data/lib/yard-method-decorators.rb

@@ -0,0 +1,11 @@
+module YARD::MethodDecorators
+  # Your code goes here...
+end
+
+YARD::Templates::Engine.register_template_path(
+  File.dirname(__FILE__) + '/../templates'
+)
+
+require File.join(File.dirname(__FILE__), 'yard-method-decorators', 'handler')
+require File.join(File.dirname(__FILE__), 'yard-method-decorators', 'version')
+

data/lib/yard-method-decorators/handler.rb

@@ -0,0 +1,22 @@
+class YARD::MethodDecorators::PlusHander < YARD::Handlers::Ruby::Base
+  handles :unary
+  namespace_only
+
+  process do
+    # method_decorators_tag = YARD::Tags::Tag.new(:method_decorators, "", [])
+
+    parent_statement = statement.parent
+    index_of_statement = parent_statement.children.find_index(statement)
+    decorated_method_statement = parent_statement.
+      children[index_of_statement..-1].detect {|child| child.type != :unary }
+    decorated_method_name = decorated_method_statement.jump(:ident).source
+    object = YARD::CodeObjects::MethodObject.new(namespace, decorated_method_name)
+    object[:method_decorators] ||= []
+    object[:method_decorators] << {
+      name: statement.jump(:const).source,
+      file: statement.file,
+      line: statement.line,
+      source: statement.last.last.source.chomp
+    }
+  end
+end

data/lib/yard-method-decorators/version.rb

@@ -0,0 +1,5 @@
+module YARD
+  module MethodDecorators
+    VERSION = "0.0.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/templates/default/method_details/html/method_decorators.erb

@@ -0,0 +1,28 @@
+<% if object[:method_decorators] %>
+<div class="tags">
+  <h4>Method Decorators:</h4>
+  <ul class="decorators">
+    <% for decorator in object[:method_decorators] %>
+      <li><%= decorator[:name] %>
+        <div class="source_code">
+          <table>
+            <tr>
+              <td>
+                <pre class="lines">
+
+
+<%= decorator[:source].split("\n").size.times.to_a.map {|i| decorator[:line] + i }.join("\n") %></pre>
+              </td>
+              <td>
+                <pre class="code"><span class="info file"># File '<%= h decorator[:file] %>', line <%= decorator[:line] %></span>
+
+<%= html_syntax_highlight format_source(decorator[:source]) %></pre>
+              </td>
+            </tr>
+          </table>
+        </div>
+      </li>
+    <% end %>
+  </ul>
+</div>
+<% end %>

data/templates/default/method_details/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.last.place(:method_decorators).after(:method_signature)
+end

data/templates/default/method_details/text/method_decorators.erb

@@ -0,0 +1,9 @@
+<% if object[:method_decorators] %>
+
+Method Decorators:
+------------------
+
+<% for decorator in object[:method_decorators] %>
+<%= indent wrap("- " + spec[:decorator]) %>
+<% end %>
+<% end %>

data/yard-method-decorators.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yard-method-decorators/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = [
+    "Jeremy Friesen",
+  ]
+  gem.email         = [
+    "jeremy.n.friesen@gmail.com",
+  ]
+  gem.description   = %q{Captures MethodDecorators in YARD}
+  gem.summary       = %q{Captures MethodDecorators in YARD}
+  gem.homepage      = "http://github.com/jeremyf/yard-method-decorators"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "yard-method-decorators"
+  gem.require_paths = ["lib"]
+  gem.version       = YARD::MethodDecorators::VERSION
+  gem.add_dependency 'yard'
+  gem.add_dependency 'method_decorators'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-given'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: yard-method-decorators
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: method_decorators
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-given
+  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'
+description: Captures MethodDecorators in YARD
+email:
+- jeremy.n.friesen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example/example_code.rb
+- lib/yard-method-decorators.rb
+- lib/yard-method-decorators/handler.rb
+- lib/yard-method-decorators/version.rb
+- spec/spec_helper.rb
+- templates/default/method_details/html/method_decorators.erb
+- templates/default/method_details/setup.rb
+- templates/default/method_details/text/method_decorators.erb
+- yard-method-decorators.gemspec
+homepage: http://github.com/jeremyf/yard-method-decorators
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Captures MethodDecorators in YARD
+test_files:
+- spec/spec_helper.rb
+has_rdoc: