dynaspan 0.1.1 → 0.1.2.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 594c27faf04b8c51de65d4f8e6101d0062b9b863
-  data.tar.gz: 6e5a1b2b1a091dc17f1e86a0d98af328caa8eb42
+  metadata.gz: bd231d2af63a1f712b0d8d1f69bc3039b1cdda40
+  data.tar.gz: e444a9c8374f08f0a61eeb927c83daf6138ca4c7
 SHA512:
-  metadata.gz: 616eadcaff9b70872a1776a62f0879a3696e1609c6bbf045ed57370a279f89711dfad0979e7a52d371ebeee0c1185f79f1f31b2c105b82ac1a29ed1cf7e471b4
-  data.tar.gz: d663df0da430cab97a4c0b280276db167349eef59b252ab5cb4d42e9680d0b1f6109b03742e34de49f37e0417be7a5fd3fb0f14e05810068a148fb4f5b05d867
+  metadata.gz: 5e187c11964538324ffb48e1abce8a45ac140dfb05c6a2e9fab3924dcb784047979b97957052052a633a0133b4543b50a38e781f1d5414118c2363a7dcee6252
+  data.tar.gz: ca711610f0de1fb36aeeb3fc845bdcef796ca73a6677c1032d7fda89222327419ddb899c28b172a2398cdebaed54c460286da45aca80a05343cde1b0bd07c745

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (C) 2014 by Daniel P. Clark
+Copyright (C) 2014-2015 by Daniel P. Clark
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,6 @@
 ##Dynaspan
 [![Gem Version](https://badge.fury.io/rb/dynaspan.svg)](http://badge.fury.io/rb/dynaspan)
+[![Code Climate](https://codeclimate.com/github/danielpclark/dynaspan/badges/gpa.svg)](https://codeclimate.com/github/danielpclark/dynaspan)
 #####[JSFiddle Demo](http://jsfiddle.net/680v09y8/)
 
 Dynaspan is an AJAX tool for Rails to update one field of any object without interfering with your website experience.  The user will see the web page as normal text.  Where ever you've placed a Dynaspan field people can click on the text and it transforms into text entry.  As soon as the person moves away from that entry it sends the update to the server.
@@ -8,39 +9,73 @@ Dynaspan also accepts updating an attribute for a nested object, but only 1 leve
 
 ###Installation
 
- - [ ] Add `gem 'dynaspan'` to your Gemfile.
- - [ ] Run `bundle`.
- - [ ] Next add `include Dynaspan::ApplicationHelper` inside your **ApplicationHelper** module.
- - [ ] Add `//= require dynaspan/dynaspan` to your **application.js** file.
- - [ ] And it's installed!
+ - [ ] Add `gem 'dynaspan'` to your Gemfile
+ - [ ] Run `bundle`
+ - [ ] Next add `include Dynaspan::ApplicationHelper` inside your **ApplicationHelper** module
+ - [ ] Add `//= require dynaspan/dynaspan` to your **application.js** file
 
-###Usage
+And it's installed!
 
-Example #1:
+###Usage
 
-    dynaspan_text_field(@article, comment, :note, '[edit]')
-    
-Example #2:
+Simple example:
+```ruby
+dynaspan_text_field(user, :name)
+```
+And that's it.  As long as you have a User object with a name field, this will update through
+the UserController's update method.  **user** is an User Object instance eg: `user = User.first`.
 
-    dynaspan_text_field(profile, profile.websites, :url, '[edit]',
-                         {
-                           hidden_fields: {page_name: 'page2'},
-                           callback_on_update: "alert('Awesome!');"
-                         }
-                       )
+---
 
+Polymorphic/Nested Example #1:
+```ruby
+dynaspan_text_field(@article, comment, :note, '[edit]')
+```
+Polymorphic/Nested Example #2:
+```ruby
+dynaspan_text_field(profile, profile.websites, :url, '[edit]',
+                     {
+                       hidden_fields: {page_name: 'page2'},
+                       callback_on_update: "alert('Awesome!');"
+                     }
+                   )
+```
 This will show the value of note in the comment object as plain text.  It can be clicked on to instantly become a text field input.  And once unselected the `@article` object will update with its nested attribute object `comment` and its new value in the `note` attribute.
 
 You can use either `dynaspan_text_field` or `dynaspan_text_area` in any of your views.  There are two mandatory parameters.  The first is a the main Object model instance you will be updating.  And the other mandatory field is the symbol of the attribute to update.  There are two optional fields.  The first is the nested attribute object which will have its field updated.  And the last is the optional text for `[edit]`-ing (clicking on to edit which is useful for blank fields).
+```ruby
+dynaspan_text_field(Object,OptionalNestedObject,SymField,OptionalEditText,OptionalOptionsHash)
+dynaspan_text_area(Object,OptionalNestedObject,SymField,OptionalEditText,OptionalOptionsHash)
+```
+The order is important.  And yes it does NOT change even if you just do:
+```ruby
+dynaspan_text_field(Object,SymField)
+```
+It is unconventional but the order remains the same despite the optional fields.
 
-    dynaspan_text_field(Object,OptionalNestedObject,SymField,OptionalEditText,OptionalOptionsHash)
-    dynaspan_text_area(Object,OptionalNestedObject,SymField,OptionalEditText,OptionalOptionsHash)
+###Parameters
 
-The order is important.  And yes it does NOT change even if you just do:
+The **first** parameter will always be the Object that will have its update method called.  It must be an instance of the Object.
+For example current_user being an instance of User.
 
-    dynaspan_text_field(Object,SymField)
+The **second** parameter can be a symbol of the field you want to update on the main Object from the first parameter.
+
+The **second** field can also be a has_one or has_many subset of the first argument moving the symbol to modify to the **third** argument.
+For example **dynaspan_text_field(author, author.stories, :title)**.  This works as a nested attribute so it includes Polymorphic Objects.
+
+The last two parameters can be edit text, and then additional options (in that order).  Both are optional.  The edit text
+is a way to be able to click somewhere to open up the input to initially enter text.
+
+The options Hash currently has three options.
+
+ - **:hidden_fields** will put in as many hidden fields as you include in a Hash with key->value matching to name->value
+ - **:callback_on_update** is a no frills callback.  It runs whatever command you give it whenever Dynaspan submits an update
+ to the server
+ - **:callback_with_values** will allow you to put a JavaScript command you want called on update and include as many parameters
+ as you'd like.  It will dynamically append a last parameter which is a Hash of two values.  The first is the CSS selector id
+ of the Dynaspan block that just performed the action, the second value is the actual text that was entered.  The keys in this
+ Hash are **ds_selector** and **ds_input**
 
-It is unconventional but the order remains the same despite the optional fields.
 
 ###How it updates
 
@@ -81,18 +116,18 @@ calling parents with selectors.  Example usage:
 
 Added a JavaScript callback that will **append** a Hash/Dictionary of the updated Dynaspan Object to the end of your
 functions parameters.  The method is named **callback_with_values**.
-
-    {
-        callback_with_values: "console.log();"
-    }
-    
+```ruby
+{
+  callback_with_values: "console.log();"
+}
+```
 This will be called everytime the Dynaspan field submits and it will **inject** the following result **as the last parameter**:
-
-    {
-      ds_selector: "dyna_span_unique_label<#>",
-      ds_input:    "the entered text from the input field"
-    }
-
+```ruby
+{
+  ds_selector: "dyna_span_unique_label<#>",
+  ds_input:    "the entered text from the input field"
+}
+```
 ####Version 0.1.0
 
 Added the same hidden_fields from version 0.0.8 to support non-nested Objects.  You can use them now on anything.
@@ -101,23 +136,23 @@ Added the same hidden_fields from version 0.0.8 to support non-nested Objects.
 
 JavaScript callback option now available.  Whenever the Dynaspan field is submitted you can have Dynaspan call
 your own JavaScript method.
-
-    {
-      callback_on_update: "someMethod('some-relative-instance-value');"
-    }
-
+```ruby
+{
+  callback_on_update: "someMethod('some-relative-instance-value');"
+}
+```
 ####Version 0.0.8
 
 You can now provide an option hash as a last parameter.  Current
 valid options only include:
-
-    {
-      hidden_fields: { label: "value" }
-    }
-    
+```ruby
+{
+  hidden_fields: { label: "value" }
+}
+```
 You can add as many hidden fields to your Dynaspan objects as you'd like.
 
->NOTE: In this version hidden fields only apply for nested attributes.
+>NOTE: In this version hidden fields only applies to nested attributes.
 
 Also the id parameter will only be passed to the server if it exists.  (No more empty
 string for id.)  This allows you to create "new" polymorphic child objects with Dynaspan.
@@ -126,7 +161,7 @@ string for id.)  This allows you to create "new" polymorphic child objects with
 
 The MIT License (MIT)
 
-Copyright (C) 2014 by Daniel P. Clark
+Copyright (C) 2014-2015 by Daniel P. Clark
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/app/helpers/dynaspan/application_helper.rb

@@ -28,21 +28,28 @@ module Dynaspan
         raise 'You did not provide a symbol for the form field.'
       end
       edit_text = nil unless edit_text.is_a? String
-      options = (parameters[-1].is_a?(Hash) ? parameters[-1] : {})
+      options = ActiveSupport::HashWithIndifferentAccess.new(parameters[-1].is_a?(Hash) ? parameters[-1] : {})
       options.default = nil
+      options[:form_for] = ActiveSupport::HashWithIndifferentAccess.new(options[:form_for])
+      options[:form_for].reverse_merge!(
+        method: :patch,
+        remote: true,
+        authenticity_token: true
+      )
       render(
           partial: "dynaspan/dynaspan_text_#{kind}",
           locals: {
             master_ds_object: master_ds_object,
             attr_object: attr_object,
             attrib: attrib,
-            unique_ref_id: dynaspan_counter,
+            unique_ref_id: options.fetch(:unique_id) { dynaspan_counter },
             dyna_span_edit_text: edit_text,
             hidden_fields: options[:hidden_fields],
             ds_callback_on_update: options[:callback_on_update],
-            ds_callback_with_values: options[:callback_with_values]
+            ds_callback_with_values: options[:callback_with_values],
+            form_for_options: options[:form_for]
           }
       )
     end
   end
-end
+end

data/app/views/dynaspan/_dynaspan_text_area.html.erb

@@ -2,7 +2,7 @@
 <div id="dyna_span_block<%= unique_ref_id %>" <%= "data-ds-callback-on-update=\"#{ds_callback_on_update}\" " if ds_callback_on_update.present? %> <%= "data-ds-callback-with-values=\"#{ds_callback_with_values}\" " if ds_callback_with_values.present? %>class='dyna-span<%= ' ds-content-present' if (attr_object.try(attrib).present? || master_ds_object.try(attrib).present?) %>'>
   <%= hidden_field_tag "last_dyna_span_val_#{unique_ref_id}", attr_object.try(attrib) || master_ds_object.try(attrib), id: "last_dyna_span_val_#{unique_ref_id}" %>
   <div id="<%= "dyna_span_div#{unique_ref_id}" %>" style="display:none;">
-    <%= form_for(master_ds_object, method: :patch, remote: true, authenticity_token: true) do |f| %>
+    <%= form_for(master_ds_object, **form_for_options.symbolize_keys) do |f| %>
       <% if master_ds_object.nested_attributes_options.keys.any? {|i| i.to_s.=~(/#{attr_object.class.try(:model_name).try(:i18n_key).to_s}/) || i.to_s.=~(/#{attr_object.class.try(:table_name)}/) } and !attr_object.nil? %>
         <%= f.fields_for master_ds_object.nested_attributes_options.keys.select {|i| i.to_s.=~(/#{attr_object.class.model_name.i18n_key.to_s}/) || i.to_s.=~(/#{attr_object.class.table_name}/) }.first, attr_object do |a|%>
           <%= a.hidden_field(:id, value: attr_object.id) if attr_object.id.present? %>
@@ -21,4 +21,4 @@
   </div>
   <%= content_tag 'span', attr_object.try(attrib) || master_ds_object.try(attrib), id: "dyna_span_span#{unique_ref_id}", onclick: "$().dynaspan.upShow('#{unique_ref_id}');", class: 'dyna-span dyna-span-text', style: 'display:block;' %>
   <%= content_tag('div', dyna_span_edit_text, class: 'dyna-span-edit-text pull-right', onclick: "$().dynaspan.upShow('#{unique_ref_id}');", style: 'cursor:pointer;')  %>
-</div>
+</div>

data/app/views/dynaspan/_dynaspan_text_field.html.erb

@@ -2,7 +2,7 @@
 <div id="dyna_span_block<%= unique_ref_id %>" <%= "data-ds-callback-on-update=\"#{ds_callback_on_update}\" " if ds_callback_on_update.present? %> <%= "data-ds-callback-with-values=\"#{ds_callback_with_values}\" " if ds_callback_with_values.present? %>class='dyna-span<%= ' ds-content-present' if (attr_object.try(attrib).present? || master_ds_object.try(attrib).present?) %>'>
   <%= hidden_field_tag "last_dyna_span_val_#{unique_ref_id}", attr_object.try(attrib) || master_ds_object.try(attrib), id: "last_dyna_span_val_#{unique_ref_id}" %>
   <div id="<%= "dyna_span_div#{unique_ref_id}" %>" style="display:none;">
-    <%= form_for(master_ds_object, method: :patch, remote: true, authenticity_token: true) do |f| %>
+    <%= form_for(master_ds_object, **form_for_options.symbolize_keys) do |f| %>
       <% if master_ds_object.nested_attributes_options.keys.any? {|i| i.to_s.=~(/#{attr_object.class.try(:model_name).try(:i18n_key).to_s}/) || i.to_s.=~(/#{attr_object.class.try(:table_name)}/) } and !attr_object.nil? %>
         <%= f.fields_for master_ds_object.nested_attributes_options.keys.select {|i| i.to_s.=~(/#{attr_object.class.model_name.i18n_key.to_s}/) || i.to_s.=~(/#{attr_object.class.table_name}/) }.first, attr_object do |a|%>
           <%= a.hidden_field(:id, value: attr_object.id) if attr_object.id.present? %>
@@ -21,4 +21,4 @@
   </div>
   <%= content_tag 'span', attr_object.try(attrib) || master_ds_object.try(attrib), id: "dyna_span_span#{unique_ref_id}", onclick: "$().dynaspan.upShow('#{unique_ref_id}');", class: 'dyna-span dyna-span-text', style: 'display:block;' %>
   <%= content_tag('div', dyna_span_edit_text, class: 'dyna-span-edit-text pull-right', onclick: "$().dynaspan.upShow('#{unique_ref_id}');", style: 'cursor:pointer;')  %>
-</div>
+</div>

data/dynaspan.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = 'dynaspan'
   gem.require_paths = ['lib']
-  gem.required_ruby_version = '~> 2.0'
+  gem.required_ruby_version = '>= 2.0'
   gem.version       = Dynaspan::VERSION
+  gem.requirements << "jQuery"
+  gem.requirements << "Rails"
 end

data/lib/dynaspan/version.rb

@@ -1,3 +1,3 @@
 module Dynaspan
-  VERSION = '0.1.1'
+  VERSION = '0.1.2.beta1'
 end

data/lib/dynaspan.rb

@@ -1,12 +1,32 @@
 require 'dynaspan/version'
 
+
 module Dynaspan
-  case ::Rails.version.to_s
-  when /^4/
-    require 'dynaspan/engine'
-  when /^3\.[12]/
-    require 'dynaspan/engine3'
-  when /^3\.[0]/
-    require 'dynaspan/railtie'
+  ASSETS = %W(dynaspan/*.js dynaspan/*.css dynaspan/*.png dynaspan/*.gif dynaspan/*.html dynaspan/*.md)
+  INITIALIZER = "initializer 'dynaspan.assets.precompile', group: :all do |app| app.config.assets.precompile += Dynaspan::ASSETS; end"
+
+  class Engine < ::Rails::Engine
+    isolate_namespace Dynaspan
+
+    eval Dynaspan::INITIALIZER
+
+    initializer 'dynaspan.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper Dynaspan::ApplicationHelper
+      end
+    end
+
+    if ::Rails.version.to_s =~ /^4/
+      rake_tasks do
+        load "dynaspan/tasks.rake"
+      end
+    end
+  end
+
+  if ::Rails.version.to_s =~ /^3\.[0]/
+    class Railtie < ::Rails::Railtie
+      eval Dynaspan::INITIALIZER
+    end
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynaspan
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2.beta1
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-31 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies: []
 description: In place text editing with AJAX substituting text to input field.
 email:
@@ -30,9 +30,6 @@ files:
 - lib/assets/javascripts/dynaspan-jquery.js
 - lib/assets/javascripts/dynaspan/basepath.js.erb
 - lib/dynaspan.rb
-- lib/dynaspan/engine.rb
-- lib/dynaspan/engine3.rb
-- lib/dynaspan/railtie.rb
 - lib/dynaspan/tasks.rake
 - lib/dynaspan/version.rb
 - vendor/assets/javascripts/dynaspan/dynaspan.js
@@ -46,17 +43,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
-requirements: []
+      version: 1.3.1
+requirements:
+- jQuery
+- Rails
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Text to AJAX editing in place.

data/lib/dynaspan/engine.rb

@@ -1,26 +0,0 @@
-module Dynaspan
-  class Engine < ::Rails::Engine
-    isolate_namespace Dynaspan
-
-    initializer 'dynaspan.assets.precompile', group: :all do |app|
-      app.config.assets.precompile += %W(
-        dynaspan/*.js
-        dynaspan/*.css
-        dynaspan/*.png
-        dynaspan/*.gif
-        dynaspan/*.html
-        dynaspan/*.md
-      )
-    end
-
-    initializer 'dynaspan.action_controller' do |app|
-      ActiveSupport.on_load :action_controller do
-        helper Dynaspan::ApplicationHelper
-      end
-    end
-
-    rake_tasks do
-      load "dynaspan/tasks.rake"
-    end
-  end
-end

data/lib/dynaspan/engine3.rb

@@ -1,23 +0,0 @@
-module Dynaspan
-  class Engine < ::Rails::Engine
-    isolate_namespace Dynaspan
-
-    initializer 'dynaspan.assets.precompile', group: :all do |app|
-      app.config.assets.precompile += %W(
-        dynaspan/*.js
-        dynaspan/*.css
-        dynaspan/*.png
-        dynaspan/*.gif
-        dynaspan/*.html
-        dynaspan/*.md
-      )
-    end
-
-    initializer 'dynaspan.action_controller' do |app|
-      ActiveSupport.on_load :action_controller do
-        helper Dynaspan::ApplicationHelper
-      end
-    end
-
-  end
-end

data/lib/dynaspan/railtie.rb

@@ -1,14 +0,0 @@
-module Dynaspan
-  class Railtie < ::Rails::Railtie
-    initializer 'dynaspan.assets.precompile', group: :all do |app|
-      app.config.assets.precompile += %W(
-        dynaspan/*.js
-        dynaspan/*.css
-        dynaspan/*.png
-        dynaspan/*.gif
-        dynaspan/*.html
-        dynaspan/*.md
-      )
-    end
-  end
-end