logging_by_bean 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53ced3a7ba6438bfdbe0fdc32a4f8385cee6088c
-  data.tar.gz: fd9bc463275278e6ddc00b3df337d5a44077bb14
+  metadata.gz: 88763963b29f16e50bfc2c2066dfcdf805bb74dc
+  data.tar.gz: cc7e08c1bac8ab71203bccef2e94def74ab1d2bd
 SHA512:
-  metadata.gz: 908f9b98bfbd9fd7cff2c23cef3324b555d842e80db81370b9030cbaa4e3420ff4dc190faf39d5ae0d3baefed3f313beeae509767a0dcc6ea2cbc46d1b134807
-  data.tar.gz: 029cf89df72d21167fdf9f95b920749359bd96eb94c681086683e06f294034c57773bcc97eafe61346a54a02f4245d9ae96980cdb1fcd8b0ffff263ca0049528
+  metadata.gz: b561b9e7dd262a40fb6041f320fb8854d8f2480013e1cb575aaf9dd33bb3cc0fb443d1ed27553c982cafcb266c7794f4e09f0a7fdf3095947ff70451ed572b40
+  data.tar.gz: 6b6f0c4ca88806bd916e72fe24a6b6c0d6ba37fa563925ca751ac1bc9bc7b7e65430962c3d06c38be1a9b8d3150da496d1ed552dd62e7d639a1dbf9dff8e49e2

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.4 -
+  - added install generator
+  - populated README
+  - created this file

data/README.md

