routing_data 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. data/README.md +30 -15
  2. data/dummy/Gemfile +38 -0
  3. data/dummy/README.rdoc +261 -0
  4. data/dummy/Rakefile +7 -0
  5. data/dummy/app/assets/images/rails.png +0 -0
  6. data/dummy/app/assets/javascripts/application.js +14 -0
  7. data/dummy/app/assets/javascripts/blogs.js.coffee +3 -0
  8. data/dummy/app/assets/javascripts/categories.js.coffee +3 -0
  9. data/dummy/app/assets/javascripts/home.js.coffee +3 -0
  10. data/dummy/app/assets/javascripts/posts.js.coffee +3 -0
  11. data/dummy/app/assets/javascripts/users.js.coffee +3 -0
  12. data/dummy/app/assets/stylesheets/application.css +13 -0
  13. data/dummy/app/assets/stylesheets/blogs.css.scss +3 -0
  14. data/dummy/app/assets/stylesheets/categories.css.scss +3 -0
  15. data/dummy/app/assets/stylesheets/home.css.scss +3 -0
  16. data/dummy/app/assets/stylesheets/posts.css.scss +3 -0
  17. data/dummy/app/assets/stylesheets/scaffolds.css.scss +69 -0
  18. data/dummy/app/assets/stylesheets/users.css.scss +3 -0
  19. data/dummy/app/controllers/application_controller.rb +3 -0
  20. data/dummy/app/controllers/blogs_controller.rb +83 -0
  21. data/dummy/app/controllers/categories_controller.rb +83 -0
  22. data/dummy/app/controllers/home_controller.rb +5 -0
  23. data/dummy/app/controllers/posts_controller.rb +86 -0
  24. data/dummy/app/controllers/users_controller.rb +83 -0
  25. data/dummy/app/helpers/application_helper.rb +2 -0
  26. data/dummy/app/helpers/blogs_helper.rb +2 -0
  27. data/dummy/app/helpers/categories_helper.rb +2 -0
  28. data/dummy/app/helpers/home_helper.rb +2 -0
  29. data/dummy/app/helpers/posts_helper.rb +2 -0
  30. data/dummy/app/helpers/users_helper.rb +2 -0
  31. data/dummy/app/models/blog.rb +6 -0
  32. data/dummy/app/models/category.rb +5 -0
  33. data/dummy/app/models/post.rb +11 -0
  34. data/dummy/app/models/user.rb +7 -0
  35. data/dummy/app/views/blogs/_form.html.erb +33 -0
  36. data/dummy/app/views/blogs/edit.html.erb +6 -0
  37. data/dummy/app/views/blogs/index.html.erb +29 -0
  38. data/dummy/app/views/blogs/new.html.erb +5 -0
  39. data/dummy/app/views/blogs/show.html.erb +25 -0
  40. data/dummy/app/views/categories/_form.html.erb +25 -0
  41. data/dummy/app/views/categories/edit.html.erb +6 -0
  42. data/dummy/app/views/categories/index.html.erb +25 -0
  43. data/dummy/app/views/categories/new.html.erb +5 -0
  44. data/dummy/app/views/categories/show.html.erb +15 -0
  45. data/dummy/app/views/home/index.html.erb +29 -0
  46. data/dummy/app/views/layouts/application.html.erb +15 -0
  47. data/dummy/app/views/posts/_form.html.erb +37 -0
  48. data/dummy/app/views/posts/edit.html.erb +6 -0
  49. data/dummy/app/views/posts/index.html.erb +29 -0
  50. data/dummy/app/views/posts/new.html.erb +5 -0
  51. data/dummy/app/views/posts/show.html.erb +25 -0
  52. data/dummy/app/views/users/_form.html.erb +25 -0
  53. data/dummy/app/views/users/edit.html.erb +6 -0
  54. data/dummy/app/views/users/index.html.erb +25 -0
  55. data/dummy/app/views/users/new.html.erb +5 -0
  56. data/dummy/app/views/users/show.html.erb +15 -0
  57. data/dummy/config/application.rb +68 -0
  58. data/dummy/config/boot.rb +6 -0
  59. data/dummy/config/database.yml +25 -0
  60. data/dummy/config/environment.rb +5 -0
  61. data/dummy/config/environments/development.rb +39 -0
  62. data/dummy/config/environments/production.rb +67 -0
  63. data/dummy/config/environments/test.rb +37 -0
  64. data/dummy/config/initializers/backtrace_silencers.rb +7 -0
  65. data/dummy/config/initializers/inflections.rb +15 -0
  66. data/dummy/config/initializers/mime_types.rb +5 -0
  67. data/dummy/config/initializers/secret_token.rb +7 -0
  68. data/dummy/config/initializers/session_store.rb +8 -0
  69. data/dummy/config/initializers/wrap_parameters.rb +14 -0
  70. data/dummy/config/locales/en.yml +5 -0
  71. data/dummy/config/routes.rb +10 -0
  72. data/dummy/config.ru +4 -0
  73. data/dummy/db/development.sqlite3 +0 -0
  74. data/dummy/db/migrate/20121118170847_create_users.rb +11 -0
  75. data/dummy/db/migrate/20121118170945_create_posts.rb +13 -0
  76. data/dummy/db/migrate/20121118171015_create_categories.rb +10 -0
  77. data/dummy/db/migrate/20121118171532_create_blogs.rb +12 -0
  78. data/dummy/db/schema.rb +50 -0
  79. data/dummy/db/seeds.rb +7 -0
  80. data/dummy/public/404.html +26 -0
  81. data/dummy/public/422.html +26 -0
  82. data/dummy/public/500.html +25 -0
  83. data/dummy/public/favicon.ico +0 -0
  84. data/dummy/public/robots.txt +5 -0
  85. data/dummy/script/rails +6 -0
  86. data/lib/routing_data/lib/assets/javascripts/routing_data.js +13 -7
  87. data/lib/routing_data/version.rb +1 -1
  88. data/lib/routing_data/view_helpers.rb +8 -8
  89. data/lib/routing_data.rb +22 -34
  90. metadata +85 -1
data/README.md CHANGED
@@ -20,21 +20,19 @@ Or install it yourself as:
20
20
  With RoutingData you have access to url helpers in your models:
21
21
 
22
22
  ```ruby
23
+ RoutingData.url_helpers.root_path
24
+ # => "/"
25
+ RoutingData.url_helpers.post_path(1)
26
+ # => "/posts/1"
23
27
  RoutingData.url_helpers.new_user_path
24
28
  # => "/users/new"
25
-
26
- RoutingData.url_helpers.user_path(User.first)
27
- # => "/users/1"
28
-
29
- RoutingData.url_helpers.post_path(Post.last)
30
- # => "/posts/2"
31
29
  ```
32
30
 
33
31
  You can access to lists of controllers and actions in your application (this is helpful for authorization purposes):
34
32
 
35
33
  ```ruby
36
34
  RoutingData.controllers_actions_map
37
- # => {:home=>[:index], :blogs=>[:index, :create, :new, :edit, :show, :update, :destroy], :categories=>[:index, :create, :new, :edit, :show, :update, :destroy], :posts=>[:index, :create, :new, :edit, :show, :update, :destroy], :users=>[:index, :create, :new, :edit, :show, :update, :destroy, :show]}
35
+ # => {:home=>[:index], :blogs=>[:index, :create, :new, :edit, :show, :update, :destroy], :categories=>[:index, :create, :new, :edit, :show, :update, :destroy], :posts=>[:index, :create, :new, :edit, :show, :update, :destroy], :users=>[:index, :create, :new, :edit, :show, :update, :destroy, :show], :"rails/info"=>[:properties]}
38
36
 
39
37
  RoutingData.controllers
40
38
  # => [:home, :blogs, :categories, :posts, :users]
@@ -46,21 +44,30 @@ RoutingData.actions_for(:users)
46
44
  You can also generate json-data about routes and use it in your Javascript:
47
45
 
48
46
  ```ruby
