minispec-metadata 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38ce1b63b96b84af69f5727f5eb38d963fe75e99
-  data.tar.gz: a8ac8f3f33abc5350eb57d50dd325668121e3803
+  metadata.gz: a5bdc75e156393afb15081d9942ca420644c1a90
+  data.tar.gz: 50c85c9943c5d9ebf508b6f13ad80b3db146bae0
 SHA512:
-  metadata.gz: 341212cc6062f980ddee800d6a17f8c4d0103f6e7d98f6acb7bacaa2a10ef7670f0c75a910e06943329c40a640b3b6bbee14343a40db7b2f90d05e87c3b28df9
-  data.tar.gz: 607554c3ddc34877eba6fb2cf1810e2deab07d354448512177de7196588b2d5450aa323cde58fa637764b9f0263fd00b7212842ee0c8c5d1ce603ca659f837ac
+  metadata.gz: c7c77884c1cb77c561aedf9cb2f6ba827a98b130f28f205977863cd8f52659cc391b6b7eb3de438ab2cc8fa9614507f6c92539b098e66bf8fece0efea301800b
+  data.tar.gz: 37d97040831cee14ddeb8145b5321640c026c8ddcb1d046af06bb8190f61c968fa3da61f058b6b6ba502b52310c1814a4cebff287ed55cf1ea685c145442e389

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 3.2.0
+
+* Add support for tags for command line filtering.
+
+## 3.1.0
+
+* Do not desctructively extract metadata from additional_desc.
+* Use ALL additional_desc as metadata.
+
 ## 3.0.0
 
 * Total rewrite.

data/README.md

@@ -51,6 +51,14 @@ describe 'Usage', some: 'metadata' do
       self.class.desc.must_equal MinispecMetadata
     end
 
+    it 'treats additional descriptions as metadata too', meta: 'data' do
+      metadata.must_equal(
+        :some                    => 'metadata',
+        'additional description' => true,
+        :meta                    => 'data',
+      )
+    end
+
   end
 
   # Thanks to @mfpiccolo for this.
