remi-rackbox 1.0.1 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (80) hide show
  1. data/README.markdown +6 -0
  2. data/Rakefile +57 -0
  3. data/VERSION.yml +2 -2
  4. data/examples/rack/config.ru +53 -0
  5. data/examples/rack/run-specs +2 -0
  6. data/examples/rack/spec +1 -0
  7. data/examples/rails/README +256 -0
  8. data/examples/rails/Rakefile +10 -0
  9. data/examples/rails/app/controllers/application.rb +15 -0
  10. data/examples/rails/app/controllers/welcome_controller.rb +32 -0
  11. data/examples/rails/app/helpers/application_helper.rb +3 -0
  12. data/examples/rails/app/helpers/welcome_helper.rb +2 -0
  13. data/examples/rails/app/views/layouts/application.html.erb +7 -0
  14. data/examples/rails/app/views/welcome/some_html.html.erb +20 -0
  15. data/examples/rails/config/boot.rb +109 -0
  16. data/examples/rails/config/database.yml +22 -0
  17. data/examples/rails/config/environment.rb +75 -0
  18. data/examples/rails/config/environments/development.rb +17 -0
  19. data/examples/rails/config/environments/production.rb +24 -0
  20. data/examples/rails/config/environments/test.rb +22 -0
  21. data/examples/rails/config/initializers/inflections.rb +10 -0
  22. data/examples/rails/config/initializers/mime_types.rb +5 -0
  23. data/examples/rails/config/initializers/new_rails_defaults.rb +17 -0
  24. data/examples/rails/config/locales/en.yml +5 -0
  25. data/examples/rails/config/routes.rb +12 -0
  26. data/examples/rails/db/development.sqlite3 +0 -0
  27. data/examples/rails/db/schema.rb +14 -0
  28. data/examples/rails/db/test.sqlite3 +0 -0
  29. data/examples/rails/doc/README_FOR_APP +5 -0
  30. data/examples/rails/lib/tasks/rspec.rake +158 -0
  31. data/examples/rails/public/404.html +30 -0
  32. data/examples/rails/public/422.html +30 -0
  33. data/examples/rails/public/500.html +33 -0
  34. data/examples/rails/public/dispatch.cgi +10 -0
  35. data/examples/rails/public/dispatch.fcgi +24 -0
  36. data/examples/rails/public/dispatch.rb +10 -0
  37. data/examples/rails/public/favicon.ico +0 -0
  38. data/examples/rails/public/images/rails.png +0 -0
  39. data/examples/rails/public/javascripts/application.js +2 -0
  40. data/examples/rails/public/javascripts/controls.js +963 -0
  41. data/examples/rails/public/javascripts/dragdrop.js +973 -0
  42. data/examples/rails/public/javascripts/effects.js +1128 -0
  43. data/examples/rails/public/javascripts/prototype.js +4320 -0
  44. data/examples/rails/public/robots.txt +5 -0
  45. data/examples/rails/run-specs +2 -0
  46. data/examples/rails/script/about +4 -0
  47. data/examples/rails/script/autospec +5 -0
  48. data/examples/rails/script/console +3 -0
  49. data/examples/rails/script/dbconsole +3 -0
  50. data/examples/rails/script/destroy +3 -0
  51. data/examples/rails/script/generate +3 -0
  52. data/examples/rails/script/performance/benchmarker +3 -0
  53. data/examples/rails/script/performance/profiler +3 -0
  54. data/examples/rails/script/performance/request +3 -0
  55. data/examples/rails/script/plugin +3 -0
  56. data/examples/rails/script/process/inspector +3 -0
  57. data/examples/rails/script/process/reaper +3 -0
  58. data/examples/rails/script/process/spawner +3 -0
  59. data/examples/rails/script/runner +3 -0
  60. data/examples/rails/script/server +3 -0
  61. data/examples/rails/script/spec +5 -0
  62. data/examples/rails/script/spec_server +125 -0
  63. data/examples/rails/spec +1 -0
  64. data/examples/rails/test/functional/welcome_controller_test.rb +8 -0
  65. data/examples/rails/test/performance/browsing_test.rb +9 -0
  66. data/examples/rails/test/test_helper.rb +38 -0
  67. data/examples/sinatra/config.ru +11 -0
  68. data/examples/sinatra/run-specs +2 -0
  69. data/examples/sinatra/sinatra_app.rb +58 -0
  70. data/examples/sinatra/spec +1 -0
  71. data/lib/rackbox/rack/extensions_for_rspec.rb +2 -0
  72. data/lib/rackbox/rackbox.rb +32 -0
  73. data/lib/rackbox/spec/configuration.rb +11 -0
  74. data/lib/rackbox/spec/helpers.rb +1 -1
  75. data/rails_generators/blackbox_spec/USAGE +5 -0
  76. data/rails_generators/blackbox_spec/blackbox_spec_generator.rb +56 -0
  77. data/rails_generators/blackbox_spec/templates/spec.erb +9 -0
  78. data/spec/rackbox_spec.rb +35 -0
  79. data/spec/spec_helper.rb +1 -0
  80. metadata +106 -2
@@ -61,6 +61,12 @@ on how things work in [Merb][] so I can duplicate any functionality I'm missing.
61
61
  `request` gives you a [`Rack::Response`](http://rack.rubyforge.org/doc/classes/Rack/Response.html) which has
62
62
  `body`, `headers`, `status` methods ([and more](http://rack.rubyforge.org/doc/classes/Rack/Response.html))
63
63
 
64
+ TODO
65
+ ----
66
+
67
+ Before I make a screencast and post it to my blog, I wanna finish these ...
68
+
69
+ - add a rails generator so you can install the gem and then ./script/generate blackbox\_spec
64
70
 
65
71
 
66
72
  [rackbox]: http://github.com/remi/rackbox
@@ -0,0 +1,57 @@
1
+ require 'rake'
2
+ require 'rubygems'
3
+ require 'rake/rdoctask'
4
+ require 'spec/rake/spectask'
5
+
6
+ begin
7
+ require 'jeweler'
8
+ Jeweler::Tasks.new do |s|
9
+ s.name = "rackbox"
10
+ s.summary = "Merb-like BlackBox testing for Rack apps, including Rails"
11
+ s.email = "remi@remitaylor.com"
12
+ s.homepage = "http://github.com/remi/rackbox"
13
+ s.description = "Merb-like BlackBox testing for Rack apps, including Rails"
14
+ s.authors = %w( remi )
15
+ s.files = FileList["[A-Z]*", "{lib,spec,examples,rails_generators}/**/*"]
16
+ # s.executables = "neato"
17
+ # s.add_dependency 'person-project'
18
+ end
19
+ rescue LoadError
20
+ puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
21
+ end
22
+
23
+ Spec::Rake::SpecTask.new do |t|
24
+ t.spec_files = FileList['spec/**/*_spec.rb']
25
+ end
26
+
27
+ desc "Run all examples with RCov"
28
+ Spec::Rake::SpecTask.new('rcov') do |t|
29
+ t.spec_files = FileList['spec/**/*_spec.rb']
30
+ t.rcov = true
31
+ end
32
+
33
+ Rake::RDocTask.new do |rdoc|
34
+ rdoc.rdoc_dir = 'rdoc'
35
+ rdoc.title = 'rackbox'
36
+ rdoc.options << '--line-numbers' << '--inline-source'
37
+ rdoc.rdoc_files.include('README*')
38
+ rdoc.rdoc_files.include('lib/**/*.rb')
39
+ end
40
+
41
+ desc 'Confirm that gemspec is $SAFE'
42
+ task :safe do
43
+ require 'yaml'
44
+ require 'rubygems/specification'
45
+ data = File.read('rackbox.gemspec')
46
+ spec = nil
47
+ if data !~ %r{!ruby/object:Gem::Specification}
48
+ Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
49
+ else
50
+ spec = YAML.load(data)
51
+ end
52
+ spec.validate
53
+ puts spec
54
+ puts "OK"
55
+ end
56
+
57
+ task :default => :spec
@@ -1,4 +1,4 @@
1
1
  ---
2
- :patch: 1
3
2
  :major: 1
4
- :minor: 0
3
+ :minor: 1
4
+ :patch: 0
@@ -0,0 +1,53 @@
1
+ use Rack::Session::Cookie
2
+
3
+ run lambda { |env|
4
+ request = Rack::Request.new env
5
+ response = Rack::Response.new
6
+ params = request.params
7
+ session = env['rack.session']
8
+ response.body = case request.path_info
9
+
10
+ when '/'
11
+ "You said #{ params['say'] || 'nothing' }"
12
+
13
+ when '/print-method'
14
+ request.request_method.downcase
15
+
16
+ when '/print-session'
17
+ session['session_variable'] = params['session_variable'] if params['session_variable']
18
+ session['session_variable']
19
+
20
+ when '/redirect'
21
+ response.headers['Location'] = params['to']
22
+ response.status = 302 # manually set!
23
+ ''
24
+
25
+ when '/relative'
26
+ response.headers['Location'] = '/i_am_relative'
27
+ response.status = 302 # manually set!
28
+ ''
29
+
30
+ when '/some_text'
31
+ "hello there, how goes it?"
32
+
33
+ when '/some_html'
34
+ %q{
35
+ <html>
36
+ <head></head>
37
+ <body>
38
+ <p id="this-one"></p>
39
+ <p id="bacon-one"></p>
40
+ <div id="chunky-one">
41
+ <b>chunky one</b>
42
+ <div></div>
43
+ </div>
44
+ </body>
45
+ </html>
46
+ }
47
+
48
+ else
49
+ "DON'T KNOW HOWTO RESPOND TO PATH: #{ request.path_info }"
50
+
51
+ end.to_s
52
+ response.finish
53
+ }
@@ -0,0 +1,2 @@
1
+ #! /bin/bash
2
+ spec --color spec/*/*_spec.rb
@@ -0,0 +1 @@
1
+ ../.shared_specs
@@ -0,0 +1,256 @@
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" templates
7
+ that are primarily responsible for inserting pre-built data in between HTML tags.
8
+ The model contains the "smart" domain objects (such as Account, Product, Person,
9
+ Post) that holds all the business logic and knows how to persist themselves to
10
+ a database. The controller handles the incoming requests (such as Save New Account,
11
+ Update Product, Show Post) by manipulating the model and directing data to the view.
12
+
13
+ In Rails, the model is handled by what's called an object-relational mapping
14
+ layer entitled Active Record. This layer allows you to present the data from
15
+ database rows as objects and embellish these data objects with business logic
16
+ methods. You can read more about Active Record in
17
+ link:files/vendor/rails/activerecord/README.html.
18
+
19
+ The controller and view are handled by the Action Pack, which handles both
20
+ layers by its two parts: Action View and Action Controller. These two layers
21
+ are bundled in a single package due to their heavy interdependence. This is
22
+ unlike the relationship between the Active Record and Action Pack that is much
23
+ more separate. Each of these packages can be used independently outside of
24
+ Rails. You can read more about Action Pack in
25
+ link:files/vendor/rails/actionpack/README.html.
26
+
27
+
28
+ == Getting Started
29
+
30
+ 1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
31
+ and your application name. Ex: rails myapp
32
+ 2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
33
+ 3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
34
+ 4. Follow the guidelines to start developing your application
35
+
36
+
37
+ == Web Servers
38
+
39
+ By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
40
+ Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
41
+ Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
42
+ that you can always get up and running quickly.
43
+
44
+ Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
45
+ suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
46
+ getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
47
+ More info at: http://mongrel.rubyforge.org
48
+
49
+ If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
50
+ Mongrel and WEBrick and also suited for production use, but requires additional
51
+ installation and currently only works well on OS X/Unix (Windows users are encouraged
52
+ to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
53
+ http://www.lighttpd.net.
54
+
55
+ And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
56
+ web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
57
+ for production.
58
+
59
+ But of course its also possible to run Rails on any platform that supports FCGI.
60
+ Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
61
+ please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
62
+
63
+
64
+ == Apache .htaccess example
65
+
66
+ # General Apache options
67
+ AddHandler fastcgi-script .fcgi
68
+ AddHandler cgi-script .cgi
69
+ Options +FollowSymLinks +ExecCGI
70
+
71
+ # If you don't want Rails to look in certain directories,
72
+ # use the following rewrite rules so that Apache won't rewrite certain requests
73
+ #
74
+ # Example:
75
+ # RewriteCond %{REQUEST_URI} ^/notrails.*
76
+ # RewriteRule .* - [L]
77
+
78
+ # Redirect all requests not available on the filesystem to Rails
79
+ # By default the cgi dispatcher is used which is very slow
80
+ #
81
+ # For better performance replace the dispatcher with the fastcgi one
82
+ #
83
+ # Example:
84
+ # RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
85
+ RewriteEngine On
86
+
87
+ # If your Rails application is accessed via an Alias directive,
88
+ # then you MUST also set the RewriteBase in this htaccess file.
89
+ #
90
+ # Example:
91
+ # Alias /myrailsapp /path/to/myrailsapp/public
92
+ # RewriteBase /myrailsapp
93
+
94
+ RewriteRule ^$ index.html [QSA]
95
+ RewriteRule ^([^.]+)$ $1.html [QSA]
96
+ RewriteCond %{REQUEST_FILENAME} !-f
97
+ RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
98
+
99
+ # In case Rails experiences terminal errors
100
+ # Instead of displaying this message you can supply a file here which will be rendered instead
101
+ #
102
+ # Example:
103
+ # ErrorDocument 500 /500.html
104
+
105
+ ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
106
+
107
+
108
+ == Debugging Rails
109
+
110
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
111
+ will help you debug it and get it back on the rails.
112
+
113
+ First area to check is the application log files. Have "tail -f" commands running
114
+ on the server.log and development.log. Rails will automatically display debugging
115
+ and runtime information to these files. Debugging info will also be shown in the
116
+ browser on requests from 127.0.0.1.
117
+
118
+ You can also log your own messages directly into the log file from your code using
119
+ the Ruby logger class from inside your controllers. Example:
120
+
121
+ class WeblogController < ActionController::Base
122
+ def destroy
123
+ @weblog = Weblog.find(params[:id])
124
+ @weblog.destroy
125
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
126
+ end
127
+ end
128
+
129
+ The result will be a message in your log file along the lines of:
130
+
131
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
132
+
133
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
134
+
135
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
136
+
137
+ * The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
138
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
139
+
140
+ These two online (and free) books will bring you up to speed on the Ruby language
141
+ and also on programming in general.
142
+
143
+
144
+ == Debugger
145
+
146
+ Debugger support is available through the debugger command when you start your Mongrel or
147
+ Webrick server with --debugger. This means that you can break out of execution at any point
148
+ in the code, investigate and change the model, AND then resume execution!
149
+ You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
150
+ Example:
151
+
152
+ class WeblogController < ActionController::Base
153
+ def index
154
+ @posts = Post.find(:all)
155
+ debugger
156
+ end
157
+ end
158
+
159
+ So the controller will accept the action, run the first line, then present you
160
+ with a IRB prompt in the server window. Here you can do things like:
161
+
162
+ >> @posts.inspect
163
+ => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
164
+ #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
165
+ >> @posts.first.title = "hello from a debugger"
166
+ => "hello from a debugger"
167
+
168
+ ...and even better is that you can examine how your runtime objects actually work:
169
+
170
+ >> f = @posts.first
171
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
172
+ >> f.
173
+ Display all 152 possibilities? (y or n)
174
+
175
+ Finally, when you're ready to resume execution, you enter "cont"
176
+
177
+
178
+ == Console
179
+
180
+ You can interact with the domain model by starting the console through <tt>script/console</tt>.
181
+ Here you'll have all parts of the application configured, just like it is when the
182
+ application is running. You can inspect domain models, change values, and save to the
183
+ database. Starting the script without arguments will launch it in the development environment.
184
+ Passing an argument will specify a different environment, like <tt>script/console production</tt>.
185
+
186
+ To reload your controllers and models after launching the console run <tt>reload!</tt>
187
+
188
+ == dbconsole
189
+
190
+ You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
191
+ You would be connected to the database with the credentials defined in database.yml.
192
+ Starting the script without arguments will connect you to the development database. Passing an
193
+ argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
194
+ Currently works for mysql, postgresql and sqlite.
195
+
196
+ == Description of Contents
197
+
198
+ app
199
+ Holds all the code that's specific to this particular application.
200
+
201
+ app/controllers
202
+ Holds controllers that should be named like weblogs_controller.rb for
203
+ automated URL mapping. All controllers should descend from ApplicationController
204
+ which itself descends from ActionController::Base.
205
+
206
+ app/models
207
+ Holds models that should be named like post.rb.
208
+ Most models will descend from ActiveRecord::Base.
209
+
210
+ app/views
211
+ Holds the template files for the view that should be named like
212
+ weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
213
+ syntax.
214
+
215
+ app/views/layouts
216
+ Holds the template files for layouts to be used with views. This models the common
217
+ header/footer method of wrapping views. In your views, define a layout using the
218
+ <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
219
+ call <% yield %> to render the view using this layout.
220
+
221
+ app/helpers
222
+ Holds view helpers that should be named like weblogs_helper.rb. These are generated
223
+ for you automatically when using script/generate for controllers. Helpers can be used to
224
+ wrap functionality for your views into methods.
225
+
226
+ config
227
+ Configuration files for the Rails environment, the routing map, the database, and other dependencies.
228
+
229
+ db
230
+ Contains the database schema in schema.rb. db/migrate contains all
231
+ the sequence of Migrations for your schema.
232
+
233
+ doc
234
+ This directory is where your application documentation will be stored when generated
235
+ using <tt>rake doc:app</tt>
236
+
237
+ lib
238
+ Application specific libraries. Basically, any kind of custom code that doesn't
239
+ belong under controllers, models, or helpers. This directory is in the load path.
240
+
241
+ public
242
+ The directory available for the web server. Contains subdirectories for images, stylesheets,
243
+ and javascripts. Also contains the dispatchers and the default HTML files. This should be
244
+ set as the DOCUMENT_ROOT of your web server.
245
+
246
+ script
247
+ Helper scripts for automation and generation.
248
+
249
+ test
250
+ Unit and functional tests along with fixtures. When using the script/generate scripts, template
251
+ test files will be generated for you and placed in this directory.
252
+
253
+ vendor
254
+ External libraries that the application depends on. Also includes the plugins subdirectory.
255
+ If the app has frozen rails, those gems also go here, under vendor/rails/.
256
+ This directory is in the load path.
@@ -0,0 +1,10 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require(File.join(File.dirname(__FILE__), 'config', 'boot'))
5
+
6
+ require 'rake'
7
+ require 'rake/testtask'
8
+ require 'rake/rdoctask'
9
+
10
+ require 'tasks/rails'
@@ -0,0 +1,15 @@
1
+ # Filters added to this controller apply to all controllers in the application.
2
+ # Likewise, all the methods added will be available for all controllers.
3
+
4
+ class ApplicationController < ActionController::Base
5
+ helper :all # include all helpers, all the time
6
+
7
+ # See ActionController::RequestForgeryProtection for details
8
+ # Uncomment the :secret if you're not using the cookie session store
9
+ protect_from_forgery # :secret => '1a02857159f22076b23409627bb4457b'
10
+
11
+ # See ActionController::Base for details
12
+ # Uncomment this to filter the contents of submitted sensitive data parameters
13
+ # from your application log (in this case, all fields with names like "password").
14
+ # filter_parameter_logging :password
15
+ end
@@ -0,0 +1,32 @@
1
+ class WelcomeController < ApplicationController
2
+
3
+ def index
4
+ render :text => "You said #{ params[:say] || 'nothing' }"
5
+ end
6
+
7
+ def print_method
8
+ render :text => request.method
9
+ end
10
+
11
+ def print_session
12
+ session[:session_variable] = params[:session_variable] if params[:session_variable]
13
+ render :text => session[:session_variable].to_s
14
+ end
15
+
16
+ def redirect
17
+ redirect_to params[:to]
18
+ end
19
+
20
+ def some_text
21
+ render :text => "well hello there \n how goes it? \n does it go well?"
22
+ end
23
+
24
+ def some_html
25
+ # render template
26
+ end
27
+
28
+ def relative
29
+ redirect_to '/i_am_relative'
30
+ end
31
+
32
+ end