minitag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76f72fc7c148e87021a776dea6655c3a676be7878e2fd595f436244d3bf7a998
+  data.tar.gz: aeea971c7ccab5fe5761e80c9d867b191b954e28693f7ceeedcd6f7d2154036a
+SHA512:
+  metadata.gz: e8d68e32988f3a13a2252b0578cf21efd6630befe8563a21869aa00c58abb63deb7d46d598fb9e6d6740b84b9be9e13214aafd8e1c2f05995ffdca766a380bc2
+  data.tar.gz: 527b5dcad48e756611bc662a587197ebd3bb257532b34b056c13f47deb2f6d9d4ec19b782c7812adc80cdd088f7e437f27d6066af6d4063ce3ed90fd5b6b00a6

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bernardo.amc@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in minitag.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    minitag (0.1.0)
+      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.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.87.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitag!
+  rake (>= 12.3.3)
+  rubocop (~> 0.87.1)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bernardo Chaves
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitag'
+```
+
+Or install it yourself as:
+
+```
+$ 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.
+
+
+```rb
+class MyTest < Minitest::Test
+  tag 'my_tag', 'another_tag'
+  test '#hello minitag' do
+    # ...
+  end
+end
+```
+
+### Running tests
+
+We can now run our test suite with specific tags:
+
+`$ bundle exec rake test --tag 'my_tag'`
+
+### Extra
+
+Tags can be:
+  1. `inclusive`
+  2. `exclusive` with the `~` prefix:
+
+### Examples
+```rb
+# Only run tests that are tagged with 'unit'
+$ bundle exec rake test --tag 'unit'
+
+# Only run tests that are NOT tagged with 'unit'
+$ bundle exec rake test --tag '~unit'
+
+# Only run tests that are tagged with 'unit' and are NOT 'parallel'
+$ bundle exec rake test --tag 'unit' --tag '~parallel'
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bernardoamc/minitag. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Minitag project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bernardoamc/minitag/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'minitag'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/minitag.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'minitest'
+require 'minitag/version'
+require 'minitag/tag'
+require 'minitag/tag_mapper'
+require 'minitag/tag_matcher'
+require 'minitag/tag_extension'
+
+# Namespace for classes or modules providing tagging functionality
+# to Minitest::Test
+module Minitag
+  class << self
+    def execution_tags
+      @execution_tags ||= []
+    end
+
+    def add_execution_tag(tag)
+      execution_tags << Tag.new(tag)
+    end
+
+    def pending_tags
+      @pending_tags || []
+    end
+
+    def pending_tags=(tags)
+      @pending_tags = Array(tags)
+    end
+
+    def tag_mapping
+      @tag_mapping ||= Minitag::TagMapper.new
+    end
+  end
+end

data/lib/minitag/tag.rb

@@ -0,0 +1,30 @@
+# 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
+
+    def initialize(name)
+      @name = name.to_s
+      @exclusive = false
+
+      return unless @name.start_with?('~')
+
+      @name = @name[1..-1]
+      @exclusive = true
+    end
+
+    def exclusive?
+      @exclusive
+    end
+
+    def inclusive?
+      !exclusive?
+    end
+  end
+end

data/lib/minitag/tag_extension.rb

@@ -0,0 +1,42 @@
+# 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
+  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.pending_tags = []
+      end
+    end
+
+    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)
+
+      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)
+      end
+    end
+  end
+end
+
+Minitest::Test.singleton_class.prepend(Minitag::TagExtension)

data/lib/minitag/tag_mapper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Minitag
+  # Stores the mapping between a test name and its existing tags.
+  class TagMapper
+    attr_reader :repository
+
+    def initialize
+      @repository = Hash.new { |h, k| h[k] = [] }
+    end
+
+    def add(context:, name:, tag:)
+      @repository[key(context, name)] << Minitag::Tag.new(tag)
+    end
+
+    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

@@ -0,0 +1,43 @@
+# 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

data/lib/minitag/version.rb

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

data/lib/minitest/minitag_plugin.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'minitag'
+
+# Plugin extension to allow developers to run their tests while specifying
+# the `--tag` or `-t` options.
+module Minitest
+  def self.plugin_minitag_options(opts, options)
+    opts.on '-t', '--tag TAG' do |tag|
+      options[:tags] ||= []
+      options[:tags] << tag
+    end
+  end
+
+  def self.plugin_minitag_init(options)
+    Array(options[:tags]).each do |tag|
+      Minitag.add_execution_tag(tag.to_s.strip)
+    end
+  end
+end

data/minitag.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minitag'
+  spec.version       = Minitag::VERSION
+  spec.authors       = ['Bernardo de Araujo']
+  spec.email         = ['bernardo.amc@gmail.com']
+
+  spec.summary       = 'Provides the ability to tag your minitest tests.'
+  spec.homepage      = 'https://github.com/bernardoamc/minitag'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  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 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rubocop', '~> 0.87.1'
+
+  spec.add_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: minitag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bernardo de Araujo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-11 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.87.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.87.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- bernardo.amc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitag.rb
+- lib/minitag/tag.rb
+- lib/minitag/tag_extension.rb
+- lib/minitag/tag_mapper.rb
+- lib/minitag/tag_matcher.rb
+- lib/minitag/version.rb
+- lib/minitest/minitag_plugin.rb
+- minitag.gemspec
+homepage: https://github.com/bernardoamc/minitag
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides the ability to tag your minitest tests.
+test_files: []