clog 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kevin Swope
+
+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.rdoc

@@ -0,0 +1,17 @@
+= clog
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kevin Swope. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    summary = "Little rails debugging gem for writing colorized output to log file"
+    gem.name = "clog"
+    gem.summary = summary
+    gem.description = summary
+    gem.email = "gems-kevdev@snkmail.com"
+    gem.homepage = "http://github.com/kswope/clog"
+    gem.authors = ["Kevin Swope"]
+    gem.add_dependency('term-ansicolor')    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "build README.html from README.doc (for previewing in browser)"
+task :readme do
+  system "rdoc README.rdoc --one-file > README.html"
+end
+
+task :default => :test
+task :test => [:test_default, :test_rails2x, :test_rails3x]
+
+require 'rake/testtask'
+Rake::TestTask.new(:test_default) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test_clog.rb'
+  test.verbose = true
+end
+
+task :test_rails2x do |t|
+  chdir "test/rails2x_root" do
+    system "rake"
+  end
+end
+
+task :test_rails3x do |t|
+  chdir "test/rails3x_root" do
+    system "rake"
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,5 @@
+
+# NOTE: this file is for rails 2x only
+
+require "clog"
+

data/lib/clog.rb

@@ -0,0 +1,145 @@
+require 'term/ansicolor'
+
+class Clog
+
+  @@foreground = :white
+  @@background = :red
+  @@maxwidth = 100 # max length before putting caller location on next line
+
+  #### change default color
+  def self.colors(bg, fg=nil)
+    @@background = bg
+    @@foreground = fg if fg
+  end
+
+  #### change default maxwidth
+  def self.maxwidth(max)
+    @@maxwidth = max
+  end
+
+  class << self
+
+    def clog(*args)
+
+      # write to appopriate stream
+      if defined?(Rails.logger)
+        Rails.logger.debug(message(*args))
+      else # probably just for testing
+        puts message(*args)
+      end
+
+    end
+
+    #### Generate string to be logged
+    def message(*args)
+
+      if args.size == 0 # flag
+        flag + leftloc
+      elsif args.size == 1 # single argument
+        if too_long_for_leftloc(args, leftloc)
+          "#{args[0].inspect}\n#{uploc}"
+        else
+          "#{args[0].inspect}#{leftloc}"
+        end
+      elsif args.size == 2 && args[0].class == Symbol # symbol + single argument
+        #symbol = colorize(args[0].to_s + ':')
+        if too_long_for_leftloc(args, leftloc)
+          "#{args[0]}: #{args[1].inspect}\n#{uploc}"
+        else
+          "#{args[0]}: #{args[1].inspect}#{leftloc}"
+        end
+      else # multiple args, each gets its own line
+        str = args.inject(''){|str, x| str << "#{x.inspect}\n"}
+        "#{str}#{uploc}"
+      end
+
+    end
+
+    private # ~*~*~*~*~
+
+    include Term::ANSIColor
+
+    #### Decide which loc is best
+    def too_long_for_leftloc(args, lloc)
+
+      # figure out length sum of arguments
+      length = args.inject(0) {|sum,x| sum+=  x.inspect.length }
+
+      # hello there, kludge - have to strip off color escape codes to size lloc
+      lloc = lloc.gsub(/\e\[(?:[34][0-7]|[0-9])?m/, '')
+
+      length += lloc.length
+
+      length > @@maxwidth
+      
+    end
+
+    #### colored get_caller_str preceeded with "\n^^^"
+    def uploc
+      colorize("^^^ " + get_caller_str)
+    end
+
+    #### colored get_caller_str preceeded with "<---"
+    def leftloc
+      " " + colorize(" <--- " + get_caller_str)
+    end
+
+    #### Munged Kernel#caller output
+    def get_caller_str
+
+      #(caller(2)[0])[/\/app\/(.*$)/, 1]
+      call = caller(5).first
+
+      # Don't like the format of Kernel#caller, lets parse and reassemble
+      # output (the hexcodes are here because the characters messed up my
+      # editors colors)
+      match = call.match /^(.*?):(\d+):in \x60(.*)\x27/ 
+
+      path = match[1]
+      line = match[2]
+      func = match[3]
+
+      # try to remove Rails.root from path
+      #path[Rails.root.to_s] = "" if defined?(Rails.root)
+      path.gsub!(/#{Rails.root}\//, '') if defined?(Rails.root)
+       
+      #path.gsub!(/#{RAILS_ROOT}\//, '') if defined? RAILS_ROOT
+
+      "#{path}:#{line} #{func}()"
+
+    end
+
+    #### Note: bolded black forground looks greyish, white background looks
+    #### greyish, but everything else bolded looks good - that is why this
+    #### method has conditionals
+    def colorize(txt)
+      str = ""
+      str << bold unless @@foreground == :black
+      str << send("on_#{@@background}") unless @@background == :white
+      str << send(@@foreground)
+      str << txt 
+      str << reset
+    end
+
+    #### Oh, say can you see...
+    def flag
+      flag = ""
+      flag << "#{bold}#{on_blue}#{white}*#{reset}" * 3
+      flag << "#{bold}#{on_red}#{white}=#{reset}" * 6
+    end
+
+  end # class << self
+
+end # class
+
+
+class Object
+
+  private # make private so clog can only be called naked
+
+  def clog(*args)
+    Clog.clog(*args)
+  end
+
+end
+

data/self.gemspec

@@ -0,0 +1,101 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{clog}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kevin Swope"]
+  s.date = %q{2010-08-22}
+  s.description = %q{Little rails debugging gem for writing colorized output to log file}
+  s.email = %q{gems-kevdev@snkmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/clog.rb",
+     "test/helper.rb",
+     "test/test_clog.rb"
+  ]
+  s.homepage = %q{http://github.com/kswope/clog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Little rails debugging gem for writing colorized output to log file}
+  s.test_files = [
+    "test/common/functional/public_controller_test.rb",
+     "test/common/migrate/20100821014956_create_users.rb",
+     "test/common/public_controller.rb",
+     "test/common/unit/helpers/public_helper_test.rb",
+     "test/common/unit/user_test.rb",
+     "test/common/user.rb",
+     "test/helper.rb",
+     "test/rails2x_root/app/controllers/application_controller.rb",
+     "test/rails2x_root/app/controllers/public_controller.rb",
+     "test/rails2x_root/app/helpers/application_helper.rb",
+     "test/rails2x_root/app/helpers/public_helper.rb",
+     "test/rails2x_root/app/models/user.rb",
+     "test/rails2x_root/config/boot.rb",
+     "test/rails2x_root/config/environment.rb",
+     "test/rails2x_root/config/environments/development.rb",
+     "test/rails2x_root/config/environments/production.rb",
+     "test/rails2x_root/config/environments/test.rb",
+     "test/rails2x_root/config/initializers/backtrace_silencers.rb",
+     "test/rails2x_root/config/initializers/cookie_verification_secret.rb",
+     "test/rails2x_root/config/initializers/inflections.rb",
+     "test/rails2x_root/config/initializers/mime_types.rb",
+     "test/rails2x_root/config/initializers/new_rails_defaults.rb",
+     "test/rails2x_root/config/initializers/session_store.rb",
+     "test/rails2x_root/config/routes.rb",
+     "test/rails2x_root/db/schema.rb",
+     "test/rails2x_root/db/seeds.rb",
+     "test/rails2x_root/test/performance/browsing_test.rb",
+     "test/rails2x_root/test/test_helper.rb",
+     "test/rails3x_root/app/controllers/application_controller.rb",
+     "test/rails3x_root/app/controllers/public_controller.rb",
+     "test/rails3x_root/app/helpers/application_helper.rb",
+     "test/rails3x_root/app/helpers/public_helper.rb",
+     "test/rails3x_root/app/models/user.rb",
+     "test/rails3x_root/config/application.rb",
+     "test/rails3x_root/config/boot.rb",
+     "test/rails3x_root/config/environment.rb",
+     "test/rails3x_root/config/environments/development.rb",
+     "test/rails3x_root/config/environments/production.rb",
+     "test/rails3x_root/config/environments/test.rb",
+     "test/rails3x_root/config/initializers/backtrace_silencers.rb",
+     "test/rails3x_root/config/initializers/inflections.rb",
+     "test/rails3x_root/config/initializers/mime_types.rb",
+     "test/rails3x_root/config/initializers/secret_token.rb",
+     "test/rails3x_root/config/initializers/session_store.rb",
+     "test/rails3x_root/config/routes.rb",
+     "test/rails3x_root/db/schema.rb",
+     "test/rails3x_root/db/seeds.rb",
+     "test/rails3x_root/test/performance/browsing_test.rb",
+     "test/rails3x_root/test/test_helper.rb",
+     "test/test_clog.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<term-ansicolor>, [">= 0"])
+    else
+      s.add_dependency(%q<term-ansicolor>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<term-ansicolor>, [">= 0"])
+  end
+end
+

data/test/common/functional/public_controller_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class PublicControllerTest < ActionController::TestCase
+
+  test "nothing blows up in rails controller" do
+    clog "Testing string"
+    clog :a_symbol, :blah
+    clog :an_array, [1,2,3,4,5]
+  end
+
+end

data/test/common/migrate/20100821014956_create_users.rb

@@ -0,0 +1,13 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :email
+      t.string :password
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/test/common/public_controller.rb

@@ -0,0 +1,11 @@
+class PublicController < ApplicationController
+
+  def index
+    render :text => "Hello, just doing some logging"
+    clog "Hello log!"
+    clog "Hello log!  Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"
+    clog :message, "hello log!"
+    clog Rails.root, Object.new, Kernel, RUBY_VERSION, :a_symbol
+  end
+
+end

data/test/common/unit/helpers/public_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class PublicHelperTest < ActionView::TestCase
+end

data/test/common/unit/user_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class UserTest < ActiveSupport::TestCase
+
+
+  #### not much of a test, all the good testing is done at the gem level, this
+  #### just tests if it blows up in rails
+  test "nothing blows up in rails model" do
+
+    user = User.new
+    clog user.email = "test@example.com"
+    clog user.password = "not encrypted"
+    clog user
+
+  end
+  
+end

data/test/common/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'clog'
+
+class Test::Unit::TestCase
+end