scribbler 0.2.3 → 0.3.0

data/lib/scribbler/version.rb

@@ -1,3 +1,3 @@
 module Scribbler
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/scribbler.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'awesome_print'
+  gem.add_development_dependency 'simplecov'
 end

data/spec/lib/scribbler/base_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module Scribbler
+  describe Base do
+    subject { described_class }
+
+    describe "configure" do
+      it "sets some config variables" do
+        subject.configure do
+          config.application_include = true
+        end
+        subject.config.application_include.should be_true
+      end
+    end
+  end
+end

data/spec/{scribbler/cli_spec.rb → lib/scribbler/cli_client_spec.rb}

@@ -1,8 +1,7 @@
 require 'spec_helper'
 
 module Scribbler
-  describe CLI do
-    subject { CLI }
+  describe CLIClient do
     let(:cp_command) { 'cp x y' }
     describe '.run_command' do
       it 'calls backtick command with output' do
@@ -21,15 +20,16 @@ module Scribbler
     describe '.say' do
       it 'calls puts wth the param' do
         subject.should_receive(:puts).with("Boom")
-        subject.say "Boom"
+        subject.send :say, "Boom"
       end
     end
 
     describe '.mass_copy' do
       let(:file_list) { ["/tmp/fake_file_1", "/tmp/fake_file 2"] }
       let(:destination) { "/tmp/destination" }
+      let(:out_definitions) { subject.send :out_definitions }
       it "copies all the files to the destination" do
-        subject.should_receive(:output).with('cp').once
+        subject.should_receive(:say).with(out_definitions['cp']).once
         subject.should_receive(:run_command).with("cp #{file_list[0]} #{destination}", :output => false).once
         subject.should_receive(:run_command).with("cp #{file_list[1]} #{destination}", :output => false).once
         subject.mass_copy file_list, destination

data/spec/{scribbler → lib/scribbler}/configurator_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
+module Rails; end
 module Scribbler
   describe Configurator do
-    subject { Configurator }
     describe "logs" do
       it "lets me set logs" do
         new_logs = %w{1 2}
@@ -22,11 +22,22 @@ module Scribbler
       end
     end
 
+    describe "default template" do
+      its(:template) { should be_a Proc }
+    end
+
     describe "log directory" do
+      let(:root_stub) { double }
+      before do
+        Rails.stub :root => root_stub
+      end
+
+      after do
+        Rails.rspec_reset
+      end
+
       it "tries a rails root when Rails defined" do
-        root_stub = stub
         root_stub.should_receive(:join).with 'log'
-        Rails = stub(:root => root_stub)
         subject.log_directory
       end
 

data/spec/lib/scribbler/executable_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Scribbler
+  describe Executable do
+    its(:cli) { should be_a CLIClient }
+    describe "stubbed CLI Client" do
+      let(:cli) { double }
+      let(:config) { Scribbler.config }
+      before do
+        subject.stub cli: cli
+      end
+      describe '.install' do
+        it 'runs some CLI commands' do
+          cli.should_receive(:run_command).with("mkdir -p #{config.default_install_path}")
+          cli.should_receive(:mass_copy).with(config.templates, config.default_install_path)
+          subject.install
+        end
+
+        let(:custom_path) { '/some/custom/path' }
+        it 'runs changes install path with given option' do
+          cli.should_receive(:run_command).with("mkdir -p #{custom_path}")
+          cli.should_receive(:mass_copy).with(config.templates, custom_path)
+          subject.install :path => custom_path
+        end
+      end
+    end
+  end
+end

data/spec/lib/scribbler/includeables_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+module Scribbler
+  class IncludedTest
+    include Includeables
+  end
+
+  describe IncludedTest do
+    subject { IncludedTest }
+    it { should respond_to :subseason_log_location }
+    it { should respond_to :production_log_location }
+    it { should respond_to :trees_log_location }
+
+    its(:subseason_log_location) { should be_a Pathname }
+
+    it "can call log_at manually" do
+      subject.log_at(:subseason).should be_a Pathname
+    end
+
+    it "logs via Logger" do
+      Logger.should_receive :log
+      subject.log :location, {}
+    end
+  end
+end

data/spec/lib/scribbler/log_location_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+module Scribbler
+  describe LogLocation do
+    its(:config) { should be_a Configurator }
+
+    it "builds a basic path" do
+      relative_path = subject.find_path(:subseason).to_s.split("/")[-3..-1].join("/")
+      relative_path.should == "scribbler/log/subseason.log"
+    end
+  end
+end

