confire 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 531cbc15f63040bd5b828b9be515239664278068
-  data.tar.gz: 598f8f0a80010088f49bc902f2e1bc67da23c031
+  metadata.gz: e9950b1c6dfbf61bca27c372715a55215d305efe
+  data.tar.gz: 1061bfb24a79a379f87d7574dc6d7bbe40030d90
 SHA512:
-  metadata.gz: 05055a5c908e3811e64cc284f227446ee8260c7d08e6cc5791022c68140a93b4b51089a28199c598e78e343e41910f106894680052e2326ee8e753e2dada5900
-  data.tar.gz: 571fdd789bc9a4d85c7638a8177b54696ddd914deba136ca760a722713f11fb48ae24b0da4e30981315669505968b4f4d48e4dd220a15e67cb6213ca9f0e82b5
+  metadata.gz: 8fd5efc88879058d0d3de821b90f20bd4a68b0ef5dfdf44329da00b2e4d2fca9e1b9767ed3d2327f4874b04362aa022071635af8d52ee0b41e77b6da414d589e
+  data.tar.gz: a7f7a6bdc253e4ae3d2da37b74b8df65a9a37ea233d1513e09043b6991875ad9c3973fcb5bfd5dd0a1d43b3db923c6e6132a3b3efc915207383ca1a57efcd5f9

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/lib/confire/main.rb

@@ -0,0 +1,66 @@
+require 'yaml'
+require 'log4r'
+require 'confire/parser'
+require 'confire/processor'
+include Log4r
+
+class Confire
+  class Main
+    def initialize(options = {})
+      # setup configs
+      #config = YAML::load_file(File.join(__dir__, 'config.yml'))
+      config = YAML::load_file('config.yml')
+      filename = config['filename']
+      lines_per_test_case = config['lines_per_test_case']
+
+      # setup logger
+      log_name = options[:log_name] || 'application'
+      logger = Logger.new log_name
+      log_level = 0
+      case config['log_level'].to_sym
+      when :debug
+        log_level = Log4r::DEBUG
+      when :info
+        log_level = Log4r::INFO
+      when :warn
+        log_level = Log4r::WARN
+      when :error
+        log_level = Log4r::ERROR
+      when :fatal
+        log_level = Log4r::FATAL
+      else
+        log_level = 0
+      end if config['log_level']
+      logger.level = log_level
+      logger.outputters = Outputter.stdout
+      @logger = logger
+
+      # setup parser
+      @parser = Parser.new(
+        filename: filename,
+        lines_per_test_case: lines_per_test_case,
+        logger: logger
+      )
+
+      # setup processor that will do all the work
+      @processor = Processor.new(
+        logger: logger,
+        custom_processor: options[:custom_processor]
+      )
+    end
+
+    def run
+      block_processor = ->(line_buffer, test_number) do
+        processed_block = @processor.process_block line_buffer, test_number
+        puts "Case ##{test_number}: #{processed_block}"
+      end
+
+      line_processor = ->(line) do
+        @processor.process_line line
+      end
+
+      @parser.parse block_processor, line_processor
+    end
+  end
+end
+

data/lib/confire/parser.rb

@@ -0,0 +1,54 @@
+class Confire
+  # Parses the google test case
+  class Parser
+    attr_accessor :filename, :lines_per_test_case
+
+    # Remember to set:
+    #   filename to read (will blow a ArgumentError if not set)
+    #   lines_per_test_case
+    def initialize(options = {})
+      @filename = options[:filename]
+      @lines_per_test_case = options[:lines_per_test_case] || 1
+      @logger = options[:logger]
+    end
+
+    # This will read a given test case and pass that into the test_case_processor.
+    #  A test case is defined as the number of lines_per_test_case
+    #  Can optionally pass in a line_processor that will process a line before adding it to the buffer.
+    #  Will stop reading after we hit the number of test cases defined in the file
+    # Assumption: Number of test cases is defined in the first line
+    def parse(test_case_processor, line_processor = nil)
+      (raise ArgumentError.new('Missing input filename to parse')) unless @filename
+      line_counter = -1
+      test_cases_read = 0
+
+      test_cases = 0
+      line_buffer = []
+
+      IO.foreach(@filename) do |line|
+        line.strip!
+        # read number of cases
+        if line_counter == -1
+          test_cases = line.to_i
+          # if unable to parse or we get 0, blow up
+          raise ArgumentError.new('Missing number of test cases on first line') if test_cases == 0
+          line_counter = 0
+        # process the test case
+        elsif line_counter == (lines_per_test_case - 1)
+          line = line_processor.call(line) if line_processor
+          line_buffer << line
+          test_cases_read += 1
+          test_case_processor.call(line_buffer, test_cases_read)
+          line_buffer = []
+          line_counter = 0
+          return if test_cases_read == test_cases
+        # keep reading
+        else
+          line = line_processor.call(line) if line_processor
+          line_buffer << line
+          line_counter += 1
+        end
+      end
+    end
+  end
+end

data/lib/confire/processor.rb

@@ -0,0 +1,36 @@
+class Confire
+  # This is where the main bits are processed
+  #   We can process lines and blocks here
+  class Processor
+    attr_accessor :logger, :custom_processor
+
+    def initialize(options = {})
+      @logger = options[:logger]
+      @custom_processor = options[:custom_processor]
+      @custom_processor.logger = @logger if @custom_processor
+    end
+
+    # Will process a test case.
+    # Just return whatever we want to print out as results.
+    # line_buffer: an array of inputs.  each line read is an element in the array
+    # test_number: the current test case number we are working on.  probably won't need this value
+    def process_block(line_buffer, test_number)
+      if (@custom_processor && @custom_processor.class.method_defined?(:process_testcase))
+        @custom_processor.process_testcase line_buffer
+      else
+        line_buffer
+      end
+    end
+
+    # Process the line
+    #   Each of these lines get stored as an element in the line_buffer array
+    # line: the line the process
+    def process_line(line)
+      if (@custom_processor && @custom_processor.class.method_defined?(:process_line))
+        @custom_processor.process_line line
+      else
+        line.split ' '
+      end
+    end
+  end
+end

data/lib/confire/project_creator.rb

@@ -1,29 +1,31 @@
-class ProjectCreator
-  def create(project_name)
-    # make dir with that project_name
-    Dir.mkdir project_name
+class Confire
+  class ProjectCreator
+    def create(project_name)
+      # make dir with that project_name
+      Dir.mkdir project_name
 
-    # copy files in
-    FileUtils.cp(filename_with_path('lib/confire/templates/config.yml'), project_name)
-    FileUtils.cp(filename_with_path('lib/confire/templates/Gemfile'), project_name)
-    FileUtils.cp(filename_with_path('lib/confire/templates/main.rb'), project_name)
-    FileUtils.cp(filename_with_path('lib/confire/templates/Rakefile'), project_name)
-    FileUtils.cp(filename_with_path('lib/confire/templates/processor.rb'), project_name)
-    FileUtils.cp_r(filename_with_path('lib/confire/templates/spec'), project_name)
-    FileUtils.cp(filename_with_path('lib/confire/templates/parser.rb'), project_name)
-    FileUtils.cp(filename_with_path('lib/confire/templates/run.sh'), project_name)
-    FileUtils.cp(filename_with_path('lib/confire/templates/input_sample.txt'), project_name)
-    #copy_and_rename project_name, 'lib/confire/templates/config_sample.yml', 'config_sample.yml', 'config.yml'
-    #copy_and_rename project_name, 'lib/confire/templates/processor.rb', 'config_sample.yml', 'config.yml'
-  end
+      # copy files in
+      FileUtils.cp(filename_with_path('lib/confire/templates/config.yml'), project_name)
+      FileUtils.cp(filename_with_path('lib/confire/templates/Gemfile'), project_name)
+      FileUtils.cp(filename_with_path('lib/confire/templates/Rakefile'), project_name)
+      FileUtils.cp(filename_with_path('lib/confire/templates/driver.rb'), project_name)
+      FileUtils.cp(filename_with_path('lib/confire/templates/custom_processor.rb'), project_name)
+      FileUtils.cp_r(filename_with_path('lib/confire/templates/spec'), project_name)
+      FileUtils.cp(filename_with_path('lib/confire/templates/run.sh'), project_name)
+      FileUtils.cp(filename_with_path('lib/confire/templates/input_sample.txt'), project_name)
 
-  protected
-  def filename_with_path(filename)
-    File.join(Confire.root, filename)
-  end
+      #copy_and_rename project_name, 'lib/confire/templates/config_sample.yml', 'config_sample.yml', 'config.yml'
+      #copy_and_rename project_name, 'lib/confire/templates/processor.rb', 'config_sample.yml', 'config.yml'
+    end
+
+    protected
+    def filename_with_path(filename)
+      File.join(Confire.root, filename)
+    end
 
-  def copy_and_rename(project_name, source, oldname, newname)
-    FileUtils.cp(source, project_name)
-    FileUtils.mv(File.join(project_name, oldname), File.join(project_name, newname))
+    def copy_and_rename(project_name, source, oldname, newname)
+      FileUtils.cp(source, project_name)
+      FileUtils.mv(File.join(project_name, oldname), File.join(project_name, newname))
+    end
   end
 end

data/lib/confire/templates/Gemfile

@@ -7,4 +7,5 @@ gem 'pry', '~> 0.9.0'
 gem 'pry-debugger', '~> 0.2.2'
 gem 'pry-rails', '~> 0.3.2'
 gem 'pry-stack_explorer', '~> 0.4.9.1'
+gem 'confire'
 

data/lib/confire/templates/config.yml

@@ -1,3 +1,5 @@
 filename: input_sample.txt
 lines_per_test_case: 2
-log_level: 0
+
+log_level: 'debug'
+log_name: 'application'

data/lib/confire/templates/custom_processor.rb

@@ -0,0 +1,41 @@
+require 'pry'
+class CustomProcessor
+  # Logger setup in config.yml
+  attr_accessor :logger
+
+  # Gets passed in a buffer (array) of lines.
+  #   Given an input with two lines
+  #   -------
+  #   5 5 23
+  #   3 1 1
+  #   1 2 3
+  #   4 5 6
+  #   -------
+  #
+  #   For example:
+  #     If each test case was 2 lines long the first invocation would have the input:
+  #       ['5 5 23', '3 1 1']
+  #     and the second would be:
+  #       ['1 2 3', '4 5 6']
+  #
+  #   For another example:
+  #     This method takes buffers up what is returned from process_line.
+  #     So if process_line creates an array by using line.split ' ', you will get an array of arrays.
+  #     First invocation:
+  #       [["5", "5", "23"], ["3", "1", "1"]]
+  #     Second invocation:
+  #       [["1", "2", "3"], ["4", "5", "6"]]
+  def process_testcase(line_buffer)
+    line_buffer
+  end
+
+  # Processing that can be done per each line.  Whatever this returns gets stored as a line in the
+  # array of arrays described in the process_testcase method.
+  #   For example:
+  #     method input: '5 5 23'
+  #     method implementation: line.split ' '
+  #     method output: ["5", "5", "23"]
+  def process_line(line)
+    line.split ' '
+  end
+end

data/lib/confire/templates/driver.rb

@@ -0,0 +1,7 @@
+require 'confire/main'
+require_relative 'custom_processor'
+
+options = {
+  custom_processor: CustomProcessor.new
+}
+Confire::Main.new(options).run

data/lib/confire/templates/run.sh

@@ -1,3 +1,3 @@
 #!/bin/bash
 
-bundle exec ruby main.rb
+bundle exec ruby driver.rb

data/lib/confire/templates/spec/custom_processor_spec.rb

@@ -0,0 +1,29 @@
+require "minitest/autorun"
+require_relative '../custom_processor'
+
+describe CustomProcessor do
+  before do
+    @processor = CustomProcessor.new
+  end
+
+  describe "when asked to process a test case" do
+    it "must process it" do
+      line_buffer = [["5", "5", "23"], ["3", "1", "1"]]
+      expected = [["5", "5", "23"], ["3", "1", "1"]]
+
+      actual = @processor.process_testcase line_buffer
+      actual.must_equal expected
+    end
+  end
+
+  describe "when asked to process a line" do
+    it "must process it" do
+      line = "5 5 23"
+      expected = ["5", "5", "23"]
+
+      actual = @processor.process_line line
+      actual.must_equal expected
+    end
+  end
+end
+

data/lib/confire.rb

@@ -1,4 +1,4 @@
-require_relative 'confire/project_creator'
+require "confire/project_creator"
 class Confire
   def initialize(project_name)
     project_creator = ProjectCreator.new

data/{lib/confire/templates/spec → spec}/processor_spec.rb

@@ -1,9 +1,9 @@
 require "minitest/autorun"
-require_relative '../processor'
+require 'confire/processor'
 
-describe Processor do
+describe Confire::Processor do
   before do
