logvisible 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0911f3db7fce87a3ef925f836f650e54a11d53e4
+  data.tar.gz: 6910f13e8ba87b1c33ad91d9a642db19cb2faaa1
+SHA512:
+  metadata.gz: cc648687b272bd14f03c53d2c4e47bcf07b6e47007fc32a9c9e44b002fc7abde85550ab6f51896f10e213027fdbbcd76cbfa094a5721fc25926a8d75a7602418
+  data.tar.gz: cd10dfceb8102cfd51f953efec71d36653e37227db18e62731cdbdedb857934bc563876c32df15f1f9de96b066c34eca31c4a574f1c7d6762697c0bfc7440ce2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logvisible.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Olson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,137 @@
+# Logvisible
+
+Easy visible logging for Rails!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'logvisible'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logvisible
+
+## Usage
+
+If you're using Rails, Logvisible will default to using Rails.logger. 
+If you're not using Rails, or you'd like to use a different logger:
+
+```ruby
+my_logger = Logger.new('/var/log/my_log')
+
+Logvisible.configure do |c|
+  c.logger = my_logger
+end
+```
+
+Logvisible exposes two methods that make visible logging easy.
+
+`logvisible`, which takes a string and a hash of options and wraps it in a separator. 
+Default separator is "\n".
+
+Options
+
+  * `:sep` The string with which to wrap your log statement. Default: "\n"
+  * `:level` The log level. One of :debug, :info, :warn, :error, or :fatal. Default: :debug
+  * `:text` Text options. A hash, containing these optional keys: :color, :style
+    * `:color` Color of the text. One of :black, :red, :green, :yellow, :blue, :magenta, :cyan, or :white
+    * `:style` Style of the text. One of :bold, :underline, or :inverse
+
+
+`logvisible_location`, also takes a string and a hash of options, but creates a tagged 
+log containing the class and method where it is called.
+
+Options
+
+  * `:location` The specific string with which your log statement will be tagged. Default: "ClassName#method_name"
+  * `:additional_tag` Additional string to be appended to the tag. Default: ''
+  * `:level` The log level. One of :debug, :info, :warn, :error, or :fatal. Default: :debug
+  * `:text` Text options. A hash, containing these optional keys: :color, :style
+    * `:color` Color of the text. One of :black, :red, :green, :yellow, :blue, :magenta, :cyan, or :white
+    * `:style` Style of the text. One of :bold, :underline, or :inverse
+
+Within models, views, or controllers at the class or instance level scope, toss these methods around!
+
+```ruby
+class Foo < ActiveRecord::Base
+
+  class << self
+    def with_status(status)
+      logvisible status
+      where(status: status)
+    end
+  end
+
+  def foo
+    # ...
+    logvisible "variable x: #{x.inspect}", text: { style: :inverse, color: :cyan }
+  end
+
+  def bar
+    logvisible_location "Tracking the status of account_balance: #{account_balance.inspect}", text: { style: :bold, color: :blue }
+    # Some complex calculations ...
+    logvisible_location "Tracking the status of account_balance: #{account_balance.inspect}", text: { style: :bold, color: :blue }
+  end
+
+  def baz
+    logvisible_location "Tracking the status of account_balance: #{account_balance.inspect}", text: { style: :bold, color: :blue }
+  end
+end
+```
+
+Works in controllers:
+
+```ruby
+class FooController < ApplicationController
+  def index
+    logvisible_location "params: #{params.inspect}", text: { style: :bold, color: :green }
+    @foos = Foo.with_status params[:status]
+  end
+end
+```
+
+Works in views:
+
+```ruby
+.foos_index
+  .foos_container
+    - logvisible @foos.inspect
+```
+
+Inside service objects, or any POROs that fall outside the Rails framework, use `Rails` as an explicit receiver:
+
+```ruby
+class SomeServiceObj
+  def foo
+    # ...
+    Rails.logvisible "variable x: #{x.inspect}", text: { style: :underline, color: :red }
+  end
+end
+```
+
+Stave off arthritis for a good 8 months: stop typing:
+
+```ruby
+logger.debug("\n\n\n#{value}\n\n\n")
+```
+
+and start using logvisible!
+
+```ruby
+logvisible value
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/logvisible.rb

@@ -0,0 +1,20 @@
+require 'logvisible/version'
+require 'logvisible/settings'
+require 'logvisible/log_methods'
+require 'logvisible/railtie' if defined? Rails
+
+module Logvisible
+  class << self
+    def configure(&block)
+      yield settings
+    end
+
+    def settings
+      @settings ||= Settings.new
+    end
+
+    def logger
+      settings.logger || Rails.logger
+    end
+  end
+end

data/lib/logvisible/log_methods.rb

@@ -0,0 +1,96 @@
+module Logvisible
+  module LogMethods
+    LOG_LEVELS = [
+      :debug,
+      :info,
+      :warn,
+      :error,
+      :fatal
+    ]
+
+    STYLES = {
+      bold:      "\e[1m",
+      underline: "\e[4m",
+      inverse:   "\e[7m"
+    }
+
+    COLORS = {
+      black:   "\e[30m",
+      red:     "\e[31m",
+      green:   "\e[32m",
+      yellow:  "\e[33m",
+      blue:    "\e[34m",
+      magenta: "\e[35m",
+      cyan:    "\e[36m",
+      white:   "\e[37m"
+    }
+
+    RESET = "\e[0m"
+
+    def self.included(base)
+      base.extend self
+    end
+
+    def logvisible(string, opts={})
+      opts  = { sep: "\n", level: :debug }.merge opts
+      level = _validate_log_level opts[:level]
+      sep   = opts[:sep].to_s * 5
+      msg   = sep + string.to_s + sep
+      _decorate!(msg, opts[:text]) if opts[:text]
+      logger.send level, msg
+    end
+
+    # Decorates messages passed to Rails' TaggedLogger
+    def logvisible_location(msg, opts={})
+      return logvisible(msg, opts) unless logger.respond_to? :tagged
+      opts = { location: find_logvisible_location, additional_tag: '', level: :debug }.merge opts
+      tag  = opts[:location].to_s + opts[:additional_tag].to_s
+      _decorate! tag, opts[:text] if opts[:text]
+      _decorate! msg, opts[:text] if opts[:text]
+      logger.tagged(tag) do
+        logvisible msg, { sep: '', level: opts[:level] }
+      end
+    end
+
+    private
+
+    def logger
+      Logvisible.logger
+    end
+
+    def find_logvisible_location
+      match    = caller[1].match(/`(\w+)'/)
+      method   = match ? match.captures.first : ''
+      location = Class == self.class ? self.name : "#{self.class.name}##{method}"
+    end
+
+    def _decorate!(string, opts={})
+      style = _get_styles opts[:style]
+      color = _get_color opts[:color]
+      string.insert(0, color)
+      string.insert(0, style)
+      string.insert(-1, _reset!) if string.start_with? "\e["
+    end
+
+    def _reset!
+      RESET
+    end
+
+    def _get_styles(style)
+      if style.is_a? Array
+        style.inject('') { |str, s| str += STYLES[s].to_s }
+      else
+        STYLES[style].to_s
+      end
+    end
+
+    def _get_color(color)
+      COLORS[color].to_s
+    end
+
+    def _validate_log_level(level)
+      level = :debug unless LOG_LEVELS.include? level
+      level
+    end
+  end
+end

