minitag 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 683ead8b294111fdcd7f19206a0713fb85bc8ed632aa3a853fcbe72a75abf1d2
-  data.tar.gz: 3100c71052cd5fc151f0107d76e1abddcc6fe36d1ec649d3d2fc3c385cc5bfa5
+  metadata.gz: 9aa792615d3b3d3022a0b1372c951f0f7394a184bd296f9ca760fb69d2be7b2d
+  data.tar.gz: ca7add04befa59ab7141cfccc41475def049d1e3e7596bfcbaeecef55e909144
 SHA512:
-  metadata.gz: a46ab8f1155605202144a8d6c44a4250409cd0ae94670fe1f748b7c08aacac9c937b9ea97488c7131d00f559be2ea52fc99a5cbb4f430f243e7ddaed0cc01b2d
-  data.tar.gz: ffa35e8148558a1210e48d92fc3672bae8d46e6eba4f9da49fde5142661af5b90f82d99db56da4d6aa07841b89056ef7012b66da6bbb105ddae64a7a5ea888ae
+  metadata.gz: 62a382576471b5223651ab76083afda212b43820dad6e23cc59d095d153e85048d81d09f38f3ca4d2f57dd758316f49ccedc48afd8ad99f84aa2554886d3ec24
+  data.tar.gz: 2fee9e38e0cfde38bdb4a71c806cee5c2395c5794aa4f3e46cfc863a8b634ee299163046693d671fc759e733b97d2fdd6b30d31ab370d77c36b549842c1a1e60

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.2.0)
+    minitag (0.4.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,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.
 
@@ -33,25 +31,30 @@ Require `minitag` in our `test_helper.rb`:
 
 We can tag specific 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).
 
 ```rb
 class MyTest < Minitest::Test
   tag 'my_tag', 'another_tag'
-  test '#hello minitag' do
+  def test_hello_minitest
     # ...
   end
 end
 ```
 
-### Running tests
+### Running tests with tag filters
 
 We can now run our test suite with specific tags:
 
-`$ bundle exec rake test --tag 'my_tag'`
+`$ bundle exec rake test --tag 'unit'`
+
+or even multiple tags:
+
+`$ bundle exec rake test --tag 'unit' --tag 'services' --tag '~model'`
 
-### Extra
+### More on tag filters
 
-Tags can be:
+Tag filters can be:
   1. `inclusive`
   2. `exclusive` with the `~` prefix:
 

data/lib/minitag.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
+require 'set'
 require 'minitest'
 require 'minitag/version'
-require 'minitag/tag'
-require 'minitag/tag_mapper'
-require 'minitag/tag_matcher'
+require 'minitag/context'
+require 'minitag/minitest_tag'
 require 'minitag/tag_extension'
 
 # Namespace for classes or modules providing tagging functionality
 # to Minitest::Test
 module Minitag
   class << self
-    # Tags specified by the `--tag` or `-t` option.
-    def execution_tags
-      @execution_tags ||= []
+    # Execution context of the test suite.
+    def context
+      @context ||= Context.new
     end
 
-    # Add tag specified by the `--tag` or `-t` option.
-    def add_execution_tag(tag)
-      execution_tags << Tag.new(tag)
+    # Add filtering tag to context specified by the `--tag` or `-t` option.
+    def add_filter(tag)
+      context.add_filter(tag)
     end
 
-    # Tags from the last `tag` method waiting to be associated with a test.
+    # Tags from the last `tag` method awaiting to be associated with a test.
     def pending_tags
       @pending_tags || []
     end
@@ -30,10 +30,5 @@ module Minitag
     def pending_tags=(tags)
       @pending_tags = Array(tags)
     end
-
-    # The mapping of tags and tests.
-    def tag_mapping
-      @tag_mapping ||= Minitag::TagMapper.new
-    end
   end
 end

