treefell 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa7207780fff940842ef702f33321ad8e07fff43
-  data.tar.gz: 4b7c5f201aa20cfed884557d3c5fac5f6ba26dff
+  metadata.gz: ebeb16ac49693f30536f49f3bf7de672c83d8ebd
+  data.tar.gz: fab978b8ea55f12886bef500dc405bdaec51e6dd
 SHA512:
-  metadata.gz: 180419544eea4e9eb0d3047000b3740c63618014ce33587cf9f0080efecc72c3ea33d1a3909f1e8f20339c7d826ab57b53891d7ac844e075fc24c0ff8715e809
-  data.tar.gz: 04cd2b4f0bcee70945b4cb4c808e685dcab9ba49e950495889ce031bfa4d361392370cd976f4a606aa8925cd73e53d5cb1b1ee97c234ac899c50523cd7e39d00
+  metadata.gz: dd51cc55d02e9f3dc966ce7990fca5fe8de0014209a9dd91fc61311b9353a7d9eef3b982a22b4090d3533aa408c66ef3c21a3151b41c2f29fe1ce93ecd7e880d
+  data.tar.gz: 479759a67145d4cbd0c46f354b1d92aaa7a9ef2bda799ddbf433f35962a5ce45ae72bc2482dcd18c0623443b7153060cc8c0220523621cacc8908837b371f932

data/README.md

@@ -1,6 +1,10 @@
 # Treefell [![Build Status](https://travis-ci.org/zdennis/treefell.svg?branch=master)](https://travis-ci.org/zdennis/treefell)
 
-Treefell is a simple debug-logging library for ruby.
+> If a tree falls in a forest and no one is around to hear it, does it make a sound?
+
+Treefell is a minimalist debug-logging library for ruby. It uses the DEBUG environment variable to determine which debug messages are logged and which are suppressed.
+
+This project was inspired by visionmedia's [debug](https://github.com/visionmedia/debug) library for nodejs. 
 
 ## Installation
 
