wicked 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 483905a170cbf0f6edace70c1673ba2c6cbcbeb6df0765ce8f86f73c5cf884f7
-  data.tar.gz: 6f9f288d5c14e26082666345d4e02191c62135743860bc4a15931fe2659132c9
+  metadata.gz: ebda68c36a8e0e08aa54c850b91c176720d5fa4897482d0312182c2bee6a418f
+  data.tar.gz: f7a27e0b7baafe854a3891d0ec185a425f6d0e57694325dd2597ca9f7f94d85b
 SHA512:
-  metadata.gz: 5cf319e58176f0985c111a4513f29580d5a3aa4161da881781021c77b6131f72166f00a8d68638938158030948c1b4e97ddd0ce5a8e95cb76557eb801c29de81
-  data.tar.gz: 6187eb1522ae0998571f21aa8580707445771f84a2d6d27d2aa3358c1508a9200e55f61050cb0be967580c305ec5e25a02be6c79f370d3b7b5f762ecb61d0c31
+  metadata.gz: bad278bb225e74a389efb8413290763b644625ff2bdc89213da99c7941b214abbdbfbc1e9e85c691a03196be064321f07d3c1222a2916c45bb6be3c425aee874
+  data.tar.gz: db3bdd321cc8902b9fa693e4884c567aa9fe474ad7fbe5cdd6f7452beec054ba9b21252441dabfd42e23adc94ee1e7fceac4bda07394d456c7cc36e65f50d82d

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

