lines 0.1.16 → 0.1.18

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDMyYWMxNDMyYjgzY2UwMzQ3NDhlYmI2MmM2ZjBlMWViMjM5MDUwYg==
+    ODA2Y2ZhNTJmYzQwYTE4ZDU1NjNhNDQ4MWVhNzAxZmMwZDcyY2U4ZA==
   data.tar.gz: !binary |-
-    OTJkNjY2ZGJiMTIwNGIwZThlNDQ4ZTRhYzU0NGY0MjNjYTk3N2M1NA==
+    Nzc3ZTEzMDczYmI1ZGVhNjk3YmFhOGQzODhjYjUzOTU1NDkxNjM3Mw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZmU2ZGI1ZDZmN2U2ZTIzMmI5ZDVjZmIyZjk1MGFmNjcxNTYzMzk1ZGEwZWY5
-    MzEwNTU1YTc2ZWUxMGI2NDEyMDU4NDBhZTIwMWQ1MWZiNjI5Mzg4N2EzMGJl
-    MjUxZTNmMGQ4ZWE0OTQxZTQ4NzMwMzQzY2M3YTllZmViOTVkYTQ=
+    YmQyNDJkZjEwMjdlOWMwMGIyMjQwYzM0Y2NhMTk0ZGNkYjk2OWZkZTg4MWQx
+    NTRlMjZmNDkyNzM2ZTZjODljZmFiMzNkMWM2NzI5ZjMzZmM0ODVhNTExY2Ew
+    MzZjN2Y2YzE4MDY4Y2QzMjUyZTk3MWZiMDFmZDUyOTUyMTUzZjg=
   data.tar.gz: !binary |-
-    MzM5MTI0YzE5NGVlMjEzNTk2OTkwODk0MDViYzRmN2YwMjBmMDc5NGM5ZmNm
-    MThiZTQ1NDgxNDJhOTBjNDM4NTAzODZhYjk0MjQ3MjI4YzdiY2FjN2YzMjFm
-    NGQzODEzMmRiNzdhMWJkMmZlY2Q2OTMyZGU5ZmMxYzVkM2UyN2Y=
+    NDQxOTdiMTc0ODk5MjBhYjNmY2JhOTcwZDk1ZTUzNmRlODRkOTdlMGY4MGVm
+    NTA1NTdkYzdjYjYyODBlNTA3N2RjMGY0M2RkY2U0ODUyYTU2MjA3ZDg2YTQy
+    MjRkNzdhZmZiYmY3MGI1ZGEyNGQxYjU4MDU5N2I5MzQzOTllMGI=

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+gemspec
+group :development do
+  gem 'parslet'
+  gem 'rdoc'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    lines (0.1.16)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    blankslate (2.1.2.4)
+    diff-lcs (1.2.1)
+    json (1.7.7)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    rdoc (4.0.0)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lines!
+  parslet
+  rdoc
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonas Pfenniger
+
+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/lib/lines.rb

@@ -290,7 +290,10 @@ module Lines
       s = s.to_s
       unless is_literal?(s)
         s = s.inspect
-        s[0] = s[-1] = "'" unless s[1..-2].include?("'")
+        unless s[1..-2].include?("'")
+          s[0] = s[-1] = "'"
+          s.gsub!('\"', '"')
+        end
       end
       s
     end

data/lib/lines/version.rb

@@ -1,3 +1,3 @@
 module Lines
-  VERSION = "0.1.16"
+  VERSION = "0.1.18"
 end

data/lines.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lines/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lines"
+  spec.version       = Lines::VERSION
+  spec.authors       = ["Jonas Pfenniger"]
+  spec.email         = ["jonas@pfenniger.name"]
+  spec.description   = %q{structured logs for humans}
+  spec.summary       = %q{Lines is an opinionated structured logging library}
+  spec.homepage      = 'https://github.com/zimbatm/lines-ruby'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rspec"
+end

data/spec/lines_loader_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'lines/loader'
+
+module Lines
+  describe Loader do
+    subject { Loader }
+
+    it "can load stuff" do
+      expect(Loader.load 'foo=bar').to eq("foo" => "bar")
+    end
+  end
+
+  describe Parser do
+    let(:parser) { Lines::Parser.new }
+
+    context "value parsing" do
+      let(:value_parser) { parser.value }
+
+      it "parses integers" do
+        pending
+        expect(value_parser).to     parse("1")
+        expect(value_parser).to     parse("-123")
+        expect(value_parser).to     parse("120381")
+        expect(value_parser).to     parse("181")
+      end
+
+      it "parses floats" do
+        pending
+        expect(value_parser).to     parse("0.1")
+        expect(value_parser).to     parse("3.14159")
+        expect(value_parser).to     parse("-0.00001")
+      end
+
+      it "parses booleans" do
+        pending
+        expect(value_parser).to     parse("#t")
+        expect(value_parser).to     parse("#f")
+      end
+
+      it "parses datetimes" do
+        pending
+        expect(value_parser).to     parse("1979-05-27T07:32:00Z")
+        expect(value_parser).to     parse("2013-02-24T17:26:21Z")
+        expect(value_parser).to_not parse("1979l05-27 07:32:00")
+      end
+
+      it "parses strings" do
+        pending
+        expect(value_parser).to     parse('""')
+        expect(value_parser).to     parse('"hello world"')
+        expect(value_parser).to     parse('"hello\\nworld"')
+        expect(value_parser).to     parse('"hello\\t\\n\\\\\\0world\\n"')
+        expect(value_parser).to_not parse("\"hello\nworld\"")
+      end
+    end
+  end
+
+  describe Transformer do
+
+  end
+end

