wireframe-sass-rails 3.1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (168) hide show
  1. data/.gitignore +5 -0
  2. data/Gemfile +13 -0
  3. data/README.markdown +68 -0
  4. data/Rakefile +12 -0
  5. data/lib/rails/generators/sass/assets/assets_generator.rb +13 -0
  6. data/lib/rails/generators/sass/assets/templates/stylesheet.css.sass +3 -0
  7. data/lib/rails/generators/sass/scaffold/scaffold_generator.rb +9 -0
  8. data/lib/rails/generators/sass_scaffold.rb +16 -0
  9. data/lib/rails/generators/scss/assets/assets_generator.rb +13 -0
  10. data/lib/rails/generators/scss/assets/templates/stylesheet.css.scss +3 -0
  11. data/lib/rails/generators/scss/scaffold/scaffold_generator.rb +10 -0
  12. data/lib/sass-rails.rb +1 -0
  13. data/lib/sass/rails.rb +12 -0
  14. data/lib/sass/rails/compressor.rb +15 -0
  15. data/lib/sass/rails/helpers.rb +38 -0
  16. data/lib/sass/rails/importer.rb +122 -0
  17. data/lib/sass/rails/logger.rb +21 -0
  18. data/lib/sass/rails/railtie.rb +74 -0
  19. data/lib/sass/rails/template_handlers.rb +86 -0
  20. data/lib/sass/rails/version.rb +5 -0
  21. data/sass-rails.gemspec +25 -0
  22. data/test/fixtures/engine_project/.gitignore +6 -0
  23. data/test/fixtures/engine_project/Gemfile +7 -0
  24. data/test/fixtures/engine_project/README.rdoc +3 -0
  25. data/test/fixtures/engine_project/Rakefile +39 -0
  26. data/test/fixtures/engine_project/app/assets/images/engine_project/.gitkeep +0 -0
  27. data/test/fixtures/engine_project/app/assets/javascripts/engine_project/application.js +9 -0
  28. data/test/fixtures/engine_project/app/assets/stylesheets/engine_project/application.css +7 -0
  29. data/test/fixtures/engine_project/app/controllers/engine_project/application_controller.rb +4 -0
  30. data/test/fixtures/engine_project/app/helpers/engine_project/application_helper.rb +4 -0
  31. data/test/fixtures/engine_project/app/views/layouts/engine_project/application.html.erb +14 -0
  32. data/test/fixtures/engine_project/config/routes.rb +2 -0
  33. data/test/fixtures/engine_project/lib/engine_project.rb +4 -0
  34. data/test/fixtures/engine_project/lib/engine_project/engine.rb +5 -0
  35. data/test/fixtures/engine_project/lib/engine_project/version.rb +3 -0
  36. data/test/fixtures/engine_project/lib/tasks/engine_project_tasks.rake +4 -0
  37. data/test/fixtures/engine_project/script/rails +6 -0
  38. data/test/fixtures/engine_project/test/dummy/Rakefile +7 -0
  39. data/test/fixtures/engine_project/test/dummy/app/assets/javascripts/application.js +9 -0
  40. data/test/fixtures/engine_project/test/dummy/app/assets/stylesheets/application.css +7 -0
  41. data/test/fixtures/engine_project/test/dummy/app/controllers/application_controller.rb +3 -0
  42. data/test/fixtures/engine_project/test/dummy/app/helpers/application_helper.rb +2 -0
  43. data/test/fixtures/engine_project/test/dummy/app/mailers/.gitkeep +0 -0
  44. data/test/fixtures/engine_project/test/dummy/app/models/.gitkeep +0 -0
  45. data/test/fixtures/engine_project/test/dummy/app/views/layouts/application.html.erb +14 -0
  46. data/test/fixtures/engine_project/test/dummy/config.ru +4 -0
  47. data/test/fixtures/engine_project/test/dummy/config/application.rb +42 -0
  48. data/test/fixtures/engine_project/test/dummy/config/boot.rb +10 -0
  49. data/test/fixtures/engine_project/test/dummy/config/database.yml +25 -0
  50. data/test/fixtures/engine_project/test/dummy/config/environment.rb +5 -0
  51. data/test/fixtures/engine_project/test/dummy/config/environments/development.rb +27 -0
  52. data/test/fixtures/engine_project/test/dummy/config/environments/production.rb +51 -0
  53. data/test/fixtures/engine_project/test/dummy/config/environments/test.rb +39 -0
  54. data/test/fixtures/engine_project/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  55. data/test/fixtures/engine_project/test/dummy/config/initializers/inflections.rb +10 -0
  56. data/test/fixtures/engine_project/test/dummy/config/initializers/mime_types.rb +5 -0
  57. data/test/fixtures/engine_project/test/dummy/config/initializers/secret_token.rb +7 -0
  58. data/test/fixtures/engine_project/test/dummy/config/initializers/session_store.rb +8 -0
  59. data/test/fixtures/engine_project/test/dummy/config/initializers/wrap_parameters.rb +12 -0
  60. data/test/fixtures/engine_project/test/dummy/config/locales/en.yml +5 -0
  61. data/test/fixtures/engine_project/test/dummy/config/routes.rb +4 -0
  62. data/test/fixtures/engine_project/test/dummy/lib/assets/.gitkeep +0 -0
  63. data/test/fixtures/engine_project/test/dummy/log/.gitkeep +0 -0
  64. data/test/fixtures/engine_project/test/dummy/public/404.html +26 -0
  65. data/test/fixtures/engine_project/test/dummy/public/422.html +26 -0
  66. data/test/fixtures/engine_project/test/dummy/public/500.html +26 -0
  67. data/test/fixtures/engine_project/test/dummy/public/favicon.ico +0 -0
  68. data/test/fixtures/engine_project/test/dummy/script/rails +6 -0
  69. data/test/fixtures/sass_project/.gitignore +5 -0
  70. data/test/fixtures/sass_project/Gemfile +7 -0
  71. data/test/fixtures/sass_project/README +261 -0
  72. data/test/fixtures/sass_project/Rakefile +7 -0
  73. data/test/fixtures/sass_project/app/assets/images/rails.png +0 -0
  74. data/test/fixtures/sass_project/app/assets/javascripts/application.js +9 -0
  75. data/test/fixtures/sass_project/app/assets/stylesheets/application.css +7 -0
  76. data/test/fixtures/sass_project/app/controllers/application_controller.rb +3 -0
  77. data/test/fixtures/sass_project/app/helpers/application_helper.rb +2 -0
  78. data/test/fixtures/sass_project/app/mailers/.gitkeep +0 -0
  79. data/test/fixtures/sass_project/app/models/.gitkeep +0 -0
  80. data/test/fixtures/sass_project/app/views/layouts/application.html.erb +14 -0
  81. data/test/fixtures/sass_project/config.ru +4 -0
  82. data/test/fixtures/sass_project/config/application.rb +52 -0
  83. data/test/fixtures/sass_project/config/boot.rb +6 -0
  84. data/test/fixtures/sass_project/config/database.yml +25 -0
  85. data/test/fixtures/sass_project/config/environment.rb +5 -0
  86. data/test/fixtures/sass_project/config/environments/development.rb +27 -0
  87. data/test/fixtures/sass_project/config/environments/production.rb +54 -0
  88. data/test/fixtures/sass_project/config/environments/test.rb +39 -0
  89. data/test/fixtures/sass_project/config/initializers/backtrace_silencers.rb +7 -0
  90. data/test/fixtures/sass_project/config/initializers/inflections.rb +10 -0
  91. data/test/fixtures/sass_project/config/initializers/mime_types.rb +5 -0
  92. data/test/fixtures/sass_project/config/initializers/secret_token.rb +7 -0
  93. data/test/fixtures/sass_project/config/initializers/session_store.rb +8 -0
  94. data/test/fixtures/sass_project/config/initializers/wrap_parameters.rb +12 -0
  95. data/test/fixtures/sass_project/config/locales/en.yml +5 -0
  96. data/test/fixtures/sass_project/config/routes.rb +58 -0
  97. data/test/fixtures/sass_project/db/seeds.rb +7 -0
  98. data/test/fixtures/sass_project/doc/README_FOR_APP +2 -0
  99. data/test/fixtures/sass_project/lib/tasks/.gitkeep +0 -0
  100. data/test/fixtures/sass_project/log/.gitkeep +0 -0
  101. data/test/fixtures/sass_project/public/404.html +26 -0
  102. data/test/fixtures/sass_project/public/422.html +26 -0
  103. data/test/fixtures/sass_project/public/500.html +26 -0
  104. data/test/fixtures/sass_project/public/favicon.ico +0 -0
  105. data/test/fixtures/sass_project/public/index.html +241 -0
  106. data/test/fixtures/sass_project/public/robots.txt +5 -0
  107. data/test/fixtures/sass_project/script/rails +6 -0
  108. data/test/fixtures/sass_project/vendor/assets/stylesheets/.gitkeep +0 -0
  109. data/test/fixtures/sass_project/vendor/plugins/.gitkeep +0 -0
  110. data/test/fixtures/scss_project/.gitignore +5 -0
  111. data/test/fixtures/scss_project/Gemfile +7 -0
  112. data/test/fixtures/scss_project/README +261 -0
  113. data/test/fixtures/scss_project/Rakefile +7 -0
  114. data/test/fixtures/scss_project/app/assets/images/rails.png +0 -0
  115. data/test/fixtures/scss_project/app/assets/javascripts/application.js +9 -0
  116. data/test/fixtures/scss_project/app/assets/stylesheets/_top_level_partial.css.scss +3 -0
  117. data/test/fixtures/scss_project/app/assets/stylesheets/application.css.scss +19 -0
  118. data/test/fixtures/scss_project/app/assets/stylesheets/css_application.css +7 -0
  119. data/test/fixtures/scss_project/app/assets/stylesheets/globbed/globbed.css.scss +3 -0
  120. data/test/fixtures/scss_project/app/assets/stylesheets/globbed/nested/nested_glob.css.scss +3 -0
  121. data/test/fixtures/scss_project/app/assets/stylesheets/partials/_sass_import.css.sass +5 -0
  122. data/test/fixtures/scss_project/app/assets/stylesheets/partials/_scss_import.css.scss +9 -0
  123. data/test/fixtures/scss_project/app/assets/stylesheets/partials/_without_css_ext.scss +3 -0
  124. data/test/fixtures/scss_project/app/assets/stylesheets/partials/subfolder/_relative_sass.css.sass +2 -0
  125. data/test/fixtures/scss_project/app/assets/stylesheets/partials/subfolder/_relative_scss.css.scss +3 -0
  126. data/test/fixtures/scss_project/app/assets/stylesheets/partials/subfolder/relative_not_a_partial.css.scss +3 -0
  127. data/test/fixtures/scss_project/app/assets/stylesheets/subfolder/another_plain.css +3 -0
  128. data/test/fixtures/scss_project/app/assets/stylesheets/subfolder/plain.css +3 -0
  129. data/test/fixtures/scss_project/app/assets/stylesheets/subfolder/second_level.css.scss +1 -0
  130. data/test/fixtures/scss_project/app/controllers/application_controller.rb +3 -0
  131. data/test/fixtures/scss_project/app/helpers/application_helper.rb +2 -0
  132. data/test/fixtures/scss_project/app/mailers/.gitkeep +0 -0
  133. data/test/fixtures/scss_project/app/models/.gitkeep +0 -0
  134. data/test/fixtures/scss_project/app/views/layouts/application.html.erb +14 -0
  135. data/test/fixtures/scss_project/config.ru +4 -0
  136. data/test/fixtures/scss_project/config/application.rb +49 -0
  137. data/test/fixtures/scss_project/config/boot.rb +6 -0
  138. data/test/fixtures/scss_project/config/database.yml +25 -0
  139. data/test/fixtures/scss_project/config/environment.rb +5 -0
  140. data/test/fixtures/scss_project/config/environments/development.rb +27 -0
  141. data/test/fixtures/scss_project/config/environments/production.rb +54 -0
  142. data/test/fixtures/scss_project/config/environments/test.rb +39 -0
  143. data/test/fixtures/scss_project/config/initializers/backtrace_silencers.rb +7 -0
  144. data/test/fixtures/scss_project/config/initializers/inflections.rb +10 -0
  145. data/test/fixtures/scss_project/config/initializers/mime_types.rb +5 -0
  146. data/test/fixtures/scss_project/config/initializers/secret_token.rb +7 -0
  147. data/test/fixtures/scss_project/config/initializers/session_store.rb +8 -0
  148. data/test/fixtures/scss_project/config/initializers/wrap_parameters.rb +12 -0
  149. data/test/fixtures/scss_project/config/locales/en.yml +5 -0
  150. data/test/fixtures/scss_project/config/routes.rb +58 -0
  151. data/test/fixtures/scss_project/db/seeds.rb +7 -0
  152. data/test/fixtures/scss_project/doc/README_FOR_APP +2 -0
  153. data/test/fixtures/scss_project/lib/tasks/.gitkeep +0 -0
  154. data/test/fixtures/scss_project/log/.gitkeep +0 -0
  155. data/test/fixtures/scss_project/public/404.html +26 -0
  156. data/test/fixtures/scss_project/public/422.html +26 -0
  157. data/test/fixtures/scss_project/public/500.html +26 -0
  158. data/test/fixtures/scss_project/public/favicon.ico +0 -0
  159. data/test/fixtures/scss_project/public/index.html +241 -0
  160. data/test/fixtures/scss_project/public/robots.txt +5 -0
  161. data/test/fixtures/scss_project/script/rails +6 -0
  162. data/test/fixtures/scss_project/vendor/assets/stylesheets/.gitkeep +0 -0
  163. data/test/fixtures/scss_project/vendor/plugins/.gitkeep +0 -0
  164. data/test/sass_rails_logger_test.rb +26 -0
  165. data/test/sass_rails_test.rb +88 -0
  166. data/test/support/sass_rails_test_case.rb +151 -0
  167. data/test/test_helper.rb +28 -0
  168. metadata +427 -0
