scribbler 0.1.1 → 0.1.2

data/{README.markdown → README.md}

@@ -23,14 +23,28 @@ to your Gemfile and
 
 Then
 
-    rake scribbler:install # THIS DOESN'T WORK YET
+    scribbler install # For options do `scribbler` first
 
 You'll find your configuration options in `config/initializers/scribbler.rb`.
+**Better, more documented examples in the template file provided by `scribbler install`**
 As an example, with this configuration file in a Rails app called `Blogger`:
 
     Scribbler::Base.configure do
       config.application_include = true
+
+      # config.log_directory = File.new '/a/better/path'
+
       config.logs = %w[production delayed_job]
+
+      config.use_template_by_default = true # Default: false
+
+      # config.template = proc do |options|
+      #   <<-MSG
+      #   ##########
+      #   Cool template bro!
+      #   Message: #{options[:message]}
+      #   MSG
+      # end
     end
 
 You are given a few methods for free. To get the production logfile location:
@@ -62,8 +76,25 @@ More importantly you're given access to a sweet `log` method:
     Blogger.log File.expand_path(File.join(File.dirname(__FILE__), 'logfile.log')), :message => "#{e} broke stuff"
     Scribbler::Base.log File.expand_path(File.join(File.dirname(__FILE__), 'logfile.log')), :message => "#{e} broke stuff"
 
+Log options with the default template proc:
+
+    options   - Hash of options for logging on Ngin
+              :error            - Error object, mostly for passing to NewRelic
+              :message          - Message to log in the actual file [REQUIRED]
+              :custom_fields    - Custom fields dropped into the default template
+              :template         - Whether or not to use the template at this log
+              :new_relic        - Notify NewRelic of the error (default: true)
+
+With the template enabled (either during call to log [:template => true] or by setting to
+be used by default) you will have each log entry wrapped into a template to pretty-up and
+get some more boilerplate data. As you can see in the config above. See method
+docs and specs for more information.
+
 ## Todo
 
-* More options in configure
-* Make block available in log method for better extensibility
+* Configure the module/class receiving the include
+* Configurable notification gem (NewRelic, Airbrake, etc.)
 * Currently attempts to notify NewRelic if its there, abstract and allow custom services
+* Allow a class to set default options for a log call within itself
+* Allow there to be a log made without the option[:message], in case its all custom_fields or someting
+* Allow event hooks on log call?

data/lib/scribbler/base.rb

@@ -102,7 +102,8 @@ module Scribbler
     # Returns Nothing.
     def self.log(location, options={})
       options = {
-        :template => config.use_template_by_default
+        :template => config.use_template_by_default,
+        :stack_frame => options[:call_stack] ? Kernel.caller[1..-1] : nil
       }.merge options
       begin
         NewRelic::Agent.notice_error(options[:error]) if options[:error] and options[:new_relic] != false
@@ -160,13 +161,21 @@ module Scribbler
     #
     # Returns Nothing
     def self.apply_to_log(location, options={})
-      if location.present? and options[:message].present?
-        log = File.open(find_file_at(location), 'a')
-        log.puts build_with_template(options)
-        log.close
+      if can_apply_to_log? location, options
+        File.open(find_file_at(location), 'a') do |f|
+          f.puts build_with_template(options)
+        end
       end
     end
 
+    # TODO: Fix to work with any template
+    def self.can_apply_to_log?(location, options)
+      location.present? and
+        (options[:message].present? or
+         options[:object].present? or
+         options[:custom_fields].present?)
+    end
+
     # Attempts to turn a symbol or string into the *_log_location method that
     # was auto-build based on Configurator.logs and finds the file path
     #
@@ -182,12 +191,14 @@ module Scribbler
     #   # => :another_file    # The method `another_file_log_location` does not exist
     #
     # Returns Nothing
-    #
-    # TODO: allow the log base directory to be set in configurator
     def self.find_file_at(location)
       if location.is_a?(Symbol) or location.is_a?(String)
         real_method = location.to_s + "_log_location"
-        location = respond_to?(real_method) ? send(real_method) : location.to_s
+        if respond_to?(real_method)
+          location = send(real_method)
+        else
+          location = "#{config.log_directory.to_s}/#{location.to_s}"
+        end
       end
       location
     end

