fbe 0.0.1

data/lib/fbe/iterate.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require_relative '../fbe'
+require_relative 'unmask_repos'
+require_relative 'octo'
+require_relative 'fb'
+
+# Create a conclude code block.
+def Fbe.iterate(fbx = Fbe.fb, loog = $loog, &)
+  c = Fbe::Iterate.new(fbx, loog)
+  c.instance_eval(&)
+end
+
+# Iterate.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
+class Fbe::Iterate
+  def initialize(fb, loog)
+    @fb = fb
+    @loog = loog
+    @label = nil
+    @since = 0
+    @query = nil
+    @limit = 100
+    @quota_aware = false
+  end
+
+  def quota_aware
+    @quota_aware = true
+  end
+
+  def limit(limit)
+    raise 'Cannot set "limit" to nil' if limit.nil?
+    @limit = limit
+  end
+
+  def by(query)
+    raise 'Query is already set' unless @query.nil?
+    raise 'Cannot set query to nil' if query.nil?
+    @query = query
+  end
+
+  def as(label)
+    raise 'Label is already set' unless @label.nil?
+    raise 'Cannot set "label" to nil' if label.nil?
+    @label = label
+  end
+
+  def over(&)
+    raise 'Use "as" first' if @label.nil?
+    raise 'Use "by" first' if @query.nil?
+    seen = {}
+    oct = Fbe.octo(loog: @loog)
+    repos = Fbe.unmask_repos(loog: @loog)
+    loop do
+      repos.each do |repo|
+        seen[repo] = 0 if seen[repo].nil?
+        next if seen[repo] > @limit
+        rid = oct.repo_id_by_name(repo)
+        before = Fbe.fb.query("(agg (and (eq what '#{@label}') (eq repository #{rid})) (first latest))").one
+        Fbe.fb.query("(and (eq what '#{@label}') (eq repository #{rid}))").delete!
+        before = before.nil? ? @since : before[0]
+        nxt = Fbe.fb.query(@query).one(before:, repository: rid)
+        after = nxt.nil? ? @since : yield(rid, nxt)
+        raise "Iterator must return an Integer, while #{after.class} returned" unless after.is_a?(Integer)
+        f = Fbe.fb.insert
+        f.repository = rid
+        f.latest = after.nil? ? nxt : after
+        f.what = @label
+        seen[repo] += 1
+        break if oct.off_quota
+      end
+      break if oct.off_quota
+      unless seen.values.any? { |v| v < @limit }
+        @loog.debug("Finished scanning #{repos.size} repos: #{seen.map { |k, v| "#{k}:#{v}" }.join(', ')}")
+        break
+      end
+    end
+  end
+end

data/lib/fbe/octo.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'loog'
+require 'decoor'
+require 'obk'
+require 'octokit'
+require 'verbose'
+require 'faraday/http_cache'
+require 'faraday/retry'
+require_relative '../fbe'
+
+def Fbe.octo(options: $options, global: $global, loog: Loog::NULL)
+  raise 'The $global is not set' if global.nil?
+  global[:octo] ||= begin
+    if options.testing.nil?
+      o = Octokit::Client.new
+      token = options.token
+      loog.debug("The 'token' option is not provided") if token.nil?
+      token = ENV.fetch('GITHUB_TOKEN', nil) if token.nil?
+      loog.debug("The 'GITHUB_TOKEN' environment variable is not set") if token.nil?
+      if token.nil?
+        loog.warn('Accessing GitHub API without a token!')
+      else
+        o = Octokit::Client.new(access_token: token)
+        loog.info("Accessing GitHub API with a token (#{token.length} chars)")
+      end
+      o.auto_paginate = true
+      o.connection_options = {
+        request: {
+          open_timeout: 15,
+          timeout: 15
+        }
+      }
+      stack = Faraday::RackBuilder.new do |builder|
+        builder.use(Faraday::Retry::Middleware)
+        builder.use(Faraday::HttpCache, serializer: Marshal, shared_cache: false)
+        builder.use(Octokit::Response::RaiseError)
+        builder.adapter(Faraday.default_adapter)
+      end
+      o.middleware = stack
+      o = Verbose.new(o, log: loog)
+    else
+      loog.debug('The connection to GitHub API is mocked')
+      o = Fbe::FakeOctokit.new
+    end
+    decoor(o, loog:) do
+      def off_quota
+        left = @origin.rate_limit.remaining
+        if left < 5
+          @loog.info("To much GitHub API quota consumed already (remaining=#{left}), stopping")
+          true
+        else
+          false
+        end
+      end
+
+      def user_name_by_id(id)
+        json = @origin.user(id)
+        name = json[:login]
+        @loog.debug("GitHub user ##{id} has a name: @#{name}")
+        name
+      end
+
+      def repo_id_by_name(name)
+        json = @origin.repository(name)
+        id = json[:id]
+        @loog.debug("GitHub repository #{name} has an ID: ##{id}")
+        id
+      end
+
+      def repo_name_by_id(id)
+        json = @origin.repository(id)
+        name = json[:full_name]
+        @loog.debug("GitHub repository ##{id} has a name: #{name}")
+        name
+      end
+    end
+  end
+end
+
+# Fake GitHub client, for tests.
+class Fbe::FakeOctokit
+  def random_time
+    Time.now - rand(10_000)
+  end
+
+  def name_to_number(name)
+    return name unless name.is_a?(String)
+    name.chars.map(&:ord).inject(0, :+)
+  end
+
+  def rate_limit
+    o = Object.new
+    def o.remaining
+      100
+    end
+    o
+  end
+
+  def repositories(_user = nil)
+    [
+      {
+        name: 'judges',
+        full_name: 'yegor256/judges',
+        id: 444
+      }
+    ]
+  end
+
+  def user(name)
+    {
+      id: 444,
+      login: 'yegor256',
+      type: name == 29_139_614 ? 'Bot' : 'User'
+    }
+  end
+
+  def repository(name)
+    {
+      id: name_to_number(name),
+      full_name: name.is_a?(Integer) ? 'yegor256/test' : name
+    }
+  end
+
+  def add_comment(_repo, _issue, _text)
+    42
+  end
+
+  def search_issues(_query, _options = {})
+    {
+      items: [
+        {
+          number: 42,
+          labels: [
+            {
+              name: 'bug'
+            }
+          ]
+        }
+      ]
+    }
+  end
+
+  def issue_timeline(_repo, _issue, _options = {})
+    [
+      {
+        actor: {
+          id: 888,
+          login: 'torvalds'
+        },
+        repository: {
+          id: name_to_number('yegor256/judges'),
+          full_name: 'yegor256/judges'
+        },
+        event: 'renamed',
+        rename: {
+          from: 'before',
+          to: 'after'
+        },
+        created_at: random_time
+      },
+      {
+        actor: {
+          id: 888,
+          login: 'torvalds'
+        },
+        repository: {
+          id: name_to_number('yegor256/judges'),
+          full_name: 'yegor256/judges'
+        },
+        event: 'labeled',
+        label: {
+          name: 'bug'
+        },
+        created_at: random_time
+      }
+    ]
+  end
+
+  def repository_events(repo, _options = {})
+    [
+      {
+        id: '123',
+        repo: {
+          id: name_to_number(repo),
+          name: repo
+        },
+        type: 'PushEvent',
+        payload: {
+          push_id: 42
+        },
+        actor: {
+          id: 888,
+          login: 'torvalds'
+        },
+        created_at: random_time
+      },
+      {
+        id: '124',
+        repo: {
+          id: name_to_number(repo),
+          name: repo
+        },
+        type: 'IssuesEvent',
+        payload: {
+          action: 'closed',
+          issue: {
+            number: 42
+          }
+        },
+        actor: {
+          id: 888,
+          login: 'torvalds'
+        },
+        created_at: random_time
+      },
+      {
+        id: '125',
+        repo: {
+          id: name_to_number(repo),
+          name: repo
+        },
+        type: 'IssuesEvent',
+        payload: {
+          action: 'opened',
+          issue: {
+            number: 42
+          }
+        },
+        actor: {
+          id: 888,
+          login: 'torvalds'
+        },
+        created_at: random_time
+      }
+    ]
+  end
+end

data/lib/fbe/unmask_repos.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require_relative 'octo'
+
+# Unmask.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
+module Fbe
+  def self.mask_to_regex(mask)
+    org, repo = mask.split('/')
+    raise "Org '#{org}' can't have an asterisk" if org.include?('*')
+    Regexp.compile("#{org}/#{repo.gsub('*', '.*')}")
+  end
+
+  def self.unmask_repos(options: $options, global: $global, loog: $loog)
+    repos = []
+    masks = (options.repositories || '').split(',')
+    masks.reject { |m| m.start_with?('-') }.each do |mask|
+      unless mask.include?('*')
+        repos << mask
+        next
+      end
+      re = Fbe.mask_to_regex(mask)
+      Fbe.octo(loog:, global:, options:).repositories(mask.split('/')[0]).each do |r|
+        repos << r[:full_name] if re.match?(r[:full_name])
+      end
+    end
+    masks.select { |m| m.start_with?('-') }.each do |mask|
+      re = Fbe.mask_to_regex(mask[1..])
+      repos.reject! { |r| re.match?(r) }
+    end
+    loog.debug("Scanning #{repos.size} repositories: #{repos.join(', ')}...")
+    repos
+  end
+end

data/lib/fbe.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# The module.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
+module Fbe
+  # Current version of the gem (changed by .rultor.yml on every release)
+  VERSION = '0.0.1'
+end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

data/rules/basic.fe

@@ -0,0 +1,158 @@
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+(undef explain)
+(defn explain '
+  r = @operands[0].evaluate(fact, maps);
+  if !r && !$loog.nil?
+    $loog.error(\'This rule failed: \' + self.to_s)
+  end
+  return r
+  ')
+
+(explain (when
+  (exists what)
+  (or
+    (eq what 'events-were-scanned')
+    (eq what 'labels-were-scanned')
+    (eq what 'bug-was-accepted')
+    (eq what 'bug-was-resolved')
+    (eq what 'comment-was-posted')
+    (eq what 'git-was-pushed')
+    (eq what 'events-were-scanned')
+    (eq what 'issue-was-closed')
+    (eq what 'issue-was-opened')
+    (eq what 'issue-was-assigned')
+    (eq what 'label-was-attached')
+    (eq what 'release-published')
+    (eq what 'reward-for-bug-reported')
+    (eq what 'reward-for-resolved-bug')
+    (eq what 'tag-was-created'))))
+
+(explain (when
+  (exists what)
+  (matches what "^[a-z]+(-[a-z]+)*$")))
+
+(explain (when
+  (exists details)
+  (and
+    (not (matches details "  "))
+    (not (matches details "^.{,120}$"))
+    (not (matches details "[^.]$")))))
+
+(explain (when
+  (exists _id)
+  (eq "Integer" (type _id))))
+(explain (when
+  (exists _time)
+  (eq "Time" (type _time))))
+(explain (when
+  (exists _version)
+  (eq "String" (type _version))))
+(explain (when
+  (exists issue)
+  (and
+    (eq "Integer" (type issue))
+    (gt issue 0))))
+(explain (when
+  (exists repository)
+  (eq "Integer" (type repository))))
+(explain (when
+  (exists who)
+  (eq "Integer" (type who))))
+(explain (when
+  (exists award)
+  (eq "Integer" (type award))))
+
+(explain (when
+  (exists when)
+  (eq "Time" (type when))))
+
+(explain (when
+  (exists issue)
+  (exists repository)))
+
+(explain (when
+  (exists award)
+  (and
+    (exists when)
+    (exists who)
+    (exists reason))))
+
+(explain (when
+  (eq what 'events-were-scanned')
+  (and
+    (exists repository)
+    (exists latest)
+    (eq "Integer" (type latest)))))
+
+(explain (when
+  (eq what 'label-was-attached')
+  (and
+    (exists issue)
+    (exists label)
+    (eq "String" (type label)))))
+
+(explain (when
+  (eq what 'issue-was-opened')
+  (and
+    (exists issue)
+    (exists when)
+    (exists who))))
+
+(explain (when
+  (eq what 'issue-was-closed')
+  (and
+    (exists issue)
+    (exists when)
+    (exists who))))
+
+(explain (when
+  (eq what 'bug-was-resolved')
+  (and
+    (exists cause)
+    (exists when)
+    (exists issue)
+    (exists details)
+    (exists who))))
+
+(explain (when
+  (eq what 'bug-was-accepted')
+  (and
+    (exists cause)
+    (exists when)
+    (exists issue)
+    (exists details)
+    (exists reporter)
+    (eq "Integer" (type reporter))
+    (exists who))))
+
+(explain (when
+  (eq what 'bug-report-was-rewarded')
+  (and
+    (exists cause)
+    (exists award)
+    (eq "Integer" (type award))
+    (exists when)
+    (exists issue)
+    (exists repository))))
+

data/test/fbe/test_conclude.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# MIT License
+#
+# Copyright (c) 2024 Zerocracy
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require 'loog'
+require 'factbase'
+require 'factbase/syntax'
+require 'judges/options'
+require_relative '../../lib/fbe/conclude'
+require_relative '../../lib/fbe/fb'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Zerocracy
+# License:: MIT
+class TestConclude < Minitest::Test
+  def test_draw
+    fb = Factbase.new
+    fb.insert.foo = 1
+    fb.insert.bar = 2
+    Fbe.conclude(fb, 'judge-one', Loog::NULL) do
+      on '(exists foo)'
+      draw do |n, prev|
+        n.sum = prev.foo + 1
+        'something funny'
+      end
+    end
+    f = fb.query('(exists sum)').each.to_a[0]
+    assert_equal(2, f.sum)
+    assert_equal('judge-one', f.what)
+    assert_equal('something funny', f.details)
+  end
+
+  def test_maybe
+    $fb = Factbase.new
+    $options = Judges::Options.new
+    $loog = Loog::NULL
+    Fbe.fb.insert.foo = 1
+    Fbe.conclude(Fbe.fb, 'issue-was-opened', Loog::NULL) do
+      on '(exists foo)'
+      maybe do |n, prev|
+        n.repository = 111
+        n.issue = prev.foo
+        n.who = 777
+        n.when = Time.now
+        "it's a test." * 20
+      end
+    end
+    f = Fbe.fb.query('(exists issue)').each.to_a[0]
+    assert_equal(1, f.issue)
+    assert(f._id.positive?)
+  end
+
+  def test_consider
+    $fb = Factbase.new
+    $options = Judges::Options.new
+    $loog = Loog::NULL
+    Fbe.fb.insert.foo = 1
+    Fbe.conclude(Fbe.fb, 'issue-was-closed', Loog::NULL) do
+      on '(exists foo)'
+      consider do |_prev|
+        Fbe.fb.insert.bar = 42
+      end
+    end
+    f = Fbe.fb.query('(exists bar)').each.to_a[0]
+    assert_equal(42, f.bar)
+  end
+end