ltsv_ng 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a521d1eff162a25c8a622ad1a8cf2c278863f11a
+  data.tar.gz: 41efc2f061b98220ca8d2542d02ecd55904f15c5
+SHA512:
+  metadata.gz: 652dbbbf133f5c4f90a759daa02ec89f5a8da1a3c04660422bd375329d1c35261fcd8ea645e30aa99c28b9dd1ed3c2641ce33cc067b66c8e6507f265b89f187c
+  data.tar.gz: d7f67a464468babde48597ed9f8082a0c51d653a59766fed80b870d06169df62c8b9fc985bcd6f29c1de6b389ce92abcfdce814f96994c5e46eab7c53aecf147

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/vendor/
+.rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 hirocaster
+
+MIT License
+
+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 @@
+# LtsvNg
+
+[LTSV](http://ltsv.org/) logger for Ruby application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ltsv_ng'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ltsv_ng
+
+## Usage
+
+### for Rails
+
+in `config/environments/production.rb`
+
+```ruby
+Rails.application.configure do
+
+(snip)
+
+  logger = LtsvNg::Logger.new(Rails.root.join("log/#{Rails.env}.log"))
+  config.logger = logger
+
+(snip)
+
+end
+```
+
+### Sample log
+
+```ruby
+Rails.logger.info "foobar" # => level:INFO   time:2015-08-05 00:44:31 +0900  msg:foobar
+Rails.logger.info id: 123, name: "alice" # => level:INFO   time:2015-08-05 00:46:56 +0900  id:123  name:alice
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/hirocaster/ltsv_ng/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/ltsv_ng/formatter.rb

@@ -0,0 +1,14 @@
+module LtsvNg
+  class Formatter < ::Logger::Formatter
+    def call(severity, timestamp, progname, msg)
+      raws = ["level:#{ severity }", "time:#{ timestamp }"]
+      case msg
+      when Hash
+        raws = msg.inject(raws) { |h, (key, value)| h << "#{key}:#{value}"; h }
+      when String
+        raws << "msg:#{ msg }"
+      end
+      "#{raws.join("\t")}\n"
+    end
+  end
+end

data/lib/ltsv_ng/logger.rb

@@ -0,0 +1,8 @@
+module LtsvNg
+  class Logger < ::Logger
+    def initialize(*args)
+      super
+      @formatter = LtsvNg::Formatter.new
+    end
+  end
+end

data/lib/ltsv_ng/version.rb

@@ -0,0 +1,3 @@
+module LtsvNg
+  VERSION = "0.0.1"
+end

data/lib/ltsv_ng.rb

@@ -0,0 +1,9 @@
+require "ltsv_ng/version"
+
+require "logger"
+require "ltsv_ng/logger"
+require "ltsv_ng/formatter"
+
+module LtsvNg
+  # Your code goes here...
+end

data/ltsv_ng.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ltsv_ng/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ltsv_ng"
+  spec.version       = LtsvNg::VERSION
+  spec.authors       = ["hirocaster"]
+  spec.email         = ["hohtsuka@gmail.com"]
+  spec.summary       = %q{LTSV format logger.}
+  spec.description   = %q{LTSV logger for Ruby application.}
+  spec.homepage      = "https://github.com/hirocaster/ltsv_ng"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/formatter_spec.rb

@@ -0,0 +1,22 @@
+require_relative "spec_helper"
+
+describe "LtsvNg::Formatter" do
+  let(:time) { Time.now }
+  let(:formatter) { LtsvNg::Formatter.new }
+
+  describe "#call" do
+    context "String data log" do
+      it "returns LTSV Format text" do
+        text =  formatter.call("INFO", time, nil, "foobar")
+        expect(text).to eq "level:INFO\ttime:#{time}\tmsg:foobar\n"
+      end
+    end
+
+    context "Hash data log" do
+      it "returns LTSV Format text" do
+        text =  formatter.call("INFO", time, nil, { id: 123, name: "foobar"})
+        expect(text).to eq "level:INFO\ttime:#{time}\tid:123\tname:foobar\n"
+      end
+    end
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,34 @@
+require_relative "spec_helper"
+
+describe "LtsvNg::Logger" do
+  before do
+    @output = StringIO.new
+    @logger = LtsvNg::Logger.new(@output)
+  end
+
+  describe "#formatter" do
+    it "returns Logger::LtsvNg::Formatter" do
+      expect(@logger.formatter).to be_an_instance_of(LtsvNg::Formatter)
+    end
+  end
+
+  describe "#info" do
+    it "returns info log by String Text" do
+      @logger.info("Test")
+
+      @output.seek(0)
+      ltsv = @output.read.strip.split("\t")
+      expect(ltsv).to include("level:INFO")
+      expect(ltsv).to include("msg:Test")
+    end
+
+    it "returns info log by Hash" do
+      @logger.info(id: 123, name: "foobar")
+      @output.seek(0)
+      ltsv = @output.read.strip.split("\t")
+      expect(ltsv).to include("level:INFO")
+      expect(ltsv).to include("id:123")
+      expect(ltsv).to include("name:foobar")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+require "ltsv_ng"

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ltsv_ng
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hirocaster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 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: LTSV logger for Ruby application.
+email:
+- hohtsuka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ltsv_ng.rb
+- lib/ltsv_ng/formatter.rb
+- lib/ltsv_ng/logger.rb
+- lib/ltsv_ng/version.rb
+- ltsv_ng.gemspec
+- spec/formatter_spec.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hirocaster/ltsv_ng
+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.2.2
+signing_key: 
+specification_version: 4
+summary: LTSV format logger.
+test_files:
+- spec/formatter_spec.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb