yarder 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.md +87 -0
  3. data/Rakefile +38 -0
  4. data/lib/tasks/yarder_tasks.rake +4 -0
  5. data/lib/yarder.rb +15 -0
  6. data/lib/yarder/action_controller/log_subscriber.rb +74 -0
  7. data/lib/yarder/action_view/log_subscriber.rb +31 -0
  8. data/lib/yarder/active_record/log_subscriber.rb +75 -0
  9. data/lib/yarder/active_resource/log_subscriber.rb +34 -0
  10. data/lib/yarder/configuration.rb +8 -0
  11. data/lib/yarder/core_ext/object/blank.rb +105 -0
  12. data/lib/yarder/logger.rb +55 -0
  13. data/lib/yarder/rack/logger.rb +72 -0
  14. data/lib/yarder/railtie.rb +69 -0
  15. data/lib/yarder/tagged_logging.rb +102 -0
  16. data/lib/yarder/version.rb +3 -0
  17. data/test/action_controller/log_subscriber_test.rb +165 -0
  18. data/test/action_view/log_subscriber_test.rb +89 -0
  19. data/test/active_record/log_subscriber_test.rb +87 -0
  20. data/test/active_resource/log_subscriber_test.rb +42 -0
  21. data/test/dummy/README.rdoc +261 -0
  22. data/test/dummy/Rakefile +7 -0
  23. data/test/dummy/app/assets/javascripts/application.js +13 -0
  24. data/test/dummy/app/assets/javascripts/widgets.js +2 -0
  25. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  26. data/test/dummy/app/assets/stylesheets/scaffold.css +56 -0
  27. data/test/dummy/app/assets/stylesheets/widgets.css +4 -0
  28. data/test/dummy/app/controllers/application_controller.rb +3 -0
  29. data/test/dummy/app/controllers/log_subscriber_controller.rb +56 -0
  30. data/test/dummy/app/controllers/widgets_controller.rb +83 -0
  31. data/test/dummy/app/helpers/application_helper.rb +2 -0
  32. data/test/dummy/app/helpers/widgets_helper.rb +2 -0
  33. data/test/dummy/app/models/widget.rb +3 -0
  34. data/test/dummy/app/views/customers/_customer.html.erb +1 -0
  35. data/test/dummy/app/views/good_customers/_good_customer.html.erb +1 -0
  36. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  37. data/test/dummy/app/views/test/_customer.erb +1 -0
  38. data/test/dummy/app/views/test/hello_world.erb +1 -0
  39. data/test/dummy/app/views/widgets/_form.html.erb +17 -0
  40. data/test/dummy/app/views/widgets/edit.html.erb +6 -0
  41. data/test/dummy/app/views/widgets/index.html.erb +21 -0
  42. data/test/dummy/app/views/widgets/new.html.erb +5 -0
  43. data/test/dummy/app/views/widgets/show.html.erb +5 -0
  44. data/test/dummy/config.ru +4 -0
  45. data/test/dummy/config/application.rb +69 -0
  46. data/test/dummy/config/boot.rb +10 -0
  47. data/test/dummy/config/database.yml +22 -0
  48. data/test/dummy/config/environment.rb +5 -0
  49. data/test/dummy/config/environments/development.rb +31 -0
  50. data/test/dummy/config/environments/production.rb +64 -0
  51. data/test/dummy/config/environments/test.rb +35 -0
  52. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  53. data/test/dummy/config/initializers/inflections.rb +15 -0
  54. data/test/dummy/config/initializers/mime_types.rb +5 -0
  55. data/test/dummy/config/initializers/secret_token.rb +7 -0
  56. data/test/dummy/config/initializers/session_store.rb +8 -0
  57. data/test/dummy/config/initializers/wrap_parameters.rb +10 -0
  58. data/test/dummy/config/locales/en.yml +5 -0
  59. data/test/dummy/config/routes.rb +69 -0
  60. data/test/dummy/db/migrate/20120927084605_create_widgets.rb +8 -0
  61. data/test/dummy/db/schema.rb +16 -0
  62. data/test/dummy/log/development.log +19 -0
  63. data/test/dummy/log/test.log +10694 -0
  64. data/test/dummy/public/404.html +26 -0
  65. data/test/dummy/public/422.html +26 -0
  66. data/test/dummy/public/500.html +25 -0
  67. data/test/dummy/public/favicon.ico +0 -0
  68. data/test/dummy/script/rails +6 -0
  69. data/test/logger_test.rb +126 -0
  70. data/test/rack/logger_test.rb +68 -0
  71. data/test/support/fake_models.rb +12 -0
  72. data/test/support/integration_case.rb +5 -0
  73. data/test/support/multibyte_test_helpers.rb +19 -0
  74. data/test/tagged_logging_test.rb +155 -0
  75. data/test/test_helper.rb +31 -0
  76. data/test/yarder_test.rb +7 -0
  77. metadata +236 -0
