fbe 0.14.1 → 0.16.0

data/lib/fbe/sec.rb

@@ -6,15 +6,22 @@
 require 'tago'
 require_relative '../fbe'
 
-# Converts number of seconds into text.
+# Converts number of seconds into human-readable time format.
 #
 # The number of seconds is taken from the +fact+ provided, usually stored
-# there in the +seconds+ property. The seconds are formatted to hours,
-# days, or weeks.
+# there in the +seconds+ property. The seconds are formatted into a
+# human-readable string like "3 days ago" or "5 hours ago" using the
+# tago gem.
 #
-# @param [Factbase::Fact] fact The fact, where to get the number of seconds
-# @param [String] prop The property in the fact, with the seconds
-# @return [String] Time interval as a text
+# @param [Factbase::Fact] fact The fact containing the seconds property
+# @param [String, Symbol] prop The property name with seconds (defaults to :seconds)
+# @return [String] Human-readable time interval (e.g., "2 weeks ago", "3 hours ago")
+# @raise [RuntimeError] If the specified property doesn't exist in the fact
+# @note Uses the tago gem's ago method for formatting
+# @example Format elapsed time from a fact
+#   build_fact = fb.query('(eq type "build")').first
+#   build_fact.duration = 7200  # 2 hours in seconds
+#   puts Fbe.sec(build_fact, :duration)  # => "2 hours ago"
 def Fbe.sec(fact, prop = :seconds)
   s = fact[prop.to_s]
   raise "There is no #{prop.inspect} property" if s.nil?

data/lib/fbe/unmask_repos.rb

@@ -6,31 +6,52 @@
 require_relative '../fbe'
 require_relative 'octo'
 
-# Converts mask to repository name.
+# Converts a repository mask pattern to a regular expression.
 #
-# This function takes something like +"zerocracy/*"+ as an input and returns
-# a regular expression that may match repositories defined by this mask, which
-# is +/zerocracy\/.*+ in this particular case.
+# @example Basic wildcard matching
+#   Fbe.mask_to_regex('zerocracy/*')
+#   # => /zerocracy\/.*/i
 #
-# @param [String] mask The mask
-# @return [Regex] Regular expression
+# @example Specific repository (no wildcard)
+#   Fbe.mask_to_regex('zerocracy/fbe')
+#   # => /zerocracy\/fbe/i
+#
+# @param [String] mask Repository mask in format 'org/repo' where repo can contain '*'
+# @return [Regexp] Case-insensitive regular expression for matching repositories
+# @raise [RuntimeError] If organization part contains asterisk
 def Fbe.mask_to_regex(mask)
   org, repo = mask.split('/')
   raise "Org '#{org}' can't have an asterisk" if org.include?('*')
   Regexp.compile("#{org}/#{repo.gsub('*', '.*')}", Regexp::IGNORECASE)
 end
 
-# Builds a list of repositories required by the +repositories+ option.
+# Resolves repository masks to actual GitHub repository names.
+#
+# Takes a comma-separated list of repository masks from options and expands
+# wildcards by querying GitHub API. Supports inclusion and exclusion patterns.
+# Archived repositories are automatically filtered out.
+#
+# @example Basic usage with wildcards
+#   # options.repositories = "zerocracy/fbe,zerocracy/ab*"
+#   repos = Fbe.unmask_repos
+#   # => ["zerocracy/fbe", "zerocracy/abc", "zerocracy/abcd"]
+#
+# @example Using exclusion patterns
+#   # options.repositories = "zerocracy/*,-zerocracy/private*"
+#   repos = Fbe.unmask_repos
+#   # Returns all zerocracy repos except those starting with 'private'
 #
-# The +repositories+ option defined in the +$options+ must contain something
-# like "zerocracy/fbe,zerocracy/ab*" (a comma-separated list of masks). This
-# function will go to the GitHub API and fetch all available repositories
-# matching these masks.
+# @example Empty result handling
+#   # options.repositories = "nonexistent/*"
+#   Fbe.unmask_repos  # Raises error: "No repos found matching: nonexistent/*"
 #