data/spec/lines_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+require 'lines'
+require 'stringio'
+
+describe Lines do
+  let(:outputter) { StringIO.new }
+  let(:output) { outputter.string }
+  before do
+    Lines.use(outputter)
+  end
+
+  it "logs stuff" do
+    Lines.log(foo: 'bar')
+    expect(output).to eq('foo=bar' + Lines::NL)
+  end
+
+  it "supports a first msg argument" do
+    Lines.log("this user is annoying", user: 'bob')
+    expect(output).to eq("msg='this user is annoying' user=bob" + Lines::NL)
+  end
+
+  it "logs exceptions" do
+    Lines.log(StandardError.new("error time!"), user: 'bob')
+    expect(output).to eq("ex=StandardError msg='error time!' user=bob" + Lines::NL)
+  end
+
+  it "logs exception backtraces when available" do
+    ex = (raise "foo" rescue $!)
+    #expect(ex).not_to eq(nil)
+    Lines.log(ex)
+    expect(output).to match(/ex=RuntimeError msg=foo backtrace=\[[^\]]+\]/)
+  end
+
+  it "works with anything" do
+    Lines.log("anything")
+    expect(output).to eq('msg=anything' + Lines::NL)
+  end
+
+  it "has global context" do
+    Lines.global["app"] = :self
+    Lines.log({})
+    Lines.global.replace({})
+    expect(output).to eq('app=self' + Lines::NL)
+  end
+
+  it "has contextes" do
+    Lines.context(foo: "bar").log(a: 'b')
+    expect(output).to eq('a=b foo=bar' + Lines::NL)
+  end
+
+  it "has contextes with blocks" do
+    Lines.context(foo: "bar") do |ctx|
+      ctx.log(a: 'b')
+    end
+    expect(output).to eq('a=b foo=bar' + Lines::NL)
+  end
+
+  it "has a backward-compatible logger" do
+    l = Lines.logger
+    l.info("hi")
+    expect(output).to eq('pri=info msg=hi' + Lines::NL)
+  end
+end
+
+describe Lines::Dumper do
+  subject { Lines::Dumper.new }
+  def expect_dump(obj)
+    expect(subject.dump obj)
+  end
+
+  it do
+    expect_dump(foo: 'bar').to eq('foo=bar')
+  end
+
+  it "dumps true, false and nil as #t, #f and nil" do
+    expect_dump(foo: true).to eq('foo=#t')
+    expect_dump(foo: false).to eq('foo=#f')
+    expect_dump(foo: nil).to eq('foo=nil')
+  end
+
+  it "dumps empty strings correclty" do
+    expect_dump(foo: '').to eq('foo=')
+  end
+
+  it "dumps a string with spaces surrounded by single quotes" do
+    expect_dump(foo: 'some" thing').to eq("foo='some\" thing'")
+  end
+
+  it "dumps a string with spaces and a single quote sourrounded with double quotes" do
+    expect_dump(foo: "foo ' bar").to eq("foo=\"foo ' bar\"")
+  end
+
+  it "can dump a basicobject" do
+    expect_dump(foo: BasicObject.new).to match(/foo=#<BasicObject:0x[0-9a-f]+>/)
+  end
+
+  it "can dump IO objects" do
+    expect_dump(foo: File.open(__FILE__)).to match(/foo=#<File:[^>]+>/)
+    expect_dump(foo: STDOUT).to eq("foo=#<IO:<STDOUT>>")
+  end
+
+  it "dumps time as ISO zulu format" do
+    expect_dump(foo: Time.at(1337)).to eq('foo=1970-01-01T01:22:17+01:00')
+  end
+
+  it "dumps symbols as strings" do
+    expect_dump(foo: :some_symbol).to eq('foo=some_symbol')
+    expect_dump(foo: :"some symbol").to eq("foo='some symbol'")
+  end
+
+  it "dumps numbers appropriately" do
+    expect_dump(foo: 10e3).to eq('foo=10000.0')
+    expect_dump(foo: 1).to eq('foo=1')
+    expect_dump(foo: -1).to eq('foo=-1')
+    # FIXME: don't put all the decimals
+    #expect_dump(foo: 4.0/3).to eq('foo=1.333')
+  end
+
+  it "dumps arrays appropriately" do
+    expect_dump(foo: [1,2,:a]).to eq('foo=[1 2 a]')
+  end
+
+  it "dumps [number, literal] tuples as numberliteral" do
+    expect_dump(foo: [3, :ms]).to eq('foo=3ms')
+    expect_dump(foo: [54.2, 's']).to eq('foo=54.2s')
+  end
+end
+
+describe Lines::UniqueIDs do
+  include Lines::UniqueIDs
+
+  it "generates a unique ID" do
+    expect(id.size).to be > 1
+  end
+
+  it "generates a unique ID on each call" do
+    id1 = id
+    id2 = id
+    expect(id1).to_not eq(id2)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+
+  # 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'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lines
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.18
 platform: ruby
 authors:
 - Jonas Pfenniger
@@ -9,22 +9,60 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-05-04 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: structured logs for humans
-email: jonas@pfenniger.name
+email:
+- jonas@pfenniger.name
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
+- lib/lines.rb
 - lib/lines/active_record.rb
 - lib/lines/loader.rb
 - lib/lines/logger.rb
 - lib/lines/rack_logger.rb
 - lib/lines/version.rb
-- lib/lines.rb
+- lines.gemspec
+- spec/lines_loader_spec.rb
+- spec/lines_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/zimbatm/lines-ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -45,5 +83,8 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: structured logs for humans
-test_files: []
+summary: Lines is an opinionated structured logging library
+test_files:
+- spec/lines_loader_spec.rb
+- spec/lines_spec.rb
+- spec/spec_helper.rb