@@ -74,6 +82,31 @@ describe 'VCR trick' do
 end
 ```
 
+### Tags
+
+(Only for Ruby >= 2 and Minitest >= 5)
+
+Use the `--tag TAG` or `-tTAG` option to focus on certain tests according to metadata (will match both string/symbol as key/value).
+E.g. Run only the slow tests below with option `--tag js`:
+
+```ruby
+describe 'integration tests' do
+  it 'runs super slow JS stuff', :js do
+    # Will run.
+  end
+  it 'runs fast stuff' do
+    # Will not run.
+  end
+end
+```
+
+You can use `--tag` more than once to include more tags to be run (any matching tags will run).
+
+If an exclusive tag, e.g. `~slow`, is used alone, all tests except those tagged slow will be run.
+If an exclusive tag is used in addition to any inclusive tags, then the exclusive tag will just filter those included.
+
+Note that when using `rake`, you need to wrap Minitest's options like this: `rake test TESTOPTS='--tag js'`.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -88,27 +121,6 @@ Or install it yourself:
 
     $ gem install minispec-metadata
 
-## Additional description gotcha
-
-In Minitest <= 4, 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.
-
 ## Compatibility
 
 Tested with Minitest 4 and up.

data/Rakefile

@@ -1,8 +1,9 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
-task :default => :test
+task :default => [:test]
 
 Rake::TestTask.new :test do |t|
   t.pattern = 'spec/**/*.spec.rb'
 end
+

data/lib/backwards.rb

@@ -1,6 +1,6 @@
 # For a bit of backward compatibility.
 # Thanks to @jhsu for discovering the discrepancy.
-if MiniTest.const_defined?(:Unit)
+if Minitest::Versions::MAJOR <= 4
   class MiniTest::Unit::TestCase
     def name
       __name__

data/lib/minispec-metadata.rb

@@ -1,25 +1,26 @@
 require 'minitest/spec'
+
+require 'minitest/versions'
 require_relative 'backwards'
 
-require "minispec-metadata/version"
+require 'minispec-metadata/version'
 
 require 'minispec-metadata/it'
 require 'minispec-metadata/describe'
+require 'minispec-metadata/tags'
 
 module MinispecMetadata
 
   module_function
 
-  def extract_metadata!(args)
+  def extract_metadata(args)
     metadata = {}
-    args.delete_if do |arg|
+    args.each do |arg|
       case arg
       when Hash
         metadata.merge! arg
-      when Symbol
-        metadata.merge!(arg => true)
       else
-        false
+        metadata.merge!(arg => true)
       end
     end
     metadata

data/lib/minispec-metadata/describe.rb

@@ -2,9 +2,19 @@ module MinispecMetadata
   module Describe
 
     def describe(desc, *additional_desc, &block)
-      metadata = MinispecMetadata.extract_metadata! additional_desc
-
-      cls = super(desc, *additional_desc, &block)
+      metadata = MinispecMetadata.extract_metadata additional_desc
+
+      # Minitest 5 allows unlimited additional_desc.
+      # Minitest 4 allows max 1 additional_desc.
+      # So we need to pass up only the number of allowed additional_desc.
+      additional_allowed =
+        if Minitest::Versions::MAJOR <= 4
+          additional_desc.first(1)
+        else
+          additional_desc
+        end
+
+      cls = super(desc, *additional_allowed.compact, &block)
       cls.extend ClassMethods
 
       cls.additional_desc = additional_desc

data/lib/minispec-metadata/it.rb

@@ -10,7 +10,7 @@ module MinispecMetadata
       def it(description, *metadata, &block)
         name = super description, &block
 
-        metadata = MinispecMetadata.extract_metadata!(metadata)
+        metadata = MinispecMetadata.extract_metadata(metadata)
 
         self.it_descriptions[name] = description
         self.metadata_by_test_name[name] = metadata
@@ -27,12 +27,16 @@ module MinispecMetadata
         @it_descriptions ||= {}
       end
 
+      def metadata_for_test_name(test_name)
+        describe_metadata.merge(
+          metadata_by_test_name.fetch(test_name)
+        )
+      end
+
     end
 
     def metadata
-      self.class.describe_metadata.merge(
-        self.class.metadata_by_test_name.fetch(name)
-      )
+      self.class.metadata_for_test_name(name)
     end
 
     def desc

data/lib/minispec-metadata/tags.rb

@@ -0,0 +1,107 @@
+module MinispecMetadata
+
+  module_function
+
+  def tags
+    @tags ||= []
+  end
+
+  def add_tag_string(tag_string)
+    tags << Tag.new(tag_string)
+  end
+
+  def supports_tags?
+    minitest_version_supports_tags? && ruby_version_supports_tags?
+  end
+
+  # Because of plugin system.
+  def minitest_version_supports_tags?
+    Minitest::Versions::MAJOR >= 5
+  end
+
+  # Because of #prepend.
+  def ruby_version_supports_tags?
+    RUBY_VERSION.to_i >= 2
+  end
+
+end
+
+module MinispecMetadata
+
+  module Tags
+
+    def runnable_methods
+      methods = super.dup
+
+      if MinispecMetadata.tags.select(&:inclusive?).any?
+        methods.select! do |runnable_method|
+          runnable_method_matches_any_inclusive_tag?(runnable_method)
+        end
+      end
+
+      methods.reject do |runnable_method|
+        runnable_method_matches_any_exclusive_tag?(runnable_method)
+      end
+    end
+
+    def runnable_method_matches_any_inclusive_tag?(runnable_method)
+      tags = MinispecMetadata.tags.select(&:inclusive?)
+      runnable_method_matches_any_tags?(runnable_method, tags)
+    end
+
+    def runnable_method_matches_any_exclusive_tag?(runnable_method)
+      tags = MinispecMetadata.tags.select(&:exclusive?)
+      runnable_method_matches_any_tags?(runnable_method, tags)
+    end
+
+  private
+
+    def runnable_method_matches_any_tags?(runnable_method, tags)
+      tags.any? do |tag|
+        metadata = metadata_for_test_name(runnable_method)
+        value = metadata[tag.key] || metadata[tag.key.to_sym]
+        matches =
+          if tag.value?
+            value.to_s == tag.value
+          else
+            !!value
+          end
+        matches
+      end
+    end
+
+  end
+
+  class Tag
+
+    def initialize(tag_string)
+      @tag_string = tag_string
+    end
+
+    def exclusive?
+      @tag_string.start_with? '~'
+    end
+
+    def inclusive?
+      !exclusive?
+    end
+
+    def key
+      @key ||= @tag_string[/\w+/]
+    end
+
+    def value
+      @value ||= @tag_string.split(':').last if value?
+    end
+
+    def value?
+      !!@tag_string[/:/]
+    end
+
+  end
+
+end
+
+if MinispecMetadata.supports_tags?
+  Minitest::Test.singleton_class.send :prepend, MinispecMetadata::Tags
+end

data/lib/minispec-metadata/version.rb

@@ -1,3 +1,3 @@
 module MinispecMetadata
-  VERSION = "3.0.0"
+  VERSION = "3.2.0"
 end

data/lib/minitest/minispec_metadata_plugin.rb

@@ -0,0 +1,25 @@
+# This file gets auto required/executed by Minitest >= v5.
+# Any other version won't find this file automatically.
+
+require 'minispec-metadata'
+
+module Minitest
+
+  def self.plugin_minispec_metadata_options(opts, options)
+    opts.on '-t', '--tag TAG'do |tag_string|
+      options[:tag_strings] ||= []
+      options[:tag_strings] << tag_string
+    end
+  end
+
+  def self.plugin_minispec_metadata_init(options)
+    if RUBY_VERSION.to_i >= 2
+      options.fetch(:tag_strings, []).each do |tag_string|
+        MinispecMetadata.add_tag_string tag_string
+      end
+    else
+      warn 'tags requires Ruby 2. If you really want it, please open an issue.'
+    end
+  end
+
+end

data/lib/minitest/versions.rb

@@ -0,0 +1,9 @@
+module Minitest
+
+  module Versions
+
+    MAJOR, MINOR, PATCH = Minitest::Unit::VERSION.split('.').map(&:to_i)
+
+  end
+
+end

data/spec/describe.spec.rb

@@ -72,48 +72,40 @@ describe MinispecMetadata::Describe, super_meta: 'data' do
 
 end
 
-if MiniTest.const_defined?(:Unit) # Minitest version 4 (maybe before too?)
+# Only allows 1 additional description.
+describe MinispecMetadata::Describe, 'additional description' do
 
-  # Only allows 1 additional description.
-  describe MinispecMetadata::Describe, 'additional description' do
-
-    it 'provides a method to get the descriptions' do
-      self.class.descs.must_equal [MinispecMetadata::Describe, 'additional description']
-    end
-
-    it 'provides a method to get only the additional description' do
-      self.class.additional_desc.must_equal ['additional description']
-    end
+  it 'provides a method to get the descriptions' do
+    self.class.descs.must_equal [MinispecMetadata::Describe, 'additional description']
+  end
 
-    describe 'nested describe with no additional description' do
+  it 'provides a method to get only the additional description' do
+    self.class.additional_desc.must_equal ['additional description']
+  end
 
-      it 'does not inherit additional description from parent' do
-        self.class.additional_desc.must_be_empty
-      end
+  describe 'nested describe with no additional description' do
 
+    it 'does not inherit additional description from parent' do
+      self.class.additional_desc.must_be_empty
     end
 
   end
 
-else
-
-  # Minitest version 5
-  describe MinispecMetadata::Describe, 'additional description', 'even more' do
-
-    it 'provides a method to get the descriptions' do
-      self.class.descs.must_equal [MinispecMetadata::Describe, 'additional description', 'even more']
-    end
-
-    it 'provides a method to get only the additional description' do
-      self.class.additional_desc.must_equal ['additional description', 'even more']
-    end
+end
 
-    describe 'nested describe with no additional description' do
+if Minitest::Versions::MAJOR >= 5
 
-      it 'does not inherit additional description from parent' do
-        self.class.additional_desc.must_be_empty
-      end
+  describe 'stuff', 'more stuff', {even_more: 'stuff'}, :holy_cow_that_is_a_lot_of_stuff, :minitest_5 do
 
+    it 'preserves additional description but still allows any value for metadata', :more? => 'yeah' do
+      self.class.descs.must_equal ['stuff', 'more stuff', {even_more: 'stuff'}, :holy_cow_that_is_a_lot_of_stuff, :minitest_5]
+      metadata.must_equal(
+        'more stuff'                     => true,
+        :even_more                       => 'stuff',
+        :holy_cow_that_is_a_lot_of_stuff => true,
+        :more?                           => 'yeah',
+        :minitest_5                      => true,
+      )
     end
 
   end
@@ -123,8 +115,15 @@ end
 describe MinispecMetadata::Describe, 'additional description', :respect do
 
   it 'respects additional description' do
-    self.class.name.must_equal 'MinispecMetadata::Describe::additional description'
-    metadata.must_equal(respect: true)
+    if Minitest::Versions::MAJOR <= 4
+      self.class.name.must_equal 'MinispecMetadata::Describe::additional description'
+    else
+      self.class.name.must_equal 'MinispecMetadata::Describe::additional description::respect'
+    end
+    metadata.must_equal(
+      'additional description' => true,
+      :respect                 => true,
+    )
   end
 
 end

data/spec/it.spec.rb

@@ -51,7 +51,11 @@ describe MinispecMetadata::It do
     describe 'in a nested describe', 'with no metadata' do
 
       it 'works', works: true do
-        metadata.must_equal(description_meta: 'data', works: true)
+        metadata.must_equal(
+          :description_meta  => 'data',
+          'with no metadata' => true,
+          :works             => true,
+        )
       end
 
     end

data/spec/minispec_metadata.spec.rb

@@ -2,27 +2,27 @@ require_relative 'helper'
 
 describe MinispecMetadata do
 
-  describe '#extract_metadata!' do
+  describe '#extract_metadata' do
 
     it 'extracts from a hash' do
-      metadata = MinispecMetadata.extract_metadata! [{asdf: true}]
+      metadata = MinispecMetadata.extract_metadata [{asdf: true}]
       metadata.must_equal asdf: true
     end
 
     it 'extracts from symbols, returns hash keys with true values' do
-      metadata = MinispecMetadata.extract_metadata! [:asdf, :fdsa]
+      metadata = MinispecMetadata.extract_metadata [:asdf, :fdsa]
       metadata.must_equal asdf: true, fdsa: true
     end
 
     it 'extracts a mix' do
-      metadata = MinispecMetadata.extract_metadata! [:asdf, {fdsa: true}]
+      metadata = MinispecMetadata.extract_metadata [:asdf, {fdsa: true}]
       metadata.must_equal asdf: true, fdsa: true
     end
 
-    it 'descructively removes metadata from args' do
+    it 'does not remove metadata from args' do
       args = [:asdf, 'description']
-      metadata = MinispecMetadata.extract_metadata! args
-      args.must_equal ['description']
+      metadata = MinispecMetadata.extract_metadata args
+      args.must_equal [:asdf, 'description']
     end
 
   end

data/spec/regression.spec.rb

@@ -2,7 +2,7 @@ require_relative 'helper'
 
 # Confirmed to not work with v2.0.0.
 # Thanks to @jrochkind.
-describe "top level describe" do    
+describe "top level describe" do
   describe "an inner describe" do
     before do
       desc.wont_be_nil

data/spec/tags.spec.rb

@@ -0,0 +1,110 @@
+require_relative 'helper'
+#require_relative 'test_tags_verifier' if ENV['TEST_TAGS'] && MinispecMetadata.supports_tags?
+
+if MinispecMetadata.supports_tags?
+
+  module MinispecMetadata
+    describe Tag do
+
+      it 'captures the metadata key' do
+        tag = Tag.new('~sure')
+        tag.key.must_equal 'sure'
+        tag.value?.must_equal false
+      end
+
+      it 'captures metadata key/value' do
+        tag = Tag.new('key:value')
+        tag.key.must_equal   'key'
+        tag.value.must_equal 'value'
+      end
+
+      it 'captures inclusivity' do
+        tag = Tag.new('sure')
+        tag.must_be :inclusive?
+      end
+
+      it 'captures exclusivity' do
+        tag = Tag.new('~sure')
+        tag.must_be :exclusive?
+      end
+
+    end
+
+    TAGS_TEST = describe Tags do
+      def self.passing_test(*args)
+        it *args do
+          pass
+        end
+      end
+
+      passing_test '1', :minitest_5
+      passing_test '2', 'minitest_5', :slow
+      passing_test '3', :minitest_4
+      passing_test '4', :minitest_4, 'slow'
+      passing_test '5', :slow, specific: 'value'
+      passing_test '6', 'specific' => :value, unmatched: :value
+      passing_test '7', 'specific' => 'value'
+    end
+
+    # Test the #runnable_methods of tags_test above with different sets of Tags.
+    describe '#runnable_methods' do
+
+      def stub_tags(tag_strings, &block)
+        tags = tag_strings.map { |tag_string| Tag.new(tag_string) }
+        MinispecMetadata.stub :tags, tags, &block
+      end
+
+      def strip_prefix(name)
+        name.sub /^test_\d{4}_/, ''
+      end
+
+      def self.assert_runnable_methods_with_tags(tag_strings, expected_runnable_methods)
+        it "returns runnable_methods with tag_strings #{tag_strings.inspect}" do
+          stub_tags tag_strings do
+            TAGS_TEST
+              .runnable_methods
+              .map(&method(:strip_prefix))
+              .sort
+              .must_equal expected_runnable_methods
+          end
+        end
+      end
+
+      assert_runnable_methods_with_tags ['minitest_5'], %w[
+        1
+        2
+      ]
+
+      assert_runnable_methods_with_tags ['~minitest_4'], %w[
+        1
+        2
+        5
+        6
+        7
+      ]
+
+      assert_runnable_methods_with_tags ['specific:value'], %w[
+        5
+        6
+        7
+      ]
+
+      assert_runnable_methods_with_tags ['~unmatched:value'], %w[
+        1
+        2
+        3
+        4
+        5
+        7
+      ]
+
+      assert_runnable_methods_with_tags ['minitest_5', 'minitest_4', 'specific:value', '~unmatched:value', '~slow'], %w[
+        1
+        3
+        7
+      ]
+
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minispec-metadata
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Jared Ning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -71,10 +71,11 @@ files:
 - lib/backwards.rb
 - lib/minispec-metadata.rb
 - lib/minispec-metadata/describe.rb
-- lib/minispec-metadata/describe_with_metadata.rb
 - lib/minispec-metadata/it.rb
-- lib/minispec-metadata/spec_with_metadata.rb
+- lib/minispec-metadata/tags.rb
 - lib/minispec-metadata/version.rb
+- lib/minitest/minispec_metadata_plugin.rb
+- lib/minitest/versions.rb
 - minispec-metadata.gemspec
 - spec/describe.spec.rb
 - spec/helper.rb
@@ -82,6 +83,7 @@ files:
 - spec/minispec_metadata.spec.rb
 - spec/readme.spec.rb
 - spec/regression.spec.rb
+- spec/tags.spec.rb
 homepage: https://github.com/ordinaryzelig/minispec-metadata
 licenses:
 - MIT
@@ -113,3 +115,4 @@ test_files:
 - spec/minispec_metadata.spec.rb
 - spec/readme.spec.rb
 - spec/regression.spec.rb
+- spec/tags.spec.rb

data/lib/minispec-metadata/describe_with_metadata.rb

@@ -1,45 +0,0 @@
-module MinispecMetadata
-  module DescribeWithMetadata
-
-    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)
-      end
-
-      description_class.send :define_method, :spec_additional_description do
-        additional_description
-      end
-
-      description_class
-    end
-
-    # Top-level method so all subclasses can call super.
-    def description_metadata
-      {}
-    end
-
-  end
-end
-
-Object.send :include, MinispecMetadata::DescribeWithMetadata

data/lib/minispec-metadata/spec_with_metadata.rb

@@ -1,66 +0,0 @@
-module MinispecMetadata
-  module SpecWithMetadata
-
-    def self.included(spec_class)
-      spec_class.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      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) :
-            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
-      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
-      self.class.class_variable_get(:@@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
-
-MiniTest::Spec.send :include, MinispecMetadata::SpecWithMetadata