49
- RoutingData.routes_data
50
- # => [{:name=>"root", :path=>"/", :controller=>"home", :action=>"index", :parts=>[]}, {:name=>"blogs", :path=>"/blogs(.:format)", :controller=>"blogs", :action=>"index", :parts=>[:format]}, {:name=>"new_blog", :path=>"/blogs/new(.:format)", :controller=>"blogs", :action=>"new", :parts=>[:format]}, {:name=>"edit_blog", :path=>"/blogs/:id/edit(.:format)", :controller=>"blogs", :action=>"edit", :parts=>[:id, :format]}, {:name=>"blog", :path=>"/blogs/:id(.:format)", :controller=>"blogs", :action=>"show", :parts=>[:id, :format]}, {:name=>"categories", :path=>"/categories(.:format)", :controller=>"categories", :action=>"index", :parts=>[:format]}, {:name=>"new_category", :path=>"/categories/new(.:format)", :controller=>"categories", :action=>"new", :parts=>[:format]}, {:name=>"edit_category", :path=>"/categories/:id/edit(.:format)", :controller=>"categories", :action=>"edit", :parts=>[:id, :format]}, {:name=>"category", :path=>"/categories/:id(.:format)", :controller=>"categories", :action=>"show", :parts=>[:id, :format]}, {:name=>"posts", :path=>"/posts(.:format)", :controller=>"posts", :action=>"index", :parts=>[:format]}, {:name=>"new_post", :path=>"/posts/new(.:format)", :controller=>"posts", :action=>"new", :parts=>[:format]}, {:name=>"edit_post", :path=>"/posts/:id/edit(.:format)", :controller=>"posts", :action=>"edit", :parts=>[:id, :format]}, {:name=>"post", :path=>"/posts/:id(.:format)", :controller=>"posts", :action=>"show", :parts=>[:id, :format]}, {:name=>"users", :path=>"/users(.:format)", :controller=>"users", :action=>"index", :parts=>[:format]}, {:name=>"new_user", :path=>"/users/new(.:format)", :controller=>"users", :action=>"new", :parts=>[:format]}, {:name=>"edit_user", :path=>"/users/:id/edit(.:format)", :controller=>"users", :action=>"edit", :parts=>[:id, :format]}, {:name=>"user", :path=>"/users/:id(.:format)", :controller=>"users", :action=>"show", :parts=>[:id, :format]}, {:name=>"show_user", :path=>"/user/ololo/:user_id(.:format)", :controller=>"users", :action=>"show", :parts=>[:user_id, :format]}]
47
+ RoutingData.url_helpers_data
48
+ # => {"root"=>{:name=>"root", :path=>"/", :controller=>"home", :action=>"index", :parts=>[]}, "blogs"=>{:name=>"blogs", :path=>"/blogs(.:format)", :controller=>"blogs", :action=>"index", :parts=>[:format]}, "new_blog"=>{:name=>"new_blog", :path=>"/blogs/new(.:format)", :controller=>"blogs", :action=>"new", :parts=>[:format]}, "edit_blog"=>{:name=>"edit_blog", :path=>"/blogs/:id/edit(.:format)", :controller=>"blogs", :action=>"edit", :parts=>[:id, :format]}, "blog"=>{:name=>"blog", :path=>"/blogs/:id(.:format)", :controller=>"blogs", :action=>"show", :parts=>[:id, :format]}, "categories"=>{:name=>"categories", :path=>"/categories(.:format)", :controller=>"categories", :action=>"index", :parts=>[:format]}, "new_category"=>{:name=>"new_category", :path=>"/categories/new(.:format)", :controller=>"categories", :action=>"new", :parts=>[:format]}, "edit_category"=>{:name=>"edit_category", :path=>"/categories/:id/edit(.:format)", :controller=>"categories", :action=>"edit", :parts=>[:id, :format]}, "category"=>{:name=>"category", :path=>"/categories/:id(.:format)", :controller=>"categories", :action=>"show", :parts=>[:id, :format]}, "posts"=>{:name=>"posts", :path=>"/posts(.:format)", :controller=>"posts", :action=>"index", :parts=>[:format]}, "new_post"=>{:name=>"new_post", :path=>"/posts/new(.:format)", :controller=>"posts", :action=>"new", :parts=>[:format]}, "edit_post"=>{:name=>"edit_post", :path=>"/posts/:id/edit(.:format)", :controller=>"posts", :action=>"edit", :parts=>[:id, :format]}, "post"=>{:name=>"post", :path=>"/posts/:id(.:format)", :controller=>"posts", :action=>"show", :parts=>[:id, :format]}, "users"=>{:name=>"users", :path=>"/users(.:format)", :controller=>"users", :action=>"index", :parts=>[:format]}, "new_user"=>{:name=>"new_user", :path=>"/users/new(.:format)", :controller=>"users", :action=>"new", :parts=>[:format]}, "edit_user"=>{:name=>"edit_user", :path=>"/users/:id/edit(.:format)", :controller=>"users", :action=>"edit", :parts=>[:id, :format]}, "user"=>{:name=>"user", :path=>"/users/:id(.:format)", :controller=>"users", :action=>"show", :parts=>[:id, :format]}, "show_user"=>{:name=>"show_user", :path=>"/user/ololo/:user_id(.:format)", :controller=>"users", :action=>"show", :parts=>[:user_id, :format]}, "rails_info_properties"=>{:name=>"rails_info_properties", :path=>"/rails/info/properties(.:format)", :controller=>"rails/info", :action=>"properties", :parts=>[:format]}}
49
+
51
50
 
