rails_objects_logger 1.0.0

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/.gpairrc

@@ -0,0 +1 @@
+alone for github

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.3@rails_objects_logger

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - ruby-head
+  - 1.9.3
+  - 1.8.7
+  - 1.9.2
+  - ree

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_objects_logger.gemspec
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "simplecov"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 zedtux
+
+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,49 @@
+# Rails Objects Logger [![Build Status](https://secure.travis-ci.org/zedtux/rails_objects_logger.png)](http://travis-ci.org/zedtux/rails_objects_logger) [![Dependency Status](https://gemnasium.com/zedtux/rails_objects_logger.png)](http://gemnasium.com/zedtux/rails_objects_logger) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/zedtux/rails_objects_logger) [![endorse](http://api.coderwall.com/zedtux/endorsecount.png)](http://coderwall.com/zedtux)
+
+Implement debug, info, warn and error class methods to all Rails objects in order to log anything very easily. This gem is part of Citaskit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_objects_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_objects_logger
+
+## Usage
+
+````ruby
+class MyObject
+  def initialize
+    MyObject.info "Initializing..."
+  end
+
+  def my_function_1
+    debug "Calling my_function_1"
+  end
+
+  def build_new_thing
+    self.error "You can't call this method!"
+  end
+end
+````
+
+Will produce those log lines in your Rails log/development.log file:
+
+    Info#MyObject: Initializing...
+    Debug#MyObject: Calling my_function_1
+    Error#MyObject: You can't call this method!
+
+## 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,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new("spec")
+
+task :default => :spec

data/lib/rails_objects_logger/object_extensions.rb

@@ -0,0 +1,23 @@
+class Object
+  def self.debug(message)
+    send_log(:debug, message)
+  end
+
+  def self.info(message)
+    send_log(:info, message)
+  end
+
+  def self.warn(message)
+    send_log(:warn, message)
+  end
+
+  def self.error(message)
+    send_log(:error, message)
+  end
+
+private
+
+  def self.send_log(level, message)
+    RailsObjectsLogger.log(level, self.name, message)
+  end
+end

data/lib/rails_objects_logger/version.rb

@@ -0,0 +1,3 @@
+module RailsObjectsLogger
+  VERSION = "1.0.0"
+end

data/lib/rails_objects_logger.rb

@@ -0,0 +1,9 @@
+require "rails_objects_logger/version"
+
+module RailsObjectsLogger
+  def self.log(level, class_name, message)
+    Rails.logger.send(level, "#{level.to_s.capitalize}##{class_name}: #{message}")
+  end
+end
+
+require "rails_objects_logger/object_extensions"

data/rails_objects_logger.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_objects_logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rails_objects_logger"
+  gem.version       = RailsObjectsLogger::VERSION
+  gem.authors       = ["zedtux"]
+  gem.email         = ["zedtux@zedroot.org"]
+  gem.description   = %q{Rails ojects logger helper}
+  gem.summary       = %q{Implement debug, info, warn and error class methods to all objects in order to log anything very easily. This gem is part of Citaskit.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport"
+end

data/spec/rails_objects_logger_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+module Rails
+  # No need to put the methods debug, info, warn and error as RSpec will stub them
+  class LoggerTest; end
+
+  attr_accessor :logger
+  def self.logger
+    @logger ||= LoggerTest.new
+  end
+end
+
+describe RailsObjectsLogger do
+  describe "Class Methods" do
+    describe "#log" do
+      context "passing level debug, class name \"Citaskit\" and message \"My awesome debug message that will make me understand what is going wrong.\"" do
+        it "should call Rails.logger.debug and log \"Debug#Citaskit: My awesome debug message that will make me understand what is going wrong.\"" do
+          Rails.logger.should_receive(:debug).with("Debug#Citaskit: My awesome debug message that will make me understand what is going wrong.")
+          RailsObjectsLogger.log(
+            :debug,
+            "Citaskit",
+            "My awesome debug message that will make me understand what is going wrong."
+          )
+        end
+      end
+      context "passing level info, class name \"Citaskit\" and message \"This information message help to know the current state of the application.\"" do
+        it "should call Rails.logger.info and log \"Info#Citaskit: This information message help to know the current state of the application.\"" do
+          Rails.logger.should_receive(:info).with("Info#Citaskit: This information message help to know the current state of the application.")
+          RailsObjectsLogger.log(
+            :info,
+            "Citaskit",
+            "This information message help to know the current state of the application."
+          )
+        end
+      end
+      context "passing level warn, class name \"Citaskit\" and message \"Achtung! This message is important!\"" do
+        it "should call Rails.logger.warn and log \"Warn#Citaskit: Achtung! This message is important!\"" do
+          Rails.logger.should_receive(:warn).with("Warn#Citaskit: Achtung! This message is important!")
+          RailsObjectsLogger.log(
+            :warn,
+            "Citaskit",
+            "Achtung! This message is important!"
+          )
+        end
+      end
+      context "passing level error, class name \"Citaskit\" and message \"CRITICAL ERROR! YOUR APP IS DEAD!\"" do
+        it "should call Rails.logger.error and log \"Error#Citaskit: CRITICAL ERROR! YOUR APP IS DEAD!\"" do
+          Rails.logger.should_receive(:error).with("Error#Citaskit: CRITICAL ERROR! YOUR APP IS DEAD!")
+          RailsObjectsLogger.log(
+            :error,
+            "Citaskit",
+            "CRITICAL ERROR! YOUR APP IS DEAD!"
+          )
+        end
+      end
+    end
+  end
+
+  describe "logging something from an object" do
+    it "should works" do
+      class MyObject; end
+      Rails.logger.should_receive(:info)
+      MyObject.info("It works!")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+if RUBY_VERSION[0, 3] == "1.9"
+  require "simplecov"
+  SimpleCov.start
+end
+
+require "rubygems"
+require "bundler/setup"
+require "active_support"
+
+# our gem
+require "rails_objects_logger"
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rails_objects_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- zedtux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: Rails ojects logger helper
+email:
+- zedtux@zedroot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gpairrc
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_objects_logger.rb
+- lib/rails_objects_logger/object_extensions.rb
+- lib/rails_objects_logger/version.rb
+- rails_objects_logger.gemspec
+- spec/rails_objects_logger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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'
+      segments:
+      - 0
+      hash: -2819341135527539488
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2819341135527539488
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Implement debug, info, warn and error class methods to all objects in order
+  to log anything very easily. This gem is part of Citaskit.
+test_files:
+- spec/rails_objects_logger_spec.rb
+- spec/spec_helper.rb