yard-rspec 0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2007-2009 Loren Segal
+
+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.rdoc

@@ -0,0 +1,30 @@
+= Embedding RSpec Specifications in YARD Documentation
+
+This plugin demonstrates how RSpec tests can be embedded within standard documentation
+using only a small amount of plugin code. The example generates documentation
+for the following {String#pig_latin} method and RSpec tests:
+
+  # Run `yardoc -e ../lib/yard-spec example_code.rb`
+
+  class String
+    # Pig latin of a String
+    def pig_latin
+      self[1..-1] + self[0] + "ay"
+    end
+  end
+
+  # 
+  # Specs
+  # 
+  describe String, '#pig_latin' do
+    it "should be a pig!" do
+      "hello".pig_latin.should == "ellohay"
+     end
+
+    it "should fail to be a pig!" do
+      "hello".pig_latin.should == "hello"
+    end
+  end
+
+View the "Specifications" section within the {String#pig_latin} method to see
+these tests.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec'
+require 'spec/rake/spectask'
+require 'yard'
+
+WINDOWS = (PLATFORM =~ /win32|cygwin/ ? true : false) rescue false
+SUDO = WINDOWS ? '' : 'sudo'
+
+task :default => :install
+
+load 'yard-rspec.gemspec'
+Rake::GemPackageTask.new(SPEC) do |pkg|
+  pkg.gem_spec = SPEC
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc "Install the gem locally"
+task :install => :package do 
+  sh "#{SUDO} gem install pkg/#{SPEC.name}-#{SPEC.version}.gem --local --no-rdoc --no-ri"
+  sh "rm -rf pkg/yard-#{SPEC.version}" unless ENV['KEEP_FILES']
+end
+
+YARD::Rake::YardocTask.new

data/example/README.rdoc

@@ -0,0 +1,30 @@
+= Embedding RSpec Specifications in YARD Documentation
+
+This plugin demonstrates how RSpec tests can be embedded within standard documentation
+using only a small amount of plugin code. The example generates documentation
+for the following {String#pig_latin} method and RSpec tests:
+
+  # Run `yardoc -e ../lib/yard-spec example_code.rb`
+
+  class String
+    # Pig latin of a String
+    def pig_latin
+      self[1..-1] + self[0] + "ay"
+    end
+  end
+
+  # 
+  # Specs
+  # 
+  describe String, '#pig_latin' do
+    it "should be a pig!" do
+      "hello".pig_latin.should == "ellohay"
+     end
+
+    it "should fail to be a pig!" do
+      "hello".pig_latin.should == "hello"
+    end
+  end
+
+View the "Specifications" section within the {String#pig_latin} method to see
+these tests.

data/example/example_code.rb

@@ -0,0 +1,24 @@
+# Run `yardoc -e ../lib/yard-spec example_code.rb`
+
+
+class String
+  # Pig latin of a String
+  def pig_latin
+    self[1..-1] + self[0] + "ay"
+  end
+end
+
+# 
+# Specs
+# 
+describe String do
+  describe '#pig_latin' do
+    it "should be a pig!" do
+      "hello".pig_latin.should == "ellohay"
+     end
+
+    it "should fail to be a pig!" do
+      "hello".pig_latin.should == "hello"
+    end
+  end
+end

data/lib/yard-rspec.rb

@@ -0,0 +1,3 @@
+YARD::Templates::Engine.register_template_path File.dirname(__FILE__) + '/../templates'
+require File.join(File.dirname(__FILE__), 'yard-rspec', 'handler') if RUBY19
+require File.join(File.dirname(__FILE__), 'yard-rspec', 'legacy')

data/lib/yard-rspec/handler.rb

@@ -0,0 +1,32 @@
+class RSpecDescribeHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:describe)
+  
+  def process
+    objname = statement.parameters.first.jump(:string_content).source
+    if statement.parameters[1]
+      src = statement.parameters[1].jump(:string_content).source
+      objname += (src[0] == "#" ? "" : "::") + src
+    end
+    obj = {:spec => owner ? (owner[:spec] || "") : ""}
+    obj[:spec] += objname
+    parse_block(statement.last.last, owner: obj)
+  rescue YARD::Handlers::NamespaceMissingError
+  end
+end
+
+class RSpecItHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:it)
+  
+  def process
+    return if owner.nil?
+    obj = P(owner[:spec])
+    return if obj.is_a?(Proxy)
+    
+    (obj[:specifications] ||= []) << {
+      name: statement.parameters.first.jump(:string_content).source,
+      file: statement.file,
+      line: statement.line,
+      source: statement.last.last.source.chomp
+    }
+  end
+end

data/lib/yard-rspec/legacy.rb

@@ -0,0 +1,31 @@
+class LegacyRSpecDescribeHandler < YARD::Handlers::Ruby::Legacy::Base
+  MATCH = /\Adescribe\s+(.+?)\s+(do|\{)/
+  handles MATCH
+  
+  def process
+    objname = statement.tokens.to_s[MATCH, 1].gsub(/["']/, '')
+    obj = {:spec => owner ? (owner[:spec] || "") : ""}
+    obj[:spec] += objname
+    parse_block :owner => obj
+  rescue YARD::Handlers::NamespaceMissingError
+  end
+end
+
+class LegacyRSpecItHandler < YARD::Handlers::Ruby::Legacy::Base
+  MATCH = /\Ait\s+['"](.+?)['"]\s+(do|\{)/
+  handles MATCH
+  
+  def process
+    return if owner.nil?
+    obj = P(owner[:spec])
+    return if obj.is_a?(Proxy)
+    
+    (obj[:specifications] ||= []) << {
+      :name => statement.tokens.to_s[MATCH, 1],
+      :file => parser.file,
+      :line => statement.line,
+      :source => statement.block.to_s
+    }
+  end
+end
+

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

@@ -0,0 +1,28 @@
+<% if object[:specifications] %>
+<div class="tags">
+  <h3>Specifications:</h3>
+  <ul class="specs">
+    <% for spec in object[:specifications] %>
+      <li><%= spec[:name] %>
+        <div class="source_code">
+          <table>
+            <tr>
+              <td>
+                <pre class="lines">
+
+
+<%= spec[:source].split("\n").size.times.to_a.map {|i| spec[:line] + i }.join("\n") %></pre>
+              </td>
+              <td>
+                <pre class="code"><span class="info file"># File '<%= h spec[:file] %>', line <%= spec[:line] %></span>
+
+<%= html_syntax_highlight format_source(spec[: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(:specs).before(:source)
+end

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

@@ -0,0 +1,9 @@
+<% if object[:specifications] %>
+
+Specifications:
+---------------
+
+<% for spec in object[:specifications] %>
+<%= indent wrap("- " + spec[:name]) %>
+<% end %>
+<% end %>

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: yard-rspec
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Loren Segal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-15 00:00:00 -04: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"
+    version: 
+description: 
+email: lsegal@soen.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- example/example_code.rb
+- example/README.rdoc
+- lib/yard-rspec/handler.rb
+- lib/yard-rspec/legacy.rb
+- lib/yard-rspec.rb
+- templates/default/method_details/html/specs.erb
+- templates/default/method_details/setup.rb
+- templates/default/method_details/text/specs.erb
+- LICENSE
+- README.rdoc
+- Rakefile
+has_rdoc: yard
+homepage: http://yardoc.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: yard-rspec
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: YARD plugin to list RSpec specifications inside documentation
+test_files: []
+