simple_form-magic_submit 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrey Subbotin
+
+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.md

@@ -0,0 +1,122 @@
+# Magic Submit Button for Simple Form
+
+A smart submit button extension for the Simple Form gem that:
+
+- Displays an alternate title on validation errors.
+- Displays a different "Loading..." title depending on whether the model is being saved or updated.
+- Is optionally postfixed with a "Cancel" link.
+- Is fully localizable via the I18n gem.
+
+## A picture's worth a thousand words, right?
+
+For a newly created model object, typically in a `new.html.haml`:
+
+<img src="https://raw.github.com/eploko/simple_form-magic_submit/master/preview/01-submit.png" width="720" height="190" alt="A preview of the submit button in the simples case."/>
+
+Add a cancel link:
+
+<img src="https://raw.github.com/eploko/simple_form-magic_submit/master/preview/02-submit-with-cancel.png" width="720" height="190" alt="A preview of the submit button accompanied by a Cancel link."/>
+
+When something goes wrong and the model fails validation:
+
+<img src="https://raw.github.com/eploko/simple_form-magic_submit/master/preview/03-model-invalid.png" width="720" height="260" alt="A preview of the submit button with a different title when the validation has failed."/>
+
+And all this and a bit more with just a single line of code:
+
+```haml
+= f.button :submit_retry, cancel: root_path
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_form-magic_submit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_form-magic_submit
+
+## Usage
+
+In your view template add it allong the lines of:
+
+```haml
+= simple_form_for(resource) do |f|
+    = f.error_notification
+    .form-inputs
+        = f.input :email, autofocus: true
+    .form-actions
+        = f.button :submit_retry
+```
+
+The last one is this gem's magic.
+
+To add a cancel link:
+
+```haml
+= simple_form_for(resource) do |f|
+    = f.error_notification
+    .form-inputs
+        = f.input :email, autofocus: true
+    .form-actions
+        = f.button :submit_retry, cancel: root_path
+```
+
+Replace `root_path` with whatever path is relevant for your app.
+
+## Localization
+
+The gem comes bundled with an English translation in [en.yml](https://github.com/eploko/simple_form-magic_submit/blob/master/locales/en.yml):
+
+```yaml
+en:
+  simple_form:
+    magic_submit:
+      default:
+        create:
+          submit: "Create a new %{model}"
+          retry: "Try creating once again"
+          loading: "Creating&#133;"
+        save:
+          submit: "Save changes"
+          retry: "Try saving once again"
+          loading: "Saving&#133;"
+      cancel:
+        format: "%{submit_button} or %{cancel_link}"
+        cancel: "Cancel"
+      # Replace 'model_name' below with the name of your model and
+      # alter the transaltions as you wish.
+      #
+      # Each translation will have %{model} interpolated.
+      #
+      # model_name:
+      #   create:
+      #     submit: "Create a new %{model}"
+      #     retry: "Try creating once again"
+      #     loading: "Creating&#133;"
+      #   save:
+      #     submit: "Save changes"
+      #     retry: "Try saving once again"
+      #     loading: "Saving&#133;"
+```
+
+Simply copy the file to you config/locales folder inside your Rails project if you want to change the default strings.
+
+## To-do
+
+1. Add tests.
+2. Add more translations.
+3. You tell me.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/simple_form/magic_submit/version.rb

@@ -0,0 +1,5 @@
+module SimpleForm
+  module MagicSubmit
+    VERSION = "0.0.1"
+  end
+end

data/lib/simple_form/magic_submit.rb

@@ -0,0 +1,41 @@
+require "simple_form/magic_submit/version"
+
+module SimpleForm
+  module MagicSubmit
+
+    def submit_retry_button(*args, &block)
+      options = args.extract_options!
+      options[:"data-loading-text"] ||= translate_key(:loading)
+      options[:class] = ['btn-primary', 'btn-submit', options[:class]].compact
+      options[:id] ||= "submit_#{object_scope}"
+      args << options
+      if cancel = options.delete(:cancel)
+        I18n.t("simple_form.magic_submit.cancel.format",
+          submit_button: submit(translate_key, *args, &block).html_safe,
+          cancel_link: template.link_to(I18n.t('simple_form.magic_submit.cancel.cancel').html_safe, cancel)
+        )
+      else
+        submit(translate_key, *args, &block)
+      end.html_safe
+    end
+
+  private
+
+    def object_scope
+      self.object.class.model_name.underscore
+    end
+
+    def translate_key(key = nil)
+      op = self.object.new_record? ? :create : :save
+      key ||= self.object.errors.count > 0 ? :retry : :submit
+      I18n.t("simple_form.magic_submit.#{object_scope}.#{op}.#{key}",
+        default: [:"simple_form.magic_submit.default.#{op}.#{key}", :"helpers.submit.#{op}"],
+        model: self.object.class.model_name.titlecase
+      ).html_safe
+    end
+
+  end
+end
+
+SimpleForm::FormBuilder.send :include, SimpleForm::MagicSubmit
+I18n.load_path += Dir.glob(File.join(File.dirname(__FILE__), '..', '..', 'locales', '*.{rb,yml}'))

data/locales/en.yml

@@ -0,0 +1,29 @@
+en:
+  simple_form:
+    magic_submit:
+      default:
+        create:
+          submit: "Create a new %{model}"
+          retry: "Try creating once again"
+          loading: "Creating…"
+        save:
+          submit: "Save changes"
+          retry: "Try saving once again"
+          loading: "Saving…"
+      cancel:
+        format: "%{submit_button} or %{cancel_link}"
+        cancel: "Cancel"
+      # Replace 'model_name' below with the name of your model and
+      # alter the transaltions as you wish.
+      #
+      # Each translation will have %{model} interpolated.
+      #
+      # model_name:
+      #   create:
+      #     submit: "Create a new %{model}"
+      #     retry: "Try creating once again"
+      #     loading: "Creating…"
+      #   save:
+      #     submit: "Save changes"
+      #     retry: "Try saving once again"
+      #     loading: "Saving…"

data/simple_form-magic_submit.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_form/magic_submit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_form-magic_submit"
+  spec.version       = SimpleForm::MagicSubmit::VERSION
+  spec.authors       = ["Andrey Subbotin"]
+  spec.email         = ["andrey@subbotin.me"]
+  spec.description   = "A smart submit button extension for the Simple Form gem."
+  spec.summary       = "Magic Submit Button for Simple Form"
+  spec.homepage      = 'http://rubygems.org/gems/simple_form-magic_submit'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "simple_form", "~> 2.0"
+  spec.add_runtime_dependency "i18n", "~> 0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.5"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: simple_form-magic_submit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrey Subbotin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: A smart submit button extension for the Simple Form gem.
+email:
+- andrey@subbotin.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_form/magic_submit.rb
+- lib/simple_form/magic_submit/version.rb
+- locales/en.yml
+- preview/01-submit.png
+- preview/02-submit-with-cancel.png
+- preview/03-model-invalid.png
+- simple_form-magic_submit.gemspec
+homepage: http://rubygems.org/gems/simple_form-magic_submit
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Magic Submit Button for Simple Form
+test_files: []