@@ -0,0 +1,89 @@
1
+ require "active_support/log_subscriber/test_helper"
2
+ require "test_helper"
3
+
4
+ class AVLogSubscriberTest < ActiveSupport::TestCase
5
+ include ActiveSupport::LogSubscriber::TestHelper
6
+
7
+ def setup
8
+ super
9
+ view_paths = ActionController::Base.view_paths
10
+ lookup_context = ActionView::LookupContext.new(view_paths, {}, ["test"])
11
+ renderer = ActionView::Renderer.new(lookup_context)
12
+ @view = ActionView::Base.new(renderer, {})
13
+ Yarder::ActionView::LogSubscriber.attach_to :action_view
14
+ Yarder.log_entries[Thread.current] = LogStash::Event.new
15
+ @log_entry = Yarder.log_entries[Thread.current]
16
+ end
17
+
18
+ def teardown
19
+ super
20
+ ActiveSupport::LogSubscriber.log_subscribers.clear
21
+ end
22
+
23
+ def test_mandatory_fields_present
24
+ @view.render(:file => "test/hello_world")
25
+ wait
26
+
27
+ assert_present @log_entry.fields['rendering']
28
+ assert_present @log_entry.fields['rendering'].first['duration']
29
+ end
30
+
31
+ def test_render_file_template
32
+ @view.render(:file => "test/hello_world")
33
+ wait
34
+
35
+ assert_equal("test/hello_world.erb", @log_entry.fields['rendering'].first['identifier'])
36
+ end
37
+
38
+ def test_render_text_template
39
+ @view.render(:text => "TEXT")
40
+ wait
41
+
42
+ assert_equal("text template", @log_entry.fields['rendering'].first['identifier'])
43
+ end
44
+
45
+ def test_render_inline_template
46
+ @view.render(:inline => "<%= 'TEXT' %>")
47
+ wait
48
+
49
+ assert_equal("inline template", @log_entry.fields['rendering'].first['identifier'])
50
+ end
51
+
52
+ def test_render_partial_template
53
+ @view.render(:partial => "test/customer")
54
+ wait
55
+
56
+ assert_equal("test/_customer.erb", @log_entry.fields['rendering'].first['identifier'])
57
+ end
58
+
59
+ def test_render_partial_with_implicit_path
60
+ @view.render(Customer.new("david"), :greeting => "hi")
61
+ wait
62
+
63
+ assert_equal("customers/_customer.html.erb", @log_entry.fields['rendering'].first['identifier'])
64
+ end
65
+
66
+ def test_render_collection_template
67
+ @view.render(:partial => "test/customer", :collection => [ Customer.new("david"), Customer.new("mary") ])
68
+ wait
69
+
70
+ assert_equal("test/_customer.erb", @log_entry.fields['rendering'].first['identifier'])
71
+ end
72
+
73
+ def test_render_collection_with_implicit_path
74
+ @view.render([ Customer.new("david"), Customer.new("mary") ], :greeting => "hi")
75
+ wait
76
+
77
+ assert_equal("customers/_customer.html.erb", @log_entry.fields['rendering'].first['identifier'])
78
+ end
79
+
80
+ def test_render_collection_template_without_path
81
+ @view.render([ GoodCustomer.new("david"), Customer.new("mary") ], :greeting => "hi")
82
+ wait
83
+
84
+ assert_equal("collection", @log_entry.fields['rendering'].first['identifier'])
85
+ end
86
+
87
+ #TODO Add tests regarding layout
88
+
89
+ end
@@ -0,0 +1,87 @@
1
+ require "active_support/log_subscriber/test_helper"
2
+ require "test_helper"
3
+
4
+ class ARecordLogSubscriberTest < ActiveSupport::TestCase
5
+ include ActiveSupport::LogSubscriber::TestHelper
6
+
7
+ def setup
8
+ super
9
+ Widget.create
10
+ Yarder::ActiveRecord::LogSubscriber.attach_to :active_record
11
+ Yarder.log_entries[Thread.current] = LogStash::Event.new
12
+ @log_entry = Yarder.log_entries[Thread.current]
13
+ end
14
+
15
+ # TODO
16
+ #def test_schema_statements_are_ignored
17
+ #end
18
+
19
+ def test_mandatory_fields_present
20
+ Widget.find(1)
21
+ wait
22
+ assert_present @log_entry.fields['sql']
23
+ assert_present @log_entry.fields['sql'].first['duration']
24
+ end
25
+
26
+ def test_sql_fields_present
27
+ Widget.find(1)
28
+ wait
29
+
30
+ assert_present sql_entry['name']
31
+ assert_present sql_entry['sql']
32
+ assert sql_entry['duration'].to_f >= 0, "sql_duration was not a positive number"
33
+ end
34
+
35
+ def test_basic_query_logging
36
+ Widget.all
37
+ wait
38
+
39
+ assert_equal 'Widget Load', sql_entry['name']
40
+ assert_match /SELECT .*?FROM .?widgets.?/i, sql_entry['sql']
41
+ end
42
+
43
+ def test_exists_query_logging
44
+ Widget.exists? 1
45
+ wait
46
+ assert_equal 'Widget Exists', sql_entry['name']
47
+ assert_match /SELECT .*?FROM .?widgets.?/i, sql_entry['sql']
48
+ end
49
+
50
+
51
+ def test_cached_queries
52
+ ActiveRecord::Base.cache do
53
+ Widget.all
54
+ Widget.all
55
+ end
56
+ wait
57
+ assert_equal 'CACHE', sql_entry['name']
58
+ assert_match /SELECT .*?FROM .?widgets.?/i, sql_entry['sql']
59
+ end
60
+
61
+ =begin
62
+ #TODO Get these done when the new logger is written
63
+ def test_basic_query_doesnt_log_when_level_is_not_debug
64
+ @logger.level = Logger::INFO
65
+ Widget.all
66
+ wait
67
+ assert_blank @log_entry.fields['sql']
68
+ end
69
+
70
+
71
+ def test_cached_queries_doesnt_log_when_level_is_not_debug
72
+ @logger.level = INFO
73
+ ActiveRecord::Base.cache do
74
+ Widget.all
75
+ Widget.all
76
+ end
77
+ wait
78
+ assert_blank @log_entry.fields['sql']
79
+ end
80
+ =end
81
+ private
82
+
83
+ def sql_entry
84
+ @sql_entry ||= @log_entry.fields['sql'].last
85
+ end
86
+
87
+ end
@@ -0,0 +1,42 @@
1
+ require "active_support/log_subscriber/test_helper"
2
+ require "active_support/core_ext/hash/conversions"
3
+
4
+ class Person < ActiveResource::Base
5
+ self.site = "http://37s.sunrise.i:3000"
6
+ end
7
+
8
+ class AResourceLogSubscriberTest < ActiveSupport::TestCase
9
+ include ActiveSupport::LogSubscriber::TestHelper
10
+
11
+ def setup
12
+ super
13
+
14
+ @matz = { :person => { :id => 1, :name => 'Matz' } }.to_json
15
+ ActiveResource::HttpMock.respond_to do |mock|
16
+ mock.get "/people/1.json", {}, @matz
17
+ end
18
+
19
+ Yarder::ActiveResource::LogSubscriber.attach_to :active_resource
20
+ Yarder.log_entries[Thread.current] = LogStash::Event.new
21
+ @log_entry = Yarder.log_entries[Thread.current]
22
+ end
23
+
24
+ def test_mandatory_fields_present
25
+ Person.find(1)
26
+ wait
27
+ assert_present @log_entry.fields['active_resource']
28
+ assert_present @log_entry.fields['active_resource'].first['duration']
29
+ end
30
+
31
+ def test_request_notification
32
+ Person.find(1)
33
+ wait
34
+
35
+ assert_equal "GET", @log_entry.fields['active_resource'].first['method']
36
+ assert_equal "http://37s.sunrise.i:3000/people/1.json", @log_entry.fields['active_resource'].first['uri']
37
+ assert_equal 200, @log_entry.fields['active_resource'].first['code']
38
+ assert_equal "200", @log_entry.fields['active_resource'].first['message']
39
+ assert_equal 33, @log_entry.fields['active_resource'].first['length']
40
+ end
41
+
42
+ 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.