minispec-metadata 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b9aead991197f6c110e3a5f9dcf7d8f2a092c9f
-  data.tar.gz: 58a7d3d21d051cd4421a1c7b1476473da6fa3260
+  metadata.gz: 3b3e8197843d0b0115644bd53b223e5cf1855d17
+  data.tar.gz: 2d74dd7985cfa56a119b3e354fefb314df0a14a0
 SHA512:
-  metadata.gz: 6069c683aecb3aa941c355b6ca48ecfdf606dd4c6d5e217224eaef8d19066f68ffc266b175fce6bedc9164f48f9a57b25a645390f59befaa80b55bd5449b7ce9
-  data.tar.gz: 2eddcda76ff3209e96de99bced9b758c0132170589d7841e5a3e8bafafc427d1a60754af07cf652ef10bfb1f00e3688c37274b4c3d56ffc5d768c61a19ceecee
+  metadata.gz: 32bb94f89f459d02737b0bf1697b7aed6eed25de6225c46c3a0805bb7b77d7a0393e98a4738fe989fd44d59924e4c9c8a92339a4a15f3813991ed45c9be605c1
+  data.tar.gz: f47ca8c8c4798c238f82282c6bb69b8f0d05bd3bb10ada125aa9f1b6baf15667d0c3a012da02f7d98eef2fe85efc1a3aab92e5f8ce068e07a62b686a414a23cc

data/README.md

@@ -8,6 +8,9 @@ https://github.com/ordinaryzelig/minispec-metadata
 ## Usage
 
 ```ruby
+require 'minitest/autorun'
+require 'minispec-metadata'
+
 describe 'Usage', some: 'metadata' do
 
   before do
@@ -50,6 +53,13 @@ describe 'Usage', some: 'metadata' do
 
   end
 
+  # Thanks to @mfpiccolo for this.
+  it 'allows array of symbols like RSpec', :these, :work, :too do
+    metadata[:these].must_equal true
+    metadata[:work].must_equal true
+    metadata[:too].must_equal true
+  end
+
 end
 ```
 
@@ -77,3 +87,24 @@ And then execute:
 Or install it yourself:
 
     $ gem install minispec-metadata
+
+## Additional description gotcha
+
+By default, Minitest allows 2 descriptions:
+
+```ruby
+describe 'Description 1', 'Description 2'
+```
+
+But this gem allows symbols as metadata:
+
+```ruby
+describe 'Description', :additional
+```
+
+Technically, this gem breaks Minitest behavior here.
+With this gem, `:additional` is used as metadata.
+But in pure Minitest, it would have been used as the additional description.
+I personally have never seen anybody use the additional description,
+and I think the "symbols as metadata" feature is more useful.
+So I allowed this breakage of Minitest behavior.

data/lib/core_extensions.rb

@@ -1,3 +1,5 @@
+# For a bit of backward compatibility.
+# Thanks to @jhsu for discovering the discrepancy.
 if MiniTest.const_defined?(:Unit)
   class MiniTest::Unit::TestCase
     def name

data/lib/minispec-metadata/describe_with_metadata.rb

@@ -1,11 +1,27 @@
 module MiniSpecMetadata
   module DescribeWithMetadata
 
-    def describe(desc, *args, &block)
-      metadata = args.last.is_a?(Hash) ? args.pop : {}
-
-      additional_description = args.first
-      description_class = super(desc, args, &block)
+    def describe(desc, *_args, &block)
+      args = _args.dup
+
+      metadata =
+        case args.last
+        when Hash
+          args.pop
+        when Symbol
+          # We're changing Minitest behavior here.
+          # If args.first is anything but a Symbol, use it as additional_description.
+          # If it's a symbol, assume it is metadata.
+          additional_description = args.shift unless args.first.is_a?(Symbol)
+          args.each_with_object({}) do |arg, hash|
+            hash[arg] = true
+          end
+        else
+          {}
+        end
+
+      additional_description ||= args.first
+      description_class = super(desc, additional_description, &block)
 
       description_class.send :define_method, :description_metadata do
         super().merge(metadata)

data/lib/minispec-metadata/spec_with_metadata.rb

@@ -6,7 +6,18 @@ module MiniSpecMetadata
     end
 
     module ClassMethods
-      def it(desc = 'anonymous', _metadata = {}, &block)
+      def it(desc = 'anonymous', *_args, &block)
+        args = _args.dup
+
+        _metadata = 
+          if args.last.is_a?(Hash)
+            args.last
+          else
+            args.each_with_object({}) do |arg, hash|
+              hash[arg] = true
+            end
+          end
+
         metadata =
           class_variable_defined?(:@@metadata) ?
             class_variable_get(:@@metadata) :

data/lib/minispec-metadata/version.rb

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

data/spec/describe_with_metadata.spec.rb

@@ -18,6 +18,13 @@ describe MiniSpecMetadata::DescribeWithMetadata, super_meta: 'data' do
 
   end
 
+  describe 'when just a symbol is passed', :axiom, :vcr do
+    it 'uses symbols as true values' do
+      metadata.fetch(:axiom).must_equal true
+      metadata.fetch(:vcr).must_equal true
+    end
+  end
+
   describe 'duplicate', first: '1st' do
 
     it 'correctly scopes metadata to current description' do

data/spec/spec_with_metadata.spec.rb

@@ -14,6 +14,11 @@ describe MiniSpecMetadata::SpecWithMetadata, description_meta: 'data' do
     metadata.fetch(:description_meta).must_equal 'data'
   end
 
+  it "uses symbols as true values", :verity, :words_are_hard do
+    metadata.fetch(:verity).must_equal true
+    metadata.fetch(:words_are_hard).must_equal true
+  end
+
   specify 'it works with #specify', 1 => 2 do
     metadata.fetch(1).must_equal 2
   end
@@ -22,6 +27,23 @@ describe MiniSpecMetadata::SpecWithMetadata, description_meta: 'data' do
     name.must_equal name
   end
 
+  describe 'in a nested describe', 'with no metadata' do
+
+    it 'works', works: true do
+      metadata[:works].must_equal true
+    end
+
+  end
+
+  describe 'in a nested describe', with_metadata: true do
+
+    it 'works', works: true do
+      metadata[:with_metadata].must_equal true
+      metadata[:works].must_equal true
+    end
+
+  end
+
 end
 
 describe MiniSpecMetadata::SpecWithMetadata, 'with no metadata' do
@@ -55,3 +77,12 @@ describe MiniSpecMetadata::SpecWithMetadata, 'test name' do
   end
 
 end
+
+describe MiniSpecMetadata::SpecWithMetadata, 'additional description', :respect do
+
+  it 'respects additional description' do
+    self.class.name.must_equal 'MiniSpecMetadata::SpecWithMetadata::additional description'
+    metadata.must_equal({respect: true})
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minispec-metadata
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jared Ning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Pass metadata to MiniTest::Spec descriptions and specs like in RSpec.