minispec-metadata 0.1.0 → 0.2.0

data/README.md

@@ -10,6 +10,11 @@ https://github.com/ordinaryzelig/minispec-metadata
 ```ruby
 describe 'Usage', some: 'metadata' do
 
+  before do
+    # Example usefulness:
+    # Capybara.current_driver = metadata[:driver]
+  end
+
   it 'defines a metadata method', more: 'metadata' do
     metadata.must_equal(
       some: 'metadata',
@@ -23,9 +28,67 @@ describe 'Usage', some: 'metadata' do
     )
   end
 
+  it 'provides a method to get the name of the spec' do
+    spec_name.must_equal 'provides a method to get the name of the spec'
+  end
+
+  describe MiniSpecMetadata::DescribeWithMetadata, 'additional description' do
+
+    it 'provides a method to get the descriptions' do
+      spec_descriptions.must_equal [MiniSpecMetadata::DescribeWithMetadata, 'additional description']
+    end
+
+    # I say "shortcut" because you can easily get this without this gem via
+    # self.class.desc
+    it 'provides a shortcut to get the main description' do
+      spec_description.must_equal MiniSpecMetadata::DescribeWithMetadata
+    end
+
+    it 'provides a method to get only the additional description' do
+      spec_additional_description.must_equal 'additional description'
+    end
+
+  end
+
+end
+```
+
+Another great use is to do a version of [Ryan Bates' VCR trick](http://railscasts.com/episodes/291-testing-with-vcr?view=asciicast).
+
+```ruby
+describe 'VCR trick' do
+
+  it 'allows you to name your cassettes the same as the spec' do
+    VCR.use_cassette spec_name do
+    end
+  end
+end
+```
+
+### Gotchas
+
+If you registered a custom spec type and made it a subclass of MiniTest::Spec, e.g.:
+
+```ruby
+class IntegrationSpec < MiniTest::Spec
+  register_spec_type(/integration$/, self)
+end
+MiniTest
+```
+
+then you will need to change your superclass to be a subclass of the spec type that allows metadata
+(see Implementation below).
+Just change it like this:
+
+```ruby
+class IntegrationSpec < MiniTest::Spec.spec_type(//)
+  register_spec_type(/integration$/, self)
 end
+MiniTest
 ```
 
+`MiniTest::Spec.spec_type` will always give you the top-level spec type, even if you don't use this gem.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -39,3 +102,11 @@ And then execute:
 Or install it yourself as:
 
     $ gem install minispec-metadata
+
+## Implementation (for transparency)
+
+To add metadata to `it` blocks, I subclassed MiniTest::Spec.
+In order to ensure that it gets used out of the box,
+I changed the default Spec class to be the new subclass.
+
+To add metadata to `describe` blocks, I included a module into the Object class.

data/lib/minispec-metadata/describe_with_metadata.rb

@@ -4,12 +4,17 @@ module MiniSpecMetadata
     def describe(desc, *args, &block)
       metadata = args.last.is_a?(Hash) ? args.pop : {}
 
+      additional_description = args.first
       description_class = super(desc, args, &block)
 
       description_class.send :define_method, :description_metadata do
         super().merge(metadata)
       end
 
+      description_class.send :define_method, :spec_additional_description do
+        additional_description
+      end
+
       description_class
     end
 

data/lib/minispec-metadata/spec_with_metadata.rb

@@ -2,10 +2,12 @@ module MiniSpecMetadata
   class SpecWithMetadata < MiniTest::Spec
 
     @@metadata = {}
+    @@spec_names = {}
 
     def self.it(desc = 'anonymous', metadata = {}, &block)
       name = super desc, &block
       @@metadata[name] = metadata
+      @@spec_names[name] = desc
       name
     end
     class << self
@@ -16,6 +18,25 @@ module MiniSpecMetadata
       description_metadata.merge @@metadata.fetch(__name__, {})
     end
 
+    # First arg passed to it block.
+    def spec_name
+      @@spec_names[__name__]
+    end
+
+    # Description args passed to describe.
+    # Additional description is included if given.
+    def spec_descriptions
+      [spec_description, spec_additional_description].compact
+    end
+
+    def spec_description
+      self.class.desc
+    end
+
+    def spec_additional_description
+      self.class.spec_additional_description
+    end
+
   end
 end
 

data/lib/minispec-metadata/version.rb

@@ -1,3 +1,3 @@
 module MiniSpecMetadata
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/describe_with_metadata.spec.rb

@@ -64,3 +64,27 @@ describe MiniSpecMetadata::DescribeWithMetadata, super_meta: 'data' do
   end
 
 end
+
+describe MiniSpecMetadata::DescribeWithMetadata, 'additional description' do
+
+  it 'provides a method to get the descriptions' do
+    spec_descriptions.must_equal [MiniSpecMetadata::DescribeWithMetadata, 'additional description']
+  end
+
+  it 'provides a shortcut to get the main description' do
+    spec_description.must_equal MiniSpecMetadata::DescribeWithMetadata
+  end
+
+  it 'provides a method to get only the additional description' do
+    spec_additional_description.must_equal 'additional description'
+  end
+
+  describe 'nested describe with no additional description' do
+
+    it 'does not inherit additional description from parent' do
+      spec_additional_description.must_be_nil
+    end
+
+  end
+
+end

data/spec/spec_with_metadata.spec.rb

@@ -47,3 +47,11 @@ describe MiniSpecMetadata::SpecWithMetadata do
   end
 
 end
+
+describe MiniSpecMetadata::SpecWithMetadata, 'test name' do
+
+  it 'provides a method to get the name of the spec' do
+    spec_name.must_equal 'provides a method to get the name of the spec'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minispec-metadata
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest