minitag 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 100ac9cc9bfef52b3aa37c8606e6a447c74459bd52df6fcda671950a6d3968e2
-  data.tar.gz: 0fe274909e46e1a0f8f812d0ec7891ae60d2a90beb92523fd7ff3720c040e7a0
+  metadata.gz: 3149cc0ce5b301309d45193c6e997b300adb38c6944b2e0c22a0e2634d5e576b
+  data.tar.gz: a15958d81aaa6f99f2d2656cb4ee3840e877bd2c0bf8f4ff877ad6514bb1bfca
 SHA512:
-  metadata.gz: 44754017cba905183452e103376d8228157ec6db852b4ff3764e89d0c66889a85e78a2867ba4f05ebbc18f7c46011583b4be5ade2239c8d75a9ccd276b083d24
-  data.tar.gz: 96de93bec156b177800d63d9ca7638dcd09eb20fcfd6e547f424f51b5bb1e2112a3b16f516990c096d1c47bce288b060d92b61238ff17a5652d4a1cb6e251fe6
+  metadata.gz: a4ee8c9f7de0386c4275b997c426bb12be7eff7fbd76b7966fde47e8452e35d529e496e6cfb3ccd02e0ab50a622c60ca3d8d2204ae8de940c26e4e9f57124603
+  data.tar.gz: 726bb9c4307f77aba61d23966b339d8a26f20e4b9238dba73546466e942abead18c8e7c7842eb37ab02fb3b9e85c7a2ff6203f830b623c4267790963f65f3a63

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: continuous-integration
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.7
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+      - name: Cache gems
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+      - name: Install gems
+        run: |
+          sed -i '/ruby ".*"/,+1 d' Gemfile
+          bundle_version=`awk '/BUNDLED WITH/{getline; gsub(/ /, "", $0); print}' Gemfile.lock`
+          gem install bundler --no-document -v ${bundle_version}
+          bundle config retry "3"
+          bundle config jobs "$(nproc)"
+          bundle config path vendor/bundle
+          bundle install
+      - name: Run RuboCop
+        run: bundle exec rubocop --parallel
+      - name: Run tests
+        run: bundle exec rake test

data/.rubocop.yml

@@ -1,13 +1,8 @@
 AllCops:
   NewCops: enable
 
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
 Layout/LineLength:
   Max: 120
 
-
+Metrics/ClassLength:
+  Enabled: false

data/Gemfile

@@ -4,5 +4,7 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+ruby '>= 2.6'
+
 # Specify your gem's dependencies in minitag.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitag (0.3.2)
+    minitag (0.6.0)
       minitest (~> 5.0)
 
 GEM
@@ -39,5 +39,8 @@ DEPENDENCIES
   rake (>= 12.3.3)
   rubocop (~> 0.87.1)
 
+RUBY VERSION
+   ruby 2.6.3p62
+
 BUNDLED WITH
    1.17.2

data/README.md

@@ -1,11 +1,19 @@
-[![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
 
-[![Build Status](https://travis-ci.org/bernardoamc/minitag.svg?branch=master)](https://travis-ci.org/bernardoamc/minitag)
+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.
 
-A simple gem that allow developers to tag their minitest tests and run tests
-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
 
@@ -25,20 +33,24 @@ $ 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'
-  test '#hello minitag' do
+  def test_hello_minitest
     # ...
   end
 end

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.
     #
@@ -34,7 +46,7 @@ module Minitag
     # @return [void]
     def add_filter(tag)
       if tag.start_with?('~')
-        @exclusive_filters << tag[1..-1]
+        @exclusive_filters << tag[1..]
       else
         @inclusive_filters << tag
       end
@@ -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.2'
+  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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitag
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Bernardo de Araujo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -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

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-before_install: gem install bundler -v 1.17.2