letters 0.2.7 → 0.3.0

data/README.md

@@ -307,4 +307,14 @@ The `o` method takes options, too, so you can add a prefix message to the output
   </tr>
 </table>
 
-See full documentation at http://lettersrb.com/api
+See the [full documentation](http://lettersrb.com/api) for examples and more detailed explanations.
+
+### Configuration ###
+
+Lastly, you can tune and tweak each Letters method to default to your own tastes. Want to name put files somewhere else? No problem. Don't like YAML? Default `f` to use Pretty Print instead! The world of defaults is your oyster.
+
+```ruby
+Letters.config do
+  f :format => "pp", :name => "my-special-file"
+end
+```

data/lib/letters/config.rb

@@ -0,0 +1,44 @@
+require "letters/assertion_error"
+
+module Letters
+  def self.defaults
+    defaults = {
+      a: { error_class: Letters::AssertionError },
+      d1: { dup: false },
+      d2: { format: "ap" },
+      f: { format: "yaml", name: "log" },
+      k: { max: 0 },
+      l: { level: "info", format: "yaml" },
+      o: { format: "ap", stream: $stdout },
+      t: { time_format: "millis" }
+    }
+
+    defaults.tap do |hash|
+      hash.default_proc = lambda {|h, k| h[k] = Hash.new }
+    end
+  end
+
+  def self.user_defaults
+    @user_defaults ||= Hash.new {|h, k| h[k] = Hash.new }
+  end
+
+  def self.defaults_with(letter, opts={})
+    defaults[letter].merge(user_defaults[letter]).merge(opts)
+  end
+
+  def self.reset_config!
+    user_defaults.clear
+  end
+
+  def self.config(&block)
+    Letters::Config.class_eval(&block)
+  end
+
+  module Config
+    ("a".."z").each do |letter|
+      define_singleton_method(letter) do |opts={}|
+        Letters.user_defaults[letter.to_sym] = opts
+      end
+    end
+  end
+end

data/lib/letters/core_ext.rb

@@ -1,10 +1,10 @@
+require "letters/config"
 require "letters/helpers"
 require "letters/diff"
-require "letters/assertion_error"
+require "letters/time_formats"
 require "letters/empty_error"
 require "letters/kill_error"
 require "letters/nil_error"
-require "letters/time_formats"
 
 module Letters
   module CoreExt
@@ -12,7 +12,7 @@ module Letters
 
     # Assert
     def a(opts={}, &block)
-      opts = { error_class: AssertionError }.merge opts
+      opts = Letters.defaults_with(:a, opts)
       tap do |o|
         Helpers.message opts
         if block_given? && !o.instance_eval(&block)
@@ -52,8 +52,7 @@ module Letters
 
     # Diff 2
     def d2(opts={})
-      require "awesome_print"
-      opts = { format: "ap" }.merge opts
+      opts = Letters.defaults_with(:d2, opts)
       tap do |o|
         diff = Helpers.diff(Letters.object_for_diff, o)
         Helpers.message opts
@@ -73,7 +72,7 @@ module Letters
 
     # File
     def f(opts={})
-      opts = { format: "yaml", name: "log" }.merge opts
+      opts = Letters.defaults_with(:f, opts)
       tap do |o|
         suffixes = [""] + (1..50).to_a
         deduper = suffixes.detect {|x| !File.directory? "#{opts[:name]}#{x}" }
@@ -96,7 +95,7 @@ module Letters
 
     # Kill
     def k(opts={})
-      opts = { max: 0 }.merge(opts)
+      opts = Letters.defaults_with(:k, opts)
       opts.merge! :error_class => KillError
       tap do |o|
         @letters_kill_count ||= 0
@@ -109,7 +108,7 @@ module Letters
 
     # Log
     def l(opts={})
-      opts = { level: "info", format: "yaml" }.merge opts
+      opts = Letters.defaults_with(:l, opts)
       tap do |o|
         begin
           logger.send(opts[:level], opts[:message]) if opts[:message]
@@ -141,7 +140,7 @@ module Letters
 
     # Print to STDOUT
     def o(opts={}, &block)
-      opts = { format: "ap", stream: $stdout }.merge opts
+      opts = Letters.defaults_with(:o, opts)
       tap do |o|
         Helpers.message opts
         obj = block_given? ? o.instance_eval(&block) : o 
@@ -167,7 +166,7 @@ module Letters
 
     # Timestamp
     def t(opts={})
-      opts = { time_format: "millis" }.merge opts
+      opts = Letters.defaults_with(:t, opts)
       tap do
         Helpers.message opts
         Helpers.out Time.now.to_s(opts[:time_format].to_sym), opts

data/lib/letters/version.rb

@@ -1,3 +1,3 @@
 module Letters
-  VERSION = "0.2.7"
+  VERSION = "0.3.0"
 end

data/spec/letters/config_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+module Letters
+  describe "configuration" do
+    let(:hash) { { a: "b" } }
+
+    before do
+      Letters.config do
+        f :format => "pp"
+      end
+      File.exist?("log").should be_false
+    end
+
+    after do
+      FileUtils.rm "log"
+    end
+
+    describe ".config" do
+      it "allows default argument configuration" do
+        hash.f
+        File.read("log").should == hash.pretty_inspect
+      end
+    end
+
+    describe ".reset_config!" do
+      it "clears out the config hash" do
+        Letters.reset_config!
+        hash.f
+        File.read("log").should == hash.to_yaml
+      end
+    end
+  end
+end

data/spec/letters/core_ext_spec.rb

@@ -152,7 +152,7 @@ module Letters
       end
 
       it 'does not raises if number of calls are below max' do
-        lambda{ hash.k(max: 1) }.should_not raise_error
+        lambda { hash.k(max: 1) }.should_not raise_error
       end
 
       it 'raises a KillError if number of calls is above max' do

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 require "letters"
 require "awesome_print"
 require "timecop"
+require "fileutils"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: letters
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-10-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70220468145960 !ruby/object:Gem::Requirement
+  requirement: &70172816319040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70220468145960
+  version_requirements: *70172816319040
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70220468145520 !ruby/object:Gem::Requirement
+  requirement: &70172816318600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70220468145520
+  version_requirements: *70172816318600
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &70220468145100 !ruby/object:Gem::Requirement
+  requirement: &70172816318180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70220468145100
+  version_requirements: *70172816318180
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70220468144680 !ruby/object:Gem::Requirement
+  requirement: &70172816317760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70220468144680
+  version_requirements: *70172816317760
 - !ruby/object:Gem::Dependency
   name: debugger
-  requirement: &70220468144260 !ruby/object:Gem::Requirement
+  requirement: &70172816317340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70220468144260
+  version_requirements: *70172816317340
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70220468143840 !ruby/object:Gem::Requirement
+  requirement: &70172816316920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220468143840
+  version_requirements: *70172816316920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70220468143420 !ruby/object:Gem::Requirement
+  requirement: &70172816316500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70220468143420
+  version_requirements: *70172816316500
 description: Letters brings Ruby debugging into the 21st century. It leverages print,
   the debugger, control transfer, even computer beeps to let you see into your code's
   state.
@@ -97,6 +97,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/letters/assertion_error.rb
+- lib/letters/config.rb
 - lib/letters/core_ext.rb
 - lib/letters/diff.rb
 - lib/letters/empty_error.rb
@@ -113,6 +114,7 @@ files:
 - README.md
 - COPYING
 - Gemfile
+- spec/letters/config_spec.rb
 - spec/letters/core_ext_spec.rb
 - spec/letters/helpers_spec.rb
 - spec/letters/patch/core_spec.rb
@@ -145,6 +147,7 @@ signing_key:
 specification_version: 3
 summary: A tiny debugging library for Ruby
 test_files:
+- spec/letters/config_spec.rb
 - spec/letters/core_ext_spec.rb
 - spec/letters/helpers_spec.rb
 - spec/letters/patch/core_spec.rb