css_splitter_opp_fork 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +99 -0
  4. data/Rakefile +40 -0
  5. data/app/helpers/css_splitter/application_helper.rb +20 -0
  6. data/config/routes.rb +2 -0
  7. data/lib/css_splitter/engine.rb +15 -0
  8. data/lib/css_splitter/splitter.rb +112 -0
  9. data/lib/css_splitter/sprockets_engine.rb +23 -0
  10. data/lib/css_splitter/version.rb +3 -0
  11. data/lib/css_splitter.rb +6 -0
  12. data/lib/tasks/css_splitter_tasks.rake +4 -0
  13. data/test/css_splitter_test.rb +41 -0
  14. data/test/dummy/README.rdoc +261 -0
  15. data/test/dummy/Rakefile +7 -0
  16. data/test/dummy/app/assets/stylesheets/application.css +16 -0
  17. data/test/dummy/app/assets/stylesheets/combined.css.scss +4 -0
  18. data/test/dummy/app/assets/stylesheets/combined_split2.css +3 -0
  19. data/test/dummy/app/assets/stylesheets/erb_stylesheet.css.scss.erb +7 -0
  20. data/test/dummy/app/assets/stylesheets/erb_stylesheet_split2.css +3 -0
  21. data/test/dummy/app/assets/stylesheets/erb_stylesheet_split3.css +3 -0
  22. data/test/dummy/app/assets/stylesheets/green_max.css.scss.erb +3 -0
  23. data/test/dummy/app/assets/stylesheets/red_100.css.scss.erb +3 -0
  24. data/test/dummy/app/assets/stylesheets/test_stylesheet_with_media_queries.css +19145 -0
  25. data/test/dummy/app/assets/stylesheets/test_stylesheet_with_media_queries_split2.css +3 -0
  26. data/test/dummy/app/assets/stylesheets/too_big_stylesheet.css.scss +4100 -0
  27. data/test/dummy/app/assets/stylesheets/too_big_stylesheet_split2.css +3 -0
  28. data/test/dummy/app/controllers/application_controller.rb +3 -0
  29. data/test/dummy/app/controllers/tests_controller.rb +4 -0
  30. data/test/dummy/app/views/layouts/application.html.erb +17 -0
  31. data/test/dummy/app/views/tests/test.html.erb +12 -0
  32. data/test/dummy/config/application.rb +64 -0
  33. data/test/dummy/config/boot.rb +10 -0
  34. data/test/dummy/config/database.yml +25 -0
  35. data/test/dummy/config/environment.rb +5 -0
  36. data/test/dummy/config/environments/development.rb +39 -0
  37. data/test/dummy/config/environments/production.rb +69 -0
  38. data/test/dummy/config/environments/test.rb +39 -0
  39. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  40. data/test/dummy/config/initializers/inflections.rb +15 -0
  41. data/test/dummy/config/initializers/mime_types.rb +5 -0
  42. data/test/dummy/config/initializers/secret_token.rb +7 -0
  43. data/test/dummy/config/initializers/session_store.rb +8 -0
  44. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  45. data/test/dummy/config/locales/en.yml +5 -0
  46. data/test/dummy/config/routes.rb +5 -0
  47. data/test/dummy/config.ru +4 -0
  48. data/test/dummy/public/404.html +26 -0
  49. data/test/dummy/public/422.html +26 -0
  50. data/test/dummy/public/500.html +25 -0
  51. data/test/dummy/public/favicon.ico +0 -0
  52. data/test/dummy/script/rails +6 -0
  53. data/test/integration/navigation_test.rb +10 -0
  54. data/test/test_helper.rb +15 -0
  55. data/test/unit/helpers/css_splitter/application_helper_test.rb +22 -0
  56. data/test/unit/splitter_test.rb +192 -0
  57. data/test/unit/too_many_selectors.css +12986 -0
  58. metadata +176 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: e9c9cad4f4c39dbd84c3c949fcedc07387a36033