data/spec/lib/scribbler/logger_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+module ::Rails; end
+module ::NewRelic
+  module Agent; end
+end
+module Scribbler
+  describe Logger do
+    describe "class" do
+      subject { Logger }
+
+      it { should respond_to :log }
+
+      it "instantiates and uses instance #log" do
+        Logger.any_instance.should_receive(:log).once
+        subject.log(:location)
+      end
+    end
+
+    describe "instance" do
+      subject { Logger.new location, options }
+      let(:location) { nil }
+      let(:options) { {} }
+      let(:file) { double puts: true }
+      before do
+        Time.stub :now => "now"
+        File.stub(:open).and_yield(file)
+      end
+
+      describe "instantiation" do
+        its(:location) { should be_nil }
+        its(:options) { should == { template: false, stack_frame: nil } }
+      end
+
+      describe "log" do
+        let(:options) { { message: "fail", error: "Lots of fails", new_relic: true } }
+        before do
+          subject.should_receive(:apply_to_log).once
+        end
+
+        describe "with newrelic" do
+          before do
+            ::NewRelic::Agent.should_receive(:notice_error).with(options[:error]).once
+          end
+
+          its(:log) { should be_nil }
+        end
+
+        describe "without newrelic" do
+          before do
+            ::NewRelic::Agent.stub(:notice_error) do
+              raise NameError
+            end
+          end
+
+          its(:log) { should be_nil }
+        end
+
+        describe "newrelic set to off" do
+          let(:options) { { message: "fail", error: "Lots of fails", new_relic: false } }
+          before do
+            ::NewRelic::Agent.should_not_receive(:notice_error)
+          end
+        end
+
+        describe "no error, new relic on" do
+          let(:options) { { message: "fail", new_relic: true } }
+          before do
+            ::NewRelic::Agent.should_not_receive(:notice_error)
+          end
+        end
+      end
+
+      describe "apply to log" do
+        before do
+          Scribbler.configure do |config|
+            config.logs = %w[test_log]
+          end
+        end
+
+        after do
+          Scribbler.instance_variable_set "@config", nil
+        end
+
+        describe "nil file" do
+          let(:file) { double puts: nil }
+          it "should not work without location" do
+            subject.send(:apply_to_log).should be_nil
+          end
+        end
+
+        describe "no message" do
+          let(:file) { double puts: nil }
+          it "should not work without message" do
+            subject.should_not_receive :test_log_log_location
+            subject.stub location: :test_log
+            subject.send(:apply_to_log).should be_nil
+          end
+        end
+
+        it "should build a template and try to put it in a file" do
+          subject.stub location: :test_log, options: { message: "..." }
+          subject.send :apply_to_log
+        end
+      end
+
+      describe "build with template" do
+        let(:some_object) { stub(:id => "no id", :class => stub(:name => "SomeObject")) }
+        before :each do
+          Scribbler.configure do |config|
+            config.application_include = false
+          end
+        end
+
+        after :each do
+          Scribbler.instance_variable_set "@config", nil
+        end
+
+        it "calls log, skips templater and still works" do
+          subject.stub options: {
+            object: some_object,
+            template: false,
+            message: "test\n123"
+          }
+
+          subject.send(:build_with_template).should == "test\n123"
+        end
+
+        it "calls log and gets message with template wrapper" do
+          subject.stub options: {
+            template: true,
+            object: some_object,
+            message: <<-MSG
+        test
+        123
+            MSG
+          }
+          subject.send(:build_with_template).should == <<-MSG.strip_heredoc
+        -------------------------------------------------
+        now
+        SomeObject: no id
+        test
+        123
+
+          MSG
+        end
+
+        it "calls log and gets message with custom params" do
+          subject.stub options: {
+            template: true,
+            object: some_object,
+            custom_fields: { test1: 1, test2: 2 },
+            message: <<-MSG
+        test
+        123
+            MSG
+          }
+          subject.send(:build_with_template).should == <<-MSG.strip_heredoc
+        -------------------------------------------------
+        now
+        SomeObject: no id
+        Test1: 1
+        Test2: 2
+        test
+        123
+
+          MSG
+        end
+      end
+    end
+  end
+end

data/spec/lib/scribbler_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+describe Scribbler do
+  subject { Scribbler }
+
+  before do
+    Object.send :remove_const, :Rails if defined?(Rails) == 'constant' && Rails.class == Class
+    Time.stub :now => "now"
+  end
+
+  it "should give me a configurator" do
+    subject.config.should be_a Scribbler::Configurator
+  end
+
+  describe "include_in_application" do
+    it "should attempt to include to the Rails app" do
+      module ::Rails; end
+      ::Rails.stub(:application => stub(:class => stub(:parent => stub(:send => true))))
+      subject.stub(:config => stub(:application_include => true))
+      subject.include_in_application.should be_true
+    end
+
+    it "should return nil because it caught the NameError of Rails not existing" do
+      subject.stub(:config => stub(:application_include => true))
+      subject.include_in_application.should be_nil
+    end
+
+    it "should not attempt to include in app if config is false" do
+      subject.stub(:config => stub(:application_include => false))
+      subject.include_in_application.should be_nil
+    end
+  end
+
+  describe "configure" do
+    it "kicks off the module and sends includes" do
+      subject.should_receive(:include_in_application).once
+      subject.configure do
+      end
+    end
+
+    it "sets some config variables" do
+      subject.configure do |config|
+        config.application_include = true
+      end
+      subject.config.application_include.should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,11 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 require 'scribbler'
 require 'ap'
 require 'active_support/inflector'
