chihiro 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60f175c477cd3d788cb1063d1b6e4be8921c4ce6fd61cc18d9b9d4a538545c6a
-  data.tar.gz: a675f4673b58aef02d396a6e880497fcc9910b085154ccb99e51d48a5e28e320
+  metadata.gz: b02e72d647ea1919e47c783bf04a46a4a239b0e7d22d97723491e4be03d06ec8
+  data.tar.gz: b59dcbe80d7d1f2363cd85db1c4179bd79a3b63175ea2ed103cbf593bc835a28
 SHA512:
-  metadata.gz: 49021a5f1292c4fc39bf78c04aa3f6ad605f45092f1b814b3ce16d0ed591482513cd9d3e2b44cd9066a1eeb3ad0eef2f15175f1e6b839f6a2241d5bdf02be7d3
-  data.tar.gz: 5a74417f9554ef60bed1c6a60abf684a133da9331fb8bedc168b626e6de18c8ee6c5f002dd8fb162db9a82dac38e6bc21ae76501ad3bc53fae09600f632f4512
+  metadata.gz: b19306ae9f799370cd051693d0435aea38fc79479843a610a472963a205e382f4d088a9e6b6bf745c8dcc164065c2a20c5e9536675f75ebed13f2e4a7471bfb2
+  data.tar.gz: 2b737de4c58abce1d4b34d16803a28b7c1db88dc784e3667228f853f8019cb7f67ce92e14d1d5a226d6be5e205fc1a6667a91d0dd969b77c44c86a23987a95ce

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in chihiro.gemspec
 gemspec

data/README.md

@@ -1,8 +1,6 @@
-# Chihiro
+# Chihiro, a Rails log formatter
 
-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/chihiro`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Chihiro is a Rails log formatter that focuses on format rails log to json
 
 ## Installation
 
@@ -20,15 +18,9 @@ Or install it yourself as:
 
     $ gem install chihiro
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Quick Start
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+add `Chihiro::Initializer.new.execute` to your `application.rb`
 
 ## Contributing
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/chihiro.gemspec

@@ -1,25 +1,27 @@
 
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "chihiro/version"
+require 'chihiro/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "chihiro"
+  spec.name = 'chihiro'
   spec.version = Chihiro::VERSION
-  spec.authors = ["Shu Hui"]
-  spec.email = ["dreamlock0630@gmail.com"]
+  spec.authors = ['Shu Hui']
+  spec.email = ['dreamlock0630@gmail.com']
 
-  spec.summary = "Tool for rails log format"
-  spec.description = "Change rails log to Json format"
-  spec.homepage = "https://github.com/blockchaintech-au/chihiro"
-  spec.license = "MIT"
+  spec.summary = 'Tool for rails log format'
+  spec.description = 'Change rails log to Json format'
+  spec.homepage = 'https://github.com/blockchaintech-au/chihiro'
+  spec.license = 'MIT'
 
-  spec.files = Dir["**/*"].keep_if { |file| File.file?(file) }
-  spec.require_paths = ["lib"]
+  spec.files = Dir['**/*'].keep_if { |file| File.file?(file) }
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "lograge", "~> 0.10"
+  spec.add_dependency 'lograge', '~> 0.10'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/chihiro/initializer.rb

@@ -1,13 +1,21 @@
+# frozen_string_literal: true
+
 module Chihiro
   class Initializer
     def execute
+      setup_log_configuration if ENV['RAILS_ENV'] == 'production'
+    end
+
+    private
+
+    def setup_log_configuration # rubocop:disable Metrics/MethodLength
       Rails.application.configure do
         config.log_formatter = Chihiro::JsonLogFormatter.new
         config.colorize_logging = false
         config.lograge.enabled = true
-        config.lograge.base_controller_class = "ActionController::API"
-        config.lograge.ignore_actions = ["HealthCheckController#index"]
-        if ENV["RAILS_LOG_TO_STDOUT"].present?
+        config.lograge.base_controller_class = 'ActionController::API'
+        config.lograge.ignore_actions = ['HealthCheckController#index']
+        if ENV['RAILS_LOG_TO_STDOUT'].present?
           logger = ActiveSupport::Logger.new(STDOUT)
           logger.formatter = config.log_formatter
           config.logger = logger

data/lib/chihiro/json_log_formatter.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 module Chihiro
   class JsonLogFormatter < Logger::Formatter
     def call(severity, _time, _progname, msg)
       extra_log_data(msg).merge(
-        "level": severity.downcase,
-        "project": ENV["PROJECT"],
-        "environment": ENV["RAILS_ENV"],
-        "application": ENV["APP_NAME"],
-        "dateTime": Time.now,
+        level: severity.downcase,
+        project: ENV['PROJECT'],
+        environment: ENV['ENVIRONMENT'],
+        application: ENV['APP_NAME'],
+        datetime: Time.now
       ).to_json + "\r\n"
     end
 
@@ -17,9 +18,9 @@ module Chihiro
       if msg.is_a? Hash
         msg
       elsif msg.is_a? Exception
-        {"message": msg.message, "backtrace": msg.backtrace}
+        { message: msg.message, backtrace: msg.backtrace }
       else
-        {"message": msg}
+        { message: msg }
       end
     end
   end

data/lib/chihiro/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chihiro
-  VERSION = "0.1.7"
+  VERSION = '0.1.8'
 end

data/lib/chihiro.rb

@@ -1,6 +1,8 @@
-require "chihiro/version"
-require "chihiro/initializer"
-require "chihiro/json_log_formatter"
+# frozen_string_literal: true
+
+require 'chihiro/version'
+require 'chihiro/initializer'
+require 'chihiro/json_log_formatter'
 
 module Chihiro
   # Your code goes here...

data/lib/generators/chihiro/init_generator.rb

@@ -2,11 +2,11 @@
 
 module Chihiro
   class InitGenerator < Rails::Generators::Base
-    source_root File.expand_path("templates", __dir__)
-    desc "Generate totoro config file"
+    source_root File.expand_path('templates', __dir__)
+    desc 'Generate totoro config file'
 
     def copy_config_file
-      template "initializer.rb", File.join("config/initializers", "chihiro.rb")
+      template 'initializer.rb', File.join('config/initializers', 'chihiro.rb')
     end
   end
 end

data/lib/generators/chihiro/templates/initializer.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Chihiro::Initializer.new.execute

data/spec/chihiro_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 RSpec.describe Chihiro do
-  it "has a version number" do
+  it 'has a version number' do
     expect(Chihiro::VERSION).not_to be nil
   end
 
-  it "does something useful" do
+  it 'does something useful' do
     expect(false).to eq(true)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chihiro
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Shu Hui
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -87,13 +87,7 @@ files:
 - lib/chihiro/version.rb
 - lib/generators/chihiro/init_generator.rb
 - lib/generators/chihiro/templates/initializer.rb
-- pkg/chihiro-0.1.0.gem
-- pkg/chihiro-0.1.1.gem
-- pkg/chihiro-0.1.2.gem
-- pkg/chihiro-0.1.3.gem
-- pkg/chihiro-0.1.4.gem
-- pkg/chihiro-0.1.5.gem
-- pkg/chihiro-0.1.6.gem
+- pkg/chihiro-0.1.8.gem
 - spec/chihiro_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/blockchaintech-au/chihiro