minitag 0.3.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab98e9f2debb23b27f21435a3b2ac0102a835391accb97fd7e1bae69457f4e07
-  data.tar.gz: 538c9bc1789dd2080b3a8f8430c116d05693eb5c2dfee3f1204fe60c67e5e80a
+  metadata.gz: edc15f86cd75fafe193dda4ce0c3ec53195a3c831b3b364c1268468cec1fa58b
+  data.tar.gz: a7cba97a2c8f4cde4263f7d4e880510a6f14a6606649eb3920bfe0a569ef9805
 SHA512:
-  metadata.gz: '081ad2c7553abb897271b01e30d0561255ca5ee30128aac47f4dbee4ac29fd7a0de0e1954268c9325f9476823f6ffc16321b429fc9d98b0edc3fc20e10433ca6'
-  data.tar.gz: 372cd5e85be6c5f7c35faf779e2ab197ac8a4d218dd11b13c43c2b5be2449aa7c14d4898208cc93c5410a24b2ec4e6290171c1d67dca332d8f9325706cb2eace
+  metadata.gz: 4e2aa1f83f281212d0417747906b9ec9cc0e7e97f9aa7d0d38eac636d1d8d0f98c555cace09b410ee2655c060e4008fa5eaafae7225f4a674f26e1bb9a19810c
+  data.tar.gz: 31b67943091e116adf9ec47a751075b8d1e5fac32480a04bbbd406bcaa732252d31fb274cfd5645f6a2cf8ded9318817dce1537eaf707572aa090e9b3a438421

data/.github/workflows/ci.yml

@@ -1,22 +1,26 @@
 name: continuous-integration
-on: push
+on: [push, pull_request]
 
 jobs:
   ci:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7' ]
+    name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Ruby 2.7
+      - name: Set up Ruby ${{ matrix.ruby }}
         uses: actions/setup-ruby@v1
         with:
-          ruby-version: "2.7"
+          ruby-version: ${{ matrix.ruby }}
       - name: Cache gems
         uses: actions/cache@v2
         with:
           path: vendor/bundle
-          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
-            ${{ runner.os }}-gem-
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
       - name: Install gems
         run: |
           sed -i '/ruby ".*"/,+1 d' Gemfile

data/.rubocop.yml

@@ -1,13 +1,12 @@
 AllCops:
   NewCops: enable
 
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
 Layout/LineLength:
   Max: 120
 
+Metrics/ClassLength:
+  Enabled: false
 
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*_test.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitag (0.3.3)
+    minitag (0.6.1)
       minitest (~> 5.0)
 
 GEM
@@ -15,7 +15,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.7.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rubocop (0.87.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)

data/README.md