@@ -1,8 +1,13 @@
 # LoggingByBean
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/logging_by_bean`. To experiment with that code, run `bin/console` for an interactive prompt.
+I've grown tired of looking through Rails logs and wanted something more
+readable.  I found a nice treatment of this at https://cbpowell.wordpress.com/2013/08/09/beautiful-logging-for-ruby-on-rails-4/,
+but I wanted something that was truly fire-and-forget.  This gem handles the 
+installation of an initializer and modification of the application.rb file
+to use nicer logging.
 
-TODO: Delete this and the text above, and describe your gem
+NOTE:  This is my first gem, and I'm doing this as much to learn how to
+generate gems as anything else.  Apologies if it's clunky.
 
 ## Installation
 
@@ -20,9 +25,15 @@ Or install it yourself as:
 
     $ gem install logging_by_bean
 
+Then run the installer:
+
+    $ rails generator logging_by_bean:install
+
 ## Usage
 
-TODO: Write usage instructions here
+Once you've rebundled with the gem and run the installation, you're good to go.
+The gem consists of two side effects:  it creates a logging_by_bean.rb initializer
+file and it modifies your application.rb to switch out the default Rails logger.
 
 ## Development
 

data/lib/generators/logging_by_bean/install/install_generator.rb

@@ -1,44 +1,16 @@
 module LoggingByBean
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
 
       def create_configuration
-        create_file "config/initializers/logging_by_bean.rb" do <<CONFIG_FILE_CONTENTS
-
-class ActiveSupport::Logger::SimpleFormatter
-  SEVERITY_TO_TAG_MAP     = {'DEBUG'=>'meh', 'INFO'=>'fyi', 'WARN'=>'hmm', 'ERROR'=>'wtf', 'FATAL'=>'omg', 'UNKNOWN'=>'???'}
-  SEVERITY_TO_COLOR_MAP   = {'DEBUG'=>'0;37', 'INFO'=>'32', 'WARN'=>'33', 'ERROR'=>'31', 'FATAL'=>'31', 'UNKNOWN'=>'37'}
-  USE_HUMOROUS_SEVERITIES = false
- 
-  def call(severity, time, progname, msg)
-    if USE_HUMOROUS_SEVERITIES
-      formatted_severity = sprintf("%-3s",SEVERITY_TO_TAG_MAP[severity])
-    else
-      formatted_severity = sprintf("%-5s",severity)
-    end
-
-    call_details = Kernel.caller[4].gsub(/#{Rails.root}/, '')
-    call_details.match /(.+):(.+):/
-    filename = $1
-    line = $2
-
-    formatted_time = time.strftime("%Y-%m-%d %H:%M:%S.") << time.usec.to_s[0..2].rjust(3)
-    color = SEVERITY_TO_COLOR_MAP[severity]
-
-    base_msg = "\033[0;37m#{formatted_time}\033[0m [\033[#{color}m#{formatted_severity}\033[0m] #{msg.strip} "
-
-    # if this is an error or fatal or unknown exception, include the file and line number
-    if severity.match(/ERROR|FATAL|UNKNOWN/)
-      base_msg += "(at: #{filename}:#{line} on pid:#{$$})\n"
-      base_msg += Kernel.caller[4,10].map{ |l| ' ' * 35 + l.gsub(/#{Rails.root}/,'')}.join("\n")
-    end    
-
-    return base_msg + "\n"
-  end
-end
-CONFIG_FILE_CONTENTS  
-
+        template "config_file_contents.rb", "config/initializers/logging_by_bean.rb"
+      end
 
+      def update_application_config
+        application 'config.logger = ActiveSupport::TaggedLogging.new(Logger.new(Pathname.new(Rails.root) + "log" + "#{Rails.env}.log"))' + "\n"
+        application '# (See config/logging_by_bean.rb for details)'
+        application '# Added automatically by logging_by_bean:install'
       end
     end
   end

data/lib/generators/logging_by_bean/install/templates/config_file_contents.rb

@@ -0,0 +1,38 @@
+# Logging by Bean Gem 
+# 
+# Provides better log messages than the default Rails logger.  Inspired by
+# https://cbpowell.wordpress.com/2013/08/09/beautiful-logging-for-ruby-on-rails-4/
+class ActiveSupport::Logger::SimpleFormatter
+  SEVERITY_TO_TAG_MAP     = {'DEBUG'=>'meh', 'INFO'=>'fyi', 'WARN'=>'hmm', 'ERROR'=>'wtf', 'FATAL'=>'omg', 'UNKNOWN'=>'???'}
+  SEVERITY_TO_COLOR_MAP   = {'DEBUG'=>'0;37', 'INFO'=>'32', 'WARN'=>'33', 'ERROR'=>'31', 'FATAL'=>'31', 'UNKNOWN'=>'37'}
+  USE_HUMOROUS_SEVERITIES = false
+ 
+  def call(severity, time, progname, msg)
+    if USE_HUMOROUS_SEVERITIES
+      formatted_severity = sprintf("%-3s",SEVERITY_TO_TAG_MAP[severity])
+    else
+      formatted_severity = sprintf("%-5s",severity)
+    end
+
+    call_details = Kernel.caller[4].gsub(/#{Rails.root}/, '')
+    call_details.match /(.+):(.+):/
+    filename = $1
+    line = $2
+
+    formatted_time = time.strftime("%Y-%m-%d %H:%M:%S.") << time.usec.to_s[0..2].rjust(3)
+    color = SEVERITY_TO_COLOR_MAP[severity]
+
+    base_msg = "\033[0;37m#{formatted_time}\033[0m [\033[#{color}m#{formatted_severity}\033[0m] #{msg.strip} "
+
+    # if this is an error or fatal or unknown exception, include the file and line number
+    if severity.match(/ERROR|FATAL|UNKNOWN/)
+      base_msg += "(at: #{filename}:#{line} on pid:#{$$})\n"
+      # Note that starting at the 5th item in the call stack is an educated guess...it may need to 
+      # be tweaked for your application.  I'm also printing out the next 10 calls in the stack because
+      # I like that.  You may want to change this to what suits you.
+      base_msg += Kernel.caller[4,10].map{ |l| ' ' * 35 + l.gsub(/#{Rails.root}/,'')}.join("\n")
+    end    
+
+    return base_msg + "\n"
+  end
+end

data/lib/logging_by_bean/version.rb

@@ -1,3 +1,3 @@
 module LoggingByBean
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/logging_by_bean.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "thor"
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: logging_by_bean
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - David L Bean
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,6 +70,7 @@ files:
 - bin/console
 - bin/setup
 - lib/generators/logging_by_bean/install/install_generator.rb
+- lib/generators/logging_by_bean/install/templates/config_file_contents.rb
 - lib/logging_by_bean.rb
 - lib/logging_by_bean/version.rb
 - logging_by_bean.gemspec