data/lib/scribbler/configurator.rb

@@ -135,7 +135,11 @@ module Scribbler
         template << "#{Time.now}\n"
         template << "#{options[:object].class.name}: #{if_id}\n" if options[:object]
         template << "#{custom_fields}\n" if custom_fields.present?
-        template << "#{options[:message]}\n\n"
+        template << "#{options[:message]}\n"
+        template << "Call Stack:\n#{options[:stack_frame].join("\n")}" if options[:call_stack]
+        template << "\n"
+
+        template
       end
     end
   end

data/lib/scribbler/version.rb

@@ -1,3 +1,3 @@
 module Scribbler
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/scribbler/base_spec.rb

@@ -58,17 +58,17 @@ module Scribbler
       end
 
       it "calls log, skips templater and still works" do
-        Scribbler::Base.send(:build_with_template,
+        subject.send(:build_with_template,
                              :object => some_object,
                              :template => false,
                              :message => "test\n123").should == "test\n123"
       end
 
       it "calls log and gets message with template wrapper" do
-        Scribbler::Base.send(:build_with_template,
-                             :object => some_object,
-                             :template => true,
-                             :message => <<-MSG
+        subject.send(:build_with_template,
+                     :template => true,
+                     :object => some_object,
+                     :message => <<-MSG
         test
         123
         MSG
@@ -83,11 +83,11 @@ module Scribbler
       end
 
       it "calls log and gets message with custom params" do
-        Scribbler::Base.send(:build_with_template,
-                             :template => true,
-                             :object => some_object,
-                             :custom_fields => {:test1 => 1, :test2 => 2},
-                             :message => <<-MSG
+        subject.send(:build_with_template,
+                     :template => true,
+                     :object => some_object,
+                     :custom_fields => {:test1 => 1, :test2 => 2},
+                     :message => <<-MSG
         test
         123
         MSG
@@ -122,12 +122,10 @@ module Scribbler
 
       it "should build a template and try to put it in a file" do
         options = { :message => "..." }
-        subject.should_receive(:send).with "test_log_log_location"
+        file = mock(:puts => true)
         subject.should_receive(:build_with_template).with options
-        file_stub = stub
-        file_stub.should_receive :puts
-        file_stub.should_receive :close
-        File.should_receive(:open) { file_stub }
+        subject.should_receive(:send).with "test_log_log_location"
+        File.should_receive(:open).and_yield(file)
         subject.apply_to_log :test_log, options
       end
     end
@@ -137,7 +135,7 @@ module Scribbler
         # in case we have bad config data lingering
         subject.stub(:respond_to?).with('test_log_log_location').and_return false
         subject.should_not_receive(:test_log_log_location)
-        subject.find_file_at(:test_log).should == 'test_log'
+        subject.find_file_at(:test_log).should == "#{Dir.pwd}/log/test_log"
       end
 
       it "finds a file method defined" do

data/spec/scribbler/configurator_spec.rb

@@ -31,10 +31,9 @@ module Scribbler
       end
 
       it "falls back to pwd/log without rails" do
-        dir = "dir/"
+        subject.log_directory = nil #RESET
         Rails.should_receive(:root).and_raise(NameError)
-        Dir.should_receive(:pwd).and_return('dir')
-        subject.log_directory.should == 'dir/log'
+        subject.log_directory.should == "#{Dir.pwd}/log"
       end
 
       it "sets the log directory" do

data/spec/spec_helper.rb

@@ -18,9 +18,7 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.color = true
   config.after(:all) do # Force a reset of some Classes
-    project_dir = ENV['BUNDLE_GEMFILE'].split('/')
-    project_dir.delete_at(-1)
-    project_dir = project_dir.join('/')
+    project_dir = File.expand_path('../..', __FILE__)
     singletons.each do |s|
       Scribbler.send(:remove_const, s)
       load "#{project_dir}/lib/scribbler/#{s.downcase}.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scribbler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -104,7 +104,7 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
-- README.markdown
+- README.md
 - Rakefile
 - bin/scribbler
 - lib/scribbler.rb
@@ -140,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4412993880917242240
+      hash: 1839906776393005062
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4412993880917242240
+      hash: 1839906776393005062
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24