@@ -1,9 +1,11 @@
-[![Gem Version](https://badge.fury.io/rb/minitag.svg)](https://badge.fury.io/rb/minitag)
+[![Gem Version](https://badge.fury.io/rb/minitag.svg)](https://badge.fury.io/rb/minitag) [![](https://github.com/bernardoamc/minitag/workflows/continuous-integration/badge.svg)](https://github.com/bernardoamc/minitag/actions?query=workflow%3Acontinuous-integration)
 
 # 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.
 
 ## Installation
 
@@ -21,20 +23,18 @@ $ gem install minitag
 
 ## Usage
 
-### Setup
-
-Require `minitag` in our `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
     # ...
@@ -70,6 +70,24 @@ $ bundle exec rake test --tag '~unit'
 $ bundle exec rake test --tag 'unit' --tag '~parallel'
 ```
 
+## FAQ
+
+### Is this gem compatible with Rails?
+
+Yes. Found any problems? Please open an issue or reach out to me.
+
+### Is this gem compatible with the spec part of minitest?
+
+For the most part yes, but tagging `describe` blocks are not supported.
+
+### When should I use this gem?
+
+- 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.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/minitag.rb

@@ -1,14 +1,27 @@
 # frozen_string_literal: true
 
+require 'set'
 require 'minitest'
 require 'minitag/version'
 require 'minitag/context'
+require 'minitag/extension_registry'
+require 'minitag/minitest_tag'
 require 'minitag/tag_extension'
 
 # Namespace for classes or modules providing tagging functionality
 # to Minitest::Test
 module Minitag
   class << self
+    # Registry of classes that requires extension by Minitag::TagExtension.
+    def extension_registry
+      @extension_registry ||= ExtensionRegistry.new
+    end
+
+    # Register a class for extension.
+    def register_for_extension(klass)
+      extension_registry.register(klass)
+    end
+
     # Execution context of the test suite.
     def context
       @context ||= Context.new

data/lib/minitag/context.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
 require_relative './tag_registry'
 
 module Minitag
@@ -19,12 +18,25 @@ module Minitag
     # @param [Array] tags the collection of tags.
     #
     # @return [void]
-    def add_tags(namespace:, name:, tags:)
+    def add_test_tags(namespace:, name:, tags:)
       @tag_registry.add(namespace: namespace, name: name, tags: tags)
     end
 
+    # Add tags to an entire namespace. Every test within the namespace will
+    # share these tags.
+    #
+    # @param [String] namespace the namespace that contain tests.
+    # @param [Array] tags the collection of tags.
+    #
+    # @return [void]
+    def add_namespace_tags(namespace:, tags:)
+      @tag_registry.add_for_namespace(namespace: namespace, tags: tags)
+    end
+
     # Adds a filter tag.
-    # Tags with a ~ prefix are treated as exclusive filters or inclusive filters otherwise.
+    #
+    # Tags with a ~ prefix are treated as exclusive filters or inclusive filters
+    # otherwise.
     #
     # param [String] name the name of the filter tag.
     #
@@ -62,7 +74,7 @@ module Minitag
     def match?(namespace:, name:)
       return true if no_filters?
 
-      tags = @tag_registry.fetch(namespace: namespace, name: name)
+      tags = @tag_registry.get(namespace: namespace, name: name)
       match_inclusive_filters?(tags) && match_exclusive_filters?(tags)
     end
 

data/lib/minitag/extension_registry.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Minitag
+  # Stores and extends classes that relies on tags with the Minitag::TagExtension
+  # module.
+  class ExtensionRegistry
+    def initialize
+      @registry = {}
+    end
+
+    # Extends a class with Minitag::TagExtension and stores it as extended.
+    #
+    # Invariants:
+    #   - Classes that were already extended will be ignored during this operation.
+    #
+    # @param [Class] klass a class that will be extended.
+    #
+    # @return [void]
+    def register(klass)
+      return if @registry.key?(klass)
+
+      @registry[klass] = true
+      klass.singleton_class.prepend(Minitag::TagExtension)
+    end
+  end
+end

data/lib/minitag/minitest_tag.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Minitag
+  # Module used to extend Minitest::Test with the tag method.
+  module MinitestTag
+    # Add tags to be associated with an entire class that inherits from
+    # Minitest::Test. Every test that belongs to this class will also inherit
+    # these tags.
+    #
+    # It is important to notice that tags associated with a class have no
+    # concept of being inclusive or exclusive. This distinction is only
+    # valid for tag filters.
+    #
+    # @param [Array] tags the list of tags to be associated with a test class.
+    #
+    # @return [void]
+    def tag_namespace(*tags)
+      Minitag.context.add_namespace_tags(
+        namespace: to_s,
+        tags: tags.map { |tag| tag.to_s.strip.downcase }
+      )
+    end
+
+    # Add tags to be associated with the next test definition and extends the
+    # class from which the tag method is being used with Minitag::TagExtension.
+    #
+    # It is important to notice that tags associated with a test have no concept
+    # of being inclusive or exclusive. This distinction is only valid for tag
+    # filters.
+    #
+    # @param [Array] tags the list of tags to be associated with a test case.
+    #
+    # @return [void]
+    def tag(*tags)
+      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
+
+Minitest::Test.singleton_class.prepend(Minitag::MinitestTag)

data/lib/minitag/tag_extension.rb

@@ -1,44 +1,17 @@
 # frozen_string_literal: true
 
 module Minitag
-  # Module used to extend Minitest::Test.
-  # It has the following responsibilities:
-  #   - Introduce the tag functionality
-  #   - Associate tags with tests
-  #   - Filter tests based on the specified tags
+  # Responsible for listening to added methods and associating tags
+  # with those.
   module TagExtension
-    # Add tags to be associated with the next test definition.
-    #
-    # It is important to notice that tags associated with a test have no concept
-    # of being inclusive or exclusive. This distinction is only valid for tag
-    # filters.
-    #
-    # @param [Array] tags the list of tags to be associated with a test case.
-    #
-    # @return [void]
-    def tag(*tags)
-      Minitag.pending_tags = tags.map { |tag| tag.to_s.strip.downcase }
-    end
-
     define_method(:method_added) do |name|
       if name[/\Atest_/]
-        Minitag.context.add_tags(
-          namespace: self, name: name, tags: Minitag.pending_tags
+        Minitag.context.add_test_tags(
+          namespace: to_s, name: name, tags: Minitag.pending_tags
         )
 
         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: self, name: runnable_method)
-      end
-    end
   end
 end
-
-Minitest::Test.singleton_class.prepend(Minitag::TagExtension)

data/lib/minitag/tag_registry.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module Minitag
-  # Stores tags associated with a test name, which belongs to a namespace.
-  # The namespace is usually the class which the test belongs to.
+  # Stores tags associated with a namespace or a single test case.
+  #
+  # A namespace is usually the class which tests belongs to.
   class TagRegistry
     def initialize
-      @repository = Hash.new { |h, k| h[k] = Set.new }
+      @registry = {}
     end
 
     # Associates tags with a name taking into account its namespace.
@@ -20,7 +19,19 @@ module Minitag
     #
     # @return [void]
     def add(namespace:, name:, tags:)
-      @repository[key(namespace, name)] = Set.new(tags)
+      @registry[key(namespace, name)] = Set.new(tags)
+    end
+
+    # Associates tags with a namespace.
+    #
+    # Duplicated tags will be removed during this operation.
+    #
+    # @param [String] namespace the context which a test name belongs.
+    # @param [Array] tags the collection of tags associated with a test.
+    #
+    # @return [void]
+    def add_for_namespace(namespace:, tags:)
+      @registry[namespace] = Set.new(tags)
     end
 
     # Fetches tags associated with a test name and namespace.
@@ -29,8 +40,10 @@ module Minitag
     # @param [String] name the test name.
     #
     # @return [Set] the tags associated with the specified namespace and test name.
-    def fetch(namespace:, name:)
-      @repository[key(namespace, name)]
+    def get(namespace:, name:)
+      @registry.fetch(namespace, Set.new).union(
+        @registry.fetch(key(namespace, name), Set.new)
+      )
     end
 
     private

data/lib/minitag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Minitag
-  VERSION = '0.3.3'
+  VERSION = '0.6.1'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitag
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.6.1
 platform: ruby
 authors:
 - Bernardo de Araujo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,8 @@ files:
 - bin/setup
 - lib/minitag.rb
 - lib/minitag/context.rb
+- lib/minitag/extension_registry.rb
+- lib/minitag/minitest_tag.rb
 - lib/minitag/tag_extension.rb
 - lib/minitag/tag_registry.rb
 - lib/minitag/version.rb