countless 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb317432e20e425c9d4a173f46e886a839ce85aaf8b445b890e4a9b6a4dbfca4
+  data.tar.gz: 87c853ba24c79208a4e6fb84f2994af994618f5cdaf0c43a19942585e87885cd
+SHA512:
+  metadata.gz: ebddecc5729fe2d1c9afdb04f135fbc30a907131999f7c2037288f3e86771fb360ef99920017cf01ad6891d286112f56335eaca0e3997c167a605e97f1e402c1
+  data.tar.gz: c1acaa20da4b0e735b3557a5b88166397e09ddaa1ad89cdf65b1088b6165fd5691d392c7574ffb466330aaeb8005230aed2a9e2ddc003e2b0a481acc2c482b5b

data/.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = true
+
+[*.json]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 4
+
+[*.sh]
+indent_style = space
+indent_size = 2

data/.github/workflows/documentation.yml

@@ -0,0 +1,39 @@
+name: Build Documentation
+on:
+  repository_dispatch:
+    types: [documentation]
+
+concurrency:
+  group: 'docs'
+
+jobs:
+  docs:
+    name: Build gem documentation
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          rubygems: latest
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Build gem documentation
+        run: make docs
+
+      - name: Upload the code coverage report
+        run: coverage
+
+      - name: Add this job to the commit status
+        run: commit-status '${{ job.status }}'
+        if: always()

data/.github/workflows/test.yml

@@ -0,0 +1,69 @@
+name: Test
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * MON'
+
+concurrency:
+  group: '${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1]
+        rails: [5.2, '6.0', 6.1, '7.0']
+        exclude:
+          # Rails 7.0 requires Ruby >=2.7
+          - ruby: 2.5
+            rails: '7.0'
+          - ruby: 2.6
+            rails: '7.0'
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: latest
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage
+
+  trigger-docs:
+    name: Trigger the documentation upload
+    runs-on: ubuntu-20.04
+    timeout-minutes: 2
+    needs: test
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/noop
+
+      - name: Trigger the documentation upload
+        run: workflow documentation

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/api/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/gemfiles/vendor/
+*.gemfile.lock
+/bin/cloc
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,58 @@
+require:
+  - rubocop-rspec
+
+Documentation:
+  Enabled: true
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - build/**/*
+    - gemfiles/**/*
+    - spec/fixtures/files/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - Rakefile
+    - '*.gemspec'
+    - spec/**/*.rb
+    - '**/*.rake'
+    - doc/**/*.rb
+
+# We stay with the original Ruby Style Guide recommendation.
+Layout/LineLength:
+  Max: 80
+
+# Document all the things.
+Style/DocumentationMethod:
+  Enabled: true
+  RequireForNonPublicMethods: true
+
+# It's a deliberate idiom in RSpec.
+# See: https://github.com/bbatsov/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+# Because +expect_any_instance_of().to have_received()+ is not
+# supported with the +with(hash_including)+ matchers
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Because nesting makes sense here to group the feature tests
+# more effective. This increases maintainability.
+RSpec/NestedGroups:
+  Max: 4
+
+# Disable regular Rails spec paths.
+RSpec/FilePath:
+  Enabled: false
+
+# Because +enqueued_jobs+ is a method not a memoized variable,
+# so when first evaluated it won't change.
+RSpec/ExpectChange:
+  Enabled: false

data/.simplecov

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+SimpleCov.start 'test_frameworks' do
+  add_filter '/vendor/bundle/'
+end

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--plugin activesupport-concern
+--markup=rdoc
+-
+README.md
+lib/**/*.rb

data/Appraisals

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+appraise 'rails-5.2' do
+  gem 'activejob', '5.2.0'
+  gem 'activerecord', '5.2.0'
+  gem 'activesupport', '5.2.0'
+end
+
+appraise 'rails-6.0' do
+  gem 'activejob', '6.0.0'
+  gem 'activerecord', '6.0.0'
+  gem 'activesupport', '6.0.0'
+end
+
+appraise 'rails-6.1' do
+  gem 'activejob', '6.1.0'
+  gem 'activerecord', '6.1.0'
+  gem 'activesupport', '6.1.0'
+end
+
+appraise 'rails-7.0' do
+  gem 'activejob', '7.0.0'
+  gem 'activerecord', '7.0.0'
+  gem 'activesupport', '7.0.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### next
+
+* Initial commit

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hermann.mayer92@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in countless.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+(directories %w[lib spec]).select do |d|
+  if Dir.exist?(d)
+    d
+  else
+    UI.warning("Directory #{d} does not exist")
+  end
+end
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/countless.rb}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/countless/([^\\]+)\.rb$}) do |m|
+    "spec/countless/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/countless/([^\\]+)/(.*)\.rb$}) do |m|
+    "spec/#{m[1]}/#{m[2]}_spec.rb"
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Hausgold
+
+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.

data/Makefile

@@ -0,0 +1,151 @@
+MAKEFLAGS += --warn-undefined-variables -j1
+SHELL := bash
+.SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := all
+.DELETE_ON_ERROR:
+.SUFFIXES:
+.PHONY:
+
+# Environment switches
+MAKE_ENV ?= docker
+COMPOSE_RUN_SHELL_FLAGS ?= --rm
+BASH_RUN_SHELL_FLAGS ?=
+CLOC_VERSION ?= v1.94
+CLOC_BASE_URL ?= https://github.com/AlDanial/cloc
+CLOC_URL ?= $(CLOC_BASE_URL)/releases/download/$(CLOC_VERSION)/cloc-1.94.pl
+
+# Directories
+VENDOR_DIR ?= vendor/bundle
+GEMFILES_DIR ?= gemfiles
+BIN_DIR ?= bin
+
+# Host binaries
+BASH ?= bash
+COMPOSE ?= docker-compose
+ID ?= id
+MKDIR ?= mkdir
+RM ?= rm
+CURL ?= curl
+CHMOD ?= chmod
+
+# Container binaries
+BUNDLE ?= bundle
+APPRAISAL ?= appraisal
+RAKE ?= rake
+RUBOCOP ?= rubocop
+GUARD ?= guard
+YARD ?= yard
+
+# Files
+GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
+	$(wildcard $(GEMFILES_DIR)/*.gemfile)))
+TEST_GEMFILES := $(GEMFILES:%=test-%)
+
+# Define a generic shell run wrapper
+# $1 - The command to run
+ifeq ($(MAKE_ENV),docker)
+define run-shell
+	$(COMPOSE) run $(COMPOSE_RUN_SHELL_FLAGS) \
+		-e LANG=en_US.UTF-8 -e LANGUAGE=en_US.UTF-8 -e LC_ALL=en_US.UTF-8 \
+		-e HOME=/tmp -e BUNDLE_APP_CONFIG=/app/.bundle \
+		-u `$(ID) -u` test \
+		bash $(BASH_RUN_SHELL_FLAGS)  -c 'sleep 0.1; echo; $(1)'
+endef
+else ifeq ($(MAKE_ENV),baremetal)
+define run-shell
+	$(1)
+endef
+endif
+
+all:
+	# Countless
+	#
+	# install            Install the dependencies
+	# test               Run the whole test suite
+	# clean              Clean the dependencies
+	#
+	# docs               Generate the Ruby documentation of the library
+	# stats              Print the code statistics (library and test suite)
+	# notes              Print all the notes from the code
+	# release            Release a new Gem version (maintainers only)
+	#
+	# shell              Run an interactive shell on the container
+	# shell-irb          Run an interactive IRB shell on the container
+
+.interactive:
+	@$(eval BASH_RUN_SHELL_FLAGS = --login)
+
+install:
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
+	@$(MAKE) --no-print-directory .fetch-cloc
+
+.fetch-cloc:
+	# Fetch the CLOC ($(CLOC_VERSION)) binary
+ifeq ("$(wildcard $(BIN_DIR)/cloc)","")
+	@$(CURL) -L '$(CLOC_URL)' -o '$(BIN_DIR)/cloc'
+	@$(CHMOD) +x '$(BIN_DIR)/cloc'
+endif
+
+test: \
+	test-specs \
+	test-style
+
+test-specs: .fetch-cloc
+	# Run the whole test suite
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
+
+$(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
+$(TEST_GEMFILES):
+	# Run the whole test suite ($(GEMFILE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
+
+test-style: \
+	test-style-ruby
+
+test-style-ruby:
+	# Run the static code analyzer (rubocop)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
+
+watch: install .interactive
+	# Watch for code changes and rerun the test suite
+	@$(call run-shell,$(BUNDLE) exec $(GUARD))
+
+clean:
+	# Clean the dependencies
+	@$(RM) -rf $(VENDOR_DIR)
+
+clean-containers:
+	# Clean running containers
+ifeq ($(MAKE_ENV),docker)
+	@$(COMPOSE) down
+endif
+
+distclean: clean clean-containers
+
+shell:
+	# Run an interactive shell on the container
+	@$(call run-shell,$(BASH) -i)
+
+shell-irb:
+	# Run an interactive IRB shell on the container
+	@$(call run-shell,bin/console)
+
+docs:
+	# Build the API documentation
+	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
+		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
+
+notes:
+	# Print the code statistics (library and test suite)
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
+
+stats:
+	# Print all the notes from the code
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
+
+release: .fetch-cloc
+	# Release a new gem version
+	@$(BUNDLE) exec $(RAKE) release