smurfville 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.md +66 -0
  3. data/Rakefile +46 -0
  4. data/app/assets/images/smurfville/smurf.png +0 -0
  5. data/app/assets/javascripts/smurfville/application.js +1 -0
  6. data/app/assets/stylesheets/smurfville/application.css.sass +38 -0
  7. data/app/assets/stylesheets/smurfville/typography.css.sass.erb +0 -0
  8. data/app/controllers/smurf/application_controller.rb +4 -0
  9. data/app/controllers/smurf/styleguide_controller.rb +19 -0
  10. data/app/helpers/smurfville/application_helper.rb +4 -0
  11. data/app/helpers/smurfville/styleguide_helper.rb +14 -0
  12. data/app/views/layouts/smurf/application.html.erb +14 -0
  13. data/app/views/smurfville/styleguide/_color_var.html.haml +11 -0
  14. data/app/views/smurfville/styleguide/colors.html.haml +10 -0
  15. data/app/views/smurfville/styleguide/typography.html.haml +6 -0
  16. data/config/routes.rb +6 -0
  17. data/lib/smurfville/color_variable_parser.rb +71 -0
  18. data/lib/smurfville/engine.rb +5 -0
  19. data/lib/smurfville/typography_parser.rb +28 -0
  20. data/lib/smurfville/version.rb +3 -0
  21. data/lib/smurfville.rb +7 -0
  22. data/lib/tasks/smurfville_tasks.rake +4 -0
  23. data/test/dummy/README.rdoc +261 -0
  24. data/test/dummy/Rakefile +7 -0
  25. data/test/dummy/app/assets/javascripts/application.js +15 -0
  26. data/test/dummy/app/assets/stylesheets/_typography.sass +37 -0
  27. data/test/dummy/app/assets/stylesheets/application.css.sass +11 -0
  28. data/test/dummy/app/controllers/application_controller.rb +3 -0
  29. data/test/dummy/app/helpers/application_helper.rb +2 -0
  30. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  31. data/test/dummy/config/application.rb +61 -0
  32. data/test/dummy/config/boot.rb +10 -0
  33. data/test/dummy/config/database.yml +25 -0
  34. data/test/dummy/config/environment.rb +5 -0
  35. data/test/dummy/config/environments/development.rb +37 -0
  36. data/test/dummy/config/environments/production.rb +67 -0
  37. data/test/dummy/config/environments/test.rb +37 -0
  38. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  39. data/test/dummy/config/initializers/inflections.rb +15 -0
  40. data/test/dummy/config/initializers/mime_types.rb +5 -0
  41. data/test/dummy/config/initializers/secret_token.rb +7 -0
  42. data/test/dummy/config/initializers/session_store.rb +8 -0
  43. data/test/dummy/config/initializers/smurfville.rb +2 -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 +4 -0
  47. data/test/dummy/config.ru +4 -0
  48. data/test/dummy/db/development.sqlite3 +0 -0
  49. data/test/dummy/db/test.sqlite3 +0 -0
  50. data/test/dummy/log/development.log +8932 -0
  51. data/test/dummy/log/test.log +110 -0
  52. data/test/dummy/public/404.html +26 -0
  53. data/test/dummy/public/422.html +26 -0
  54. data/test/dummy/public/500.html +25 -0
  55. data/test/dummy/public/favicon.ico +0 -0
  56. data/test/dummy/script/rails +6 -0
  57. data/test/dummy/tmp/cache/assets/CBE/460/sprockets%2F82cd2698ea187319b82eee783227407b +0 -0
  58. data/test/dummy/tmp/cache/assets/CC3/D80/sprockets%2F664f76338152c770cfef980d5588be21 +0 -0
  59. data/test/dummy/tmp/cache/assets/CCA/0C0/sprockets%2F6c3e053393afe303432ca73f1b41490b +0 -0
  60. data/test/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953 +0 -0
  61. data/test/dummy/tmp/cache/assets/CE3/2B0/sprockets%2Fac9929105133c62d94cedd5e46b52493 +0 -0
  62. data/test/dummy/tmp/cache/assets/D03/150/sprockets%2F82855a1c8339d7bef8a98868ab858f18 +0 -0
  63. data/test/dummy/tmp/cache/assets/D16/910/sprockets%2Ff4ea1f2c07dd541e81f481f835a64838 +0 -0
  64. data/test/dummy/tmp/cache/assets/D18/840/sprockets%2F50c1885539f61359c48af74fcae1df31 +0 -0
  65. data/test/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705 +0 -0
  66. data/test/dummy/tmp/cache/assets/D35/5E0/sprockets%2F50cfa004a8a405f2e48625bec5c583e6 +0 -0
  67. data/test/dummy/tmp/cache/assets/D44/0E0/sprockets%2Fe82cfc1252647fb8586c7abf2c2056c7 +0 -0
  68. data/test/dummy/tmp/cache/assets/D58/580/sprockets%2F82e92c71c797dac98897e20a7df20df7 +0 -0
  69. data/test/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6 +0 -0
  70. data/test/dummy/tmp/cache/assets/D5E/470/sprockets%2Fb90e61060b73e4c4c2466c5ad8acc06b +0 -0
  71. data/test/dummy/tmp/cache/assets/D8F/EC0/sprockets%2Fc501d0e26be5fc8f613a8faa5c003c49 +0 -0
  72. data/test/dummy/tmp/cache/assets/D97/AA0/sprockets%2F30c4ef2c6254a2c8ecedf8f7259c01b0 +0 -0
  73. data/test/dummy/tmp/cache/assets/DA6/120/sprockets%2Fc5880aca76ccbb51f9388362e8afc1e6 +0 -0
  74. data/test/dummy/tmp/cache/assets/DF1/3C0/sprockets%2Fa6c7bdfdcdc7a50417324089c9a1abcc +0 -0
  75. data/test/dummy/tmp/cache/assets/DF2/040/sprockets%2Fabe2c880aeb0bf05a2651c9a3d68ce5f +0 -0
  76. data/test/dummy/tmp/sass-cache/8533189236bf1aa999c1f771fbe4dd9915738473/typography.sassc +0 -0
  77. data/test/functional/smurf/styleguide_controller_test.rb +9 -0
  78. data/test/integration/navigation_test.rb +10 -0
  79. data/test/smurf_test.rb +7 -0
  80. data/test/test_helper.rb +15 -0
  81. data/test/unit/color_variable_parser_test.rb +52 -0
  82. data/test/unit/helpers/smurf/styleguide_helper_test.rb +6 -0
  83. data/test/unit/sass/colors_01.sass +15 -0
  84. data/test/unit/sass/colors_02.css.sass +209 -0
  85. metadata +266 -0
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2012 YOURNAME
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,66 @@
1
+ SMURF
2
+ =====
3
+
4
+ **S**calable, **M**odular, re**U**sable **R**ails **F**rontends
5
+
6
+ ![SMURF](https://github.com/railslove/smurf/raw/master/app/assets/images/smurf/smurf.png)
7
+
8
+ [![Build Status](https://secure.travis-ci.org/railslove/smurf.png?branch=master)](http://travis-ci.org/railslove/smurf)
9
+
10
+ The name and the philosophy of SMURF are heavily influenced by the [SMACSS](http://smacss.com) approach by Jonathan Snook ([@snookca](https://twitter.com/snookca)) which stands for Scalable Modular Architecture for CSS.
11
+
12
+
13
+ # SMURF Philosophy
14
+
15
+ These are the main goals behind SMURF:
16
+
17
+ ## Goal 1: Conventions
18
+
19
+ Analogous to what [SMACSS](http://smacss.com) does for modular CSS we want to establish conventions for naming, structure, and filenames of all modular frontend code. There should be a specific partial, helper or similar for each frontend module and it should be immediately clear how it needs to be named and where the files should be put.
20
+
21
+ This goal is achieved when it is completely clear where all the necessary parts of a frontend module are located.
22
+
23
+
24
+ ## Goal 2: Living Styleguide
25
+
26
+ Based on the conventions from Goal 1 we are creating tools that parse our Rails projects and render anything that makes sense into a living styleguide. This would include an overview of all the modules with their different submodules and states and hopefully also some JS interactions. The two goals behind this would be **a)** to have a tool for something like **"visual unit testing"** and **b)** to have a **communication device** for any kind of **design work** within a project.
27
+
28
+ As a first step, our SMURF gem can already render a living styleguide of all the color variables in your Sass code.
29
+
30
+ An example for a similar tool could be [kss-rails](https://github.com/dewski/kss-rails)
31
+
32
+ ## Goal 3: Developing modules in the browser
33
+
34
+ Once we have a tool to easily render all our modules, the next step is to add the ability to write/change/tweak them right within the browser. This would have the advantage that you could open the module editor in different browsers to directly account for x-browser differences and you don't have to hit reload again to see the effect of your changes to the frontend code. One could see it as an equivalent for vim+tmux+autotest for frontend development.
35
+
36
+ (technology ideas: [voyage-editor](http://voyage-editor.herokuapp.com/), [cloud9](http://c9.io), [fivetastic](https://github.com/makevoid/fivetastic))
37
+
38
+
39
+ # SMURF Gem
40
+
41
+ Currently the gem can parse your Sass files and display all the color variables your are using in a nice styleguide.
42
+
43
+ ## Prerequisites
44
+
45
+ * Rails >3.1
46
+ * Sass
47
+ * Haml
48
+
49
+ ## Installation
50
+
51
+ Add this to your `Gemfile`, run `bundle install`:
52
+
53
+ gem 'smurf-rails'
54
+
55
+ Add an initializer to your Rails project in which you tell SMURF where it can find your Sass files:
56
+
57
+ # config/initializers/smurf.rb
58
+ Smurf.sass_directory = Rails.root.join('app', 'assets', 'stylesheets').to_s
59
+
60
+ Mount the SMURF gem in your routes:
61
+
62
+ # config/routes.rb
63
+
64
+ mount Smurf::Engine => "/smurf"
65
+
66
+ Restart your server and you should be able to access the SMURF pages, e.g. `yourapp.com/smurf/styleguide/colors`
data/Rakefile ADDED
@@ -0,0 +1,46 @@
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 = 'Smurfville'
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
41
+
42
+ # task :testing do
43
+ # parser = Smurfville::TypographyParser.new
44
+ # parser.parse "/home/jk/projects/smurf/test/unit/sass/typography.sass"
45
+ # puts parser.typographies.inspect
46
+ # end
@@ -0,0 +1 @@
1
+ //= require jquery
@@ -0,0 +1,38 @@
1
+ //= require_self
2
+
3
+ $border-color: silver
4
+ $padding: 10px
5
+
6
+ html, body, ul, li, p
7
+ font-family: sans-serif
8
+ font-size: 13px
9
+
10
+ strong
11
+ font-weight: bold
12
+
13
+ .smurfville-color-list
14
+ padding: 0
15
+ > li
16
+ list-style-type: none
17
+ float: left
18
+ width: 300px
19
+ min-height: 80px
20
+ border: 1px solid $border-color
21
+ padding: $padding
22
+ margin: $padding
23
+ > ul
24
+ padding: 0
25
+
26
+ .smurfville-color-var
27
+ list-style-type: none
28
+ overflow: hidden
29
+ margin-bottom: $padding
30
+ > .smurfville-color-var--name
31
+ float: left
32
+ > .smurfville-color-var--mappings
33
+ padding: 0
34
+ float: right
35
+ > li
36
+ text-align: right
37
+ list-style-type: none
38
+
@@ -0,0 +1,4 @@
1
+ module Smurfville
2
+ class ApplicationController < ActionController::Base
3
+ end
4
+ end
@@ -0,0 +1,19 @@
1
+ module Smurfville
2
+ class StyleguideController < ApplicationController
3
+ def colors
4
+ @parser = Smurfville::ColorVariableParser.new
5
+ @parser.parse
6
+ end
7
+
8
+ def partials
9
+ end
10
+
11
+ def helper
12
+ end
13
+
14
+ def typography
15
+ # @parser = Smurfville::TypographyParser.new
16
+ # @parser.parse
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,4 @@
1
+ module Smurfville
2
+ module ApplicationHelper
3
+ end
4
+ end
@@ -0,0 +1,14 @@
1
+ require "color/css"
2
+
3
+ module Smurfville
4
+ module StyleguideHelper
5
+
6
+ # returns well readable, high-contrast foreground color ("black" or "white") based on passed background_color
7
+ def foreground_color(background_color)
8
+ if color = Smurfville::ColorVariableParser.parse_color(background_color)
9
+ return "black" if color.brightness > 0.5
10
+ end
11
+ return "white"
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Smurfville</title>
5
+ <%= stylesheet_link_tag "smurfville/application", :media => "all" %>
6
+ <%= javascript_include_tag "smurfville/application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,11 @@
1
+ %li.smurfville-color-var
2
+ .smurfville-color-var--name
3
+ %strong= color_var
4
+ %small= "(#{@parser.print_variable_usage_count_for(color_var)})"
5
+
6
+ -if @parser.variable_mappings[color_var]
7
+ %ul.smurfville-color-var--mappings
8
+ -@parser.variable_mappings[color_var].each do |color_mapping|
9
+ %li
10
+ = color_mapping
11
+ %small= "(#{@parser.print_variable_usage_count_for(color_mapping)})"
@@ -0,0 +1,10 @@
1
+ -if @parser
2
+ %ul.smurfville-color-list
3
+ -@parser.colors.each do |color|
4
+ -color_value = color[0]
5
+ -color_vars = color[1]
6
+ %li{style: "background-color: #{color[0]}; color: #{foreground_color(color[0])}"}
7
+ .smurfville-html-color= color[0]
8
+ %ul
9
+ -color_vars.each do |color_var|
10
+ = render partial: "color_var", locals: {color_var: color_var}
@@ -0,0 +1,6 @@
1
+ :sass
2
+ @import "typography"
3
+ .typo1
4
+ +default-text()
5
+
6
+ .typo1= "typo1"
data/config/routes.rb ADDED
@@ -0,0 +1,6 @@
1
+ Smurfville::Engine.routes.draw do
2
+ root :to => "styleguide#colors"
3
+
4
+ match "styleguide/colors" => "styleguide#colors"
5
+ match "styleguide/typography" => "styleguide#typography"
6
+ end
@@ -0,0 +1,71 @@
1
+ require "color/css"
2
+ require "sass"
3
+
4
+ module Smurfville
5
+ class ColorVariableParser
6
+ attr_accessor :colors, :variable_mappings, :variable_usage, :sass_directory
7
+
8
+ def initialize(sass_directory = Smurfville.sass_directory)
9
+ @colors = {}
10
+ @variable_mappings = {}
11
+ @variable_usage = {}
12
+ @sass_directory = sass_directory
13
+ end
14
+
15
+ def parse_sass_directory(directory = sass_directory)
16
+ Dir.glob("#{directory}/**/*").each do |file|
17
+ if file.end_with?(".sass", ".scss")
18
+ parse_sass_file(file)
19
+ parse_variable_usage(file)
20
+ end
21
+ end
22
+ end
23
+ alias_method :parse, :parse_sass_directory
24
+
25
+ # parses Sass file and returns hash with colors and variable_mappings (or false)
26
+ def parse_sass_file(file, options = {})
27
+ Sass::Engine.for_file(file, options).to_tree.children.each do | node |
28
+ if node.kind_of? Sass::Tree::VariableNode
29
+ variable_node_parts = node.to_scss.split(":")
30
+ variable_name = variable_node_parts[0]
31
+ value = variable_node_parts[1].gsub(";", "").strip
32
+
33
+ if color = Smurfville::ColorVariableParser.parse_color(value)
34
+ (self.colors[color.html] ||= []) << variable_name
35
+
36
+ elsif value.start_with? "$"
37
+ (self.variable_mappings[value] ||= []) << variable_name
38
+
39
+ end
40
+ end
41
+ end
42
+ end
43
+
44
+ def parse_variable_usage(file)
45
+ grep_output = `grep -iG "\$" #{file}`
46
+ grep_output.each_line do |line|
47
+ matches = line.scan(/\$[\w-]*/)
48
+ matches.each do |match|
49
+ self.variable_usage[match] ||= 0
50
+ self.variable_usage[match] += 1
51
+ end
52
+ end
53
+ end
54
+
55
+ def print_variable_usage_count_for(color)
56
+ self.variable_usage[color] - 1 rescue 0
57
+ end
58
+
59
+ def self.parse_color(color)
60
+ return false unless color.is_a? String
61
+
62
+ if color.include? "#"
63
+ Color::RGB.from_html(color) rescue false
64
+ elsif Color::CSS[color]
65
+ Color::CSS[color]
66
+ else
67
+ false
68
+ end
69
+ end
70
+ end
71
+ end
@@ -0,0 +1,5 @@
1
+ module Smurfville
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace Smurfville
4
+ end
5
+ end
@@ -0,0 +1,28 @@
1
+ require "sass"
2
+
3
+ module Smurfville
4
+ class TypographyParser
5
+ attr_accessor :typographies, :typography_sass_file
6
+
7
+ def initialize(typography_sass_file = Smurfville.typography_sass_file)
8
+ @typographies = {}
9
+ @typography_sass_file = typography_sass_file
10
+ end
11
+
12
+ def parse(options = {})
13
+ sass_tree = Sass::Engine.for_file(self.typography_sass_file, options).to_tree
14
+ sass_tree.children.each do | node |
15
+ if node.kind_of?(Sass::Tree::CommentNode) && is_typography_comment?(node)
16
+ parsed_comment = YAML.load node.value.join.gsub!("// ", "")
17
+ self.typographies[parsed_comment["styleguide_typography"]["mixin"]] = parsed_comment["styleguide_typography"]["params"]
18
+ end
19
+ end
20
+ end
21
+
22
+ private
23
+
24
+ def is_typography_comment?(comment_node)
25
+ comment_node.value.any? { |comment| comment.index("styleguide_typography") }
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,3 @@
1
+ module Smurfville
2
+ VERSION = "0.0.4"
3
+ end
data/lib/smurfville.rb ADDED
@@ -0,0 +1,7 @@
1
+ require "smurfville/engine"
2
+ require "smurfville/color_variable_parser"
3
+ #require "smurfville/typography_parser"
4
+
5
+ module Smurfville
6
+ mattr_accessor :sass_directory, :typography_sass_file
7
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :smurfville do
3
+ # # Task goes here
4
+ # 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