rails-labeled_log 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed22b778f0ef5fbc0010af12991a4c57bc1635b7
+  data.tar.gz: 859bd6d98f0e98b8573e09cdf820ea321a129f00
+SHA512:
+  metadata.gz: b511c221332d1887f5542a7eb8dbd8721e8c3162a9d3dcde933687f02e710c70e40b9c143281f15886c6618038a0db7758aaaf2a8dfa90a5df640e86d610278a
+  data.tar.gz: 5d764e179e741966a7cfacf6df115a0ba70d7fe6fabb80ec3bb11e73e515e7136fd038f638adea88c187fbc459993f3b0d6589a8e9f064014d83de752dbeaa1a

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+TODO
+
+# For MacOS:
+.DS_Store
+
+# For vim:
+*.sw*
+
+# RVM
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fernando Hamasaki de Amorim
+
+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,94 @@
+# Rails Labeled Log
+A tool to use easily Rails Tagged Logging in your Ruby classes.
+
+## Installing
+
+### Gemfile
+
+```ruby
+gem 'rails-labeled_log'
+```
+
+### Direct installation
+
+```console
+$ gem install rails-labeled_log
+```
+
+
+## Using
+
+### Rails::LabeledLog::Logging module
+
+```ruby
+require 'rails-labeled_log'
+
+# Include Rails::LabeledLog::Logging module in your class
+module FakeModule
+  class FakeClass
+    include Rails::LabeledLog::Logging
+
+    def do_something
+      # Log some info here
+      log_info 'I did something'
+    end
+  end
+end
+
+fake = FakeModule::FakeClass.new
+fake.do_something
+
+# You also can use class methods
+FakeModule::FakeClass.log_error 'Something was wrong'
+```
+
+Rails log will be labeled with the class name:
+```
+[FakeModule::FakeClass] I did something at 2015-09-21 00:33:17 -0300
+[FakeModule::FakeClass] Something was wrong at 2015-09-21 00:33:18 -0300
+```
+
+##### Available (private) instance methods and class methods
+- log_info
+- log_error
+- log_warn
+- log_debug
+- log_fatal
+
+### Rails::LabeledLog::Logger class
+
+```ruby
+require 'rails-labeled_log'
+
+logger = Rails::LabeledLog::Logger.new('One', 'Two')
+logger.info 'My info message'
+```
+In the Rails Log:
+```
+[One] [Two] My info message at 2015-09-21 01:01:43 -0300
+```
+
+##### Available methods
+- info
+- error
+- warn
+- debug
+- fatal
+
+## Author
+[Fernando Hamasaki de Amorim (prodis)](http://prodis.blog.br)
+
+![Prodis Logo](http://prodis.net.br/images/prodis_150.gif)
+
+
+## Contributing to Rails Labeled Log
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+- Fork the project.
+- Start a feature/bugfix branch.
+- Commit and push until you are happy with your contribution.
+- Don't forget to rebase with branch master in main project before submit the pull request.
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/lib/rails/labeled_log/levels.rb

@@ -0,0 +1,5 @@
+module Rails
+  module LabeledLog
+    LEVELS = [:debug, :error, :fatal, :info, :warn].freeze
+  end
+end

data/lib/rails/labeled_log/logger.rb

@@ -0,0 +1,29 @@
+module Rails
+  module LabeledLog
+    class Logger
+      attr_reader :labels
+
+      def initialize(*labels)
+        @labels = labels
+      end
+
+      LabeledLog::LEVELS.each do |level|
+        define_method(level) do |message|
+          log(level, message)
+        end
+      end
+
+      private
+
+      def log(level, message)
+        Rails.logger.tagged(*labels) do
+          Rails.logger.send(level, format_message(message))
+        end
+      end
+
+      def format_message(message)
+        "#{message} at #{Time.now}"
+      end
+    end
+  end
+end

data/lib/rails/labeled_log/logging.rb

@@ -0,0 +1,41 @@
+module Rails
+  module LabeledLog
+    module Logging
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.send(:prepend, InstanceMethods)
+      end
+
+      module ClassMethods
+        Rails::LabeledLog::LEVELS.each do |level|
+          define_method("log_#{level}".to_sym) do |message|
+            log_labeled(level, message)
+          end
+        end
+
+        private
+
+        def log_labeled(level, message)
+          Rails::LabeledLog::Logger.new(self.name).send(level, message)
+        end
+      end
+
+      module InstanceMethods
+        attr_reader :logger
+
+        def initialize(*args)
+          @logger = Rails::LabeledLog::Logger.new(self.class.name)
+          super
+        end
+
+        private
+
+        Rails::LabeledLog::LEVELS.each do |level|
+          define_method("log_#{level}".to_sym) do |message|
+            logger.send(level, message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/labeled_log/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module LabeledLog
+    VERSION = '0.0.1'
+  end
+end

data/lib/rails-labeled-log.rb

@@ -0,0 +1 @@
+require 'rails-labeled_log'

data/lib/rails-labeled_log.rb

@@ -0,0 +1,3 @@
+require 'rails/labeled_log/levels'
+require 'rails/labeled_log/logger'
+require 'rails/labeled_log/logging'

data/lib/rails_labeled-log.rb

@@ -0,0 +1 @@
+require 'rails-labeled_log'

data/lib/rails_labeled_log.rb

@@ -0,0 +1 @@
+require 'rails-labeled_log'

data/rails-labeled_log.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/labeled_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails-labeled_log'
+  spec.version       = Rails::LabeledLog::VERSION
+  spec.author        = 'Prodis a.k.a. Fernando Hamasaki de Amorim'
+  spec.email         = 'prodis@gmail.com'
+  spec.summary       = 'A tool to use easily Rails Tagged Logging in your Ruby classes.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/prodis/rails-labeled_log'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'rails', '>= 3.2'
+
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/rails/labeled_log/logger_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Rails::LabeledLog::Logger do
+  subject { described_class.new('Chefe', 'Pixel') }
+
+  before(:all) do
+    @log_stream = StringIO.new
+    Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new(@log_stream))
+  end
+
+  after(:all) do
+    Rails.logger = nil
+  end
+
+  Rails::LabeledLog::LEVELS.each do |level|
+    describe "##{level}" do
+      it 'logs with labels' do
+        subject.send(level, "Message for #{level}")
+        expect(@log_stream.string).to include("[Chefe] [Pixel] Message for #{level} at ")
+      end
+    end
+  end
+end

data/spec/rails/labeled_log/logging_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module FakeModule
+  class FakeClass
+    include Rails::LabeledLog::Logging
+  end
+end
+
+describe Rails::LabeledLog::Logging do
+  before(:all) do
+    @log_stream = StringIO.new
+    Rails.logger = ActiveSupport::TaggedLogging.new(Logger.new(@log_stream))
+  end
+
+  after(:all) do
+    Rails.logger = nil
+  end
+
+  context 'class methods' do
+    subject { FakeModule::FakeClass }
+
+    Rails::LabeledLog::LEVELS.each do |level|
+      describe "#log_#{level}" do
+        it 'logs with class name' do
+          subject.send("log_#{level}", "Message for #{level} in class methods")
+          expect(@log_stream.string).to include("[FakeModule::FakeClass] Message for #{level} in class methods at ")
+        end
+      end
+    end
+  end
+
+  context 'instance methods' do
+    subject { FakeModule::FakeClass.new }
+
+    Rails::LabeledLog::LEVELS.each do |level|
+      describe "#log_#{level}" do
+        it 'logs with class name' do
+          subject.send("log_#{level}", "Message for #{level} in instance methods")
+          expect(@log_stream.string).to include("[FakeModule::FakeClass] Message for #{level} in instance methods at ")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rails-labeled_log'
+require 'coveralls'
+require 'rails'
+
+Coveralls.wear!
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rails-labeled_log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Prodis a.k.a. Fernando Hamasaki de Amorim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: pry
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool to use easily Rails Tagged Logging in your Ruby classes.
+email: prodis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rails-labeled-log.rb
+- lib/rails-labeled_log.rb
+- lib/rails/labeled_log/levels.rb
+- lib/rails/labeled_log/logger.rb
+- lib/rails/labeled_log/logging.rb
+- lib/rails/labeled_log/version.rb
+- lib/rails_labeled-log.rb
+- lib/rails_labeled_log.rb
+- rails-labeled_log.gemspec
+- spec/rails/labeled_log/logger_spec.rb
+- spec/rails/labeled_log/logging_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/prodis/rails-labeled_log
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A tool to use easily Rails Tagged Logging in your Ruby classes.
+test_files: []