betterspecs 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +18 -0
  4. data/Rakefile +29 -0
  5. data/app/assets/javascripts/betterspecs/application.js +15 -0
  6. data/app/assets/stylesheets/betterspecs/application.sass +20 -0
  7. data/app/controllers/betterspecs/application_controller.rb +4 -0
  8. data/app/controllers/betterspecs/contexts_controller.rb +9 -0
  9. data/app/helpers/betterspecs/application_helper.rb +4 -0
  10. data/app/helpers/betterspecs/contexts_helper.rb +4 -0
  11. data/app/models/betterspecs/context.rb +37 -0
  12. data/app/models/betterspecs/image.rb +16 -0
  13. data/app/views/betterspecs/contexts/_context.haml +14 -0
  14. data/app/views/betterspecs/contexts/index.haml +3 -0
  15. data/app/views/layouts/betterspecs/application.html.erb +14 -0
  16. data/config/routes.rb +4 -0
  17. data/db/migrate/20131003203424_create_betterspecs_contexts.rb +13 -0
  18. data/db/migrate/20131003204715_create_betterspecs_images.rb +11 -0
  19. data/db/migrate/20131003205445_add_attachment_file_to_betterspecs_images.rb +11 -0
  20. data/lib/betterspecs.rb +5 -0
  21. data/lib/betterspecs/engine.rb +12 -0
  22. data/lib/betterspecs/rspec.rb +47 -0
  23. data/lib/betterspecs/version.rb +3 -0
  24. data/lib/tasks/betterspecs_tasks.rake +4 -0
  25. data/spec/controllers/betterspecs/contexts_controller_spec.rb +18 -0
  26. data/spec/dummy/README.rdoc +261 -0
  27. data/spec/dummy/Rakefile +7 -0
  28. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  29. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  30. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  31. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  32. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  33. data/spec/dummy/config.ru +4 -0
  34. data/spec/dummy/config/application.rb +65 -0
  35. data/spec/dummy/config/boot.rb +10 -0
  36. data/spec/dummy/config/database.yml +25 -0
  37. data/spec/dummy/config/environment.rb +5 -0
  38. data/spec/dummy/config/environments/development.rb +37 -0
  39. data/spec/dummy/config/environments/production.rb +67 -0
  40. data/spec/dummy/config/environments/test.rb +37 -0
  41. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  42. data/spec/dummy/config/initializers/inflections.rb +15 -0
  43. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  44. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  45. data/spec/dummy/config/initializers/session_store.rb +8 -0
  46. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  47. data/spec/dummy/config/locales/en.yml +5 -0
  48. data/spec/dummy/config/routes.rb +4 -0
  49. data/spec/dummy/db/development.sqlite3 +0 -0
  50. data/spec/dummy/db/schema.rb +38 -0
  51. data/spec/dummy/db/seeds.rb +14 -0
  52. data/spec/dummy/db/test.sqlite3 +0 -0
  53. data/spec/dummy/log/development.log +6618 -0
  54. data/spec/dummy/log/test.log +36778 -0
  55. data/spec/dummy/public/404.html +26 -0
  56. data/spec/dummy/public/422.html +26 -0
  57. data/spec/dummy/public/500.html +25 -0
  58. data/spec/dummy/public/favicon.ico +0 -0
  59. data/spec/dummy/public/system/betterspecs/images/files/000/000/001/medium/dashboard.png +0 -0
  60. data/spec/dummy/public/system/betterspecs/images/files/000/000/001/original/dashboard.png +0 -0
  61. data/spec/dummy/public/system/betterspecs/images/files/000/000/001/original/desk.png +0 -0
  62. data/spec/dummy/public/system/betterspecs/images/files/000/000/001/thumb/dashboard.png +0 -0
  63. data/spec/dummy/public/system/betterspecs/images/files/000/000/002/medium/dashboard.png +0 -0
  64. data/spec/dummy/public/system/betterspecs/images/files/000/000/002/original/dashboard.png +0 -0
  65. data/spec/dummy/public/system/betterspecs/images/files/000/000/002/thumb/dashboard.png +0 -0
  66. data/spec/dummy/public/system/betterspecs/images/files/000/000/003/medium/dashboard.png +0 -0
  67. data/spec/dummy/public/system/betterspecs/images/files/000/000/003/original/dashboard.png +0 -0
  68. data/spec/dummy/public/system/betterspecs/images/files/000/000/003/thumb/dashboard.png +0 -0
  69. data/spec/dummy/script/rails +6 -0
  70. data/spec/dummy/tmp/cache/assets/C5A/840/sprockets%2Fb86a516f11d8761e6885169f440237e0 +0 -0
  71. data/spec/dummy/tmp/cache/assets/CAB/540/sprockets%2F0e183e4c8bb0935b03d891644b655f31 +0 -0
  72. data/spec/dummy/tmp/cache/assets/CE3/E60/sprockets%2F33f782f88d5b5a4e0026a9ef47236c04 +0 -0
  73. data/spec/dummy/tmp/cache/assets/D38/620/sprockets%2F47bf0c51ead2f0fa9c045052e7862a68 +0 -0
  74. data/spec/dummy/tmp/cache/assets/D4C/0D0/sprockets%2F7c3ef31ae79e782490f08a9fdc6b6530 +0 -0
  75. data/spec/dummy/tmp/cache/assets/D5A/5A0/sprockets%2F6dcdab340d6131406a1f53c7a9eec108 +0 -0
  76. data/spec/dummy/tmp/cache/assets/D6B/0D0/sprockets%2F24ebb3144e29f6d5eaa942bc8c012e89 +0 -0
  77. data/spec/dummy/tmp/cache/assets/D6F/540/sprockets%2F11b108756c6ffc522425f7df2ce8a4fd +0 -0
  78. data/spec/dummy/tmp/cache/assets/D9B/5B0/sprockets%2Fa06f5228ecf973c75bd74ad3cb15e0e3 +0 -0
  79. data/spec/dummy/tmp/cache/assets/DAE/780/sprockets%2Fda9f2b86e2d7cf8029b6a984d1ff2e80 +0 -0
  80. data/spec/dummy/tmp/cache/assets/DC3/180/sprockets%2Fec51dfeb1bbc19bd060f8803c54d1c85 +0 -0
  81. data/spec/dummy/tmp/cache/assets/DC9/BC0/sprockets%2Ff9b23a768da2cd1b5bccaef85037237d +0 -0
  82. data/spec/dummy/tmp/cache/assets/DE4/180/sprockets%2Fc4412cf01a64fcbcb05aa143da83fff4 +0 -0
  83. data/spec/dummy/tmp/cache/sass/9833c66217406feb84b0a9b81455941b8e477746/application.sassc +0 -0
  84. data/spec/factories/assets/dashboard.png +0 -0
  85. data/spec/factories/contexts.rb +5 -0
  86. data/spec/factories/images.rb +8 -0
  87. data/spec/models/betterspecs/context_spec.rb +70 -0
  88. data/spec/models/betterspecs/image_spec.rb +34 -0
  89. data/spec/models/betterspecs/rspec_spec.rb +17 -0
  90. data/spec/spec_helper.rb +28 -0
  91. data/spec/support/capybara.rb +26 -0
  92. data/spec/support/fixture_file.rb +5 -0
  93. data/spec/support/paperclip.rb +17 -0
  94. metadata +274 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 6936918474198cd44aa6170efa63228c9eb94d59
