effective_form_inputs 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98b06e8541683a63c88431d726aef55d80f22f42
-  data.tar.gz: beed34183584c0e589488afd005436e5d37df9ab
+  metadata.gz: dfb139ee0ac3bdd08159e9eb79359d31bad07c27
+  data.tar.gz: 38c3ea428c5d9c184f8a7bc143705b3b6eb5e581
 SHA512:
-  metadata.gz: adae80480b8caf15d1ca19548eedbb4587ef6d850deb1085ead6ca7fd373eea4bd64ef25e99e43ba41cbc06dca906faebe3917347abd75aae919a7c7e6d06f40
-  data.tar.gz: 1038b9a5f82d18b58fef6ef255e95ef7d6f4d13a7c68b78c736f66933a74f29cf439e97eaa9b66d3f3486b1f688bdb645b0e09670941e9f6a9ef5919e70e6352
+  metadata.gz: fb0cb297acd58a2d45024bb5906cec6825261bbaefdc6aea4b3030c9c84617db288f51c8d408d8ec9de2818f1ff4492c108e8725add0d6e4aea2f457a9ef2a65
+  data.tar.gz: d9254902a855f0abf74936cdbbd26338386b0216f748b42ef1537b706b15e261437b32cbb694eb65205c2fa8449ded1e071c29781a829b107f98008cf6149d3e

data/README.md

@@ -1,65 +1,118 @@
 # Effective Form Inputs
 
-This gem is in active development and should be considered BETA
+Multiple custom Rails Form Helper and SimpleForm inputs in one Rails engine.
 
-The purpose of this gem is to house a whole bunch of Javascript form inputs that can then be all at once brought into a Rails app
+This gem contains numerous custom form inputs along with their Javascript/CSS assets.
 
-Each form input will be a Rails FormBuilder and a simple_form input
+Each included form input is available to both the default Rails Form Helper and SimpleForm.
 
-Right now there's just one form input -- the bootstrap3 datepicker
+Rails 3.2.x and 4.x
 
-## Installation
+Right now there's just one form input.  This will grow.
 
-bundle install the gem
+## Getting Started
 
-No rails generater to run
+Add to your Gemfile:
 
-If you want to use all inputs:
+```ruby
+gem 'effective_form_inputs'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+### Install All Form Inputs
 
+This gem packages the javascript/css assets for numerous form inputs.
+
+The assets for these inputs may be included all at once or individually.
+
+To install all available inputs, add the following to your application.js:
+
+```ruby
 //= require effective_form_inputs
-@import 'effective_form_inputs';
+```
 
-Or just one:
+and add the following to your application.css:
 
-//= require effective_date_time_picker/input
-@import 'effective_date_time_picker/input';
+```ruby
+*= require effective_form_inputs
+```
 
-## Bootstrap3 Datepicker
+All of the included form inputs will now be available with no additional installation tasks.
 
-https://github.com/Eonasdan/bootstrap-datetimepicker
 
-As a rails FormBuilder
+## Bootstrap3 DateTimePicker
 
-= f.effective_date_time_picker :updated_at
+This custom form input is based on the following awesome project:
 
-As a SimpleForm input
+Bootstrap 3 Datepicker (https://github.com/Eonasdan/bootstrap-datetimepicker)
 
-= f.input :updated_at, :as => :effective_date_time_picker
 
-## TODO
+### Installation
 
-Write a proper README.
+If you've already installed the 'All Form Inputs' assets (see above), there are no additional installation steps.
 
-## License
+To install this form input individually, add the following to your application.js:
 
-MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+```ruby
+//= require effective_date_time_picker/input
+```
 
-Code and Effect is the product arm of [AgileStyle](http://www.agilestyle.com/), an Edmonton-based shop that specializes in building custom web applications with Ruby on Rails.
+and add the following to your application.css:
+
+```ruby
+*= require effective_date_time_picker/input
+```
 
+### Usage
 
-## Credits
+As a Rails Form Helper input:
 
+```ruby
+= form_for @user do |f|
+  = f.effective_date_time_picker :updated_at
+```
 
-## Testing
+and as a SimpleForm input:
 
-The test suite for this gem is unfortunately not yet complete.
+```ruby
+= simple_form_for @user do |f|
+  = f.input :updated_at, :as => :effective_date_time_picker
+```
 
-Run tests by:
+### Passing Options to JavaScript
+
+Any options passed to the form input will be used to initialize the Bootstrap3 DateTimePicker
+
+For example (and this works just the same with the SimpleForm input):
 
 ```ruby
-rake spec
+= form_for @user do |f|
+  = f.effective_date_time_picker :updated_at, :format => 'YYYY-MM-DD', :showTodayButton => true
 ```
 
+For a full list of options, please refer to:
+
+http://eonasdan.github.io/bootstrap-datetimepicker/Options/
+
+
+## License
+
+MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+
+Code and Effect is the product arm of [AgileStyle](http://www.agilestyle.com/), an Edmonton-based shop that specializes in building custom web applications with Ruby on Rails.
+
+
+## Credits
+
+The authors of this gem are not associated with any of the awesome projects used in this gem.
+
+We are just extending these existing community projects for ease of use with Rails Form Helper and SimpleForm
+
 
 ## Contributing
 

data/lib/effective_form_inputs/version.rb

@@ -1,3 +1,3 @@
 module EffectiveFormInputs
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/effective_form_inputs.rb

@@ -3,5 +3,5 @@ require "effective_form_inputs/engine"
 require "effective_form_inputs/version"
 
 module EffectiveFormInputs
-  REJECTED_INPUT_JS_OPTIONS = [:as, :hint, :error, :readonly, :disabled, :required, :label, :inline_label, :placeholder, :prompt, :min_max, :maxlength, :pattern, :input_html, :wrapper_html, :error_html, :id, :wrapper, :collection]
+  REJECTED_INPUT_JS_OPTIONS = [:as, :hint, :error, :readonly, :disabled, :required, :label, :inline_label, :placeholder, :prompt, :min_max, :maxlength, :pattern, :input_html, :wrapper_html, :error_html, :id, :wrapper, :collection, :include_blank]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_form_inputs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails