recog 3.1.1 → 3.1.2

data/lib/recog/formatter.rb

@@ -1,51 +1,53 @@
+# frozen_string_literal: true
+
 module Recog
-class Formatter
-  COLORS = {
-    :red    => 31,
-    :yellow => 33,
-    :green  => 32,
-    :white  => 15
-  }
-
-  attr_reader :options, :output
-
-  def initialize(options, output)
-    @options = options
-    @output  = output || StringIO.new
-  end
+  class Formatter
+    COLORS = {
+      red: 31,
+      yellow: 33,
+      green: 32,
+      white: 15
+    }.freeze
 
-  def status_message(text)
-    output.puts color(text, :white)
-  end
+    attr_reader :options, :output
 
-  def success_message(text)
-    output.puts color(text, :green)
-  end
+    def initialize(options, output)
+      @options = options
+      @output  = output || StringIO.new
+    end
 
-  def warning_message(text)
-    output.puts color(text, :yellow)
-  end
+    def status_message(text)
+      output.puts color(text, :white)
+    end
 
-  def failure_message(text)
-    output.puts color(text, :red)
-  end
+    def success_message(text)
+      output.puts color(text, :green)
+    end
 
-  private
+    def warning_message(text)
+      output.puts color(text, :yellow)
+    end
 
-  def color_enabled?
-    options.color
-  end
+    def failure_message(text)
+      output.puts color(text, :red)
+    end
 
-  def color(text, color_code)
-    color_enabled? ? colorize(text, color_code) : text
-  end
+    private
 
-  def colorize(text, color_code)
-    "\e[#{color_code_for(color_code)}m#{text}\e[0m"
-  end
+    def color_enabled?
+      options.color
+    end
 
-  def color_code_for(code)
-    COLORS.fetch(code) { COLORS.fetch(:white) }
+    def color(text, color_code)
+      color_enabled? ? colorize(text, color_code) : text
+    end
+
+    def colorize(text, color_code)
+      "\e[#{color_code_for(color_code)}m#{text}\e[0m"
+    end
+
+    def color_code_for(code)
+      COLORS.fetch(code) { COLORS.fetch(:white) }
+    end
   end
 end
-end

data/lib/recog/match_reporter.rb

@@ -1,111 +1,110 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Recog
-class MatchReporter
-  attr_reader :formatter
-  attr_reader :line_count, :match_count, :fail_count
-
-  def initialize(options, formatter)
-    @options = options
-    @formatter = formatter
-    reset_counts
-  end
+  class MatchReporter
+    attr_reader :formatter, :line_count, :match_count, :fail_count
 
-  def report
-    reset_counts
-    yield self
-    summarize unless @options.quiet
-  end
+    def initialize(options, formatter)
+      @options = options
+      @formatter = formatter
+      reset_counts
+    end
 
-  def stop?
-    return false unless @options.fail_fast
-    @fail_count >= @options.stop_after
-  end
+    def report
+      reset_counts
+      yield self
+      summarize unless @options.quiet
+    end
 
-  def increment_line_count
-    @line_count += 1
-  end
+    def stop?
+      return false unless @options.fail_fast
 
-  def match(match_data)
-    @match_count += 1
-    if @options.json_format
-      # remove data field from all matches and promote to a top-level field
-      data_field = match_data[0]["data"]
-      match_data.each { |h| h.delete("data") }
-      new_object = {
-        'data' => data_field,
-      }
-
-      if @options.multi_match
-        new_object['matches'] = match_data
+      @fail_count >= @options.stop_after
+    end
+
+    def increment_line_count
+      @line_count += 1
+    end
+
+    def match(match_data)
+      @match_count += 1
+      if @options.json_format
+        # remove data field from all matches and promote to a top-level field
+        data_field = match_data[0]['data']
+        match_data.each { |h| h.delete('data') }
+        new_object = {
+          'data' => data_field
+        }
+
+        if @options.multi_match
+          new_object['matches'] = match_data
+        else
+          new_object['match'] = match_data[0]
+        end
+        msg = new_object.to_json
       else
-        new_object['match'] = match_data[0]
+        match_prefix = match_data.size > 1 ? 'MATCHES' : 'MATCH'
+        msg = "#{match_prefix}: #{match_data.map(&:inspect).join(',')}"
       end
-      msg = new_object.to_json
-    else
-      match_prefix = match_data.size > 1 ? 'MATCHES' : 'MATCH'
-      msg = "#{match_prefix}: #{match_data.map(&:inspect).join(',')}"
+      formatter.success_message(msg.to_s)
     end
-    formatter.success_message("#{msg}")
-  end
 
-  def failure(text)
-    @fail_count += 1
-    if @options.json_format
-      new_object = {
-        'data' => text,
-        'match_failure' => true
-      }
-      if @options.multi_match
-        new_object['matches'] = nil
+    def failure(text)
+      @fail_count += 1
+      if @options.json_format
+        new_object = {
+          'data' => text,
+          'match_failure' => true
+        }
+        if @options.multi_match
+          new_object['matches'] = nil
+        else
+          new_object['match'] = nil
+        end
+        msg = new_object.to_json
       else
-        new_object['match'] = nil
+        msg = "FAIL: #{text}"
       end
