runger_actions 0.19.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31d6a155048b68d9c185337c270d65745883c7233cbf2d62d32e4304625e215a
+  data.tar.gz: 5e48b14544e523f23d5bd061e63f836961e54e718e8898bf8be638e382702645
+SHA512:
+  metadata.gz: ef95ab3fa31979b0a9bb780085ef50ba396ec994a0b7e3769d31d6ca222b8f8365231bbad7b375b0137acfe3db1ffe41bc9f4a0f2ca8f7ea6b415655129848f8
+  data.tar.gz: 508050ed87530bfe4b42e2488ffa78e0c4bb462549c6adc3a34c7554edaa3619a1c1a542d408698711d322f8c846f6fe9f066b3c11de45fc2031e3f04d353f46

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:52"
+    timezone: America/Chicago
+  open-pull-requests-limit: 20
+  ignore:
+  - dependency-name: shaped
+    versions:
+    - 0.8.0

data/.github/workflows/ruby.yml

@@ -0,0 +1,25 @@
+name: Run Rspec Tests
+
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: Run Rubocop
+      run: bin/rubocop --format clang
+    - name: Run RSpec tests
+      run: bin/rspec --format progress
+    - name: Ensure alpha version
+      run: grep alpha $(find . -type f -name version.rb)
+    - name: Ensure no git diff
+      run: git diff --exit-code && git diff-index --quiet --cached HEAD
+    - name: Ensure "## Unreleased" is in CHANGELOG.md
+      run: grep "^## Unreleased" CHANGELOG.md

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.release_assistant.yml

@@ -0,0 +1,3 @@
+---
+git: true
+rubygems: true

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  runger_style:
+    - rulesets/default.yml # gem 'rubocop'
+    - rulesets/performance.yml # gem 'rubocop-performance'
+    - rulesets/rspec.yml # gem 'rubocop-rspec'
+
+AllCops:
+  Exclude:
+    - lib/generators/runger_actions/action/templates/action.rb
+    - vendor/**/*

data/.ruby-version

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

data/CHANGELOG.md

