yard-rspec_examples 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 601f363204ebbf3d59050eab358312982cefc6fa
-  data.tar.gz: 68010e9a097bed8711e97f487654be151c63f515
+  metadata.gz: 622d647f404d59aeee33f91d2b98666bab13fb8e
+  data.tar.gz: bbfb8cdead28af1b2139fafa6d3b7608fc74e961
 SHA512:
-  metadata.gz: 59af946589cc352e1e6c001b1fc7b579772682680cbedf281d5b5828573a52d510430ebe5a02c7ec8ee0b098a570fcb5f569d6e609cd7616b5369a36b56d8620
-  data.tar.gz: 38d4807e9bf351ba80f957351883948345f439c62c167bcb4d1556eb738dd51c41a6b64cc5e11cda0d036b4b616e62d52816f1e9adefd8fee62d4cf75faf5fb6
+  metadata.gz: 11b660458e260e6f92a5a6f975f7bbb77b1da4e3e4e3c97e5d8dc7bb7fab4b9ac784a81c07a3f5a7139bcbc310b265679c57c241eac8ad23a24a6cd2a66a404d
+  data.tar.gz: 3877e218e518686565f7b0c405701b3aa21095b76eba397be8c262892e12c83ce8356e6d6d4ee2853c843cb0f5788eef93f318ff5e482a3f98e3439a42ace6b4

data/.gitignore

@@ -1,4 +1,5 @@
 doc
 .yardoc
+.ruby-version
 Gemfile.lock
-.ruby-version
+coverage/.*

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -1,8 +1,16 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
+gem "rake"
+
 group :development do
+  gem 'coveralls', require: false
   gem "rspec"
   gem "yard"
+  gem 'byebug'
+end
+
+group :test do
+  gem 'nokogiri'
 end

data/README.md

