abracadabra 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0313990291cc523dfc6808622a86e8c7eccd38e2
+  data.tar.gz: 20e68d186cbddebed1443543d45603c2dae9b924
+SHA512:
+  metadata.gz: 9e388c41997ce8dc45c4398b694b829db9249c51e4536e7c8973e3fe2a73ec75bae4163f54a26b7992df15ede1bc09638bdb28b2ede43e99e04a76f3b94a970b
+  data.tar.gz: fbdf1360e53ed87c8c028b3814996d5b2a9e5b0abc15a0e2d36a8ea05b96b2080ec3255f5f0d5de793dcdabb2c9c0d986160b855a9cc06086d47304183ae6362

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 abracadabra.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Trevor Hinesley
+
+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,70 @@
+# Abracadabra
+
+A lightweight gem for swapping out text with a fully-compliant Rails form in one click.
+
+Much of the concepts and html mark-up were taken from the awesome [x-editable](http://vitalets.github.io/x-editable/) plugin and the Rails version of this, [x-editable-rails](https://github.com/werein/x-editable-rails). However, this was written from the ground up and uses fully Rails-compliant forms without hacking into x-editable's core files, or overriding them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'abracadabra'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install abracadabra
+
+## Usage
+
+In your `application.css`, AFTER Bootstrap (currently only supports Bootstrap), include the css file:
+
+```css
+ *= require abracadabra
+```
+
+In your `application.js`, AFTER Jquery (required), include the javascript file:
+
+```js
+ //= require abracadabra
+```
+
+## Helpers
+
+The bread and butter of abracadabra is its helper, `click_to_edit`. Its pretty much as readable as it gets:
+
+```ruby
+<%= 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:
+
+[Video of abracadabra in action!](http://recordit.co/cpwdWIyEN4)
+
+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.
+
+It accepts the following optional hash keys (more will be added soon):
+
+```ruby
+class: "my-class"
+# A class to be added to the text input of the form.
+
+value: "blah"
+# An alternate value, other than what object.attribute would return.
+
+method: "patch"
+# HTTP REST method to use. Use anything but "get".
+```
+
+## Future & Contributing
+
+I would love anyone to add date pickers and other alternate field types to this. It would be nice to respond to more than just javascript as well (very simple to implement). Any other ideas, feel free to contribute!
+
+1. Fork it ( http://github.com/<my-github-username>/abracadabra/fork )
+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/abracadabra.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'abracadabra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "abracadabra"
+  spec.version       = Abracadabra::Rails::VERSION
+  spec.authors       = ["Trevor Hinesley"]
+  spec.email         = ["trevor.hinesley@gmail.com"]
+  spec.summary       = %q{A lightweight gem for swapping out text with a fully-compliant Rails form in one click using JQuery.}
+  spec.description   = %q{Abracadabra: #{spec.summary}}
+  spec.homepage      = "https://github.com/TrevorHinesley/abracadabra"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "rails", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/app/assets/javascripts/abracadabra.js

@@ -0,0 +1,43 @@
+$(function() {
+  $("body").on("ajax:success", ".abracadabra-form", function(e) {
+    $(e.target).find(".abracadabra-cancel").click();
+  })
+
+  $("body").on("click", ".abracadabra-cancel", function() {
+    container = $(this).closest(".abracadabra-container");
+    value = $(this).parents(".abracadabra-buttons").siblings().find("input").val();
+    container.siblings(".abracadabra").text(value).show();
+    $(this).closest(".abracadabra-container").remove();
+  });
+
+  $("body").on("keydown", ".abracadabra-input input", function(e) {
+    if (e.which == 9)
+    {
+      e.preventDefault();
+      $(this.form).submit();
+    }
+  });
+  
+  $(".abracadabra").on("click", function() {
+    link = $(this);
+    link.hide();
+    path = link.data("path");
+    attribute = link.data("attribute");
+    form_method = link.data("method");
+    instance_class = link.data("class");
+    input_value = link.text();
+    input_id = instance_class + "_" + attribute;
+    input_name = instance_class + "[" + attribute + "]";
+
+    buttons = "<button type='submit' class='btn btn-primary abracadabra-submit'><i class='fa fa-check'></i></button><button type='button' class='btn abracadabra-cancel'><i class='fa fa-times'></i></button>";
+    open_form_tag = "<form accept-charset='UTF-8' action='" + path + "' data-remote='true' class='form-inline abracadabra-form' method='post'>";
+    hidden_method_tags = "<div style='display:none;'><input name='utf8' type='hidden' value='&#10003;'><input name='_method' type='hidden' value='" + form_method + "'></div>";
+    input = "<input type='text' class='form-control' id='" + input_id + "' name='" + input_name + "' value='" + input_value + "'>";
+    
+    html = "<span class='abracadabra-container abracadabra-inline'>" + open_form_tag + hidden_method_tags;
+    html += "<div class='control-group'><div><div class='abracadabra-input'>" + input + "</div>";
+    html += "<div class='abracadabra-buttons'>" + buttons + "</div></div></form></span>";
+
+    link.after(html);
+  });
+});

data/app/assets/stylesheets/abracadabra.css

@@ -0,0 +1,21 @@
+.abracadabra {
+  border-bottom: 1px dashed;
+  color: #428bca;
+}
+
+.abracadabra:hover {
+  text-decoration: none;
+  color: darken(#428bca, 10%);
+}
+
+.abracadabra-container { display: block; }
+
+.abracadabra-container > form > .control-group > div > .abracadabra-input {
+  width: 60%;
+  display: inline-block;
+}
+
+.abracadabra-container > form > .control-group > div > .abracadabra-buttons {
+  width: 40%;
+  display: inline-block;
+}

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

@@ -0,0 +1,13 @@
+module Abracadabra
+  module Rails
+    module ViewHelper
+      def click_to_edit(instance, options)
+        instance_class = instance.class.to_s.underscore
+        link_class = "#{options[:class]} abracadabra".strip
+        value = options[:value] || instance.send(options[:attribute])
+        method = options[:method] || "patch"
+        "<a href='javascript:void(0)' class='#{link_class}' data-path='#{options[:path]}' data-method='#{method}' data-attribute='#{options[:attribute]}' data-class='#{instance_class}'>#{value}</a>".html_safe
+      end
+    end
+  end
+end

data/lib/abracadabra/engine.rb

@@ -0,0 +1,6 @@
+module Abracadabra
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/abracadabra/version.rb

@@ -0,0 +1,5 @@
+module Abracadabra
+  module Rails
+    VERSION = "1.0.0"
+  end
+end

data/lib/abracadabra.rb

@@ -0,0 +1,2 @@
+require "abracadabra/version"
+require "abracadabra/engine" if defined?(::Rails)

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: abracadabra
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trevor Hinesley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Abracadabra: #{spec.summary}'
+email:
+- trevor.hinesley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- abracadabra.gemspec
+- app/assets/javascripts/abracadabra.js
+- app/assets/stylesheets/abracadabra.css
+- app/helpers/abracadabra/rails/view_helper.rb
+- lib/abracadabra.rb
+- lib/abracadabra/engine.rb
+- lib/abracadabra/version.rb
+homepage: https://github.com/TrevorHinesley/abracadabra
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A lightweight gem for swapping out text with a fully-compliant Rails form
+  in one click using JQuery.
+test_files: []