active_manageable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f814604ee5d0971ec242d0f6e076140d746a209df9e32bd9a2e64db50c169df
+  data.tar.gz: 001f6cafc1265cc866cbd314d06b71c765131165cb719114c679188328a8d99e
+SHA512:
+  metadata.gz: 8799c680b7b565cbcf3cdd950500222c73d794d2e6a9ff51297316e97564488bcbd19de13025b0cffb0c86f029d3768d724544d97edd891de15f688840ddc746
+  data.tar.gz: c989025cbcb8944027ab74aa23ffee3f26cbace675a0131f7e22a9b8b740c9ac9e70ce6ae56df20405e9332cbc8312fb55e1b1f23e65ac40ce9275b3bb382bbd

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+# GitHub actions workflow using a matrix to test all stable releases of Ruby
+# with the different releases of ActiveRecord & ActiveSupport using the Appraisals gemfiles
+# References
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-ruby
+# https://github.com/ruby/setup-ruby#matrix-of-gemfiles
+# https://technology.customink.com/blog/2019/09/02/from-travis-ci-to-github-actions/
+# https://bibwild.wordpress.com/2020/11/12/deep-dive-moving-ruby-projects-from-travis-to-github-actions-for-ci/
+# https://github.com/jrochkind/attr_json/blob/a3f38f01dc641bc0486442ec6ff4351e18ab4a03/.github/workflows/ci.yml
+name: CI
+
+on: [push,pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false # should GitHub cancel all in-progress jobs if any matrix job fails
+      matrix:
+        ruby-version: ['2.7']
+        gemfile: ['rails_6_0']
+        include:
+          - ruby-version: '2.7'
+            gemfile: 'rails_6_1'
+          - ruby-version: '2.7'
+            gemfile: 'rails_7_0'
+          - ruby-version: '3.0'
+            gemfile: 'rails_6_0'
+          - ruby-version: '3.0'
+            gemfile: 'rails_6_1'
+          - ruby-version: '3.0'
+            gemfile: 'rails_7_0'
+          - ruby-version: '3.1'
+            gemfile: 'rails_6_1'
+          - ruby-version: '3.1'
+            gemfile: 'rails_7_0'
+
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby ${{ matrix.ruby-version }} and bundle ${{ matrix.gemfile }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Run the tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# dummy application
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*.log
+/spec/dummy/storage/
+/spec/dummy/tmp/
+
+# appraisals gemfile lockfiles
+/gemfiles/*.gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,42 @@
+# .rubocop.yml
+
+# Based article from Evil Martians
+# https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard
+# referenced in standard readme relating to use of Standard with Rubocop extensions
+# https://github.com/testdouble/standard
+
+# We want Exclude directives from different
+# config files to get merged, not overwritten
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  # Performance cops are bundled with Standard
+  - rubocop-performance
+  # Standard's config uses this custom cop,
+  # so it must be loaded
+  - standard/cop/block_single_line_braces
+
+inherit_gem:
+  standard: config/base.yml
+
+inherit_from:
+  - .rubocop_rails.yml
+  - .rubocop_rspec.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - "spec/dummy/config/*"
+    - "spec/dummy/config/environments/*"
+    - "spec/dummy/db/schema.rb"
+    - "spec/spec_helper.rb"
+
+# Exclude cop for base class with equality comparison
+# so the gem does not need a dependency on ActionPack
+Style/ClassEqualityComparison:
+  Enabled: true
+  Exclude:
+    - "lib/active_manageable/base.rb"

data/.rubocop_rails.yml

@@ -0,0 +1,201 @@
+# Copy of Evil Martians config file
+# https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard
+# https://gist.github.com/palkan/24869b835c45e89116b9727b534e579e
+# Based on removed standard configuration:
+# https://github.com/testdouble/standard/commit/94d133f477a5694084ac974d5ee01e8a66ce777e#diff-65478e10d5b2ef41c7293a110c0e6b7c
+
+require:
+  - rubocop-rails
+
+Rails/ActionFilter:
+  Enabled: true
+  EnforcedStyle: action
+  Include:
+    - app/controllers/**/*.rb
+
+Rails/ActiveRecordAliases:
+  Enabled: true
+
+Rails/ActiveSupportAliases:
+  Enabled: true
+
+Rails/ApplicationJob:
+  Enabled: true
+
+Rails/ApplicationRecord:
+  Enabled: true
+
+Rails/AssertNot:
+  Enabled: true
+  Include:
+    - '**/test/**/*'
+
+Rails/Blank:
+  Enabled: true
+  # Convert usages of `nil? || empty?` to `blank?`
+  NilOrEmpty: true
+  # Convert usages of `!present?` to `blank?`
+  NotPresent: true
+  # Convert usages of `unless present?` to `if blank?`
+  UnlessPresent: true
+
+Rails/BulkChangeTable:
+  Enabled: true
+  Database: null
+  Include:
+    - db/migrate/*.rb
+
+Rails/CreateTableWithTimestamps:
+  Enabled: true
+  Include:
+    - db/migrate/*.rb
+
+Rails/Date:
+  Enabled: true
+  EnforcedStyle: flexible
+
+Rails/Delegate:
+  Enabled: true
+  EnforceForPrefixed: true
+
+Rails/DelegateAllowBlank:
+  Enabled: true
+
+Rails/DynamicFindBy:
+  Enabled: true
+  Whitelist:
+    - find_by_sql
+
+Rails/EnumUniqueness:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb
+
+Rails/EnvironmentComparison:
+  Enabled: true
+
+Rails/Exit:
+  Enabled: true
+  Include:
+    - app/**/*.rb
+    - config/**/*.rb
+    - lib/**/*.rb
+  Exclude:
+    - lib/**/*.rake
+
+Rails/FilePath:
+  Enabled: true
+  EnforcedStyle: arguments
+
+Rails/FindBy:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb
+
+Rails/FindEach:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb
+
+Rails/HasAndBelongsToMany:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb
+
+Rails/HttpPositionalArguments:
+  Enabled: true
+  Include:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Rails/HttpStatus:
+  Enabled: true
+  EnforcedStyle: symbolic
+
+Rails/InverseOf:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb
+
+Rails/LexicallyScopedActionFilter:
+  Enabled: true
+  Safe: false
+  Include:
+    - app/controllers/**/*.rb
+
+Rails/NotNullColumn:
+  Enabled: true
+  Include:
+    - db/migrate/*.rb
+
+Rails/Output:
+  Enabled: true
+  Include:
+    - app/**/*.rb
+    - config/**/*.rb
+    - db/**/*.rb
+    - lib/**/*.rb
+
+Rails/OutputSafety:
+  Enabled: true
+
+Rails/PluralizationGrammar:
+  Enabled: true
+
+Rails/Presence:
+  Enabled: true
+
+Rails/Present:
+  Enabled: true
+  NotNilAndNotEmpty: true
+  NotBlank: true
+  UnlessBlank: true
+
+Rails/ReadWriteAttribute:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb
+
+Rails/RedundantReceiverInWithOptions:
+  Enabled: true
+
+Rails/RefuteMethods:
+  Enabled: true
+  Include:
+    - '**/test/**/*'
+
+Rails/RelativeDateConstant:
+  Enabled: true
+  AutoCorrect: false
+
+Rails/RequestReferer:
+  Enabled: true
+  EnforcedStyle: referer
+
+Rails/ReversibleMigration:
+  Enabled: true
+  Include:
+    - db/migrate/*.rb
+
+Rails/SafeNavigation:
+  Enabled: true
+  ConvertTry: false
+
+Rails/ScopeArgs:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb
+
+Rails/TimeZone:
+  Enabled: true
+  EnforcedStyle: flexible
+
+Rails/UniqBeforePluck:
+  Enabled: true
+  EnforcedStyle: conservative
+  AutoCorrect: false
+
+Rails/Validation:
+  Enabled: true
+  Include:
+    - app/models/**/*.rb

data/.rubocop_rspec.yml

@@ -0,0 +1,68 @@
+# Copy of Evil Martians config file
+# https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard
+# 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:
+  Enabled: true
+
+RSpec/FactoryBot:
+  Enabled: true
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+# disabled as using expect_any_instance_of(ActiveRecord::Relation)
+# to check for calls to :includes and :preload etc
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false

data/.standard.yml

@@ -0,0 +1,5 @@
+# Standard ruby style guide, linter, and formatter https://github.com/testdouble/standard
+# to check the style of files run:-
+# $ bundle exec standardrb
+ignore:
+  - 'active_manageable.gemspec'

data/Appraisals

@@ -0,0 +1,27 @@
+# Appraisal integrates with bundler and rake to test your library
+# against different versions of dependencies in repeatable scenarios called "appraisals"
+# https://github.com/thoughtbot/appraisal
+#
+# The dependencies in your Appraisals file are combined with dependencies in your Gemfile
+#
+# Install the dependencies for each appraisal
+# $ bundle exec appraisal install
+# which generates a Gemfile for each appraisal in the gemfiles directory
+#
+# Run each appraisal in turn or a single appraisal:-
+# $ bundle exec appraisal rspec
+# $ bundle exec appraisal rails-6-1 rspec
+appraise "rails-7-0" do
+  gem "activerecord", "~> 7.0"
+  gem "activesupport", "~> 7.0"
+end
+
+appraise "rails-6-1" do
+  gem "activerecord", "~> 6.1"
+  gem "activesupport", "~> 6.1"
+end
+
+appraise "rails-6-0" do
+  gem "activerecord", "~> 6.0.1"
+  gem "activesupport", "~> 6.0.1"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0 - 2022-03-21
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 138595+chrisbranson@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in active_manageable.gemspec
+gemspec