-# @param [Judges::Options] options The options coming from the +judges+ tool
-# @param [Hash] global The hash for global caching
-# @param [Loog] loog The logging facility
-# @return [Array<String>] List of repository full names
+# @param [Judges::Options] options Options containing 'repositories' field with masks
+# @param [Hash] global Global cache for storing API responses
+# @param [Loog] loog Logger for debug output
+# @return [Array<String>] Shuffled list of repository full names (e.g., 'org/repo')
+# @raise [RuntimeError] If no repositories match the provided masks
+# @note Exclusion patterns must start with '-' (e.g., '-org/pattern*')
+# @note Results are shuffled to distribute load when processing
 def Fbe.unmask_repos(options: $options, global: $global, loog: $loog)
   repos = []
   octo = Fbe.octo(loog:, global:, options:)

data/lib/fbe/who.rb

@@ -6,19 +6,26 @@
 require_relative '../fbe'
 require_relative 'octo'
 
-# Converts an ID of GitHub user into a nicely formatted string with their name.
+# Converts a GitHub user ID into a formatted username string.
 #
 # The ID of the user (integer) is expected to be stored in the +who+ property of the
-# provided +fact+. This function makes a live request to GitHub API in order
-# to find out what is the name of the user. For example, the ID +526301+
-# will be converted to the +"@yegor256"+ string.
+# provided +fact+. This function makes a live request to GitHub API to
+# retrieve the username. The result is cached globally to minimize API calls.
+# For example, the ID +526301+ will be converted to +"@yegor256"+.
 #
-# @param [Factbase::Fact] fact The fact, where to get the ID of GitHub user
-# @param [String] prop The property in the fact, with the ID
-# @param [Judges::Options] options The options coming from the +judges+ tool
-# @param [Hash] global The hash for global caching
-# @param [Loog] loog The logging facility
-# @return [String] Full name of the user
+# @param [Factbase::Fact] fact The fact containing the GitHub user ID
+# @param [String, Symbol] prop The property name with the ID (defaults to :who)
+# @param [Judges::Options] options The options from judges tool (uses $options global)
+# @param [Hash] global The hash for global caching (uses $global)
+# @param [Loog] loog The logging facility (uses $loog global)
+# @return [String] Formatted username with @ prefix (e.g., "@yegor256")
+# @raise [RuntimeError] If the specified property doesn't exist in the fact
+# @note Results are cached to reduce GitHub API calls
+# @note Subject to GitHub API rate limits
+# @example Convert user ID to username
+#   contributor = fb.query('(eq type "contributor")').first
+#   contributor.author_id = 526301
+#   puts Fbe.who(contributor, :author_id)  # => "@yegor256"
 def Fbe.who(fact, prop = :who, options: $options, global: $global, loog: $loog)
   id = fact[prop.to_s]
   raise "There is no #{prop.inspect} property" if id.nil?

data/lib/fbe.rb

@@ -10,5 +10,5 @@
 # License:: MIT
 module Fbe
   # Current version of the gem (changed by +.rultor.yml+ on every release)
-  VERSION = '0.14.1' unless const_defined?(:VERSION)
+  VERSION = '0.16.0' unless const_defined?(:VERSION)
 end

data/test/fbe/test_octo.rb

@@ -274,4 +274,23 @@ class TestOcto < Fbe::Test
     assert_raises(Octokit::NotFound) { o.repository(404_123) }
     assert_raises(Octokit::NotFound) { o.repository(404_124) }
   end
+
+  def test_fetches_fake_issue_events_has_assigned_event
+    o = Fbe.octo(loog: Loog::NULL, global: {}, options: Judges::Options.new({ 'testing' => true }))
+    result = o.issue_events('foo/foo', 123)
+    assert_instance_of(Array, result)
+    assert_equal(7, result.size)
+    event = result.find { _1[:event] == 'assigned' }
+    assert_equal(608, event[:id])
+    assert_pattern do
+      event => {
+        id: Integer,
+        actor: { login: 'user2', id: 422, type: 'User' },
+        event: 'assigned',
+        created_at: Time,
+        assignee: { login: 'user2', id: 422, type: 'User' },
+        assigner: { login: 'user', id: 411, type: 'User' }
+      }
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fbe
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -13,42 +13,42 @@ dependencies:
   name: backtrace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: baza.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: decoor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -71,124 +71,124 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: graphql-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: judges
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.5.1
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: loog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: obk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -197,54 +197,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: others
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tago
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: verbose
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 description: A collection of extensions for a factbase, helping the judges of Zerocracy