wicked 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebda68c36a8e0e08aa54c850b91c176720d5fa4897482d0312182c2bee6a418f
-  data.tar.gz: f7a27e0b7baafe854a3891d0ec185a425f6d0e57694325dd2597ca9f7f94d85b
+  metadata.gz: eb950926820837e2ebfd752237b01d22a38186c6073642f9c2c3fbf94da96fb3
+  data.tar.gz: 8eddcdf3391ac3d8e881c75624b431cafb54ccc956d488f6a1f975f02aff0c8d
 SHA512:
-  metadata.gz: bad278bb225e74a389efb8413290763b644625ff2bdc89213da99c7941b214abbdbfbc1e9e85c691a03196be064321f07d3c1222a2916c45bb6be3c425aee874
-  data.tar.gz: db3bdd321cc8902b9fa693e4884c567aa9fe474ad7fbe5cdd6f7452beec054ba9b21252441dabfd42e23adc94ee1e7fceac4bda07394d456c7cc36e65f50d82d
+  metadata.gz: b33ad97299a460547b255c6774c6961d0c6ee0d9721ca9db04dbc26b7e37b606aaddd7a8a93dda1e6bc60e2b3418ac103bbca53bd76815cf65796acaaabc32fe
+  data.tar.gz: 4d5c337fb136b16a2468ba1f456f77db7f73600280fa5966e5c9f4d95bf01932aa61fb0bc5651a13974d259513dc7d6e353287e8b1daaf3488a6db157a7f1016

data/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.5'
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          # - 'head'
+        gemfile:
+          - gemfiles/rails_5.2.gemfile
+          - gemfiles/rails_6.0.gemfile
+          - gemfiles/rails_7.0.gemfile
+          # - gemfile: gemfiles/rails_head.gemfile
+        exclude:
+          - ruby: '2.5'
+            gemfile: gemfiles/rails_7.0.gemfile
+          - ruby: '2.6'
+            gemfile: gemfiles/rails_7.0.gemfile
+          - ruby: '2.7'
+            gemfile: gemfiles/rails_5.2.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_5.2.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_6.0.gemfile
+          - ruby: '3.1'
+            gemfile: gemfiles/rails_5.2.gemfile
+          - ruby: '3.1'
+            gemfile: gemfiles/rails_6.0.gemfile
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run test
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: bundle exec rake test

data/Appraisals

@@ -1,11 +1,11 @@
-appraise "rails-5.1" do
+appraise "rails-5.2" do
   gem "rails", "~> 5.2"
 end
 
-appraise "rails-5.2" do
-  gem "rails", "~> 5.2"
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0"
 end
 
