fbe 0.48.3 → 0.48.4

data/lib/fbe/iterate.rb

@@ -42,10 +42,10 @@ def Fbe.iterate(
   fb: Fbe.fb, loog: $loog, options: $options, global: $global,
   epoch: $epoch || Time.now, kickoff: $kickoff || Time.now, &
 )
-  raise 'The fb is nil' if fb.nil?
-  raise 'The $global is not set' if global.nil?
-  raise 'The $options is not set' if options.nil?
-  raise 'The $loog is not set' if loog.nil?
+  raise(Fbe::Error, 'The fb is nil') if fb.nil?
+  raise(Fbe::Error, 'The $global is not set') if global.nil?
+  raise(Fbe::Error, 'The $options is not set') if options.nil?
+  raise(Fbe::Error, 'The $loog is not set') if loog.nil?
   c = Fbe::Iterate.new(fb:, loog:, options:, global:, epoch:, kickoff:)
   c.instance_eval(&)
 end
@@ -98,11 +98,11 @@ class Fbe::Iterate
     @label = nil
     @since = 0
     @query = nil
-    @sort_by = nil
+    @sorting = nil
     @repeats = 1
-    @quota_aware = true
-    @lifetime_aware = true
-    @timeout_aware = true
+    @quota = true
+    @lifetime = true
+    @timeout = true
   end
 
   # Makes the iterator aware of GitHub API quota limits.
@@ -116,21 +116,21 @@ class Fbe::Iterate
   #   iterator.quota_aware
   #   iterator.over { |repo, item| ... }  # Will stop if quota exhausted
   def quota_unaware
-    @quota_aware = false
+    @quota = false
   end
 
   # Makes the iterator aware of lifetime limits.
   #
   # @return [nil] Nothing is returned
   def lifetime_unaware
-    @lifetime_aware = false
+    @lifetime = false
   end
 
   # Makes the iterator aware of timeout limits.
   #
   # @return [nil] Nothing is returned
   def timeout_unaware
-    @timeout_aware = false
+    @timeout = false
   end
 
   # Sets the maximum number of iterations per repository.
@@ -144,8 +144,8 @@ class Fbe::Iterate
   # @example Process up to 100 items per repository
   #   iterator.repeats(100)
   def repeats(repeats)
-    raise 'Cannot set "repeats" to nil' if repeats.nil?
-    raise 'The "repeats" must be a positive integer' unless repeats.positive?
+    raise(Fbe::Error, 'Cannot set "repeats" to nil') if repeats.nil?
+    raise(Fbe::Error, 'The "repeats" must be a positive integer') unless repeats.positive?
     @repeats = repeats
   end
 
@@ -161,8 +161,8 @@ class Fbe::Iterate
   # @example Query for issues after a certain ID
   #   iterator.by('(and (eq what "issue") (gt id $before) (eq repo $repository))')
   def by(query)
-    raise 'Query is already set' unless @query.nil?
-    raise 'Cannot set query to nil' if query.nil?
+    raise(Fbe::Error, 'Query is already set') unless @query.nil?
+    raise(Fbe::Error, 'Cannot set query to nil') if query.nil?
     @query = query
   end
 
@@ -178,10 +178,10 @@ class Fbe::Iterate
   # @example Sort issues by number
   #   iterator.sort_by('issue')
   def sort_by(prop)
-    raise 'Sort field is already set' unless @sort_by.nil?
-    raise 'Cannot set sort field to nil' if prop.nil?
-    raise 'Sort field must be a String' unless prop.is_a?(String)
-    @sort_by = prop
+    raise(Fbe::Error, 'Sort field is already set') unless @sorting.nil?
+    raise(Fbe::Error, 'Cannot set sort field to nil') if prop.nil?
+    raise(Fbe::Error, 'Sort field must be a String') unless prop.is_a?(String)
+    @sorting = prop
   end
 
   # Sets the label for tracking iteration state.
@@ -196,9 +196,11 @@ class Fbe::Iterate
   # @example Set label for issue processing
   #   iterator.as('issue_processor')
   def as(label)
