convenient_service 0.17.0 → 0.18.0

data/.dev/.tmuxinator.yml

@@ -1,22 +0,0 @@
-##
-# NOTE: Tmuxinator config options.
-# - https://github.com/tmuxinator/tmuxinator#create-a-project
-#
-name: convenient_service
-root: .
-
-on_project_start:
-  - task editor:open
-  - task docker:start
-  - task github:open
-
-windows:
-  - main:
-      layout: even-vertical
-      root: .
-      panes:
-        - task docker:bash:ruby_2.7
-        - task docker:bash:ruby_3.0
-        - task docker:bash:jruby_9.4
-        - task docker:bash:truffleruby_22.3
-        - git status

data/.dockerignore

@@ -1 +0,0 @@
-Gemfile.lock

data/.gem_release.yml

@@ -1,11 +0,0 @@
-quiet: false
-
-##
-# NOTE: `release` options.
-# https://github.com/svenfuchs/gem-release#gem-release
-#
-release:
-  color: true
-  host: https://rubygems.org
-  recurse: false
-  key: convenient_service

data/.github/contributing.md

@@ -1,15 +0,0 @@
-# Contributing
-
-## Legal
-
-By submitting a Pull Request, you disavow any rights or claims to any changes
-submitted to the Convenient Service project and assign the copyright of
-those changes to Convenient Service Organization.
-
-If you cannot or do not want to reassign those rights (your employment
-contract for your employer may not allow this), you should not submit a PR.
-Open an issue and someone else can do the work.
-
-This is a legal way of saying "If you submit a PR to us, that code becomes ours".
-99.9% of the time that's what you intend anyways; we hope it doesn't scare you
-away from contributing.

data/.github/issue_template.md

@@ -1,35 +0,0 @@
-## What is the issue?
-<!--- Briefly describe the problem -->
-
--
-
-## When it happens? How to reproduce it?
-<!--- Tell us how to reproduce the problem. You can write a step-by-step guide, for example -->
-
--
-
-## Where it happens?
-<!--- Point to the file/loc which causes inconsistent behaviour -->
-
--
-
-## How big is the damage from it?
-
--
-
-## Why it happens?
-
--
-
-## What can be done to resolve it?
-
--
-
-## What is the complexity of a possible fix?
-
--
-
-## Notes
-<!--- Additional info, links, screenshots, actually anything that helps to recreate the way of thoughts (optional). -->
-
--

data/.github/pull_request_template.md

