activeadmin-selleo-cms 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.rdoc +13 -0
  3. data/Rakefile +40 -0
  4. data/app/admin/activeadmin_selleo_cms/locale.rb +21 -0
  5. data/app/admin/activeadmin_selleo_cms/page.rb +68 -0
  6. data/app/admin/translation.rb +35 -0
  7. data/app/assets/javascripts/activeadmin-selleo-cms/application.js +15 -0
  8. data/app/assets/javascripts/activeadmin-selleo-cms/custom.js +44 -0
  9. data/app/assets/javascripts/activeadmin-selleo-cms/jquery.mjs.nestedSortable.js +429 -0
  10. data/app/assets/stylesheets/activeadmin-selleo-cms/application.css +13 -0
  11. data/app/assets/stylesheets/activeadmin-selleo-cms/custom.css +59 -0
  12. data/app/assets/stylesheets/activeadmin-selleo-cms/jquery-ui.css +517 -0
  13. data/app/controllers/activeadmin_selleo_cms/application_controller.rb +9 -0
  14. data/app/controllers/activeadmin_selleo_cms/locales_controller.rb +8 -0
  15. data/app/controllers/activeadmin_selleo_cms/pages_controller.rb +15 -0
  16. data/app/controllers/activeadmin_selleo_cms/searches_controller.rb +8 -0
  17. data/app/helpers/activeadmin_selleo_cms/application_helper.rb +27 -0
  18. data/app/models/activeadmin_selleo_cms/layout.rb +10 -0
  19. data/app/models/activeadmin_selleo_cms/locale.rb +44 -0
  20. data/app/models/activeadmin_selleo_cms/page.rb +64 -0
  21. data/app/models/activeadmin_selleo_cms/search.rb +10 -0
  22. data/app/models/activeadmin_selleo_cms/section.rb +20 -0
  23. data/app/models/ckeditor/asset.rb +4 -0
  24. data/app/models/ckeditor/attachment_file.rb +12 -0
  25. data/app/models/ckeditor/picture.rb +13 -0
  26. data/app/models/translation.rb +25 -0
  27. data/app/modules/active_admin/views/index_as_list.rb +28 -0
  28. data/app/modules/activeadmin_selleo_cms/content_translation.rb +25 -0
  29. data/app/views/active_admin/resource/update.js +0 -0
  30. data/app/views/activeadmin_selleo_cms/pages/show.html.haml +3 -0
  31. data/app/views/activeadmin_selleo_cms/searches/show.html.haml +6 -0
  32. data/app/views/admin/pages/_fields_additional_locale.html.haml +17 -0
  33. data/app/views/admin/pages/_fields_current_locale.html.haml +14 -0
  34. data/app/views/admin/pages/_form.html.haml +65 -0
  35. data/app/views/admin/pages/_js.html.haml +12 -0
  36. data/app/views/admin/translations/update.js.haml +4 -0
  37. data/app/views/layouts/activeadmin_selleo_cms/application.html.erb +15 -0
  38. data/config/initializers/active_admin.rb +7 -0
  39. data/config/initializers/ckeditor.rb +18 -0
  40. data/config/initializers/i18n.rb +8 -0
  41. data/config/initializers/string_extensions.rb +5 -0
  42. data/config/locales/cms.en.yml +7 -0
  43. data/config/routes.rb +14 -0
  44. data/db/migrate/20121129142932_create_activeadmin_selleo_cms_pages.rb +20 -0
  45. data/db/migrate/20121129160200_create_activeadmin_selleo_cms_locales.rb +19 -0
  46. data/db/migrate/20121204112326_create_ckeditor_assets.rb +26 -0
  47. data/db/migrate/20121206231053_create_activeadmin_selleo_cms_sections.rb +12 -0
  48. data/db/migrate/20121221164723_create_activeadmin_selleo_cms_searches.rb +33 -0
  49. data/db/migrate/20121227222912_create_translations.rb +18 -0
  50. data/lib/activeadmin-selleo-cms.rb +11 -0
  51. data/lib/activeadmin-selleo-cms/application.rb +15 -0
  52. data/lib/activeadmin-selleo-cms/engine.rb +5 -0
  53. data/lib/activeadmin-selleo-cms/version.rb +3 -0
  54. data/lib/tasks/activeadmin-selleo-cms_tasks.rake +4 -0
  55. data/lib/tasks/i18n.rake +6 -0
  56. data/test/activeadmin-selleo-cms_test.rb +7 -0
  57. data/test/dummy/README.rdoc +261 -0
  58. data/test/dummy/Rakefile +7 -0
  59. data/test/dummy/app/assets/javascripts/application.js +15 -0
  60. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  61. data/test/dummy/app/controllers/application_controller.rb +3 -0
  62. data/test/dummy/app/helpers/application_helper.rb +2 -0
  63. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  64. data/test/dummy/config.ru +4 -0
  65. data/test/dummy/config/application.rb +59 -0
  66. data/test/dummy/config/boot.rb +10 -0
  67. data/test/dummy/config/database.yml +25 -0
  68. data/test/dummy/config/environment.rb +5 -0
  69. data/test/dummy/config/environments/development.rb +37 -0
  70. data/test/dummy/config/environments/production.rb +67 -0
  71. data/test/dummy/config/environments/test.rb +37 -0
  72. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  73. data/test/dummy/config/initializers/inflections.rb +15 -0
  74. data/test/dummy/config/initializers/mime_types.rb +5 -0
  75. data/test/dummy/config/initializers/secret_token.rb +7 -0
  76. data/test/dummy/config/initializers/session_store.rb +8 -0
  77. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  78. data/test/dummy/config/locales/en.yml +5 -0
  79. data/test/dummy/config/routes.rb +4 -0
  80. data/test/dummy/public/404.html +26 -0
  81. data/test/dummy/public/422.html +26 -0
  82. data/test/dummy/public/500.html +25 -0
  83. data/test/dummy/public/favicon.ico +0 -0
  84. data/test/dummy/script/rails +6 -0
  85. data/test/fixtures/activeadmin_selleo_cms/layouts.yml +11 -0
  86. data/test/fixtures/activeadmin_selleo_cms/page_parts.yml +11 -0
  87. data/test/fixtures/activeadmin_selleo_cms/pages.yml +11 -0
  88. data/test/integration/navigation_test.rb +10 -0
  89. data/test/test_helper.rb +15 -0
  90. data/test/unit/activeadmin_selleo_cms/page_part_test.rb +9 -0
  91. data/test/unit/activeadmin_selleo_cms/page_test.rb +9 -0
  92. metadata +364 -0
@@ -0,0 +1,12 @@
1
+ = javascript_include_tag "activeadmin-selleo-cms/jquery.mjs.nestedSortable"
2
+
3
+ :javascript
4
+ $(document).ready(function(){
5
+
6
+ $('.sortable').nestedSortable({
7
+ handle: 'div',
8
+ items: 'li',
9
+ toleranceElement: '> div'
10
+ });
11
+
12
+ });
@@ -0,0 +1,4 @@
1
+ - if @translation and @translation.update_attribute(:value, params[:value])
2
+ $('#translations.index input[data-locale="#{@translation.locale}"]').filter('[data-key="#{@translation.key}"]').closest('td').effect('highlight');
3
+ - else
4
+ alert('#{t("cms.errors.ajax.update.unknown_error")}');
@@ -0,0 +1,15 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>ActiveadminSelleoCms</title>
5
+ <%= stylesheet_link_tag "activeadmin-selleo-cms/application", :media => "all" %>
6
+ <%= javascript_include_tag "activeadmin-selleo-cms/application" %>
7
+ <%= csrf_meta_tags %>
8
+ <link rel="stylesheet" href="http://code.jquery.com/ui/1.9.2/themes/base/jquery-ui.css" />
9
+ </head>
10
+ <body>
11
+
12
+ <%= yield %>
13
+
14
+ </body>
15
+ </html>
@@ -0,0 +1,7 @@
1
+ ActiveAdmin.setup do |config|
2
+ config.register_javascript 'ckeditor/init.js'
3
+ config.register_javascript 'activeadmin-selleo-cms/custom.js'
4
+
5
+ config.register_stylesheet 'activeadmin-selleo-cms/jquery-ui.css'
6
+ config.register_stylesheet 'activeadmin-selleo-cms/custom.css'
7
+ end
@@ -0,0 +1,18 @@
1
+ # Use this hook to configure ckeditor
2
+ if Object.const_defined?("Ckeditor")
3
+ Ckeditor.setup do |config|
4
+ # ==> ORM configuration
5
+ # Load and configure the ORM. Supports :active_record (default), :mongo_mapper and
6
+ # :mongoid (bson_ext recommended) by default. Other ORMs may be
7
+ # available as additional gems.
8
+ require "ckeditor/orm/active_record"
9
+
10
+ # Allowed image file types for upload.
11
+ # Set to nil or [] (empty array) for all file types
12
+ # config.image_file_types = ["jpg", "jpeg", "png", "gif", "tiff"]
13
+
14
+ # Allowed attachment file types for upload.
15
+ # Set to nil or [] (empty array) for all file types
16
+ # config.attachment_file_types = ["doc", "docx", "xls", "odt", "ods", "pdf", "rar", "zip", "tar", "swf"]
17
+ end
18
+ end
@@ -0,0 +1,8 @@
1
+ require "i18n/backend/fallbacks"
2
+ I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
3
+
4
+ if ActiveRecord::Base.connection.table_exists? 'translations'
5
+ require 'i18n/backend/active_record'
6
+ I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Fallbacks)
7
+ I18n.backend = I18n::Backend::Chain.new(I18n::Backend::ActiveRecord.new, I18n.backend)
8
+ end
@@ -0,0 +1,5 @@
1
+ class String
2
+ def to_boolean
3
+ !!(self =~ /^(true|t|yes|y|1)$/i)
4
+ end
5
+ end
@@ -0,0 +1,7 @@
1
+ en:
2
+ cms:
3
+ navbar:
4
+ search:
5
+ placeholder: "search"
6
+ footer:
7
+ copyright: "© JIPS Web Development 2011 - 2013"
data/config/routes.rb ADDED
@@ -0,0 +1,14 @@
1
+ ActiveadminSelleoCms::Engine.routes.draw do
2
+ mount Ckeditor::Engine => '/ckeditor'
3
+
4
+ scope ":locale", :locale => /\w{2}/ do
5
+ scope "search" do
6
+ resources :searches, path: '', only: [:show]
7
+ end
8
+ resources :pages, path: '', only: [:show]
9
+ end
10
+
11
+ match ':locale' => 'pages#show'
12
+
13
+ root to: 'pages#show'
14
+ end
@@ -0,0 +1,20 @@
1
+ class CreateActiveadminSelleoCmsPages < ActiveRecord::Migration
2
+ def change
3
+ create_table :activeadmin_selleo_cms_pages do |t|
4
+ t.integer :parent_id
5
+ t.integer :lft
6
+ t.integer :rgt
7
+ t.integer :depth
8
+ t.string :layout
9
+ t.boolean :show_in_menu, default: true
10
+ t.boolean :is_published
11
+ t.datetime :published_at
12
+ t.boolean :is_link_url, default: false
13
+ t.string :link_url
14
+ t.integer :views, default: 0
15
+ t.timestamps
16
+ end
17
+
18
+ ActiveadminSelleoCms::Page.create_translation_table! title: :string, slug: :string, browser_title: :string, meta_keywords: :string, meta_description: :text
19
+ end
20
+ end
@@ -0,0 +1,19 @@
1
+ class CreateActiveadminSelleoCmsLocales < ActiveRecord::Migration
2
+ def up
3
+ create_table :activeadmin_selleo_cms_locales do |t|
4
+ t.string :name
5
+ t.string :code
6
+ t.boolean :enabled, default: false
7
+ end
8
+ add_index :activeadmin_selleo_cms_locales, :name
9
+ add_index :activeadmin_selleo_cms_locales, :code
10
+ add_index :activeadmin_selleo_cms_locales, :enabled
11
+ LanguageList::COMMON_LANGUAGES.each do |lang|
12
+ ActiveadminSelleoCms::Locale.create({name: lang.name, code: lang.iso_639_1, enabled: ['en'].include?(lang.iso_639_1)}, as: :admin)
13
+ end
14
+ end
15
+
16
+ def down
17
+ drop_table :activeadmin_selleo_cms_locales
18
+ end
19
+ end
@@ -0,0 +1,26 @@
1
+ class CreateCkeditorAssets < ActiveRecord::Migration
2
+ def self.up
3
+ create_table :ckeditor_assets do |t|
4
+ t.string :data_file_name, :null => false
5
+ t.string :data_content_type
6
+ t.integer :data_file_size
7
+
8
+ t.integer :assetable_id
9
+ t.string :assetable_type, :limit => 30
10
+ t.string :type, :limit => 30
11
+
12
+ # Uncomment it to save images dimensions, if your need it
13
+ t.integer :width
14
+ t.integer :height
15
+
16
+ t.timestamps
17
+ end
18
+
19
+ add_index "ckeditor_assets", ["assetable_type", "type", "assetable_id"], :name => "idx_ckeditor_assetable_type"
20
+ add_index "ckeditor_assets", ["assetable_type", "assetable_id"], :name => "idx_ckeditor_assetable"
21
+ end
22
+
23
+ def self.down
24
+ drop_table :ckeditor_assets
25
+ end
26
+ end
@@ -0,0 +1,12 @@
1
+ class CreateActiveadminSelleoCmsSections < ActiveRecord::Migration
2
+ def change
3
+ create_table :activeadmin_selleo_cms_sections do |t|
4
+ t.string :name, :null => false
5
+ t.belongs_to :sectionable, polymorphic: true
6
+ t.timestamps
7
+ end
8
+ add_index :activeadmin_selleo_cms_sections, :name
9
+
10
+ ActiveadminSelleoCms::Section.create_translation_table! body: :text
11
+ end
12
+ end
@@ -0,0 +1,33 @@
1
+ class CreateActiveadminSelleoCmsSearches < ActiveRecord::Migration
2
+ def up
3
+ ActiveRecord::Base.connection.execute <<-SQL
4
+ CREATE VIEW activeadmin_selleo_cms_searches AS
5
+ SELECT
6
+ 'ActiveadminSelleoCms::Page' AS searchable_type,
7
+ page_translations.activeadmin_selleo_cms_page_id AS searchable_id,
8
+ coalesce(page_translations.title,'')||' '||coalesce(page_translations.browser_title,'') AS content,
9
+ page_translations.locale
10
+ FROM
11
+ activeadmin_selleo_cms_page_translations page_translations
12
+
13
+ UNION ALL
14
+
15
+ SELECT
16
+ 'ActiveadminSelleoCms::Page' AS searchable_type,
17
+ sections.sectionable_id AS searchable_id,
18
+ coalesce(section_translations.body,'') AS content,
19
+ section_translations.locale
20
+ FROM
21
+ activeadmin_selleo_cms_section_translations section_translations
22
+ INNER JOIN
23
+ activeadmin_selleo_cms_sections sections
24
+ ON sections.id = section_translations.activeadmin_selleo_cms_section_id
25
+ SQL
26
+ end
27
+
28
+ def down
29
+ ActiveRecord::Base.connection.execute <<-SQL
30
+ DROP VIEW activeadmin_selleo_cms_searches
31
+ SQL
32
+ end
33
+ end
@@ -0,0 +1,18 @@
1
+ class CreateTranslations < ActiveRecord::Migration
2
+ def up
3
+ create_table :translations do |t|
4
+ t.string :locale
5
+ t.string :key
6
+ t.text :value
7
+ t.text :interpolations
8
+ t.boolean :is_proc, default: false
9
+ t.datetime :created_at, null: false
10
+ t.datetime :updated_at, null: false
11
+ t.timestamps
12
+ end
13
+ end
14
+
15
+ def down
16
+ drop_table :translations
17
+ end
18
+ end
@@ -0,0 +1,11 @@
1
+ require "globalize3"
2
+ require "ckeditor"
3
+ require "language_list"
4
+ require "paperclip"
5
+ require "awesome_nested_set"
6
+ require "liquid"
7
+ require "activeadmin-selleo-cms/engine"
8
+ require "activeadmin-selleo-cms/application"
9
+
10
+ module ActiveadminSelleoCms
11
+ end
@@ -0,0 +1,15 @@
1
+ require 'active_admin/helpers/settings'
2
+
3
+ module ActiveadminSelleoCms
4
+ class Application
5
+ end
6
+ end
7
+
8
+ module ActiveAdmin
9
+ class Application
10
+ include Settings
11
+
12
+ setting :load_paths, ["#{ActiveadminSelleoCms::Engine.root}/app/admin", File.expand_path('app/admin', Rails.root)]
13
+
14
+ end
15
+ end
@@ -0,0 +1,5 @@
1
+ module ActiveadminSelleoCms
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace ActiveadminSelleoCms
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module ActiveadminSelleoCms
2
+ VERSION = "0.0.2"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :activeadmin-selleo-cms do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,6 @@
1
+ namespace :i18n do
2
+ task(:load => :environment) do
3
+ puts "Loading translations"
4
+ ActiveadminSelleoCms::Translation.load_translations!
5
+ end
6
+ end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class ActiveadminSelleoCmsTest < ActiveSupport::TestCase
4
+ test "truth" do
5
+ assert_kind_of Module, ActiveadminSelleoCms
6
+ end
7
+ end
@@ -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.