4
+ data.tar.gz: 01c18622b7d0d903832e7a1a10f1dbc91cfaa43b
5
+ SHA512:
6
+ metadata.gz: 49290d5f9264cb894070f596728f7b866f65de901e27cdaca687f4fa3a5aa7bd1e46fde82e5021e8b87fb46dde505d73ae02137c6b07d51566004b1038688d98
7
+ data.tar.gz: 5ef707a46b7f13c1ca47d7940c91d8525683d19e525464663efd58fd14a47930b1ae31dab845899148c35ff17231a0bde5f28b6f99a021d425ce503354606a7a
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2012 Jakob Hilden
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.md ADDED
@@ -0,0 +1,99 @@
1
+ # CssSplitter [![Build Status](https://travis-ci.org/zweilove/css_splitter.png?branch=master)](https://travis-ci.org/zweilove/css_splitter)
2
+
3
+ Gem for splitting up stylesheets that go beyond the IE limit of 4096 selectors, for Rails 3.1+ apps using the Asset Pipeline. You can read this [blogpost](http://railslove.com/blog/2013/03/08/overcoming-ies-4096-selector-limit-using-the-css-splitter-gem) for an explanation of this gem's background story.
4
+
5
+
6
+ ## Installation
7
+
8
+ Install by putting `gem 'css_splitter'` into your Gemfile.
9
+
10
+ ## What it does?
11
+
12
+ Older versions of Internet Explorer (version 9 and below) have a hard limit for the number of CSS selectors they can process, which is 4095. If one of your stylesheets exceeds this limit, all the rule sets beyond the 4095th selector will not be processed by IE and your app will miss some styling information.
13
+
14
+ CssSplitter integrates with the Rails 3.1+ Asset Pipeline to generate additional split stylesheets with all the CSS rules beyond the 4095th that can be served to IE browsers in order to get all the styling information.
15
+
16
+
17
+ ## Dependencies
18
+
19
+ * Sprockets 2.0+
20
+ * e.g. Rails 3.1+ with the asset pipeline
21
+
22
+ ## Documentation
23
+
24
+ ### 1. Splitting your stylesheets
25
+
26
+ The first step is identifying the stylesheets that have more than 4095 selectors and therefore need to be split for IE.
27
+
28
+ Once you know which stylesheets need to be split, you need to create a second "container file" for those stylesheets with the `_split2` suffix appended to the base filename that will contain the styles beyond the 4095 selector limit. The extension of this file should be just `.css` without any additional preprocessor extensions.
29
+
30
+ For example, if you want to split `too_big_stylesheet.css.scss`, you need to create a new file `too_big_stylesheet_split2.css` in the same directory. The only content of that container, will contain a `require` directive to the name of the original asset, e.g.:
31
+
32
+ # app/assets/stylesheets/too_big_stylesheet_split2.css
33
+
34
+ /*
35
+ *= require 'too_big_stylesheet'
36
+ */
37
+
38
+ If your stylesheet is big enough to need splitting into more than two more files, simply create additional `_split3`, `_split4`, etc. files, the contents of which should be identical to the `_split2` file.
39
+
40
+ You also need to remember to add those new files to the asset pipeline, so they will be compiled. For example:
41
+
42
+ # config/application.rb
43
+
44
+ module MyApp
45
+ class Application < Rails::Application
46
+ config.assets.precompile += %w( too_big_stylesheet_split2.css )
47
+
48
+ Here is a checklist of requirements for your split stylesheet:
49
+
50
+ 1. It needs to have the `_splitN` suffix appended to the original asset name, e.g. `original_stylesheet_split2` or `application_split2`
51
+ 2. It needs to have `.css` as a file extension.
52
+ 3. It needs to require the orginal stylesheet.
53
+ 4. It needs to be added to list of precompiled assets.
54
+
55
+ ### 2. Including your split stylesheets
56
+
57
+ Now that you have split up your big stylesheets at the 4095 limit you need to change your HTML layout, so the split stylesheets are used for older IE versions (IE9 and older).
58
+
59
+ You can just use our `split_stylesheet_link_tag` helper, which would look something like this:
60
+
61
+ # app/views/layout/application.html.erb
62
+ <%= split_stylesheet_link_tag "too_big_stylesheet", :media => "all" %>
63
+
64
+ # output
65
+ <link href="/stylesheets/too_big_stylesheet.css" media="all" rel="stylesheet" type="text/css" />
66
+ <!--[if lte IE 9]>
67
+ <link href="/stylesheets/too_big_stylesheet_split2.css" media="all" rel="stylesheet" type="text/css" />
68
+ <![endif]-->
69
+
70
+ If your stylesheet is split into more than two files, add the `split_count` option to specify the total number of files.
71
+
72
+ <%= split_stylesheet_link_tag "too_big_stylesheet", :split_count => 3 %>
73
+
74
+ Or you can just create similar HTML as in the above example yourself. If you want to use the `split_stylesheet_link_tag` helper you need to make sure the gem is loaded in production, so you can't put it in the `:assets` group in your Gemfile.
75
+
76
+ ## How it works
77
+
78
+ Basically, CssSplitter is registering a new Sprockets bundle processor that looks for CSS assets named with the `_splitN` suffix and will fill those files with all the selectors beyond the 4095th. Unfortunately, those `_splitN` files need to be created manually, because we haven't figured out a way for a `Sprockets::Engine` to output multiple files. They need to present before the compile step.
79
+
80
+ If you have more questions about how it works, look at the code or contact us.
81
+
82
+ ## Gotchas
83
+
84
+ #### Differences from previous versions
85
+
86
+ Note that if you used versions below `0.4.0` of this gem, the naming and contents of the split files have changed. Split files no longer need to have the `.split2` extension and now use the `require` directive rather than the `include` directive. The previous prohibition against using `require_tree .` and `require_self` directives also no longer applies. For more details see the [CHANGELOG.md](CHANGELOG.md#040)
87
+
88
+ ## Credits & License
89
+
90
+ This is a joint project by the two German Rails shops [Zweitag](http://zweitag.de) and [Railslove](http://railslove.com), therefore the GitHub name "Zweilove".
91
+
92
+ The original code was written by [Christian Peters](mailto:christian.peters@zweitag.de) and [Thomas Hollstegge](mailto:thomas.hollstegge@zweitag.de) (see this [Gist](https://gist.github.com/2398394)) and turned into a gem by [Jakob Hilden](mailto:jakobhilden@gmail.com).
93
+
94
+ **Major Contributors**
95
+
96
+ * [@Umofomia](https://github.com/Umofomia)
97
+
98
+ This project rocks and uses MIT-LICENSE.
99
+
data/Rakefile ADDED
@@ -0,0 +1,40 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+ begin
8
+ require 'rdoc/task'
9
+ rescue LoadError
10
+ require 'rdoc/rdoc'
11
+ require 'rake/rdoctask'
12
+ RDoc::Task = Rake::RDocTask
13
+ end
14
+
15
+ RDoc::Task.new(:rdoc) do |rdoc|
16
+ rdoc.rdoc_dir = 'rdoc'
17
+ rdoc.title = 'CssSplitter'
18
+ rdoc.options << '--line-numbers'
19
+ rdoc.rdoc_files.include('README.rdoc')
20
+ rdoc.rdoc_files.include('lib/**/*.rb')
21
+ end
22
+
23
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
24
+ load 'rails/tasks/engine.rake'
25
+
26
+
27
+
28
+ Bundler::GemHelper.install_tasks
29
+
30
+ require 'rake/testtask'
31
+
32
+ Rake::TestTask.new(:test) do |t|
33
+ t.libs << 'lib'
34
+ t.libs << 'test'
35
+ t.pattern = 'test/**/*_test.rb'
36
+ t.verbose = false
37
+ end
38
+
39
+
40
+ task :default => :test
@@ -0,0 +1,20 @@
1
+ module CssSplitter
2
+ module ApplicationHelper
3
+ def split_stylesheet_link_tag(*sources)
4
+ options = sources.extract_options!
5
+ split_count = options.delete(:split_count) || 2
6
+
7
+ sources.map do |source|
8
+ split_sources = (2..split_count).map { |index| "#{source}_split#{index}" }
9
+ split_sources << options
10
+
11
+ [
12
+ stylesheet_link_tag(source, options),
13
+ "<!--[if lte IE 9]>",
14
+ stylesheet_link_tag(*split_sources),
15
+ "<![endif]-->"
16
+ ]
17
+ end.flatten.join("\n").html_safe
18
+ end
19
+ end
20
+ end
data/config/routes.rb ADDED
@@ -0,0 +1,2 @@
1
+ CssSplitter::Engine.routes.draw do
2
+ end
@@ -0,0 +1,15 @@
1
+ module CssSplitter
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace CssSplitter
4
+
5
+ initializer 'css_splitter.sprockets_engine', after: 'sprockets.environment', group: :all do |app|
6
+ app.assets.register_bundle_processor 'text/css', CssSplitter::SprocketsEngine
7
+ end
8
+
9
+ initializer 'css_splitter.action_controller' do |app|
10
+ ActiveSupport.on_load :action_controller do
11
+ helper CssSplitter::ApplicationHelper
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,112 @@
1
+ module CssSplitter
2
+
3
+ class Splitter
4
+
5
+ MAX_SELECTORS_DEFAULT = 4095
6
+
7
+ # returns the specified split of the passed css_string
8
+ def self.split_string(css_string, split = 1, max_selectors = MAX_SELECTORS_DEFAULT)
9
+ rules = split_string_into_rules(css_string)
10
+ extract_part rules, split, max_selectors
11
+ end
12
+
13
+ # splits string into array of rules (also strips comments)
14
+ def self.split_string_into_rules(css_string)
15
+ strip_comments(css_string).chomp.scan /[^}]*}/
16
+ end
17
+
18
+ # extracts the specified part of an overlong CSS string
19
+ def self.extract_part(rules, part = 1, max_selectors = MAX_SELECTORS_DEFAULT)
20
+ return if rules.first.nil?
21
+
22
+ charset_statement, rules[0] = extract_charset(rules.first)
23
+ return if rules.nil?
24
+
25
+ output = charset_statement || ""
26
+ selectors_count = 0
27
+ selector_range = max_selectors * (part - 1) + 1 .. max_selectors * part # e.g (4096..8190)
28
+
29
+ current_media = nil
30
+ selectors_in_media = 0
31
+ first_hit = true
32
+ rules.each do |rule|
33
+ media_part = extract_media(rule)
34
+ if media_part
35
+ current_media = media_part
36
+ selectors_in_media = 0
37
+ end
38
+
39
+ rule_selectors_count = count_selectors_of_rule rule
40
+ selectors_count += rule_selectors_count
41
+
42
+ if rule =~ /\A\s*}\z$/
43
+ current_media = nil
44
+ # skip the line if the close bracket is the first rule for the new file
45
+ next if first_hit
46
+ end
47
+
48
+ if selector_range.cover? selectors_count # add rule to current output if within selector_range
49
+ if media_part
50
+ output << media_part
51
+ elsif first_hit && current_media
52
+ output << current_media
53
+ end
54
+ selectors_in_media += rule_selectors_count if current_media.present?
55
+ output << rule
56
+ first_hit = false
57
+ elsif selectors_count > selector_range.end # stop writing to output
58
+ break
59
+ end
60
+ end
61
+
62
+ if current_media.present? and selectors_in_media > 0
63
+ output << '}'
64
+ end
65
+
66
+ output
67
+ end
68
+
69
+ # count selectors of one individual CSS rule
70
+ def self.count_selectors_of_rule(rule)
71
+ parts = strip_comments(rule).partition(/\{/)
72
+ parts.second.empty? ? 0 : parts.first.scan(/,/).count.to_i + 1
73
+ end
74
+
75
+
76
+
77
+ # count selectors of a CSS stylesheet (not used by SprocketsEngine)
78
+ def self.count_selectors(css_file)
79
+ raise "file could not be found" unless File.exists? css_file
80
+
81
+ rules = split_string_into_rules(File.read css_file)
82
+ return if rules.first.nil?
83
+
84
+ rules.sum{ |rule| count_selectors_of_rule(rule) }
85
+ end
86
+
87
+
88
+
89
+ private
90
+
91
+ def self.extract_media(rule)
92
+ if rule.sub!(/^\s*(@media[^{]*{)([^{}]*{[^}]*})$/) { $2 }
93
+ $1
94
+ end
95
+ end
96
+
97
+ # extracts potential charset declaration from the first rule
98
+ def self.extract_charset(rule)
99
+ if rule.include?('charset')
100
+ rule.partition(/^\@charset[^;]+;/)[1,2]
101
+ else
102
+ [nil, rule]
103
+ end
104
+ end
105
+
106
+ def self.strip_comments(s)
107
+ s.gsub(/\/\*.*?\*\//m, "")
108
+ end
109
+
110
+ end
111
+
112
+ end
@@ -0,0 +1,23 @@
1
+ require 'tilt'
2
+
3
+ module CssSplitter
4
+
5
+ class SprocketsEngine < Tilt::Template
6
+ def self.engine_initialized?
7
+ true
8
+ end
9
+
10
+ def prepare
11
+ end
12
+
13
+ def evaluate(scope, locals, &block)
14
+ # Evaluate the split if the asset is named with a trailing _split2, _split3, etc.
15
+ if scope.logical_path =~ /_split(\d+)$/
16
+ CssSplitter::Splitter.split_string(data, $1.to_i)
17
+ else
18
+ data
19
+ end
20
+ end
21
+ end
22
+
23
+ end
@@ -0,0 +1,3 @@
1
+ module CssSplitter
2
+ VERSION = "0.4.0"
3
+ end
@@ -0,0 +1,6 @@
1
+ require "css_splitter/engine" if defined?(Rails)
2
+ require "css_splitter/sprockets_engine"
3
+ require "css_splitter/splitter"
4
+
5
+ module CssSplitter
6
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :css_splitter do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,41 @@
1
+ require 'test_helper'
2
+
3
+ class CssSplitterTest < ActiveSupport::TestCase
4
+
5
+ setup :clear_assets_cache
6
+
7
+ test "truth" do
8
+ assert_kind_of Module, CssSplitter
9
+ end
10
+
11
+ test "asset pipeline stylesheet splitting" do
12
+ part1 = "#test{background-color:red}" * CssSplitter::Splitter::MAX_SELECTORS_DEFAULT
13
+ part2 = "#test{background-color:green}" * CssSplitter::Splitter::MAX_SELECTORS_DEFAULT
14
+ part3 = "#test{background-color:blue}"
15
+
16
+ assert_equal "#{part1}#{part2}#{part3}\n", assets["erb_stylesheet"].to_s
17
+ assert_equal "#{part2}\n", assets["erb_stylesheet_split2"].to_s
18
+ assert_equal "#{part3}\n", assets["erb_stylesheet_split3"].to_s
19
+ end
20
+
21
+ test "asset pipeline stylesheet splitting on stylesheet combined using requires" do
22
+ red = "#test{background-color:red}" * 100
23
+ green = "#test{background-color:green}" * CssSplitter::Splitter::MAX_SELECTORS_DEFAULT
24
+ blue = "#test{background-color:blue}"
25
+
26
+ assert_equal "#{red}#{green}#{blue}\n", assets["combined"].to_s
27
+ assert_equal "#{"#test{background-color:green}" * 100}#{blue}\n", assets["combined_split2"].to_s
28
+ end
29
+
30
+ private
31
+
32
+ def clear_assets_cache
33
+ assets_cache = Rails.root.join("tmp/cache/assets")
34
+ assets_cache.rmtree if assets_cache.exist?
35
+ end
36
+
37
+ def assets
38
+ Rails.application.assets
39
+ end
40
+
41
+ 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.
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env rake
2
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
3
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
4
+
5
+ require File.expand_path('../config/application', __FILE__)
6
+
7
+ Dummy::Application.load_tasks