log-analyzer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eccd209a81035144e2f86390c024ab6cea0f64fc
-  data.tar.gz: d0614f2ae83b0bf049da0ac37e5a99dd9c2ff4e2
+  metadata.gz: 9f8d3ab240961adfb8a7a8f95f38b19ab967dc88
+  data.tar.gz: c07499a1e0a7001e39cba2d8ccb606e3f066aa9e
 SHA512:
-  metadata.gz: 3a70d4208ae639505149d6c9712ffcb7124d86259a9e406f46cdb8857aa2a65e122b9593abf4f6189622fc573dc3a0a577b09cce18cf6a0d34edaeafef6dfaec
-  data.tar.gz: c38689ba60da004b6f63210f18b8bfa8b6bbef8035b5d5fbbe589a34d97d70920ffac30105352cc6b476c146019b17bc1a8de3f3129f0ac362b564fdccb27ac2
+  metadata.gz: c070b05e228ea3539d920b4a2bcee2552d96787bc5e9127537860d8d5e3e333860ae82ff4d16bcd97f09427e2d0a33813c70bc198665848b4bc287259c8818fa
+  data.tar.gz: 0549d9c8cd21aaba0df5c722f41e7f9ffdb10c1ee95eeeb3e4ab739f3ce83d65298cdcb4dcf145d86bde5e83cb9c58ea52bda4eb3b47644ae7183612c94ad94c

data/README.md

@@ -30,6 +30,31 @@ Other Framework Application:
 
     $ log-analyzer -r routing_file <file ...>
 
+## CLI Reference
+
+Help:
+
+```shell
+$ log-analyzer --help
+Usage: log-analyzer [options] <file ...>
+    -h, --help                       output usage information
+    -V, --version                    output the version number
+    -r FILE                          routing format file
+    -R, --route-regexp VALUE         route regexp
+    -L, --log-regexp VALUE           log regexp
+```
+
+Example:
+
+```shell
+$ log-analyzer -r path/to/routes.txt path/to/application.log
+┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┓
+┃ method ┃ endpoint ┃ count ┃
+┣━━━━━━━━╊━━━━━━━━━━╊━━━━━━━┫
+┃ GET    ┃ /        ┃ 1     ┃
+┗━━━━━━━━┻━━━━━━━━━━┻━━━━━━━┛
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/log-analyzer.rb

@@ -1,4 +1,5 @@
 require 'log-analyzer/version'
+require 'log-analyzer/config'
 require 'log-analyzer/routes'
 require 'log-analyzer/analyze'
 require 'log-analyzer/log'
@@ -9,5 +10,13 @@ require 'log-analyzer/rails/railtie.rb' if defined?(Rails)
 
 module Log
   module Analyzer
+    module_function
+    def self.configure(&block)
+      yield(config)
+    end
+
+    def config
+      @_config ||= Config.new
+    end
   end
 end

data/lib/log-analyzer/cli.rb

@@ -3,7 +3,7 @@ require 'command_line_reporter'
 module Log::Analyzer
   class CLI
     def self.run(files, options)
-      routing_text = File.read(options[:r])
+      routing_text = File.read(options[:routing_file])
       analyze = Analyze.new(files, routing_text)
       Report.new(analyze.sort).run
     end

data/lib/log-analyzer/command/log-analyzer.rb

@@ -18,12 +18,19 @@ op.on('-V', '--version', 'output the version number') do |v|
   exit
 end
 
-op.on('-r VALUE', 'routing format file') { |v| opts[:r] = v }
+op.on('-r FILE', 'routing format file') { |v| opts[:routing_file] = v }
+op.on('-R VALUE', '--route-regexp', 'route regexp') { |v| opts[:route_regexp] = v }
+op.on('-L VALUE', '--log-regexp', 'log regexp') { |v| opts[:log_regexp] = v }
 
 op.parse!(ARGV)
 
 if ARGV.empty?
   puts op
 else
+  Log::Analyzer.configure do |config|
+    config.route_regexp = Regexp.new(opts[:route_regexp]) if opts[:route_regexp]
+    config.log_regexp   = Regexp.new(opts[:log_regexp]) if opts[:log_regexp]
+  end
+
   Log::Analyzer::CLI.run(ARGV, opts)
 end

data/lib/log-analyzer/config.rb

@@ -0,0 +1,10 @@
+module Log::Analyzer
+  class Config
+    attr_accessor :log_regexp, :route_regexp
+
+    def initialize
+      @route_regexp = /(GET|POST|DELETE|PATCH|PUT)\s+([^\s]*)\s/i
+      @log_regexp = /Started (?<request_method>GET|POST|DELETE|PATCH|PUT) "(?<path_info>[^"]+)"/i
+    end
+  end
+end

data/lib/log-analyzer/endpoint.rb

@@ -18,7 +18,7 @@ module Log::Analyzer
     end
 
     def self.all
-      @endpoints.values
+      self.endpoints.values
     end
 
     def self.endpoints

data/lib/log-analyzer/log.rb

@@ -1,14 +1,12 @@
 module Log::Analyzer
   class Log
-    LOG_REGEXP = /Started (?<request_method>GET|POST|DELETE|PATCH|PUT) "(?<path_info>[^"]+)"/i
-
     def initialize(path)
       @file = File.open(path)
     end
 
     def each_line(&block)
       @file.each_line do |line|
-        next unless md = line.match(LOG_REGEXP)
+        next unless md = line.match(regexp)
         env = md.names.inject({}) do |hash, name|
                 hash[name.upcase] = md[name]
                 hash
@@ -16,5 +14,10 @@ module Log::Analyzer
         block.call(ActionDispatch::Request.new(env))
       end
     end
+
+    private
+    def regexp
+      ::Log::Analyzer.config.log_regexp
+    end
   end
 end

data/lib/log-analyzer/routes.rb

@@ -3,14 +3,17 @@ require 'action_dispatch'
 
 module Log::Analyzer
   class Routes < ActionDispatch::Journey::Routes
-    ROUTE_REGEXP = /(GET|POST|DELETE|PATCH|PUT)\s+([^\s]*)\s/i
-
     def initialize(routes_text)
       super()
-      routes_text.scan(ROUTE_REGEXP) do |request_method, request_path|
+      routes_text.scan(regexp) do |request_method, request_path|
         path_pattern = Pattern.from_string(request_method, request_path)
         add_route(nil, path_pattern, {request_method: /^#{request_method}$/}, {}, {})
       end
     end
+
+    private
+    def regexp
+      ::Log::Analyzer.config.route_regexp
+    end
   end
 end

data/lib/log-analyzer/version.rb

@@ -1,5 +1,5 @@
 module Log
   module Analyzer
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log-analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - shiro16
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-01 00:00:00.000000000 Z
+date: 2016-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -145,6 +145,7 @@ files:
 - lib/log-analyzer/analyze.rb
 - lib/log-analyzer/cli.rb
 - lib/log-analyzer/command/log-analyzer.rb
+- lib/log-analyzer/config.rb
 - lib/log-analyzer/endpoint.rb
 - lib/log-analyzer/log.rb
 - lib/log-analyzer/pattern.rb