@@ -0,0 +1,225 @@
+## v0.19.0 (2023-05-20)
+### Added
+- Release gem via RubyGems.
+
+## v0.18.0 (2023-05-20)
+### Breaking Changes
+- Change project name from "ActiveActions" to "RungerActions"
+
+## v0.17.1 (2021-03-23)
+### Fixed
+- Remove no-longe-accurate claim in README.md that `shaped` must be listed in apps' `Gemfile`s
+
+## v0.17.0 (2021-02-17)
+### Added
+- Allow setting `error_message` on the result object when invoking a `fails_with` case
+
+### Maintenance
+- Specify Ruby 3.0.0 for gem development
+
+## v0.16.1 (2021-02-13)
+### Docs
+- Fix README.md typo (change `requires` to `returns`)
+
+## v0.16.0 (2021-02-01)
+### Dependencies
+- Bump `shaped` from 0.7.0 to 0.8.0
+
+## v0.15.1 (2021-01-28)
+### Fixed
+- Mention the correct class (the action class rather than the result class) in error messages when
+  invoking a failure condition when executing via `run!`
+
+## v0.15.0 (2021-01-28)
+### BREAKING CHANGES
+- Change the behavior of the `#run!` instance method to also raise an error if any failure
+  conditions (i.e. failures set via a `fails_with` case) occur during the execution of the action.
+  (Previously, `#run!` would only raise if any of the initialization params were invalid.)
+
+### Added
+- Add `::new!` and `::run!` class methods for actions
+
+## v0.14.2 (2021-01-26)
+### Dependencies
+- Bump `release_assistant` to `0.1.1.alpha`
+
+## v0.14.1 (2021-01-26)
+### Internal
+- Move CI from Travis to GitHub Actions
+- Ensure in PR CI runs that the current version contains "alpha", that there's no git diff (e.g. due
+  to failing to run `bundle` after updating the version), and that there is an "Unreleased" section
+  in `CHANGELOG.md`
+- Use `release_assistant` gem to manage the release process
+
+## v0.14.0 (2021-01-21)
+### Added
+- Add Rails generator (e.g. `bin/rails g runger_actions:action Users::Create`)
+
+## v0.13.3 (2020-07-02)
+### Internal
+- Source Rubocop rules/config from `runger_style` gem
+
+## v0.13.2 (2020-06-24)
+### Dependencies
+- Bump `shaped` from 0.6.4 to 0.7.0
+
+## v0.13.1 (2020-06-22)
+### Docs
+- List some alternatives
+- Add detail about the project status/context
+
+## v0.13.0 (2020-06-22)
+### Dependencies
+- Bump `shaped` from 0.6.3 to 0.6.4
+
+## v0.12.0 (2020-06-22)
+### Changed
+- Source `shaped` from RubyGems
+
+### Docs
+- Add more badges to README.md (Dependabot; GitHub tag/version)
+
+## v0.11.0 (2020-06-21)
+### Fixed
+- Only check for promised return values if the action is successful
+
+## v0.10.2 (2020-06-20)
+### Docs
+- Add Travis build status badge to README.md
+
+## v0.10.1 (2020-06-20)
+### Docs
+- Add example of controller code using an action
+- Add a table of contents to README.md
+- Simplify README.md action example by removing check for NEXMO_API_KEY
+- Illustrate `returns` in README.md example
+- Add more detailed documentation/examples to README.md
+
+## 0.10.0 (2020-06-19)
+### Added
+- Validate (at the time of assignment to the `result`) the "shape" of all `returns`ed result values
+
+### Changed
+- Tweaked the wording/formatting of some validation failure error messages.
+
+## v0.9.0 (2020-06-19)
+### Dependencies
+- Bump `shaped` from 0.5.8 to 0.6.0
+
+## v0.8.1 (2020-06-19)
+### Dependencies
+- Bump `shaped` from 0.5.0 to 0.5.8
+
+## v0.8.0 (2020-06-19)
+### Added
+- Bump `shaped` from 0.4.0 to 0.5.0, which adds support for a new `Shaped::Shape::Callable` shape
+  description, so you can now do something like this:
+
+```rb
+class ProcessOrder < ApplicationAction
+  # allow ordering only 2, 4, or 6 widgets
+  requires :number_of_widgets, ->(num) { num.is_a?(Integer) && (2..6).cover?(num) && num.even? }
+  # [...]
+end
+```
+
+## v0.7.0 (2020-06-18)
+### Added
+- Bump `shaped` from 0.3.2 to 0.4.0, which adds support for ActiveModel-style validations of
+  `Shaped::Shape::Class` shapes. So now you can do something like this:
+
+```rb
+class ProcessOrder < ApplicationAction
+  requires :number_of_widgets, Integer, numericality: { greater_than: 0, less_than: 1_000 }
+  # [...]
+end
+```
+
+## v0.6.1 (2020-06-18)
+### Maintenance
+- Add test coverage reporting (via `codecov` and `simplecov`)
+
+### Tests
+- Add test for `Result#success?`
+
+## v0.6.0 (2020-06-18)
+### Breaking changes
+- Update `shaped` (which is used for param validation) from version 0.2.1 to 0.3.0, which has
+  breaking changes. For more details, see the [`shaped`
+  changelog](https://github.com/davidrunger/shaped/blob/master/CHANGELOG.md#030---2020-06-18).
+- For `requires`, _all_ type/shape descriptions (i.e. arguments `[1..]`) are now passed through the
+  `Shaped::Shape(...)` constructor method. (In most cases, this change will not have any effect,
+  because in most cases the type/shape description was a single class, and this change has no effect
+  in that case.)
+
+## 0.5.1 - 2020-06-16
+### Docs
+- Mention in README.md that `shaped` needs to be installed explicitly/manually as a dependency in the user's own
+  `Gemfile`.
+
+## 0.5.0 - 2020-06-16
+### Added
+- Use [`shaped`](https://github.com/davidrunger/shaped/) gem to describe the shape of Hahes and
+  Arrays
+
+## 0.4.0 - 2020-06-16
+### Added
+- Raise an `RungerActions::MissingResultValue` error if a promised return value (as declared via the
+  `returns` class method on the action) has not been set by the action's `#execute` method.
+
+## 0.3.1 - 2020-06-16
+### Fixed
+- Don't raise an error when running an action that doesn't have any `requires` / input params
+
+## 0.3.0 - 2020-06-15
+### Added
+- Add `RungerActions::Base#run!` method that will raise `RungerActions::InvalidParam` if there are
+  any ActiveRecord params provided to the action that fail any validation(s) specified for that
+  param. This can be used as an (error-raising) alternative to manually checking `action.valid?`.
+
+## 0.2.2 - 2020-06-15
+### Added
+- Prevent mutating a returned `result` from outside of the action
+
+### Maintenance
+- Don't install a specific `bundler` version in Travis
+- Run tests on Travis via `bin/rspec` (rather than (implicitly) via `bundle exec rake`)
+- Run rubocop in Travis
+
+## 0.2.1 - 2020-06-15
+### Added
+- Raise an explicit error if action class fails to implement #execute
+
+## 0.2.0 - 2020-06-15
+### Added
+- Add stricter type validations and better error messages for type validation failures
+- Add support for arrays of allowed classes (rather than only allowing a single allowed class type
+  to be specified)
+
+### Maintenance
+- Only send Travis notifications when builds fail (not when they pass)
+- Specify Ruby 2.7.0 (not 2.7.1)
+- Specify `os: linux` for Travis
+- Specify `dist: bionic` for Travis
+
+## 0.1.3 - 2020-06-14
+### Fixed
+- Allow #result to return a result even w/o any returns or fails_with
+
+## 0.1.2 - 2020-06-14
+### Fixed
+- Create reader methods on `Result` object for `returns`ed values
+
+## 0.1.1 - 2020-06-14
+### Docs
+- Add usage instructions (including code example) to README.md and make other tweaks to README.md.
+
+### Maintenance
+- Add `bin/release` executable
+
+### Refactor
+- Autocorrect all autocorrectable rubocop violations
+
+## 0.1.0 - 2020-06-14
+- Initial release of RungerActions! Organize and validate the business logic of your Rails
+  application with this combined form object / command object.

data/Gemfile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+ruby '3.2.0'
+
+# Specify your gem's dependencies in runger_actions.gemspec
+gemspec
+
+group :development, :test do
+  gem 'amazing_print'
+  gem 'pry-byebug'
+  gem 'rake', '~> 13.0', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'runger_style', require: false
+end
+
+group :development do
+  gem 'release_assistant', require: false, github: 'davidrunger/release_assistant'
+end
+
+group :test do
+  gem 'codecov', require: false
+  gem 'rspec', '~> 3.12'
+  gem 'simple_cov-formatter-terminal'
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,268 @@
+GIT
+  remote: https://github.com/davidrunger/release_assistant.git
+  revision: bd6955962211ee0d89d699a19a2225c2f52ce500
+  specs:
+    release_assistant (0.3.3.alpha)
+      activesupport (>= 6, < 8)
+      colorize (~> 0.8)
+      memoist (~> 0.16)
+      slop (~> 4.8)
+
+PATH
+  remote: .
+  specs:
+    runger_actions (0.19.0)
+      memoist (~> 0.16)
+      rails (>= 6, < 8)
+      shaped (>= 0.9, < 0.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    amazing_print (1.4.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.2)
+    minitest (5.18.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rouge (4.1.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.22.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    runger_style (0.2.22)
+      rubocop (>= 1.38.0, < 2)
+    shaped (0.10.0)
+      activemodel (>= 6, < 8)
+      activesupport (>= 6, < 8)
+    simple_cov-formatter-terminal (0.2.2)
+      activesupport (>= 7.0.4, < 8)
+      memoist (>= 0.16.2, < 1)
+      rouge (>= 4.0.0, < 5)
+      rspec-core (>= 3.11.0, < 4)
+      simplecov (>= 0.21.2, < 1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    slop (4.10.1)
+    sqlite3 (1.6.3)
+      mini_portile2 (~> 2.8.0)
+    thor (1.2.2)
+    timeout (0.3.2)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amazing_print
+  codecov
+  pry-byebug
+  rake (~> 13.0)
+  release_assistant!
+  rspec (~> 3.12)
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  runger_actions!
+  runger_style
+  simple_cov-formatter-terminal
+  sqlite3
+
+RUBY VERSION
+   ruby 3.2.0p0
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

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