token_field 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/MIT-LICENSE +20 -0
- data/README.md +181 -0
- data/Rakefile +26 -0
- data/lib/token_field/capybara/dsl.rb +25 -0
- data/lib/token_field/engine.rb +11 -0
- data/lib/token_field/form_builder.rb +150 -0
- data/lib/token_field/version.rb +3 -0
- data/lib/token_field.rb +3 -0
- data/spec/dummy/README.rdoc +261 -0
- data/spec/dummy/Rakefile +7 -0
- data/spec/dummy/app/assets/javascripts/application.js +16 -0
- data/spec/dummy/app/assets/stylesheets/application.css +14 -0
- data/spec/dummy/app/controllers/application_controller.rb +3 -0
- data/spec/dummy/app/controllers/categories_controller.rb +38 -0
- data/spec/dummy/app/controllers/products_controller.rb +31 -0
- data/spec/dummy/app/helpers/application_helper.rb +2 -0
- data/spec/dummy/app/models/category.rb +10 -0
- data/spec/dummy/app/models/product.rb +13 -0
- data/spec/dummy/app/models/product_has_category.rb +6 -0
- data/spec/dummy/app/views/categories/_form.html.erb +12 -0
- data/spec/dummy/app/views/categories/edit.html.erb +2 -0
- data/spec/dummy/app/views/categories/index.html.erb +9 -0
- data/spec/dummy/app/views/categories/new.html.erb +2 -0
- data/spec/dummy/app/views/layouts/application.html.erb +14 -0
- data/spec/dummy/app/views/products/_form.html.erb +12 -0
- data/spec/dummy/app/views/products/edit.html.erb +2 -0
- data/spec/dummy/app/views/products/index.html.erb +9 -0
- data/spec/dummy/app/views/products/new.html.erb +2 -0
- data/spec/dummy/config/application.rb +59 -0
- data/spec/dummy/config/boot.rb +10 -0
- data/spec/dummy/config/database.yml +25 -0
- data/spec/dummy/config/environment.rb +5 -0
- data/spec/dummy/config/environments/development.rb +37 -0
- data/spec/dummy/config/environments/production.rb +67 -0
- data/spec/dummy/config/environments/test.rb +37 -0
- data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
- data/spec/dummy/config/initializers/inflections.rb +15 -0
- data/spec/dummy/config/initializers/mime_types.rb +5 -0
- data/spec/dummy/config/initializers/secret_token.rb +7 -0
- data/spec/dummy/config/initializers/session_store.rb +8 -0
- data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
- data/spec/dummy/config/locales/en.yml +5 -0
- data/spec/dummy/config/routes.rb +11 -0
- data/spec/dummy/config.ru +4 -0
- data/spec/dummy/db/development.sqlite3 +0 -0
- data/spec/dummy/db/migrate/20121012100526_create_categories.rb +10 -0
- data/spec/dummy/db/migrate/20121012235444_create_products.rb +9 -0
- data/spec/dummy/db/migrate/20121012235509_create_product_has_categories.rb +10 -0
- data/spec/dummy/db/schema.rb +36 -0
- data/spec/dummy/db/test.sqlite3 +0 -0
- data/spec/dummy/log/development.log +2848 -0
- data/spec/dummy/log/test.log +5938 -0
- data/spec/dummy/public/404.html +26 -0
- data/spec/dummy/public/422.html +26 -0
- data/spec/dummy/public/500.html +25 -0
- data/spec/dummy/public/favicon.ico +0 -0
- data/spec/dummy/script/rails +6 -0
- data/spec/dummy/tmp/cache/assets/BFD/FA0/sprockets%2F956cc6670041848963c189f12a536075 +0 -0
- data/spec/dummy/tmp/cache/assets/C68/F70/sprockets%2F03000591510dc6784ee531c103e66a7a +0 -0
- data/spec/dummy/tmp/cache/assets/C82/490/sprockets%2F2cea86012965b76f28b56b4522099f12 +0 -0
- data/spec/dummy/tmp/cache/assets/C8A/7F0/sprockets%2F4e7378273896b0f7371ca47f4a24128d +0 -0
- data/spec/dummy/tmp/cache/assets/CCB/5D0/sprockets%2F2b021b5261218f4183021778bade6ddd +0 -0
- data/spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
- data/spec/dummy/tmp/cache/assets/D0F/700/sprockets%2Fb728373cb12011fa141dfc9a8386ef89 +0 -0
- data/spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
- data/spec/dummy/tmp/cache/assets/D3E/1E0/sprockets%2Fd3e4a0e0e469d4f2099f2991fc52bd10 +0 -0
- data/spec/dummy/tmp/cache/assets/D4C/880/sprockets%2Fbb9e5647377f244f135f349fc70e7cba +0 -0
- data/spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655 +0 -0
- data/spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
- data/spec/dummy/tmp/cache/assets/D63/FB0/sprockets%2Faed0411c9144264bba7519e8cfda37b4 +0 -0
- data/spec/dummy/tmp/cache/assets/D7F/9E0/sprockets%2Fd984f45a60778c3cf14f1df92b0d9e6d +0 -0
- data/spec/dummy/tmp/cache/assets/DA5/100/sprockets%2F7d657d1d3bce59d08ee0cf74f16086ba +0 -0
- data/spec/dummy/tmp/cache/assets/DA7/A00/sprockets%2Fac9acf238820db9d87b3f81c5de1298b +0 -0
- data/spec/dummy/tmp/cache/assets/DAC/370/sprockets%2F03a081dc7732cd2c4cbb10a57caa43ec +0 -0
- data/spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994 +0 -0
- data/spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af +0 -0
- data/spec/dummy/tmp/cache/assets/E1A/730/sprockets%2Fa4e8a61e45b4a04eeb1b2fb5f1b90edb +0 -0
- data/spec/dummy/tmp/pids/server.pid +1 -0
- data/spec/factories/factories.rb +11 -0
- data/spec/requests/categories_spec.rb +68 -0
- data/spec/requests/products_spec.rb +70 -0
- data/spec/spec_helper.rb +62 -0
- metadata +352 -0
data/MIT-LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright 2012 YOURNAME
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,181 @@
|
|
1
|
+
# TokenField
|
2
|
+
|
3
|
+
This gem add helper for form_for to Ruby on Rails 3.+
|
4
|
+
form_for helper for token input with jquery token input plugin
|
5
|
+
for has_many and belongs_to association
|
6
|
+
|
7
|
+
http://railscasts.com/episodes/258-token-fields
|
8
|
+
http://loopj.com/jquery-tokeninput/
|
9
|
+
https://github.com/foohey/jquery-tokeninput-rails
|
10
|
+
|
11
|
+
helper will render standard text field input with javascript.
|
12
|
+
javascript will change standard input to token field input
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
Add this line to your application's Gemfile:
|
17
|
+
|
18
|
+
gem "jquery-tokeninput-rails" # dependency
|
19
|
+
gem "token_field"
|
20
|
+
|
21
|
+
And then execute:
|
22
|
+
|
23
|
+
$ bundle
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
### Javascript include
|
28
|
+
|
29
|
+
//= require jquery.tokeninput
|
30
|
+
|
31
|
+
### Stylesheet include
|
32
|
+
|
33
|
+
*= require token-input-facebook
|
34
|
+
|
35
|
+
### belongs_to with token_input
|
36
|
+
|
37
|
+
usage for tree
|
38
|
+
|
39
|
+
we have a model Category like this
|
40
|
+
|
41
|
+
class Category < ActiveRecord::Base
|
42
|
+
attr_accessible :name, :parent_id
|
43
|
+
|
44
|
+
has_many :categories, :foreign_key => :parent_id
|
45
|
+
belongs_to :parent, :foreign_key => :parent_id, :class_name => "Category"
|
46
|
+
|
47
|
+
# method for converting array of categories to array of hashes in format that token input accepts
|
48
|
+
def self.token_json(items)
|
49
|
+
items.map{|i| {:id => i.id, :name => i.name} }
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
we have action for responding for token input ajax calls, simple autocomplete
|
54
|
+
|
55
|
+
class CategoriesController < ApplicationController
|
56
|
+
|
57
|
+
# action for autocomplete
|
58
|
+
def token
|
59
|
+
@categories = Category.where("categories.name like ?", "%#{params[:q]}%")
|
60
|
+
respond_to do |format|
|
61
|
+
format.json { render :json => Category.token_json(@categories) }
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
# rest of the class
|
66
|
+
end
|
67
|
+
|
68
|
+
in routes we have route for token ajax call
|
69
|
+
|
70
|
+
MyApplication::Application.routes.draw do
|
71
|
+
resources :categories do
|
72
|
+
collection do
|
73
|
+
get :token # route for token -> token_categories_path
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
then in view we call token_field with param :model => :category
|
79
|
+
|
80
|
+
<%= form_for @category do |f| %>
|
81
|
+
<%= f.token_field :parent_id, :model => :category %>
|
82
|
+
<% end %>
|
83
|
+
|
84
|
+
if there would be model Parent, we can omit :model parameter.
|
85
|
+
for example in Product model like this
|
86
|
+
|
87
|
+
class Product < ActiveRecord::Base
|
88
|
+
belongs_to :category
|
89
|
+
end
|
90
|
+
|
91
|
+
we can use this code in view
|
92
|
+
|
93
|
+
<%= form_for @product do |f| %>
|
94
|
+
<%= f.token_field :category_id %>
|
95
|
+
<% end %>
|
96
|
+
|
97
|
+
helper will allow you to enter only one element.
|
98
|
+
|
99
|
+
### has_many with token_input
|
100
|
+
|
101
|
+
We can use token_input also for mapping categories to product
|
102
|
+
we will use ActiveRecord method category_ids which be default return array of ids from association
|
103
|
+
in model we have to change category_ids= method like this
|
104
|
+
|
105
|
+
class Product < ActiveRecord::Base
|
106
|
+
has_many :product_has_categories
|
107
|
+
has_many :categories, :through => :product_has_categories
|
108
|
+
|
109
|
+
alias_method :category_ids_old=, :category_ids=
|
110
|
+
def category_ids=(ids)
|
111
|
+
ids = ids.split(",").map(&:to_i) if ids.is_a?(String)
|
112
|
+
self.category_ids_old=ids
|
113
|
+
end
|
114
|
+
|
115
|
+
# rest of the class...
|
116
|
+
end
|
117
|
+
|
118
|
+
in view you will use attribute category_ids. token input will expected more than one category.
|
119
|
+
so you can enter more than one category.
|
120
|
+
|
121
|
+
<%= form_for @product do |f| %>
|
122
|
+
<%= f.token_field :category_ids %>
|
123
|
+
<% end %>
|
124
|
+
|
125
|
+
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.
|
126
|
+
|
127
|
+
<%= form_for @product do |f| %>
|
128
|
+
<%= f.token_field :category_ids, :append_to_id => :id %>
|
129
|
+
<% end %>
|
130
|
+
|
131
|
+
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"
|
132
|
+
if @product.id is nil id of html input will be "product_categories_ids"
|
133
|
+
|
134
|
+
other value for :append_id option will be used like this
|
135
|
+
|
136
|
+
<%= form_for @product do |f| %>
|
137
|
+
<%= f.token_field :category_ids, :append_to_id => 5 %>
|
138
|
+
<% end %>
|
139
|
+
|
140
|
+
id of html input will be "product_categories_ids_5"
|
141
|
+
|
142
|
+
## Testing
|
143
|
+
|
144
|
+
add support for helpers in rspec
|
145
|
+
|
146
|
+
RSpec.configure do |config|
|
147
|
+
config.include TokenField::Capybara::Dsl
|
148
|
+
end
|
149
|
+
|
150
|
+
### test helpers for capybara
|
151
|
+
|
152
|
+
filling token input
|
153
|
+
|
154
|
+
fill_in "category_parent_id", :with => new_parent.id # standard input
|
155
|
+
fill_in_token "category_parent_id", :with => "wood"
|
156
|
+
|
157
|
+
clearing token input
|
158
|
+
|
159
|
+
clear_token "category_parent_id"
|
160
|
+
|
161
|
+
project is covered by integration tests. using rspec, capybara and selenium
|
162
|
+
how to run test
|
163
|
+
|
164
|
+
bundle # install dependency
|
165
|
+
rake db:create
|
166
|
+
rake db:migrate RAILS_ENV=test
|
167
|
+
rspec spec/
|
168
|
+
|
169
|
+
|
170
|
+
## Contributing
|
171
|
+
|
172
|
+
1. Fork it
|
173
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
174
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
175
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
176
|
+
5. Create new Pull Request
|
177
|
+
|
178
|
+
|
179
|
+
## Licence
|
180
|
+
|
181
|
+
This project rocks and uses MIT-LICENSE.
|
data/Rakefile
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
begin
|
3
|
+
require 'bundler/setup'
|
4
|
+
rescue LoadError
|
5
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
6
|
+
end
|
7
|
+
begin
|
8
|
+
require 'rdoc/task'
|
9
|
+
rescue LoadError
|
10
|
+
require 'rdoc/rdoc'
|
11
|
+
require 'rake/rdoctask'
|
12
|
+
RDoc::Task = Rake::RDocTask
|
13
|
+
end
|
14
|
+
|
15
|
+
RDoc::Task.new(:rdoc) do |rdoc|
|
16
|
+
rdoc.rdoc_dir = 'rdoc'
|
17
|
+
rdoc.title = 'TokenField'
|
18
|
+
rdoc.options << '--line-numbers'
|
19
|
+
rdoc.rdoc_files.include('README.rdoc')
|
20
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
21
|
+
end
|
22
|
+
|
23
|
+
APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
|
24
|
+
load 'rails/tasks/engine.rake'
|
25
|
+
|
26
|
+
Bundler::GemHelper.install_tasks
|
@@ -0,0 +1,25 @@
|
|
1
|
+
module TokenField
|
2
|
+
module Capybara
|
3
|
+
module Dsl
|
4
|
+
def fill_in_token(id, options)
|
5
|
+
fill_in "token-input-#{input_id(id, options)}", options
|
6
|
+
sleep(1)
|
7
|
+
find(".token-input-dropdown-facebook li").click
|
8
|
+
end
|
9
|
+
|
10
|
+
def clear_token(id, options={})
|
11
|
+
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']")
|
12
|
+
remove_buttons.each{ |button| button.click }
|
13
|
+
end
|
14
|
+
|
15
|
+
private
|
16
|
+
|
17
|
+
def input_id(id, options)
|
18
|
+
input_id = id
|
19
|
+
element_id = options.delete(:element_id)
|
20
|
+
input_id << "_#{element_id}" if element_id
|
21
|
+
input_id
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,150 @@
|
|
1
|
+
module TokenField
|
2
|
+
module FormBuilder
|
3
|
+
include ActionView::Helpers
|
4
|
+
|
5
|
+
#
|
6
|
+
# form_for helper for token input with jquery token input plugin
|
7
|
+
# for has_many and belongs_to association
|
8
|
+
#
|
9
|
+
# http://railscasts.com/episodes/258-token-fields
|
10
|
+
# http://loopj.com/jquery-tokeninput/
|
11
|
+
#
|
12
|
+
# helper will render standard text field input with javascript.
|
13
|
+
# javascript will change standard input to token field input
|
14
|
+
#
|
15
|
+
# EXAMPLE
|
16
|
+
#
|
17
|
+
# class Category < ActiveRecord::Base
|
18
|
+
# attr_accessible :name, :parent_id, :product_ids
|
19
|
+
# has_many :products
|
20
|
+
#
|
21
|
+
# # method for converting array of categories to array of hashes in format that token input accepts
|
22
|
+
# def self.token_json(items)
|
23
|
+
# items.map{|i| {:id => i.id, :name => i.name} }
|
24
|
+
# end
|
25
|
+
# end
|
26
|
+
#
|
27
|
+
# class Product < ActiveRecord::Base
|
28
|
+
# attr_accessible :name, :category_id
|
29
|
+
#
|
30
|
+
# belongs_to :category
|
31
|
+
# end
|
32
|
+
#
|
33
|
+
# class CategoriesController < ApplicationController
|
34
|
+
#
|
35
|
+
# # action for autocomplete
|
36
|
+
# def token
|
37
|
+
# @categories = Category.where("categories.name like ?", "%#{params[:q]}%")
|
38
|
+
# respond_to do |format|
|
39
|
+
# format.json { render :json => Category.token_json(@categories) }
|
40
|
+
# end
|
41
|
+
# end
|
42
|
+
#
|
43
|
+
# # rest of the class
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# then in routes add route for token ajax call
|
47
|
+
#
|
48
|
+
# MyApplication::Application.routes.draw do
|
49
|
+
# resources :categories do
|
50
|
+
# collection do
|
51
|
+
# get :token # route for token -> token_categories_path
|
52
|
+
# end
|
53
|
+
# end
|
54
|
+
# end
|
55
|
+
#
|
56
|
+
# then in view we call token_field
|
57
|
+
# token_field input will be default expects, that Category model exists
|
58
|
+
# <%= form_for @product do |f| %>
|
59
|
+
# <%= f.token_field :category_id %>
|
60
|
+
# <% end %>
|
61
|
+
#
|
62
|
+
# possible options:
|
63
|
+
#
|
64
|
+
# in case the association roles where given like this
|
65
|
+
#
|
66
|
+
# class Product < ActiveRecord::Base
|
67
|
+
# belongs_to :cat, :class_name => 'Category', :foreign_key => :cat_id
|
68
|
+
# end
|
69
|
+
#
|
70
|
+
# then right model need to be specified
|
71
|
+
#
|
72
|
+
# <%= f.token_field :cat_id, :model => :category %>
|
73
|
+
#
|
74
|
+
# We can use token_input also for mapping category to products
|
75
|
+
# we will use ActiveRecord method product_ids which be default return array of ids from association
|
76
|
+
# <%= form_for @category do |f| %>
|
77
|
+
# <%= f.token_field :product_ids %>
|
78
|
+
# <% end %>
|
79
|
+
#
|
80
|
+
# in model we have to change product_ids= method like this
|
81
|
+
#
|
82
|
+
# class Category < ActiveRecord::Base
|
83
|
+
# has_many :products
|
84
|
+
#
|
85
|
+
# alias_method :product_ids_old=, :product_ids=
|
86
|
+
# def product_ids=(ids)
|
87
|
+
# ids = ids.split(",").map(&:to_i) if ids.is_a?(String)
|
88
|
+
# self.product_ids_old=ids
|
89
|
+
# end
|
90
|
+
#
|
91
|
+
# # rest of the class...
|
92
|
+
# end
|
93
|
+
def token_field(attribute_name, options = {})
|
94
|
+
association_type = @object.send(attribute_name).respond_to?(:each) ? :many : :one
|
95
|
+
model_name = (options[:model] || attribute_name.to_s.gsub(/_ids?/, "")).to_s
|
96
|
+
association = attribute_name.to_s.gsub(/_ids?/, "").to_sym
|
97
|
+
model = model_name.camelize.constantize
|
98
|
+
token_url = options[:token_url]
|
99
|
+
append_to_id = options[:append_to_id]
|
100
|
+
|
101
|
+
token_limit = nil
|
102
|
+
token_limit = 1 if association_type == :one
|
103
|
+
|
104
|
+
if token_url.nil?
|
105
|
+
token_url = "/#{model_name.pluralize}/token.json"
|
106
|
+
end
|
107
|
+
|
108
|
+
id = @object.send(:id)
|
109
|
+
|
110
|
+
html_id = "#{@object_name}_#{attribute_name.to_s}"
|
111
|
+
if append_to_id == :id && id
|
112
|
+
html_id << "_#{id}"
|
113
|
+
elsif append_to_id && append_to_id != :id
|
114
|
+
html_id << "_#{append_to_id}"
|
115
|
+
end
|
116
|
+
|
117
|
+
value = nil
|
118
|
+
data_pre = nil
|
119
|
+
if association_type == :one && @object.send(association)
|
120
|
+
data_pre = model.token_json([@object.send(association)]).to_json()
|
121
|
+
value = @object.send(association).id
|
122
|
+
elsif association_type == :many && @object.send(association.to_s.pluralize).count > 0
|
123
|
+
data_pre = model.token_json(@object.send(association.to_s.pluralize)).to_json()
|
124
|
+
value = @object.send(attribute_name).join(",")
|
125
|
+
end
|
126
|
+
|
127
|
+
on_add = options[:on_add] ? "#{options[:on_add]}" : "false"
|
128
|
+
on_delete = options[:on_delete] ? "#{options[:on_delete]}" : "false"
|
129
|
+
|
130
|
+
text_field("#{attribute_name}", "data-pre" => data_pre, :value => value, :id => html_id)+
|
131
|
+
javascript_tag("
|
132
|
+
jQuery.noConflict();
|
133
|
+
jQuery(function() {
|
134
|
+
jQuery('##{html_id}').tokenInput('#{token_url}', {
|
135
|
+
crossDomain: false,
|
136
|
+
tokenLimit: #{token_limit.nil? ? "null" : token_limit.to_i},
|
137
|
+
preventDuplicates: true,
|
138
|
+
prePopulate: jQuery('##{attribute_name}').data('pre'),
|
139
|
+
theme: 'facebook',
|
140
|
+
hintText: '"+t('helpers.token_field.hint_text')+"',
|
141
|
+
searchingText: '"+t('helpers.token_field.searching_text')+"',
|
142
|
+
noResultsText: '"+t('helpers.token_field.no_results_text')+"',
|
143
|
+
onAdd: "+on_add+",
|
144
|
+
onDelete: "+on_delete+"
|
145
|
+
});
|
146
|
+
});
|
147
|
+
")
|
148
|
+
end
|
149
|
+
end
|
150
|
+
end
|
data/lib/token_field.rb
ADDED
@@ -0,0 +1,261 @@
|
|
1
|
+
== Welcome to Rails
|
2
|
+
|
3
|
+
Rails is a web-application framework that includes everything needed to create
|
4
|
+
database-backed web applications according to the Model-View-Control pattern.
|
5
|
+
|
6
|
+
This pattern splits the view (also called the presentation) into "dumb"
|
7
|
+
templates that are primarily responsible for inserting pre-built data in between
|
8
|
+
HTML tags. The model contains the "smart" domain objects (such as Account,
|
9
|
+
Product, Person, Post) that holds all the business logic and knows how to
|
10
|
+
persist themselves to a database. The controller handles the incoming requests
|
11
|
+
(such as Save New Account, Update Product, Show Post) by manipulating the model
|
12
|
+
and directing data to the view.
|
13
|
+
|
14
|
+
In Rails, the model is handled by what's called an object-relational mapping
|
15
|
+
layer entitled Active Record. This layer allows you to present the data from
|
16
|
+
database rows as objects and embellish these data objects with business logic
|
17
|
+
methods. You can read more about Active Record in
|
18
|
+
link:files/vendor/rails/activerecord/README.html.
|
19
|
+
|
20
|
+
The controller and view are handled by the Action Pack, which handles both
|
21
|
+
layers by its two parts: Action View and Action Controller. These two layers
|
22
|
+
are bundled in a single package due to their heavy interdependence. This is
|
23
|
+
unlike the relationship between the Active Record and Action Pack that is much
|
24
|
+
more separate. Each of these packages can be used independently outside of
|
25
|
+
Rails. You can read more about Action Pack in
|
26
|
+
link:files/vendor/rails/actionpack/README.html.
|
27
|
+
|
28
|
+
|
29
|
+
== Getting Started
|
30
|
+
|
31
|
+
1. At the command prompt, create a new Rails application:
|
32
|
+
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
|
33
|
+
|
34
|
+
2. Change directory to <tt>myapp</tt> and start the web server:
|
35
|
+
<tt>cd myapp; rails server</tt> (run with --help for options)
|
36
|
+
|
37
|
+
3. Go to http://localhost:3000/ and you'll see:
|
38
|
+
"Welcome aboard: You're riding Ruby on Rails!"
|
39
|
+
|
40
|
+
4. Follow the guidelines to start developing your application. You can find
|
41
|
+
the following resources handy:
|
42
|
+
|
43
|
+
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
|
44
|
+
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
|
45
|
+
|
46
|
+
|
47
|
+
== Debugging Rails
|
48
|
+
|
49
|
+
Sometimes your application goes wrong. Fortunately there are a lot of tools that
|
50
|
+
will help you debug it and get it back on the rails.
|
51
|
+
|
52
|
+
First area to check is the application log files. Have "tail -f" commands
|
53
|
+
running on the server.log and development.log. Rails will automatically display
|
54
|
+
debugging and runtime information to these files. Debugging info will also be
|
55
|
+
shown in the browser on requests from 127.0.0.1.
|
56
|
+
|
57
|
+
You can also log your own messages directly into the log file from your code
|
58
|
+
using the Ruby logger class from inside your controllers. Example:
|
59
|
+
|
60
|
+
class WeblogController < ActionController::Base
|
61
|
+
def destroy
|
62
|
+
@weblog = Weblog.find(params[:id])
|
63
|
+
@weblog.destroy
|
64
|
+
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
The result will be a message in your log file along the lines of:
|
69
|
+
|
70
|
+
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
|
71
|
+
|
72
|
+
More information on how to use the logger is at http://www.ruby-doc.org/core/
|
73
|
+
|
74
|
+
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
|
75
|
+
several books available online as well:
|
76
|
+
|
77
|
+
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
|
78
|
+
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
|
79
|
+
|
80
|
+
These two books will bring you up to speed on the Ruby language and also on
|
81
|
+
programming in general.
|
82
|
+
|
83
|
+
|
84
|
+
== Debugger
|
85
|
+
|
86
|
+
Debugger support is available through the debugger command when you start your
|
87
|
+
Mongrel or WEBrick server with --debugger. This means that you can break out of
|
88
|
+
execution at any point in the code, investigate and change the model, and then,
|
89
|
+
resume execution! You need to install ruby-debug to run the server in debugging
|
90
|
+
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
|
91
|
+
|
92
|
+
class WeblogController < ActionController::Base
|
93
|
+
def index
|
94
|
+
@posts = Post.all
|
95
|
+
debugger
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
So the controller will accept the action, run the first line, then present you
|
100
|
+
with a IRB prompt in the server window. Here you can do things like:
|
101
|
+
|
102
|
+
>> @posts.inspect
|
103
|
+
=> "[#<Post:0x14a6be8
|
104
|
+
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
|
105
|
+
#<Post:0x14a6620
|
106
|
+
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
|
107
|
+
>> @posts.first.title = "hello from a debugger"
|
108
|
+
=> "hello from a debugger"
|
109
|
+
|
110
|
+
...and even better, you can examine how your runtime objects actually work:
|
111
|
+
|
112
|
+
>> f = @posts.first
|
113
|
+
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
|
114
|
+
>> f.
|
115
|
+
Display all 152 possibilities? (y or n)
|
116
|
+
|
117
|
+
Finally, when you're ready to resume execution, you can enter "cont".
|
118
|
+
|
119
|
+
|
120
|
+
== Console
|
121
|
+
|
122
|
+
The console is a Ruby shell, which allows you to interact with your
|
123
|
+
application's domain model. Here you'll have all parts of the application
|
124
|
+
configured, just like it is when the application is running. You can inspect
|
125
|
+
domain models, change values, and save to the database. Starting the script
|
126
|
+
without arguments will launch it in the development environment.
|
127
|
+
|
128
|
+
To start the console, run <tt>rails console</tt> from the application
|
129
|
+
directory.
|
130
|
+
|
131
|
+
Options:
|
132
|
+
|
133
|
+
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
|
134
|
+
made to the database.
|
135
|
+
* Passing an environment name as an argument will load the corresponding
|
136
|
+
environment. Example: <tt>rails console production</tt>.
|
137
|
+
|
138
|
+
To reload your controllers and models after launching the console run
|
139
|
+
<tt>reload!</tt>
|
140
|
+
|
141
|
+
More information about irb can be found at:
|
142
|
+
link:http://www.rubycentral.org/pickaxe/irb.html
|
143
|
+
|
144
|
+
|
145
|
+
== dbconsole
|
146
|
+
|
147
|
+
You can go to the command line of your database directly through <tt>rails
|
148
|
+
dbconsole</tt>. You would be connected to the database with the credentials
|
149
|
+
defined in database.yml. Starting the script without arguments will connect you
|
150
|
+
to the development database. Passing an argument will connect you to a different
|
151
|
+
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
|
152
|
+
PostgreSQL and SQLite 3.
|
153
|
+
|
154
|
+
== Description of Contents
|
155
|
+
|
156
|
+
The default directory structure of a generated Ruby on Rails application:
|
157
|
+
|
158
|
+
|-- app
|
159
|
+
| |-- assets
|
160
|
+
| |-- images
|
161
|
+
| |-- javascripts
|
162
|
+
| `-- stylesheets
|
163
|
+
| |-- controllers
|
164
|
+
| |-- helpers
|
165
|
+
| |-- mailers
|
166
|
+
| |-- models
|
167
|
+
| `-- views
|
168
|
+
| `-- layouts
|
169
|
+
|-- config
|
170
|
+
| |-- environments
|
171
|
+
| |-- initializers
|
172
|
+
| `-- locales
|
173
|
+
|-- db
|
174
|
+
|-- doc
|
175
|
+
|-- lib
|
176
|
+
| `-- tasks
|
177
|
+
|-- log
|
178
|
+
|-- public
|
179
|
+
|-- script
|
180
|
+
|-- test
|
181
|
+
| |-- fixtures
|
182
|
+
| |-- functional
|
183
|
+
| |-- integration
|
184
|
+
| |-- performance
|
185
|
+
| `-- unit
|
186
|
+
|-- tmp
|
187
|
+
| |-- cache
|
188
|
+
| |-- pids
|
189
|
+
| |-- sessions
|
190
|
+
| `-- sockets
|
191
|
+
`-- vendor
|
192
|
+
|-- assets
|
193
|
+
`-- stylesheets
|
194
|
+
`-- plugins
|
195
|
+
|
196
|
+
app
|
197
|
+
Holds all the code that's specific to this particular application.
|
198
|
+
|
199
|
+
app/assets
|
200
|
+
Contains subdirectories for images, stylesheets, and JavaScript files.
|
201
|
+
|
202
|
+
app/controllers
|
203
|
+
Holds controllers that should be named like weblogs_controller.rb for
|
204
|
+
automated URL mapping. All controllers should descend from
|
205
|
+
ApplicationController which itself descends from ActionController::Base.
|
206
|
+
|
207
|
+
app/models
|
208
|
+
Holds models that should be named like post.rb. Models descend from
|
209
|
+
ActiveRecord::Base by default.
|
210
|
+
|
211
|
+
app/views
|
212
|
+
Holds the template files for the view that should be named like
|
213
|
+
weblogs/index.html.erb for the WeblogsController#index action. All views use
|
214
|
+
eRuby syntax by default.
|
215
|
+
|
216
|
+
app/views/layouts
|
217
|
+
Holds the template files for layouts to be used with views. This models the
|
218
|
+
common header/footer method of wrapping views. In your views, define a layout
|
219
|
+
using the <tt>layout :default</tt> and create a file named default.html.erb.
|
220
|
+
Inside default.html.erb, call <% yield %> to render the view using this
|
221
|
+
layout.
|
222
|
+
|
223
|
+
app/helpers
|
224
|
+
Holds view helpers that should be named like weblogs_helper.rb. These are
|
225
|
+
generated for you automatically when using generators for controllers.
|
226
|
+
Helpers can be used to wrap functionality for your views into methods.
|
227
|
+
|
228
|
+
config
|
229
|
+
Configuration files for the Rails environment, the routing map, the database,
|
230
|
+
and other dependencies.
|
231
|
+
|
232
|
+
db
|
233
|
+
Contains the database schema in schema.rb. db/migrate contains all the
|
234
|
+
sequence of Migrations for your schema.
|
235
|
+
|
236
|
+
doc
|
237
|
+
This directory is where your application documentation will be stored when
|
238
|
+
generated using <tt>rake doc:app</tt>
|
239
|
+
|
240
|
+
lib
|
241
|
+
Application specific libraries. Basically, any kind of custom code that
|
242
|
+
doesn't belong under controllers, models, or helpers. This directory is in
|
243
|
+
the load path.
|
244
|
+
|
245
|
+
public
|
246
|
+
The directory available for the web server. Also contains the dispatchers and the
|
247
|
+
default HTML files. This should be set as the DOCUMENT_ROOT of your web
|
248
|
+
server.
|
249
|
+
|
250
|
+
script
|
251
|
+
Helper scripts for automation and generation.
|
252
|
+
|
253
|
+
test
|
254
|
+
Unit and functional tests along with fixtures. When using the rails generate
|
255
|
+
command, template test files will be generated for you and placed in this
|
256
|
+
directory.
|
257
|
+
|
258
|
+
vendor
|
259
|
+
External libraries that the application depends on. Also includes the plugins
|
260
|
+
subdirectory. If the app has frozen rails, those gems also go here, under
|
261
|
+
vendor/rails/. This directory is in the load path.
|
data/spec/dummy/Rakefile
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
#!/usr/bin/env rake
|
2
|
+
# Add your own tasks in files placed in lib/tasks ending in .rake,
|
3
|
+
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
|
4
|
+
|
5
|
+
require File.expand_path('../config/application', __FILE__)
|
6
|
+
|
7
|
+
Dummy::Application.load_tasks
|