-appraise "rails-6.0.1" do
-  gem "rails", "~> 6.0.1"
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## 2.0.0
+
+* Return `422` (`:unprocessable_entity`) when form submissions fails. Turbo requires an HTTP Status code between 400-499 or 500-599 when a FormSubmission request fails. This pull request makes wicked compatible with Turbo Drive (https://github.com/zombocom/wicked/pull/294)
+* Pass the provided step when raising InvalidStepError errors (https://github.com/zombocom/wicked/pull/284)
+
 ## 1.4.0
 
 * Update readme to include `current_step?` (https://github.com/zombocom/wicked/pull/271)

data/README.md

@@ -1,8 +1,8 @@
-![](http://cl.ly/image/3O2i1P061o3y/content.png)
+![](./wicked.png)
 
 # Step-By-Step Wizard Controllers
 
-[![Build Status](https://travis-ci.org/schneems/wicked.svg?branch=master)](https://travis-ci.org/schneems/wicked)
+[![Build Status](https://github.com/zombocom/wicked/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/zombocom/wicked)
 [![Code Climate](https://codeclimate.com/github/schneems/wicked/badges/gpa.svg)](https://codeclimate.com/github/schneems/wicked)
 [![Help Contribute to Open Source](https://www.codetriage.com/schneems/wicked/badges/users.svg)](https://www.codetriage.com/schneems/wicked)
 
@@ -30,6 +30,7 @@ Then run `bundle install` and you're ready to start
 * [Show Current Wizard Progress to User](https://github.com/schneems/wicked/wiki/Show-Current-Wizard-Progress-to-User)
 * [Example App](https://github.com/schneems/wicked_example)
 * [Screencast](http://schneems.com/post/18437886598/wizard-ify-your-rails-controllers-with-wicked)
+* [Devise Onboarding With Wicked by Deanin](https://www.youtube.com/watch?v=P-eYHvgT4KA)
 * [Watch Railscasts episode: #346 Wizard Forms with Wicked](http://railscasts.com/episodes/346-wizard-forms-with-wicked)
 
 ## How
@@ -121,7 +122,7 @@ class AfterSignupController < ApplicationController
     @user = current_user
     case step
     when :confirm_password
-      @user.update_attributes(user_params)
+      @user.update(user_params)
     end
     sign_in(@user, bypass: true) # needed for devise
     render_wizard @user
@@ -137,7 +138,7 @@ end
 
 We're passing `render_wizard` our `@user` object here. If you pass an object into `render_wizard` it will show the next step if the object saves or re-render the previous view if it does not save.
 
-Note that `render_wizard` does attempt to save the passed object. This means that in the above example, the object will be saved twice. This will cause any callbacks to run twice also. If this is undesirable for your use case, then calling `assign_attributes` (which does not save the object) instead of `update_attributes` might work better.
+Note that `render_wizard` does attempt to save the passed object. This means that in the above example, the object will be saved twice. This will cause any callbacks to run twice also. If this is undesirable for your use case, then calling `assign_attributes` (which does not save the object) instead of `update` might work better.
 
 To get to this update action, you simply need to submit a form that PUT's to the same url
 

data/gemfiles/{rails_5.1.gemfile → rails_6.0.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.2"
+gem "rails", "~> 6.0"
 
 group :development, :test do
   gem "sqlite3", platform: [:ruby, :mswin, :mingw]

data/gemfiles/{rails_6.0.1.gemfile → rails_7.0.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 6.0.1"
+gem "rails", "~> 7.0"
 
 group :development, :test do
   gem "sqlite3", platform: [:ruby, :mswin, :mingw]

data/lib/wicked/controller/concerns/render_redirect.rb

@@ -25,6 +25,8 @@ module Wicked::Controller::Concerns::RenderRedirect
       @skip_to ||= @next_step
     else
       @skip_to = nil
+      # Do not override user-provided status for render
+      options[:status] ||= :unprocessable_entity
     end
   end
 

data/lib/wicked/version.rb

@@ -1,3 +1,3 @@
 module Wicked
-  VERSION = "1.4.0"
+  VERSION = "2.0.0"
 end

data/lib/wicked/wizard.rb

@@ -3,8 +3,12 @@ module Wicked
     extend ActiveSupport::Concern
 
     class InvalidStepError < RuntimeError
-      def initialize
-        super "The requested step did not match any steps defined for this controller."
+      attr_accessor :step
+
+      def initialize(step = nil)
+        self.step = step
+
+        super "The requested step did not match any steps defined for this controller: #{step.inspect}"
       end
     end
 
@@ -57,10 +61,10 @@ module Wicked
       check_redirect_to_first_last!(the_step)
 
       valid_steps = steps + self.class::PROTECTED_STEPS
-      the_step = valid_steps.detect { |stp| stp.to_s == the_step }
+      resolved_step = valid_steps.detect { |stp| stp.to_s == the_step }
 
-      raise InvalidStepError if the_step.nil?
-      the_step
+      raise InvalidStepError.new(the_step) if resolved_step.nil?
+      resolved_step
     end
 
     private def check_steps!

data/test/controllers/status_codes_controller_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class StatusCodesControllerTest < WickedControllerTestCase
+  test 'returns successful status code for show' do
+    get :show, params: { id: 'good' }
+    assert_response(:success)
+  end
+
+  test 'returns correct status code for successfuly update' do
+    put :update, params: { id: 'good' }
+    assert_response(:redirect)
+  end
+
+  test 'returns correct status code for failed update' do
+    put :update, params: { id: 'bad' }
+    assert_response(:unprocessable_entity)
+  end
+end

data/test/dummy/app/controllers/status_codes_controller.rb

@@ -0,0 +1,39 @@
+class StatusCodesController < ApplicationController
+  include Wicked::Wizard
+
+  class GoodThing
+    def save
+      true
+    end
+  end
+
+  class BadThing
+    def save
+      false
+    end
+  end
+
+  steps :good, :bad
+
+  def index; end
+
+  def show
+    render_wizard
+  end
+
+  def update
+    case step
+    when :good
+      @thing = GoodThing.new
+    when :bad
+      @thing = BadThing.new
+    end
+    render_wizard(@thing, notice: "Thing was updated from step #{step}.")
+  end
+
+  private
+
+  def finish_wizard_path
+    updates_path
+  end
+end

data/test/dummy/app/views/status_codes/bad.html.erb

@@ -0,0 +1 @@
+bad step

data/test/dummy/app/views/status_codes/good.html.erb

@@ -0,0 +1 @@
+good step

data/test/dummy/config/routes.rb

@@ -8,6 +8,7 @@ Dummy::Application.routes.draw do
   resources :string_steps
   resources :redirect_to_next
   resources :redirect_to_finish_flash
+  resources :status_codes
   resources :updates
   resources :update_params
 

data/test/test_helper.rb

@@ -18,12 +18,12 @@ Capybara.default_selector = :css
 
 # https://github.com/plataformatec/devise/blob/master/test/orm/active_record.rb
 migrate_path = File.expand_path("../rails_app/db/migrate", __FILE__)
-if Rails.version.start_with? '6'
-  ActiveRecord::MigrationContext.new(migrate_path, ActiveRecord::SchemaMigration).migrate
-elsif Rails.version.start_with? '5.2'
+if ActiveRecord.version < Gem::Version.create("5.2.0")
+  ActiveRecord::Migrator.migrate(migrate_path)
+elsif ActiveRecord.version < Gem::Version.create("6.0.0")
   ActiveRecord::MigrationContext.new(migrate_path).migrate
 else
-  ActiveRecord::Migrator.migrate(migrate_path)
+  ActiveRecord::MigrationContext.new(migrate_path, ActiveRecord::SchemaMigration).migrate
 end
 
 # Load support files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wicked
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-07 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -89,8 +89,8 @@ extra_rdoc_files:
 - README.md
 files:
 - ".github/workflows/check_changelog.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -98,9 +98,9 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
-- gemfiles/rails_6.0.1.gemfile
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/wicked.rb
 - lib/wicked/controller/concerns/action.rb
 - lib/wicked/controller/concerns/path.rb
@@ -112,6 +112,7 @@ files:
 - lib/wicked/wizard/translated.rb
 - lib/wicked/wizard_controller.rb
 - test/controllers/bar_controller_test.rb
+- test/controllers/status_codes_controller_test.rb
 - test/controllers/updates_controller_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
@@ -124,6 +125,7 @@ files:
 - test/dummy/app/controllers/pages_controller.rb
 - test/dummy/app/controllers/redirect_to_finish_flash_controller.rb
 - test/dummy/app/controllers/redirect_to_next_controller.rb
+- test/dummy/app/controllers/status_codes_controller.rb
 - test/dummy/app/controllers/step_positions_controller.rb
 - test/dummy/app/controllers/string_steps_controller.rb
 - test/dummy/app/controllers/update_params_controller.rb
@@ -151,6 +153,8 @@ files:
 - test/dummy/app/views/redirect_to_next/first.html.erb
 - test/dummy/app/views/redirect_to_next/last_step.html.erb
 - test/dummy/app/views/redirect_to_next/second.html.erb
+- test/dummy/app/views/status_codes/bad.html.erb
+- test/dummy/app/views/status_codes/good.html.erb
 - test/dummy/app/views/step_positions/_step_position.html.erb
 - test/dummy/app/views/step_positions/first.html.erb
 - test/dummy/app/views/step_positions/last_step.html.erb
@@ -211,6 +215,7 @@ files:
 - test/test_helper.rb
 - test/wicked_test.rb
 - wicked.gemspec
+- wicked.png
 homepage: https://github.com/schneems/wicked
 licenses:
 - MIT
@@ -230,12 +235,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Use Wicked to turn your controller into a wizard
 test_files:
 - test/controllers/bar_controller_test.rb
+- test/controllers/status_codes_controller_test.rb
 - test/controllers/updates_controller_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
@@ -248,6 +254,7 @@ test_files:
 - test/dummy/app/controllers/pages_controller.rb
 - test/dummy/app/controllers/redirect_to_finish_flash_controller.rb
 - test/dummy/app/controllers/redirect_to_next_controller.rb
+- test/dummy/app/controllers/status_codes_controller.rb
 - test/dummy/app/controllers/step_positions_controller.rb
 - test/dummy/app/controllers/string_steps_controller.rb
 - test/dummy/app/controllers/update_params_controller.rb
@@ -275,6 +282,8 @@ test_files:
 - test/dummy/app/views/redirect_to_next/first.html.erb
 - test/dummy/app/views/redirect_to_next/last_step.html.erb
 - test/dummy/app/views/redirect_to_next/second.html.erb
+- test/dummy/app/views/status_codes/bad.html.erb
+- test/dummy/app/views/status_codes/good.html.erb
 - test/dummy/app/views/step_positions/_step_position.html.erb
 - test/dummy/app/views/step_positions/first.html.erb
 - test/dummy/app/views/step_positions/last_step.html.erb

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-
-sudo: false
-
-gemfile:
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-  - gemfiles/rails_6.0.1.gemfile
-
-jobs:
-  exclude:
-  - gemfile: gemfiles/rails_5.1.gemfile
-    rvm: 2.7.1