52
- RoutingData.routes_json_data
53
- # => "[{\"name\":\"root\",\"path\":\"/\",\"controller\":\"home\",\"action\":\"index\",\"parts\":[]},{\"name\":\"blogs\",\"path\":\"/blogs(.:format)\",\"controller\":\"blogs\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_blog\",\"path\":\"/blogs/new(.:format)\",\"controller\":\"blogs\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_blog\",\"path\":\"/blogs/:id/edit(.:format)\",\"controller\":\"blogs\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"blog\",\"path\":\"/blogs/:id(.:format)\",\"controller\":\"blogs\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"categories\",\"path\":\"/categories(.:format)\",\"controller\":\"categories\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_category\",\"path\":\"/categories/new(.:format)\",\"controller\":\"categories\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_category\",\"path\":\"/categories/:id/edit(.:format)\",\"controller\":\"categories\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"category\",\"path\":\"/categories/:id(.:format)\",\"controller\":\"categories\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"posts\",\"path\":\"/posts(.:format)\",\"controller\":\"posts\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_post\",\"path\":\"/posts/new(.:format)\",\"controller\":\"posts\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_post\",\"path\":\"/posts/:id/edit(.:format)\",\"controller\":\"posts\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"post\",\"path\":\"/posts/:id(.:format)\",\"controller\":\"posts\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"users\",\"path\":\"/users(.:format)\",\"controller\":\"users\",\"action\":\"index\",\"parts\":[\"format\"]},{\"name\":\"new_user\",\"path\":\"/users/new(.:format)\",\"controller\":\"users\",\"action\":\"new\",\"parts\":[\"format\"]},{\"name\":\"edit_user\",\"path\":\"/users/:id/edit(.:format)\",\"controller\":\"users\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},{\"name\":\"user\",\"path\":\"/users/:id(.:format)\",\"controller\":\"users\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"show_user\",\"path\":\"/user/ololo/:user_id(.:format)\",\"controller\":\"users\",\"action\":\"show\",\"parts\":[\"user_id\",\"format\"]}]"
51
+ RoutingData.url_helpers_data(as_json: true)
52
+ # => "{\"root\":{\"name\":\"root\",\"path\":\"/\",\"controller\":\"home\",\"action\":\"index\",\"parts\":[]},\"blogs\":{\"name\":\"blogs\",\"path\":\"/blogs(.:format)\",\"controller\":\"blogs\",\"action\":\"index\",\"parts\":[\"format\"]},\"new_blog\":{\"name\":\"new_blog\",\"path\":\"/blogs/new(.:format)\",\"controller\":\"blogs\",\"action\":\"new\",\"parts\":[\"format\"]},\"edit_blog\":{\"name\":\"edit_blog\",\"path\":\"/blogs/:id/edit(.:format)\",\"controller\":\"blogs\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},\"blog\":{\"name\":\"blog\",\"path\":\"/blogs/:id(.:format)\",\"controller\":\"blogs\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},\"categories\":{\"name\":\"categories\",\"path\":\"/categories(.:format)\",\"controller\":\"categories\",\"action\":\"index\",\"parts\":[\"format\"]},\"new_category\":{\"name\":\"new_category\",\"path\":\"/categories/new(.:format)\",\"controller\":\"categories\",\"action\":\"new\",\"parts\":[\"format\"]},\"edit_category\":{\"name\":\"edit_category\",\"path\":\"/categories/:id/edit(.:format)\",\"controller\":\"categories\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},\"category\":{\"name\":\"category\",\"path\":\"/categories/:id(.:format)\",\"controller\":\"categories\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},\"posts\":{\"name\":\"posts\",\"path\":\"/posts(.:format)\",\"controller\":\"posts\",\"action\":\"index\",\"parts\":[\"format\"]},\"new_post\":{\"name\":\"new_post\",\"path\":\"/posts/new(.:format)\",\"controller\":\"posts\",\"action\":\"new\",\"parts\":[\"format\"]},\"edit_post\":{\"name\":\"edit_post\",\"path\":\"/posts/:id/edit(.:format)\",\"controller\":\"posts\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},\"post\":{\"name\":\"post\",\"path\":\"/posts/:id(.:format)\",\"controller\":\"posts\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},\"users\":{\"name\":\"users\",\"path\":\"/users(.:format)\",\"controller\":\"users\",\"action\":\"index\",\"parts\":[\"format\"]},\"new_user\":{\"name\":\"new_user\",\"path\":\"/users/new(.:format)\",\"controller\":\"users\",\"action\":\"new\",\"parts\":[\"format\"]},\"edit_user\":{\"name\":\"edit_user\",\"path\":\"/users/:id/edit(.:format)\",\"controller\":\"users\",\"action\":\"edit\",\"parts\":[\"id\",\"format\"]},\"user\":{\"name\":\"user\",\"path\":\"/users/:id(.:format)\",\"controller\":\"users\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},\"show_user\":{\"name\":\"show_user\",\"path\":\"/user/ololo/:user_id(.:format)\",\"controller\":\"users\",\"action\":\"show\",\"parts\":[\"user_id\",\"format\"]},\"rails_info_properties\":{\"name\":\"rails_info_properties\",\"path\":\"/rails/info/properties(.:format)\",\"controller\":\"rails/info\",\"action\":\"properties\",\"parts\":[\"format\"]}}"
53
+
54
+ RoutingData.url_helpers_data(for_controllers: ['home', 'posts'])
55
+ # => {"root"=>{:name=>"root", :path=>"/", :controller=>"home", :action=>"index", :parts=>[]}, "posts"=>{:name=>"posts", :path=>"/posts(.:format)", :controller=>"posts", :action=>"index", :parts=>[:format]}, "new_post"=>{:name=>"new_post", :path=>"/posts/new(.:format)", :controller=>"posts", :action=>"new", :parts=>[:format]}, "edit_post"=>{:name=>"edit_post", :path=>"/posts/:id/edit(.:format)", :controller=>"posts", :action=>"edit", :parts=>[:id, :format]}, "post"=>{:name=>"post", :path=>"/posts/:id(.:format)", :controller=>"posts", :action=>"show", :parts=>[:id, :format]}}
56
+
57
+ RoutingData.url_helpers_data(with_name_in: ['root', 'post', 'user'], as_json: true)
58
+ # => "[{\"name\":\"root\",\"path\":\"/\",\"controller\":\"home\",\"action\":\"index\",\"parts\":[]},{\"name\":\"post\",\"path\":\"/posts/:id(.:format)\",\"controller\":\"posts\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]},{\"name\":\"user\",\"path\":\"/users/:id(.:format)\",\"controller\":\"users\",\"action\":\"show\",\"parts\":[\"id\",\"format\"]}]"
54
59
  ```
55
60
 
56
61
  In your Javascript you can use RoutingData object and url helpers through it. Just add
57
62
 
58
- ``` //= require routing_data
63
+ ```
64
+ //= require routing_data
65
+ ```
59
66
 