@@ -1,31 +0,0 @@
-## What was done as a part of this PR?
-<!--- Describe your changes -->
-
--
-
-## Why it was done?
-<!--- Why is this change required? Does it improve something? What problem does it solve? -->
-<!--- If it fixes an open issue, please link to the issue here. -->
-
--
-
-## How it was done?
-<!--- Useful when a solution is not obvious (seems too extraordinary or too heavy) for a team you work with (optional). -->
-
--
-
-## How to test?
-
-- `task rspec -- corresponding_spec.rb`
-- [Development: Local Development#tests](https://github.com/marian13/convenient_service/wiki/Development:-Local-Development#tests).
-
-## Notes
-<!--- Additional info, links, screenshots, actually anything that helps to recreate the way of thoughts (optional). -->
-
--
-
-## Checklist:
-
-- [ ] I have performed a self-review of my code.
-- [ ] I have added/adjusted tests that prove my fix is effective or that my feature works.
-- [ ] CI is green.

data/.github/workflows/cd.yml

@@ -1,68 +0,0 @@
-##
-# CD using GitHub Actions.
-#
-# NOTE: GitHub Actions DSL.
-# - https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#understanding-the-workflow-file
-# - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
-#
-# NOTE: Ruby workflow example.
-# - https://github.com/ruby/setup-ruby#usage
-#
-# NOTE: How to set the working directory for the run directive (working-directory)?
-# - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrunhttps://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
-#
-# NOTE: How to deploy to GitHub Pages using GitHub Actions?
-# - https://github.com/marketplace/actions/github-pages-action
-#
-name: CD
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  deploy_api_docs:
-    runs-on: ubuntu-20.04
-    name: Deploy API Docs
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.2
-          ##
-          # NOTE: Installs the latest compatible Bundler version, runs `bundle install` and caches installed gems.
-          # - https://github.com/ruby/setup-ruby#usage
-          # - https://github.com/ruby/setup-ruby#bundler
-          #
-          bundler-cache: true
-      ##
-      # NOTE: Installs Task (task runner).
-      # - https://taskfile.dev/installation/#github-actions
-      # - https://github.com/go-task/task
-      #
-      - name: Install Task (task runner)
-        uses: arduino/setup-task@v1
-      - name: Generate docs
-        working-directory: ./
-        run: task docs:generate
-      - name: Deploy docs to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs/api
-          cname: apidocs.convenientservice.org
-
-  create_github_release:
-    runs-on: ubuntu-20.04
-    name: Create GitHub Release PR
-    steps:
-      - uses: google-github-actions/release-please-action@v3
-        with:
-          changelog-path: CHANGELOG.md
-          default-branch: main
-          include-v-in-tag: true
-          package-name: convenient_service
-          release-type: ruby
-          version-file: lib/convenient_service/version.rb

data/.github/workflows/ci.yml

@@ -1,212 +0,0 @@
-##
-# CI using GitHub Actions.
-#
-# NOTE: GitHub Actions DSL.
-# - https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions#understanding-the-workflow-file
-# - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
-#
-# NOTE: Ruby workflow example.
-# - https://github.com/ruby/setup-ruby#usage
-#
-# NOTE: Building and testing Ruby.
-# - https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-ruby
-#
-# NOTE: More examples.
-# - https://gist.github.com/geonizeli/57376c15f23feecdabf5ea213c3d7f41
-# - https://docs.knapsackpro.com/2019/how-to-run-rspec-on-github-actions-for-ruby-on-rails-app-using-parallel-jobs
-#
-# NOTE: Sharing data between jobs and post-workflow artifacts.
-# - https://docs.github.com/en/actions/learn-github-actions/essential-features-of-github-actions#sharing-data-between-jobs
-# - https://github.com/actions/upload-artifact
-# - https://github.com/actions/download-artifact
-#
-# NOTE: Virtual Environments.
-# - https://github.com/actions/virtual-environments
-#
-# NOTE: How to collect and upload coverage reports for Coveralls?
-# - https://github.com/marketplace/actions/coveralls-github-action#complete-parallel-job-example
-# - https://github.com/coverallsapp/github-action/issues/29
-# - https://github.com/coverallsapp/github-action/issues/29#issuecomment-704366557
-#
-# NOTE: What is the purpose of bundle-audit?
-# - https://github.com/rubysec/bundler-audit
-#
-# IMPORTANT: This workflow is heavily based on Shopify/packwerk workflow.
-# - https://github.com/Shopify/packwerk/blob/main/.github/workflows/ci.yml
-# - https://github.com/Shopify/packwerk/actions/runs/331834549/workflow
-#
-name: CI
-
-on:
-  pull_request:
-    branches:
-      - main
-  push:
-    branches:
-      - main
-
-jobs:
-  lint:
-    ##
-    # NOTE: If there are no memory, performance, or cost constraints, prefer to use as standard Linux distribution as it is possible.
-    # In a general case, you simply won't have enough time to resolve all the "quirks" of more specific distributions if you are an application developer.
-    # That is why the well-known Ubuntu is used.
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#choosing-github-hosted-runners
-    #
-    runs-on: ubuntu-20.04
-    name: Lint
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.2
-          ##
-          # NOTE: Installs the latest compatible Bundler version, runs `bundle install` and caches installed gems.
-          # - https://github.com/ruby/setup-ruby#usage
-          # - https://github.com/ruby/setup-ruby#bundler
-          #
-          bundler-cache: true
-      ##
-      # NOTE: Installs Task (task runner).
-      # https://taskfile.dev/installation/#github-actions
-      # https://github.com/go-task/task
-      #
-      - name: Install Task (task runner)
-        uses: arduino/setup-task@v1
-      - name: Run Rubocop
-        run: task rubocop
-      - name: Run Yard-Junk (docs linter)
-        run: task docs:lint
-
-  test:
-    needs:
-      - lint
-    ##
-    # NOTE: If there are no memory, performance, or cost constraints, prefer to use as standard Linux distribution as it is possible.
-    # In a general case, you simply won't have enough time to resolve all the "quirks" of more specific distributions if you are an application developer.
-    # That is why the well-known Ubuntu is used.
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#choosing-github-hosted-runners
-    #
-    # NOTE: List of all possible Ruby, JRuby versions.
-    # https://github.com/ruby/setup-ruby/blob/master/ruby-builder-versions.json
-    #
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        gemfile:
-          - Gemfile
-        ruby:
-          - 2.7
-          ##
-          # NOTE: 3.0 is wrapped by quotes in order to avoid misparsing it as integer.
-          # https://github.com/actions/runner/issues/849
-          #
-          - "3.0"
-          - 3.1
-          - 3.2
-          ##
-          # NOTE: JRuby 9.4 aims CRuby 3.1 compatibility.
-          # - https://www.jruby.org/download
-          #
-          - "jruby-9.4"
-          ##
-          # NOTE: TruffleRuby 22.3 aims CRuby 3.1 compatibility.
-          # - https://www.jruby.org/download
-          #
-          # IMPORTANT: TruffleRuby 22.3 is currently disabled since too many specs are failing due to CRuby uncompatible code.
-          #
-          # NOTE: Use `task docker:bash:truffleruby_22.3` and then `task rspec` to reproduce them locally.
-          #
-          # TODO: Make ConvenientService TruffleRuby 22.3 compatible.
-          #
-          # - "truffleruby-22.3"
-    env:
-      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
-
-    name: "Test Ruby `${{ matrix.ruby }}` with Gemfile `${{ matrix.gemfile }}`"
-    steps:
-      - uses: actions/checkout@v2
-      - name: "Set up Ruby `${{ matrix.ruby }}`"
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          ##
-          # NOTE: Installs the latest compatible Bundler version, runs `bundle install` and caches installed gems.
-          # - https://github.com/ruby/setup-ruby#usage
-          # - https://github.com/ruby/setup-ruby#bundler
-          #
-          bundler-cache: true
-      ##
-      # NOTE: Installs Task (task runner).
-      # - https://taskfile.dev/installation/#github-actions
-      # - https://github.com/go-task/task
-      #
-      - name: Install Task (task runner)
-        uses: arduino/setup-task@v1
-      - name: Run RSpec without appraisals
-        run: task rspec:standard
-      - name: Install dependencies for appraisals
-        run: task deps:install
-      - name: Run RSpec with Rails 7.0
-        run: task rspec:rails_7.0
-      - name: Run RSpec with Rails 6.1
-        run: task rspec:rails_6.1
-      - name: Run RSpec with Rails 6.0
-        run: task rspec:rails_6.0
-      - name: Run RSpec with Rails 5.2
-        run: task rspec:rails_5.2
-      - name: Run RSpec with Dry
-        run: task rspec:dry
-      - name: Run Minitest
-        run: task minitest
-      ##
-      # NOTE: `lcov-result-merger` is written in JS.
-      #
-      - name: Set up Node.js 16.x
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16.x
-      ##
-      # NOTE: `lcov-result-merger` docs.
-      # - https://github.com/mweibel/lcov-result-merger
-      #
-      # NOTE: `npx --yes` option.
-      # - https://stackoverflow.com/questions/70742968/automatically-accept-installing-npx-package
-      #
-      # NOTE: `lcov-result-merger` uses `vinyl-fs` for globs which in turn uses `node-glob`.
-      # - https://github.com/mweibel/lcov-result-merger/blob/v3.3.0/bin/lcov-result-merger.js#L38
-      # - https://github.com/gulpjs/vinyl-fs#srcglobs-options
-      # - https://github.com/isaacs/node-glob#glob-primer
-      #
-      # NOTE: Append `&& cat coverage/lcov.info` to debug.
-      #
-      # IMPORTANT: 'coverage/**/lcov.info' single quotes are mandatory.
-      #
-      - name: Merge coverage reports into single file
-        run: task coverage:lcov:merge
-      - name: Configure coverage reports for Coveralls
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.github_token }}
-          flag-name: run-${{ matrix.ruby }}-${{ matrix.gemfile }}
-          parallel: true
-          path-to-lcov: "./coverage/lcov.info"
-
-  coverage:
-    needs:
-      - test
-    ##
-    # NOTE: If there are no memory, performance, or cost constraints, prefer to use as standard Linux distribution as it is possible.
-    # In a general case, you simply won't have enough time to resolve all the "quirks" of more specific distributions if you are an application developer.
-    # That is why the well-known Ubuntu is used.
-    # - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#choosing-github-hosted-runners
-    #
-    runs-on: ubuntu-20.04
-    name: Gather coverage
-    steps:
-      - name: Upload coverage reports to Coveralls
-        uses: coverallsapp/github-action@master
-        with:
-          github-token: ${{ secrets.github_token }}
-          parallel-finished: true

