interactor-rails 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc65cbf18ce5fbbec1e02ed917daa2a49e4d2bfd626aef17ede0df533bc3944b
-  data.tar.gz: b70c03d54ff025b83e6599ff2558f57383203f8d70c150d8e6ecf68d785d4808
+  metadata.gz: 732b2810255ccf99b1c720642f1133b8a6b7c96dea8fea74493a0a7b7e7bea25
+  data.tar.gz: 39675283cc9f10d1454240b8c838a480098e731ee39f791d350f4949f55be3e4
 SHA512:
-  metadata.gz: e703564f4935f203aa257cda93084c44e1fccc43e3aed8e09e0e5d3e1ba3e07b23a0a318c1f611255d5b4015479cdd0d8c1be2bba474a6c898cf13767122acff
-  data.tar.gz: e2852df358e6f2b1a040f6dd09f201ad7da76060d3909733c366b92eabb56e4888b2222c7c35205690d3c1ea6d76d392d1a2649bad8bac752fc3c2e8acde7417
+  metadata.gz: c0c913e97e92e0818dd27b0ea6d46fb89ce87ebf63c524fe519fc29cde7ef62d32a22bffb3da928a3ca52c3d5d480f8214904e5f44d2b301e9684ecf92ddf003
+  data.tar.gz: 1b3bdaabf48460b18343f5c6a95ca15328cbbcb6000434d58b8494ddf63cf557200e9af6390fb4019bbfcc29929df7af78cc453847255259c66762a0e35b39fc

data/.github/workflows/tests.yml

@@ -0,0 +1,44 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby_version:
+          - "3.1"
+          - "3.2"
+          - "3.3"
+        gemfile:
+          - "rails70"
+          - "rails71"
+          - "rails72"
+          - "rails80"
+        exclude:
+          - ruby_version: "3.1"
+            gemfile: "rails80"
+        include:
+          - ruby_version: "head"
+            gemfile: "rails-main"
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true
+
+    - name: Run Tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 2.3.0 / 2024-11-18
+
+* [ENHANCEMENT] Add support for test-unit
+* [ENHANCEMENT] Add support for Ruby 3.1+ and Rails 7.0+
+* [ENHANCEMENT] Drop support for EOL Ruby and Rails versions
+* [ENHANCEMENT] Change depdency from all of Rails to just railties
+* [ENHANCEMENT] Prefer spec/rails_helper.rb when available
+* [ENHANCEMENT] Use double quotes in templates
+
+## 2.2.0 / 2019-09-01
+
+* [ENHANCEMENT] Add support for Ruby 2.6
+* [ENHANCEMENT] Add support for Rails 6.0+
+
 ## 2.2.0 / 2018-04-23
 
 * [ENHANCEMENT] Add support for Ruby 2.5

data/README.md

@@ -1,7 +1,7 @@
 # Interactor Rails
 
 [![Gem](https://img.shields.io/gem/v/interactor-rails.svg?style=flat-square)](http://rubygems.org/gems/interactor-rails)
-[![Build](https://img.shields.io/travis/collectiveidea/interactor-rails/master.svg?style=flat-square)](https://travis-ci.org/collectiveidea/interactor-rails)
+[![Build](https://github.com/collectiveidea/interactor-rails/actions/workflows/tests.yml/badge.svg)](https://github.com/collectiveidea/interactor-rails/actions/workflows/tests.yml)
 [![Coverage](https://img.shields.io/codeclimate/coverage-letter/collectiveidea/interactor-rails.svg?style=flat-square)](https://codeclimate.com/github/collectiveidea/interactor-rails)
 [![Maintainability](https://img.shields.io/codeclimate/maintainability/collectiveidea/interactor-rails.svg?style=flat-square)](https://codeclimate.com/github/collectiveidea/interactor-rails)
 
@@ -16,8 +16,8 @@ Add this line to your application's Gemfile:
 gem "interactor-rails", "~> 2.0"
 ```
 
-Interactor Rails is compatible with Ruby 2.3, 2.4, or 2.5 on Rails 4.2, 5.0,
-5.1, or 5.2.
+Interactor Rails is tested against Ruby 3.1 and newer on Rails 7.0 or newer.
+For older versions of Ruby and Rails use version 2.2.1.
 
 ## Usage
 

data/gemfiles/rails-main.gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", github: "rails/rails"
+
+group :test do
+  gem "aruba"
+  gem "codeclimate-test-reporter", "~> 1.0"
+  gem "rspec"
+end

data/gemfiles/{rails52+.gemfile → rails70.gemfile}

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "rails", ">= 5.2"
+gem "rails", "~> 7.0.0"
 
 group :test do
   gem "aruba"

data/gemfiles/{rails42.gemfile → rails71.gemfile}

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "rails", "~> 4.2.0"
+gem "rails", "~> 7.1.0"
 
 group :test do
   gem "aruba"

data/gemfiles/{rails50.gemfile → rails72.gemfile}

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "rails", "~> 5.0.0"
+gem "rails", "~> 7.2.0"
 
 group :test do
   gem "aruba"

data/gemfiles/{rails51.gemfile → rails80.gemfile}

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "rails", "~> 5.1.0"
+gem "rails", "~> 8.0.0"
 
 group :test do
   gem "aruba"

data/interactor-rails.gemspec

@@ -1,8 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
   spec.name    = "interactor-rails"
-  spec.version = "2.2.0"
+  spec.version = "2.3.0"
 
   spec.author      = "Collective Idea"
   spec.email       = "info@collectiveidea.com"
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(/^spec/)
 
   spec.add_dependency "interactor", "~> 3.0"
-  spec.add_dependency "rails", ">= 4.2", "< 5.3"
+  spec.add_dependency "railties", ">= 7.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/generators/interactor.rb

@@ -1,12 +1,29 @@
 module Interactor
   class Generator < ::Rails::Generators::NamedBase
     def self.source_root
-      File.expand_path("../templates", __FILE__)
+      File.expand_path("templates", __dir__)
     end
 
     def generate
       template "#{self.class.generator_name}.erb", File.join("app/interactors", class_path, "#{file_name}.rb")
-      template "spec.erb", File.join("spec/interactors", class_path, "#{file_name}_spec.rb")
+
+      if use_test_unit?
+        template "test.erb", File.join("test/interactors", class_path, "#{file_name}_test.rb")
+      else
+        template "spec.erb", File.join("spec/interactors", class_path, "#{file_name}_spec.rb")
+      end
+    end
+
+    def use_test_unit?
+      ::Rails.application.config.generators.options[:rails][:test_framework] == :test_unit
+    end
+
+    def rspec_helper_file
+      if File.exist?("spec/rails_helper.rb")
+        "rails_helper"
+      else
+        "spec_helper"
+      end
     end
   end
 end

data/lib/generators/templates/spec.erb

@@ -1,7 +1,7 @@
-require 'spec_helper'
+require "<%= rspec_helper_file %>"
 
 RSpec.describe <%= class_name %>, type: :interactor do
-  describe '.call' do
+  describe ".call" do
     pending "add some examples to (or delete) #{__FILE__}"
   end
 end

data/lib/generators/templates/test.erb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/spec/interactor/rails_spec.rb

@@ -1,22 +1,18 @@
 module Interactor
   describe "Rails" do
-    def last_command_started
-      # Account for older versions of Aruba as required by Rails 3.0
-      Aruba::Api.method_defined?(:last_command_started) ? super : last_command
-    end
-
     before do
-      run_simple <<-CMD
+      run_command_and_stop <<~CMD
         bundle exec rails new example \
-          --skip-yarn \
-          --skip-gemfile \
           --skip-git \
           --skip-keeps \
           --skip-action-mailer \
-          --skip-active-record \
-          --skip-puma \
+          --skip-action-mailbox \
+          --skip-action-text \
           --skip-action-cable \
-          --skip-sprockets \
+          --skip-active-record \
+          --skip-active-job \
+          --skip-active-storage \
+          --skip-asset-pipeline \
           --skip-spring \
           --skip-listen \
           --skip-coffee \
@@ -28,172 +24,221 @@ module Interactor
           --skip-bundle \
           --skip-bootsnap \
           --quiet
-        CMD
+      CMD
+
       cd "example"
-      write_file "Gemfile", <<-EOF
+      write_file "Gemfile", <<~FILE
         gem "rails"
         gem "interactor-rails", path: "#{ROOT}"
-        EOF
-      run_simple "bundle install"
+      FILE
+
+      run_command_and_stop "bundle install"
     end
 
     context "rails generate" do
       context "interactor" do
         it "generates an interactor and spec" do
-          run_simple "bundle exec rails generate interactor place_order"
+          run_command_and_stop "bundle exec rails generate interactor place_order"
 
           path = "app/interactors/place_order.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-class PlaceOrder
-  include Interactor
+          expect(path).to have_file_content(<<~FILE)
+            class PlaceOrder
+              include Interactor
 
-  def call
-    # TODO
-  end
-end
-EOF
+              def call
+                # TODO
+              end
+            end
+          FILE
 
-          path = 'spec/interactors/place_order_spec.rb'
+          path = "spec/interactors/place_order_spec.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-require 'spec_helper'
-
-RSpec.describe PlaceOrder, type: :interactor do
-  describe '.call' do
-    pending "add some examples to (or delete) \#{__FILE__}"
-  end
-end
-EOF
+          expect(path).to have_file_content(<<~FILE)
+            require "spec_helper"
+
+            RSpec.describe PlaceOrder, type: :interactor do
+              describe ".call" do
+                pending "add some examples to (or delete) \#{__FILE__}"
+              end
+            end
+          FILE
         end
 
         it "requires a name" do
-          run_simple "bundle exec rails generate interactor"
+          run_command_and_stop "bundle exec rails generate interactor"
 
           expect("app/interactors/place_order.rb").not_to be_an_existing_file
           expect(last_command_started.stdout).to include("rails generate interactor NAME")
         end
 
         it "handles namespacing" do
-          run_simple "bundle exec rails generate interactor invoice/place_order"
+          run_command_and_stop "bundle exec rails generate interactor invoice/place_order"
 
           path = "app/interactors/invoice/place_order.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-class Invoice::PlaceOrder
-  include Interactor
+          expect(path).to have_file_content(<<~FILE)
+            class Invoice::PlaceOrder
+              include Interactor
 
-  def call
-    # TODO
-  end
-end
-EOF
+              def call
+                # TODO
+              end
+            end
+          FILE
 
           path = "spec/interactors/invoice/place_order_spec.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-require 'spec_helper'
-
-RSpec.describe Invoice::PlaceOrder, type: :interactor do
-  describe '.call' do
-    pending "add some examples to (or delete) \#{__FILE__}"
-  end
-end
-EOF
+          expect(path).to have_file_content(<<~FILE)
+            require "spec_helper"
+
+            RSpec.describe Invoice::PlaceOrder, type: :interactor do
+              describe ".call" do
+                pending "add some examples to (or delete) \#{__FILE__}"
+              end
+            end
+          FILE
         end
       end
 
       context "interactor:organizer" do
         it "generates an organizer" do
-          run_simple <<-CMD
+          run_command_and_stop <<~CMD
             bundle exec rails generate interactor:organizer place_order
-            CMD
+          CMD
 
           path = "app/interactors/place_order.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-class PlaceOrder
-  include Interactor::Organizer
+          expect(path).to have_file_content(<<~FILE)
+            class PlaceOrder
+              include Interactor::Organizer
 
-  # organize Interactor1, Interactor2
-end
-EOF
+              # organize Interactor1, Interactor2
+            end
+          FILE
 
           path = "spec/interactors/place_order_spec.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-require 'spec_helper'
-
-RSpec.describe PlaceOrder, type: :interactor do
-  describe '.call' do
-    pending "add some examples to (or delete) \#{__FILE__}"
-  end
-end
-EOF
+          expect(path).to have_file_content(<<~FILE)
+            require "spec_helper"
+
+            RSpec.describe PlaceOrder, type: :interactor do
+              describe ".call" do
+                pending "add some examples to (or delete) \#{__FILE__}"
+              end
+            end
+          FILE
         end
 
         it "generates an organizer with interactors" do
-          run_simple <<-CMD
+          run_command_and_stop <<~CMD
             bundle exec rails generate interactor:organizer place_order \
               charge_card fulfill_order
-            CMD
+          CMD
 
           path = "app/interactors/place_order.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-class PlaceOrder
-  include Interactor::Organizer
+          expect(path).to have_file_content(<<~FILE)
+            class PlaceOrder
+              include Interactor::Organizer
 
-  organize ChargeCard, FulfillOrder
-end
-EOF
+              organize ChargeCard, FulfillOrder
+            end
+          FILE
         end
 
         it "requires a name" do
-          run_simple "bundle exec rails generate interactor:organizer"
+          run_command_and_stop "bundle exec rails generate interactor:organizer"
 
           expect("app/interactors/place_order.rb").not_to be_an_existing_file
           expect(last_command_started.stdout).to include("rails generate interactor:organizer NAME")
         end
 
         it "handles namespacing" do
-          run_simple "bundle exec rails generate interactor:organizer invoice/place_order"
+          run_command_and_stop "bundle exec rails generate interactor:organizer invoice/place_order"
 
           path = "app/interactors/invoice/place_order.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-class Invoice::PlaceOrder
-  include Interactor::Organizer
+          expect(path).to have_file_content(<<~FILE)
+            class Invoice::PlaceOrder
+              include Interactor::Organizer
 
-  # organize Interactor1, Interactor2
-end
-EOF
+              # organize Interactor1, Interactor2
+            end
+          FILE
 
           path = "spec/interactors/invoice/place_order_spec.rb"
           expect(path).to be_an_existing_file
-          expect(path).to have_file_content(<<-EOF)
-require 'spec_helper'
-
-RSpec.describe Invoice::PlaceOrder, type: :interactor do
-  describe '.call' do
-    pending "add some examples to (or delete) \#{__FILE__}"
-  end
-end
-EOF
+          expect(path).to have_file_content(<<~FILE)
+            require "spec_helper"
+
+            RSpec.describe Invoice::PlaceOrder, type: :interactor do
+              describe ".call" do
+                pending "add some examples to (or delete) \#{__FILE__}"
+              end
+            end
+          FILE
         end
       end
+
+      it "prefers rails_helper if available" do
+        write_file "spec/rails_helper.rb", <<~FILE
+          require "spec_helper"
+        FILE
+
+        run_command_and_stop "bundle exec rails generate interactor place_order"
+
+        path = "spec/interactors/place_order_spec.rb"
+        expect(path).to be_an_existing_file
+        expect(path).to have_file_content(<<~FILE)
+          require "rails_helper"
+
+          RSpec.describe PlaceOrder, type: :interactor do
+            describe ".call" do
+              pending "add some examples to (or delete) \#{__FILE__}"
+            end
+          end
+        FILE
+      ensure
+        remove("spec/rails_helper.rb")
+      end
     end
 
-    it "auto-loads interactors" do
-      run_simple "bundle exec rails generate interactor place_order"
+    it "support test unit instead of rspec" do
+      # Enable test-unit support since it is skipped while generating the app.
+      write_file "config/initializers/test_unit.rb", <<~FILE
+        require "rails/test_unit/railtie"
+      FILE
 
-      run_simple "bundle exec rails runner PlaceOrder"
+      run_command_and_stop "bundle exec rails generate interactor invoice/place_order"
+
+      path = "spec/interactors/invoice/place_order_spec.rb"
+      expect(path).not_to be_an_existing_file
+
+      path = "test/interactors/invoice/place_order_test.rb"
+      expect(path).to be_an_existing_file
+
+      expect(path).to have_file_content(<<~FILE)
+        require "test_helper"
+
+        class Invoice::PlaceOrderTest < ActiveSupport::TestCase
+          # test "the truth" do
+          #   assert true
+          # end
+        end
+      FILE
+    ensure
+      remove("config/initializers/test_unit.rb")
     end
 
-    it "auto-loads organizers" do
-      run_simple "bundle exec rails generate interactor:organizer place_order"
+    it "auto-loads interactors" do
+      run_command_and_stop "bundle exec rails generate interactor place_order"
+      run_command_and_stop "bundle exec rails runner PlaceOrder"
+    end
 
-      run_simple "bundle exec rails runner PlaceOrder"
+    it "auto-loads organizers" do
+      run_command_and_stop "bundle exec rails generate interactor:organizer place_order"
+      run_command_and_stop "bundle exec rails runner PlaceOrder"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interactor-rails
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Collective Idea
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor
@@ -25,25 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,20 +72,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails42.gemfile
-- gemfiles/rails50.gemfile
-- gemfiles/rails51.gemfile
-- gemfiles/rails52+.gemfile
-- gemfiles/rails52.gemfile
+- gemfiles/rails-main.gemfile
+- gemfiles/rails70.gemfile
+- gemfiles/rails71.gemfile
+- gemfiles/rails72.gemfile
+- gemfiles/rails80.gemfile
 - interactor-rails.gemspec
 - lib/generators/interactor.rb
 - lib/generators/interactor/organizer_generator.rb
@@ -99,6 +93,7 @@ files:
 - lib/generators/templates/interactor.erb
 - lib/generators/templates/organizer.erb
 - lib/generators/templates/spec.erb
+- lib/generators/templates/test.erb
 - lib/interactor/rails.rb
 - spec/interactor/rails_spec.rb
 - spec/spec_helper.rb
@@ -107,7 +102,7 @@ homepage: https://github.com/collectiveidea/interactor-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.5.19
+signing_key:
 specification_version: 4
 summary: Rails support for Interactor
 test_files:

data/.travis.yml

@@ -1,30 +0,0 @@
-after_success:
-  - bundle exec codeclimate-test-reporter
-before_install:
-  - gem update bundler rake
-branches:
-  only:
-    - master
-gemfile:
-  - gemfiles/rails42.gemfile
-  - gemfiles/rails50.gemfile
-  - gemfiles/rails51.gemfile
-  - gemfiles/rails52.gemfile
-  - gemfiles/rails52+.gemfile
-language: ruby
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - gemfile: gemfiles/rails52+.gemfile
-notifications:
-  webhooks:
-    on_start: always
-    urls:
-      - https://buildlight.collectiveidea.com/
-rvm:
-  - "2.3"
-  - "2.4"
-  - "2.5"
-  - ruby-head
-script: bundle exec rspec --format=documentation
-sudo: false

data/gemfiles/rails52.gemfile

@@ -1,11 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: ".."
-
-gem "rails", "~> 5.2.0"
-
-group :test do
-  gem "aruba"
-  gem "codeclimate-test-reporter", "~> 1.0"
-  gem "rspec"
-end