lines 0.1.19 → 0.1.20

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjI0OWIzNjUxNDMzZjFiOGFjYjQ2NWY0YzBiMGFkNGRiNTkyM2Q1YQ==
+    NGU4YzQzOTg2NjJlNWFjNjA2ZDliYzEzYTRkMDE3OWJjZGRjZmI0NQ==
   data.tar.gz: !binary |-
-    Y2EzOWYzNDlmZjkyMGRlZDJkNWFjNGU0NjYyNzU1YTZkYzUwYjlkNg==
+    NzIzODU1MzljMTg5N2I1MzVhMjdlN2EwOTE4YmVlY2ZlMjE4NDM4Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NGY3YTIwMmExZDM0OGI3OTQ4YTA3ZmJiODkyNzUzMzIxMTZiYmFmMWEyYmUy
-    NWM4YTQ4M2VlNjc5ZDlmNmEwZDM2MTZkYWI0NDJiYjA3YjBhZTlhMGI1MDAx
-    YzNkMmMwNmJiZGU0MTc4YjM0MzhkN2VkOGMzZDBiN2U1MmVkZjI=
+    YmQ0MGI3ODU4ZWJhNDM1NzA5ZDlmMWI2NjNiMmFjMDQ2YjZjZDExZjExMjk4
+    MDFlZWQyMmRmY2IxZjY4NDc1ODljZmI3NmYwZTkzZjBiYjUwZWY0OWI4MjU4
+    ZDE3NThhMDhhMWY5NTlkYWZhY2M3YjcwMjZhY2Q2MzlhZDNlNjE=
   data.tar.gz: !binary |-
-    NTcwMTE4YmIxMmU2MTE3YTZhY2Q5NzNlMDg4NTBhODY5N2MxMTY2NWVjYzli
-    NGNjMzE1ZWFmMDBjNGQ0NTE1NDFhMDY3YWI4MDQ3MDQ0MmMxY2ZjMTliMzU5
-    ZTUxM2Y1OWQ5NmQ5MGQwZThmODNhOWFhYWQwYzkwYWEyODBjOTY=
+    OTg1YjllMzkyNjMzNmIwZjdmYTU2MDQzZmIzNmNmY2IyOTE5ZTJiNDkwYWRi
+    M2U1YWE5OWEzNjk5YjkzMmU2OWFlZDRjMWI1NzZmNjVjOWQwY2NkNmY3NmYx
+    MjIzNWFjMjNmNjllMGZlZDBlNTljNzMwZmE4OWUzYjMzZWIzYTQ=

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/lib/lines.rb

@@ -56,8 +56,7 @@ module Lines
     # obj - a ruby hash
     # args -
     def log(obj, args={})
-      obj = sanitize_obj(obj, args)
-      obj = global.merge(obj)
+      obj = prepare_obj(obj, args)
       outputters.each{|out| out.output(dumper, obj) }
       obj
     end
@@ -65,25 +64,15 @@ module Lines
     # Add data to the logs
     #
     # data - a ruby hash
+    #
+    # return a Context instance
     def context(data={})
-      new_context = Context.new global.merge(data)
+      new_context = Context.new ensure_hash!(data)
       yield new_context if block_given?
       new_context
     end
 
-    class Context
-      attr_reader :data
-
-      def initialize(data)
-        @data = data
-      end
-
-      def log(obj, args={})
-        Lines.log(obj, args.merge(data))
-      end
-    end
-
-    # A backward-compatibile logger
+    # Returns a backward-compatibile logger
     def logger
       @logger ||= (
         require "lines/logger"
@@ -91,23 +80,34 @@ module Lines
       )
     end
 
+    def ensure_hash!(obj) # :nodoc:
+      return {} unless obj
+      return obj if obj.kind_of?(Hash)
+      return obj.to_h if obj.respond_to?(:to_h)
+      obj = {msg: obj}
+    end
+
     protected
 
-    def sanitize_obj(obj, args={})
+    def prepare_obj(obj, args={})
       if obj.kind_of?(Exception)
         ex = obj
         obj = {ex: ex.class, msg: ex.to_s}
         if ex.respond_to?(:backtrace) && ex.backtrace
           obj[:backtrace] = ex.backtrace
         end
