minitag 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8004bb1833fb4829727720b31f79334793e459d8bcb956914bbd6cddb93c85a2
-  data.tar.gz: 40271847cdace3dcf99f483d59530b45496fc1a02fc5208e56c6a1f5817c03de
+  metadata.gz: 5cfcb59a8e761ef05e4520539a37892c772362685feab9ca2c9d98badbc155ee
+  data.tar.gz: e99d1e6784863d642564e69592d08d999218399951dbd346f484d63450358e19
 SHA512:
-  metadata.gz: 89b73ed8cdb55e205b3692ebd67c301785ae6e8fb7fcc856c32d0cc863024eb55bbaaa899a439cf1bdb2bef64627f1de7fbc171650dd95b6794ab64f3f6da121
-  data.tar.gz: 21be5c61d05d203558b664dbe92a08c01ac809b84580ddbf4ac6a648067e175cebb1c9b7912e91673f14f315f789ae11ee09bf653860b4ed67d53262fecd8db0
+  metadata.gz: 9e788f60ca4a42e8220ed07955b2c4f93a41791b4e9425b17f6785b3783e0cb88b002fc75d03baceb73984a65438df1ab041455243a11dfe480b1e6be8dce888
+  data.tar.gz: a8720ea668e10aa1c4d1fb58fb2c4fad8661c39e9fe33f8e35a69a57696c482ebf3c236074716764eef004225900e3fc11eb3d37e71dc93f904d98e380114f6f

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: continuous-integration
+on: push
+
+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/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.0)
+    minitag (0.4.1)
       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,9 +1,7 @@
-[![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 to tag their minitest tests and run tests
 based on these tags.
 
@@ -38,7 +36,7 @@ It is important to point out that tags associated with a test have no concept of
 ```rb
 class MyTest < Minitest::Test
   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
@@ -24,7 +23,7 @@ module Minitag
     end
 
     # Adds a filter tag.
-    # Tags with a ~ prefix are exclusive filters and 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 +33,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
@@ -42,13 +41,15 @@ module Minitag
 
     # Indicates when a context has no filters.
     #
-    # @return [boolean] whether a context has no filters.
+    # @return [Boolean] whether a context has no filters.
     def no_filters?
       @inclusive_filters.empty? && @exclusive_filters.empty?
     end
 
     # Detects whether the name associated with a namespace contains tags
-    # that matches the filtering criteria.
+    # that matches the filtering criteria. For more information check the methods:
+    #   - match_inclusive_filters?
+    #   - match_exclusive_filters?
     #
     # @param [String] namespace the namespace which a test name belongs.
     # @param [String] name the test name.
@@ -56,7 +57,7 @@ module Minitag
     # Invariants:
     #   - Returns true when no filters are present.
     #
-    # return [boolean] whether there was a match or not.
+    # @return [Boolean] whether there was a match or not.
     def match?(namespace:, name:)
       return true if no_filters?
 
@@ -75,7 +76,7 @@ module Minitag
     #   - Returns false when inclusive filters are specified but there
     #     are no tags.
     #
-    # return [boolean] whether there was a match or not.
+    # @return [Boolean] whether there was a match or not.
     def match_inclusive_filters?(tags)
       return true if @inclusive_filters.empty?
       return false if @inclusive_filters.any? && tags.empty?
@@ -92,7 +93,7 @@ module Minitag
     #   - Returns true when exclusive filters are specified and there
     #     are no tags.
     #
-    # return [boolean] whether there was a match or not.
+    # return [Boolean] whether there was a match or not.
     def match_exclusive_filters?(tags)
       return true if @exclusive_filters.empty?
       return true if @exclusive_filters.any? && tags.empty?

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,23 @@
+# frozen_string_literal: true
+
+module Minitag
+  # Module used to extend Minitest::Test with the tag method.
+  module MinitestTag
+    # 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
+  end
+end
+
+Minitest::Test.singleton_class.prepend(Minitag::MinitestTag)

data/lib/minitag/tag_extension.rb

@@ -1,25 +1,11 @@
 # frozen_string_literal: true
 
 module Minitag
-  # Module used to extend Minitest::Test.
+  # Module used to extend classes that rely on tags.
   # It has the following responsibilities:
-  #   - Introduce the tag functionality
   #   - Associate tags with tests
   #   - Filter tests based on the specified tags
   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 inclusive or exclusive tags. 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(
@@ -40,5 +26,3 @@ module Minitag
     end
   end
 end
-
-Minitest::Test.singleton_class.prepend(Minitag::TagExtension)

data/lib/minitag/tag_registry.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'set'
-
 module Minitag
-  # Stores tags associated with a namespace and name.
+  # Stores tags associated with a test name, which belongs to a namespace.
+  # The namespace is usually the class which the test belongs to.
   class TagRegistry
     def initialize
       @repository = Hash.new { |h, k| h[k] = Set.new }
@@ -11,9 +10,11 @@ module Minitag
 
     # Associates tags with a name taking into account its namespace.
     #
-    # @param [String] namespace the namespace which a test name belongs.
+    # Duplicated tags will be removed during this operation.
+    #
+    # @param [String] namespace the context which a test name belongs.
     # @param [String] name the test name.
-    # @param [Array] tags the collection of tags.
+    # @param [Array] tags the collection of tags associated with a test.
     #
     # @return [void]
     def add(namespace:, name:, tags:)
@@ -22,10 +23,10 @@ module Minitag
 
     # Fetches tags associated with a test name and namespace.
     #
-    # @param [String] namespace the namespace which a test name belongs.
+    # @param [String] namespace the context which a test name belongs.
     # @param [String] name the test name.
     #
-    # @return [Set] the tags associated with the specified namespace and name.
+    # @return [Set] the tags associated with the specified namespace and test name.
     def fetch(namespace:, name:)
       @repository[key(namespace, name)]
     end

data/lib/minitag/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitag
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Bernardo de Araujo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-07-15 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