minispec-metadata 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cce2a61ca40964ed06d9e2e649c1002133b9b8f
-  data.tar.gz: 285a42529861f70d7cc3a2d0c900ba6a4ce4a0af
+  metadata.gz: 9b9aead991197f6c110e3a5f9dcf7d8f2a092c9f
+  data.tar.gz: 58a7d3d21d051cd4421a1c7b1476473da6fa3260
 SHA512:
-  metadata.gz: 42b1922f175708ff7e050bdab7905cb34ab50d275ab5e02fdb26721ecec836c13d4dc6bed76d8aa7a49dde0d422bba9d63befd4a7007723921212c52ca006630
-  data.tar.gz: e7abea1f81addc0bd9fea33e5cc4af02d8ca2744fdcd2834546ee53d0ff502d6aa591b94ed39673859f48ec2641fe5ddf8a943e58502393e5a8b35d62366dea2
+  metadata.gz: 6069c683aecb3aa941c355b6ca48ecfdf606dd4c6d5e217224eaef8d19066f68ffc266b175fce6bedc9164f48f9a57b25a645390f59befaa80b55bd5449b7ce9
+  data.tar.gz: 2eddcda76ff3209e96de99bced9b758c0132170589d7841e5a3e8bafafc427d1a60754af07cf652ef10bfb1f00e3688c37274b4c3d56ffc5d768c61a19ceecee

data/README.md

@@ -57,7 +57,6 @@ Another great use is to do a version of [Ryan Bates' VCR trick](http://railscast
 
 ```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
@@ -65,30 +64,6 @@ describe 'VCR trick' do
 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:
@@ -99,14 +74,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself:
 
     $ 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/spec_with_metadata.rb

@@ -1,26 +1,38 @@
 module MiniSpecMetadata
-  class SpecWithMetadata < MiniTest::Spec
+  module SpecWithMetadata
 
-    @@metadata = {}
-    @@spec_names = {}
-
-    def self.it(desc = 'anonymous', metadata = {}, &block)
-      name = super desc, &block
-      @@metadata[name] = metadata
-      @@spec_names[name] = desc
-      name
+    def self.included(spec_class)
+      spec_class.extend(ClassMethods)
     end
-    class << self
-      alias :specify :it
+
+    module ClassMethods
+      def it(desc = 'anonymous', _metadata = {}, &block)
+        metadata =
+          class_variable_defined?(:@@metadata) ?
+            class_variable_get(:@@metadata) :
+            class_variable_set(:@@metadata, {})
+        spec_names =
+          class_variable_defined?(:@@spec_names) ?
+            class_variable_get(:@@spec_names) :
+            class_variable_set(:@@spec_names, {})
+
+        name = super desc, &block
+
+        metadata[name] = _metadata
+        spec_names[name] = desc
+        name
+      end
+      alias_method :specify, :it
     end
 
     def metadata
-      description_metadata.merge @@metadata.fetch(name, {})
+      class_metadata = self.class.class_variable_get(:@@metadata).fetch(name, {})
+      description_metadata.merge class_metadata
     end
 
     # First arg passed to it block.
     def spec_name
-      @@spec_names[name]
+      self.class.class_variable_get(:@@spec_names)[name]
     end
 
     # Description args passed to describe.
@@ -40,5 +52,4 @@ module MiniSpecMetadata
   end
 end
 
-# Override the default spec type.
-MiniTest::Spec::TYPES[0] = [//, MiniSpecMetadata::SpecWithMetadata]
+MiniTest::Spec.send :include, MiniSpecMetadata::SpecWithMetadata

data/lib/minispec-metadata/version.rb

@@ -1,3 +1,3 @@
 module MiniSpecMetadata
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/minispec-metadata.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{MiniTest::Spec metadata}
   gem.summary       = %q{Pass metadata to MiniTest::Spec descriptions and specs like in RSpec.}
   gem.homepage      = "https://github.com/ordinaryzelig/minispec-metadata"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/helper.rb

@@ -1,11 +1,10 @@
 require 'bundler/setup'
+require 'awesome_print'
 
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'minispec-metadata'
 
-require 'awesome_print'
-
 class MiniTest::Unit::TestCase
   parallelize_me!
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minispec-metadata
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jared Ning
@@ -77,7 +77,8 @@ files:
 - spec/helper.rb
 - spec/spec_with_metadata.spec.rb
 homepage: https://github.com/ordinaryzelig/minispec-metadata
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []