logfmt_marshalling 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f87ce5ef918a5e1a05d179ffd9243d7995573b9
+  data.tar.gz: 2c9d654c9bfb918c77c635ae0de9383a94a1186d
+SHA512:
+  metadata.gz: 375fdc64f8bc0ea64869efb2cd5376789b8088fb375d574a287b47f6cc5995c8070f1d15048c2ef9b8a1ed06f729b321b51c67dc225c675f1b273eef39df8851
+  data.tar.gz: 070c8f7d81915033f58111b1273cb20b2785e0f9dfeb883cb5308897ef118bb9fefa1e0a97bc8886a57f2d5dc2bcfdf7f0c1af13d69efaedd06273b918c4943d

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.ruby-gemset
+.ruby-version
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.1
+  - 2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 pm
+
+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,36 @@
+# LogfmtMarshalling
+
+A Ruby gem for emitting [logfmt logging format](https://brandur.org/logfmt).
+
+logfmt (as a key-value logging format) is one flavor of [structured logging](http://gregoryszorc.com/blog/category/logging/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logfmt_marshalling'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logfmt_marshalling
+
+## Usage
+
+```
+> require 'logfmt_marshalling'
+=> true
+> LogfmtMarshalling.marshal method: 'get', path: '/', status: 200
+=> "method=get path=/ status=200"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/MitinPavel/logfmt_marshalling/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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/logfmt_marshalling/marshaller.rb

@@ -0,0 +1,58 @@
+module LogfmtMarshalling
+  class Marshaller
+    def marshal(hash)
+      hash.inject([]) do |acc, (key, value)|
+        case value
+          when TrueClass then acc << marshal_key(key)
+          else                acc << [marshal_key(key), marshal_value(value)].join('=')
+        end
+        acc
+      end.join ' '
+    end
+
+    private
+
+    def marshal_key(key)
+      key.to_s
+    end
+
+    def marshal_value(value)
+      case value
+        when String then marshal_string_value value
+        else             value.to_s
+      end
+    end
+
+    def marshal_string_value(value)
+      handle_special_case(value) || wrap_in_quotes(escapes_double_quotes(value))
+    end
+
+    def escapes_double_quotes(value)
+      value.gsub '[^\]"', '\"'
+    end
+
+    def wrap_in_quotes(value)
+      if value.match(/\\|\s/)
+        %{"#{value}"}
+      else
+        value
+      end
+    end
+
+    def handle_special_case(value)
+      case value
+        when '' then '""'
+        when 'false' then '"false"'
+        when 'true' then '"true"'
+        when /\d/ then handle_string_with_number(value)
+      end
+    end
+
+    def handle_string_with_number(value)
+      Kernel.Float value
+      %{"#{value}"}
+    rescue ArgumentError
+      # Not a number. Will be handled later.
+    end
+  end
+end

data/lib/logfmt_marshalling/version.rb

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

data/lib/logfmt_marshalling.rb

@@ -0,0 +1,10 @@
+require "logfmt_marshalling/version"
+require "logfmt_marshalling/marshaller"
+
+module LogfmtMarshalling
+  def self.marshal(hash)
+    marshaller = ::LogfmtMarshalling::Marshaller.new
+
+    marshaller.marshal hash
+  end
+end

data/logfmt_marshalling.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logfmt_marshalling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logfmt_marshalling'
+  spec.version       = LogfmtMarshalling::VERSION
+  spec.authors       = ['Pavel Mitin']
+  spec.email         = ['mitin.pavel@gmail.com']
+  spec.summary       = %q{A Ruby gem for emitting strings in logfmt logging format.}
+  spec.description   = %q{A Ruby gem for emitting strings in logfmt logging format. Check out https://brandur.org/logfmt to get more information about logfmt key-value structured logging.}
+  spec.homepage      = 'https://github.com/MitinPavel/logfmt_marshalling'
+  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.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/logfmt_marshalling/marshaller_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+describe ::LogfmtMarshalling::Marshaller do
+  it 'serializes an empty hash' do
+    actual = marshal({})
+    expect(actual).to eq('')
+  end
+
+  it 'serializes an empty string' do
+    actual = marshal 'key' => ''
+    expect(actual).to eq('key=""')
+  end
+
+  it 'serializes a whitespace string' do
+    actual = marshal 'key' => ' '
+    expect(actual).to eq('key=" "')
+  end
+
+  it 'drops the TrueClass instance value' do
+    actual = marshal 'key' => true
+    expect(actual).to eq('key')
+  end
+
+  it "serializes the FalseClass instance value" do
+    actual = marshal 'key' => false
+    expect(actual).to eq('key=false')
+  end
+
+  it 'serializes a quoted true as a string' do
+    actual = marshal 'key' => 'true'
+    expect(actual).to eq('key="true"')
+  end
+
+  it 'serializes a quoted false as a string' do
+    actual = marshal 'key' => 'false'
+    expect(actual).to eq('key="false"')
+  end
+
+  it 'serializes a single key-value pair' do
+    actual = marshal 'key' => 'value'
+    expect(actual).to eq('key=value')
+  end
+
+  it 'serializes multiple key-value pairs' do
+    actual = marshal 'key1' => true, 'key2' => true
+    expect(actual).to eq('key1 key2')
+  end
+
+  it 'preserves order of serialized pairs' do
+    actual = marshal 'key1' => 'value1', 'key2' => 'value2'
+    expect(actual).to eq('key1=value1 key2=value2')
+  end
+
+  it 'serializes mixed single/non-single pairs' do
+    actual = marshal 'key1' => 'value1', 'key2' => true
+    expect(actual).to eq('key1=value1 key2')
+  end
+
+  it 'preserves order of  mixed single/non-single pairs' do
+    actual = marshal 'key1' => true, 'key2' => 'value2'
+    expect(actual).to eq('key1 key2=value2')
+  end
+
+  it 'quotes values with whitespaces' do
+    actual = marshal 'key' => 'a value'
+    expect(actual).to eq('key="a value"')
+  end
+
+  it 'serializes escaped quote value ' do
+    actual = marshal 'key' => 'quoted \" value', 'r' => 'esc\\t'
+    expect(actual).to eq('key="quoted \" value" r="esc\t"')
+  end
+
+  it 'serializes mixed pairs' do
+    actual = marshal 'key1' => 'quoted \" value', 'key2' => true, 'key3' => 'value3'
+    expect(actual).to eq('key1="quoted \" value" key2 key3=value3')
+  end
+
+  it 'serializes mixed characters pairs' do
+    actual = marshal 'foo' => 'bar',
+                     'a' => 14,
+                     'baz' => 'hello kitty',
+                     'ƒ' => '2h3s',
+                     'cool%story' => 'bro',
+                     'f' => true,
+                     '%^asdf' => true
+    expect(actual).to eq('foo=bar a=14 baz="hello kitty" ƒ=2h3s cool%story=bro f %^asdf')
+  end
+
+  it 'serializes Ruby Symbol objects as Strings' do
+    actual = marshal key: :value
+    expect(actual).to eq('key=value')
+  end
+
+  it 'serializes a positive integer' do
+    actual = marshal 'key' => 234
+    expect(actual).to eq('key=234')
+  end
+
+  it 'serializes a negative integer' do
+    actual = marshal 'key' => -3428
+    expect(actual).to eq('key=-3428')
+  end
+
+  it 'serializes a bignum' do
+    bignum = 9999999999999999999
+    expect(bignum).to be_a(Bignum)
+
+    actual = marshal 'key' => bignum
+
+    expect(actual).to eq('key=9999999999999999999')
+  end
+
+  it 'serializes a positive float' do
+    actual = marshal 'key' => 3.14
+    expect(actual).to eq('key=3.14')
+  end
+
+  it 'serializes a negative float' do
+    actual = marshal 'key' => -0.9934
+    expect(actual).to eq('key=-0.9934')
+  end
+
+  it 'serializes an exponential float' do
+    actual = marshal 'key' => 2.342342342342344e+18
+    expect(actual).to eq('key=2.342342342342344e+18')
+  end
+
+  %w(
+      0
+      1
+      -1
+      123.4
+      -3.14
+      1.0e6
+      1.2e-3
+      4E20
+      4e+20
+  ).each do |quoted_float|
+    it %{serializes a quoted number ("#{quoted_float}") as a string} do
+      actual = marshal 'key' => quoted_float
+      expect(actual).to eq(%{key="#{quoted_float}"})
+    end
+  end
+
+  def marshal(data)
+    described_class.new.marshal data
+  end
+end

data/spec/logfmt_marshalling_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ::LogfmtMarshalling do
+  describe '.marshal' do
+    it 'delegates work to LogfmtMarshalling::Marshaller' do
+      expect_any_instance_of(::LogfmtMarshalling::Marshaller).to receive(:marshal).with 'k' => 'v'
+
+      described_class.marshal 'k' => 'v'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'logfmt_marshalling'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: logfmt_marshalling
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pavel Mitin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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 Ruby gem for emitting strings in logfmt logging format. Check out https://brandur.org/logfmt
+  to get more information about logfmt key-value structured logging.
+email:
+- mitin.pavel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/logfmt_marshalling.rb
+- lib/logfmt_marshalling/marshaller.rb
+- lib/logfmt_marshalling/version.rb
+- logfmt_marshalling.gemspec
+- spec/logfmt_marshalling/marshaller_spec.rb
+- spec/logfmt_marshalling_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/MitinPavel/logfmt_marshalling
+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.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for emitting strings in logfmt logging format.
+test_files:
+- spec/logfmt_marshalling/marshaller_spec.rb
+- spec/logfmt_marshalling_spec.rb
+- spec/spec_helper.rb