lugg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 269ec3ed7cc8b001cb923289fcc45a991f1d6fbb
+  data.tar.gz: 9f34b5919963cfc7f972887ab416d6d1e21abf92
+SHA512:
+  metadata.gz: 4c2a1b31b30905a76ce343f57510fa5373dfbe06c499b9819d57e7e40e90cf11eb3ea6f858eeb3390f3fabe8a92d466984b39e7bf5f6b9fbe3584d35678efbef
+  data.tar.gz: c673f9f5112bb7233ec78c882d913bbecbb7a5f425043ae5053eae42183d0930397469b0d411ef621ea6d47082b76143ed20f7f99a6ddba40c89526889b3ed0b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--order rand
+-I lib
+--require lugg

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  Includes:
+    - '**/*.gemspec'
+    - '**/Rakefile'
+  Excludes:
+    - 'bin/*'
+
+SignalException:
+  EnforcedStyle: only_raise
+
+SymbolArray:
+  Enabled: true
+
+Documentation:
+  Exclude:
+    - spec/**/*.rb
+    - lib/lugg/version.rb
+
+LineLength:
+  Exclude:
+    - spec/**/*.rb
+    - lib/lugg.rb
+
+AndOr:
+  Enabled: false
+
+ClassLength:
+  Exclude:
+    - lib/lugg/runner.rb
+
+MethodLength:
+  Exclude:
+    - lib/lugg/runner.rb
+
+DoubleNegation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title "Lugg, Query Rails log files from the command line."
+--readme README.md
+--markup markdown
+--markup-provider kramdown
+--output-dir doc/api
+-
+HISTORY.md
+LICENSE

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Arjan van der Gaag
+
+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,89 @@
+# Lugg — query Rails log files [![Build Status](https://secure.travis-ci.org/avdgaag/lugg.png?branch=master)](http://travis-ci.org/avdgaag/lugg) [![Code Climate](https://codeclimate.com/github/avdgaag/lugg.png)](https://codeclimate.com/github/avdgaag/lugg)
+
+A tiny command line utility to search through Rails server log files and display
+requests that meet certain criteria.
+
+## Installation
+
+Lugg is distributed as a Ruby gem, which should be installed on most Macs and
+Linux systems. Once you have ensured you have a working installation of Ruby
+and Ruby gems, install the gem as follows from the command line:
+
+    $ gem install lugg
+
+You can verify the gem has installed correctly by checking its version number:
+
+    $ lugg -v
+
+If this generates an error, something has gone wrong. You should see something
+along the lines of `lugg 1.0.0`.
+
+## Usage
+
+Lugg takes one or more files as arguments or input on STDIN and redirects that
+content to STDOUT -- but not before applying some filters. Content will be
+parsed as Rails server log files and only the entire log entries matching your
+criteria are displayed.
+
+You supply criteria by passing in command line options. You can see a full list
+of accepted options by running `lugg -h`:
+
+```
+    --and                        Combine previous and next clause with AND instead of OR
+    --get                        Limit to GET requests
+    --post                       Limit to POST requests
+    --put                        Limit to PUT requests
+    --delete                     Limit to DELETE requests
+    --head                       Limit to HEAD requests
+    --patch                      Limit to PATCH requests
+-c, --controller CONTROLLER      Limit to requests handled by CONTROLLER
+-a, --action CONTROLLER_ACTION   Limit to requests handled by CONTROLLER_ACTION
+    --json                       Limit to json requests
+    --html                       Limit to html requests
+    --xml                        Limit to xml requests
+    --csv                        Limit to csv requests
+    --pdf                        Limit to pdf requests
+    --js                         Limit to js requests
+-f, --format FORMAT              Limit to FORMAT requests
+-s, --status CODE                Limit requests with status code CODE
+    --since TIME                 Limit to requests made after TIME
+    --until TIME                 Limit to requests made before TIME
+-d, --duration N                 Limit to requests longer than N ms
+-u, --uri URI                    Limit to requests matching URI
+-p, --param KEY=VAL              Limit to requests with param KEY => VAL
+
+-v, --version                    Display version number
+-h, --help                       Display this message
+```
+
+Note that all conditions are combined with OR, but you can combine two
+conditions with the `--and` flag.
+
+### Documentation
+
+See the inline [API docs](http://rubydoc.info/github/avdgaag/lugg/master/frames) for more information.
+
+## Contributing
+
+1. Fork it ( https://github.com/avdgaag/lugg/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 new Pull Request
+
+### Issues
+
+Please report any issues, defects or suggestions in the [Github issue
+tracker](https://github.com/avdgaag/lugg/issues).
+
+### What has changed?
+
+See the [HISTORY](https://github.com/avdgaag/lugg/blob/master/HISTORY.md) file for a detailed changelog.
+
+### Credits
+
+Created by: Arjan van der Gaag  
+URL: [http://arjanvandergaag.nl](http://arjanvandergaag.nl)  
+Project homepage: [http://avdgaag.github.io/lugg](http://avdgaag.github.io/lugg)  
+Date: march 2014  
+License: [MIT-license](https://github.com/avdgaag/lugg/LICENSE) (same as Ruby)

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler/gem_tasks'
+
+desc 'Default: run specs.'
+task default: %i[spec rubocop doc]
+
+require 'rspec/core/rake_task'
+desc 'Run specs'
+RSpec::Core::RakeTask.new
+
+require 'yard'
+desc 'Generate API docs'
+YARD::Rake::YardocTask.new :doc
+
+require 'rubocop/rake_task'
+desc 'Check source code against Ruby style guide'
+Rubocop::RakeTask.new
+
+desc 'Start Irb with Lugg pre-loaded'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'lugg'
+  ARGV.clear
+  IRB.start
+end

data/bin/lugg

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby -w
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'lugg'
+Lugg::Runner.new(ARGV).run(ARGF)

data/lib/lugg/filter.rb

@@ -0,0 +1,60 @@
+module Lugg
+  # Apply a list of filters to an Enumerable object or an enumerator.
+  #
+  # This class is used to combine all the search queries into a single filter
+  # to process a collection with. Its input is expected to be a
+  # `Lugg::Streamer` enumerator, but it could be anything.
+  #
+  # By default, the collection will be passed through as-is, but you can add
+  # more conditions to limit the results with either callable objects (such as
+  # Procs) or with blocks.
+  #
+  # @example Using a proc
+  #   filter = Filter.new
+  #   filter.use ->(record) { record.method == 'GET' }
+  #
+  # @example Using a block
+  #   filter = Filter.new
+  #   filter.use { |record| record.code == 404 }
+  class Filter
+    def initialize
+      @conditions = []
+    end
+
+    # Apply all known conditions to `records`.
+    #
+    # @param [Enumerable] records
+    # @return [Enumerable] filtered records
+    def call(records)
+      return records unless @conditions.any?
+      records.select do |record|
+        matches?(record)
+      end
+    end
+
+    # Store a new condition to be used on the next invocation of {#call}.
+    #
+    # @param [#call] callable
+    # @raise ArgumentError when both a callable or block are given
+    # @raise ArgumentError when the given callable does not respond to #call
+    def use(callable = nil, &block)
+      unless block_given? ^ callable
+        raise ArgumentError, 'Supply either an argument or a block'
+      end
+
+      unless block_given? || callable.respond_to?(:call)
+        raise ArgumentError, 'Supply either a callable argument or a block'
+      end
+
+      @conditions << (block_given? ? block : callable)
+    end
+
+    private
+
+    def matches?(record)
+      @conditions.any? do |condition|
+        condition.call(record)
+      end
+    end
+  end
+end

data/lib/lugg/request.rb

@@ -0,0 +1,81 @@
+require 'time'
+
+module Lugg
+  # Request is a value object representing a single log entry from start to
+  # finish. Its value is the original source text from the log file, but it
+  # defines various reader methods to extract useful information from it.
+  #
+  # Note that a request is frozen once created. Two {Request} objects with
+  # the same source are considered equal.
+  #
+  # @todo optimise performance
+  class Request
+    attr_reader :source, :hash
+
+    def initialize(source)
+      @source = source
+      @hash = self.class.hash ^ source.hash
+      freeze
+    end
+
+    def eql?(other)
+      self.class == other.class && source == other.source
+    end
+    alias_method :==, :eql?
+
+    def method
+      source[/^Started ([A-Z]+)/, 1]
+    end
+
+    def controller
+      source[/^Processing by (\w+)#(\w+) as (\w+)$/, 1]
+    end
+
+    def action
+      source[/^Processing by (\w+)#(\w+) as (\w+)$/, 1] + '#' +
+      source[/^Processing by (\w+)#(\w+) as (\w+)$/, 2]
+    end
+
+    def format
+      source[/^Processing by (\w+)#(\w+) as (\w+)$/, 3]
+    end
+
+    def status
+      source[/^Completed (\d+) (\w+)/, 2]
+    end
+
+    def code
+      source[/^Completed (\d+) (\w+)/, 1].to_i
+    end
+
+    def ip
+      source[/^Started .* for ([0-9\.]+)/, 1]
+    end
+
+    def timestamp
+      Time.parse(source[/^Started .* at (.+)$/, 1])
+    end
+
+    def uri
+      source[/^Started \w+ "([^"]+)"/, 1]
+    end
+
+    def path
+      uri.split('?').first
+    end
+
+    def query
+      uri.split('?', 2).last
+    end
+
+    def duration
+      source[/^Completed .* in (\d+)ms/, 1].to_i
+    end
+
+    def params
+      params_string = source[/^  Parameters: (.+)$/, 1]
+      return {} unless params_string
+      eval(params_string) rescue {} # rubocop:disable Eval, RescueModifier
+    end
+  end
+end

data/lib/lugg/request_matcher.rb

@@ -0,0 +1,32 @@
+module Lugg
+  # RequestMatcher is a flip-flop conditional, that becomes true when compared
+  # to one condition, and then stays true until a new condition. It is used to
+  # match log entries in a log file, starting to match when encountering a line
+  # with `Starting...` and stopping to match when encountering a line with
+  # `Completed...`.
+  class RequestMatcher
+    def initialize
+      @active = false
+      @finished = false
+    end
+
+    def active?
+      !!@active
+    end
+
+    def finished?
+      !!@finished
+    end
+
+    def =~(line) # rubocop:disable OpMethod
+      if line =~ /^Started/
+        @active = true
+      elsif line =~ /^Completed/
+        @active = false
+        @finished = true
+      else
+        @active
+      end
+    end
+  end
+end

data/lib/lugg/runner.rb

@@ -0,0 +1,150 @@
+require 'lugg/version'
+require 'lugg/filter'
+require 'lugg/streamer'
+require 'optparse'
+require 'optparse/time'
+
+module Lugg
+  # The runner defines the command line interface for Lugg, using the other
+  # components and defining command line options and their implementations.
+  #
+  # When creating a Runner object, you pass it your option flags (typically
+  # `ARGV`). You can then apply its conditions to an IO object (typically
+  # `ARGF`).
+  #
+  # @todo extract conditions into individual objects.
+  class Runner
+    attr_reader :filter
+    private :filter
+
+    def initialize(flags = [], filter = Filter.new)
+      @filter = filter
+      reset
+      options.parse!(flags)
+    end
+
+    def run(io)
+      filter.call(Streamer.new(io).records).each do |request|
+        puts request.source
+      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
+        filter.use { |r| prev_block.call(r) && block.call(r) }
+        reset
+      else
+        filter.use(&block)
+        @last_block = block
+      end
+    end
+
+    def options
+      @options ||= OptionParser.new do |o|
+        o.banner = <<-EOS
+Usage: lugg [options] FILE
+
+Parses log entries from FILE or STDIN and uses [options] to control what is
+sent STDOUT.
+EOS
+        o.separator ''
+
+        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
+
+        o.on_tail '-h', '--help', 'Display this message' do
+          puts o
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/lugg/streamer.rb

@@ -0,0 +1,31 @@
+require 'lugg/request'
+require 'lugg/request_matcher'
+
+module Lugg
+  # The Streamer reads in content from an IO object and returns an Enumerator
+  # yielding {Request} objects.
+  class Streamer
+    attr_reader :io
+    private :io
+
+    def initialize(io)
+      @io = io
+    end
+
+    # @return [Enumerator]
+    def records # rubocop:disable MethodLength
+      Enumerator.new do |yielder|
+        buffer = ''
+        matcher = RequestMatcher.new
+        io.each do |line|
+          buffer << line if matcher =~ line
+          if matcher.finished?
+            yielder << Request.new(buffer)
+            matcher = RequestMatcher.new
+            buffer = ''
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lugg/version.rb

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

data/lib/lugg.rb

@@ -0,0 +1,44 @@
+require 'lugg/version'
+require 'lugg/runner'
+
+# A tiny command line utility to search through Rails server log files and
+# display requests that meet certain criteria.
+#
+# Lugg takes one or more files as arguments or input on STDIN and redirects
+# that content to STDOUT -- but not before applying some filters. Content will
+# be parsed as Rails server log files and only the entire log entries matching
+# your criteria are displayed.
+#
+# You supply criteria by passing in command line options. You can see a full
+# list of accepted options by running `lugg -h`:
+#
+#         --and                        Combine previous and next clause with AND instead of OR
+#         --get                        Limit to GET requests
+#         --post                       Limit to POST requests
+#         --put                        Limit to PUT requests
+#         --delete                     Limit to DELETE requests
+#         --head                       Limit to HEAD requests
+#         --patch                      Limit to PATCH requests
+#     -c, --controller CONTROLLER      Limit to requests handled by CONTROLLER
+#     -a, --action CONTROLLER_ACTION   Limit to requests handled by CONTROLLER_ACTION
+#         --json                       Limit to json requests
+#         --html                       Limit to html requests
+#         --xml                        Limit to xml requests
+#         --csv                        Limit to csv requests
+#         --pdf                        Limit to pdf requests
+#         --js                         Limit to js requests
+#     -f, --format FORMAT              Limit to FORMAT requests
+#     -s, --status CODE                Limit requests with status code CODE
+#         --since TIME                 Limit to requests made after TIME
+#         --until TIME                 Limit to requests made before TIME
+#     -d, --duration N                 Limit to requests longer than N ms
+#     -u, --uri URI                    Limit to requests matching URI
+#     -p, --param KEY=VAL              Limit to requests with param KEY => VAL
+#
+#     -v, --version                    Display version number
+#     -h, --help                       Display this message
+#
+# Note that all conditions are combined with OR, but you can combine two
+# conditions with the `--and` flag.
+module Lugg
+end

data/lugg.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lugg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lugg'
+  spec.version       = Lugg::VERSION
+  spec.authors       = ['Arjan van der Gaag']
+  spec.email         = ['arjan@kabisa.nl']
+  spec.summary       = %q{Query Rails log files from the command line.}
+  spec.description   = <<-EOS
+A tiny command line utility to search through Rails server log files and
+display requests that meet certain criteria.
+EOS
+  spec.homepage      = 'http://avdgaa.github.io/lugg'
+  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.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rubocop'
+end