@@ -6,6 +6,7 @@ test/dummy/log/*.log
 test/dummy/tmp/
 .DS_Store
 .rvmrc
+.idea
 
 Gemfile.lock
 .ruby-version

data/.travis.yml

@@ -1,28 +1,17 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - 2.2.2
-  - ruby-head
-  - jruby-19mode
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 
 sudo: false
 
 gemfile:
-  - gemfiles/3.1.gemfile
-  - gemfiles/3.2.gemfile
-  - gemfiles/4.0.gemfile
-  - gemfiles/4.1.gemfile
-  - gemfiles/4.2.gemfile
-matrix:
-  include:
-    - gemfile: gemfiles/5.0.beta2.gemfile
-      rvm: 2.2.2
-  allow_failures:
-    - gemfile: gemfiles/3.0.gemfile
-      rvm: 2.0.0
-    - gemfile: gemfiles/3.0.gemfile
-      rvm: 2.1.1
-    - rvm: ruby-head
+  - 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

data/Appraisals

@@ -1,30 +1,11 @@
-appraise "3.1" do
-  gem "rails", "~> 3.1.0"
-  gemspec
+appraise "rails-5.1" do
+  gem "rails", "~> 5.2"
 end
 
-appraise "3.2" do
-  gem "rails", "~> 3.2.15"
-  gemspec
+appraise "rails-5.2" do
+  gem "rails", "~> 5.2"
 end
 
-appraise "4.0" do
-  gem "rails", "~> 4.0.0"
-  gemspec
-end
-
-appraise "4.1" do
-  gem "rails", "~> 4.1.0"
-  gemspec
-end
-
-
-appraise "4.2" do
-  gem "rails", "~> 4.2"
-  gemspec
-end
-
-appraise "5.0.beta2" do
-  gem "rails", "~> 5.0.0.beta2"
-  gemspec
+appraise "rails-6.0.1" do
+  gem "rails", "~> 6.0.1"
 end

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## Master
+## Unreleased
+
+## 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
 

data/Gemfile

@@ -1,10 +1,6 @@
 source "https://rubygems.org"
 
-
-# Put all runtime dependencies in wicked.gemspec
-# Put development requirements for different platforms here
-# Put more specific gem declarations in different gemfiles/*.gemfile files
-gemspec :path => ::File.expand_path("../.", __FILE__)
+gemspec
 
 group :development, :test do
   gem "sqlite3", :platform => [:ruby, :mswin, :mingw]

data/README.md

@@ -121,11 +121,17 @@ class AfterSignupController < ApplicationController
     @user = current_user
     case step
     when :confirm_password
-      @user.update_attributes(params[:user])
+      @user.update_attributes(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
 ```
 
@@ -171,12 +177,17 @@ Now you've got a fully functioning AfterSignup controller! If you have questions
 **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
+
+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, and are not absolute paths
+# These only work while in a Wizard
 # You can have multiple wizards in a project with multiple `wizard_path` calls
 ```
 
@@ -194,6 +205,7 @@ 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

data/gemfiles/rails_5.1.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_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.1.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.1"
+
+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/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,7 +25,6 @@ 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,
@@ -28,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

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

@@ -1,7 +1,6 @@
 module Wicked::Controller::Concerns::RenderRedirect
   extend ActiveSupport::Concern
 
-
   def render_wizard(resource = nil, options = {}, params = {})
     process_resource!(resource, options)
 

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

@@ -83,7 +83,6 @@ module Wicked::Controller::Concerns::Steps
     step ||= steps.first
   end
 
-
   def next_step(current_step = nil)
     return @next_step if current_step.nil?
     index = steps.index(current_step)
@@ -91,18 +90,15 @@ module Wicked::Controller::Concerns::Steps
     step  ||= Wicked::FINISH_STEP
   end
 
-  private
-
-  def step_index_for(step_name)
+  private def step_index_for(step_name)
     steps.index(step_name)
   end
 
-  def current_step_index
+  private def current_step_index
     step_index_for(step)
   end
 
-  def current_and_given_step_exists?(step_name)
+  private def current_and_given_step_exists?(step_name)
     current_step_index.present? && steps.index(step_name).present?
   end
 end
-

data/lib/wicked/version.rb

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

data/lib/wicked/wizard/translated.rb

@@ -57,7 +57,6 @@ module Wicked
       end
 
 
-      private
       # sets up a translated wizard controller
       # translations are expected under the 'wicked' namespace
       #
@@ -74,12 +73,10 @@ module Wicked
       #
       #     steps "wicked.first", "wicked.second"
       #
-      def setup_wizard_translated
+      private def setup_wizard_translated
         self.steps = wizard_translations.keys     # must come before setting previous/next steps
         setup_wizard
       end
-      public
     end
   end
 end
-

data/lib/wicked/wizard.rb

@@ -15,7 +15,6 @@ module Wicked
     end
 
     # Include the modules!!
-
     include Wicked::Controller::Concerns::Path
     include Wicked::Controller::Concerns::RenderRedirect
     include Wicked::Controller::Concerns::Steps
@@ -23,12 +22,12 @@ module Wicked
     included do
       include Wicked::Controller::Concerns::Action
       # Give our Views helper methods!
-      helper_method :wizard_path,     :next_wizard_path, :previous_wizard_path,
-                    :step,            :wizard_steps,     :current_step?,
-                    :past_step?,      :future_step?,     :previous_step?,
-                    :next_step?
+      helper_method :wizard_path, :wizard_url, :next_wizard_path, :next_wizard_url, :previous_wizard_path,
+                    :previous_wizard_url, :step, :wizard_steps, :current_step?, :past_step?, :future_step?,
+                    :next_step?,  :previous_step?
+
       # Set @step and @next_step variables
-      before_action :setup_wizard
+      before_action :initialize_wicked_variables, :setup_wizard
     end
 
     # forward to first step with whatever params are provided
@@ -41,14 +40,17 @@ module Wicked
       step_name
     end
 
-    private
+    private def initialize_wicked_variables
+      @skip_to = nil
+      @wicked_redirect_params = nil
+    end
 
-    def check_redirect_to_first_last!(step)
+    private def check_redirect_to_first_last!(step)
       redirect_to wizard_path(steps.first) if step.to_s == Wicked::FIRST_STEP
       redirect_to wizard_path(steps.last)  if step.to_s == Wicked::LAST_STEP
     end
 
-    def setup_step_from(the_step)
+    private def setup_step_from(the_step)
       return if steps.nil?
 
       the_step ||= steps.first
@@ -61,23 +63,21 @@ module Wicked
       the_step
     end
 
-    def check_steps!
+    private def check_steps!
       raise UndefinedStepsError if steps.nil?
     end
 
-    def set_previous_next(step)
+    private def set_previous_next(step)
       @previous_step = previous_step(step)
       @next_step     = next_step(step)
     end
 
-    def setup_wizard
+    private def setup_wizard
       check_steps!
       return if params[:id].nil?
 
       @step = setup_step_from(params[:id])
       set_previous_next(@step)
     end
-    public
   end
 end
-

data/lib/wicked/wizard_controller.rb

@@ -35,4 +35,3 @@ class Wicked::WizardController < ApplicationController
   #   render_wizard @user
   # end
 end
-

data/test/dummy/app/views/bar/first.html.erb

@@ -4,4 +4,6 @@ first
 <%= "params[:foo] #{params[:foo]}" %>
 <%= link_to 'last', wizard_path(:last_step) %>
 <%= link_to 'current', wizard_path %>
-<%= link_to 'skip', next_wizard_path %>
+<%= link_to 'current url', wizard_url %>
+<%= link_to 'skip', next_wizard_path %>
+<%= link_to 'next url', next_wizard_url %>

data/test/dummy/app/views/bar/second.html.erb

@@ -1,3 +1,4 @@
 second
 
-<%= link_to 'previous', previous_wizard_path %>
+<%= link_to 'previous', previous_wizard_path %>
+<%= link_to 'previous url', previous_wizard_url %>

data/test/integration/helpers_test.rb

@@ -5,13 +5,23 @@ class HelpersTest < ActiveSupport::IntegrationCase
   test 'next_wizard_path' do
     step = :first
     visit(bar_path(step))
+    assert has_link?('skip', href: '/bar/second')
     click_link 'skip'
     assert_has_content?('second')
   end
 
+  test 'next_wizard_url' do
+    step = :first
+    visit(bar_path(step))
+    assert has_link?('next url', href: 'http://www.example.com/bar/second')
+    click_link 'next url'
+    assert_has_content?('second')
+  end
+
   test 'wizard_path' do
     step = :first
     visit(bar_path(step))
+    assert has_link?('current', href: '/bar/first')
     click_link 'current'
     assert_has_content?(step.to_s)
   end
@@ -23,9 +33,26 @@ class HelpersTest < ActiveSupport::IntegrationCase
     assert_has_content?('last_step')
   end
 
+  test 'wizard_url' do
+    step = :first
+    visit(bar_path(step))
+    assert has_link?('current url', href: 'http://www.example.com/bar/first')
+    click_link 'current'
+    assert_has_content?(step.to_s)
+  end
+
   test 'previous_wizard_path' do
     step = :second
     visit(bar_path(step))
+    assert has_link?('previous', href: '/bar/first')
+    click_link 'previous'
+    assert_has_content?("first")
+  end
+
+  test 'previous_wizard_url' do
+    step = :second
+    visit(bar_path(step))
+    assert has_link?('previous url', href: 'http://www.example.com/bar/first')
     click_link 'previous'
     assert_has_content?("first")
   end

data/test/integration/security_test.rb

@@ -7,7 +7,6 @@ class SecurityTest < ActiveSupport::IntegrationCase
     assert_raise(Wicked::Wizard::InvalidStepError) do
       visit(bar_path(step))
     end
-    refute has_content?('sqlite3')
   end
 
   # only works on *nix systems
@@ -18,6 +17,5 @@ class SecurityTest < ActiveSupport::IntegrationCase
     assert_raise(Wicked::Wizard::InvalidStepError) do
       visit(bar_path(step))
     end
-    refute has_content?('aardvark')
   end
 end

data/test/test_helper.rb

@@ -1,15 +1,10 @@
 # Configure Rails Envinronment
 ENV["RAILS_ENV"] = "test"
 
-
-
 ENGINE_RAILS_ROOT=File.join(File.dirname(__FILE__), '../')
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
 
-
-
-
 ActionMailer::Base.delivery_method = :test
 ActionMailer::Base.perform_deliveries = true
 ActionMailer::Base.default_url_options[:host] = "test.com"
@@ -21,10 +16,15 @@ require "capybara/rails"
 Capybara.default_driver   = :rack_test
 Capybara.default_selector = :css
 
-
-
-# Run any available migration
-ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+# 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'
+  ActiveRecord::MigrationContext.new(migrate_path).migrate
+else
+  ActiveRecord::Migrator.migrate(migrate_path)
+end
 
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wicked
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Richard Schneeman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
@@ -97,12 +98,9 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- gemfiles/3.1.gemfile
-- gemfiles/3.2.gemfile
-- gemfiles/4.0.gemfile
-- gemfiles/4.1.gemfile
-- gemfiles/4.2.gemfile
-- gemfiles/5.0.beta2.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.1.gemfile
 - lib/wicked.rb
 - lib/wicked/controller/concerns/action.rb
 - lib/wicked/controller/concerns/path.rb
@@ -217,7 +215,7 @@ homepage: https://github.com/schneems/wicked
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -232,8 +230,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Use Wicked to turn your controller into a wizard
 test_files:

data/gemfiles/3.1.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 3.1.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/3.2.gemfile

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

data/gemfiles/4.0.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 4.0.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/4.1.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 4.1.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/4.2.gemfile

@@ -1,12 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 4.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/5.0.beta2.gemfile

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