numerous 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81cd7af81cd06630de6c5c5977a968826255a02c
-  data.tar.gz: 22d6039e73429dabfe34569d7f5abf899e51cd37
+  metadata.gz: 3e171328d544adba51ab1f9e6b751750fc6de531
+  data.tar.gz: 094e754f7254e0363d46495951010634f59a4872
 SHA512:
-  metadata.gz: 4718911d49efb631de58edaaa5ead5ea6d3f1496cefdf991926a3c942d001447af1c7dbd102424ded5b49c2fbdcedd22e0233279b3208dd9f9d8fb18330263d7
-  data.tar.gz: 3c2fe0669927189d31fc6faef9d23f708083620388eff504f6e8d5156aa2a14fee5795e61ddc7d5a96b4f766d747a6000d4b7d82dfe12beafee210635b14fbda
+  metadata.gz: 910b9271a851ccf48c4e126a43b36da506adf3f7245458a4407dd9061a803c1d9a73317041657729d6db2c602526a2721b513da129d137eb083ce2d00ab19325
+  data.tar.gz: 717c11e534d8fcd6bcfd022dc0226013d6b30cac3ce2029cd40758177b36d4ae2ef801fe4bc888c02a7da8438d71267faf0758b67aed127cf786cd0dcd5e304a

data/README.md

@@ -1,6 +1,8 @@
 # Numerous
 
-TODO: Write a gem description
+Gem for numerous plugin
+* Source code available here: https://github.com/kbparagua/numerous.js
+* Live demo available here: http://numerous-js.herokuapp.com/
 
 ## Installation
 
@@ -18,12 +20,140 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### JS
 
-## Contributing
+In your application.js: `//= require numerous`
 
-1. Fork it ( https://github.com/[my-github-username]/numerous/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 a new Pull Request
+
+## Quick Start
+
+1. Create an element where the new forms will be appended.
+
+        <div id="list"></div>
+
+
+2. Create a `fields_for` template to be used when adding a new object. 
+
+        <div id="fields-for-list" class="numerous">
+        
+          <%= form.fields_for :objects, Object.new, :child_index => 'replace_this' do |f| %>
+            <%= f.text_field :object_field %>
+            <%= f.text_field :another_object_field %>
+           ...    
+            <%= link_to 'Remove', '#', :class => 'numerous-remove' %>
+        </div>
+
+
+3. Create a link for adding new objects. 
+
+        <%= link_to 'Add Object', '#', :id => 'add-to-list' %>
+
+
+
+4. Call `Numerous.init()` when the document is ready:
+
+        $(document).ready(function(){
+          Numerous.init();
+        });
+
+
+
+## Naming Conventions
+
+1. The whole `fields_for` section must be under a div like this:
+
+        <div id="fields-for-[list id]" class="numerous">
+
+2. `fields_for` objects must have 'replace_this' as the `:child_index` value.
+        
+        <%= form.fields_for :objects, Object.new, :child_index => 'replace_this' do |f| %>
+
+
+3. Put a `numerous-remove` link if you want the ability to delete objects.
+        
+        <%= link_to 'Remove', '#', :class => 'numerous-remove' %>
+      
+
+  Set `:allow_destroy => true` to the parent model if you want this functionality.
+
+        class Parent < ActiveRecord::Base
+          has_many :lists
+          accepts_nested_attributes_for :lists, :allow_destroy => true
+        end
+
+
+4. The add link must follow this id template:
+        
+        <%= link_to 'Add Object', '#', :id => 'add-to-[list id]' %>
+
+
+## Callbacks
+You can add callbacks which will be called after adding or removing a `fields_for` instance.
+
+        Numerous.init({
+          'list-name' : {
+            'add' : function(form){
+              alert("I'm adding another fields_for instance!");
+              // do something here
+            },
+            
+            'remove' : function(form){
+              alert("I'm removing a fields_for instance!");
+              // do something here
+            }
+          }
+        });
+
+The `add` and `remove` callbacks take 1 parameter which is the `fields_for` element that is added or removed. 
+
+
+## Updating Objects
+By default numerous.js is adding `fields-for-[list id]` class to all `fields_for` instance you've added.
+If you want to be able to remove existing objects, put the `fields_for` under a `fields-for-[list id]` div.
+
+        <% parent.lists.each do |list| %>
+          <div class='fields-for-list'>
+            <%= form.fields_for :list, list do |f| %>
+              <%= f.text_field :object_field %>
+              <%= f.text_field :another_object_field %>
+              ...    
+              <%= link_to 'Remove', '#', :class => 'numerous-remove' %>
+            <% end %>
+          </div>
+        <% end %>
+
+## Initialization Options
+
+`add : function()`
+- A callback that will be called every time a new object is added.
+
+`remove : function()`
+- A callback that will be called every time an object is removed.
+
+`initial : number | function()`
+- An integer or a funtion that returns an integer.
+- The list will initially have this number of object.
+- defaults to 0.
+
+`after-initialize : function()`
+- A callback that will be called after initializing the list.
+
+
+## Helper Methods
+
+`Numerous.count(String list)`
+- returns the current count (Number) of the visible objects under the passed list
+
+
+`Numerous.get(String list)`
+- returns all the objects (HTML Elements) under the passed list
+
+
+`Numerous.removeAll(String list)`
+- triggers the remove link of all the list objects
+
+## Credits
+
+Karl Bryan P. Paragua
+
+www.daftcoder.com

data/lib/numerous/version.rb

@@ -1,3 +1,3 @@
 module Numerous
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: numerous
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Geoffrey Hervet
@@ -58,7 +58,7 @@ files:
 - lib/numerous.rb
 - lib/numerous/version.rb
 - numerous.gemspec
-- vendor/assets/javascripts/numerous.js
+- vendor/assets/javascripts/numerous/numerous.js
 homepage: https://github.com/kbparagua/numerous.js
 licenses:
 - MIT