token_field 1.1.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTI5YjFmOTgzY2U2OTY4MTk3N2QyYTY5NDRmNmVhZjI2NTc5NDU4ZQ==
-  data.tar.gz: !binary |-
-    ZTRjNjI2ZTM4Y2FkZmRmMWM4NTgxMTEwM2ZiZmZlMzJiZDdkYmMxZQ==
+SHA1:
+  metadata.gz: 85d4b06c7b4116ae38a8e4400420b91994491213
+  data.tar.gz: 59d38c8bc49e6a5a19ac6dc0ceb8921f84ae6a03
 SHA512:
-  metadata.gz: !binary |-
-    ZDk5OTYzNjYyYzFhNTlmNGZjZDUwOWUwNjA5OGFjNjM5ZTA1ZTNiMjc5NDJl
-    ZjI3NmJiNzVkYzU1ODVhMTVhNjg3M2U1MThhODA0MzdkMmZlNzAwNzBiMzg5
-    NWVhOTk5YWNiMzA3ZDEyMGEwNzc1NTI5YTY2MTBlMGUyMWQ5ZGU=
-  data.tar.gz: !binary |-
-    MjBkNTBjOGViODIxYzgwMmNlNTdiNGQxZWIyNDIwMzZlMzE4M2FkMmY0YWFj
-    MTllYjM0Y2VmYzI3NDJiMmI4MzYzZDVmNWU5NDgwOTY5ODQ3NmU1ZGYwNjZk
-    MmE5NWMzN2RiMWI4ZGIwY2I1ZmM4ZGI1MmU2M2UyOTBiN2NjMGI=
+  metadata.gz: b9a360736e6de51ffd39393ac2a033135fe0ea0aa3948cbe88e4905b907ce13ff3196edcc3151afeda34c19aec630041906a4f7837ba955b1aced71dbbbdd80c
+  data.tar.gz: 51e877060b97959eccc7f7483678fdb8290e52f87e8ff814ca68ee45ac7774c1cb1d635a46c829f0afdfbc13b93bd1013e54508a5ce86b1e1f4d504520c845a1

data/README.md

@@ -1,13 +1,23 @@
 # TokenField
 