@@ -11,17 +16,10 @@ require 'active_support/concern'
 Dir.glob(File.expand_path('../support/lib/**/*.rb', __FILE__)).each { |file| require file }
 include SpecUtils
 
-singletons = %w[Base CLI Configurator Executable]
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.color = true
-  config.after(:all) do # Force a reset of some Classes
-    project_dir = File.expand_path('../..', __FILE__)
-    singletons.each do |s|
-      Scribbler.send(:remove_const, s)
-      load "#{project_dir}/lib/scribbler/#{s.downcase}.rb"
-    end
-  end
+  config.order = 'random'
 end

data/spec/support/examples/scribbler_example.rb

@@ -1,4 +1,4 @@
-Scribbler::Base.configure do
+Scribbler.configure do |config|
   # This is like the Rails configure. This is actually a #class_eval.
   # Unless you'd like to experiment with breaking things and battling dragons,
   # please only use what we document here.

data/templates/scribbler.rb

@@ -1,4 +1,4 @@
-Scribbler::Base.configure do
+Scribbler.configure do |config|
   # This is like the Rails configure. This is actually a #class_eval.
   # Unless you'd like to experiment with breaking things and battling dragons,
   # please only use what we document here.
@@ -27,14 +27,14 @@ Scribbler::Base.configure do
   # DO PLX FIX                                        #
   #
   # If you would rather this not be default you may set this to false. Keep
-  # in mind, there is an option on the Base.log to enable or disable the
+  # in mind, there is an option on the Scribbler.log to enable or disable the
   # template on a per-call basis. (:template)
   #
   # config.use_template_by_default = true # Default: false
   #
   #
   # Don't like the default template above? Write your own proc here.
-  # The proc is given the options hash that you give to Base.log so you're
+  # The proc is given the options hash that you give to Scribbler.log so you're
   # given plenty of control over what information you have to work with.
   #
   # options   - Hash of options for logging on Ngin

metadata

@@ -1,96 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: scribbler
 version: !ruby/object:Gem::Version
-  version: 0.2.3
   prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Jon Phenow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  type: :development
 description: ''
 email:
 - jon.phenow@tstmedia.com
@@ -100,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .irbrc
 - .rvmrc
 - .travis.yml
 - Gemfile
@@ -109,19 +126,23 @@ files:
 - bin/scribbler
 - lib/scribbler.rb
 - lib/scribbler/base.rb
-- lib/scribbler/cli.rb
+- lib/scribbler/cli_client.rb
 - lib/scribbler/configurator.rb
 - lib/scribbler/executable.rb
 - lib/scribbler/includeables.rb
+- lib/scribbler/log_location.rb
+- lib/scribbler/logger.rb
 - lib/scribbler/version.rb
 - scribbler.gemspec
-- spec/scribbler/base_spec.rb
-- spec/scribbler/cli_spec.rb
-- spec/scribbler/configurator_spec.rb
-- spec/scribbler/executable_spec.rb
-- spec/scribbler/includeables_spec.rb
-- spec/scribbler/version_spec.rb
-- spec/scribbler_spec.rb
+- spec/lib/scribbler/base_spec.rb
+- spec/lib/scribbler/cli_client_spec.rb
+- spec/lib/scribbler/configurator_spec.rb
+- spec/lib/scribbler/executable_spec.rb
+- spec/lib/scribbler/includeables_spec.rb
+- spec/lib/scribbler/log_location_spec.rb
+- spec/lib/scribbler/logger_spec.rb
+- spec/lib/scribbler/version_spec.rb
+- spec/lib/scribbler_spec.rb
 - spec/spec_helper.rb
 - spec/support/examples/scribbler_example.rb
 - spec/support/lib/spec_utils.rb
@@ -133,23 +154,23 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: -3735178954186904383
-required_rubygems_version: !ruby/object:Gem::Requirement
+      hash: 1283107986408181274
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: -3735178954186904383
+      hash: 1283107986408181274
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -157,13 +178,15 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
-- spec/scribbler/base_spec.rb
-- spec/scribbler/cli_spec.rb
-- spec/scribbler/configurator_spec.rb
-- spec/scribbler/executable_spec.rb
-- spec/scribbler/includeables_spec.rb
-- spec/scribbler/version_spec.rb
-- spec/scribbler_spec.rb
+- spec/lib/scribbler/base_spec.rb
+- spec/lib/scribbler/cli_client_spec.rb
+- spec/lib/scribbler/configurator_spec.rb
+- spec/lib/scribbler/executable_spec.rb
+- spec/lib/scribbler/includeables_spec.rb
+- spec/lib/scribbler/log_location_spec.rb
+- spec/lib/scribbler/logger_spec.rb
+- spec/lib/scribbler/version_spec.rb
+- spec/lib/scribbler_spec.rb
 - spec/spec_helper.rb
 - spec/support/examples/scribbler_example.rb
 - spec/support/lib/spec_utils.rb