data/lib/logvisible/railtie.rb

@@ -0,0 +1,8 @@
+module Logvisible
+  class Railtie < Rails::Railtie
+    Rails.extend Logvisible::LogMethods
+    [:action_controller, :active_record, :action_view].each do |framework|
+      ActiveSupport.on_load(framework) { include LogMethods }
+    end
+  end
+end

data/lib/logvisible/settings.rb

@@ -0,0 +1,6 @@
+module Logvisible
+  class Settings
+    attr_accessor :logger
+
+  end
+end

data/lib/logvisible/version.rb

@@ -0,0 +1,3 @@
+module Logvisible
+  VERSION = "0.0.1"
+end

data/logvisible.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logvisible/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logvisible"
+  spec.version       = Logvisible::VERSION
+  spec.authors       = ["Dan Olson"]
+  spec.email         = ["daniel.olson@code42.com"]
+  spec.description   = %q{Create easy to see log statements for debugging in Rails applications}
+  spec.summary       = %q{Easy visible logging for Rails!}
+  spec.homepage      = "https://github.com/code42/logvisible"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+end

data/spec/lib/logvisible/log_methods_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+module Logvisible
+  describe LogMethods do
+    let(:logger){ stub }
+    let(:foo) do
+      Class.new do
+        include Logvisible::LogMethods
+      end
+    end
+
+    before do
+      Logvisible.configure do |c|
+        c.logger = logger
+      end
+    end
+
+    describe '#logvisible' do
+
+      it 'surrounds the given input with newlines' do
+        logger.should_receive(:send).with(:debug, "\n\n\n\n\nfoobar\n\n\n\n\n")
+        foo.logvisible 'foobar'
+      end
+
+      it 'accepts a :sep option' do
+        logger.should_receive(:send).with(:debug, '$$$$$foobar$$$$$')
+        foo.logvisible 'foobar', sep: '$'
+      end
+
+      it 'accepts a :level option' do
+        logger.should_receive(:send).with(:fatal, '$$$$$foobar$$$$$')
+        foo.logvisible 'foobar', level: :fatal, sep: '$'
+      end
+
+      it 'calls #to_s on the first argument' do
+        arg = Object.new
+        logger.should_receive(:send).with(:debug, "\n\n\n\n\n#{arg.to_s}\n\n\n\n\n")
+        foo.logvisible arg
+      end
+
+      describe 'the :text option' do
+        describe 'color support' do
+          it 'supports blue' do
+            logger.should_receive(:send).with(:debug, "\e[34m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { color: :blue }
+          end
+
+          it 'supports red' do
+            logger.should_receive(:send).with(:debug, "\e[31m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { color: :red }
+          end
+
+          it 'supports yellow' do
+            logger.should_receive(:send).with(:debug, "\e[33m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { color: :yellow }
+          end
+
+          it 'supports green' do
+            logger.should_receive(:send).with(:debug, "\e[32m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { color: :green }
+          end
+
+          it 'supports magenta' do
+            logger.should_receive(:send).with(:debug, "\e[35m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { color: :magenta }
+          end
+
+          it 'supports cyan' do
+            logger.should_receive(:send).with(:debug, "\e[36m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { color: :cyan }
+          end
+
+          it "doesn't support puce" do
+            logger.should_receive(:send).with(:debug, "\n\n\n\n\nfoobar\n\n\n\n\n")
+            foo.logvisible 'foobar', text: { color: :puce }
+          end
+        end
+
+        describe 'style support' do
+          it 'supports bold' do
+            logger.should_receive(:send).with(:debug, "\e[1m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { style: :bold }
+          end
+
+          it 'supports underline' do
+            logger.should_receive(:send).with(:debug, "\e[4m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { style: :underline }
+          end
+
+          it 'supports inverse' do
+            logger.should_receive(:send).with(:debug, "\e[7m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { style: :inverse }
+          end
+
+          it "doesn't support foobar" do
+            logger.should_receive(:send).with(:debug, "\n\n\n\n\nfoobar\n\n\n\n\n")
+            foo.logvisible 'foobar', text: { style: :foobar }
+          end
+
+          it 'supports multiple styles' do
+            logger.should_receive(:send).with(:debug, "\e[7m\e[1m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { style: [:inverse, :bold] }
+          end
+
+          it 'rejects invalid styles' do
+            logger.should_receive(:send).with(:debug, "\e[7m\n\n\n\n\nfoobar\n\n\n\n\n\e[0m")
+            foo.logvisible 'foobar', text: { style: [:inverse, :foobar] }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/logvisible_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Logvisible do
+  describe 'configuration' do
+    it 'accepts a logger' do
+      logger = stub
+      Logvisible.configure do |c|
+        c.logger = logger
+      end
+
+      Logvisible.logger.should == logger
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'logvisible'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: logvisible
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: Create easy to see log statements for debugging in Rails applications
+email:
+- daniel.olson@code42.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logvisible.rb
+- lib/logvisible/log_methods.rb
+- lib/logvisible/railtie.rb
+- lib/logvisible/settings.rb
+- lib/logvisible/version.rb
+- logvisible.gemspec
+- spec/lib/logvisible/log_methods_spec.rb
+- spec/lib/logvisible_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/code42/logvisible
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Easy visible logging for Rails!
+test_files:
+- spec/lib/logvisible/log_methods_spec.rb
+- spec/lib/logvisible_spec.rb
+- spec/spec_helper.rb