flowerbox 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # Flowerbox
 
-TODO: Write a gem description
+Flowerbox gives you pretty log output for debugging rails applications
 
 ## Installation
 
@@ -18,7 +18,32 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Flowerbox extends ActiveSupport::BufferedLogger with the method #flowerbox
+
+It logs the inspected arguments at info loglevel along with the file and line where it was called.
+
+```ruby
+logger.flowerbox([], {})
+```
+
+```
+================================================================================
+/Users/ehrenmurdick/projects/flowerbox/test.rb:29:in `block (2 levels) in <top (required)>'
+--------------------------------------------------------------------------------
+[]
+--------------------------------------------------------------------------------
+{}
+================================================================================
+```
+
+
+By default flowerbox only outputs in the log in development mode. To enable it in test or any other environment, create
+config/initializers/flowerbox.rb and add
+
+```ruby
+Flowerbox.enable("test")
+```
+
 
 ## Contributing
 

data/lib/flowerbox/version.rb

@@ -1,3 +1,3 @@
 module Flowerbox
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/flowerbox.rb

@@ -1,20 +1,26 @@
 require "flowerbox/version"
 
 module Flowerbox
-  if Rails.env == "development"
-    def flowerbox *objs
-      info "=" * 80
-      info caller[1]
-      objs.each do |o|
-        info "-" * 80
-        info o.inspect
+  def flowerbox *objs
+  end
+
+  def self.enable(env)
+    if Rails.env == env
+      class_eval do
+        def flowerbox *objs
+          info "=" * 80
+          info caller[1]
+          objs.each do |o|
+            info "-" * 80
+            info o.inspect
+          end
+          info "=" * 80
+        end
       end
-      info "=" * 80
-    end
-  else
-    def flowerbox *objs
     end
   end
+
+  enable "development"
 end
 
 ActiveSupport::BufferedLogger.send(:include, Flowerbox)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flowerbox
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -56,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3855520414111520791
+      hash: 1705221955776818042
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3855520414111520791
+      hash: 1705221955776818042
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24