minitag 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76f72fc7c148e87021a776dea6655c3a676be7878e2fd595f436244d3bf7a998
-  data.tar.gz: aeea971c7ccab5fe5761e80c9d867b191b954e28693f7ceeedcd6f7d2154036a
+  metadata.gz: 683ead8b294111fdcd7f19206a0713fb85bc8ed632aa3a853fcbe72a75abf1d2
+  data.tar.gz: 3100c71052cd5fc151f0107d76e1abddcc6fe36d1ec649d3d2fc3c385cc5bfa5
 SHA512:
-  metadata.gz: e8d68e32988f3a13a2252b0578cf21efd6630befe8563a21869aa00c58abb63deb7d46d598fb9e6d6740b84b9be9e13214aafd8e1c2f05995ffdca766a380bc2
-  data.tar.gz: 527b5dcad48e756611bc662a587197ebd3bb257532b34b056c13f47deb2f6d9d4ec19b782c7812adc80cdd088f7e437f27d6066af6d4063ce3ed90fd5b6b00a6
+  metadata.gz: a46ab8f1155605202144a8d6c44a4250409cd0ae94670fe1f748b7c08aacac9c937b9ea97488c7131d00f559be2ea52fc99a5cbb4f430f243e7ddaed0cc01b2d
+  data.tar.gz: ffa35e8148558a1210e48d92fc3672bae8d46e6eba4f9da49fde5142661af5b90f82d99db56da4d6aa07841b89056ef7012b66da6bbb105ddae64a7a5ea888ae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minitag (0.1.0)
+    minitag (0.2.0)
       minitest (~> 5.0)
 
 GEM

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/minitag.svg)](https://badge.fury.io/rb/minitag)
+
 # Minitag
 
 [![Build Status](https://travis-ci.org/bernardoamc/minitag.svg?branch=master)](https://travis-ci.org/bernardoamc/minitag)

data/lib/minitag.rb

@@ -11,22 +11,27 @@ require 'minitag/tag_extension'
 # to Minitest::Test
 module Minitag
   class << self
+    # Tags specified by the `--tag` or `-t` option.
     def execution_tags
       @execution_tags ||= []
     end
 
+    # Add tag specified by the `--tag` or `-t` option.
     def add_execution_tag(tag)
       execution_tags << Tag.new(tag)
     end
 
+    # Tags from the last `tag` method waiting to be associated with a test.
     def pending_tags
       @pending_tags || []
     end
 
+    # Tags set from the `tag` method.
     def pending_tags=(tags)
       @pending_tags = Array(tags)
     end
 
+    # The mapping of tags and tests.
     def tag_mapping
       @tag_mapping ||= Minitag::TagMapper.new
     end

data/lib/minitag/tag.rb

@@ -9,6 +9,14 @@ module Minitag
   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
@@ -19,10 +27,16 @@ module Minitag
       @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

data/lib/minitag/tag_mapper.rb

@@ -3,16 +3,27 @@
 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
 
+    # 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

data/lib/minitag/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bernardo de Araujo