minitag 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8004bb1833fb4829727720b31f79334793e459d8bcb956914bbd6cddb93c85a2
-  data.tar.gz: 40271847cdace3dcf99f483d59530b45496fc1a02fc5208e56c6a1f5817c03de
+  metadata.gz: '094566c4bff048ad837a295ae4d013c4257e618a1a31086421950bc2b6108320'
+  data.tar.gz: 026ec2b8c2297582e79e703b64376949acd4a82ff4b64547b1e3cf03244ca01d
 SHA512:
-  metadata.gz: 89b73ed8cdb55e205b3692ebd67c301785ae6e8fb7fcc856c32d0cc863024eb55bbaaa899a439cf1bdb2bef64627f1de7fbc171650dd95b6794ab64f3f6da121
-  data.tar.gz: 21be5c61d05d203558b664dbe92a08c01ac809b84580ddbf4ac6a648067e175cebb1c9b7912e91673f14f315f789ae11ee09bf653860b4ed67d53262fecd8db0
+  metadata.gz: ba85967b4f9529917d6d048d8da4d6e9cc766f32f8efae1265630453fdcd2e4f9605d2839a7904721d899700f2a6e8b570e5b838da93b849f38916b8b4066037
+  data.tar.gz: 1eb9624c88014f714dde789e628d78801f1f874d4ddbb87c8abbde62a53727b2189d84e8d06583c65df65e074138ccc0d0dab4e2fccf736cc82c4746ec3c743b

data/lib/minitag/context.rb

@@ -24,7 +24,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.
     #
@@ -42,13 +42,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 +58,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 +77,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 +94,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/tag_extension.rb

@@ -10,12 +10,12 @@ module Minitag
     # 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
+    # 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]
+    # @return [void]
     def tag(*tags)
       Minitag.pending_tags = tags.map { |tag| tag.to_s.strip.downcase }
     end

data/lib/minitag/tag_registry.rb

@@ -3,7 +3,8 @@
 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 +12,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 +25,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.3.1'
 end

metadata

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