@@ -18,7 +22,76 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Take the ruby program:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'treefell'
+
+foo_debug = Treefell['foo']
+foo_debug.puts 'too funky in here'
+
+bar_debug = Treefell['bar']
+bar_debug.puts 'you got that right'
+
+baz_debug = Treefell['baz']
+baz_debug.puts 'say it again'
+```
+
+Each call to `Treefell['...']` instantiates a `DebugLogger` for the provided
+namespace (e.g. foo, bar, baz).
+
+By default no debug log statements are displayed:
+
+```
+> ruby program.rb
+```
+
+### Displaying all messages
+
+You can tell it to display all messages with the wildcard `*`:
+
+![Example 1 Screenshot](/examples/example_1.png?raw=true)
+
+### Displaying messages from a particular namespace
+
+Here's how to display messages for one specific debugging namespace:
+
+![Example 2 Screenshot](/examples/example_2.png?raw=true)
+
+### Displaying messages for multiple namespaces
+
+To display messages from multiple namespaces use a comma-separated list of
+namespaces:
+
+![Example 3 Screenshot](/examples/example_3.png?raw=true)
+
+### Colored output
+
+Every namespace gets a color associated with it to aide in the visual parsing
+of the output. Also `DebugLogger`(s) are cached per namespace so regardless
+of when you refer to the namespace it will always have the same color
+associated with it.
+
+E.g.
+
+```ruby
+foo_debug = Treefell['foo']
+other_foo_debug = Treefell['foo']
+
+foo_debug.eql?(other_foo_debug) # => true
+```
+
+#### Sending to IO other than STDOUT
+
+By default all messages are written to `STDOUT`. You can change this by
+instantiating a debug logger using the `debug` method, e.g.:
+
+```ruby
+foo_debug = Treefell.debug('foo', io: some_io)
+foo_debug.puts 'Get up offa that thing, and dance till you feel better'
+```
 
 ## Contributing
 

data/examples/program.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'treefell'
+
+foo_debug = Treefell['foo']
+foo_debug.puts 'too funky in here'
+
+bar_debug = Treefell['bar']
+bar_debug.puts 'you got that right'
+
+baz_debug = Treefell['baz']
+baz_debug.puts 'say it again'

data/lib/treefell/debug_logger.rb

@@ -12,6 +12,15 @@ module Treefell
       @filter = filter || DEFAULT_FILTER_PROC
     end
 
+    def [](sub_namespace)
+      @debug_loggers ||= {}
+      @debug_loggers[sub_namespace] ||= DebugLogger.new(
+        namespace: sub_namespace,
+        io: self,
+        filter: DEFAULT_FILTER_PROC
+      )
+    end
+
     def puts(message)
       if @filter.call(namespace, message)
         formatted_namespace = if namespace

data/lib/treefell/filters/env_filter.rb

@@ -1,11 +1,11 @@
 module Treefell
   module Filters
     class EnvFilter
-      ENV_VAR_KEY = 'DEBUG'
-      ENV_VAR_LOOKUP = -> { ENV[ENV_VAR_KEY] }
+      NAMESPACE_ENV_VAR_KEY = 'DEBUG'
+      NAMESPACE_ENV_VAR_LOOKUP = -> { ENV[NAMESPACE_ENV_VAR_KEY] }
       WILDCARD = '*'
 
-      def initialize(value: ENV_VAR_LOOKUP)
+      def initialize(value: NAMESPACE_ENV_VAR_LOOKUP)
         @value_proc = value
       end
 

data/lib/treefell/version.rb

@@ -1,3 +1,3 @@
 module Treefell
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/treefell.rb

@@ -5,18 +5,28 @@ require 'treefell/debug_logger'
 require 'treefell/filters/env_filter'
 
 module Treefell
-  ENV_VAR_LOOKUP = -> { ENV[Treefell.env_var] }
+  NAMESPACE_ENV_VAR_LOOKUP = -> { ENV[Treefell.namespace_env_var] }
 
-  def self.env_var=(env_var)
-    @env_var = env_var
+  def self.namespace_env_var=(namespace_env_var)
+    @namespace_env_var = namespace_env_var
   end
 
-  def self.env_var
-    @env_var || Filters::EnvFilter::ENV_VAR_KEY
+  def self.namespace_env_var
+    @namespace_env_var || Filters::EnvFilter::NAMESPACE_ENV_VAR_KEY
   end
 
-  def self.debug(namespace=nil, io: $stdout, filter: nil)
-    filter ||= Filters::EnvFilter.new(value: ENV_VAR_LOOKUP)
+  def self.debug(namespace=nil, io: nil, filter: nil)
+    io ||= begin
+      treefell_out = ENV['TREEFELL_OUT']
+      if treefell_out
+        @treefell_out_io ||= File.open(treefell_out, 'w+').tap do |io|
+          io.sync = true
+        end
+      else
+        $stdout
+      end
+    end
+    filter ||= Filters::EnvFilter.new(value: NAMESPACE_ENV_VAR_LOOKUP)
     @debug_loggers ||= {}
     @debug_loggers[namespace] ||= DebugLogger.new(
       namespace: namespace,
@@ -26,8 +36,12 @@ module Treefell
   end
 
   def self.reset
+    if @treefell_out_io
+      @treefell_out_io.close unless @treefell_out_io.closed?
+      @treefell_out_io = nil
+    end
     @debug_loggers.clear if @debug_loggers
-    @env_var = nil
+    @namespace_env_var = nil
   end
 
   def self.[](namespace)

data/treefell.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
+  s.add_dependency "ansi_string", "~> 0.1"
   s.add_dependency "term-ansicolor", "~> 1.3"
   s.add_development_dependency 'rspec', '~> 3.4.0', '>= 3.4'
   s.add_development_dependency 'climate_control', '~> 0.0.3'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: treefell
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Zach Dennis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-08 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ansi_string
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- examples/example_1.png
+- examples/example_2.png
+- examples/example_3.png
+- examples/program.rb
 - lib/tasks/gem.rake
 - lib/treefell.rb
 - lib/treefell/color.rb
@@ -93,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Treefell is a simple debug-logging library for ruby