token_field 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,181 @@
+# TokenField
+
+This gem add helper for form_for to Ruby on Rails 3.+
+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
+
+helper will render standard text field input with javascript.
+javascript will change standard input to token field input
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "jquery-tokeninput-rails" # dependency
+    gem "token_field"
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Javascript include
+
+    //= require jquery.tokeninput
+
+### Stylesheet include
+
+    *= require token-input-facebook
+
+### belongs_to with token_input
+
+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"
+
+       # 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
+
+we have action for responding for token input ajax calls, simple autocomplete
+
+    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
+
+       # 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
+    end
+
+then in view we call token_field with param :model => :category
+
+    <%= form_for @category do |f| %>
+       <%= f.token_field :parent_id, :model => :category %>
+    <% end %>
+
+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
+
+we can use this code in view
+
+    <%= form_for @product do |f| %>
+      <%= f.token_field :category_id %>
+    <% end %>
+
+helper will allow you to enter only one element.
+
+### has_many with token_input
+
+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
+
+       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
+
+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 %>
+    <% 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, :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, :append_to_id => 5 %>
+    <% end %>
+
+id of html input will be "product_categories_ids_5"
+
+## Testing
+
+add support for helpers in rspec
+
+    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"
+
+clearing token input
+
+    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/
+
+
+## Contributing
+
+1. Fork it
+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
+
+
+## Licence
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,26 @@
+#!/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
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/lib/token_field/capybara/dsl.rb

@@ -0,0 +1,25 @@
+module TokenField
+  module Capybara
+    module Dsl
+      def fill_in_token(id, options)
+        fill_in "token-input-#{input_id(id, options)}", options
+        sleep(1)
+        find(".token-input-dropdown-facebook li").click
+      end
+
+      def clear_token(id, options={})
+        remove_buttons = page.all(:xpath, "//input[@id='#{input_id(id, options)}']/preceding-sibling::ul[@class='token-input-list-facebook'][last()]/descendant::span[@class='token-input-delete-token-facebook']")
+        remove_buttons.each{ |button| button.click }
+      end
+
+      private
+
+      def input_id(id, options)
+        input_id = id
+        element_id = options.delete(:element_id)
+        input_id << "_#{element_id}" if element_id
+        input_id
+      end
+    end
+  end
+end

data/lib/token_field/engine.rb

@@ -0,0 +1,11 @@
+module TokenField
+  class Engine < ::Rails::Engine
+    isolate_namespace TokenField
+
+    initializer "token_field" do
+      ActionView::Helpers::FormBuilder.instance_eval do
+        include TokenField::FormBuilder
+      end
+    end
+  end
+end

data/lib/token_field/form_builder.rb

@@ -0,0 +1,150 @@
+module TokenField
+  module FormBuilder
+    include ActionView::Helpers
+
+    #
+    # 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/
+    #
+    # helper will render standard text field input with javascript.
+    # javascript will change standard input to token field input
+    #
+    # EXAMPLE
+    #
+    # class Category < ActiveRecord::Base
+    #   attr_accessible :name, :parent_id, :product_ids
+    #   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} }
+    #   end
+    # end
+    #
+    # class Product < ActiveRecord::Base
+    #   attr_accessible :name, :category_id
+    #
+    #   belongs_to :category
+    # end
+    #
+    # 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
+    #
+    #   # rest of the class
+    # end
+    #
+    # then in routes add 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
+    # end
+    #
+    # then in view we call token_field
+    # token_field input will be default expects, that Category model exists
+    # <%= form_for @product do |f| %>
+    #   <%= f.token_field :category_id %>
+    # <% end %>
+    #
+    # possible options:
+    #
+    # in case the association roles where given like this
+    #
+    # class Product < ActiveRecord::Base
+    #    belongs_to :cat, :class_name => 'Category', :foreign_key => :cat_id
+    # end
+    #
+    # then right model need to be specified
+    #
+    # <%= f.token_field :cat_id, :model => :category %>
+    #
+    # We can use token_input also for mapping category to products
+    # we will use ActiveRecord method product_ids which be default return array of ids from association
+    # <%= form_for @category do |f| %>
+    #   <%= f.token_field :product_ids %>
+    # <% end %>
+    #
+    # in model we have to change product_ids= method like this
+    #
+    # class Category < ActiveRecord::Base
+    #   has_many :products
+    #
+    #   alias_method :product_ids_old=, :product_ids=
+    #   def product_ids=(ids)
+    #     ids = ids.split(",").map(&:to_i) if ids.is_a?(String)
+    #     self.product_ids_old=ids
+    #   end
+    #
+    #   # rest of the class...
+    # 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
+      association = attribute_name.to_s.gsub(/_ids?/, "").to_sym
+      model = model_name.camelize.constantize
+      token_url = options[:token_url]
+      append_to_id = options[:append_to_id]
+
+      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}"
+      if append_to_id == :id && id
+        html_id << "_#{id}"
+      elsif append_to_id && append_to_id != :id
+        html_id << "_#{append_to_id}"
+      end
+
+      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(",")
+      end
+
+      on_add = options[:on_add] ? "#{options[:on_add]}" : "false"
+      on_delete = options[:on_delete] ? "#{options[:on_delete]}" : "false"
+
+      text_field("#{attribute_name}", "data-pre" => data_pre, :value => value, :id => html_id)+
+          javascript_tag("
+        jQuery.noConflict();
+        jQuery(function() {
+          jQuery('##{html_id}').tokenInput('#{token_url}', {
+            crossDomain: false,
+            tokenLimit: #{token_limit.nil? ? "null" : token_limit.to_i},
+            preventDuplicates: true,
+            prePopulate: jQuery('##{attribute_name}').data('pre'),
+            theme: 'facebook',
+            hintText: '"+t('helpers.token_field.hint_text')+"',
+            searchingText: '"+t('helpers.token_field.searching_text')+"',
+            noResultsText: '"+t('helpers.token_field.no_results_text')+"',
+            onAdd: "+on_add+",
+            onDelete: "+on_delete+"
+            });
+          });
+      ")
+    end
+  end
+end

data/lib/token_field/version.rb

@@ -0,0 +1,3 @@
+module TokenField
+  VERSION = "0.0.1"
+end

data/lib/token_field.rb

@@ -0,0 +1,3 @@
+require "token_field/form_builder"
+require "token_field/engine"
+require "token_field/capybara/dsl" if Rails.env.test?

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks