onlylogs 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df2635aae242c5b3d3d1881c3dcb4c9297662200134c403b6f722036ef8f2357
-  data.tar.gz: f6faaccddcbd4042a0d6cb4cee8f087ce0ff7e9c75e66f0e403ee5c7de2edbc3
+  metadata.gz: 4856715cec18b6f3e8bca4cd01d3d3de18c4a6286eea249239d4a61423db5107
+  data.tar.gz: c73534414629768100cf3be121e9a06c8a0cc6841bce942dc02ed31655581432
 SHA512:
-  metadata.gz: e649a51a9841c162ad4c418eea5047462505054a040f5314fec37f171109fb39bf4198e12d107b04f52d77cc19d84ab873e5435ca28bb77c1b4aad17677d02b6
-  data.tar.gz: 4e6b8ab9a92d4317c04de55e4f560642e77baa8d8b73c7f583fdb181383eed1965c6e731cbb871ede1aa2ce291a0f3a4dd07759eada1e0d4fc1f5fb069ab479d
+  metadata.gz: d25035152f19a9711cfd0ce93a238162067d1a7a070971b06eebe023569645536a63358c89d0475fd0d4201f1327aac6fc1d9a44168166278dd886564e2a788b
+  data.tar.gz: 165b9455a35fc3f4e882995ca9201340e65c13ea6074214015b529b04c5add2a828d71e29a479ad127eef1f625f2619932aaf688aba803e57338b68fb3543532

data/README.md

@@ -630,6 +630,22 @@ bin/rails test test/models/onlylogs/grep_performance_test.rb
 > [!NOTE]
 > Performance tests are automatically skipped in CI environments or if the large fixture files are missing.
 
+### Release
+
+1. Bump the version in `lib/onlylogs/version.rb`, run `bundle install`, move the `Unreleased` entries of
+   `CHANGELOG.md` under the new version and commit to `main`.
+1. Tag the commit with the bare version and push the tag:
+
+   ```bash
+   git tag -a 1.2.3 -m 1.2.3
+   git push origin 1.2.3
+   ```
+
+1. Create a GitHub release for the tag with the changelog section as notes.
+
+Semaphore runs the tests on the tag and, when they pass, promotes the `release` pipeline, which pushes the gem to
+[rubygems.org](https://rubygems.org). It fails when the tag does not match the gem version.
+
 ### Plans for the future
 
 We believe that by simply analysing your logs you can also get error reports and performance reports. The goal is to

data/Rakefile

@@ -6,3 +6,5 @@ load "rails/tasks/engine.rake"
 load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
+
+Rake::Task["release"].clear

data/app/models/onlylogs/grep.rb

@@ -7,6 +7,10 @@ module Onlylogs
     # can keep a single rescue.
     class TimeoutError < ::Timeout::Error; end
 
+    # Raised for a pattern Ruby cannot compile, which only matters when +captures+
+    # asks Ruby to read its groups back.
+    class PatternError < ArgumentError; end
+
     # +timeout+ is in seconds and defaults to nil, which is no deadline at all:
     # the search runs until it finishes or the caller abandons it. The default
     # is deliberately not a number, because only the caller knows how long it
@@ -16,9 +20,17 @@ module Onlylogs
     # <tt>context: true</tt>. It needs ripgrep: plain grep is run without byte
     # offsets, so its context lines could not be told apart from matches, and
     # +context+ is ignored there. Context never reaches outside the byte window.
+    # +captures+ treats +pattern+ as a regular expression and yields, under
+    # <tt>captures:</tt>, what its groups matched on each match: one entry per group,
+    # or the whole match when it has none. The engine finds the line and Ruby reads
+    # the groups back from it, so a pattern the two read differently, or one that
+    # times out, yields nil there instead.
     def self.grep(pattern, file_path, start_position: 0, end_position: nil, regexp_mode: false,
-      case_sensitive: true, max_matches: Onlylogs.max_line_matches, context: 0, timeout: nil, &block)
+      case_sensitive: true, max_matches: Onlylogs.max_line_matches, context: 0, captures: false,
+      timeout: nil, &block)
       context = 0 unless Onlylogs.ripgrep_enabled?
+      regexp_mode ||= captures
+      capture_pattern = compile(pattern, case_sensitive: case_sensitive) if captures
       command_args = search_command(pattern, file_path, start_position: start_position,
         end_position: end_position, regexp_mode: regexp_mode, case_sensitive: case_sensitive,
         max_matches: max_matches, context: context)
@@ -51,6 +63,7 @@ module Onlylogs
 
           result = {byte_offset: byte_offset, content: content}
           result[:context] = true if context_line
+          result[:captures] = captures_in(capture_pattern, content) if capture_pattern && !context_line
           matches += 1 unless context_line
 
           if block_given?
@@ -73,6 +86,21 @@ module Onlylogs
 
     GROUP_SEPARATOR = "--"
 
+    def self.compile(pattern, case_sensitive:)
+      Regexp.new(pattern, case_sensitive ? nil : Regexp::IGNORECASE, timeout: MATCH_TIMEOUT)
+    rescue ::RegexpError => e
+      raise PatternError, "invalid regular expression: #{e.message}"
+    end
+
+    def self.captures_in(pattern, content)
+      found = pattern.match(content.gsub(ANSI_COLOR, ""))
+      return nil unless found
+
+      found.captures.empty? ? [found[0]] : found.captures
+    rescue ::Regexp::TimeoutError
+      nil
+    end
+
     # The scripts run under LC_ALL=C. ripgrep folds case over Unicode anyway,
     # grep then folds ASCII only: "error" finds "ERROR" with both engines, but
     # "über" finds "Über" with ripgrep only.
@@ -186,11 +214,12 @@ module Onlylogs
     end
 
     MATCH_TIMEOUT = 0.1 # seconds
+    ANSI_COLOR = /\e\[[0-9;]*m/
 
     # Folds case over Unicode, like ripgrep. See search_command for grep.
     def self.match_line?(line, string, regexp_mode: false, case_sensitive: true)
       # Strip ANSI color codes from the line before matching
-      stripped_line = line.gsub(/\e\[[0-9;]*m/, "")
+      stripped_line = line.gsub(ANSI_COLOR, "")
       # Normalize multiple spaces to single spaces
       normalized_line = stripped_line.gsub(/\s+/, " ")
 

data/lib/onlylogs/version.rb

@@ -1,3 +1,3 @@
 module Onlylogs
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlylogs
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Alessandro Rodi
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.8
 specification_version: 4
 summary: A Rails engine to view, stream, grep log files in real-time.
 test_files: []