super_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 750432fafde32eb25108d8cf1adaa984f789cded
+  data.tar.gz: 84a4882561d56918946817ed8929b2bc3e31a214
+SHA512:
+  metadata.gz: 57f2377eba282826f33e32ef11388ff306b60a7a4bb1ec7ea707aafea0e942b71d62d207cc1b3a527c2c70067b10e2e2d7b03f5e6c2a35bfb309e6fec9061664
+  data.tar.gz: dde89c258e74dace9c72a69c67f8076be828844587b9980ecb259afc4d920d64d2f5548f369e494d63a06b56dfb868b56d128dd508c488ca28a9adea07e14ede

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matt Dodds
+
+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,53 @@
+# SuperLogger
+
+Originally was going to be called "LogBomb". Just provides a very easy way to find debug messages in a log.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'super_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install super_logger
+
+## Configuration
+
+Shown with default values:
+
+```ruby
+Configuration.configure do |config|
+  config.delimiter      = "\n"
+  config.line_length    = 50
+  config.rule_character = '='
+  config.log_path       = './default.log'
+  config.logger         = Logger.new(log_path) # Rails.logger
+end
+```
+
+## Usage
+
+```ruby
+SuperLogger.log('This is a log message', 'Key')
+```
+
+See [example.log](http://github.com/MatthewRDodds/super_logger/blob/master/example.log) for examples of that this looks like in the log.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/super_logger/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "super_logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example.log

@@ -0,0 +1,25 @@
+I, [2015-04-24T22:18:06.581794 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:06.581866 #42823]  INFO -- : ==================== An Array ====================
+I, [2015-04-24T22:18:06.581888 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:06.581907 #42823]  INFO -- : This is a message
+I, [2015-04-24T22:18:06.581924 #42823]  INFO -- : this is another message
+I, [2015-04-24T22:18:06.581942 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:06.581958 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:06.581975 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:06.581996 #42823]  INFO -- : 
+I, [2015-04-24T22:18:24.436987 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:24.437035 #42823]  INFO -- : ==================== A String ====================
+I, [2015-04-24T22:18:24.437055 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:24.437078 #42823]  INFO -- : This is a message
+I, [2015-04-24T22:18:24.437097 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:24.437114 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:24.437130 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:24.437148 #42823]  INFO -- : 
+I, [2015-04-24T22:18:51.973567 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:51.973625 #42823]  INFO -- : ===================== A Hash =====================
+I, [2015-04-24T22:18:51.973651 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:51.975979 #42823]  INFO -- : key: value
+I, [2015-04-24T22:18:51.976019 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:51.976043 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:51.976065 #42823]  INFO -- : ==================================================
+I, [2015-04-24T22:18:51.976094 #42823]  INFO -- : 

data/lib/super_logger.rb

@@ -0,0 +1,7 @@
+require 'super_logger/version'
+require 'logger'
+
+require 'super_logger/configuration'
+
+require 'super_logger/message_formatter'
+require 'super_logger/base_logger'

data/lib/super_logger/base_logger.rb

@@ -0,0 +1,39 @@
+module SuperLogger
+  def self.conf
+    SuperLogger.config
+  end
+
+  def self.base_line
+    @line ||= conf.rule_character * conf.line_length
+  end
+
+  def self.log(loggable, key = nil, log_level = 'info')
+    horizontal_rule(log_level, key)
+
+    MessageFormatter.format(loggable).each do |message|
+      actual_log message, log_level
+    end
+
+    horizontal_rule(log_level)
+  end
+
+  def self.actual_log(message, log_level)
+    conf.logger.send(log_level, message)
+  end
+
+  def self.rule_with_text(key)
+    computed_length = base_line.length - (key.length + 2)
+    partial_line = conf.rule_character * (computed_length / 2).floor
+
+    "#{partial_line} #{key} #{partial_line}"
+  end
+
+  def self.horizontal_rule(log_level, key = nil)
+    middle_line = key ? rule_with_text(key) : base_line
+
+    actual_log(base_line, log_level)
+    actual_log(middle_line, log_level)
+    actual_log(base_line, log_level)
+    actual_log(String.new, log_level) unless key
+  end
+end

data/lib/super_logger/configuration.rb

@@ -0,0 +1,25 @@
+module SuperLogger
+  class Configuration
+    attr_accessor :delimiter, :line_length, :rule_character, :log_path, :logger
+
+    def initialize
+      @delimiter      = "\n"
+      @line_length    = 50
+      @rule_character = '='
+      @log_path       = './default.log'
+      @logger         = Logger.new(log_path)
+    end
+  end
+
+  class << self
+    attr_writer :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+  end
+end

data/lib/super_logger/message_formatter.rb

@@ -0,0 +1,14 @@
+module SuperLogger
+  module MessageFormatter
+    def self.format(message)
+      case message
+      when Hash
+        message.map { |k, v| "#{k}: #{v}" }
+      when Array
+        message
+      else
+        message.split SuperLogger.config.delimiter
+      end
+    end
+  end
+end

data/lib/super_logger/version.rb

@@ -0,0 +1,3 @@
+module SuperLogger
+  VERSION = "0.1.0"
+end

data/super_logger.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'super_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'super_logger'
+  spec.version       = SuperLogger::VERSION
+  spec.authors       = ['Matthew Dodds']
+  spec.email         = ['matthewrusselldodds@gmail.com']
+
+  spec.summary       = %q{Log bomber}
+  spec.description   = %q{Writes a message with a logger that can easily be found in the log}
+  spec.homepage      = 'http://github.com/MatthewRDodds/super_logger'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: super_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Dodds
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Writes a message with a logger that can easily be found in the log
+email:
+- matthewrusselldodds@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example.log
+- lib/super_logger.rb
+- lib/super_logger/base_logger.rb
+- lib/super_logger/configuration.rb
+- lib/super_logger/message_formatter.rb
+- lib/super_logger/version.rb
+- super_logger.gemspec
+homepage: http://github.com/MatthewRDodds/super_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Log bomber
+test_files: []