activerecord-confirmable 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yoshimoto
+
+MIT License
+
+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.en.md

@@ -0,0 +1,79 @@
+# Activerecord::Confirmable
+
+Confirmation view helper of model on creating or updating.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-confirmable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-confirmable
+
+## Usage
+
+This module is adding by virtual confimed attribute to your model. #confirmation? method returns submittion status.
+
+
+                         validation fail
+          +---------------+-----------------------------+
+          |               |                             |
+          v               |                             |
+    +--------------+    submit    +--------------+    submit
+    |  new / edit  |  ----------> | confirmation |  ---------->  done
+    +--------------+              +--------------+
+    confirmed != '1'              confirmed == '1'
+
+          ^                                |
+          |  back (set confirmed = false)  |
+          +--------------------------------+
+
+exapmle:
+
+    class Article
+      include ActiveRecord::Confirmable
+    end
+
+    class ArticlesController
+      def create
+        @article = Article.new(params[:article])
+        @article.confirmed = false if params[:commit] == "back"
+        if @article.save
+          redirect_to @article
+        else
+          render action: "new"
+        end
+      end
+
+      def update
+        @article = Article.find(params[:id])
+        params[:article][:confirmed] = false if params[:commit] == "back"
+        if @article.update_attributes(params[:article])
+          redirect_to @article
+        else
+          render action: "edit"
+        end
+      end
+    end
+
+    articles/_form.html.erb
+      <%= form_for(@article) do |f| %>
+        <%= f.text_field :title %>
+        <%= f.submit f.object.confirmation? ? "submit" : "confirm" %>
+        <%= f.submit "back" if f.object.confirmation? %>
+        <%= f.hidden_field :confirmed %>
+      <% end %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.md

@@ -0,0 +1,78 @@
+# Activerecord::Confirmable
+
+Railsで、controllerにconfirmアクションを作らずに、確認画面を実装するためのモジュールです。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-confirmable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-confirmable
+
+## Usage
+
+このモジュールをモデルにincludeすると、confirmedアトリビュートが追加されます。フォームに、hidden_field :confirmed を追加すると確認画面に遷移するようになります。#confirmation? がtrueの場合はモデルが確認画面の状態なので、適切にviewを切り替えてください。
+
+                         validation fail
+          +---------------+-----------------------------+
+          |               |                             |
+          v               |                             |
+    +--------------+    submit    +--------------+    submit
+    |  new / edit  |  ----------> | confirmation |  ---------->  done
+    +--------------+              +--------------+
+    confirmed != '1'              confirmed == '1'
+
+          ^                                |
+          |  back (set confirmed = false)  |
+          +--------------------------------+
+
+exapmle:
+
+    class Article
+      include ActiveRecord::Confirmable
+    end
+
+    class ArticlesController
+      def create
+        @article = Article.new(params[:article])
+        @article.confirmed = false if params[:commit] == "back"
+        if @article.save
+          redirect_to @article
+        else
+          render action: "new"
+        end
+      end
+
+      def update
+        @article = Article.find(params[:id])
+        params[:article][:confirmed] = false if params[:commit] == "back"
+        if @article.update_attributes(params[:article])
+          redirect_to @article
+        else
+          render action: "edit"
+        end
+      end
+    end
+
+    articles/_form.html.erb
+      <%= form_for(@article) do |f| %>
+        <%= f.text_field :title %>
+        <%= f.submit f.object.confirmation? ? "submit" : "confirm" %>
+        <%= f.submit "back" if f.object.confirmation? %>
+        <%= f.hidden_field :confirmed %>
+      <% end %>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rspec_opts = ['-cfs']
+  end
+rescue LoadError => e
+end

data/activerecord-confirmable.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/activerecord-confirmable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Beyond"]
+  gem.email         = ["beyond@be.to"]
+  gem.description   = %q{ confirmatin view on model creation / changes }
+  gem.summary       = %q{ confirmatin view without confirm action adding to controller. }
+  gem.homepage      = "https://github.com/beyond/activerecord-confirmable"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "activerecord-confirmable"
+  gem.require_paths = ["lib"]
+  gem.version       = Activerecord::Confirmable::VERSION
+
+  gem.add_runtime_dependency "activerecord"
+  gem.add_runtime_dependency "activesupport"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency 'rake', '~> 0.9.2.2'
+  gem.add_development_dependency 'rdoc', '~> 3.11'
+  gem.add_development_dependency 'sqlite3'
+end

data/lib/activerecord-confirmable/active_record/confirmable.rb

