lugg 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 269ec3ed7cc8b001cb923289fcc45a991f1d6fbb
-  data.tar.gz: 9f34b5919963cfc7f972887ab416d6d1e21abf92
+  metadata.gz: abcad075a8a7f632dbf9fd6d144291d3ae4273c9
+  data.tar.gz: 2a24b47421c0b4c40615f1a8ccff3158b64b8897
 SHA512:
-  metadata.gz: 4c2a1b31b30905a76ce343f57510fa5373dfbe06c499b9819d57e7e40e90cf11eb3ea6f858eeb3390f3fabe8a92d466984b39e7bf5f6b9fbe3584d35678efbef
-  data.tar.gz: c673f9f5112bb7233ec78c882d913bbecbb7a5f425043ae5053eae42183d0930397469b0d411ef621ea6d47082b76143ed20f7f99a6ddba40c89526889b3ed0b
+  metadata.gz: 685c248a1c3da1cc2798164108a18538062aece46f8edf00d7104e3c07354895ba73249e330aee99547ce87d3b95f0c26ff50aaa6bf85f9e1de08660307e2594
+  data.tar.gz: 83940e320771cb6d5b5c37a430dd5c001f728db52f0d332bef0bbec51cd213ff448065dc47dd6a4599a58c2a16b104f19d38471dff2fcd2a15fecc5f9f1e8abb

data/.rubocop.yml

@@ -24,13 +24,9 @@ LineLength:
 AndOr:
   Enabled: false
 
-ClassLength:
-  Exclude:
-    - lib/lugg/runner.rb
-
-MethodLength:
-  Exclude:
-    - lib/lugg/runner.rb
-
 DoubleNegation:
   Enabled: false
+
+TrivialAccessors:
+  Exclude:
+    - lib/lugg/switch.rb

data/lib/lugg/request.rb

@@ -74,8 +74,11 @@ module Lugg
 
     def params
       params_string = source[/^  Parameters: (.+)$/, 1]
-      return {} unless params_string
-      eval(params_string) rescue {} # rubocop:disable Eval, RescueModifier
+      String(params_string)
+        .scan(/(?<!\\)"(.+?)(?<!\\)"=>(?<!\\)"(.+?)(?<!\\)"/)
+        .each_with_object({}) do |match, output|
+        output[match[0]] = match[1]
+      end
     end
   end
 end

data/lib/lugg/runner.rb

@@ -1,6 +1,7 @@
 require 'lugg/version'
 require 'lugg/filter'
 require 'lugg/streamer'
+require 'lugg/switches'
 require 'optparse'
 require 'optparse/time'
 
@@ -29,17 +30,6 @@ module Lugg
       end
     end
 
-    private
-
-    def reset
-      @combine = false
-      @last_block = nil
-    end
-
-    def combine_clauses?
-      @combine && @last_block
-    end
-
     def add_clause(&block)
       if combine_clauses?
         prev_block = @last_block
@@ -51,6 +41,12 @@ module Lugg
       end
     end
 
+    def combine_next
+      @combine = true
+    end
+
+    private
+
     def options
       @options ||= OptionParser.new do |o|
         o.banner = <<-EOS
@@ -60,91 +56,17 @@ Parses log entries from FILE or STDIN and uses [options] to control what is
 sent STDOUT.
 EOS
         o.separator ''
+        Switch.apply_all(o, self)
+      end
+    end
 
