resty_prefill 1.0.0

data/.gitignore

@@ -0,0 +1,52 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+.*.swp
+.*.swo
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+tmp
+README.html

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# gem 'rails', '>= 3.0.0'
+gem 'rake'
+# gem 'activemodel', '= 3.0.11'
+# gem 'activesupport', '= 3.0.11'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.4.0"
+  gem "bundler"
+end
+

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (10.0.3)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  rspec (~> 2.4.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Paul A. Jungwirth
+
+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,109 @@
+resty\_prefill
+==============
+
+The resty\_prefill gem fixes a problem with Rails' REST behavior when handling form-submit errors. I've written more about this problem [here](http://www.illuminatedcomputing.com/posts/2011/07/restless-doubts/), but basically it's this:
+
+A typical Rails controller has these methods:
+
+    class WidgetsController < ApplicationController
+
+      def new
+        @widget = Widget.new
+      end
+
+      def create
+        @widget = Widget.new(params[:widget])
+        if @widget.save
+          flash[:success] = 'Widget created.'
+          redirect_to widgets_path
+        else
+          render 'new'
+        end
+      end
+
+      def edit
+        @widget = Widget.find(params[:id])
+      end
+
+      def update
+        @widget = Widget.find(params[:id])
+        if @widget.update_attributes(params[:widget])
+          flash[:success] = 'Widget updated.'
+          redirect_to widgets_path
+        else
+          render 'edit'
+        end
+      end
+
+      # ...
+
+    end
+
+The problem is how this approach handles errors. To create a Widget, the user starts at `/widgets/new`, but after getting errors he winds up at just `/widgets`. That URL is non-GETtable, non-bookmarkable, and non-sharable. If you do Ctrl-L then Enter, you'll get a routing error. If you click "Like" or "Share", people following your URL get a routing error. Ideally form errors should send the user back to `/widgets/new`. Similarly with `/widgets/2/edit` vs. `/widgets/2`.
+
+So resty\_prefill makes it easy to preserve RESTful URLs even with form errors. Just `include RestyPrefill` in your ApplicationController, then write your code like this:
+
+    class WidgetsController < ApplicationController
+
+      def new
+        @widget = Widget.new
+        prefill @widget
+      end
+
+      def create
+        @widget = Widget.new(params[:widget])
+        if @widget.save
+          flash[:success] = 'Widget created.'
+          redirect_to widgets_path
+        else
+          ready_prefill @widget, params[:widget]
+          redirect_to new_widget_path
+        end
+      end
+
+      def edit
+        @widget = Widget.find(params[:id])
+        prefill @widget
+      end
+
+      def update
+        @widget = Widget.find(params[:id])
+        if @widget.update_attributes(params[:widget])
+          flash[:success] = 'Widget updated.'
+          redirect_to widgets_path
+        else
+          ready_prefill @widget, params[:widget]
+          redirect_to edit_widget_path(@widget)
+        end
+      end
+
+      # ...
+
+    end
+
+The `prefill` method populates `@widget.errors` so your form displays the right messages and highlights the right fields. The `ready_prefill` method stores information in the session to make this possible.
+
+
+Contributing to resty\_prefill
+------------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone hasn't already requested and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make be sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, that is fine, but please isolate that change to its own commit so I can cherry-pick around it.
+
+Commands for building/releasing/installing:
+
+* `rake build`
+* `rake install`
+* `rake release`
+
+Copyright
+---------
+
+Copyright (c) 2013 Illuminated Computing Inc.
+See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,28 @@
+# 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 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+desc 'Default: run specs'
+task :default => :spec
+
+
+Bundler::GemHelper.install_tasks
+
+
+task :readme => [] do |task|
+  `markdown README.md >README.html`
+end

data/lib/resty_prefill.rb

@@ -0,0 +1,42 @@
+module RestyPrefill
+
+  VERSION = '1.0.0'
+
+  def redirect_and_prefill_for(obj)
+    (session[:redirect_and_prefill] ||= {})[obj.class.to_s] ||= {
+      attrs: {},
+      errors: []
+    }
+  end
+
+  def clear_redirect_and_prefill_for(obj)
+    h = redirect_and_prefill_for(obj)
+    h[:attrs] = {}
+    h[:errors] = []
+  end
+
+  def prefill(obj)
+    attrs = redirect_and_prefill_for(obj)[:attrs]
+    attrs.each do |k,v|
+      obj[:k] = v
+    end
+
+    errs = redirect_and_prefill_for(obj)[:errors]
+    errs.each do |attr, msg|
+      obj.errors.add(attr, msg)
+    end
+  ensure
+    clear_redirect_and_prefill_for(obj)
+  end
+
+  def ready_prefill(obj, attrs)
+    redirect_and_prefill_for(obj)[:attrs] = attrs
+    errs = []
+    obj.errors.each do |attr, msg|
+      errs << [attr, msg]
+    end
+    redirect_and_prefill_for(obj)[:errors] = errs
+  end
+
+end
+

data/resty_prefill.gemspec

@@ -0,0 +1,28 @@
+$:.push File.dirname(__FILE__) + '/lib'
+require 'resty_prefill'
+
+Gem::Specification.new do |s|
+  s.name = "resty_prefill"
+  s.version = RestyPrefill::VERSION
+  s.date = "2013-03-10"
+
+  s.summary = "Used to preserve RESTful URLs in Rails despite form submit errors."
+  s.description = "Used to preserve RESTful URLs in Rails despite form submit errors."
+
+  s.authors = ["Paul A. Jungwirth"]
+  s.homepage = "http://github.com/pjungwir/resty_prefill"
+  s.email = "pj@illuminatedcomputing.com"
+
+  s.licenses = ["MIT"]
+
+  s.require_paths = ["lib"]
+  s.executables = []
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,fixtures}/*`.split("\n")
+
+  s.add_runtime_dependency 'rails', '>= 3.0.0'
+  s.add_development_dependency 'rspec', '~> 2.4.0'
+  s.add_development_dependency 'bundler', '>= 0'
+
+end
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: resty_prefill
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Paul A. Jungwirth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Used to preserve RESTful URLs in Rails despite form submit errors.
+email: pj@illuminatedcomputing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resty_prefill.rb
+- resty_prefill.gemspec
+homepage: http://github.com/pjungwir/resty_prefill
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -618312344268099606
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Used to preserve RESTful URLs in Rails despite form submit errors.
+test_files: []