60
67
  to app/assets/javascripts/application.js and
61
68
 
62
69
  ```ruby
63
- <%= include_routing_data %>
70
+ <%= include_url_helpers_data %>
64
71
  ```
65
72
 
66
73
  in your views before requiring javascripts.
@@ -68,10 +75,10 @@ in your views before requiring javascripts.
68
75
  After this you can work with RoutingData object:
69
76
 
70
77
  ```javascript
71
- RoutingData // { routes:{...}, helpers: {...} }
78
+ RoutingData // { helpersData: {...}, helpers: {...}, globalizeHelpers() }
72
79
  ```
73
80
 
74
- **RoutingData.routes** is made from data from RoutingData.routes_json_data method in Ruby.
81
+ **RoutingData.helpersData** is made from data from RoutingData.url_helpers_data method in Ruby.
75
82
 
76
83
  **RoutingData.helpers** contains url helpers with names like in you Ruby on Rails app. For example:
77
84
 
@@ -83,6 +90,14 @@ RoutingData.helpers.post_path({id: 1}); // "/posts/1"
83
90
  RoutingData.helpers.post_path({id: 1, format: 'xml'}); // "/posts/1.xml"
84
91
  ```
85
92
 
93
+ You can use **RoutingData.globalizeHelpers()** to make your url helper methods also available as global functions. For example:
94
+
95
+ ```javascript
96
+ RoutingData.helpers.new_blog_path(); // "/blogs/new"
97
+ RoutingData.globalizeHelpers();
98
+ new_blog_path(); //"/blogs/new"
99
+ ```
100
+
86
101
 
87
102
  ## Contributing
88
103
 
data/dummy/Gemfile ADDED
@@ -0,0 +1,38 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gem 'rails', '3.2.9.rc2'
4
+
5
+ # Bundle edge Rails instead:
6
+ # gem 'rails', :git => 'git://github.com/rails/rails.git'
7
+
8
+ gem 'sqlite3'
9
+
10
+
11
+ # Gems used only for assets and not required
12
+ # in production environments by default.
13
+ group :assets do
14
+ gem 'sass-rails', '~> 3.2.3'
15
+ gem 'coffee-rails', '~> 3.2.1'
16
+
17
+ # See https://github.com/sstephenson/execjs#readme for more supported runtimes
18
+ # gem 'therubyracer', :platforms => :ruby
19
+
20
+ gem 'uglifier', '>= 1.0.3'
21
+ end
22
+
23
+ gem 'routing_data', '0.2.1', :path => '../'
24
+
25
+ # To use ActiveModel has_secure_password
26
+ # gem 'bcrypt-ruby', '~> 3.0.0'
27
+
28
+ # To use Jbuilder templates for JSON
29
+ # gem 'jbuilder'
30
+
31
+ # Use unicorn as the app server
32
+ # gem 'unicorn'
33
+
34
+ # Deploy with Capistrano
35
+ # gem 'capistrano'
36
+
37
+ # To use debugger
38
+ # gem 'debugger'
data/dummy/README.rdoc 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/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
Binary file
@@ -0,0 +1,14 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // the compiled file.
9
+ //
10
+ // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
11
+ // GO AFTER THE REQUIRES BELOW.
12
+ //
13
+ //= require_tree .
14
+ //= require routing_data
@@ -0,0 +1,3 @@
1
+ # Place all the behaviors and hooks related to the matching controller here.
2
+ # All this logic will automatically be available in application.js.
3
+ # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,3 @@
1
+ # Place all the behaviors and hooks related to the matching controller here.
2
+ # All this logic will automatically be available in application.js.
3
+ # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,3 @@
1
+ # Place all the behaviors and hooks related to the matching controller here.
2
+ # All this logic will automatically be available in application.js.
3
+ # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,3 @@
1
+ # Place all the behaviors and hooks related to the matching controller here.
2
+ # All this logic will automatically be available in application.js.
3
+ # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,3 @@
1
+ # Place all the behaviors and hooks related to the matching controller here.
2
+ # All this logic will automatically be available in application.js.
3
+ # You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/
@@ -0,0 +1,13 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
9
+ * compiled file, but it's generally better to create a new file per style scope.
10
+ *
11
+ *= require_self
12
+ *= require_tree .
13
+ */
@@ -0,0 +1,3 @@
1
+ // Place all the styles related to the Blogs controller here.
2
+ // They will automatically be included in application.css.
3
+ // You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,3 @@
1
+ // Place all the styles related to the Categories controller here.
2
+ // They will automatically be included in application.css.
3
+ // You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,3 @@
1
+ // Place all the styles related to the Home controller here.
2
+ // They will automatically be included in application.css.
3
+ // You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,3 @@
1
+ // Place all the styles related to the Posts controller here.
2
+ // They will automatically be included in application.css.
3
+ // You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,69 @@
1
+ body {
2
+ background-color: #fff;
3
+ color: #333;
4
+ font-family: verdana, arial, helvetica, sans-serif;
5
+ font-size: 13px;
6
+ line-height: 18px;
7
+ }
8
+
9
+ p, ol, ul, td {
10
+ font-family: verdana, arial, helvetica, sans-serif;
11
+ font-size: 13px;
12
+ line-height: 18px;
13
+ }
14
+
15
+ pre {
16
+ background-color: #eee;
17
+ padding: 10px;
18
+ font-size: 11px;
19
+ }
20
+
21
+ a {
22
+ color: #000;
23
+ &:visited {
24
+ color: #666;
25
+ }
26
+ &:hover {
27
+ color: #fff;
28
+ background-color: #000;
29
+ }
30
+ }
31
+
32
+ div {
33
+ &.field, &.actions {
34
+ margin-bottom: 10px;
35
+ }
36
+ }
37
+
38
+ #notice {
39
+ color: green;
40
+ }
41
+
42
+ .field_with_errors {
43
+ padding: 2px;
44
+ background-color: red;
45
+ display: table;
46
+ }
47
+
48
+ #error_explanation {
49
+ width: 450px;
50
+ border: 2px solid red;
51
+ padding: 7px;
52
+ padding-bottom: 0;
53
+ margin-bottom: 20px;
54
+ background-color: #f0f0f0;
55
+ h2 {
56
+ text-align: left;
57
+ font-weight: bold;
58
+ padding: 5px 5px 5px 15px;
59
+ font-size: 12px;
60
+ margin: -7px;
61
+ margin-bottom: 0px;
62
+ background-color: #c00;
63
+ color: #fff;
64
+ }
65
+ ul li {
66
+ font-size: 12px;
67
+ list-style: square;
68
+ }
69
+ }
@@ -0,0 +1,3 @@
1
+ // Place all the styles related to the Users controller here.
2
+ // They will automatically be included in application.css.
3
+ // You can use Sass (SCSS) here: http://sass-lang.com/
@@ -0,0 +1,3 @@
1
+ class ApplicationController < ActionController::Base
2
+ protect_from_forgery
3
+ end