-    @processor = Processor.new
+    @processor = Confire::Processor.new
   end
 
   describe "when asked to process a test case" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confire
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Jon Keam
@@ -17,18 +17,22 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Rakefile
 - bin/confire
 - lib/confire.rb
+- lib/confire/main.rb
+- lib/confire/parser.rb
+- lib/confire/processor.rb
 - lib/confire/project_creator.rb
 - lib/confire/templates/Gemfile
 - lib/confire/templates/Rakefile
 - lib/confire/templates/config.yml
+- lib/confire/templates/custom_processor.rb
+- lib/confire/templates/driver.rb
 - lib/confire/templates/input_sample.txt
-- lib/confire/templates/main.rb
-- lib/confire/templates/parser.rb
-- lib/confire/templates/processor.rb
 - lib/confire/templates/run.sh
-- lib/confire/templates/spec/processor_spec.rb
+- lib/confire/templates/spec/custom_processor_spec.rb
+- spec/processor_spec.rb
 homepage: https://github.com/jkeam/confire
 licenses:
 - MIT

data/lib/confire/templates/main.rb

@@ -1,44 +0,0 @@
-require 'yaml'
-require 'log4r'
-require_relative 'parser'
-require_relative 'processor'
-include Log4r
-
-class Main
-  def initialize
-    # setup configs
-    config = YAML::load_file(File.join(__dir__, 'config.yml'))
-    filename = config['filename']
-    lines_per_test_case = config['lines_per_test_case']
-
-    # setup parser
-    @parser = Parser.new(
-      filename: filename,
-      lines_per_test_case: lines_per_test_case
-    )
-
-    # setup logger
-    logger = Logger.new 'application_logger'
-    logger.outputters = Outputter.stdout
-    logger.level = config['log_level']
-    @logger = logger
-
-    # setup processor that will do all the work
-    @processor = Processor.new
-  end
-
-  def run
-    block_processor = ->(line_buffer, test_number) do
-      processed_block = @processor.process_block line_buffer, test_number
-      puts "#{test_number}: #{processed_block}"
-    end
-
-    line_processor = ->(line) do
-      @processor.process_line line
-    end
-
-    @parser.parse block_processor, line_processor
-  end
-end
-
-Main.new.run

data/lib/confire/templates/parser.rb

@@ -1,51 +0,0 @@
-# Parses the google test case
-class Parser
-  attr_accessor :filename, :lines_per_test_case
-
-  # Remember to set:
-  #   filename to read (will blow a ArgumentError if not set)
-  #   lines_per_test_case
-  def initialize(options = {})
-    @filename = options[:filename]
-    @lines_per_test_case = options[:lines_per_test_case] || 1
-  end
-
-  # This will read a given test case and pass that into the test_case_processor.
-  #  A test case is defined as the number of lines_per_test_case
-  #  Can optionally pass in a line_processor that will process a line before adding it to the buffer.
-  #  Will stop reading after we hit the number of test cases defined in the file
-  # Assumption: Number of test cases is defined in the first line
-  def parse(test_case_processor, line_processor = nil)
-    (raise ArgumentError.new('Missing input filename to parse')) unless @filename
-    line_counter = -1
-    test_cases_read = 0
-
-    test_cases = 0
-    line_buffer = []
-
-    IO.foreach(@filename) do |line|
-      line.strip!
-      # read number of cases
-      if line_counter == -1
-        test_cases = line.to_i
-        # if unable to parse or we get 0, blow up
-        raise ArgumentError.new('Missing number of test cases on first line') if test_cases == 0
-        line_counter = 0
-      # process the test case
-      elsif line_counter == (lines_per_test_case - 1)
-        line = line_processor.call(line) if line_processor
-        line_buffer << line
-        test_cases_read += 1
-        test_case_processor.call(line_buffer, test_cases_read)
-        line_buffer = []
-        line_counter = 0
-        return if test_cases_read == test_cases
-      # keep reading
-      else
-        line = line_processor.call(line) if line_processor
-        line_buffer << line
-        line_counter += 1
-      end
-    end
-  end
-end

data/lib/confire/templates/processor.rb

@@ -1,13 +0,0 @@
-# This is where the main bits are processed
-#   We can process lines and blocks here
-class Processor
-  # Will process a test case.  simply return whatever we want to print out as results
-  def process_block(line_buffer, test_number)
-    line_buffer
-  end
-
-  # Process the line to be stored in the line_buffer
-  def process_line(line)
-    line.split ' '
-  end
-end