aix-errlog 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c569d77d9bdcd400b84076c146dee2857479389f5aa587dcd9d94425da40242d
-  data.tar.gz: 8a88141ae5ddd9d0728421215668c9dc373f3081683d406da1380fa3f3f4ed8a
+  metadata.gz: 2a5bf9f5032e8678c2743abee0bc82207e79fe58ab891a8e54fa86cfec4d73b5
+  data.tar.gz: 58d752d88e8ec4c746b220185d7d4693bdd7422d040f95a6a3b5ac7a3f496d57
 SHA512:
-  metadata.gz: f8dc5bf3b7ec2d0a76093e938f903daa30efa452d0123956bf9169b821f1fc4cc9b364391c6ba954a50597dda8d9a55e361cfa73091defbf3fd405be981c111b
-  data.tar.gz: 5836a08e5eba18292711936ad8273300acbf05c8a7e3616791fbcabfba35ea6ed9dce273b8375a5ae6abbd2975adc4131231565ec178a8a215950d460dfc825d
+  metadata.gz: bc7ff6b6b189b7aa3bee944d81371dd5cfb878d900fdbcb44386162c0d9ec60ba707816374ab9e140cadff5b8ec0bfdd9746f5f31e5acf6d80b3193279a96d3b
+  data.tar.gz: 967c2fa36918ad19addb60f2c6183c8d4d0a993c896eed7c7dd785fbe9dc206f36a3067b573288f5301d067adb2c582e397e59c03cf4da3fe10778f77d87e0ef

data/lib/aix/errlog/errlog.rb

@@ -46,7 +46,7 @@ module AIX
     #   require 'aix/errlog'
     #
     #   AIX::Errlog.open do |log|
-    #     log.forward_each(match: log.match {
+    #     log.forward_each(log.match {
     #       label.include?('KILL') & (
     #         (
     #           (sequence > 1000) &
@@ -142,15 +142,11 @@ module AIX
       # Enumerate log Entry objects in forward order (default is reverse).  If
       # no block is given, returns an enumerator.
       #
-      # sequence specifies the sequence ID to start with.  It will be included
-      # in the results if specifed
-      #
-      # match takes a Match object, which specifies which entries to match.
+      # The single option is a matcher.  It specifies a match if the passed in
+      # value is a Match, or a sequence ID otherwise.
       #
-      # match and sequence must not be both specified.  If neither are
-      # specified, this simply iterates from the beginning (or from the previous
-      # stopped position, if #find_sequence or #find_first have already been
-      # called).
+      # sequence specifies the sequence ID to start with.  It will be included
+      # in the results if specifed.  The match is a more complex matcher.
       #
       # An active enumerator can not be nested within another active enumerator,
       # including the block form of this.  If you invoke any of the #each_
@@ -161,30 +157,24 @@ module AIX
       # Warning: if the sequence does not exist (which is common when error logs
       # are cleaned), no entries will be returned, even if they follow the
       # sequence ID.  If you want all entries based on their sequence number,
-      # use match instead.  You're usually better off using the timestamp
+      # use a Match instead.  You're usually better off using the timestamp
       # instead of sequence number, because the sequence number is 32 bits and
       # might wrap.
-      def forward_each(match: nil, sequence: nil, &block)
-        raise 'match and sequence must not be both specified' if match && sequence
-
-        return to_enum(:forward_each, match: match, sequence: sequence) unless block_given?
+      def forward_each(matcher=nil, &block)
+        return to_enum(:forward_each, matcher) unless block_given?
         set_direction :forward
-        each(match: match, sequence: sequence, &block)
+        each(matcher, &block)
       end
 
       ##
       # Enumerate log Entry objects in reverse order (default is reverse).  If
       # no block is given, returns an enumerator.
       #
-      # sequence specifies the sequence ID to start with.  It will be included
-      # in the results if specifed
-      #
-      # match takes a Match object, which specifies which entries to match.
+      # The single option is a matcher.  It specifies a match if the passed in
+      # value is a Match, or a sequence ID otherwise.
       #
-      # match and sequence must not be both specified.  If neither are
-      # specified, this simply iterates from the beginning (or from the previous
-      # stopped position, if #find_sequence or #find_first have already been
-      # called).
+      # sequence specifies the sequence ID to start with.  It will be included
+      # in the results if specifed.  The match is a more complex matcher.
       #
       # An active enumerator can not be nested within another active enumerator,
       # including the block form of this.  If you invoke any of the #each_
@@ -195,15 +185,13 @@ module AIX
       # Warning: if the sequence does not exist (which is common when error logs
       # are cleaned), no entries will be returned, even if they follow the
       # sequence ID.  If you want all entries based on their sequence number,
-      # use match instead.  You're usually better off using the timestamp
+      # use a Match instead.  You're usually better off using the timestamp
       # instead of sequence number, because the sequence number is 32 bits and
       # might wrap.
-      def reverse_each(match: nil, sequence: nil, &block)
-        raise 'match and sequence must not be both specified' if match && sequence
-
-        return to_enum(:reverse_each, match: match, sequence: sequence) unless block_given?
+      def reverse_each(matcher=nil, &block)
+        return to_enum(:reverse_each, matcher) unless block_given?
         set_direction :reverse
-        each(match: match, sequence: sequence, &block)
+        each(matcher, &block)
       end
 
       ##
@@ -283,15 +271,11 @@ module AIX
       # Enumerate log entries in the order set in #set_direction (default is
       # reverse).
       #
-      # sequence specifies the sequence ID to start with.  It will be included
-      # in the results if specifed
-      #
-      # match takes a Match object, which specifies which entries to match.
+      # The single option is a matcher.  It specifies a match if the passed in
+      # value is a Match, or a sequence ID otherwise.
       #
-      # match and sequence must not be both specified.  If neither are
-      # specified, this simply iterates from the beginning (or from the previous
-      # stopped position, if #find_sequence or #find_first have already been
-      # called).
+      # sequence specifies the sequence ID to start with.  It will be included
+      # in the results if specifed.  The match is a more complex matcher.
       #
       # An active enumerator can not be nested within another active enumerator,
       # including the block form of this.  If you invoke any of the #each_
@@ -302,12 +286,12 @@ module AIX
       # Warning: if the sequence does not exist (which is common when error logs
       # are cleaned), no entries will be returned, even if they follow the
       # sequence ID.  If you want all entries based on their sequence number,
-      # use match instead.  You're usually better off using the timestamp
+      # use a Match instead.  You're usually better off using the timestamp
       # instead of sequence number, because the sequence number is 32 bits and
       # might wrap.
       #
       # The user-facing entry points to this are #forward_each and #reverse_each
-      def each(match: nil, sequence: nil)
+      def each(matcher=nil)
         # Does not return an enumerator, because this will always be called with
         # an active block
 
@@ -315,14 +299,13 @@ module AIX
           raise Errors::EnumeratorError if @enum_active
           @enum_active = true
 
-          if sequence
-            entry = find_sequence(sequence)
-            return if entry.nil?
-            yield entry
-          end
-
-          if match
-            entry = find_first(match)
+          if matcher
+            entry = 
+              if matcher.is_a? Match
+                find_first(matcher)
+              else
+                find_sequence(matcher)
+              end
             return if entry.nil?
             yield entry
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aix-errlog
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Taylor C. Richberger