abracadabra 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1f78acf9d1934bf40e2d2efad77bfe6b4ed4127
-  data.tar.gz: 28b8156bb3c5dc500e15f5db765324704b34ac52
+  metadata.gz: a547e178b8cfdab8f627f326c25a717262c259c8
+  data.tar.gz: b9f09ee3fa7e063623b8f90e0ebbff941296bdf8
 SHA512:
-  metadata.gz: 7e95f984e783c3f570dca808096b5b7133cb57d598b2a245e94c1e38ed176e0090897dc10c612750af3f9b291ea993cb917ea8b12ca08eca4eefedf695660191
-  data.tar.gz: 9a421a6ef67b44e1305e8d6d7f90b583bb335a5ceb58b4836846d52e79d38760cc85d7dfaeaa1787096dd69af2232f0437852fefde6f550521589dfeab36801a
+  metadata.gz: 42b5af88fa0c4b382d48779cc039f4f360ca0f99a307d40f93abe1aa439075114a43c22097d5191ccf248a78e434f147e9208f6e08d1efb1c83d774897ae1a08
+  data.tar.gz: 799eed594cf39ee6f922fccddf8768d95bf94131f94b828cf1d0faa0dd45d6a141f6bed55765fdcf6ac3b3dc51804fa340a7cb17e7e266525c3827f8a371c765

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+* Requires JQuery, JQuery-UJS (rails.js), Bootstrap and Font-Awesome (unless you override the framework specific classes with CSS)
+
 In your `application.css`, AFTER Bootstrap (currently only supports Bootstrap), include the css file:
 
 ```css
@@ -40,28 +42,54 @@ The bread and butter of abracadabra is its helper, `click_to_edit`. Its pretty m
 <%= click_to_edit @user, path: user_path(@user), attribute: :name %>
 ```
 
-When a user clicks the link generated by this helper, a form with a text field input will replace the link. It's fully Rails compliant, and looks identical to a `form_for` with `remote: true`. Currently, it only responds to javascript, but other datatypes will be supported soon. Here's what it looks like:
+When a user clicks the link generated by this helper, a form with a text field input will replace the link. It's fully Rails compliant, and looks identical to a `form_for` with `remote: true`. Here's what it looks like:
 
-[Video of abracadabra in action!](http://recordit.co/cpwdWIyEN4)
+![Abracadabra Demo](http://recordit.co/CbgPTahYix.gif "Abracadabra Demo")
 
-The first parameter is the object to be edited, and the only other required parameters are `path` and `attribute`. `path` specifies where the form will be submitted, and `attribute` specifies the column being updated.
+The first parameter of `click_to_edit` is the object to be edited, and the only other required parameters are `path` and `attribute`. `path` specifies where the form will be submitted, and `attribute` specifies the column being updated.
 
-It accepts the following optional hash keys (more will be added soon):
+It accepts the following parameters:
 
 ```ruby
+### REQUIRED ###
+path: user_path(@user)
+# Specifies where the form will be submitted.
+
+attribute: :name
+# Specifies what attribute your text field will be updating.
+
+
+### OPTIONAL ###
 class: "my-class"
-# A class to be added to the text input of the form.
+# Class(es) to be added to the text input of the form. The class "abracadabra" is added either way.
+# Default: only "abracadabra"
 
 value: "blah"
 # An alternate value, other than what object.attribute would return.
+# Default: object.attribute
 
 method: "patch"
 # HTTP REST method to use. Use anything but "get".
+# Default: "patch"
+
+remote: true
+# Same as link_to's remote: true, form submits via AJAX.
+# Default: true
+
+# IMPORTANT: `type` will be ignored if `remote = false` is used. HTML is the default 
+# in Rails for standard form submissions.
+type: :js
+# Content type -- responds to any content types (:js and :script can both be used to respond with Javascript).
+# Default: :script (:js)
 ```
 
 ## Future & Contributing
 
-I would love anyone to add date pickers and other alternate field types to this. Any other ideas, feel free to contribute!
+1. I would love anyone to add date pickers and other alternate field types to this.
+
+2. I would love the different Bootstrap classes to be overridable with an initializer (config/abracadabra.rb) so that any framework could be used. Same with the Font-Awesome button classes.
+
+Any other ideas, feel free to contribute!
 
 1. Fork it ( http://github.com/TrevorHinesley/abracadabra/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/app/helpers/abracadabra/rails/view_helper.rb

@@ -7,10 +7,10 @@ module Abracadabra
         value = options[:value] || instance.send(options[:attribute])
         method = options[:method] || "patch"
 
-        if (options[:remote].nil? && options[:type].nil?) || options[:remote] == true
-          remote = true
-        else
+        if !options[:remote].nil? && options[:remote] == false
           remote = false
+        else
+          remote = true
         end
 
         data_type = options[:type].to_s.gsub(/^j+s+$/, "script") || "script"

data/lib/abracadabra/version.rb

@@ -1,5 +1,5 @@
 module Abracadabra
   module Rails
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abracadabra
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Trevor Hinesley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails