wicked 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1830f26475c47d09c4ef96c6da9b8ea9ed4229e5
-  data.tar.gz: 26aacf9b06cf1a3640850fedac063a34640c9219
+SHA256:
+  metadata.gz: eb950926820837e2ebfd752237b01d22a38186c6073642f9c2c3fbf94da96fb3
+  data.tar.gz: 8eddcdf3391ac3d8e881c75624b431cafb54ccc956d488f6a1f975f02aff0c8d
 SHA512:
-  metadata.gz: 9af83dcfe6c322566f4ef3eccacccaa697d13730782b3fb3a2dcadf97c2816000db720fe77a6d49e4ba2511b5a84607992abda5bf1c59b52fdd99212a952578a
-  data.tar.gz: 05c1f6c605724a99df9320a5e0e1f16372c2f762b834e70bdc9c23a776dca161e614603f357074fe4349f20afba05478608bbb674bd187f8359195833c7c4126
+  metadata.gz: b33ad97299a460547b255c6774c6961d0c6ee0d9721ca9db04dbc26b7e37b606aaddd7a8a93dda1e6bc60e2b3418ac103bbca53bd76815cf65796acaaabc32fe
+  data.tar.gz: 4d5c337fb136b16a2468ba1f456f77db7f73600280fa5966e5c9f4d95bf01932aa61fb0bc5651a13974d259513dc7d6e353287e8b1daaf3488a6db157a7f1016

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,13 @@
+name: Check Changelog
+
+on:
+ pull_request:
+  types: [opened, reopened, edited, synchronize]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

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/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+.DS_Store
+.rvmrc
+.idea
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+gemfiles/*.lock
+*.gem

data/Appraisals

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

data/CHANGELOG.md

@@ -1,3 +1,48 @@
+## 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)
+* Add `*_url` versions of `wizard_path`, `next_wizard_path`, and `previous_wizard_path` (https://github.com/zombocom/wicked/pull/272)
+
+## 1.3.4
+
+* Remove arity check for AR objects (https://github.com/schneems/wicked/pull/257)
+
+## 1.3.3
+
+* Support being able to set a context in validation (https://github.com/schneems/wicked/pull/236)
+
+## 1.3.2
+
+* Support for params (#222)
+
+## 1.3.1
+
+* Docs and minor fixes
+
+## 1.3.0
+
+* [#201] Avoid Rails 5 deprecations.
+
+## 1.2.1 (8/28/2015)
+
+* [#186] Do not require use of ApplicationController with wicked.
+
+## 1.1.1 (2/23/2015)
+
+* [#159] Default wizard index actions now work when using `default_url_options`
+
+## 1.1.0 (9/15/2014)
+
+* [#136] `skip_step` and `jump_to` now take redirect options. You can use
+this to effectively pass parameters to a redirect initiated by either of these method.
+
 ## 1.0.3 (4/25/2014)
 
 * All `to_sym` have been removed. Symbol attacks are no longer possible.

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+There are two main ways to contribute to this project.
+
+## Content
+
+* Write articles
+* Recording screencasts
+* Submit presentations
+
+## Development
+
+Using [CodeTriage](http://www.codetriage.com/schneems/wicked) as a volunteer, you'll receive an email each day with a link to an open issue that needs to be triaged in this project. You'll also receive instructions on how to triage issues.
+
+1. Fork it! ( https://github.com/schneems/wicked/fork )
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Create a new Pull Request :D

data/Gemfile

@@ -1,25 +1,8 @@
 source "https://rubygems.org"
 
-rails_version = ENV["RAILS_VERSION"] || "default"
-
-rails = case rails_version
-when "master"
-  {:github => "rails/rails"}
-when "default"
-  ">= 3.0.7"
-else
-  "~> #{rails_version}"
-end
-
-gem "rails", rails
-
+gemspec
 
 group :development, :test do
-  gem 'rake'
-  gem 'jeweler'
-  gem "capybara", "~> 1.1.2"
-  gem "launchy"
-
-  gem "sqlite3",                          :platform => [:ruby, :mswin, :mingw]
-  gem "activerecord-jdbcsqlite3-adapter", '>= 1.3.0.beta', :platform => :jruby
+  gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", '~> 1.3.13', :platform => :jruby
 end

data/README.md

@@ -1,9 +1,11 @@
-![](http://cl.ly/image/3O2i1P061o3y/content.png)
+![](./wicked.png)
 
 # Step-By-Step Wizard Controllers
 
-[![Build Status](https://secure.travis-ci.org/schneems/wicked.png)](http://travis-ci.org/schneems/wicked)
-[![Code Climate](https://codeclimate.com/github/schneems/wicked.png)](https://codeclimate.com/github/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)
+
 
 Use wicked to make your Rails controllers into step-by-step wizards. To see Wicked in action check out the example [Rails app](https://github.com/schneems/wicked_example) or [watch the screencast](http://schneems.com/post/18437886598/wizard-ify-your-rails-controllers-with-wicked).
 
@@ -28,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
@@ -119,16 +122,23 @@ class AfterSignupController < ApplicationController
     @user = current_user
     case step
     when :confirm_password
-      @user.update_attributes(params[:user])
+      @user.update(user_params)
     end
     sign_in(@user, bypass: true) # needed for devise
     render_wizard @user
   end
+  
+  private
+  def user_params
+    params.require(:user)
+          .permit(:email, :current_password) # ...
+  end
 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` might work better.
 
 To get to this update action, you simply need to submit a form that PUT's to the same url
 
@@ -165,34 +175,61 @@ Now you've got a fully functioning AfterSignup controller! If you have questions
 
 ## Quick Reference
 
-View/URL Helpers
+**View/URL Helpers:**
 
 ```ruby
-wizard_path                  # Grabs the current path in the wizard
-wizard_path(:specific_step)  # Url of the :specific_step
-next_wizard_path             # Url of the next step
-previous_wizard_path         # Url of the previous step
+wizard_path                  # relative url of the current step
+wizard_path(:specific_step)  # relative url of a :specific_step
+next_wizard_path             # relative url of the next step
+previous_wizard_path         # relative url of the previous step
 
-# These only work while in a Wizard, and are not absolute paths
+wizard_url                  # fully qualified url of the current step
+wizard_url(:specific_step)  # fully qualified url of a :specific_step
+next_wizard_url             # fully qualified url of the next step
+previous_wizard_url         # fully qualified url of the previous step
+
+# These only work while in a Wizard
 # You can have multiple wizards in a project with multiple `wizard_path` calls
 ```
 
 
-Controller Tidbits:
+**Controller Tidbits:**
 
 ```ruby
-steps  :first, :second       # Sets the order of steps
-step                         # Gets current step
-next_step                    # Gets next step
-previous_step                # Gets previous step
-skip_step                    # Tells render_wizard to skip to the next logical step
-jump_to(:specific_step)      # Jump to :specific_step
-render_wizard                # Renders the current step
-render_wizard(@user)         # Shows next_step if @user.save, otherwise renders current step
+steps  :first, :second                        # Sets the order of steps
+step                                          # Gets current step
+next_step                                     # Gets next step
+previous_step                                 # Gets previous step
+skip_step                                     # Tells render_wizard to skip to the next logical step
+jump_to(:specific_step)                       # Jump to :specific_step
+render_wizard                                 # Renders the current step
+render_wizard(@user)                          # Shows next_step if @user.save, otherwise renders
+render_wizard(@user, context: :account_setup) # Shows next_step if @user.save(context: :account_setup), otherwise renders
+wizard_steps                                  # Gets ordered list of steps
+current_step?(step)                           # is step the same as the current request's step
+past_step?(step)                              # does step come before the current request's step in wizard_steps
+future_step?(step)                            # does step come after the current request's step in wizard_steps
+previous_step?(step)                          # is step immediately before the current request's step
+next_step?(step)                              # is step immediately after the current request's step
+```
+
+**Redirect options**
+
+Both `skip_step` and `jump_to` will cause a redirect.
+
+```
+skip_step(foo: "bar")
 ```
 
+*Note that unlike you would do when making a call to Rails' `redirect_to`, you should not call `return` immediately after `skip_step` and `jump_to`, since the actual redirection is done in the render_wizard call.*
 
-Finally:
+If you want to pass params to the step you are skipping to you can pass it into those:
+
+```
+jump_to(:specific_step, foo: "bar")
+```
+
+**Finally:**
 
 Don't forget to create your named views
 
@@ -206,7 +243,7 @@ app/
 ```
 
 
-# Finish Wizard Path
+## Finish Wizard Path
 
 You can specify the url that your user goes to by over-riding the `finish_wizard_path` in your wizard controller.
 
@@ -217,18 +254,16 @@ def finish_wizard_path
 end
 ```
 
-
 ### Testing with RSpec
 
 ```ruby
 # Test find_friends block of show action
-get :show, id: :find_friends
+get :show, params: { id: :find_friends }
 
 # Test find_friends block of update action
-put :update, {'id' => 'find_friends', "user" => { "id" => @user.id.to_s }}
+patch :update, params: {'id' => 'find_friends', "user" => { "id" => @user.id.to_s }}
 ```
 
-
 ### Internationalization of URLS (I18n)
 
 If your site works in multiple languages, or if you just want more control over how your URLs look you can now use I18n with wicked. To do so you need to replace this:
@@ -262,7 +297,7 @@ es:
 It would also be a good idea to create a english version under `config/locales/en.yml` or your english speaking friends will get errors. If your app already uses I18n you don't need to do anything else, if not you will need to make sure that you set the `I18n.locale` on each request you could do this somewhere like a before filter in your application_controller.rb
 
 ```ruby
-before_filter :set_locale
+before_action :set_locale
 
 private
 
@@ -305,7 +340,6 @@ end
 
 Instead you need to use `wizard_value` to get the "reverse translation" in your controller code like this:
 
-
 ```ruby
 steps :confirm_password, :confirm_profile, :find_friends
 
@@ -347,8 +381,9 @@ Now you can change the values in the URLs to whatever you want without changing
 ```ruby
 config.i18n.default_locale = :de
 ```
+
 **Important:** Don't forget to use `wizard_value()` method to make
-sure you are using the right cannonical values of `step`,
+sure you are using the right canonical values of `step`,
 `previous_step`, `next_step`, etc. If you are comparing them to non
 wicked generate values.
 
@@ -356,11 +391,12 @@ Custom crafted wizard urls: just another way Wicked makes your app a little more
 
 ## Dynamic Step Names
 
-If you wish to set the order of your steps dynamically you can do this with a `prepend_before_filter` and `self.steps =` like this:
+If you wish to set the order of your steps dynamically you can do this by manually calling  and `self.steps = [# <some steps> ]` in a `before_action` method. Then call `before_action :setup_wizard` after so that wicked knows when it is safe to initializelike this:
 
 ```ruby
 include Wicked::Wizard
-prepend_before_filter :set_steps
+before_action :set_steps
+before_action :setup_wizard
 
 # ...
 
@@ -374,6 +410,41 @@ def set_steps
 end
 ```
 
+NOTE: The order of the `before_action` matters, when `setup_wizard` is called it will validate the presence of `self.steps`, you must call your custom step setting code before this point.
+
+## Send params to finish_wizard_path method
+
+If you wish to send parameters to the `finish_wizard_path` method that can be done by adding to your controller the method with the params argument `def finish_wizard_path(params) ... end`.
+
+In order to send the parameters to the method here is an example of the show method:
+
+```ruby
+steps :first_step, :second_step
+
+def show
+  # ...
+  render_wizard(nil, {}, { hello: 'world' })
+end
+
+def update
+  # ...
+  render_wizard(@user, {}, { hello: 'world' })
+end
+
+def finish_wizard_path(params)
+  # here you can access params and that would be equal to { hello: 'world' }
+end
+```
+
+The `wizard_path` and `next_wizard_path` methods also take parameters that can then be accessed or visible in the `show` and `update` actions of the controller. You can use the methods like so:
+
+```ruby
+next_wizard_path({ hello: 'world' })
+wizard_path(nil, { hello: 'world' })
+# the wizard_path with the step specified would look like this
+wizard_path(:wicked_finish, wizard_id: @user.id, hello: 'world')
+```
+
 ## Keywords
 
 There are a few "magical" keywords that will take you to the first step,
@@ -389,15 +460,59 @@ Wicked::FINISH_STEP
 ```
 
 You can build links using these constants
-`after_signup_path(Wicked::LAST_STEP)` which will redirect the user to
+`after_signup_path(Wicked::FIRST_STEP)` which will redirect the user to
 the first step you've specified. This might be useful for redirecting a
 user to a step when you're not already in a Wicked controller. If you
-change the step names, they are expected to be strings (not symbols).
+change the constants, they are expected to be strings (not symbols).
 
-## About
+## Support
+
+Most problems using this library are general problems using Ruby/Rails. If you cannot get something to work correctly please open up a question on [stack overflow](http://stackoverflow.com/). If you've not posted there before, provide a description of the problem you're having and usually some example code and a copy of your rails logs helps.
 
-Please poke around the source code, if you see easier ways to get a Rails controller to do what I want, let me know.
+If you've found a bug, please open a ticket on the issue tracker with a small example app that reproduces the behavior.
+
+## About
 
-If you have a question file an issue or, find me on the Twitters [@schneems](http://twitter.com/schneems).
+Made by [@schneems](http://twitter.com/schneems).
 
 This project rocks and uses MIT-LICENSE.
+
+## Compatibility
+
+Refer to the Travis CI test matrix for test using your version of Ruby and Rails. If there is a newer Ruby or Rails you don't see on there, please add an entry to the Appraisals file, then run `$ appraisals install` and update the `.travis.yml` file and send me a pull request.
+
+Note: Rails 3.0 support is only for Ruby 1.9.3 or JRuby, not Ruby 2.0.0 or newer.
+
+## Running Gem Tests
+
+First, install the development gems:
+
+```
+$ bundle install
+```
+
+Now that `appraisal` is installed, use it to set up all the gemfiles for the test matrix:
+
+```
+$ appraisal install
+```
+
+Then to run tests against all the appraisal gemfiles, use:
+
+```
+$ appraisal rake test
+```
+
+To run tests against one specific gemfile,
+use
+
+```
+$ appraisal 4.1 rake test
+```
+
+Note that Rails 3.0 tests don't pass in Ruby 2.0.0 or newer, so during development it may be easier to disable this
+gemfile if you are using a current version of Ruby.
+
+## Contributing
+
+See the [Contributing guide](https://github.com/schneems/wicked/blob/master/CONTRIBUTING.md).

data/Rakefile

@@ -2,6 +2,8 @@
 require 'rubygems'
 require 'bundler'
 
+require 'bundler/gem_tasks'
+
 begin
   Bundler.setup(:default, :development, :test)
 rescue Bundler::BundlerError => e
@@ -33,18 +35,3 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
 end
 
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name        = "wicked"
-  gem.homepage    = "http://github.com/schneems/wicked"
-  gem.license     = "MIT"
-  gem.summary     = %Q{Use Wicked to turn your controller into a wizard}
-  gem.description = %Q{Wicked is a Rails engine for producing easy wizard controllers}
-  gem.email       = "richard.schneeman@gmail.com"
-  gem.authors     = ["schneems"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2"
+
+group :development, :test do
+  gem "sqlite3", platform: [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.13", platform: :jruby
+end
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0"
+
+group :development, :test do
+  gem "sqlite3", platform: [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.13", platform: :jruby
+end
+
+gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0"
+
+group :development, :test do
+  gem "sqlite3", platform: [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.13", platform: :jruby
+end
+
+gemspec path: "../"

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

@@ -0,0 +1,13 @@
+module Wicked::Controller::Concerns::Action
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def self.extended(base)
+      %w{before skip_before prepend_before}.each do |action|
+        define_method "#{action}_action" do |*names, &blk|
+          send("#{action}_filter", *names, &blk)
+        end unless base.respond_to? "#{action}_action"
+      end
+    end
+  end
+end

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

@@ -1,15 +1,22 @@
 module Wicked::Controller::Concerns::Path
   extend ActiveSupport::Concern
 
-
   def next_wizard_path(options = {})
     wizard_path(@next_step, options)
   end
 
+  def next_wizard_url(options = {})
+    wizard_url(@next_step, options)
+  end
+
   def previous_wizard_path(options = {})
     wizard_path(@previous_step, options)
   end
 
+  def previous_wizard_url(options = {})
+    wizard_url(@previous_step, options)
+  end
+
   def wicked_controller
     params[:controller]
   end
@@ -18,8 +25,8 @@ module Wicked::Controller::Concerns::Path
     params[:action]
   end
 
-
   def wizard_path(goto_step = nil, options = {})
+    options = options.respond_to?(:to_h) ? options.to_h : options
     options = { :controller => wicked_controller,
                 :action     => 'show',
                 :id         => goto_step || params[:id],
@@ -27,5 +34,8 @@ module Wicked::Controller::Concerns::Path
                }.merge options
     url_for(options)
   end
-end
 
+  def wizard_url(goto_step = nil, options = {})
+    wizard_path(goto_step, options.merge(only_path: false))
+  end
+end