-    raise 'Label is already set' unless @label.nil?
-    raise 'Cannot set "label" to nil' if label.nil?
-    raise "Wrong label format '#{label}', use [_a-z][a-zA-Z0-9_]*" unless label.match?(/\A[_a-z][a-zA-Z0-9_]*\z/)
+    raise(Fbe::Error, 'Label is already set') unless @label.nil?
+    raise(Fbe::Error, 'Cannot set "label" to nil') if label.nil?
+    unless label.match?(/\A[_a-z][a-zA-Z0-9_]*\z/)
+      raise(Fbe::Error, "Wrong label format '#{label}', use [_a-z][a-zA-Z0-9_]*")
+    end
     @label = label
   end
 
@@ -238,18 +240,19 @@ class Fbe::Iterate
   #     fetch_and_process_issue(repo_id, issue_number)
   #     issue_number + 1  # Return next issue number to process
   #   end
-  def over
-    raise 'Use "as" first' if @label.nil?
-    raise 'Use "by" first' if @query.nil?
+  def over # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    raise(Fbe::Error, 'Use "as" first') if @label.nil?
+    raise(Fbe::Error, 'Use "by" first') if @query.nil?
     seen = {}
     oct = Fbe.octo(loog: @loog, options: @options, global: @global)
     return if Fbe.over?(
       global: @global, options: @options, loog: @loog, epoch: @epoch, kickoff: @kickoff,
-      quota_aware: @quota_aware, lifetime_aware: @lifetime_aware, timeout_aware: @timeout_aware
+      quota_aware: @quota, lifetime_aware: @lifetime, timeout_aware: @timeout
     )
-    repos = Fbe.unmask_repos(
-      loog: @loog, options: @options, global: @global, quota_aware: @quota_aware
-    ).map { |n| oct.repo_id_by_name(n) }
+    repos =
+      Fbe.unmask_repos(
+        loog: @loog, options: @options, global: @global, quota_aware: @quota
+      ).map { |n| oct.repo_id_by_name(n) }
     started = Time.now
     restarted = []
     before =
@@ -267,10 +270,10 @@ class Fbe::Iterate
       end
     starts = before.dup
     values = {}
-    loop do
+    loop do # rubocop:disable Metrics/BlockLength
       if Fbe.over?(
         global: @global, options: @options, loog: @loog, epoch: @epoch, kickoff: @kickoff,
-        quota_aware: @quota_aware, lifetime_aware: @lifetime_aware, timeout_aware: @timeout_aware
+        quota_aware: @quota, lifetime_aware: @lifetime, timeout_aware: @timeout
       )
         @loog.info("Time to stop after #{started.ago}")
         break
@@ -278,7 +281,7 @@ class Fbe::Iterate
       repos.each do |repo|
         if Fbe.over?(
           global: @global, options: @options, loog: @loog, epoch: @epoch, kickoff: @kickoff,
-          quota_aware: @quota_aware, lifetime_aware: @lifetime_aware, timeout_aware: @timeout_aware
+          quota_aware: @quota, lifetime_aware: @lifetime, timeout_aware: @timeout
         )
           @loog.info("Won't check repository ##{repo}")
           break
@@ -290,10 +293,10 @@ class Fbe::Iterate
           next
         end
         nxt =
-          if @sort_by
+          if @sorting
             values[repo] ||= @fb.query(@query).each(
               @fb, before: before[repo], repository: repo
-            ).map { _1[@sort_by]&.first }.compact.sort.each
+            ).filter_map { _1[@sorting]&.first }.sort.each
             begin
               values[repo].next
             rescue StopIteration
@@ -306,14 +309,14 @@ class Fbe::Iterate
           if nxt.nil?
             @loog.debug("Next element after ##{before[repo]} not suggested, re-starting from ##{@since}: #{@query}")
             restarted << repo
-            values.delete(repo) if @sort_by
+            values.delete(repo) if @sorting
             @since
           else
             @loog.debug("Next is ##{nxt}, starting from it")
             yield(repo, nxt)
           end
         unless before[repo].is_a?(Integer)
-          raise "Iterator must return an Integer, but #{before[repo].class} was returned"
+          raise(Fbe::Error, "Iterator must return an Integer, but #{before[repo].class} was returned")
         end
         seen[repo] += 1
       end

