ultra_light_wizard 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c477bed626ccfefdabaa81d8537e8e045db42feb
-  data.tar.gz: b5e197995d61a13d57ac1ca1fc932894212cdb4a
+  metadata.gz: c8aa77dc46a2504759cd6e587b87259a3c939541
+  data.tar.gz: db43b213bf6684703c6e5e05a4b2bd51709a7585
 SHA512:
-  metadata.gz: c4c0c47bbe0ebd1b983a6eab5c1e5635aa65a8ae4b2600638f0475a9f956e82c12a29fadacd5a3fb7604f197a252fc12c710fb35049e3e4899f7a4d7cc65da26
-  data.tar.gz: 785dfb392fcca6b2bb73115a2133a9b1cc3afc429ad0d2a38f7c61955b26c683088fe696d3f5222a5a6ba34e8276ee04e291056b52e31da2351b8a7dbeeef663
+  metadata.gz: 1f97a1b85a1532534b8cf9e05027cb4724d1261ebd107dc36d8c198f4397ce8e9e78f408e315a988b24a3491fec19c40d74b2f8bb8cde3026449195ebaca3351
+  data.tar.gz: a12fdbf28e420f159677fa1604b5c2627863faed215c6069a2812d2c583ab9183964e9d8d84002d3d6d8192b0ba2c3b79ddc1dd6ab817d00e8fbfc600fdc462e

data/README.md

@@ -1,5 +1,5 @@
-Ultra Light Wizard
-==================
+Ultra Light Wizard v0.1.0 (beta)
+================================
 
 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.
 
@@ -8,18 +8,32 @@ No time to manage a wizard state machine, session variables, or complicated cont
 This RailsConf 2014 talk video explains it all:
 https://www.youtube.com/watch?v=muyfoiKHMMA
 
+Principles
+==========
+
+- REST: wizard steps are represented as REST nested resources under the model resource being built
+- MVC: respects MVC separation of concerns
+- OO: honors OO principles of low coupling and high cohesion
+- Design Patterns: wizard is simply a model Builder
+- DDD: supports domain concepts directly with customizable vocabulary
+- Non-Functional Requirements:
+  - Productivity: minimum effort for adding wizards and wizard steps
+  - Maintainability: minimum code to maintain while adhering to other principles
+  - Performance: stateless design means scalability
+  - Security: stateless design is compatible with Rails security measures
+
 Instructions
 ============
 
 Simply use the following command in place of the Rails scaffold generator, and it will scaffold both standard resource and wizard components
 
-```rails generate ultra_light_wizard:wizard (resource) steps:(step1),(step2),(step3),... attributes:(attribute1:db_type1),(attribute2:db_type2),...```
+```rails generate ultra_light_wizard:scaffold (resource) steps:(step1),(step2),(step3),... attributes:(attribute1:db_type1),(attribute2:db_type2),...```
 
 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 attributes:name:string,description:text,start_date:date,delivery_date:date```
+```rails generate ultra_light_wizard:scaffold Project steps:basic_info,project_detail,file_uploads,preview attributes:name:string,description:text,start_date:date,delivery_date:date```
 
 Output:
 
@@ -58,7 +72,7 @@ generate  scaffold
   invoke  scss
 identical    app/assets/stylesheets/scaffolds.scss
 conflict  app/controllers/projects_controller.rb
-Overwrite /cygdrive/c/Users/a_mal_000/OneDrive/code/rails_example/app/controllers/projects_controller.rb? (enter "h" for help) [Ynaqdh] a
+Overwrite ~/code/rails_example/app/controllers/projects_controller.rb? (enter "h" for help) [Ynaqdh] a
    force  app/controllers/projects_controller.rb
   create  app/controllers/project_steps_controller.rb
   create  app/helpers/project_steps_helper.rb
@@ -78,13 +92,21 @@ resources :project_steps, 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 kick-off wizard, simply trigger the main model controller create action, and it will transition to the wizard step first step edit action.
+
+For example, the following will kick-off the project wizard by creating a project and automatically redirecting to first step:
+
+```<%= link_to 'New Project', projects_path, method: :post %>```
+
 It will ask you at one point to overwrite projects_controller generated in included scaffold. Type y or a to have it continue.
 
 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 attributes:name:string,description:text,start_date:date,delivery_date:date step_alias:part```
+```rails generate ultra_light_wizard:scaffold Project steps:basic_info,project_detail,file_uploads,preview attributes:name:string,description:text,start_date:date,delivery_date:date step_alias:part```
 
 Output:
 
@@ -123,7 +145,7 @@ generate  scaffold
   invoke  scss
 identical    app/assets/stylesheets/scaffolds.scss
 conflict  app/controllers/projects_controller.rb
-Overwrite /cygdrive/c/Users/a_mal_000/OneDrive/code/rails_example/app/controllers/projects_controller.rb? (enter "h" for help) [Ynaqdh] a
+Overwrite ~/code/rails_example/app/controllers/projects_controller.rb? (enter "h" for help) [Ynaqdh] a
    force  app/controllers/projects_controller.rb
   create  app/controllers/project_parts_controller.rb
   create  app/helpers/project_parts_helper.rb
@@ -143,50 +165,33 @@ 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 kick-off wizard, simply trigger the main model controller create action, and it will transition to the wizard step first step edit action.
-
-For example, the following will kick-off the project wizard by creating a project and automatically redirecting to first step:
-
-```<%= link_to 'New Project', projects_path, method: :post %>```
-
 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)
 
-Principles
-==========
-
-- REST: wizard steps are represented as REST nested resources under the model resource being built
-- MVC: respects MVC separation of concerns
-- OO: honors OO principles of low coupling and high cohesion
-- Design Patterns: wizard is simply a model Builder
-- DDD: supports domain concepts directly with customizable vocabulary
-- Non-Functional Requirements:
-  - Productivity: minimum effort for adding wizards and wizard steps
-  - Maintainability: minimum code to maintain while adhering to other principles
-  - Performance: stateless design means scalability
-  - Security: stateless design is compatible with Rails security measures
-
 Features
 ========
 
-- Wizard step generator (model part builder MVC components)
+- Ultra Light Wizard scaffold generator
+  + [DONE] Scaffolding of main model controller/views/migration
   + [DONE] Routes
   + [DONE] Controller steps
   + [DONE] Model parts
   + [DONE] View parts
   + [DONE] View navigation
-  + [DONE] Helper (or Controller SuperModule trait) for ultra light wizard support
+  + [DONE] Helper for ultra light wizard support
   + [DONE] Route helper methods
   + [DONE] Wizard kick-off helper/view
   + [DONE] Forms
-  - Form fields
-  + [DONE] Scaffolding of main model controller/views/migration
   + [DONE] Support for attributes
+  + [DONE] Form fields
+  + [DONE] Custom name conventions
+  - Write automated tests
   - Support for nested resources
   - Modularize (perhaps extracting sub-generators)
-  + [DONE] Customize name conventions
-  - Write automated tests
+
+Enhancements
+============
+
+If you are interested in having enhancements implemented, please report via a GitHub issue, describing the problem, providing use case examples, and suggesting solutions to implement. I'd be happy to implement as part of paid work if needed ASAP using the [CodeMentor platform](https://www.codementor.io/andymaleh).
 
 License
 =======

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.0

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

@@ -1,6 +1,7 @@
 <h1><%= file_path.humanize %> wizard</h1>
 <h2><%= step_alias.titleize %>: <%= @wizard_step.humanize %></h2>
 <%%= form_for <%= file_path %>_<%= step_alias %>_model, :url => current_<%= step_alias %>_path, :as => :<%= file_path %> do |f| %>
-  <%%# Please insert the fields of this particular step %>
+  <%%# TODO limit to fields of this particular step %>
+  <%= form_content(true) %>
   <%%= render '<%= step_alias %>_navigation', f: f %>
 <%% end %>

data/lib/generators/ultra_light_wizard/{wizard_generator.rb → scaffold_generator.rb}