data/lib/minitag/context.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative './tag_registry'
+
+module Minitag
+  # Represents the execution context of the test suite.
+  class Context
+    def initialize
+      @inclusive_filters = Set.new
+      @exclusive_filters = Set.new
+      @tag_registry = Minitag::TagRegistry.new
+    end
+
+    # Associates tags with a name taking into account its namespace.
+    #
+    # @param [String] namespace the namespace which a name belongs.
+    # @param [String] name the test name.
+    # @param [Array] tags the collection of tags.
+    #
+    # @return [void]
+    def add_tags(namespace:, name:, tags:)
+      @tag_registry.add(namespace: namespace, name: name, tags: tags)
+    end
+
+    # Adds a filter tag.
+    # Tags with a ~ prefix are treated as exclusive filters or inclusive filters otherwise.
+    #
+    # param [String] name the name of the filter tag.
+    #
+    # Invariants:
+    #   - A filter will always be a String without the ~ prefix.
+    #
+    # @return [void]
+    def add_filter(tag)
+      if tag.start_with?('~')
+        @exclusive_filters << tag[1..]
+      else
+        @inclusive_filters << tag
+      end
+    end
+
+    # Indicates when 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. 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.
+    #
+    # Invariants:
+    #   - Returns true when no filters are present.
+    #
+    # @return [Boolean] whether there was a match or not.
+    def match?(namespace:, name:)
+      return true if no_filters?
+
+      tags = @tag_registry.fetch(namespace: namespace, name: name)
+      match_inclusive_filters?(tags) && match_exclusive_filters?(tags)
+    end
+
+    private
+
+    # Detects whether any of the tags matches the inclusive filters.
+    #
+    # @param [Set] tags the set of tags.
+    #
+    # Invariants:
+    #   - Returns true when no inclusive filters are specified.
+    #   - Returns false when inclusive filters are specified but there
+    #     are no tags.
+    #
+    # @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?
+
+      (@inclusive_filters & tags).any?
+    end
+
+    # Detects whether any of the tags matches the exclusive filters.
+    #
+    # @param [Set] tags the set of tags.
+    #
+    # Invariants:
+    #   - Returns true when no exclusive filters are specified.
+    #   - Returns true when exclusive filters are specified and there
+    #     are no tags.
+    #
+    # 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?
+
+      (@exclusive_filters & tags).none?
+    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 }
+      singleton_class.prepend(Minitag::TagExtension)
+    end
+  end
+end
+
+Minitest::Test.singleton_class.prepend(Minitag::MinitestTag)

data/lib/minitag/tag_extension.rb

@@ -1,21 +1,16 @@
 # 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
-    def tag(*tags)
-      Minitag.pending_tags = tags
-    end
-
     define_method(:method_added) do |name|
       if name[/\Atest_/]
-        Minitag.pending_tags.each do |pending_tag|
-          Minitag.tag_mapping.add(context: self, name: name, tag: pending_tag)
-        end
+        Minitag.context.add_tags(
+          namespace: self, name: name, tags: Minitag.pending_tags
+        )
 
         Minitag.pending_tags = []
       end
@@ -23,20 +18,11 @@ module Minitag
 
     def runnable_methods
       methods = super.dup
-      return methods if Minitag.execution_tags.empty? || methods.empty?
-
-      execution_tags = Minitag.execution_tags
-      inclusive_tags = execution_tags.select(&:inclusive?).map(&:name)
-      exclusive_tags = execution_tags.select(&:exclusive?).map(&:name)
+      return methods if Minitag.context.no_filters?
 
       methods.select do |runnable_method|
-        runnable_method_tags = Minitag.tag_mapping.fetch(context: self, name: runnable_method).map(&:name)
-
-        Minitag::TagMatcher.inclusive_match?(inclusive_tags, runnable_method_tags) &&
-          Minitag::TagMatcher.exclusive_match?(exclusive_tags, runnable_method_tags)
+        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

@@ -0,0 +1,40 @@
+# 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.
+  class TagRegistry
+    def initialize
+      @repository = Hash.new { |h, k| h[k] = Set.new }
+    end
+
+    # Associates tags with a name taking into account its namespace.
+    #
+    # 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 associated with a test.
+    #
+    # @return [void]
+    def add(namespace:, name:, tags:)
+      @repository[key(namespace, name)] = Set.new(tags)
+    end
+
+    # Fetches tags associated with a test name and namespace.
+    #
+    # @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 test name.
+    def fetch(namespace:, name:)
+      @repository[key(namespace, name)]
+    end
+
+    private
+
+    def key(namespace, name)
+      "#{namespace}_#{name}"
+    end
+  end
+end

data/lib/minitag/version.rb

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

data/lib/minitest/minitag_plugin.rb

@@ -8,13 +8,13 @@ module Minitest
   def self.plugin_minitag_options(opts, options)
     opts.on '-t', '--tag TAG' do |tag|
       options[:tags] ||= []
