refinerycms-copywriting 2.0.2 → 2.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (79) hide show
  1. data/app/assets/stylesheets/{refinerycms-copywriting-tab.css.scss → refinery/copywriting/backend.css.scss} +4 -0
  2. data/app/models/refinery/copywriting/phrase.rb +3 -3
  3. data/app/views/refinery/copywriting/admin/phrases/_form.html.erb +8 -13
  4. data/app/views/refinery/copywriting/admin/phrases/_locale_filters.html.erb +0 -2
  5. data/app/views/refinery/copywriting/admin/phrases/_phrases.html.erb +1 -1
  6. data/app/views/refinery/copywriting/admin/phrases/edit.html.erb +1 -1
  7. data/app/views/refinery/copywriting/admin/phrases/index.html.erb +4 -4
  8. data/app/views/refinery/pages/admin/tabs/_copywriting.html.erb +2 -2
  9. data/config/locales/pl.yml +24 -0
  10. data/config/locales/ru.yml +24 -0
  11. data/config/routes.rb +1 -5
  12. data/db/migrate/2_create_copywriting_translation_table.rb +14 -1
  13. data/lib/refinery/copywriting/engine.rb +2 -2
  14. data/spec/models/copywriting_phrase_spec.rb +7 -2
  15. metadata +5 -67
  16. data/app/assets/stylesheets/refinerycms-copywriting.css.scss +0 -3
  17. data/spec/dummy/README.rdoc +0 -261
  18. data/spec/dummy/Rakefile +0 -7
  19. data/spec/dummy/app/assets/javascripts/application.js +0 -15
  20. data/spec/dummy/app/assets/stylesheets/application.css +0 -13
  21. data/spec/dummy/app/controllers/application_controller.rb +0 -3
  22. data/spec/dummy/app/helpers/application_helper.rb +0 -2
  23. data/spec/dummy/app/views/sitemap/index.xml.builder +0 -25
  24. data/spec/dummy/config.ru +0 -4
  25. data/spec/dummy/config/application.rb +0 -62
  26. data/spec/dummy/config/boot.rb +0 -6
  27. data/spec/dummy/config/database.yml +0 -18
  28. data/spec/dummy/config/database.yml.mysql +0 -20
  29. data/spec/dummy/config/database.yml.postgresql +0 -58
  30. data/spec/dummy/config/database.yml.sqlite3 +0 -18
  31. data/spec/dummy/config/environment.rb +0 -5
  32. data/spec/dummy/config/environments/development.rb +0 -37
  33. data/spec/dummy/config/environments/production.rb +0 -71
  34. data/spec/dummy/config/environments/test.rb +0 -37
  35. data/spec/dummy/config/initializers/backtrace_silencers.rb +0 -7
  36. data/spec/dummy/config/initializers/devise.rb +0 -229
  37. data/spec/dummy/config/initializers/inflections.rb +0 -15
  38. data/spec/dummy/config/initializers/mime_types.rb +0 -5
  39. data/spec/dummy/config/initializers/refinery/core.rb +0 -48
  40. data/spec/dummy/config/initializers/refinery/images.rb +0 -41
  41. data/spec/dummy/config/initializers/refinery/pages.rb +0 -44
  42. data/spec/dummy/config/initializers/refinery/resources.rb +0 -26
  43. data/spec/dummy/config/initializers/secret_token.rb +0 -7
  44. data/spec/dummy/config/initializers/session_store.rb +0 -8
  45. data/spec/dummy/config/initializers/wrap_parameters.rb +0 -14
  46. data/spec/dummy/config/locales/en.yml +0 -5
  47. data/spec/dummy/config/routes.rb +0 -3
  48. data/spec/dummy/db/migrate/20120416115049_create_copywritings.refinery_copywriting.rb +0 -24
  49. data/spec/dummy/db/migrate/20120416115050_create_copywriting_translation_table.refinery_copywriting.rb +0 -42
  50. data/spec/dummy/db/migrate/20120416115051_add_phrase_type.refinery_copywriting.rb +0 -12
  51. data/spec/dummy/db/migrate/20120416115052_add_refinery_prefix_to_tables.refinery_copywriting.rb +0 -14
  52. data/spec/dummy/db/migrate/20120416115053_add_phrase_last_access_at.refinery_copywriting.rb +0 -12
  53. data/spec/dummy/db/migrate/20120416115054_create_refinerycms_authentication_schema.refinery_authentication.rb +0 -44
  54. data/spec/dummy/db/migrate/20120416115055_create_refinerycms_images_schema.refinery_images.rb +0 -16
  55. data/spec/dummy/db/migrate/20120416115056_create_refinerycms_resources_schema.refinery_resources.rb +0 -14
  56. data/spec/dummy/db/migrate/20120416115057_create_refinerycms_pages_schema.refinery_pages.rb +0 -59
  57. data/spec/dummy/db/migrate/20120416115058_create_seo_meta.seo_meta_engine.rb +0 -24
  58. data/spec/dummy/db/schema.rb +0 -177
  59. data/spec/dummy/db/seeds.rb +0 -10
  60. data/spec/dummy/dummy_dev +0 -0
  61. data/spec/dummy/dummy_test +0 -0
  62. data/spec/dummy/log/development.log +0 -389
  63. data/spec/dummy/log/test.log +0 -1894
  64. data/spec/dummy/public/404.html +0 -26
  65. data/spec/dummy/public/422.html +0 -26
  66. data/spec/dummy/public/500.html +0 -25
  67. data/spec/dummy/public/favicon.ico +0 -0
  68. data/spec/dummy/script/rails +0 -6
  69. data/spec/dummy/tmp/index/development/refinery/page/102_111_117.ind +0 -2
  70. data/spec/dummy/tmp/index/development/refinery/page/104_111_109.ind +0 -0
  71. data/spec/dummy/tmp/index/development/refinery/page/110_111_116.ind +0 -1
  72. data/spec/dummy/tmp/index/development/refinery/page/112_97_103.ind +0 -0
  73. data/spec/dummy/tmp/index/development/refinery/page/97_98_111.ind +0 -0
  74. data/spec/dummy/tmp/index/development/refinery/page/size +0 -1
  75. data/spec/dummy/tmp/index/development/refinery/page/version +0 -1
  76. data/spec/dummy/tmp/index/test/refinery/page/112_97_103.ind +0 -1
  77. data/spec/dummy/tmp/index/test/refinery/page/116_101_115.ind +0 -0
  78. data/spec/dummy/tmp/index/test/refinery/page/size +0 -1
  79. data/spec/dummy/tmp/index/test/refinery/page/version +0 -1
@@ -1,3 +1,7 @@
1
+ .scope_icon {
2
+ background-image: url("/assets/refinery/icons/zoom.png");
3
+ }
4
+
1
5
  #copywriting-tab {
2
6
  ul {
3
7
  padding: 0 5px 10px 10px;
@@ -1,6 +1,6 @@
1
1
  module Refinery
2
2
  module Copywriting
3
- class Phrase < ActiveRecord::Base
3
+ class Phrase < Refinery::Core::BaseModel
4
4
 
5
5
  belongs_to :page, :class_name => 'Refinery::Page'
6
6
  translates :value if self.respond_to?(:translates)
@@ -19,7 +19,7 @@ module Refinery
19
19
  options[:name] = name.to_s
20
20
  options[:page_id] ||= options[:page].try(:id)
21
21
 
22
- phrase = self.find_by_name_and_page_id(options[:name], options[:page_id]) || self.create(options)
22
+ phrase = self.find_by_name_and_scope_and_page_id(options[:name], options[:scope], options[:page_id]) || self.create(options)
23
23
  phrase.update_attributes(options.except(:value, :page, :page_id, :locale))
24
24
  phrase.last_access_at = Date.today
25
25
  phrase.save if phrase.changed?
@@ -33,4 +33,4 @@ module Refinery
33
33
 
34
34
  end
35
35
  end
36
- end
36
+ end
@@ -1,19 +1,14 @@
1
1
  <%= form_for [refinery, :copywriting, :admin, @phrase] do |f| -%>
2
2
  <%= hidden_field_tag :switch_locale, @current_locale %>
3
3
 
4
- <%= render :partial => "/refinery/admin/error_messages", :locals => {
5
- :object => @phrase,
6
- :include_object_name => true
7
- } %>
4
+ <%= render "/refinery/admin/error_messages", :object => @phrase, :include_object_name => true %>
8
5
 
9
- <%= render :partial => '/refinery/copywriting/admin/phrases/value_field', :locals => {:f => f} %>
6
+ <%= render '/refinery/copywriting/admin/phrases/value_field', :f => f %>
10
7
 
11
- <%= render :partial => "/refinery/admin/form_actions",
12
- :locals => {
13
- :f => f,
14
- :continue_editing => false,
15
- :hide_cancel => true,
16
- :delete_title => t('delete', :scope => 'refinery.copywriting.admin.phrases.phrase'),
17
- :delete_confirmation => t('message', :scope => 'refinery.admin.delete', :title => @phrase.name)
18
- } %>
8
+ <%= render "/refinery/admin/form_actions",
9
+ :f => f,
10
+ :continue_editing => false,
11
+ :hide_cancel => true,
12
+ :delete_title => t('delete', :scope => 'refinery.copywriting.admin.phrases.phrase'),
13
+ :delete_confirmation => t('message', :scope => 'refinery.admin.delete', :title => @phrase.name) %>
19
14
  <% end -%>
@@ -1,4 +1,3 @@
1
- <% if ::Refinery.i18n_enabled? and !(::Refinery::I18n.frontend_locales == [::Refinery::I18n.default_frontend_locale]) %>
2
1
  <% locales = ::Refinery::I18n.locales.reject {|locale, title| !@locales.include?( locale ) } %>
3
2
  <ul class='collapsible_menu closed'>
4
3
 
@@ -22,4 +21,3 @@
22
21
  </li>
23
22
  <% end %>
24
23
  </ul>
25
- <% end %>
@@ -1,4 +1,4 @@
1
- <%= will_paginate @phrases %>
1
+ <%= will_paginate @phrases, :params => { :controller => "refinery/copywriting/admin/phrases", :action => "index" } %>
2
2
  <ul id='phrases'>
3
3
  <%= render :partial => 'refinery/copywriting/admin/phrases/phrase', :collection => @phrases %>
4
4
  </ul>
@@ -1 +1 @@
1
- <%= render :partial => "form" %>
1
+ <%= render "form" %>
@@ -1,10 +1,10 @@
1
1
  <section id='records'>
2
- <%= render :partial => 'records' %>
2
+ <%= render 'records' %>
3
3
  </section>
4
4
  <aside id='actions'>
5
- <%= render :partial => 'actions' %>
5
+ <%= render 'actions' %>
6
6
  </aside>
7
7
 
8
8
  <% content_for :stylesheets do %>
9
- <%= stylesheet_link_tag 'refinerycms-copywriting' %>
10
- <% end %>
9
+ <%= stylesheet_link_tag 'refinery/copywriting/backend' %>
10
+ <% end %>
@@ -5,7 +5,7 @@
5
5
  <% copywriting_phrases.each do |phrase| %>
6
6
  <li>
7
7
  <%= f.fields_for :copywriting_phrases, phrase do |p| %>
8
- <%= render :partial => 'refinery/copywriting/admin/phrases/value_field', :locals => {:f => p} %>
8
+ <%= render 'refinery/copywriting/admin/phrases/value_field', :f => p %>
9
9
  <% end %>
10
10
  </li>
11
11
  <% end %>
@@ -18,5 +18,5 @@
18
18
  <% end %>
19
19
 
20
20
  <% content_for :stylesheets do %>
21
- <%= stylesheet_link_tag 'refinerycms-copywriting-tab' %>
21
+ <%= stylesheet_link_tag 'refinery/copywriting/backend' %>
22
22
  <% end %>
@@ -0,0 +1,24 @@
1
+ pl:
2
+ refinery:
3
+ plugins:
4
+ refinerycms_copywriting:
5
+ title: "Stopki"
6
+ copywriting:
7
+ admin:
8
+ phrases:
9
+ locale_filters:
10
+ change_language: "Zmień język"
11
+ scope_filters:
12
+ filter_by_scope: "Filtruj wg elementu"
13
+ filtered_by: "Filtruj wg '%{filter_scope}'"
14
+ clear_scope_filter: "WYczyść"
15
+ records:
16
+ no_items_yet: "Nie ma jeszcze żadnej frazy do edycji."
17
+ phrase:
18
+ edit: "Edytuj frazę"
19
+ delete: "Usuń frazę"
20
+ pages:
21
+ admin:
22
+ tabs:
23
+ copywriting:
24
+ no_copywriting_yet: "Brak frazy do edycji dla tej strony"
@@ -0,0 +1,24 @@
1
+ ru:
2
+ refinery:
3
+ plugins:
4
+ refinerycms_copywriting:
5
+ title: Копирайтинг
6
+ copywriting:
7
+ admin:
8
+ phrases:
9
+ locale_filters:
10
+ change_language: Сменить язык
11
+ scope_filters:
12
+ filter_by_scope: Фильтровать по контексту
13
+ filtered_by: "Отфильтровано по '%{filter_scope}'"
14
+ clear_scope_filter: Очистить
15
+ records:
16
+ no_items_yet: Записей пока еще нет.
17
+ phrase:
18
+ edit: Редактировать эту запись
19
+ delete: Удалить эту запись
20
+ pages:
21
+ admin:
22
+ tabs:
23
+ copywriting:
24
+ no_copywriting_yet: Записей для этой страницы пока еще нет
@@ -2,11 +2,7 @@ Refinery::Core::Engine.routes.draw do
2
2
  namespace :copywriting, :path => '' do
3
3
  namespace :admin, :path => 'refinery' do
4
4
  scope :path => 'copywriting' do
5
- resources :phrases, :except => [:show, :new, :create] do
6
- collection do
7
- post :update_positions
8
- end
9
- end
5
+ resources :phrases, :except => [:show, :new, :create]
10
6
  end
11
7
  end
12
8
  end
@@ -13,7 +13,9 @@ class CreateCopywritingTranslationTable < ActiveRecord::Migration
13
13
  :migrate_data => true
14
14
  })
15
15
 
16
- rename_column Refinery::Copywriting::Phrase.translation_class.table_name, :copywriting_phrase_id, :refinery_copywriting_phrase_id
16
+ with_short_sqlite_compatible_index do
17
+ rename_column Refinery::Copywriting::Phrase.translation_class.table_name, :copywriting_phrase_id, :refinery_copywriting_phrase_id
18
+ end
17
19
 
18
20
  ::Refinery::Copywriting::Phrase.table_name = "refinery_#{Refinery::Copywriting::Phrase.table_name}"
19
21
  ::Refinery::Copywriting::Phrase.module_eval do
@@ -38,4 +40,15 @@ class CreateCopywritingTranslationTable < ActiveRecord::Migration
38
40
  ::Refinery::Copywriting::Phrase.translation_class.table_name = "refinery_#{Refinery::Copywriting::Phrase.translation_class.table_name}"
39
41
  end
40
42
 
43
+
44
+ def self.with_short_sqlite_compatible_index
45
+ if ActiveRecord::Base.connection.adapter_name.downcase.to_sym == :sqlite
46
+ remove_index Refinery::Copywriting::Phrase.translation_class.table_name, [:copywriting_phrase_id]#[:index_altered_copywriting_phrase_translations_on_copywriting_phrase_id]
47
+ yield
48
+ add_index Refinery::Copywriting::Phrase.translation_class.table_name, :refinery_copywriting_phrase_id, :name => "index_short_on_refinery_copywriting_phrase_id"
49
+ else
50
+ yield
51
+ end
52
+ end
53
+
41
54
  end
@@ -21,7 +21,7 @@ module Refinery
21
21
 
22
22
  initializer "register refinery_copywriting plugin", :after => :set_routes_reloader do |app|
23
23
  ::Refinery::Pages::Tab.register do |tab|
24
- tab.name = 'copywriting'
24
+ tab.name = ::I18n.t(:'refinery.plugins.refinerycms_copywriting.title')
25
25
  tab.partial = '/refinery/pages/admin/tabs/copywriting'
26
26
  end
27
27
 
@@ -42,4 +42,4 @@ module Refinery
42
42
  end
43
43
  end
44
44
  end
45
- end
45
+ end
@@ -22,7 +22,12 @@ describe Refinery::Copywriting::Phrase do
22
22
  Refinery::Copywriting::Phrase.where(:name => 'name').count.should == 1
23
23
  end
24
24
 
25
- it "should return the string the value once its set" do
25
+ it "differentiates records by scope" do
26
+ 2.times {|n| Refinery::Copywriting::Phrase.for('name', {:scope => "scope#{n}", :default => 'default'}) }
27
+ Refinery::Copywriting::Phrase.where(:name => 'name').pluck(:scope).should =~ ['scope0', 'scope1']
28
+ end
29
+
30
+ it "should return the string the value once it is set" do
26
31
  Refinery::Copywriting::Phrase.for('name', {:scope => 'scope', :default => 'default'}).should == 'default'
