minitag 0.4.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cfcb59a8e761ef05e4520539a37892c772362685feab9ca2c9d98badbc155ee
-  data.tar.gz: e99d1e6784863d642564e69592d08d999218399951dbd346f484d63450358e19
+  metadata.gz: 02416e0cda7083e357dc0342f0d6d3f86bb738f6040e8d43e08d49c64acde976
+  data.tar.gz: b62593ed9ed8180006488b7cbeb01c536eb79b0b52f6b184795c98d17adeb643
 SHA512:
-  metadata.gz: 9e788f60ca4a42e8220ed07955b2c4f93a41791b4e9425b17f6785b3783e0cb88b002fc75d03baceb73984a65438df1ab041455243a11dfe480b1e6be8dce888
-  data.tar.gz: a8720ea668e10aa1c4d1fb58fb2c4fad8661c39e9fe33f8e35a69a57696c482ebf3c236074716764eef004225900e3fc11eb3d37e71dc93f904d98e380114f6f
+  metadata.gz: d327bd13b733bdfc9f1c0335f6f60c73c3ef621f67890389091a9aea23e2f6157074d4e4cc6c81efcec4ccfcc5f59cb42c44d12c8e54bd121102dcdabe782714
+  data.tar.gz: 3eab456a164f8272f761906de05f3737d42fa9ba1053682c4a90f43026b9f331d00c4a8602fba0a2167eec2af0fc77ed43a51a557d26f74045ed8546fcab864f

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,20 @@
 AllCops:
   NewCops: enable
 
-Metrics/AbcSize:
-  Enabled: false
+Layout/LineLength:
+  Max: 120
 
-Metrics/CyclomaticComplexity:
+Metrics/ClassLength:
   Enabled: false
 
-Layout/LineLength:
-  Max: 120
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*_test.rb'
 
+Lint/EmptyBlock:
+  Exclude:
+    - 'test/**/*_test.rb'
 
+Naming/VariableNumber:
+  Exclude:
+    - 'test/**/*_test.rb'

data/Gemfile.lock

@@ -1,46 +1,48 @@
 PATH
   remote: .
   specs:
-    minitag (0.4.1)
+    minitag (0.6.2)
       minitest (~> 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    minitest (5.14.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    ast (2.4.2)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rubocop (0.87.1)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.4)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.8.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
+  universal-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (>= 2.2.10)
   minitag!
   rake (>= 12.3.3)
-  rubocop (~> 0.87.1)
+  rubocop (~> 1.18)
 
 RUBY VERSION
    ruby 2.6.3p62
 
 BUNDLED WITH
-   1.17.2
+   2.2.25

data/README.md

@@ -2,8 +2,10 @@
 
 # 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/context.rb

@@ -18,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.
     #
@@ -61,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/minitest_tag.rb

@@ -3,6 +3,24 @@
 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.
     #
@@ -17,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,28 +1,17 @@
 # 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_/]
-        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

data/lib/minitag/tag_registry.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 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.
@@ -18,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.
@@ -27,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.4.1'
+  VERSION = '0.6.2'
 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

data/minitag.gemspec

@@ -23,9 +23,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
   spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rubocop', '~> 0.87.1'
+  spec.add_development_dependency 'rubocop', '~> 1.18'
 
   spec.add_dependency 'minitest', '~> 5.0'
+
+  spec.required_ruby_version = '>= 2.6.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: minitag
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Bernardo de Araujo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="