-        o.on '--and',
-             'Combine previous and next clause with AND instead of OR' do
-          @combine = true
-        end
-
-        %w(get post put delete head patch).each do |verb|
-          o.on "--#{verb}", "Limit to #{verb.upcase} requests" do
-            add_clause { |r| r.method == verb.upcase }
-          end
-        end
-
-        o.on '-c',
-             '--controller CONTROLLER',
-             'Limit to requests handled by CONTROLLER' do |controller|
-          add_clause { |r| r.controller == controller }
-        end
-
-        o.on '-a',
-             '--action CONTROLLER_ACTION',
-             'Limit to requests handled by CONTROLLER_ACTION' do |ca|
-          add_clause { |r| r.action == ca }
-        end
-
-        %w(json html xml csv pdf js).each do |format|
-          o.on "--#{format}", "Limit to #{format} requests" do
-            add_clause { |r| r.format.downcase == format }
-          end
-        end
-
-        o.on '-f', '--format FORMAT', 'Limit to FORMAT requests' do |format|
-          add_clause { |r| r.format.downcase == format.downcase }
-        end
-
-        o.on '-s',
-             '--status CODE',
-             'Limit requests with status code CODE' do |code|
-          add_clause { |r| r.code == code }
-        end
-
-        o.on '--since TIME',
-             Time,
-             'Limit to requests made after TIME' do |time|
-          add_clause { |r| r.timestamp > time }
-        end
-
-        o.on '--until TIME',
-             Time,
-             'Limit to requests made before TIME' do |time|
-          add_clause { |r| r.timestamp < time }
-        end
-
-        o.on '-d',
-             '--duration N',
-             Integer,
-             'Limit to requests longer than N ms' do |n|
-          add_clause { |r| r.duration > n }
-        end
-
-        o.on '-u',
-             '--uri URI',
-             Regexp,
-             'Limit to requests matching URI' do |uri|
-          add_clause { |r| r.uri =~ uri }
-        end
-
-        o.on '-p',
-             '--param KEY=VAL',
-             'Limit to requests with param KEY => VAL' do |param|
-          key, value = param.split('=', 2)
-          add_clause { |r| r.params[key] == value }
-        end
-
-        o.separator ''
-
-        o.on_tail '-v', '--version', 'Display version number' do
-          puts Lugg::VERSION
-          exit
-        end
+    def reset
+      @combine = false
+      @last_block = nil
+    end
 
-        o.on_tail '-h', '--help', 'Display this message' do
-          puts o
-          exit
-        end
-      end
+    def combine_clauses?
+      @combine && @last_block
     end
   end
 end

data/lib/lugg/switch.rb

@@ -0,0 +1,58 @@
+module Lugg
+  # An object representing a command line swith with certain behaviour. The
+  # Runner applies switches to its own internal `OptionParser` object to build
+  # the CLI and provide querying functionality.
+  #
+  # @see Runner
+  class Switch
+    @queries = []
+
+    # Define a new Switch object and add it to the global collection of
+    # switches.
+    def self.define(*args, &block)
+      @queries << new(*args).tap { |obj| obj.instance_eval(&block) }
+    end
+
+    # Call {#apply} on each {Switch} in the global collection to register the
+    # callback on a given object.
+    def self.apply_all(*args)
+      @queries.each do |query|
+        query.apply_to(*args)
+      end
+    end
+
+    def initialize(method = :on)
+      @method = method
+      @flags  = nil
+      @cast   = nil
+      @desc   = nil
+      @action = nil
+    end
+
+    def apply_to(options, obj)
+      @options = options
+      @obj     = obj
+      @options.send(@method, *[@flags, @cast, @desc].flatten.compact, &@action)
+    end
+
+    private
+
+    def flags(*flags)
+      @flags = flags
+    end
+
+    def cast(obj)
+      @cast = obj
+    end
+
+    def desc(msg)
+      @desc = msg
+    end
+
+    def action(&block)
+      @action = block
+    end
+
+    attr_reader :options, :obj
+  end
+end

data/lib/lugg/switches.rb