27
32
  copy = Refinery::Copywriting::Phrase.where(:name => 'name').first
28
33
  copy.value = 'updated!'
@@ -75,4 +80,4 @@ describe Refinery::Copywriting::Phrase do
75
80
 
76
81
  end
77
82
 
78
- end
83
+ end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: refinerycms-copywriting
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.2
4
+ version: 2.0.3
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -28,9 +28,10 @@ files:
28
28
  - config/locales/cs.yml
29
29
  - config/locales/en.yml
30
30
  - config/locales/es.yml
31
+ - config/locales/pl.yml
32
+ - config/locales/ru.yml
31
33
  - config/routes.rb
32
- - app/assets/stylesheets/refinerycms-copywriting-tab.css.scss
33
- - app/assets/stylesheets/refinerycms-copywriting.css.scss
34
+ - app/assets/stylesheets/refinery/copywriting/backend.css.scss
34
35
  - app/controllers/refinery/copywriting/admin/phrases_controller.rb
35
36
  - app/helpers/refinery/copywriting/copywriting_helper.rb
36
37
  - app/models/refinery/copywriting/phrase.rb
@@ -51,69 +52,6 @@ files:
51
52
  - db/migrate/4_add_refinery_prefix_to_tables.rb
52
53
  - db/migrate/5_add_phrase_last_access_at.rb
53
54
  - db/seeds/copywritings.rb
