minitag 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d440fb67a5cd62d5c4b65d12abd2168a7962171348ecdf55b401bc87815d407b
-  data.tar.gz: 0e0aa4b1f27d85fff9fd79242d28a8e48b23f0e5c76cb982b41aae570fa17b79
+  metadata.gz: 3149cc0ce5b301309d45193c6e997b300adb38c6944b2e0c22a0e2634d5e576b
+  data.tar.gz: a15958d81aaa6f99f2d2656cb4ee3840e877bd2c0bf8f4ff877ad6514bb1bfca
 SHA512:
-  metadata.gz: ffc87f80426c64eacc5a9171f5bec559c04fc2e6ebb9c0530fd22b9d84cca03f4d27a6fc637c0ce030b6256793180d6c2276e4cb566a85ecad895078a119d99f
-  data.tar.gz: b636027dfe4dbb4bfcff9d9d5ae6c3614fc1fcf1635779e9911a485ceed81211bc21d5175bde1a8e2cdd2bf037f74e961ba630e9effb42b10cc083d1f6f44eaa
+  metadata.gz: a4ee8c9f7de0386c4275b997c426bb12be7eff7fbd76b7966fde47e8452e35d529e496e6cfb3ccd02e0ab50a622c60ca3d8d2204ae8de940c26e4e9f57124603
+  data.tar.gz: 726bb9c4307f77aba61d23966b339d8a26f20e4b9238dba73546466e942abead18c8e7c7842eb37ab02fb3b9e85c7a2ff6203f830b623c4267790963f65f3a63

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitag (0.5.0)
+    minitag (0.6.0)
       minitest (~> 5.0)
 
 GEM

data/README.md

@@ -2,8 +2,18 @@
 
 # Minitag
 
-A simple gem that allow developers to tag their minitest tests and run tests
-based on these tags.
+A simple gem that allow developers using minitest to specify tags for their classes and tests, and run their test suite based on these tags.
+
+This gem should be framework agnostic, let me know if you encounter any problems
+running this within the framework of your choice.
+
+## When should I use this?
+
+- When there's a need to split a test suite into different CI steps.
+- During development, it's helpful to have extra flexibility when running a big
+  test suite.
+- When there are tests that you want to run only occasionality. For example,
+  tests that perform network calls or have expensive side effects.
 
 ## Installation
 
@@ -23,18 +33,22 @@ $ gem install minitag
 
 ### Setup
 
-Require `minitag` in our `test_helper.rb`:
+Require `minitag` within `test_helper.rb`:
 
 `require 'minitag'`
 
 ### Adding tags
 
-We can tag specific tests with one or more tags.
+We can tag specific classes or tests with one or more tags.
 
-It is important to point out that tags associated with a test have no concept of being inclusive or exclusive. This distinction is only valid for [tag filters](#running-tests-with-tag-filters).
+It is important to point out that tags associated with a class or test have no concept of being inclusive or exclusive. This distinction is only valid for [tag filters](#running-tests-with-tag-filters).
 
 ```rb
 class MyTest < Minitest::Test
+  # Every test within this class will inherit this tag
+  tag_namespace 'my_namespace_tag'
+
+  # Only the test below will have this tag
   tag 'my_tag', 'another_tag'
   def test_hello_minitest
     # ...

data/lib/minitag/minitest_tag.rb

@@ -19,8 +19,6 @@ module Minitag
         namespace: to_s,
         tags: tags.map { |tag| tag.to_s.strip.downcase }
       )
-
-      Minitag.register_for_extension(self)
     end
 
     # Add tags to be associated with the next test definition and extends the
@@ -37,6 +35,23 @@ module Minitag
       Minitag.pending_tags = tags.map { |tag| tag.to_s.strip.downcase }
       Minitag.register_for_extension(self)
     end
+
+    # Decides which methods to run based on an Array of test names provided by
+    # the superclass and the tags defined within test classes.
+    #
+    # Invariants:
+    #   - Returns the full list of test names when the test suite runs without
+    #   any tag filtering.
+    #
+    # @return [Array] the list of test names that should run.
+    def runnable_methods
+      methods = super.dup
+      return methods if Minitag.context.no_filters?
+
+      methods.select do |runnable_method|
+        Minitag.context.match?(namespace: to_s, name: runnable_method)
+      end
+    end
   end
 end
 

data/lib/minitag/tag_extension.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 module Minitag
-  # Module used to extend classes that rely on tags.
-  # It has the following responsibilities:
-  #   - Associate tags with tests
-  #   - Filter tests based on the specified tags
+  # Responsible for listening to added methods and associating tags
+  # with those.
   module TagExtension
     define_method(:method_added) do |name|
       if name[/\Atest_/]
@@ -15,14 +13,5 @@ module Minitag
         Minitag.pending_tags = []
       end
     end
-
-    def runnable_methods
-      methods = super.dup
-      return methods if Minitag.context.no_filters?
-
-      methods.select do |runnable_method|
-        Minitag.context.match?(namespace: to_s, name: runnable_method)
-      end
-    end
   end
 end

data/lib/minitag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Minitag
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/minitest/minitag_plugin.rb

@@ -14,7 +14,7 @@ module Minitest
 
   def self.plugin_minitag_init(options)
     Array(options[:tags]).each do |tag|
-      Minitag.context.add_filter(tag)
+      Minitag.add_filter(tag)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitag
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Bernardo de Araujo