-      elsif !obj.kind_of?(Hash)
-        if obj.respond_to?(:to_h)
-          obj = obj.to_h
-        else
-          obj = {msg: obj}
-        end
+      else
+        obj = ensure_hash!(obj)
       end
-      obj.merge(args)
+
+      args = ensure_hash!(args)
+
+      g = global.inject({}) do |h, (k,v)|
+        h[k] = v.respond_to?(:call) ? v.call : v
+        h
+      end
+
+      g.merge(obj.merge(args))
     end
 
     def to_outputter(out)
@@ -125,6 +125,19 @@ module Lines
     end
   end
 
+  # Wrapper object that holds a given context. Emitted by Lines.with
+  class Context
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def log(obj, args={})
+      Lines.log obj, Lines.ensure_hash!(args).merge(data)
+    end
+  end
+
   class StreamOutputter
     # stream must accept a #write(str) message
     def initialize(stream = $stderr)
@@ -157,9 +170,8 @@ module Lines
     }
 
     def initialize(syslog = Syslog, app_name=nil)
-      @app_name = app_name
       @syslog = syslog
-      prepare_syslog
+      prepare_syslog(app_name)
     end
 
     def output(dumper, obj)
@@ -176,10 +188,9 @@ module Lines
 
     protected
 
-    attr_reader :app_name
     attr_reader :syslog
 
-    def prepare_syslog
+    def prepare_syslog(app_name)
       unless syslog.opened?
         # Did you know ? app_name is detected by syslog if nil
         syslog.open(app_name,

data/lib/lines/version.rb

@@ -1,3 +1,3 @@
 module Lines
-  VERSION = "0.1.19"
+  VERSION = "0.1.20"
 end

data/spec/lines_spec.rb

@@ -6,59 +6,90 @@ describe Lines do
   let(:outputter) { StringIO.new }
   let(:output) { outputter.string }
   before do
+    Lines.global.replace({})
     Lines.use(outputter)
   end
 
-  it "logs stuff" do
-    Lines.log(foo: 'bar')
-    expect(output).to eq('foo=bar' + Lines::NL)
-  end
+  context ".log" do
+    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 "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 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 "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 "works with anything" do
+      Lines.log("anything1", "anything2")
+      expect(output).to eq('msg=anything2' + 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)
+    it "doesn't convert nil args to msg" do
+      Lines.log("anything", nil)
+      expect(output).to eq('msg=anything' + Lines::NL)
+    end
   end
 
-  it "has contextes" do
-    Lines.context(foo: "bar").log(a: 'b')
-    expect(output).to eq('a=b foo=bar' + Lines::NL)
+  context ".context" do
+    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 "mixes everything" do
+      Lines.global[:app] = :self
+      ctx = Lines.context(foo: "bar")
+      ctx.log('msg', ahoi: true)
+      expect(output).to eq('app=self msg=msg ahoi=#t foo=bar' + Lines::NL)
+    end
   end
 
-  it "has contextes with blocks" do
-    Lines.context(foo: "bar") do |ctx|
-      ctx.log(a: 'b')
+  context ".logger" do
+    it "is provided for backward-compatibility" do
+      l = Lines.logger
+      l.info("hi")
+      expect(output).to eq('pri=info msg=hi' + Lines::NL)
     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)
+  context ".global" do
+    it "prepends data to the line" do
+      Lines.global["app"] = :self
+      Lines.log 'hey'
+      expect(output).to eq('app=self msg=hey' + Lines::NL)
+    end
+
+    it "resolves procs dynamically" do
+      count = 0
+      Lines.global[:count] = proc{ count += 1 }
+      Lines.log 'test1'
+      Lines.log 'test2'
+      expect(output).to eq(
+        'count=1 msg=test1' + Lines::NL +
+        'count=2 msg=test2' + Lines::NL
+      )
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lines
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.20
 platform: ruby
 authors:
 - Jonas Pfenniger
@@ -45,10 +45,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    lines (0.1.18)
-
-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)
-    rake (0.9.2.2)
-    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
-  bundler (~> 1.3)
-  lines!
-  parslet
-  rake
-  rdoc
-  rspec