54
- - spec/dummy/app/assets/javascripts/application.js
55
- - spec/dummy/app/assets/stylesheets/application.css
56
- - spec/dummy/app/controllers/application_controller.rb
57
- - spec/dummy/app/helpers/application_helper.rb
58
- - spec/dummy/app/views/sitemap/index.xml.builder
59
- - spec/dummy/config/application.rb
60
- - spec/dummy/config/boot.rb
61
- - spec/dummy/config/database.yml
62
- - spec/dummy/config/database.yml.mysql
63
- - spec/dummy/config/database.yml.postgresql
64
- - spec/dummy/config/database.yml.sqlite3
65
- - spec/dummy/config/environment.rb
66
- - spec/dummy/config/environments/development.rb
67
- - spec/dummy/config/environments/production.rb
68
- - spec/dummy/config/environments/test.rb
69
- - spec/dummy/config/initializers/backtrace_silencers.rb
70
- - spec/dummy/config/initializers/devise.rb
71
- - spec/dummy/config/initializers/inflections.rb
72
- - spec/dummy/config/initializers/mime_types.rb
73
- - spec/dummy/config/initializers/refinery/core.rb
74
- - spec/dummy/config/initializers/refinery/images.rb
75
- - spec/dummy/config/initializers/refinery/pages.rb
76
- - spec/dummy/config/initializers/refinery/resources.rb
77
- - spec/dummy/config/initializers/secret_token.rb
78
- - spec/dummy/config/initializers/session_store.rb
79
- - spec/dummy/config/initializers/wrap_parameters.rb
80
- - spec/dummy/config/locales/en.yml
81
- - spec/dummy/config/routes.rb
82
- - spec/dummy/config.ru
83
- - spec/dummy/db/migrate/20120416115049_create_copywritings.refinery_copywriting.rb
84
- - spec/dummy/db/migrate/20120416115050_create_copywriting_translation_table.refinery_copywriting.rb
85
- - spec/dummy/db/migrate/20120416115051_add_phrase_type.refinery_copywriting.rb
86
- - spec/dummy/db/migrate/20120416115052_add_refinery_prefix_to_tables.refinery_copywriting.rb
87
- - spec/dummy/db/migrate/20120416115053_add_phrase_last_access_at.refinery_copywriting.rb
88
- - spec/dummy/db/migrate/20120416115054_create_refinerycms_authentication_schema.refinery_authentication.rb
89
- - spec/dummy/db/migrate/20120416115055_create_refinerycms_images_schema.refinery_images.rb
90
- - spec/dummy/db/migrate/20120416115056_create_refinerycms_resources_schema.refinery_resources.rb
91
- - spec/dummy/db/migrate/20120416115057_create_refinerycms_pages_schema.refinery_pages.rb
92
- - spec/dummy/db/migrate/20120416115058_create_seo_meta.seo_meta_engine.rb
93
- - spec/dummy/db/schema.rb
94
- - spec/dummy/db/seeds.rb
95
- - spec/dummy/dummy_dev
96
- - spec/dummy/dummy_test
97
- - spec/dummy/log/development.log
98
- - spec/dummy/log/test.log
99
- - spec/dummy/public/404.html
100
- - spec/dummy/public/422.html
101
- - spec/dummy/public/500.html
102
- - spec/dummy/public/favicon.ico
103
- - spec/dummy/Rakefile
104
- - spec/dummy/README.rdoc
105
- - spec/dummy/script/rails
106
- - spec/dummy/tmp/index/development/refinery/page/102_111_117.ind
107
- - spec/dummy/tmp/index/development/refinery/page/104_111_109.ind
108
- - spec/dummy/tmp/index/development/refinery/page/110_111_116.ind
109
- - spec/dummy/tmp/index/development/refinery/page/112_97_103.ind
110
- - spec/dummy/tmp/index/development/refinery/page/97_98_111.ind
111
- - spec/dummy/tmp/index/development/refinery/page/size
112
- - spec/dummy/tmp/index/development/refinery/page/version
113
- - spec/dummy/tmp/index/test/refinery/page/112_97_103.ind
114
- - spec/dummy/tmp/index/test/refinery/page/116_101_115.ind
115
- - spec/dummy/tmp/index/test/refinery/page/size
116
- - spec/dummy/tmp/index/test/refinery/page/version
117
55
  - spec/helpers/copywriting_helper_spec.rb
118
56
  - spec/models/copywriting_phrase_spec.rb
119
57
  - spec/spec_helper.rb
@@ -137,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
137
75
  version: '0'
138
76
  requirements: []
139
77
  rubyforge_project:
140
- rubygems_version: 1.8.10
78
+ rubygems_version: 1.8.23
141
79
  signing_key:
142
80
  specification_version: 3
143
81
  summary: Refinery CMS engine to manage copywriting, application wide or per pages,
@@ -1,3 +0,0 @@
1
- .scope_icon {
2
- background-image: url("/assets/refinery/icons/zoom.png");
3
- }
@@ -1,261 +0,0 @@
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.