-      msg = new_object.to_json
-    else
-      msg = "FAIL: #{text}"
+      formatter.failure_message(msg.to_s)
     end
-    formatter.failure_message("#{msg}")
-  end
 
-  def print_summary
-    colorize_summary(summary_line)
-  end
+    def print_summary
+      colorize_summary(summary_line)
+    end
 
-  private
+    private
 
-  def reset_counts
-    @line_count = @match_count = @fail_count = 0
-  end
+    def reset_counts
+      @line_count = @match_count = @fail_count = 0
+    end
 
-  def detail?
-    @options.detail
-  end
+    def detail?
+      @options.detail
+    end
+
+    def summarize
+      return unless detail?
 
-  def summarize
-    if detail?
       print_lines_processed
       print_summary
     end
-  end
 
-  def print_lines_processed
-    formatter.status_message("\nProcessed #{line_count} lines")
-  end
+    def print_lines_processed
+      formatter.status_message("\nProcessed #{line_count} lines")
+    end
 
-  def summary_line
-    summary = "SUMMARY: "
-    summary << "#{match_count} matches"
-    summary << " and #{fail_count} failures"
-    summary
-  end
+    def summary_line
+      "SUMMARY: #{match_count} matches and #{fail_count} failures"
+    end
 
-  def colorize_summary(summary)
-    if @fail_count > 0
-      formatter.failure_message(summary)
-    else
-      formatter.success_message(summary)
+    def colorize_summary(summary)
+      if @fail_count > 0
+        formatter.failure_message(summary)
+      else
+        formatter.success_message(summary)
+      end
     end
   end
 end
-end

data/lib/recog/matcher.rb

@@ -1,60 +1,57 @@
+# frozen_string_literal: true
+
 module Recog
-class Matcher
-  attr_reader :fingerprints, :reporter, :multi_match
-
-  # @param fingerprints Array of [Recog::Fingerprint] The list of fingerprints from the Recog DB to find possible matches.
-  # @param reporter [Recog::MatchReporter] The reporting structure that holds the matches and fails
-  # @param multi_match [Boolean] specifies whether or not to use multi-match (true) or not (false)
-  def initialize(fingerprints, reporter, multi_match)
-    @fingerprints = fingerprints
-    @reporter = reporter
-    @multi_match = multi_match
-  end
+  class Matcher
+    attr_reader :fingerprints, :reporter, :multi_match
+
+    # @param fingerprints Array of [Recog::Fingerprint] The list of fingerprints from the Recog DB to find possible matches.
+    # @param reporter [Recog::MatchReporter] The reporting structure that holds the matches and fails
+    # @param multi_match [Boolean] specifies whether or not to use multi-match (true) or not (false)
+    def initialize(fingerprints, reporter, multi_match)
+      @fingerprints = fingerprints
+      @reporter = reporter
+      @multi_match = multi_match
+    end
 
-  # @param banners_file [String] The source of banners to attempt to match against the Recog DB.
-  def match_banners(banners_file)
-    reporter.report do
+    # @param banners_file [String] The source of banners to attempt to match against the Recog DB.
+    def match_banners(banners_file)
+      reporter.report do
+        fd = $stdin
+        file_source = false
 
-      fd = $stdin
-      file_source = false
+        if banners_file && (banners_file != '-')
+          fd = File.open(banners_file, 'rb')
+          file_source = true
+        end
 
-      if banners_file and banners_file != "-"
-        fd = File.open(banners_file, "rb")
-        file_source = true
-      end
+        fd.each_line do |line|
+          reporter.increment_line_count
 
-      fd.each_line do |line|
-        reporter.increment_line_count
+          line = line.to_s.unpack('C*').pack('C*').strip.gsub(/\\[rn]/, '')
+          found_extractions = false
 
-        line = line.to_s.unpack("C*").pack("C*").strip.gsub(/\\[rn]/, '')
-        found_extractions = false
+          extraction_data = []
+          fingerprints.each do |fp|
+            extractions = fp.match(line)
+            next unless extractions
 
-        extraction_data = []
-        fingerprints.each do |fp|
-          extractions = fp.match(line)
-          if extractions
             found_extractions = true
             extractions['data'] = line
             extraction_data << extractions
             break unless multi_match
           end
-        end
 
-        if found_extractions
-          reporter.match extraction_data
-        else
-          reporter.failure line
-        end
+          if found_extractions
+            reporter.match extraction_data
+          else
+            reporter.failure line
+          end
 
-        if reporter.stop?
-          break
+          break if reporter.stop?
         end
 
+        fd.close if file_source
       end
-
-      fd.close if file_source
-
     end
   end
 end
-end

data/lib/recog/matcher_factory.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 
 require 'recog/matcher'
 require 'recog/formatter'
 require 'recog/match_reporter'
 
 module Recog
-module MatcherFactory
-  def self.build(options)
-    formatter = Formatter.new(options, $stdout)
-    reporter  = MatchReporter.new(options, formatter)
-    Matcher.new(options.fingerprints, reporter, options.multi_match)
+  module MatcherFactory
+    def self.build(options)
+      formatter = Formatter.new(options, $stdout)
+      reporter  = MatchReporter.new(options, formatter)
+      Matcher.new(options.fingerprints, reporter, options.multi_match)
+    end
   end
 end
-end