filter_log 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3-p392@filter_log --create

data/DEVELOPER_README.md

@@ -0,0 +1,23 @@
+# FilterLog
+
+This is a README for working on FilterLog
+
+## Installing
+
+```
+gem build filter_log.gemspec
+gem install ./filter_log-1.0.0.gem
+```
+
+## Running
+
+Get into `irb`.
+
+Run `require 'filter_log'`.
+
+Now you can access the FilterLog object.
+
+## All together now
+
+`gem build filter_log.gemspec; gem install filter_log-1.0.0.gem; irb`
+`require 'filter_log'`

data/Gemfile

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

data/README.md

@@ -0,0 +1,62 @@
+# FilterLog
+
+FilterLog is a simple log that allows you to filter on which log messages get displayed by using tags.
+
+## Dependencies
+
+FilterLog uses the [colored](https://github.com/defunkt/colored) gem to color output.
+
+## Usage
+
+### `.debug` and `.error`
+
+FilterLog provides two functions for showing output, both of which render using `puts`.
+
+These functions are `.debug` and `.error`.
+
+`.debug` will render a string out like so:
+
+![](http://puu.sh/3waWv)
+
+`.error` will render a string out like so:
+
+![](http://puu.sh/3waXu)
+
+### Using tags
+
+You can pass tags in to your log calls that the FilterLog class will use to determine whether or not to show a given log message.
+
+By default, no tags are enabled. This means that the following call will render nothing:
+
+```ruby
+FilterLog.debug("Jordan rules", :my_tag)
+```
+
+To enable a tag, you can use:
+
+```ruby
+FilterLog.enableTags(:my_tag, :my_other_tag)
+```
+
+To disable a tag you can use:
+
+```ruby
+FilterLog.disableTags(:my_tag, :my_other_tag)
+```
+
+The purpose of using tagging is so you can reduce the amount of crap you see in your logs.
+
+You can add as many tags as you want to a given log statement, so the following also works:
+
+```ruby
+FilterLog.debug("Jordan rules", :my_tag, :hedonism, :other_tag, :something_else)
+```
+
+Tags can be anything, so if you want to see logs only for a given object, you can do the following:
+
+```ruby
+jordan = Object.new
+FilterLog.enableTags(jordan)
+FilterLog.debug("I am a log", jordan)
+```
+

data/Rakefile

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

data/filter_log.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "filter_log"
+  s.version     = "1.0.0"
+  s.authors     = ["Jordan Maguire"]
+  s.email       = ["jmaguire@thefrontiergroup.com.au"]
+  s.homepage    = "https://github.com/jordanmaguire/filter_log"
+  s.summary     = "A filterable log for Ruby"
+  s.description = "Specify which types of log entry you want to see logged"
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'colored'
+end

data/lib/filter_log.rb

@@ -0,0 +1,42 @@
+require 'colored'
+
+class FilterLog
+
+  def self.debug(message, *tags)
+    if tagsShouldOutput(tags)
+      output("Debug: ".cyan + message.white)
+    end
+  end
+
+  def self.error(message, *tags)
+    if tagsShouldOutput(tags)
+      output("Error: ".red + message.white)
+    end
+  end
+
+  def self.disableTags(*tags)
+    return enabledTags if tags.nil? || tags.empty?
+    tags.each { |tag| enabledTags.delete(tag) }
+    enabledTags
+  end
+
+  def self.enabledTags
+    @enabledTags ||= []
+  end
+
+  def self.enableTags(*tags)
+    enabledTags.concat(tags).uniq!
+    enabledTags
+  end
+
+private
+
+  def self.output(message)
+    puts("#{message}\n")
+  end
+
+  def self.tagsShouldOutput(tags)
+    tags.nil? || tags.empty? || tags.any? { |x| enabledTags.include?(x) }
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: filter_log
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jordan Maguire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Specify which types of log entry you want to see logged
+email:
+- jmaguire@thefrontiergroup.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- DEVELOPER_README.md
+- Gemfile
+- README.md
+- Rakefile
+- filter_log.gemspec
+- lib/filter_log.rb
+homepage: https://github.com/jordanmaguire/filter_log
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A filterable log for Ruby
+test_files: []