log-me 0.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.10)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.6.0)

data/README.rdoc

@@ -0,0 +1,73 @@
+= LogMe
+
+A simple way to configure log in your gem.
+
+LogMe is especially useful when you need to log Web Service calls or HTTP requests and responses.
+
+== Instalation
+
+=== Gemfile
+  gem 'log-me'
+
+=== Command line
+  $ gem install log-me
+
+== Usage
+
+In your gem:
+  require 'log-me'
+
+  module CoolGem
+    extend LogMe
+  end
+
+  module CoolGem
+    class SomeClass
+      def do_something
+        # do something and log
+        CoolGem.log "I am logging something here."
+      end
+    end
+  end
+
+Using your gem:
+  some = CoolGem.SomeClass.new
+  some.do_something
+
+By default will be logged in STDOUT using log level :info:
+  I, [2011-08-24T01:22:52.677395 #3026]  INFO -- : I am logging something here.
+
+Your gem consumer can configure the logger:
+  CoolGem.configure_me do |config|
+    config.log_enabled = false   # Disable log
+    config.log_level = :debug    # Change the log level
+    config.logger = Rails.logger # Use the Rails logger
+  end
+
+== Copyright
+
+(The MIT License)
+
+{Prodis a.k.a. Fernando Hamasaki}[http://prodis.blog.br]
+
+Copyright (c) 2011 Prodis
+
+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/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require 'rubygems'
+require 'rake'
+require './lib/logme/version'
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "log-me"
+  gem.homepage = "http://github.com/prodis/log-me"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple way to configure log in your gem.}
+  gem.description = %Q{LogMe is especially useful when you need to log Web Service calls or HTTP requests and responses.}
+  gem.email = "prodis@gmail.com"
+  gem.authors = ["Prodis a.k.a. Fernando Hamasaki"]
+  gem.version = LogMe::Version::VERSION
+  gem.required_ruby_version = ">= 1.8.7"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "log-me #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/log-me.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'logger'
+
+module LogMe
+  attr_writer :log_enabled
+  attr_writer :log_level
+  attr_writer :logger
+
+  def log_enabled?
+    @log_enabled != false
+  end
+
+  def log_level
+    @log_level ||= :info
+  end
+
+  def logger
+    @logger ||= ::Logger.new STDOUT
+  end
+
+  def log(message)
+    logger.send log_level, message if log_enabled?
+  end
+
+  def self.extended(base)
+    base.send :extend, Configuration
+  end
+
+  module Configuration
+    def configure_me
+      yield self if block_given?
+    end
+  end
+end

data/lib/logme/version.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+module LogMe
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 0
+    VERSION = [MAJOR, MINOR, PATCH].join(".")
+  end
+end

data/log-me.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{log-me}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Prodis a.k.a. Fernando Hamasaki"]
+  s.date = %q{2011-08-24}
+  s.description = %q{LogMe is especially useful when you need to log Web Service calls or HTTP requests and responses.}
+  s.email = %q{prodis@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.rdoc",
+    "Rakefile",
+    "lib/log-me.rb",
+    "lib/logme/version.rb",
+    "log-me.gemspec",
+    "spec/log-me_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/prodis/log-me}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+  s.rubygems_version = %q{1.6.1}
+  s.summary = %q{A simple way to configure log in your gem.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/log-me_spec.rb

@@ -0,0 +1,103 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+module FakeModule
+  extend LogMe
+end
+
+describe LogMe do
+  describe "#log_enabled?" do
+    it "default is true" do
+      FakeModule.log_enabled?.should be_true
+    end
+
+    context "when log is disabled" do
+      around do |example|
+        FakeModule.configure_me { |config| config.log_enabled = false }
+        example.run
+        FakeModule.configure_me { |config| config.log_enabled = true }
+      end
+
+      it "returns false" do
+        FakeModule.log_enabled?.should be_false
+      end
+    end
+  end
+
+  describe "#log_level" do
+    it "default is info" do
+      FakeModule.log_level.should == :info
+    end
+
+    context "when log level is set" do
+      around do |example|
+        FakeModule.configure_me { |config| config.log_level = :debug }
+        example.run
+        FakeModule.configure_me { |config| config.log_level = :info }
+      end
+
+      it "returns set level" do
+        FakeModule.log_level.should == :debug
+      end
+    end
+  end
+
+  describe "#logger" do
+    it "default is Logger" do
+      FakeModule.logger.should be_a(::Logger)
+    end
+
+    context "when set logger" do
+      it "returns set logger" do
+        fake_logger = Class.new
+        FakeModule.configure_me { |config| config.logger = fake_logger }
+        FakeModule.logger.should == fake_logger
+      end
+    end
+  end
+
+  describe "#log" do
+    before :each do
+      @log_stream = StringIO.new
+      FakeModule.configure_me { |config| config.logger = ::Logger.new(@log_stream) }
+    end
+
+    context "when log is enabled" do
+      it "logs the message" do
+        FakeModule.log("Some message to log.")
+        @log_stream.string.should include("Some message to log.")
+      end
+
+      it "calls log level method" do
+        FakeModule.logger.should_receive(:info).with("Some message to log.")
+        FakeModule.log("Some message to log.")
+      end
+    end
+
+    context "when log is disabled" do
+      around do |example|
+        FakeModule.configure_me { |config| config.log_enabled = false }
+        example.run
+        FakeModule.configure_me { |config| config.log_enabled = true }
+      end
+
+      it "does not log the message" do
+        FakeModule.log("Some message to log.")
+        @log_stream.string.should be_empty
+      end
+    end
+
+    context "when log level is set" do
+      around do |example|
+        FakeModule.configure_me { |config| config.log_level = :debug }
+        example.run
+        FakeModule.configure_me { |config| config.log_level = :info }
+      end
+
+      it "calls log level set method" do
+        FakeModule.logger.should_receive(:debug).with("Some message to log.")
+        FakeModule.log("Some message to log.")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'log-me'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: log-me
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Prodis a.k.a. Fernando Hamasaki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-24 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: LogMe is especially useful when you need to log Web Service calls or HTTP requests and responses.
+email: prodis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/log-me.rb
+- lib/logme/version.rb
+- log-me.gemspec
+- spec/log-me_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/prodis/log-me
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: A simple way to configure log in your gem.
+test_files: []
+