@@ -0,0 +1,51 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # Code is not reloaded between requests
5
+ config.cache_classes = true
6
+
7
+ # Full error reports are disabled and caching is turned on
8
+ config.consider_all_requests_local = false
9
+ config.action_controller.perform_caching = true
10
+
11
+ # Disable Rails's static asset server (Apache or nginx will already do this)
12
+ config.serve_static_assets = false
13
+
14
+ # Compress JavaScripts and CSS
15
+ config.assets.compress = true
16
+
17
+ # Specifies the header that your server uses for sending files
18
+ # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
19
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
20
+
21
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
22
+ # config.force_ssl = true
23
+
24
+ # See everything in the log (default is :info)
25
+ # config.log_level = :debug
26
+
27
+ # Use a different logger for distributed setups
28
+ # config.logger = SyslogLogger.new
29
+
30
+ # Use a different cache store in production
31
+ # config.cache_store = :mem_cache_store
32
+
33
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server
34
+ # config.action_controller.asset_host = "http://assets.example.com"
35
+
36
+ # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
37
+ # config.assets.precompile += %w( search.js )
38
+
39
+ # Disable delivery errors, bad email addresses will be ignored
40
+ # config.action_mailer.raise_delivery_errors = false
41
+
42
+ # Enable threaded mode
43
+ # config.threadsafe!
44
+
45
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
46
+ # the I18n.default_locale when a translation can not be found)
47
+ config.i18n.fallbacks = true
48
+
49
+ # Send deprecation notices to registered listeners
50
+ config.active_support.deprecation = :notify
51
+ end
@@ -0,0 +1,39 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # The test environment is used exclusively to run your application's
5
+ # test suite. You never need to work with it otherwise. Remember that
6
+ # your test database is "scratch space" for the test suite and is wiped
7
+ # and recreated between test runs. Don't rely on the data there!
8
+ config.cache_classes = true
9
+
10
+ # Configure static asset server for tests with Cache-Control for performance
11
+ config.serve_static_assets = true
12
+ config.static_cache_control = "public, max-age=3600"
13
+
14
+ # Log error messages when you accidentally call methods on nil
15
+ config.whiny_nils = true
16
+
17
+ # Show full error reports and disable caching
18
+ config.consider_all_requests_local = true
19
+ config.action_controller.perform_caching = false
20
+
21
+ # Raise exceptions instead of rendering exception templates
22
+ config.action_dispatch.show_exceptions = false
23
+
24
+ # Disable request forgery protection in test environment
25
+ config.action_controller.allow_forgery_protection = false
26
+
27
+ # Tell Action Mailer not to deliver emails to the real world.
28
+ # The :test delivery method accumulates sent emails in the
29
+ # ActionMailer::Base.deliveries array.
30
+ config.action_mailer.delivery_method = :test
31
+
32
+ # Use SQL instead of Active Record's schema dumper when creating the test database.
33
+ # This is necessary if your schema can't be completely dumped by the schema dumper,
34
+ # like if you have constraints or database-specific column types
35
+ # config.active_record.schema_format = :sql
36
+
37
+ # Print deprecation notices to the stderr
38
+ config.active_support.deprecation = :stderr
39
+ end
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5
+
6
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7
+ # Rails.backtrace_cleaner.remove_silencers!
@@ -0,0 +1,10 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format
4
+ # (all these examples are active by default):
5
+ # ActiveSupport::Inflector.inflections do |inflect|
6
+ # inflect.plural /^(ox)$/i, '\1en'
7
+ # inflect.singular /^(ox)en/i, '\1'
8
+ # inflect.irregular 'person', 'people'
9
+ # inflect.uncountable %w( fish sheep )
10
+ # end
@@ -0,0 +1,5 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
5
+ # Mime::Type.register_alias "text/html", :iphone
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+ # Make sure the secret is at least 30 characters and all random,
6
+ # no regular words or you'll be exposed to dictionary attacks.
7
+ Dummy::Application.config.secret_token = 'd6e88517fac324a6d3fa410aa3a90b74b625b0805b4a56377f183909840ec2e55cc7d14e3a6d422fc33e10d25aa658d2a340dd344126b6e8a7321a3e43e688e4'
@@ -0,0 +1,8 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
4
+
5
+ # Use the database for sessions instead of the cookie-based default,
6
+ # which shouldn't be used to store highly confidential information
7
+ # (create the session table with "rails generate session_migration")
8
+ # Dummy::Application.config.session_store :active_record_store
@@ -0,0 +1,12 @@
1
+ # Be sure to restart your server when you modify this file.
2
+ #
3
+ # This file contains settings for ActionController::ParamsWrapper which
4
+ # is enabled by default.
5
+
6
+ # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
7
+ ActionController::Base.wrap_parameters :format => [:json]
8
+
9
+ # Disable root element in JSON by default.
10
+ if defined?(ActiveRecord)
11
+ ActiveRecord::Base.include_root_in_json = false
12
+ end
@@ -0,0 +1,5 @@
1
+ # Sample localization file for English. Add more files in this directory for other locales.
2
+ # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
3
+
4
+ en:
5
+ hello: "Hello world"
@@ -0,0 +1,4 @@
1
+ Rails.application.routes.draw do
2
+
3
+ mount EngineProject::Engine => "/engine_project"
4
+ end
@@ -0,0 +1,26 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <style type="text/css">
6
+ body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
7
+ div.dialog {
8
+ width: 25em;
9
+ padding: 0 4em;
10
+ margin: 4em auto 0 auto;
11
+ border: 1px solid #ccc;
12
+ border-right-color: #999;
13
+ border-bottom-color: #999;
14
+ }
15
+ h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <!-- This file lives in public/404.html -->
21
+ <div class="dialog">
22
+ <h1>The page you were looking for doesn't exist.</h1>
23
+ <p>You may have mistyped the address or the page may have moved.</p>
24
+ </div>
25
+ </body>
26
+ </html>
@@ -0,0 +1,26 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <style type="text/css">
6
+ body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
7
+ div.dialog {
8
+ width: 25em;
9
+ padding: 0 4em;
10
+ margin: 4em auto 0 auto;
11
+ border: 1px solid #ccc;
12
+ border-right-color: #999;
13
+ border-bottom-color: #999;
14
+ }
15
+ h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <!-- This file lives in public/422.html -->
21
+ <div class="dialog">
22
+ <h1>The change you wanted was rejected.</h1>
23
+ <p>Maybe you tried to change something you didn't have access to.</p>
24
+ </div>
25
+ </body>
26
+ </html>
@@ -0,0 +1,26 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>We're sorry, but something went wrong (500)</title>
5
+ <style type="text/css">
6
+ body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
7
+ div.dialog {
8
+ width: 25em;
9
+ padding: 0 4em;
10
+ margin: 4em auto 0 auto;
11
+ border: 1px solid #ccc;
12
+ border-right-color: #999;
13
+ border-bottom-color: #999;
14
+ }
15
+ h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <!-- This file lives in public/500.html -->
21
+ <div class="dialog">
22
+ <h1>We're sorry, but something went wrong.</h1>
23
+ <p>We've been notified about this issue and we'll take a look at it shortly.</p>
24
+ </div>
25
+ </body>
26
+ </html>
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
3
+
4
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
5
+ require File.expand_path('../../config/boot', __FILE__)
6
+ require 'rails/commands'
@@ -0,0 +1,5 @@
1
+ .bundle
2
+ db/*.sqlite3
3
+ log/*.log
4
+ tmp/
5
+ .sass-cache/
@@ -0,0 +1,7 @@
1
+ source 'http://rubygems.org'
2
+
3
+ gem 'rails', "~> 3.1.0.rc4"
4
+ gem 'sqlite3'
5
+
6
+ # Asset template engines
7
+ gem 'sass-rails'
@@ -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.