mac_generators 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README +3 -0
  3. data/Rakefile +32 -0
  4. data/lib/generators/authentication/USAGE +8 -0
  5. data/lib/generators/authentication/authentication_generator.rb +89 -0
  6. data/lib/generators/authentication/templates/create_identities.rb +11 -0
  7. data/lib/generators/authentication/templates/erb/identity_new.html.erb +24 -0
  8. data/lib/generators/authentication/templates/erb/session_new.html.erb +14 -0
  9. data/lib/generators/authentication/templates/haml/identity_new.html.haml +18 -0
  10. data/lib/generators/authentication/templates/haml/session_new.html.haml +14 -0
  11. data/lib/generators/authentication/templates/identities_controller.rb +23 -0
  12. data/lib/generators/authentication/templates/identity.rb +26 -0
  13. data/lib/generators/authentication/templates/sessions_controller.rb +21 -0
  14. data/lib/generators/bootstrap/USAGE +7 -0
  15. data/lib/generators/bootstrap/bootstrap_generator.rb +36 -0
  16. data/lib/generators/bootstrap/templates/_application.css.scss +3 -0
  17. data/lib/generators/bootstrap/templates/_variables.css.scss +4 -0
  18. data/lib/generators/bootstrap/templates/application.html.erb +16 -0
  19. data/lib/generators/bootstrap/templates/application.html.haml +10 -0
  20. data/lib/generators/bootstrap/templates/application.js +4 -0
  21. data/lib/generators/bootstrap/templates/application.scss +3 -0
  22. data/lib/mac_generators.rb +2 -0
  23. data/lib/mac_generators/version.rb +3 -0
  24. data/lib/tasks/mac_generators_tasks.rake +4 -0
  25. data/test/dummy/README.rdoc +259 -0
  26. data/test/dummy/Rakefile +6 -0
  27. data/test/dummy/app/assets/javascripts/application.js +16 -0
  28. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  29. data/test/dummy/app/controllers/application_controller.rb +5 -0
  30. data/test/dummy/app/helpers/application_helper.rb +2 -0
  31. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  32. data/test/dummy/config.ru +4 -0
  33. data/test/dummy/config/application.rb +32 -0
  34. data/test/dummy/config/boot.rb +9 -0
  35. data/test/dummy/config/database.yml +25 -0
  36. data/test/dummy/config/environment.rb +5 -0
  37. data/test/dummy/config/environments/development.rb +34 -0
  38. data/test/dummy/config/environments/production.rb +85 -0
  39. data/test/dummy/config/environments/test.rb +39 -0
  40. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  41. data/test/dummy/config/initializers/inflections.rb +16 -0
  42. data/test/dummy/config/initializers/locale.rb +7 -0
  43. data/test/dummy/config/initializers/mime_types.rb +5 -0
  44. data/test/dummy/config/initializers/secret_token.rb +12 -0
  45. data/test/dummy/config/initializers/session_store.rb +3 -0
  46. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  47. data/test/dummy/config/locales/en.yml +23 -0
  48. data/test/dummy/config/routes.rb +49 -0
  49. data/test/dummy/db/development.sqlite3 +0 -0
  50. data/test/dummy/log/development.log +0 -0
  51. data/test/dummy/public/404.html +27 -0
  52. data/test/dummy/public/422.html +26 -0
  53. data/test/dummy/public/500.html +26 -0
  54. data/test/dummy/public/favicon.ico +0 -0
  55. data/test/dummy/script/rails +6 -0
  56. data/test/mac_generators_test.rb +7 -0
  57. data/test/test_helper.rb +15 -0
  58. metadata +173 -0
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2012 MARIO A CHAVEZ
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 ADDED
@@ -0,0 +1,3 @@
1
+ = MacGenerators
2
+
3
+ This project rocks and uses MIT-LICENSE.
data/Rakefile ADDED
@@ -0,0 +1,32 @@
1
+ begin
2
+ require 'bundler/setup'
3
+ rescue LoadError
4
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
5
+ end
6
+
7
+ require 'rdoc/task'
8
+
9
+ RDoc::Task.new(:rdoc) do |rdoc|
10
+ rdoc.rdoc_dir = 'rdoc'
11
+ rdoc.title = 'MacGenerators'
12
+ rdoc.options << '--line-numbers'
13
+ rdoc.rdoc_files.include('README.rdoc')
14
+ rdoc.rdoc_files.include('lib/**/*.rb')
15
+ end
16
+
17
+
18
+
19
+
20
+ Bundler::GemHelper.install_tasks
21
+
22
+ require 'rake/testtask'
23
+
24
+ Rake::TestTask.new(:test) do |t|
25
+ t.libs << 'lib'
26
+ t.libs << 'test'
27
+ t.pattern = 'test/**/*_test.rb'
28
+ t.verbose = false
29
+ end
30
+
31
+
32
+ task default: :test
@@ -0,0 +1,8 @@
1
+ Description:
2
+ Will generate files for Rails authentication
3
+
4
+ Example:
5
+ rails generate authentication
6
+
7
+ This will create:
8
+ app/controllers/identity_controller.rb
@@ -0,0 +1,89 @@
1
+ class AuthenticationGenerator < Rails::Generators::Base
2
+
3
+ source_root File.expand_path('../templates', __FILE__)
4
+ argument :resource_name, :type => :string, :default => 'identity'
5
+ class_option :haml, type: :boolean, default: false, description: 'Generate haml templates'
6
+
7
+ def copy_controller_files
8
+ template 'identities_controller.rb', "app/controllers/#{resource_pluralize}_controller.rb"
9
+ template 'sessions_controller.rb', 'app/controllers/sessions_controller.rb'
10
+ end
11
+
12
+ def copy_view_files
13
+ puts ">>>#{options}"
14
+ if options[:haml]
15
+ template 'haml/identity_new.html.haml', "app/views/#{resource_pluralize}/new.html.haml"
16
+ template 'haml/session_new.html.haml', "app/views/sessions/new.html.haml"
17
+ else
18
+ template 'erb/identity_new.html.erb', "app/views/#{resource_pluralize}/new.html.erb"
19
+ template 'erb/session_new.html.erb', "app/views/sessions/new.html.erb"
20
+ end
21
+ end
22
+
23
+ def add_routes
24
+ route "get 'sign_up' => '#{resource_pluralize}#new', as: :sign_up"
25
+ route "get 'log_in' => 'sessions#new', as: :log_in"
26
+ route "get 'log_out' => 'sessions#destroy', as: :log_out"
27
+
28
+ route "resource :#{resource_name}, only: [:create, :new]"
29
+ route "resource :sessions, only: [:create, :new]"
30
+ end
31
+
32
+ def generate_user
33
+ if Dir["db/migrate/*create_#{resource_pluralize}.rb"].empty?
34
+ template 'create_identities.rb', "db/migrate/#{migration_name}"
35
+ end
36
+ template 'identity.rb', "app/models/#{resource_name}.rb"
37
+ end
38
+
39
+ def add_helper_methods
40
+ insert_into_file 'app/controllers/application_controller.rb', after: /:exception/ do
41
+ <<-EOS
42
+
43
+
44
+ helper_method :current_#{resource_name}
45
+
46
+ private
47
+ def current_#{resource_name}
48
+ @current_#{resource_name} ||= #{resource_name.classify}.find(session[:#{resource_name}_id]) if session[:#{resource_name}_id]
49
+ end
50
+ EOS
51
+ end
52
+
53
+ end
54
+
55
+ def add_gems
56
+ gem 'bcrypt-ruby', require: 'bcrypt'
57
+ end
58
+
59
+ def add_translations
60
+ insert_into_file "config/locales/#{I18n.default_locale.to_s}.yml", after: 'en:' do
61
+ <<-EOS
62
+
63
+ sessions:
64
+ new:
65
+ log_in: 'Log in'
66
+ create:
67
+ invalid_credentials: 'Your credentials are invalid'
68
+ logged_in: 'Welcome back!'
69
+ destroy:
70
+ logged_out: 'See you later!'
71
+ #{resource_pluralize}:
72
+ new:
73
+ create: 'Create #{resource_name}'
74
+ create:
75
+ sign_up: 'Welcome to your new account!'
76
+ EOS
77
+ end
78
+ end
79
+
80
+ private
81
+ def resource_pluralize
82
+ @resource_pluralize ||= resource_name.pluralize
83
+ end
84
+
85
+ def migration_name
86
+ date = (DateTime.now.strftime "%Y %m %d %H %M %S").gsub(' ', '')
87
+ "#{date}_create_#{resource_pluralize}.rb"
88
+ end
89
+ end
@@ -0,0 +1,11 @@
1
+ class Create<%= resource_pluralize.capitalize %> < ActiveRecord::Migration
2
+ def change
3
+ create_table :<%= resource_pluralize %> do |t|
4
+ t.string :email
5
+ t.string :password_hash
6
+ t.string :password_salt
7
+
8
+ t.timestamps
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,24 @@
1
+ <%%= form_for @<%= resource_name %>, url: <%= resource_name %>_path do |form| %>
2
+ <%% if @<%= resource_name %>.errors.any? %>
3
+ <h2>Form is invalid</h2>
4
+ <ul>
5
+ <%% for message in @<%= resource_name %>.errors.full_messages %>
6
+ <li><%%= message %>
7
+ <%% end %>
8
+ </ul>
9
+ <%% end %>
10
+
11
+ <p>
12
+ <%%= form.label :email %>
13
+ <%%= form.text_field :email %>
14
+ </p>
15
+ <p>
16
+ <%%= form.label :password %>
17
+ <%%= form.password_field :password %>
18
+ </p>
19
+ <p>
20
+ <%%= form.label :password_confirmation %>
21
+ <%%= form.password_field :password_confirmation %>
22
+ </p>
23
+ <p class='button'><%%= form.submit t('.create')%></p>
24
+ <%% end %>
@@ -0,0 +1,14 @@
1
+ <%%- if flash.alert %>
2
+ <div class='alert'><%%= flash.alert %></div>
3
+ <%% end %>
4
+ <%%= form_tag sessions_path do %>
5
+ <p>
6
+ <%%= label_tag :email %><br />
7
+ <%%= text_field_tag :email, params[:email] %>
8
+ </p>
9
+ <p>
10
+ <%%= label_tag :password %><br />
11
+ <%%= password_field_tag :password, params[:password] %>
12
+ </p>
13
+ <p class='button'><%%= submit_tag t('.log_in') %></p>
14
+ <%% end %>
@@ -0,0 +1,18 @@
1
+ = form_for @<%= resource_name %>, url: <%= resource_name %>_path do |form|
2
+ - if @<%= resource_name %>.errors.any?
3
+ %h2 Form is invalid
4
+ %ul
5
+ - for message in @<%= resource_name %>.errors.full_messages
6
+ %li
7
+ = message
8
+ %p
9
+ = form.label :email
10
+ = form.text_field :email
11
+ %p
12
+ = form.label :password
13
+ = form.password_field :password
14
+ %p
15
+ = form.label :password_confirmation
16
+ = form.password_field :password_confirmation
17
+ %p.button
18
+ = form.submit t('.create')
@@ -0,0 +1,14 @@
1
+ - if flash.alert
2
+ .alert
3
+ = flash.alert
4
+ = form_tag sessions_path do
5
+ %p
6
+ = label_tag :email
7
+ %br/
8
+ = text_field_tag :email, params[:email]
9
+ %p
10
+ = label_tag :password
11
+ %br/
12
+ = password_field_tag :password, params[:password]
13
+ %p.button
14
+ = submit_tag t('.log_in')
@@ -0,0 +1,23 @@
1
+ class <%= resource_pluralize.capitalize %>Controller < ApplicationController
2
+
3
+ def new
4
+ @<%= resource_name %> = <%= resource_name.classify %>.new
5
+ end
6
+
7
+ def create
8
+ @<%= resource_name %> = <%= resource_name.classify %>.new <%= resource_name %>_params
9
+
10
+ if @<%= resource_name %>.save
11
+ session[:<%=resource_name %>_id] = <%= resource_name %>.id
12
+ redirect_to root_url, notice: t('.sign_up')
13
+ else
14
+ render :new
15
+ end
16
+ end
17
+
18
+ private
19
+ def <%= resource_name %>_params
20
+ params.require(:<%= resource_name %>).permit :email, :password, :password_confirmation
21
+ end
22
+
23
+ end
@@ -0,0 +1,26 @@
1
+ class <%= resource_name.classify %> < ActiveRecord::Base
2
+ attr_accessor :password
3
+ before_save :encrypt_password
4
+
5
+ validates_confirmation_of :password
6
+ validates_presence_of :password, :on => :create
7
+ validates_presence_of :email
8
+ validates_uniqueness_of :email
9
+
10
+ def encrypt_password
11
+ if password.present?
12
+ self.password_salt = BCrypt::Engine.generate_salt
13
+ self.password_hash = BCrypt::Engine.hash_secret(password, password_salt)
14
+ end
15
+ end
16
+
17
+ def self.authenticate(email, password)
18
+ <%= resource_name %> = where(email: email).first
19
+
20
+ if <%= resource_name %> && <%= resource_name %>.password_hash == BCrypt::Engine.hash_secret(password, <%= resource_name %>.password_salt)
21
+ <%= resource_name %>
22
+ else
23
+ nil
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,21 @@
1
+ class SessionsController < ApplicationController
2
+ def new
3
+ end
4
+
5
+ def create
6
+ <%= resource_name %> = <%= resource_name.classify %>.authenticate params[:email], params[:password]
7
+
8
+ if <%= resource_name %>
9
+ session[:<%=resource_name %>_id] = <%= resource_name %>.id
10
+ return redirect_to root_url, notice: t('.logged_in')
11
+ end
12
+ flash.now.alert = t('.invalid_credentials')
13
+ render :new
14
+ end
15
+
16
+ def destroy
17
+ session[:<%=resource_name %>_id] = nil
18
+ redirect_to root_url, notice: t('.logged_out')
19
+ end
20
+ end
21
+
@@ -0,0 +1,7 @@
1
+ Description:
2
+ Will generate bootstrap setup with sass and coffee support
3
+
4
+ Example:
5
+ rails generate bootstrap
6
+
7
+ This will create:
@@ -0,0 +1,36 @@
1
+ class BootstrapGenerator < Rails::Generators::Base
2
+
3
+ source_root File.expand_path('../templates', __FILE__)
4
+ argument :resource_name, :type => :string, :default => 'application'
5
+ class_option :haml, type: :boolean, default: false, description: 'Generate haml templates'
6
+
7
+ def add_gems
8
+ gem 'bootstrap-sass'
9
+ end
10
+
11
+ def create_scss_files
12
+ copy_file '_variables.css.scss', "app/assets/stylesheets/#{resource_name}/_variables.css.scss"
13
+ copy_file '_application.css.scss', "app/assets/stylesheets/#{resource_name}/_#{resource_name}.css.scss"
14
+ end
15
+
16
+ def create_scss_manifest
17
+ template 'application.scss', "app/assets/stylesheets/#{resource_name}.scss"
18
+ end
19
+
20
+ def create_coffee_manifest
21
+ template 'application.js', "app/assets/javascripts/#{resource_name}.js"
22
+ end
23
+
24
+ def create_layout
25
+ if options[:haml]
26
+ template 'application.html.haml', "app/views/layouts/#{resource_name}.html.haml"
27
+ else
28
+ template 'application.html.erb', "app/views/layouts/#{resource_name}.html.erb"
29
+ end
30
+ end
31
+
32
+ private
33
+ def application_name
34
+ Rails.application.class.name.split('::').first
35
+ end
36
+ end
@@ -0,0 +1,3 @@
1
+ /*
2
+ In this file override any css style or add new ones
3
+ */
@@ -0,0 +1,4 @@
1
+ /*
2
+ Include your variables to override bootstrap them.
3
+ For more info look at http://twitter.github.com/bootstrap/customize.html
4
+ */
@@ -0,0 +1,16 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title><%= application_name %></title>
5
+ <%%= stylesheet_link_tag "<%= resource_name %>", media: "all" %>
6
+ <%%= javascript_include_tag "<%= resource_name %>" %>
7
+ <%%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <div class="container">
12
+ <%%= yield %>
13
+ </div>
14
+
15
+ </body>
16
+ </html>
@@ -0,0 +1,10 @@
1
+ !!!
2
+ %html
3
+ %head
4
+ %title <%= application_name %>
5
+ = stylesheet_link_tag "<%= resource_name %>", media: "all"
6
+ = javascript_include_tag "<%= resource_name %>"
7
+ = csrf_meta_tags
8
+ %body
9
+ .container
10
+ = yield
@@ -0,0 +1,4 @@
1
+ //= require jquery
2
+ //= require jquery_ujs
3
+ //= require turbolinks
4
+ //= require bootstrap
@@ -0,0 +1,3 @@
1
+ @import "<%= resource_name %>/variables";
2
+ @import "bootstrap";
3
+ @import "<%= resource_name %>/<%= resource_name %>";
@@ -0,0 +1,2 @@
1
+ module MacGenerators
2
+ end
@@ -0,0 +1,3 @@
1
+ module MacGenerators
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :mac_generators do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,259 @@
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 the 'debugger' gem to run the server in debugging
90
+ mode. Add gem 'debugger' to your Gemfile and run <tt>bundle</tt> to install it. 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
+
195
+ app
196
+ Holds all the code that's specific to this particular application.
197
+
198
+ app/assets
199
+ Contains subdirectories for images, stylesheets, and JavaScript files.
200
+
201
+ app/controllers
202
+ Holds controllers that should be named like weblogs_controller.rb for
203
+ automated URL mapping. All controllers should descend from
204
+ ApplicationController which itself descends from ActionController::Base.
205
+
206
+ app/models
207
+ Holds models that should be named like post.rb. Models descend from
208
+ ActiveRecord::Base by default.
209
+
210
+ app/views
211
+ Holds the template files for the view that should be named like
212
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
213
+ eRuby syntax by default.
214
+
215
+ app/views/layouts
216
+ Holds the template files for layouts to be used with views. This models the
217
+ common header/footer method of wrapping views. In your views, define a layout
218
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
219
+ Inside default.html.erb, call <% yield %> to render the view using this
220
+ layout.
221
+
222
+ app/helpers
223
+ Holds view helpers that should be named like weblogs_helper.rb. These are
224
+ generated for you automatically when using generators for controllers.
225
+ Helpers can be used to wrap functionality for your views into methods.
226
+
227
+ config
228
+ Configuration files for the Rails environment, the routing map, the database,
229
+ and other dependencies.
230
+
231
+ db
232
+ Contains the database schema in schema.rb. db/migrate contains all the
233
+ sequence of Migrations for your schema.
234
+
235
+ doc
236
+ This directory is where your application documentation will be stored when
237
+ generated using <tt>rake doc:app</tt>
238
+
239
+ lib
240
+ Application specific libraries. Basically, any kind of custom code that
241
+ doesn't belong under controllers, models, or helpers. This directory is in
242
+ the load path.
243
+
244
+ public
245
+ The directory available for the web server. Also contains the dispatchers and the
246
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
247
+ server.
248
+
249
+ script
250
+ Helper scripts for automation and generation.
251
+
252
+ test
253
+ Unit and functional tests along with fixtures. When using the rails generate
254
+ command, template test files will be generated for you and placed in this
255
+ directory.
256
+
257
+ vendor
258
+ External libraries that the application depends on. If the app has frozen rails,
259
+ those gems also go here, under vendor/rails/. This directory is in the load path.