data/.gitignore

@@ -1,66 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-
-##
-# NOTE: Ignores `coverage` content, but NOT the folder.
-#
-/coverage/*
-!/coverage/.gitkeep
-
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-/.rspec_status
-
-# Hide `byebug` history
-/.byebug_history
-
-# Ignore `Gemfile.lock`
-/Gemfile.lock
-
-##
-# NOTE: Ignores `Gemfile` amd `Gemfile.lock` used in docker containers.
-#
-# NOTE: `Gemfile*` matches all files that start with Gemfile in any nesting.
-# NOTE: `/Gemfile*` matches all files that start with Gemfile only from root folder.
-#
-/Gemfile*
-
-##
-# NOTE: Ignores `gemfiles` content, but NOT the folder.
-# NOTE: `gemfiles` folder is generated by Appraisal.
-#
-/gemfiles/*
-!/gemfiles/.gitkeep
-
-##
-# NOTE: Ignores `.DS_Store` in any nesting.
-#
-.DS_Store
-
-##
-# NOTE: Ignores `docs` content, but NOT the folder.
-#
-/docs/*
-!/docs/.gitkeep
-
-##
-# NOTE: Ignores `docs/api` content, but NOT the folder.
-#
-/docs/api/*
-!/docs/api/.gitkeep
-
-##
-# NOTE: Ignores `flowchart.html`, that can be generated by `Service.mermaid_flowchart.save`.
-# Check `HasMermaidFlowchart` for details.
-#
-flowchart.html
-
-##
-# NOTE: Ignores `TODO.md`. Usually, this file is used for notes that are NOT ready to be shared with the outside world.
-#
-TODO.md

data/.inch.yml

@@ -1,7 +0,0 @@
-##
-# Configures Inch (inch gives you hints where to improve your docs).
-# https://github.com/rrrene/inch#configuration
-#
-files:
-  included:
-    - lib/**/*.rb

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,45 +0,0 @@
-inherit_from:
-  - .rubocop_rspec.yml
-
-##
-# Standard based Rubocop config.
-# - https://github.com/testdouble/standard
-# - https://github.com/testdouble/standard#usage-via-rubocop
-# - https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard
-#
-require:
-  ##
-  # Rubocop for RSpec files.
-  # https://github.com/rubocop/rubocop-rspec#usage
-  #
-  - rubocop-rspec
-  ##
-  # NOTE: `rubocop-performance` is automatically bundled with Standard.
-  #
-  - rubocop-performance
-  ##
-  # NOTE: Custom Standard cop that should be loaded before `config/base.yml`.
-  #
-  - standard/cop/block_single_line_braces
-
-inherit_gem:
-  standard: config/base.yml
-
-AllCops:
-  ##
-  # https://github.com/testdouble/standard#how-do-i-specify-a-ruby-version-what-is-supported
-  #
-  TargetRubyVersion: 2.7
-
-  Exclude:
-    ##
-    # NOTE: Excludes vendor from linting. Needed by GitHub Actions.
-    # - https://github.com/rubocop/rubocop/issues/9832
-    # - https://github.com/rubocop/rubocop/issues/9832#issuecomment-873398952
-    #
-    - vendor/**/*
-
-    ##
-    # NOTE: Excludes dependencies from linting.
-    #
-    - lib/convenient_service/dependencies/**/*

data/.rubocop_rspec.yml

@@ -1,58 +0,0 @@
-##
-# Standard based Rubocop config suggested by Evil Martians.
-# - https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard
-# - https://github.com/testdouble/standard
-#
-# Copied without any modifications from:
-# https://gist.github.com/palkan/623c0816b05ed246bfe0cb406050990a
-#
-require:
-  - rubocop-rspec
-
-RSpec/Focus:
-  Enabled: true
-
-RSpec/EmptyExampleGroup:
-  Enabled: true
-
-RSpec/EmptyLineAfterExampleGroup:
-  Enabled: true
-
-RSpec/EmptyLineAfterFinalLet:
-  Enabled: true
-
-RSpec/EmptyLineAfterHook:
-  Enabled: true
-
-RSpec/EmptyLineAfterSubject:
-  Enabled: true
-
-RSpec/HookArgument:
-  Enabled: true
-
-RSpec/HooksBeforeExamples:
-  Enabled: true
-
-RSpec/ImplicitExpect:
-  Enabled: true
-
-RSpec/IteratedExpectation:
-  Enabled: true
-
-RSpec/LetBeforeExamples:
-  Enabled: true
-
-RSpec/MissingExampleGroupArgument:
-  Enabled: true
-
-RSpec/ReceiveCounts:
-  Enabled: true
-
-RSpec/Capybara/CurrentPathExpectation:
-  Enabled: true
-
-RSpec/FactoryBot/AttributeDefinedStatically:
-  Enabled: true
-
-RSpec/FactoryBot/CreateList:
-  Enabled: true