-      options[:tags] << tag
+      options[:tags] << tag.to_s.strip.downcase
     end
   end
 
   def self.plugin_minitag_init(options)
     Array(options[:tags]).each do |tag|
-      Minitag.add_execution_tag(tag.to_s.strip)
+      Minitag.context.add_filter(tag)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitag
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Bernardo de Araujo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-11 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
@@ -85,10 +85,10 @@ files:
 - bin/console
 - bin/setup
 - lib/minitag.rb
-- lib/minitag/tag.rb
+- lib/minitag/context.rb
+- lib/minitag/minitest_tag.rb
 - lib/minitag/tag_extension.rb
-- lib/minitag/tag_mapper.rb
-- lib/minitag/tag_matcher.rb
+- lib/minitag/tag_registry.rb
 - lib/minitag/version.rb
 - lib/minitest/minitag_plugin.rb
 - minitag.gemspec

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

data/lib/minitag/tag.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Minitag
-  # Represents a tag in our system.
-  # Provides helper methods to identify the type of a tag, which can
-  # only one of the following:
-  #   - inclusive
-  #   - exclusive (name with ~ as a prefix)
-  class Tag
-    attr_reader :name
-
-    # Initializes a tag. Tags with a ~ prefix are deemed exclusive and
-    # inclusive otherwise.
-    #
-    # param [String] name the name of the tag
-    #
-    # Invariants:
-    #   - A tag name will always be a String without the ~ prefix
-    #     after initialization.
-    def initialize(name)
-      @name = name.to_s
-      @exclusive = false
-
-      return unless @name.start_with?('~')
-
-      @name = @name[1..-1]
-      @exclusive = true
-    end
-
-    # Whether this tag needs to be excluded or not.
-    #
-    # return [boolean]
-    def exclusive?
-      @exclusive
-    end
-
-    # Whether this tag needs to be included or not.
-    #
-    # return [boolean]
-    def inclusive?
-      !exclusive?
-    end
-  end
-end

data/lib/minitag/tag_mapper.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Minitag
-  # Stores the mapping between a test name and its existing tags.
-  class TagMapper
-    def initialize
-      @repository = Hash.new { |h, k| h[k] = [] }
-    end
-
-    # Associates a tag with a test name takinto into account is context.
-    #
-    # @param [String] context the context which a test name belongs.
-    # @param [String] name the test name.
-    # @param [String] tag the tag name.
-    #
-    # @return [void]
-    def add(context:, name:, tag:)
-      @repository[key(context, name)] << Minitag::Tag.new(tag)
-    end
-
-    # Fetches tags associated with a test name and context.
-    #
-    # @param [String] context the context which a test name belongs.
-    # @param [String] name the test name.
-    #
-    # @return [Array] the tags associated with the test.
-    def fetch(context:, name:)
-      @repository[key(context, name)]
-    end
-
-    private
-
-    def key(context, name)
-      "#{context}_#{name}"
-    end
-  end
-end

data/lib/minitag/tag_matcher.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Minitag
-  # Introduce different match? methods based on the type of the chosen tags.
-  class TagMatcher
-    # Detects if any of the desired tags match any of the existing ones.
-    #
-    # @param [Array] desired_tags the tags specified by `--tag`.
-    # @param [Array] existing_tags the tags specified by the `tag` method.
-    #
-    # Invariants:
-    #   - Always returns true when no desired tags are specified.
-    #   - Always returns false when desired tags are specified but there are
-    #     no existing tags.
-    #
-    # return [boolean] whether there was a match or not.
-    def self.inclusive_match?(desired_tags, existing_tags)
-      return true if desired_tags.empty?
-      return false if desired_tags.any? && existing_tags.empty?
-
-      (desired_tags & existing_tags).any?
-    end
-
-    # Detects if there are no matches between any of the desired tags
-    # and existing ones.
-    #
-    # @param desired_tags  [Array] tags specified by `--tag`.
-    # @param existing_tags [Array] tags specified by the `tag` method.
-    #
-    # Invariants:
-    #   - Always returns true when no desired tags are specified.
-    #   - Always returns true when desired tags are specified but there are
-    #     no existing tags.
-    #
-    # return [boolean] whether there was no match or not.
-    def self.exclusive_match?(desired_tags, existing_tags)
-      return true if desired_tags.empty?
-      return true if desired_tags.any? && existing_tags.empty?
-
-      (desired_tags & existing_tags).none?
-    end
-  end
-end