ultra_light_wizard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f6a677b2537b3df14e59d1d579862c4fa106e41
+  data.tar.gz: 64b413b744fe3da9527ad49cce13979a53023067
+SHA512:
+  metadata.gz: fe2a44cc2140f924f60f37aba9bf76049652fecd1719de26a419a10f0e96218cb0fa7a1ba816794b70869e83f5c4d2922557d0cd2ac39699a9ac40aa0be9731b
+  data.tar.gz: d36a12dc2cac94d1e72a72f2490a904ab239f28689c897826c22e3a1e11d659d03dd86a0072ad0e6474bf6aa4d7a4e99f87e4a83a5f537271eddcc0e2cd8ebd8

data/.ruby-gemset

@@ -0,0 +1 @@
+ultra_light_wizard

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'coveralls'
+end

data/Gemfile.lock

@@ -0,0 +1,81 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mime-types (2.0)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  jeweler
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Andy Maleh
+
+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.

data/README.md

@@ -0,0 +1,80 @@
+Ultra Light Wizard
+==================
+
+No time to manage a wizard state machine, session variables, or complicated controllers? Use Ultra Light Wizard!! A RESTful session-less validation-friendly simple wizard approach in Rails.
+
+Watching this video explains it all:
+https://www.youtube.com/watch?v=muyfoiKHMMA
+
+Instructions
+============
+
+rails generate ultra_light_wizard:wizard (resource) steps=(step1),(step2),(step3),...
+
+This will generate wizard step routes, controller, models, and views
+
+Example:
+
+rails generate ultra_light_wizard:wizard Project steps:basic_info,project_detail,file_uploads,preview
+
+Output:
+
+```
+create  app/controllers/project_steps_controller.rb
+create  app/models/project/basic_info.rb
+create  app/views/project_steps/basic_info.html.erb
+create  app/models/project/project_detail.rb
+create  app/views/project_steps/project_detail.html.erb
+create  app/models/project/file_uploads.rb
+create  app/views/project_steps/file_uploads.html.erb
+create  app/models/project/preview.rb
+create  app/views/project_steps/preview.html.erb
+ route  resources :projects, only: [:create, :show] do
+resources :project_steps, only: [:edit, :update]
+end
+```
+
+If you'd like to customize the term "step", you can add a step_alias:(alias) option as in the following:
+
+Example:
+
+rails generate ultra_light_wizard:wizard Project steps:basic_info,project_detail,file_uploads,preview step_alias:part
+
+Output:
+
+```
+create  app/controllers/project_parts_controller.rb
+create  app/models/project/basic_info.rb
+create  app/views/project_parts/basic_info.html.erb
+create  app/models/project/project_detail.rb
+create  app/views/project_parts/project_detail.html.erb
+create  app/models/project/file_uploads.rb
+create  app/views/project_parts/file_uploads.html.erb
+create  app/models/project/preview.rb
+create  app/views/project_parts/preview.html.erb
+ route  resources :projects, only: [:create, :show] do
+resources :project_parts, only: [:edit, :update]
+end
+```
+
+Once the files are generated, you can proceed to place your own code customizations in the wizard step models and views.
+
+To learn more about the Ultra Light Wizard philosophy and function, please read this [Code Painter](http://www.codepainter.ca) blog post: [Ultra Light & Maintainable Wizard in Rails] (http://www.codepainter.ca/2013/10/ultra-light-maintainable-wizards-in.html)
+
+TODO
+====
+
+- Wizard step generator (model part builder MVC components)
+  + Routes
+  + Controller steps
+  + Model parts
+  + View parts
+  - Helper (or Controller SuperModule trait) for ultra light wizard support
+  - Support for nested resources
+  - Modularize (perhaps extracting sub-generators)
++ Customize name conventions
+
+License
+=======
+
+MIT

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+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 = "ultra_light_wizard"
+  gem.homepage = "http://github.com/AndyObtiva/ultra_light_wizard"
+  gem.license = "MIT"
+  gem.summary = %Q{Ultra Light & Maintainable Wizards In Rails}
+  gem.description = %Q{Ultra light & maintainble wizards in Rails that honor REST, MVC, and OO with minimal writing of code involved and maximum flexibility}
+  gem.email = "andy.am@gmail.com"
+  gem.authors = ["Andy Maleh"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ultra_light_wizard #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/generators/templates/app/controllers/wizard_steps_controller.rb.erb

@@ -0,0 +1,53 @@
+class <%= class_name %><%= step_alias.pluralize.camelize %>Controller < ApplicationController
+  before_action :authorize_<%= file_path %>
+
+  <%= step_alias.pluralize.upcase %> = %w(<%= steps.to_a.join(' ') %>)
+
+  def edit
+      if <%= file_path %>_<%= step_alias %>_model.editable?
+        if <%= step_alias %>.present?
+          render <%= step_alias %>
+        else
+          render "#{Rails.root.to_s}/public/404.html", :layout => false, :status => 404
+        end
+      else
+        redirect_to :back, :alert => I18n.t("<%= file_path %>.#{@<%= file_path %>.status}_editable_error")
+      end
+  end
+
+  def update
+    if <%= file_path %>_<%= step_alias %>_model.update_attributes(params[:<%= file_path %>])
+      if next_<%= step_alias %> && params[:commit].downcase.include?('continue')
+        redirect_to edit_<%= file_path %>_<%= file_path %>_<%= step_alias %>_path(<%= file_path %>_<%= step_alias %>_model, next_<%= step_alias %>)
+      else
+        redirect_to <%= file_path %>_path(@<%= file_path %>)
+      end
+    else
+      render <%= step_alias %>, :error => "Please complete all required fields"
+    end
+  end
+
+  private
+
+  def authorize_<%= file_path %>
+    @<%= file_path %> = <%= file_path %>_<%= step_alias %>_model
+    if @<%= file_path %>.user_id != current_user.id && !current_user.is_admin?
+      render(:file => "#{Rails.root.to_s}/public/403.html", :layout => false, :status => 403)
+    end
+  end
+
+  def <%= file_path %>_<%= step_alias %>_model
+    <%= file_path %>_class = "<%= class_name %>::#{<%= step_alias %>.camelcase}".constantize rescue <%= class_name %>
+    <%= file_path %>_class.find(params[:<%= file_path %>_id])
+  end
+
+  def <%= step_alias %>
+    <%= step_alias.pluralize.upcase %>.find {|a_<%= step_alias %>| a_<%= step_alias %> == params[:id].to_s.downcase}
+  end
+
+  def next_<%= step_alias %>
+    current_<%= step_alias %>_index = <%= step_alias.pluralize.upcase %>.index(<%= step_alias %>)
+    next_<%= step_alias %> = <%= step_alias.pluralize.upcase %>[current_<%= step_alias %>_index+1]
+  end
+
+end

data/lib/generators/templates/app/models/wizard_step_model.rb.erb

@@ -0,0 +1,2 @@
+class <%= class_name %>::<%= @wizard_step.camelize %> < <%= class_name %>
+end

data/lib/generators/templates/app/views/wizard_step_view.html.erb

@@ -0,0 +1,2 @@
+<h1><%= file_path.humanize %> wizard</h1>
+<h2><%= step_alias.titleize %>: <%= @wizard_step.humanize %></h2>

data/lib/generators/ultra_light_wizard/wizard_generator.rb

@@ -0,0 +1,38 @@
+module UltraLightWizard
+  module Generators
+    class WizardGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../../templates", __FILE__)
+      def arguments
+        args.inject({}) do |output, arg|
+          arg_parts = arg.split(':')
+          output.merge(arg_parts.first => arg_parts.last)
+        end
+      end
+
+      def step_alias
+        arguments['step_alias'] || 'step'
+      end
+
+      def steps
+        arguments['steps'].to_s.split(',').map(&:strip)
+      end
+
+      desc "Creates a configuration file for a specific application context (e.g. admin). Takes context path as argument (e.g. admin or internal/wiki) to create config/features/[context_path].yml"
+      def copy_config
+        template "app/controllers/wizard_steps_controller.rb.erb", "app/controllers/#{file_path}_#{step_alias.pluralize}_controller.rb"
+        steps.each do |step|
+          @wizard_step = step
+          template "app/models/wizard_step_model.rb.erb", "app/models/#{file_path}/#{step}.rb"
+          template "app/views/wizard_step_view.html.erb", "app/views/#{file_path}_#{step_alias.pluralize}/#{step}.html.erb"
+        end
+        wizard_route_content = <<-CONTENT
+resources :#{plural_file_name}, only: [:create, :show] do
+    resources :#{file_path}_#{step_alias.pluralize}, only: [:edit, :update]
+  end
+        CONTENT
+        routes_content = File.new(Rails.root.join('config', 'routes.rb')).read
+        route wizard_route_content unless routes_content.include?(wizard_route_content)
+      end
+    end
+  end
+end

data/ruby187.Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'rspec'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+ENV['APP_ENV'] = 'test'
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+if RUBY_VERSION >= '1.9'
+  begin
+    require 'coveralls'
+    Coveralls.wear!
+  rescue LoadError, StandardError
+    #no op to support Ruby 1.8.7, ree and Rubinius which do not support Coveralls
+  end
+end
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ultra_light_wizard')

data/ultra_light_wizard.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: ultra_light_wizard 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "ultra_light_wizard"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Andy Maleh"]
+  s.date = "2016-01-26"
+  s.description = "Ultra light & maintainble wizards in Rails that honor REST, MVC, and OO with minimal writing of code involved and maximum flexibility"
+  s.email = "andy.am@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".ruby-gemset",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/templates/app/controllers/wizard_steps_controller.rb.erb",
+    "lib/generators/templates/app/models/wizard_step_model.rb.erb",
+    "lib/generators/templates/app/views/wizard_step_view.html.erb",
+    "lib/generators/ultra_light_wizard/wizard_generator.rb",
+    "lib/ultra_light_wizard.rb",
+    "ruby187.Gemfile",
+    "spec/spec_helper.rb",
+    "spec/ultra_light_wizard/ultra_light_wizard_spec.rb",
+    "ultra_light_wizard.gemspec"
+  ]
+  s.homepage = "http://github.com/AndyObtiva/ultra_light_wizard"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "Ultra Light & Maintainable Wizards In Rails"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ultra_light_wizard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Maleh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ultra light & maintainble wizards in Rails that honor REST, MVC, and
+  OO with minimal writing of code involved and maximum flexibility
+email: andy.am@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/generators/templates/app/controllers/wizard_steps_controller.rb.erb
+- lib/generators/templates/app/models/wizard_step_model.rb.erb
+- lib/generators/templates/app/views/wizard_step_view.html.erb
+- lib/generators/ultra_light_wizard/wizard_generator.rb
+- lib/ultra_light_wizard.rb
+- ruby187.Gemfile
+- spec/spec_helper.rb
+- spec/ultra_light_wizard/ultra_light_wizard_spec.rb
+- ultra_light_wizard.gemspec
+homepage: http://github.com/AndyObtiva/ultra_light_wizard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ultra Light & Maintainable Wizards In Rails
+test_files: []