@@ -0,0 +1,19 @@
+module ActiveRecord
+	module Confirmable
+		extend ActiveSupport::Concern
+
+		included do
+			validates_acceptance_of :confirmed
+			after_rollback :check_confirming
+		end
+
+	  def check_confirming
+			errors.messages.delete( :confirmed )
+			self.confirmed = errors.empty? ? '1' : '' if self.confirmed
+	  end
+
+		def confirmation?
+			!self.confirmed.blank?
+		end
+	end
+end

data/lib/activerecord-confirmable/version.rb

@@ -0,0 +1,5 @@
+module Activerecord
+  module Confirmable
+    VERSION = "1.0.0"
+  end
+end

data/lib/activerecord-confirmable.rb

@@ -0,0 +1,2 @@
+require "activerecord-confirmable/version"
+require "activerecord-confirmable/active_record/confirmable"

data/spec/confirmable_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe ActiveRecord::Confirmable do
+	context "confirmed attribute is not set" do
+		subject { Article.new }
+
+		context "validation is fail" do
+			it "should not be valid" do
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.errors[ :confirmed ].should be_empty
+			end
+		end
+
+		context "validation is success" do
+			it "should be saved" do
+				subject.title = "title"
+				subject.should be_valid
+				subject.save.should be_true
+			end
+		end
+	end
+
+	context "confirmed is blank string (new state)" do
+		subject { Article.new confirmed: "" }
+
+		context "validation is fail" do
+			it "should not be in confirmation status yet" do
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.errors[ :confirmed ].should be_empty
+				subject.confirmation?.should be_false
+			end
+		end
+
+		context "validation is success" do
+			before do
+				subject.title = "title"
+			end
+
+			it "should be in confirmation" do
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.errors[ :confirmed ].should be_empty
+				subject.confirmation?.should be_true
+			end
+
+			it "should be accepted" do
+				subject.save
+				subject.confirmed.should == "1"
+			end
+		end
+	end
+
+	context "confirmed is '1' string (prepare to submit)" do
+		subject { Article.new confirmed: "1" }
+
+		context "validation is fail" do
+			it "should be required title" do
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.errors[ :confirmed ].should be_empty
+				subject.confirmation?.should be_false
+			end
+		end
+
+		context "validation is success" do
+			before do
+				subject.title = "title"
+			end
+
+			it "shoud be submittable" do
+				subject.should be_valid
+				subject.save.should be_true
+			end
+		end
+	end
+
+	context "confirmed is false (back button from confimation)" do
+		subject { Article.new confirmed: false }
+
+		context "validation is fail" do
+			it "should be new state" do
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.errors[ :confirmed ].should be_empty
+				subject.confirmation?.should be_false
+			end
+		end
+
+		context "validation is success" do
+			before do
+				subject.title = "title"
+			end
+
+			it "should be new state" do
+				subject.title = "title"
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.confirmation?.should be_false
+			end
+		end
+	end
+
+	context "confirmed is 'false' string (back and submit)" do
+		subject { Article.new confirmed: "false" }
+
+		context "validation is fail" do
+			it "should be new state" do
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.errors[ :confirmed ].should be_empty
+				subject.confirmation?.should be_false
+			end
+		end
+
+		context "validation is success" do
+			before do
+				subject.title = "title"
+			end
+
+			it "should be submittable" do
+				subject.should_not be_valid
+				subject.save.should be_false
+				subject.confirmation?.should be_true
+			end
+
+			it "should be accepted" do
+				subject.save
+				subject.confirmed.should == "1"
+			end
+		end
+	end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'active_record'
+require File.expand_path("../lib/activerecord-confirmable", File.dirname(__FILE__))
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+ActiveRecord::Schema.define do
+  create_table "articles", :force => true do |t|
+    t.string   "title"
+    t.string   "body"
+  end
+end
+
+class Article < ActiveRecord::Base
+	include ActiveRecord::Confirmable
+
+  attr_accessible :title, :confirmed
+	validates :title, presence: true
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-confirmable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Beyond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &21337600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21337600
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &21336940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *21336940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &21336200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21336200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &21335600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *21335600
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &21335080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: *21335080
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &21334680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21334680
+description: ! ' confirmatin view on model creation / changes '
+email:
+- beyond@be.to
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.en.md
+- README.md
+- Rakefile
+- activerecord-confirmable.gemspec
+- lib/activerecord-confirmable.rb
+- lib/activerecord-confirmable/active_record/confirmable.rb
+- lib/activerecord-confirmable/version.rb
+- spec/confirmable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/beyond/activerecord-confirmable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: confirmatin view without confirm action adding to controller.
+test_files:
+- spec/confirmable_spec.rb
+- spec/spec_helper.rb