mage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f5683b046e4441b7bdf7b9634844d3060794f52
+  data.tar.gz: 018f52b8564cb24285328e83a83f3a8b0984bba4
+SHA512:
+  metadata.gz: d5402a3640a1a4ca7104944d938a7f57084c2c430d1cbab31c3cb928b09993f69a13b3e915cb99e64f89f8a99b0bcfeb023fb358bbffc648b8bd265d899e2992
+  data.tar.gz: 0c69e4ae1b9e309a5afc3c62b0c395caa0fc7899a35c06e26b7774ce00cf255e7c6be59b6fd245ef36ac3944335c76de0ecac03b6665315d7cd33f0de85cc3cc

data/.gitignore

@@ -0,0 +1,9 @@
+g/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 effect305
+
+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,112 @@
+# Mage
+
+Mage can be used for making model creation wizards with step by step validations in Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mage', git: 'git://github.com/effect305/mage.git'
+```
+
+And then execute:
+
+    $ bundle install
+
+After that migrate your database:
+
+    $ rake db:migrate
+
+## Usage
+
+Define steps in your model:
+
+```ruby
+class Product < ActiveRecord::Base
+  has_mage_steps :name, :price, :category
+end
+```
+
+Add validations for each step, using mage_step_STEPNAME? syntax:
+
+```ruby
+  validates :name, presence: true, if: :mage_step_name?
+  validates :price, presence: true, if: :mage_step_price?
+  validates :category, presence: true, if: :mage_step_category?
+```
+
+You can use also custom validators or anything you want, just define on which step they should be run.
+Also bear in mind that each step runs validations of all previous steps. Step increases after
+successful save of the object.
+
+After that create steps subdirectory in views directory of your controller.
+
+    $ mkdir app/views/products/steps
+
+Put there templates for each step, naming them like steps. You can use form_for helper in your templates:
+
+```ruby
+<h1>Creating new product, step 1</h1>
+<%= form_for @product do |f| %>
+    <%= f.label :name %>
+    <%= f.text_field :name %>
+    <%= f.submit %>
+<% end %>
+```
+
+And the main part, it's time to set up your controller! Use render_mage method with your object as argument
+in each place that you want to render wizard. This method will render necessary template from steps directory
+according to the state of the object.
+
+```ruby
+  def new
+    @product = Product.new
+    render_mage(@product)
+  end
+
+  def create
+    @product = Product.new(product_params)
+    @product.save
+    render_mage(@product)
+  end
+
+  def edit
+    @product = Product.find(params[:id])
+    render_mage(@product)
+  end
+
+  def update
+    @product = Product.find(params[:id])
+    @product.update(product_params)
+    render_mage(@product)
+    redirect_to product_path(@product)
+  end
+```
+
+Take a look at update action in our example, there's redirect_to method after render_mage. Yes, this code
+will be executed only if your object is finished wizard, if not - wizard will be rendered, and all the code
+below render_mage won't be executed, so you don't need to worry about that.
+
+Also if tou want to show current step in url as a param, you can use show_step option each time you call
+render_mage method like this:
+
+```ruby
+render_mage(@product, show_step: true)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/effect305/mage.
+
+## ToDo
+
+I think there's a lot of stuff to do. Here's just examples:
+* Keep flash messages if showing step
+* Generator
+* Tests
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/db/migrate/20160407080915_create_mage_steps.rb

@@ -0,0 +1,10 @@
+class CreateMageSteps < ActiveRecord::Migration
+  def change
+    create_table :mage_steps do |t|
+      t.belongs_to(:object, polymorphic: true)
+      t.string :step
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/mage.rb

@@ -0,0 +1,76 @@
+require 'mage/version'
+
+module Mage
+  class WizardRendered < Exception
+  end
+
+  class MageStep < ActiveRecord::Base
+    belongs_to :object, polymorphic: true
+  end
+end
+
+class ActiveRecord::Base
+  def self.has_mage_steps(*steps)
+    @@mage_steps = steps
+    after_save :mage_after_save
+    after_destroy { Mage::MageStep.where(object_id: self.id, object_type: self.model_name.name).try(:take).try(:destroy) }
+
+    define_method :mage_steps do
+      @@mage_steps
+    end
+
+    instance_eval do
+      define_method :mage_step do
+        Mage::MageStep.where(object_id: self.id, object_type: self.model_name.name)
+            .try(:take).try(:step).try(:to_sym) || @@mage_steps.first
+      end
+
+      steps.each_with_index do |step, index|
+        define_method "mage_step_#{step}?" do
+          index <= (@@mage_steps.find_index(mage_step) || @@mage_steps.count)
+        end
+      end
+
+      define_method :mage_after_save do
+        if mage_step != :done
+          mage_model = Mage::MageStep.where(object_id: id, object_type: model_name.name).try(:take) ||
+              Mage::MageStep.create(object_id: id, object_type: model_name.name, step: mage_step)
+          mage_model.update(step: (@@mage_steps[@@mage_steps.find_index(mage_step) + 1] || :done))
+        end
+      end
+
+      private :mage_after_save
+
+    end
+  end
+end
+
+class ActionController::Base
+  rescue_from Mage::WizardRendered, with: :mage_return
+
+  def render_mage(object, options = {})
+    unless object.mage_step == :done
+      if request.method == 'GET'
+        if options[:show_step] && params[:step].blank?
+          mage_redirect(object, options[:show_step])
+        else
+          render "#{params[:controller]}/steps/#{object.mage_step}"
+        end
+      else
+        mage_redirect(object, options[:show_step])
+      end
+      raise Mage::WizardRendered.new
+    end
+  end
+
+  def mage_redirect(object, show_step = false)
+    path = object.new_record? ? :new_polymorphic_path : :edit_polymorphic_path
+    redirect_to send(path, object, step: (object.mage_step if show_step))
+  end
+
+  def mage_return
+  end
+
+  private :mage_return, :mage_redirect
+end
+

data/lib/mage/version.rb

@@ -0,0 +1,3 @@
+module Mage
+  VERSION = '0.1.0'
+end

data/mage.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mage"
+  spec.version       = Mage::VERSION
+  spec.authors       = ["Viacheslav Mefodin"]
+  spec.email         = ["mefodin.v@gmailcom"]
+
+  spec.summary       = %q{Rails wizard model creation}
+  spec.description   = %q{This gem allows model to have state, and based on that
+    create wizard with step by step validations}
+  spec.homepage      = "https://github.com/effect305/mage"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "db"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: mage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viacheslav Mefodin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  This gem allows model to have state, and based on that
+      create wizard with step by step validations
+email:
+- mefodin.v@gmailcom
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- db/migrate/20160407080915_create_mage_steps.rb
+- lib/mage.rb
+- lib/mage/version.rb
+- mage.gemspec
+homepage: https://github.com/effect305/mage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- db
+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.8
+signing_key: 
+specification_version: 4
+summary: Rails wizard model creation
+test_files: []