-This gem add helper for form_for to Ruby on Rails 3.+
+[![Build Status](https://travis-ci.org/mirrec/token_field.svg?branch=master)](https://travis-ci.org/mirrec/token_field)
+
+This gem add helper for form_for to Ruby on Rails
 form_for helper for token input with jquery token input plugin
 for has_many and belongs_to association
 
 http://railscasts.com/episodes/258-token-fields
+
 http://loopj.com/jquery-tokeninput/
+
 https://github.com/foohey/jquery-tokeninput-rails
 
+Supported Ruby on Rails versions:
+* ~> 3.2.1
+* ~> 4.0.1
+* ~> 4.1.1
+* ~> 4.2.1
+
 helper will render standard text field input with javascript.
 javascript will change standard input to token field input
 
@@ -15,8 +25,10 @@ javascript will change standard input to token field input
 
 Add this line to your application's Gemfile:
 
-    gem "jquery-tokeninput-rails" # dependency
-    gem "token_field"
+```ruby
+gem 'jquery-tokeninput-rails' # dependency
+gem 'token_field'
+```
 
 And then execute:
 
@@ -38,85 +50,105 @@ usage for tree
 
 we have a model Category like this
 
-    class Category < ActiveRecord::Base
-       attr_accessible :name, :parent_id
 
-       has_many :categories, :foreign_key => :parent_id
-       belongs_to :parent, :foreign_key => :parent_id, :class_name => "Category"
+```ruby
+class Category < ActiveRecord::Base
+  attr_accessible :name, :parent_id
 
-       # method for converting array of categories to array of hashes in format that token input accepts
-       def self.token_json(items)
-         items.map{|i| {:id => i.id, :name => i.name} }
-       end
-    end
+  has_many :categories, :foreign_key => :parent_id
+  belongs_to :parent, :foreign_key => :parent_id, :class_name => "Category"
+
+  # format that token input use
+  def to_token
+   {:id => id, :name => name}
+  end
+end
+```
 
 we have action for responding for token input ajax calls, simple autocomplete
 
-    class CategoriesController < ApplicationController
+```ruby
+class CategoriesController < ApplicationController
 
-       # action for autocomplete
-       def token
-         @categories = Category.where("categories.name like ?", "%#{params[:q]}%")
-         respond_to do |format|
-           format.json { render :json => Category.token_json(@categories) }
-         end
-       end
+  # action for autocomplete
+  def token
+   categories = Category.where("categories.name like ?", "%#{params[:q]}%")
 
-       # rest of the class
-    end
+   respond_to do |format|
+     format.json { render :json => categories.map(&:to_token) }
+   end
+  end
+
+  # rest of the class
+end
+```
 
 in routes we have route for token ajax call
 
-    MyApplication::Application.routes.draw do
-       resources :categories do
-         collection do
-           get :token # route for token -> token_categories_path
-         end
-       end
+```ruby
+MyApplication::Application.routes.draw do
+  resources :categories do
+    collection do
+     get :token # route for token -> token_categories_path
     end
+  end
+end
+```
 
 then in view we call token_field with param :model => :category
 
-    <%= form_for @category do |f| %>
-       <%= f.token_field :parent_id, :model => :category, :token_url => token_categories_path %>
-    <% end %>
+```erb
+<%= form_for @category do |f| %>
+   <%= f.token_field :parent_id, :model => :category, :token_url => token_categories_path %>
+<% end %>
+```
 
 in case model is in namespace for example MyApp you should use :model like this
 
-    <%= form_for @category do |f| %>
-       <%= f.token_field :parent_id, :model => "MyApp::Category", :token_url => token_categories_path %>
-    <% end %>
+```erb
+<%= form_for @category do |f| %>
+   <%= f.token_field :parent_id, :model => "MyApp::Category", :token_url => token_categories_path %>
+<% end %>
+```
 
 if you need dynamically evaluated url of token input, you can pass inline javascript function to `:token_url` options but with `:token_url_is_function` set to `true`
 
-    <%= form_for @category do |f| %>
-       <%= f.token_field :parent_id, :model => :category, :token_url => "function(){ return '/hello' }", :token_url_is_function => true %>
-    <% end %>
+```erb
+<%= form_for @category do |f| %>
+   <%= f.token_field :parent_id, :model => :category, :token_url => "function(){ return '/hello' }", :token_url_is_function => true %>
+<% end %>
+```
 
 also own separate function are supported
 
-    <%= form_for @category do |f| %>
-       <%= f.token_field :parent_id, :model => :category, :token_url => "myDynamicUrl", :token_url_is_function => true %>
-    <% end %>
+```erb
+<%= form_for @category do |f| %>
+  <%= f.token_field :parent_id, :model => :category, :token_url => "myDynamicUrl", :token_url_is_function => true %>
+<% end %>
 
-    <script type="text/javascript">
-      function myDynamicUrl() {
-        return "/my-url/";
-      }
-    </script>
+<script type="text/javascript">
+  function myDynamicUrl() {
+    return "/my-url/";
+  }
+</script>
+```
 
 if there would be model Parent, we can omit :model parameter.
 for example in Product model like this
 
-    class Product < ActiveRecord::Base
-       belongs_to :category
-    end
+```ruby
+class Product < ActiveRecord::Base
+  belongs_to :category
+end
+```
 
 we can use this code in view
 
-    <%= form_for @product do |f| %>
-      <%= f.token_field :category_id, :token_url => token_categories_path %>
-    <% end %>
+```erb
+<%= form_for @product do |f| %>
+  <%= f.token_field :category_id, :token_url => token_categories_path %>
+<% end %>
+```
 
 helper will allow you to enter only one element.
 
@@ -126,40 +158,48 @@ We can use token_input also for mapping categories to product
 we will use ActiveRecord method category_ids which be default return array of ids from association
 in model we have to change category_ids= method like this
 
-    class Product < ActiveRecord::Base
-       has_many :product_has_categories
-       has_many :categories, :through => :product_has_categories
+```ruby
+class Product < ActiveRecord::Base
+  has_many :product_has_categories
+  has_many :categories, :through => :product_has_categories
 
-       alias_method :category_ids_old=, :category_ids=
-       def category_ids=(ids)
-         ids = ids.split(",").map(&:to_i) if ids.is_a?(String)
-         self.category_ids_old=ids
-       end
+  alias_method :category_ids_old=, :category_ids=
+  def category_ids=(ids)
+    ids = ids.split(",").map(&:to_i) if ids.is_a?(String)
+    self.category_ids_old=ids
+  end
 
-       # rest of the class...
-    end
+  # rest of the class...
+end
+```
 
 in view you will use attribute category_ids. token input will expected more than one category.
 so you can enter more than one category.
 
-    <%= form_for @product do |f| %>
-       <%= f.token_field :category_ids, :token_url => token_categories_path %>
-    <% end %>
+```erb
+<%= form_for @product do |f| %>
+  <%= f.token_field :category_ids, :token_url => token_categories_path %>
+<% end %>
+```
 
 if you want to use multiple token inputs on page, and id of element would be the same, you can user option :append_to_id.
 
-    <%= form_for @product do |f| %>
-       <%= f.token_field :category_ids, :token_url => token_categories_path, :append_to_id => :id %>
-    <% end %>
+```erb
+<%= form_for @product do |f| %>
+   <%= f.token_field :category_ids, :token_url => token_categories_path, :append_to_id => :id %>
+<% end %>
+```
 
 if @product.id is present and for example "3" it will use this id and generate id of html input like this "product_categories_ids_3"
 if @product.id is nil id of html input will be "product_categories_ids"
 
 other value for :append_id option will be used like this
 
-    <%= form_for @product do |f| %>
-       <%= f.token_field :category_ids, :token_url => token_categories_path, :append_to_id => 5 %>
-    <% end %>
+```erb
+<%= form_for @product do |f| %>
+  <%= f.token_field :category_ids, :token_url => token_categories_path, :append_to_id => 5 %>
+<% end %>
+```
 
 id of html input will be "product_categories_ids_5"
 
@@ -168,39 +208,57 @@ id of html input will be "product_categories_ids_5"
 if you use simple_form in your project, TokenInput field will be loaded.
 you can use it in view like this
 
-    <%= simple_form_for(@item) do |f| %>
-      <%= f.input :category_id, :as => :token, :token_url => token_categories_path %>
-    <% end %>
+```erb
+<%= simple_form_for(@item) do |f| %>
+  <%= f.input :category_id, :as => :token, :token_url => token_categories_path %>
+<% end %>
+```
 
 all options for token_field helper can be used in simple form helper as well.
 
+## Updating from 1.x to 2.0
+
+* Add `#to_token` method to model you are using
+* Remove `.token_json` method, we don't use it anymore
+* require dsl helper for tests (see below)
+
 ## Testing
 
 add support for helpers in rspec
 
-    RSpec.configure do |config|
-      config.include TokenField::Capybara::Dsl
-    end
+```ruby
+require 'token_field/capybara/dsl'
+
+RSpec.configure do |config|
+  config.include TokenField::Capybara::Dsl
+end
+```
 
 ### test helpers for capybara
 
 filling token input
 
-    fill_in "category_parent_id", :with => new_parent.id # standard input
-    fill_in_token "category_parent_id", :with => "wood"
+```ruby
+fill_in "category_parent_id", :with => new_parent.id # standard input
+fill_in_token "category_parent_id", :with => "wood"
+fill_in_token "category_parent_id", :with => "wood", :waiting_call => lambda { sleep(4) }
+```
 
 clearing token input
 
-    clear_token "category_parent_id"
+```ruby
+clear_token "category_parent_id"
+```
 
 project is covered by integration tests. using rspec, capybara and selenium
 how to run test
 
-    bundle # install dependency
-    rake db:create
-    rake db:migrate RAILS_ENV=test
-    rspec spec/
-
+```bash
+bundle # install dependency
+rake db:create
+rake db:migrate RAILS_ENV=test
+rspec spec/
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,26 +1,18 @@
 #!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'TokenField'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require 'rspec/core/rake_task'
 
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
+
+begin
+
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+end

data/lib/token_field/capybara/dsl.rb

@@ -2,8 +2,9 @@ module TokenField
   module Capybara
     module Dsl
       def fill_in_token(id, options)
+        waiting = options.fetch(:waiting_call) { lambda { sleep(1) } }
         fill_in "token-input-#{input_id(id, options)}", options
-        sleep(1)
+        waiting.call
         find(".token-input-dropdown-facebook li").click
       end
 

data/lib/token_field/engine.rb

@@ -11,9 +11,5 @@ module TokenField
     initializer "token_input" do
       require "token_field/simple_form/token_input" if defined?(SimpleForm)
     end
-
-    initializer "token_field_test_helper" do
-      require "token_field/capybara/dsl" if Rails.env.test?
-    end
   end
 end

data/lib/token_field/form_builder.rb

@@ -19,8 +19,8 @@ module TokenField
     #   has_many :products
     #
     #   # method for converting array of categories to array of hashes in format that token input accepts
-    #   def self.token_json(items)
-    #     items.map{|i| {:id => i.id, :name => i.name} }
+    #   def to_token
+    #     {:id => id, :name => name}
     #   end
     # end
     #
@@ -34,9 +34,10 @@ module TokenField
     #
     #   # action for autocomplete
     #   def token
-    #     @categories = Category.where("categories.name like ?", "%#{params[:q]}%")
+    #     categories = Category.where("categories.name like ?", "%#{params[:q]}%")
+    #
     #     respond_to do |format|
-    #       format.json { render :json => Category.token_json(@categories) }
+    #       format.json { render :json => categories.map(&:to_token) }
     #     end
     #   end
     #
@@ -92,20 +93,16 @@ module TokenField
     # end
     def token_field(attribute_name, options = {})
       association_type = @object.send(attribute_name).respond_to?(:each) ? :many : :one
-      model_name = (options[:model] || attribute_name.to_s.gsub(/_ids?/, "")).to_s
+      model_name = options.fetch(:model) { attribute_name.to_s.gsub(/_ids?/, "") }.to_s
       association = attribute_name.to_s.gsub(/_ids?/, "").to_sym
-      model = model_name.camelize.constantize
-      token_url = options[:token_url]
+      token_url = options.fetch(:token_url) { "/#{model_name.pluralize}/token.json" }
       token_url_is_function = options.fetch(:token_url_is_function) { false }
       append_to_id = options[:append_to_id]
+      token_method = options.fetch(:token_method) { :to_token }
 
       token_limit = nil
       token_limit = 1 if association_type == :one
 
-      if token_url.nil?
-        token_url = "/#{model_name.pluralize}/token.json"
-      end
-
       id = @object.send(:id)
 
       html_id = "#{@object_name}_#{attribute_name.to_s}"
@@ -116,16 +113,17 @@ module TokenField
       end
       html_id = html_id.parameterize.underscore
 
-      value = nil
-      data_pre = nil
-      if association_type == :one && @object.send(association)
-        data_pre = model.token_json([@object.send(association)]).to_json()
-        value = @object.send(association).id
-      elsif association_type == :many && @object.send(association.to_s.pluralize).count > 0
-        data_pre = model.token_json(@object.send(association.to_s.pluralize)).to_json()
-        value = @object.send(attribute_name).join(",")
+      results = []
+
+      if association_type == :one && @object.public_send(association)
+        results << @object.public_send(association)
+      elsif association_type == :many && @object.public_send(association.to_s.pluralize).count > 0
+        @object.public_send(association.to_s.pluralize).each { |record| results << record }
       end
 
+      data_pre = results.map{ |result| result.public_send(token_method) }
+      value = data_pre.map{ |row| row[:id] }.join(',')
+
       on_add = options[:on_add] ? "#{options[:on_add]}" : "false"
       on_delete = options[:on_delete] ? "#{options[:on_delete]}" : "false"
 
@@ -149,7 +147,7 @@ module TokenField
           });
       "
       script = content_tag(:script, js_content.html_safe, :type => Mime::JS)
-      text_field("#{attribute_name}", "data-pre" => data_pre, :value => value, :id => html_id) + script
+      text_field("#{attribute_name}", "data-pre" => data_pre.to_json, :value => value, :id => html_id) + script
     end
   end
 end