@@ -0,0 +1,127 @@
+require 'lugg/switch'
+
+# Collection of available command line argument switches and their behaviour.
+module Lugg
+  Switch.define do
+    flags '--and'
+    desc 'Combine previous and next clause with AND instead of OR'
+    action do
+      obj.combine_next
+    end
+  end
+
+  %w(get post put delete head patch).each do |verb|
+    Switch.define do
+      flags "--#{verb}"
+      desc "Limit to #{verb.upcase} requests"
+      action do
+        obj.add_clause { |r| r.method == verb.upcase }
+      end
+    end
+  end
+
+  Switch.define do
+    flags '-c', '--controller CONTROLLER'
+    desc 'Limit to requests handled by CONTROLLER'
+    action do |controller|
+      obj.add_clause { |r| r.controller == controller }
+    end
+  end
+
+  Switch.define do
+    flags '-a', '--action CONTROLLER_ACTION'
+    desc 'Limit to requests handled by CONTROLLER_ACTION'
+    action do |ca|
+      obj.add_clause { |r| r.action == ca }
+    end
+  end
+
+  %w(json html xml csv pdf js).each do |format|
+    Switch.define do
+      flags "--#{format}"
+      desc "Limit to #{format} requests"
+      action do
+        obj.add_clause { |r| r.format.downcase == format }
+      end
+    end
+  end
+
+  Switch.define do
+    flags '-f', '--format FORMAT'
+    desc 'Limit to FORMAT requests'
+    action do |format|
+      obj.add_clause { |r| r.format.downcase == format.downcase }
+    end
+  end
+
+  Switch.define do
+    flags '-s', '--status CODE'
+    desc 'Limit requests with status code CODE'
+    action do |code|
+      obj.add_clause { |r| r.code == code }
+    end
+  end
+
+  Switch.define do
+    flags '--since TIME'
+    cast Time
+    desc 'Limit to requests made after TIME'
+    action do |time|
+      obj.add_clause { |r| r.timestamp > time }
+    end
+  end
+
+  Switch.define do
+    flags '--until TIME'
+    cast Time
+    desc 'Limit to requests made before TIME'
+    action do |time|
+      obj.add_clause { |r| r.timestamp < time }
+    end
+  end
+
+  Switch.define do
+    flags '-d', '--duration N'
+    cast Integer
+    desc 'Limit to requests longer than N ms'
+    action do |n|
+      obj.add_clause { |r| r.duration > n }
+    end
+  end
+
+  Switch.define do
+    flags '-u', '--uri URI'
+    cast Regexp
+    desc 'Limit to requests matching URI'
+    action do |uri|
+      obj.add_clause { |r| r.uri =~ uri }
+    end
+  end
+
+  Switch.define do
+    flags '-p', '--param PAIR'
+    desc 'Limit to requests with param KEY => VAL'
+    action do |param|
+      key, value = param.split('=', 2)
+      obj.add_clause { |r| r.params[key] == value }
+    end
+  end
+
+  Switch.define :on_tail do
+    flags '-v', '--version'
+    desc 'Display version number'
+    action do
+      puts Lugg::VERSION
+      exit
+    end
+  end
+
+  Switch.define :on_tail do
+    flags '-h', '--help'
+    desc 'Display this message'
+    action do
+      puts options
+      exit
+    end
+  end
+end

data/lib/lugg/version.rb

@@ -1,3 +1,3 @@
 module Lugg
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/lugg/runner_spec.rb

@@ -32,7 +32,7 @@ module Lugg
       let(:options) { %w(--post --and --controller PostsController) }
       let(:input)   { "Started GET\nProcessing by PostsController#index as HTML\nCompleted 1\nStarted POST\nProcessing by BlogController#create as HTML\nCompleted 2\n" }
 
-      it 'limits requests to GET requests' do
+      it 'limits to post requests in PostsController' do
         subject.run(StringIO.new(input))
         expect(stdout.string).to eql("Started POST\nProcessing by BlogController#create as HTML\nCompleted 2\n")
       end
@@ -42,7 +42,7 @@ module Lugg
       let(:options) { %w(--controller PostsController) }
       let(:input)   { "Started GET\nProcessing by PostsController#index as HTML\nCompleted 1\nStarted POST\nProcessing by BlogController#create as HTML\nCompleted 2\n" }
 
-      it 'limits requests to GET requests' do
+      it 'limits to just PostController' do
         subject.run(StringIO.new(input))
         expect(stdout.string).to eql("Started GET\nProcessing by PostsController#index as HTML\nCompleted 1\n")
       end
@@ -52,17 +52,17 @@ module Lugg
       let(:options) { %w(--since 2012-03-20) }
       let(:input)   { "Started GET at 2012-03-21 12:00 +0100\nCompleted 1\nStarted GET at 2012-03-19\nProcessing by BlogController#create as HTML\nCompleted 2\n" }
 
-      it 'limits requests to GET requests' do
+      it 'limits to after the date' do
         subject.run(StringIO.new(input))
         expect(stdout.string).to eql("Started GET at 2012-03-21 12:00 +0100\nCompleted 1\n")
       end
     end
 
-    context 'with --param foo=bar' do
-      let(:options) { ['--param', 'foo=val'] }
+    context 'with --param foo=val' do
+      let(:options) { %w(--param foo=val) }
       let(:input)   { "Started GET\n  Parameters: {\"foo\"=>\"val\"}\nCompleted 1\nStarted POST\nProcessing by BlogController#create as HTML\nCompleted 2\n" }
 
-      it 'limits requests to GET requests' do
+      it 'limits to requests with given param' do
         subject.run(StringIO.new(input))
         expect(stdout.string).to eql("Started GET\n  Parameters: {\"foo\"=>\"val\"}\nCompleted 1\n")
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lugg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Arjan van der Gaag
@@ -107,6 +107,8 @@ files:
 - lib/lugg/request_matcher.rb
 - lib/lugg/runner.rb
 - lib/lugg/streamer.rb
+- lib/lugg/switch.rb
+- lib/lugg/switches.rb
 - lib/lugg/version.rb
 - lugg.gemspec
 - spec/fixtures/example.log