data/lib/fbe/just_one.rb

@@ -43,7 +43,7 @@ def Fbe.just_one(fb: Fbe.fb)
         @map[k.to_sym]
       end
     end
-  yield f
+  yield(f)
   q = attrs.except('_id', '_time', '_version').map do |k, v|
     vv = v.to_s
     if v.is_a?(String)
@@ -57,6 +57,6 @@ def Fbe.just_one(fb: Fbe.fb)
   before = fb.query(q).each.first
   return before unless before.nil?
   n = fb.insert
-  attrs.each { |k, v| n.send(:"#{k}=", v) }
+  attrs.each { |k, v| n.public_send(:"#{k}=", v) }
   n
 end

data/lib/fbe/kill_if.rb

@@ -14,7 +14,7 @@ def Fbe.kill_if(facts, fb: Fbe.fb, fid: '_id')
   ids = []
   facts.each do |f|
     if block_given?
-      t = yield f
+      t = yield(f)
       next unless t
     end
     ids << f[fid].first

data/lib/fbe/middleware/formatter.rb

@@ -53,7 +53,7 @@ class Fbe::Middleware::Formatter < Faraday::Logging::Formatter
   # @return [void]
   # @note Only logs when status >= 400
   # @note Special handling for 403 JSON responses to show compact error message
-  def response(http)
+  def response(http) # rubocop:disable Metrics/AbcSize
     return if http.status < 400
     if http.status == 403 && http.response_headers['content-type'].start_with?('application/json')
       warn(

data/lib/fbe/middleware/rate_limit.rb

@@ -29,9 +29,9 @@ class Fbe::Middleware::RateLimit < Faraday::Middleware
   # @param [Object] app The next middleware in the stack
   def initialize(app)
     super
-    @cached_response = nil
-    @remaining_count = nil
-    @request_counter = 0
+    @cached = nil
+    @remaining = nil
+    @counter = 0
   end
 
   # Processes the HTTP request and handles rate limit caching.
@@ -54,14 +54,14 @@ class Fbe::Middleware::RateLimit < Faraday::Middleware
   # @param [Faraday::Env] env The request environment
   # @return [Faraday::Response] Cached or fresh response
   def handle_rate_limit_request(env)
-    if @cached_response.nil? || @request_counter >= 100
+    if @cached.nil? || @counter >= 100
       response = @app.call(env)
-      @cached_response = response.dup
-      @remaining_count = extract_remaining_count(response)
-      @request_counter = 0
+      @cached = response.dup
+      @remaining = extract_remaining_count(response)
+      @counter = 0
       response
     else
-      response = @cached_response.dup
+      response = @cached.dup
       update_remaining_count(response)
       Faraday::Response.new(response_env(env, response))
     end
@@ -69,9 +69,9 @@ class Fbe::Middleware::RateLimit < Faraday::Middleware
 
   # Tracks non-rate_limit requests and decrements counter.
   def track_request
-    return if @remaining_count.nil?
-    @remaining_count -= 1 if @remaining_count.positive?
-    @request_counter += 1
+    return if @remaining.nil?
+    @remaining -= 1 if @remaining.positive?
+    @counter += 1
   end
 
   # Extracts the remaining count from the response body.
@@ -96,8 +96,8 @@ class Fbe::Middleware::RateLimit < Faraday::Middleware
   # @param [Faraday::Response] response The cached response to update
   def update_remaining_count(response)
     body = response.body
-    original_was_string = body.is_a?(String)
-    if original_was_string
+    stringed = body.is_a?(String)
+    if stringed
       begin
         body = JSON.parse(body)
       rescue JSON::ParserError
@@ -105,8 +105,8 @@ class Fbe::Middleware::RateLimit < Faraday::Middleware
       end
     end
     return unless body.is_a?(Hash) && body['rate']
-    body['rate']['remaining'] = @remaining_count
-    return unless original_was_string
+    body['rate']['remaining'] = @remaining
+    return unless stringed
     response.instance_variable_set(:@body, body.to_json)
   end
 
@@ -117,7 +117,7 @@ class Fbe::Middleware::RateLimit < Faraday::Middleware
   # @return [Hash] Response environment hash
   def response_env(env, response)
     headers = response.headers.dup
-    headers['x-ratelimit-remaining'] = @remaining_count.to_s if @remaining_count
+    headers['x-ratelimit-remaining'] = @remaining.to_s if @remaining
     {
       method: env.method,
       url: env.url,

data/lib/fbe/middleware/sqlite_store.rb

@@ -58,21 +58,21 @@ class Fbe::Middleware::SqliteStore
   # @raise [ArgumentError] If path is nil/empty, directory doesn't exist, version is nil/empty,
   # or ttl is not nil or not Integer or not positive
   def initialize(path, version, loog: Loog::NULL, maxsize: '10Mb', maxvsize: '10Kb', ttl: nil, cache_min_age: nil)
-    raise ArgumentError, 'Database path cannot be nil or empty' if path.nil? || path.empty?
+    raise(ArgumentError, 'Database path cannot be nil or empty') if path.nil? || path.empty?
     dir = File.dirname(path)
-    raise ArgumentError, "Directory #{dir} does not exist" unless File.directory?(dir)
-    raise ArgumentError, 'Version cannot be nil or empty' if version.nil? || version.empty?
+    raise(ArgumentError, "Directory #{dir} does not exist") unless File.directory?(dir)
+    raise(ArgumentError, 'Version cannot be nil or empty') if version.nil? || version.empty?
     @path = File.absolute_path(path)
     @version = version
     @loog = loog
-    @maxsize = Filesize.from(maxsize.to_s).to_i
-    @maxvsize = Filesize.from(maxvsize.to_s).to_i
-    raise ArgumentError, 'TTL can be nil or Integer > 0' if !ttl.nil? && !(ttl.is_a?(Integer) && ttl.positive?)
+    @maxsize = Integer(Filesize.from(maxsize.to_s))
+    @maxvsize = Integer(Filesize.from(maxvsize.to_s))
+    raise(ArgumentError, 'TTL can be nil or Integer > 0') if !ttl.nil? && !(ttl.is_a?(Integer) && ttl.positive?)
     @ttl = ttl
     if !cache_min_age.nil? && !(cache_min_age.is_a?(Integer) && cache_min_age.positive?)
-      raise ArgumentError, 'Cache min age can be nil or Integer > 0'
+      raise(ArgumentError, 'Cache min age can be nil or Integer > 0')
     end
-    @cache_min_age = cache_min_age
+    @minage = cache_min_age
   end
 
   # Read a value from the cache.
@@ -106,28 +106,29 @@ class Fbe::Middleware::SqliteStore
   # @return [nil]
   # @note Values larger than 10KB are not cached
   # @note Non-GET requests and URLs with query parameters are not cached
-  def write(key, value)
+  def write(key, value) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     return if value.is_a?(Array) && value.any? do |vv|
       req = JSON.parse(vv[0])
       req['method'] != 'get'
     end
-    if @cache_min_age && value.is_a?(Array) && value[0].is_a?(Array) && value[0].size > 1
+    if @minage && value.is_a?(Array) && value[0].is_a?(Array) && value[0].size > 1
       begin
         resp = JSON.parse(value[0][1])
       rescue TypeError, JSON::ParserError => e
         @loog.info("Failed to parse response to rewrite the cache age: #{e.message}")
         resp = nil
       end
-      cache_control = resp.dig('response_headers', 'cache-control') if resp.is_a?(Hash)
-      if cache_control && !cache_control.empty?
+      control = resp.dig('response_headers', 'cache-control') if resp.is_a?(Hash)
+      if control && !control.empty?
         %w[max-age s-maxage].each do |key|
-          age = cache_control.scan(/#{key}=(\d+)/i).first&.first&.to_i
+          matched = control.scan(/#{key}=(\d+)/i).first&.first
+          age = matched.nil? ? nil : Integer(matched, 10)
           if age
-            age = [age, @cache_min_age].max
-            cache_control = cache_control.sub(/#{key}=(\d+)/, "#{key}=#{age}")
+            age = [age, @minage].max
+            control = control.sub(/#{key}=(\d+)/, "#{key}=#{age}")
           end
         end
-        resp['response_headers']['cache-control'] = cache_control
+        resp['response_headers']['cache-control'] = control
         value[0][1] = JSON.dump(resp)
       end
     end
@@ -146,10 +147,10 @@ class Fbe::Middleware::SqliteStore
   # @return [void]
   def clear
     perform do |t|
-      t.execute 'DELETE FROM cache;'
-      t.execute "UPDATE meta SET value = ? WHERE key = 'version';", [@version]
+      t.execute('DELETE FROM cache;')
+      t.execute("UPDATE meta SET value = ? WHERE key = 'version';", [@version])
     end
-    @db.execute 'VACUUM;'
+    @db.execute('VACUUM;')
   end
 
   # Get all entries from the cache.
@@ -160,68 +161,68 @@ class Fbe::Middleware::SqliteStore
 
   private
 
-  def perform(&)
+  def perform(&) # rubocop:disable Metrics/AbcSize
     @db ||=
-      SQLite3::Database.new(@path).tap do |d|
+      SQLite3::Database.new(@path).tap do |d| # rubocop:disable Metrics/BlockLength
         d.transaction do |t|
-          t.execute 'CREATE TABLE IF NOT EXISTS cache(key TEXT UNIQUE NOT NULL, value TEXT);'
-          t.execute 'CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);'
-          t.execute 'CREATE TABLE IF NOT EXISTS meta(key TEXT UNIQUE NOT NULL, value TEXT);'
-          t.execute 'CREATE INDEX IF NOT EXISTS meta_key_idx ON meta(key);'
-          t.execute "INSERT INTO meta(key, value) VALUES('version', ?) ON CONFLICT(key) DO NOTHING;", [@version]
+          t.execute('CREATE TABLE IF NOT EXISTS cache(key TEXT UNIQUE NOT NULL, value TEXT);')
+          t.execute('CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);')
+          t.execute('CREATE TABLE IF NOT EXISTS meta(key TEXT UNIQUE NOT NULL, value TEXT);')
+          t.execute('CREATE INDEX IF NOT EXISTS meta_key_idx ON meta(key);')
+          t.execute("INSERT INTO meta(key, value) VALUES('version', ?) ON CONFLICT(key) DO NOTHING;", [@version])
         end
         if d.execute("SELECT 1 FROM pragma_table_info('cache') WHERE name = 'touched_at';").dig(0, 0) != 1
           d.transaction do |t|
-            t.execute 'ALTER TABLE cache ADD COLUMN touched_at TEXT;'
-            t.execute 'UPDATE cache set touched_at = ?;', [Time.now.utc.iso8601]
-            t.execute 'ALTER TABLE cache RENAME TO cache_old;'
-            t.execute <<~SQL
+            t.execute('ALTER TABLE cache ADD COLUMN touched_at TEXT;')
+            t.execute('UPDATE cache set touched_at = ?;', [Time.now.utc.iso8601])
+            t.execute('ALTER TABLE cache RENAME TO cache_old;')
+            t.execute(<<~SQL)
               CREATE TABLE IF NOT EXISTS cache(
                 key TEXT UNIQUE NOT NULL, value TEXT, touched_at TEXT NOT NULL
               );
             SQL
-            t.execute 'INSERT INTO cache SELECT * FROM cache_old;'
-            t.execute 'DROP TABLE cache_old;'
-            t.execute 'CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);'
-            t.execute 'CREATE INDEX IF NOT EXISTS cache_touched_at_idx ON cache(touched_at);'
+            t.execute('INSERT INTO cache SELECT * FROM cache_old;')
+            t.execute('DROP TABLE cache_old;')
+            t.execute('CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);')
+            t.execute('CREATE INDEX IF NOT EXISTS cache_touched_at_idx ON cache(touched_at);')
           end
-          d.execute 'VACUUM;'
+          d.execute('VACUUM;')
         end
         if d.execute("SELECT 1 FROM pragma_table_info('cache') WHERE name = 'created_at';").dig(0, 0) != 1
           d.transaction do |t|
-            t.execute 'ALTER TABLE cache ADD COLUMN created_at TEXT;'
-            t.execute 'UPDATE cache set created_at = ?;', [Time.now.utc.iso8601]
-            t.execute 'ALTER TABLE cache RENAME TO cache_old;'
-            t.execute <<~SQL
+            t.execute('ALTER TABLE cache ADD COLUMN created_at TEXT;')
+            t.execute('UPDATE cache set created_at = ?;', [Time.now.utc.iso8601])
+            t.execute('ALTER TABLE cache RENAME TO cache_old;')
+            t.execute(<<~SQL)
               CREATE TABLE IF NOT EXISTS cache(
                 key TEXT UNIQUE NOT NULL, value TEXT, touched_at TEXT NOT NULL, created_at TEXT NOT NULL
               );
             SQL
-            t.execute 'INSERT INTO cache SELECT * FROM cache_old;'
-            t.execute 'DROP TABLE cache_old;'
-            t.execute 'CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);'
-            t.execute 'CREATE INDEX IF NOT EXISTS cache_touched_at_idx ON cache(touched_at);'
-            t.execute 'CREATE INDEX IF NOT EXISTS cache_created_at_idx ON cache(created_at);'
+            t.execute('INSERT INTO cache SELECT * FROM cache_old;')
+            t.execute('DROP TABLE cache_old;')
+            t.execute('CREATE INDEX IF NOT EXISTS cache_key_idx ON cache(key);')
+            t.execute('CREATE INDEX IF NOT EXISTS cache_touched_at_idx ON cache(touched_at);')
+            t.execute('CREATE INDEX IF NOT EXISTS cache_created_at_idx ON cache(created_at);')
           end
-          d.execute 'VACUUM;'
+          d.execute('VACUUM;')
         end
         found = d.execute("SELECT value FROM meta WHERE key = 'version' LIMIT 1;").dig(0, 0)
         if found != @version
           @loog.info("Version mismatch in SQLite cache: stored '#{found}' != current '#{@version}', cleaning up")
           d.transaction do |t|
-            t.execute 'DELETE FROM cache;'
-            t.execute "UPDATE meta SET value = ? WHERE key = 'version';", [@version]
+            t.execute('DELETE FROM cache;')
+            t.execute("UPDATE meta SET value = ? WHERE key = 'version';", [@version])
           end
-          d.execute 'VACUUM;'
+          d.execute('VACUUM;')
         end
         unless @ttl.nil?
           d.transaction do |t|
-            t.execute <<~SQL, [(Time.now.utc - (@ttl * 60 * 60)).iso8601]
+            t.execute(<<~SQL, [(Time.now.utc - (@ttl * 60 * 60)).iso8601])
               DELETE FROM cache
               WHERE key IN (SELECT key FROM cache WHERE (created_at < ?));
             SQL
           end
-          d.execute 'VACUUM;'
+          d.execute('VACUUM;')
         end
         if File.size(@path) > @maxsize
           @loog.info(
@@ -234,14 +235,14 @@ class Fbe::Middleware::SqliteStore
             FROM pragma_page_count(), pragma_freelist_count(), pragma_page_size();
           SQL
             d.transaction do |t|
-              t.execute <<~SQL
+              t.execute(<<~SQL)
                 DELETE FROM cache
                 WHERE key IN (SELECT key FROM cache ORDER BY touched_at LIMIT 50)
               SQL
               deleted += t.changes
             end
           end
-          d.execute 'VACUUM;'
+          d.execute('VACUUM;')
           @loog.info(
             "Deleted #{deleted} old cache entries, " \
             "new file size: #{Filesize.from(File.size(@path).to_s).pretty} bytes"

data/lib/fbe/middleware/trace.rb

@@ -44,11 +44,7 @@ class Fbe::Middleware::Trace < Faraday::Middleware
   # @param [Faraday::Env] env The request environment
   # @return [Faraday::Response] The response from the next middleware
   def call(env)
-    entry = {
-      method: env.method,
-      url: env.url.to_s,
-      started_at: Time.now
-    }
+    entry = { method: env.method, url: env.url.to_s, started_at: Time.now }
     @app.call(env).on_complete do |response_env|
       next if !@ignores.empty? &&
               response_env[:http_cache_trace] &&