data/.ruby-version

@@ -1 +0,0 @@
-3.2.0

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.2.0

data/.vscode/CacheItsValue.code-snippets

@@ -1,15 +0,0 @@
-{
-  ////
-  // NOTE: `.code-snippets` files support only C-style comments.
-  // NOTE: More information about VS Code Snippets can be found here:
-  // - https://code.visualstudio.com/docs/editor/userdefinedsnippets
-  //
-  "CacheItsValue RSpec module": {
-    "scope": "ruby",
-    "prefix": "CacheItsValue",
-    "body": [
-      "include ConvenientService::RSpec::PrimitiveMatchers::CacheItsValue",
-    ],
-    "description": "`CacheItsValue` - a module that allows to use custom RSpec matcher `cache_its_value` to verify caching"
-  }
-}

data/.vscode/DelegateTo.code-snippets

@@ -1,15 +0,0 @@
-{
-  ////
-  // NOTE: `.code-snippets` files support only C-style comments.
-  // NOTE: More information about VS Code Snippets can be found here:
-  // - https://code.visualstudio.com/docs/editor/userdefinedsnippets
-  //
-  "DelegateTo RSpec module": {
-    "scope": "ruby",
-    "prefix": "DelegateTo",
-    "body": [
-      "include ConvenientService::RSpec::Matchers::DelegateTo",
-    ],
-    "description": "`DelegateTo` - a module that allows to use custom RSpec matcher `delegate_to` to verify delegations"
-  }
-}

data/.vscode/cache_its_value.code-snippets

@@ -1,17 +0,0 @@
-{
-  ////
-  // NOTE: `.code-snippets` files support only C-style comments.
-  // NOTE: More information about VS Code Snippets can be found here:
-  // - https://code.visualstudio.com/docs/editor/userdefinedsnippets
-  //
-  "cache_its_value RSpec matcher": {
-    "scope": "ruby",
-    "prefix": "cache_its_value",
-    "body": [
-      "specify do",
-      "  expect { $1 }.to cache_its_value",
-      "end"
-    ],
-    "description": "`cache_its_value` - a custom RSpec matcher to verify caching"
-  }
-}

data/.vscode/comparison.code-snippets

@@ -1,41 +0,0 @@
-{
-  ////
-  // NOTE: `.code-snippets` files support only C-style comments.
-  // NOTE: More information about VS Code Snippets can be found here:
-  // - https://code.visualstudio.com/docs/editor/userdefinedsnippets
-  //
-  "comparison RSpec example group": {
-    "scope": "ruby",
-    "prefix": "comparison",
-    "body": [
-      "example_group \"comparison\" do",
-      "  describe \"#==\" do",
-      "    context \"when `other` have different class\" do",
-      "      let(:other) { 42 }",
-      "",
-      "      it \"returns `nil`\" do",
-      "        expect(${1:entity} == other).to be_nil",
-      "      end",
-      "    end",
-      "",
-      "    context \"when `other` have different ${2:attribute}\" do",
-      "      let(:other) { described_class.new(${2:attribute}: other_${2:attribute}) }",
-      "",
-      "      it \"returns `false`\" do",
-      "        expect(${1:entity} == other).to eq(false)",
-      "      end",
-      "    end",
-      "",
-      "    context \"when `other` has same attributes\" do",
-      "      let(:other) { described_class.new }",
-      "",
-      "      it \"returns `true`\" do",
-      "        expect(${1:entity} == other).to eq(true)",
-      "      end",
-      "    end",
-      "  end",
-      "end",
-    ],
-    "description": "`comparison` - an example group for RSpec to verify `#==`, `#===`, `#equal?`, `#eql?` methods"
-  }
-}