@@ -1,6 +1,6 @@
 module UltraLightWizard
   module Generators
-    class WizardGenerator < Rails::Generators::NamedBase
+    class ScaffoldGenerator < Rails::Generators::NamedBase
       source_root File.expand_path("../../templates", __FILE__)
       def arguments
         args.inject({}) do |output, arg|
@@ -43,7 +43,7 @@ module UltraLightWizard
       end
 
       def scaffold_attributes
-        model_attributes.sub(',', ' ')
+        model_attributes.gsub(',', ' ')
       end
 
       def controller_attribute_names
@@ -58,9 +58,28 @@ module UltraLightWizard
         file_path.pluralize
       end
 
+      def arg_options
+        options.select {|key, value| value}.map {|key, value| "--#{key}"}.join(' ')
+      end
+
+      def form_content(execute=false)
+        if execute #prevents thor from executing too early
+          @form_content ||= lambda {
+            # TODO support formats other than html.erb like html.haml (autodetect)
+            scaffold_form_lines = File.new(Rails.root.join('app', 'views', plural_table_name, '_form.html.erb')).readlines
+            form_start_index = scaffold_form_lines.find_index {|line| line.include?('form')}
+            form_end_index =  scaffold_form_lines.length - 1 - scaffold_form_lines.reverse.find_index {|line| line.include?('actions')}
+            form_content_start_index = form_start_index + 1
+            form_content_end_index = form_end_index - 1
+            extracted_form_lines = scaffold_form_lines[form_content_start_index..form_content_end_index]
+            extracted_form_lines.join
+          }.()
+        end
+      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
-        generate "scaffold", "#{file_path} #{scaffold_attributes}"
+        generate "scaffold", "#{file_path} #{scaffold_attributes} #{arg_options}"
         template "app/controllers/model_controller.rb.erb", "app/controllers/#{file_path.pluralize}_controller.rb"
         template "app/controllers/wizard_steps_controller.rb.erb", "app/controllers/#{file_path}_#{step_alias.pluralize}_controller.rb"
         template "app/helpers/wizard_steps_helper.rb.erb", "app/helpers/#{file_path}_#{step_alias.pluralize}_helper.rb"

data/ultra_light_wizard.gemspec

@@ -2,16 +2,16 @@
 # 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.6 ruby lib
+# stub: ultra_light_wizard 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ultra_light_wizard"
-  s.version = "0.0.6"
+  s.version = "0.1.0"
 
   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-02-01"
+  s.date = "2016-02-14"
   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 = [
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
     "lib/generators/templates/app/models/wizard_step_model.rb.erb",
     "lib/generators/templates/app/views/wizard_step_navigation_view.html.erb",
     "lib/generators/templates/app/views/wizard_step_view.html.erb",
-    "lib/generators/ultra_light_wizard/wizard_generator.rb",
+    "lib/generators/ultra_light_wizard/scaffold_generator.rb",
     "lib/ultra_light_wizard.rb",
     "ruby187.Gemfile",
     "spec/spec_helper.rb",
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/AndyObtiva/ultra_light_wizard"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.6"
+  s.rubygems_version = "2.4.5.1"
   s.summary = "Ultra Light & Maintainable Wizards In Rails"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: ultra_light_wizard
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.8
 description: Ultra light & maintainble wizards in Rails that honor REST, MVC, and
@@ -33,8 +33,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .ruby-gemset
-- .ruby-version
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -47,7 +47,7 @@ files:
 - lib/generators/templates/app/models/wizard_step_model.rb.erb
 - lib/generators/templates/app/views/wizard_step_navigation_view.html.erb
 - lib/generators/templates/app/views/wizard_step_view.html.erb
-- lib/generators/ultra_light_wizard/wizard_generator.rb
+- lib/generators/ultra_light_wizard/scaffold_generator.rb
 - lib/ultra_light_wizard.rb
 - ruby187.Gemfile
 - spec/spec_helper.rb
@@ -64,17 +64,17 @@ 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.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ultra Light & Maintainable Wizards In Rails