4
+ data.tar.gz: 972bb6d0890c5c3d94204239662f0939127e6b41
5
+ SHA512:
6
+ metadata.gz: 5bbea7865c30f8cb8c773db9a56dc767758322b6ab97e5e8aaeaa66a38f9242ac538af5f1273ab9b5ad220202a513fa753c081bad3d47dbf6100566e396f33e5
7
+ data.tar.gz: 1b8ea6453c12c83c7bf7d85fe0f79c247294c888bd511682534e67d279e3cf87bcf30060ee6c4d2b6ec3813e36addeab637292448fb8db328fc481a86747e4e6
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2013 Tomasz Bąk
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,18 @@
1
+ Install
2
+ =======
3
+
4
+ rake betterspecs:install:migrations
5
+ rake db:migrate
6
+
7
+
8
+ Development
9
+ ===========
10
+
11
+ cd spec/dummy
12
+ RAILS_ENV=development rake db:drop db:setup && rails s
13
+
14
+ Test
15
+ ====
16
+
17
+ RAILS_ENV=test rake db:drop db:migrate
18
+ guard
data/Rakefile ADDED
@@ -0,0 +1,29 @@
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 = 'Betterspecs'
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("../spec/dummy/Rakefile", __FILE__)
24
+ load 'rails/tasks/engine.rake'
25
+
26
+
27
+
28
+ Bundler::GemHelper.install_tasks
29
+
@@ -0,0 +1,15 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // the compiled file.
9
+ //
10
+ // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
11
+ // GO AFTER THE REQUIRES BELOW.
12
+ //
13
+ //= require jquery
14
+ //= require jquery_ujs
15
+ //= require_tree .
@@ -0,0 +1,20 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
9
+ * compiled file, but it's generally better to create a new file per style scope.
10
+ *
11
+ *= require_self
12
+ *= require_tree .
13
+ */
14
+
15
+ .context
16
+ background: silver
17
+ width: 200px
18
+
19
+ .image
20
+ background: peachpuff
@@ -0,0 +1,4 @@
1
+ module Betterspecs
2
+ class ApplicationController < ActionController::Base
3
+ end
4
+ end
@@ -0,0 +1,9 @@
1
+ require_dependency "betterspecs/application_controller"
2
+
3
+ module Betterspecs
4
+ class ContextsController < ApplicationController
5
+ def index
6
+ @contexts = Context.roots
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,4 @@
1
+ module Betterspecs
2
+ module ApplicationHelper
3
+ end
4
+ end
@@ -0,0 +1,4 @@
1
+ module Betterspecs
2
+ module ContextsHelper
3
+ end
4
+ end
@@ -0,0 +1,37 @@
1
+ module Betterspecs
2
+ class Context < ActiveRecord::Base
3
+ attr_accessible :name, :position, :parent
4
+
5
+ has_ancestry
6
+ has_many :images, class_name: Betterspecs::Image
7
+
8
+ validates :name, presence: true
9
+
10
+ def fullpath
11
+ path.map(&:name).join('/')
12
+ end
13
+
14
+ def get_context(path)
15
+ first, *rest = path.split('/')
16
+
17
+ if first.blank?
18
+ self
19
+ else
20
+ (children.find_by_name(first) || children.create(name: first)).get_context rest.join('/')
21
+ end
22
+ end
23
+
24
+ def self.get_context(path)
25
+ first, *rest = path.split('/')
26
+ if first.blank?
27
+ nil
28
+ else
29
+ Context.roots.find_or_create_by_name(first).get_context rest.join('/')
30
+ end
31
+ end
32
+
33
+ def get_image(name)
34
+ images.find_by_name(name)||images.create(name: name)
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,16 @@
1
+ module Betterspecs
2
+ class Image < ActiveRecord::Base
3
+ attr_accessible :context_id, :name, :position, :file
4
+
5
+ has_attached_file :file,
6
+ :styles => { :medium => "400x400>", :thumb => "100x100>" },
7
+ :default_url => "/images/:style/missing.png"
8
+
9
+ belongs_to :context
10
+
11
+ def self.get_image(path)
12
+ context_path, image_name = File.split(path)
13
+ Context.get_context(context_path).get_image(image_name)
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,14 @@
1
+ %li.context
2
+ = context.name
3
+
4
+ - unless context.images.empty?
5
+ %ul
6
+ - context.images.each do |image|
7
+ %li.image
8
+ = image.name
9
+ = link_to image_tag(image.file.url(:thumb)), image.file.url
10
+
11
+ - unless context.children.empty?
12
+ %ul
13
+ - context.children.each do |child|
14
+ = render child
@@ -0,0 +1,3 @@
1
+ %ul
2
+ - @contexts.each do |context|
3
+ = render context
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Betterspecs</title>
5
+ <%= stylesheet_link_tag "betterspecs/application", :media => "all" %>
6
+ <%= javascript_include_tag "betterspecs/application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
data/config/routes.rb ADDED
@@ -0,0 +1,4 @@
1
+ Betterspecs::Engine.routes.draw do
2
+ resources :contexts
3
+ root to: "contexts#index"
4
+ end
@@ -0,0 +1,13 @@
1
+ class CreateBetterspecsContexts < ActiveRecord::Migration
2
+ def change
3
+ create_table :betterspecs_contexts do |t|
4
+ t.string :name
5
+ t.integer :position
6
+ t.string :ancestry
7
+
8
+ t.timestamps
9
+ end
10
+
11
+ add_index :betterspecs_contexts, :ancestry
12
+ end
13
+ end
@@ -0,0 +1,11 @@
1
+ class CreateBetterspecsImages < ActiveRecord::Migration
2
+ def change
3
+ create_table :betterspecs_images do |t|
4
+ t.string :name
5
+ t.integer :position
6
+ t.integer :context_id
7
+
8
+ t.timestamps
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ class AddAttachmentFileToBetterspecsImages < ActiveRecord::Migration
2
+ def self.up
3
+ change_table :betterspecs_images do |t|
4
+ t.attachment :file
5
+ end
6
+ end
7
+
8
+ def self.down
9
+ drop_attached_file :betterspecs_images, :file
10
+ end
11
+ end
@@ -0,0 +1,5 @@
1
+ require "betterspecs/engine"
2
+ require "betterspecs/rspec" if Rails.env.test?
3
+
4
+ module Betterspecs
5
+ end
@@ -0,0 +1,12 @@
1
+ module Betterspecs
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace Betterspecs
4
+
5
+ config.generators do |g|
6
+ g.template_engine :haml
7
+ g.test_framework :rspec, view_specs: false
8
+ g.integration_tool :rspec
9
+ g.fixture_replacement :factory_girl, dir: 'spec/factories'
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,47 @@
1
+ require 'capybara/dsl'
2
+
3
+ module Betterspecs
4
+ class RSpec
5
+ include Capybara::DSL
6
+
7
+ attr_accessor :objects
8
+
9
+ def initialize(path,options)
10
+ @path = File.join "betterspecs", path.to_s
11
+ @objects = options.keys
12
+ end
13
+
14
+ def fullpath(path)
15
+ path = File.join [@path, path].compact
16
+ FileUtils.mkdir_p File.dirname(path)
17
+ path
18
+ end
19
+
20
+ def dump(path, objects)
21
+ File.open(fullpath("#{path}.json"),"w") do |f|
22
+ f.write(objects.to_json)
23
+ end
24
+ end
25
+
26
+ def screenshot(path)
27
+ page.driver.save_screenshot fullpath("#{path}.jpg")
28
+ end
29
+
30
+ # TODO keep order of calls and generate index.json files with:
31
+ # ["Shot 1", "Shot 2"]
32
+ # best if we read and write to that file in the dirname/index.json
33
+ end
34
+ end
35
+
36
+ #def screenshot(path)
37
+ # betterspec.screenshot(path)
38
+ # #objectshot path
39
+ #end
40
+ #
41
+ #def objectshot(path)
42
+ # objects = {}
43
+ # betterspec.objects.each do |key|
44
+ # objects[key] = send(key)
45
+ # end
46
+ # betterspec.objectshot(path, objects)
47
+ #end
@@ -0,0 +1,3 @@
1
+ module Betterspecs
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :betterspecs do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,18 @@
1
+ require 'spec_helper'
2
+
3
+ module Betterspecs
4
+ describe ContextsController do
5
+ routes { Engine.routes }
6
+ let(:roots) { [create(:context)] }
7
+
8
+ describe "GET 'index'" do
9
+ it "returns http success" do
10
+ Context.stub(:all) { roots }
11
+ get :index
12
+ response.should be_success
13
+ assigns(:contexts).should == roots
14
+ end
15
+ end
16
+
17
+ end
18
+ 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
+ | |-- assets
177
+ | `-- tasks
178
+ |-- log
179
+ |-- public
180
+ |-- script
181
+ |-- test
182
+ | |-- fixtures
183
+ | |-- functional
184
+ | |-- integration
185
+ | |-- performance
186
+ | `-- unit
187
+ |-- tmp
188
+ | `-- cache
189
+ | `-- assets
190
+ `-- vendor
191
+ |-- assets
192
+ | |-- javascripts
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.