@@ -0,0 +1,84 @@
+[![Build Status](http://img.shields.io/travis/UP-nxt/yard-rspec_examples.svg)](https://travis-ci.org/UP-nxt/yard-rspec_examples)
+[![Dependency Status](https://img.shields.io/gemnasium/UP-nxt/yard-rspec_examples.svg)](https://gemnasium.com/UP-nxt/yard-rspec_examples)
+[![Code Climate](http://img.shields.io/codeclimate/github/UP-nxt/yard-rspec_examples.svg)](https://codeclimate.com/UP-nxt/yard-rspec_examples)
+[![Coverage Status](https://coveralls.io/repos/UP-nxt/yard-rspec_examples/badge.svg?branch=master&service=github)](https://coveralls.io/github/UP-nxt/yard-rspec_examples?branch=master)
+
+
+# yard-rspec_examples
+
+Yard plugin to include examples in the generated doc through rspec
+
+## Installation
+
+In order to install it you just have to install it gem from gemcutter
+
+    gem install yard-rspec_examples
+
+## Description
+
+This plugin simply includes an example tag and recreates it with the source code that corresponds
+to the first example included in the describe blocks below.
+This have to be defined inside a describe block called "#method_name" that, in turn,
+has to be defined in a describe block with the class name, i.e. the regular way people use rspec when testing objects.
+
+So, for example,
+
+Given this source code:
+
+    class Foo
+      ## 
+      # This is a foo method with an example
+      # @rspec_example
+      def foo_method
+      end
+    end
+
+And this spec:
+
+    describe Foo do
+      describe "#foo_method" do 
+        it "works this way" do
+          this = "is"
+          # The code that will be included in the example
+        end
+      end
+    end
+
+A result like this is to be expected
+
+    class Foo
+      ## 
+      # This is a foo method with an example
+      # @example
+      #   this = "is"
+      #   # The code that will be included in the example
+      def foo_method
+      end
+    end
+
+Another usage is to pass the example's name to the tag, using the regular conventions for rspec descriptions as they
+are used with the ```--example``` option of the rspec executable.
+
+    @rspec_example #foo_method works this way
+    class Foo
+      ##
+      # This is a foo method with an example
+      # @rspec_example works this way
+      def foo_method
+      end
+    end
+    
+    @rspec_example Foo#foo_method works this way
+    class AnotherClass
+    end
+
+## Using it
+
+In order to use it, you just have to add the --plugin param plus yours
+
+    yardoc --plugin yar-rspec_examples [OPTS]
+
+
+## Copyright
+Copyright partly(c) 2011 Jose Fernandez (magec). 
+See LICENSE.txt for further details.

data/Rakefile

@@ -1,18 +1,7 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
-
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = "--color"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--options', 'spec/rspec.opts']
 end
 
-require 'rubygems'
-
-require 'rake'
+task default: [:spec]

data/lib/yard-rspec_examples.rb

@@ -4,6 +4,7 @@ require 'yard/rspec_examples/it_handler'
 require 'yard/rspec_examples/module_handler'
 require 'yard/rspec_examples/describe_handler'
 require 'yard/rspec_examples/parser_trace'
+require 'yard/tags/rspec_example_tag'
 
 ##
 # This class will hold a map that associates the method descriptions with its source code
@@ -15,36 +16,8 @@ end
 
 module YARD
   module Tags
-    ##
-    # A new type of tags has to be used cause we need to intercept the
-    # text call and generate its contents (in generation time, after everything was parsed)
-    class RSpecExampleTag < Tag
-      def text
-        # for now, we just handle case where describes are derived from the context
-        example_description = rspec_description(object).gsub(/^::/,'').gsub(/ ::/, ' ')
-        example_description += " #{name}" unless name.empty?
-        key = RSpecExampleRegistry.example_map.keys.detect{|k| k.include?(example_description)}
-        puts "[warn] Could not find example '#{example_description}'" unless key
-        @text = RSpecExampleRegistry.example_map[key]
-      end
-
-      private
-      def rspec_description(object)
-        case object
-        when CodeObjects::RootObject
-          ""
-        when CodeObjects::MethodObject
-          "#{rspec_description(object.namespace)} ##{object.name}"
-        when CodeObjects::ClassObject
-          "#{rspec_description(object.namespace)}::#{object.name}"
-        when CodeObjects::ModuleObject
-          "#{rspec_description(object.namespace)}#{object.name} "
-        end
-      end
-    end
-
     class DefaultFactory
-      def parse_tag_with_rspec_example_tag(tagname, text)
+      def parse_tag_with_rspec_example_tag(_, text)
         RSpecExampleTag.new(:example, "", [], text)
       end
     end

data/lib/yard/rspec_examples/describe_handler.rb

@@ -5,30 +5,13 @@ module YARD
     class RSpecDescribeHandler < YARD::Handlers::Ruby::Base
 
       handles method_call(:describe)
+      handles method_call(:context)
 
       def process
         param = statement.parameters.first
-
-        subject = nil
-
-        # A class is being declared
-        if param.type == :var_ref && param.children.first.type == :const
-          subject = param.children.first.source
-        end
-
-        # A class is being declared (with a nested name)
-        if param.type == :const_path_ref
-          subject = param.children.map { |i| i.source }.join("::")
-        end
-
-        # A method is being declared
-        if param.type == :string_literal && param.source =~ /^"#/
-          subject = param.source.delete('"|\ ')
-        end
-
-        ParserTrace.path.push(subject.dup) if subject
+        ParserTrace.stack.push(param)
         parse_block(statement.last.last)
-        ParserTrace.path.pop if subject
+        ParserTrace.stack.pop
       end
     end
   end

data/lib/yard/rspec_examples/it_handler.rb

@@ -6,10 +6,15 @@ module YARD
       handles method_call(:it)
 
       def process
-        it_description = statement.parameters.source[1...-1]
-        rspec_path_string = ParserTrace.path.dup.push(it_description).join(' ')
-        #TODO: indentation depends on level of test indents.
-        RSpecExampleRegistry.example_map[rspec_path_string] = statement.block.last.source.gsub("\n      ", "\n")
+        it_description = statement.parameters.empty? ? '' : statement.parameters.source[1...-1]
+        rspec_path_string = full_example_description(it_description)
+        RSpecExampleRegistry.example_map[rspec_path_string] = statement.block.source.gsub(/\A\s*do\s*^(.*)end\s*\z/m, '\\1')
+                                                                .gsub(/\Ado;\s*(.*)\s*end\z/m, '\\1')
+                                                                .gsub(/\A{\s*(.*)\s*}/m, '\\1').rstrip
+      end
+
+      def full_example_description(it_description)
+        "#{ParserTrace.full_description} #{it_description}"
       end
     end
   end

data/lib/yard/rspec_examples/module_handler.rb

@@ -4,29 +4,9 @@ module YARD
       handles :module
 
       def process
-        # param = statement.parameters.first
-        #
-        # subject = nil
-        #
-        # # A class is being declared
-        # if param.type == :var_ref && param.children.first.type == :const
-        #   subject = param.children.first.source
-        # end
-        #
-        # # A class is being declared (with a nested name)
-        # if param.type == :const_path_ref
-        #   subject = param.children.map { |i| i.source }.join("::")
-        # end
-        #
-        # # A method is being declared
-        # if param.type == :string_literal && param.source =~ /^"#/
-        #   subject = param.source.delete('"|\ ')
-        # end
-        #
-        #TODO: probably thave to strip namespace from the module
-        ParserTrace.path.push(statement.module_name.path)
+        ParserTrace.stack.push(statement.first)
         parse_block(statement.last.last)
-        ParserTrace.path.pop
+        ParserTrace.stack.pop
       end
 
     end

data/lib/yard/rspec_examples/parser_trace.rb

@@ -1,8 +1,25 @@
 module YARD
   module RSpecExamples
     class ParserTrace
-      def self.path
-        @path ||= []
+      def self.stack
+        @stack ||= []
+      end
+
+      def self.full_description
+        @stack.reverse.reduce("") do |result, o|
+          case o.type
+          when :string_literal
+            description = o.source[1..-2]
+            prefix = description =~ /^(#|\.|::)/ ? '' : ' '
+            prefix + description + result
+          when :var_ref
+            "::#{o.path.first}#{result}"
+          when :const_ref
+            "::#{o.path.first}#{result}"
+          else
+            o.source + result
+          end
+        end.gsub(/^::/, '')
       end
     end
   end

data/lib/yard/rspec_examples/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module RSpecExamples
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/lib/yard/tags/rspec_example_tag.rb

@@ -0,0 +1,51 @@
+module YARD
+  module Tags
+    ##
+    # A new type of tags has to be used cause we need to intercept the
+    # text call and generate its contents (in generation time, after everything was parsed)
+    class RSpecExampleTag < Tag
+      def text
+        # for now, we just handle case where describes are derived from the context
+        example_description = full_rspec_description
+        key = find_key(example_description, @name)
+        puts "[warn] Could not find example '#{example_description}'" unless key
+        @text = RSpecExampleRegistry.example_map[key]
+      end
+
+      def name
+        find_key(full_rspec_description, @name) || ''
+      end
+
+      private
+
+      def find_key(example_description, name)
+        key = RSpecExampleRegistry.example_map.keys.detect { |k| k.include?(example_description) }
+        key || RSpecExampleRegistry.example_map.keys.detect { |k| k.include?(name) }
+      end
+
+      def full_rspec_description
+        example_description = rspec_description(object).gsub(/^::/, '')
+        example_description + (@name.empty? ? '' : (@name.to_s =~ /^(#|\.)/ ? @name.to_s : " #{@name}"))
+      end
+
+      def rspec_description(object)
+        case object
+        when CodeObjects::RootObject
+          ""
+        when CodeObjects::MethodObject
+          if object.scope == :instance
+            "#{rspec_description(object.namespace)}##{object.name}"
+          else
+            "#{rspec_description(object.namespace)}.#{object.name}"
+          end
+        when CodeObjects::ClassObject
+          "::#{object.name}"
+        when CodeObjects::ModuleObject
+          "#{rspec_description(object.namespace)}::#{object.name}"
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/example_file.rb

@@ -1,19 +1,28 @@
+# @rspec_example #foo_method
+# @rspec_example #foo_method also supports this
 class Foo
   ## 
   # This is a foo method with an example
   # @rspec_example
   # @rspec_example also supports this
+  # @rspec_example supports single line do begin
+  # @rspec_example supports curly braces syntax
   def foo_method
   end
 end
 
 class Foo
+  # @rspec_example Bar#bar_method
   class Bar
     ##
     # This is a class nested example
     # @rspec_example
     def bar_method
     end
+
+    # @rspec_example
+    def self.class_method
+    end
   end
 end
 

data/spec/inline_examples_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+class Eggplant
+  # @rspec_example
+  def instance_method
+  end
+end
+
+describe Eggplant do
+  subject { -> { Eggplant.new.instance_method } }
+  it { is_expected.not_to raise_error }
+end
+
+describe 'rspec_examples' do
+  context 'with inline examples' do
+    before { YARD.parse(__FILE__) }
+    subject do
+      output = YARD::Registry.all(:class).find { |i| i.to_s == "Eggplant" }
+      output = YARD::Templates::Engine.render(OPTIONS.merge(:object => output))
+      Nokogiri.HTML(output).css('.examples .example').map(&:text)
+    end
+    it { is_expected.to include 'is_expected.not_to raise_error' }
+  end
+end

data/spec/named_examples_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+class NamedExample
+  # @rspec_example can be executed
+  def a_method
+  end
+end
+
+describe NamedExample do
+  describe '#a_method' do
+    it 'can be executed' do
+      NamedExample.new.a_method
+    end
+  end
+end
+
+describe NamedExample do
+  subject do
+    -> {
+      YARD.parse(__FILE__)
+      output = YARD::Registry.all(:class).find { |i| i.to_s == 'NamedExample' }
+      YARD::Templates::Engine.render(OPTIONS.merge(:object => output))
+    }
+  end
+
+  it { is_expected.not_to output.to_stdout }
+end

data/spec/nested_class_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+# @rspec_example Beetroot#instance_method
+# @rspec_example Beetroot.class_method
+class Asparagus
+  # @rspec_example #instance_method
+  # @rspec_example .class_method
+  class Beetroot
+    # @rspec_example
+    def instance_method
+    end
+
+    # @rspec_example
+    def self.class_method
+    end
+  end
+end
+
+# @rspec_example Asparagus::Beetroot#instance_method
+# @rspec_example Asparagus::Beetroot.class_method
+class Zucchini
+end
+
+describe Asparagus::Beetroot do
+  describe '#instance_method' do
+    it 'can be called' do
+      Asparagus::Beetroot.new.instance_method
+    end
+  end
+  describe '.class_method' do
+    it 'can be called' do
+      Asparagus::Beetroot.class_method
+    end
+  end
+end
+
+describe 'rspec_examples' do
+  context 'with nested classes' do
+    it "renders without warning" do
+      expect do
+        YARD.parse(__FILE__)
+        YARD::Registry.all.each do |o|
+          YARD::Templates::Engine.render(OPTIONS.merge(:object => o))
+        end
+      end.not_to output.to_stdout
+    end
+  end
+end

data/spec/nested_modules_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+# @rspec_example NestedModule::EmbeddedClass#instance_method
+# @rspec_example NestedModule::EmbeddedClass.class_method
+module TopModule
+  # @rspec_example EmbeddedClass#instance_method
+  # @rspec_example EmbeddedClass.class_method
+  module NestedModule
+    # @rspec_example #instance_method
+    # @rspec_example .class_method
+    class EmbeddedClass
+      # @rspec_example
+      def instance_method
+      end
+
+      # @rspec_example
+      def self.class_method
+      end
+    end
+  end
+end
+
+# @rspec_example TopModule::NestedModule::EmbeddedClass#instance_method
+# @rspec_example TopModule::NestedModule::EmbeddedClass.class_method
+class AnotherClass
+end
+
+module TopModule
+  module NestedModule
+    describe EmbeddedClass do
+      describe '#instance_method' do
+        it 'can be called' do
+          EmbeddedClass.new.instance_method
+        end
+      end
+      describe '.class_method' do
+        it 'can be called' do
+          EmbeddedClass.class_method
+        end
+      end
+    end
+  end
+end
+
+module TopModule
+  module NestedModule
+    describe EmbeddedClass do
+      it "renders without warning" do
+        expect do
+          YARD.parse(__FILE__)
+          YARD::Registry.all.each do |o|
+            YARD::Templates::Engine.render(OPTIONS.merge(:object => o))
+          end
+        end.not_to output.to_stdout
+        #end.to raise_error
+      end
+    end
+  end
+end

data/spec/simple_context_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+# @rspec_example simple context can be instantiated
+class SimpleClass
+end
+
+describe SimpleClass do
+  context 'with simple context' do
+    it 'can be instantiated' do
+      SimpleClass.new
+    end
+  end
+end
+
+describe SimpleClass do
+   subject {
+     YARD.parse(__FILE__)
+     output = YARD::Registry.all(:class).find { |i| i.to_s == 'SimpleClass' }
+     output = YARD::Templates::Engine.render(OPTIONS.merge(:object => output))
+     Nokogiri.HTML(output).css('.examples .inline').map(&:text)
+   }
+
+  it 'has the right example title' do
+    expect(subject).to include "\nSimpleClass with simple context can be instantiated\n"
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,24 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'yard'
+require 'nokogiri'
+require 'byebug'
 require 'yard-rspec_examples'
+
 require 'fixtures/example_file'
 
+OPTIONS = {
+  :format => :html,
+  :template => :default,
+  :markup => :rdoc,
+  :serializer => YARD::Serializers::FileSystemSerializer.new,
+  :default_return => "Object",
+  :hide_void_return => false,
+  :no_highlight => false,
+  :files => []
+}
+
 RSpec.configure do |config|
   
 end

data/spec/yard-rspec_examples_spec.rb

@@ -1,17 +1,6 @@
 require 'spec_helper'
-require 'yard'
-EXAMPLE_DOC_DIR=[File.expand_path(File.dirname(__FILE__) + "/fixtures/*.rb"), File.expand_path(File.dirname(__FILE__) + "/*.rb")]
 
-OPTIONS = {
-  :format => :html,
-  :template => :default,
-  :markup => :rdoc,
-  :serializer => YARD::Serializers::FileSystemSerializer.new,
-  :default_return => "Object",
-  :hide_void_return => false,
-  :no_highlight => false,
-  :files => []
-}
+EXAMPLE_DOC_DIR=[File.expand_path(File.dirname(__FILE__) + "/fixtures/*.rb"), File.expand_path(File.dirname(__FILE__) + "/*.rb")]
 
 describe "Using the rspec_example tag in the method comment" do
   before(:each) do
@@ -24,11 +13,23 @@ describe "Using the rspec_example tag in the method comment" do
     @nested_class_output = YARD::Templates::Engine.render(OPTIONS.merge(:object => nested_class))
   end
 
+  it "spawns no warnings on the fixtures" do
+    expect do
+      YARD.parse(EXAMPLE_DOC_DIR)
+      foo = YARD::Registry.all(:class).find { |i| i.to_s == "Foo" }
+      @class_foo_output = YARD::Templates::Engine.render(OPTIONS.merge(:object => foo))
+      bar = YARD::Registry.all(:class).find { |i| i.to_s == "Foo::Bar" }
+      @class_bar_output = YARD::Templates::Engine.render(OPTIONS.merge(:object => bar))
+      nested_class = YARD::Registry.all(:module).find { |i| i.to_s == "My" }
+      @nested_class_output = YARD::Templates::Engine.render(OPTIONS.merge(:object => nested_class))
+    end.not_to output.to_stdout
+  end
+
   it "displays warning on unfound example" do
     expect do
       invalid_class = YARD::Registry.all(:class).find { |i| i.to_s == "InvalidClass" }
       @invalid_class_output = YARD::Templates::Engine.render(OPTIONS.merge(:object => invalid_class))
-    end.to output("[warn] Could not find example 'InvalidClass #some_method invalid'\n").to_stdout
+    end.to output("[warn] Could not find example 'InvalidClass#some_method invalid'\n").to_stdout
   end
 
   it "creates an example tag in the registry" do
@@ -40,15 +41,22 @@ describe "Using the rspec_example tag in the method comment" do
   end
 
   it "includes the comments in the example as well" do
-    # TODO: comments as first line get stripped away right now.
     expect(@class_foo_output).to match /With some comments/
   end
 
+  it "supports single line do begin" do
+    expect(Nokogiri.HTML(@class_foo_output).css('.examples .example').map(&:text)).to include('"abracadabra"')
+  end
+
+  it "supports curly braces syntax" do
+    expect(Nokogiri.HTML(@class_foo_output).css('.examples .example').map(&:text)).to include('"curly braces"')
+  end
+
   it "works with nested classes" do
     expect(@class_bar_output).to match /nested_class/
   end
 
-  it "works with module/class/classs nestes classes" do
+  it "works with module/class/class nestes classes" do
     expect(@nested_class_output).to match /super_nested_class/
   end
 
@@ -59,23 +67,18 @@ end
 
 # A bit of a hack, this is the spec that is going to be used as fixture for the plugin
 describe Foo do
-  describe "#foo_method" do
+  context "#foo_method" do
     it "works this way" do
-      this = "is"
-      just = "example code"
       # With some comments
-      [1, 2, 3].each do |i|
-        i
-      end
     end
 
     it "also supports this" do
-      0 + 0
       # comment for 'also support this' it
-      1 + 2
-      # kilo
-      4 + 3
     end
+
+    it "supports single line do begin" do; "abracadabra" end
+
+    it("supports curly braces syntax"){"curly braces"}
   end
 end
 
@@ -86,6 +89,12 @@ describe Foo::Bar do
       nested_class = nil
     end
   end
+
+  describe ".class_method" do
+    it 'is defined' do
+      Foo::Bar.class_method
+    end
+  end
 end
 
 module My

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-rspec_examples
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bert Bruynooghe
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -35,11 +35,11 @@ files:
 - ".document"
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - ".yardopts"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/yard-rspec_examples.rb
 - lib/yard/rspec_examples/describe_handler.rb
@@ -47,7 +47,13 @@ files:
 - lib/yard/rspec_examples/module_handler.rb
 - lib/yard/rspec_examples/parser_trace.rb
 - lib/yard/rspec_examples/version.rb
+- lib/yard/tags/rspec_example_tag.rb
 - spec/fixtures/example_file.rb
+- spec/inline_examples_spec.rb
+- spec/named_examples_spec.rb
+- spec/nested_class_spec.rb
+- spec/nested_modules_spec.rb
+- spec/simple_context_spec.rb
 - spec/spec_helper.rb
 - spec/yard-rspec_examples_spec.rb
 - yard-rspec_examples.gemspec
@@ -76,6 +82,11 @@ specification_version: 4
 summary: Yard plugin to include RSpec examples in documentation
 test_files:
 - spec/fixtures/example_file.rb
+- spec/inline_examples_spec.rb
+- spec/named_examples_spec.rb
+- spec/nested_class_spec.rb
+- spec/nested_modules_spec.rb
+- spec/simple_context_spec.rb
 - spec/spec_helper.rb
 - spec/yard-rspec_examples_spec.rb
 has_rdoc: 

data/README.rdoc

@@ -1,75 +0,0 @@
-= yard-rspec_examples
-
-Yard plugin to include examples in the generated doc through rspec
-
-== Installation
-
-In order to install it you just have to install it gem from gemcutter
-
-  gem install yard-rspec_examples
-
-== Description
-
-This plugin simply includes an example tag and recreates it with the source code that corresponds
-to the first example included in the describe blocks below.
-This have to be defined inside a describe block called "#method_name" that, in turn,
-has to be defined in a describe block with the class name, i.e. the regular way people use rspec when testing objects.
-
-So, for example,
-
-Given this source code:
-
-  class Foo
-    ## 
-    # This is a foo method with an example
-    # @rspec_example
-    def foo_method
-    end
-  end
-
-And this spec:
-
-  describe Foo do
-    describe "#foo_method" do 
-      it "works this way" do
-        this = "is"
-        # The code that will be included in the example
-      end
-    end
-  end
-
-A result like this is to be expected
-  class Foo
-    ## 
-    # This is a foo method with an example
-    # @example
-    #   this = "is"
-    #   # The code that will be included in the example
-    def foo_method
-    end
-  end
-
-Another usage is to pass the example's name to the tag:
-
-  class Foo
-    ##
-    # This is a foo method with an example
-    # @rspec_example works this way
-    def foo_method
-    end
-  end
-
-
-
-
-== Using it
-
-In order to use it, you just have to add the --plugin param plus yours
-
-  yardoc --plugin yar-rspec_examples [OPTS]
-
-
-== Copyright
-Copyright (c) 2011 Jose Fernandez (magec). See LICENSE.txt for
-further details.
-