stockboy 1.2.1 → 1.3.0

data/lib/stockboy/providers/soap.rb

@@ -28,7 +28,7 @@ module Stockboy::Providers
     # Maximum time to establish a connection
     #
     # @!attribute [rw] open_timeout
-    # @return [Fixnum]
+    # @return [Integer]
     # @example
     #   open_timeout 10
     #
@@ -37,7 +37,7 @@ module Stockboy::Providers
     # Maximum time to read data from connection
     #
     # @!attribute [rw] read_timeout
-    # @return [Fixnum]
+    # @return [Integer]
     # @example
     #   read_timeout 10
     #
@@ -182,6 +182,7 @@ module Stockboy::Providers
       opts[:open_timeout] = open_timeout if open_timeout
       opts[:read_timeout] = read_timeout if read_timeout
       opts[:logger] = logger
+      opts[:log] = logger.debug?
       opts[:convert_response_tags_to] = ->(tag) { string_pool(tag) }
       opts[:namespace] = namespace if namespace
       opts[:namespaces] = namespaces if namespaces

data/lib/stockboy/readers/csv.rb

@@ -25,14 +25,14 @@ module Stockboy::Readers
     # Skip number of rows at start of file before data starts
     #
     # @!attribute [rw] skip_header_rows
-    # @return [Fixnum]
+    # @return [Integer]
     #
     dsl_attr :skip_header_rows
 
     # Skip number of rows at end of file after data ends
     #
     # @!attribute [rw] skip_footer_rows
-    # @return [Fixnum]
+    # @return [Integer]
     #
     dsl_attr :skip_footer_rows
 
@@ -80,7 +80,7 @@ module Stockboy::Readers
       chain = options[:header_converters] || []
       chain << proc{ |h| h.freeze }
       opts = options.merge(header_converters: chain)
-      ::CSV.parse(sanitize(data), opts).map &:to_hash
+      ::CSV.parse(sanitize(data), opts).map(&:to_hash)
     end
 
     # Hash of all CSV-specific options

data/lib/stockboy/readers/fixed_width.rb

@@ -14,7 +14,7 @@ module Stockboy::Readers
     # Array format will use numeric indexes for field keys. Hash will use the
     # keys for naming the fields.
     #
-    # @return [Array<Fixnum>, Hash{Object=>Fixnum}]
+    # @return [Array<Integer>, Hash{Object=>Integer}]
     # @example
     #   reader.headers = [10, 5, 10, 42]
     #   reader.parse(data)
@@ -29,27 +29,31 @@ module Stockboy::Readers
     # String format used for unpacking rows
     #
     # This is read from the {#headers} attribute by default but can be
-    # overridden
+    # overridden. Uses implementation from +String#unpack+ to set field widths
+    # and types.
     #
     # @return [String]
+    # @see http://ruby-doc.org/core/String.html#method-i-unpack
+    # @example
+    #   row_format "U16U32" # column A: 16 unicode, column B: 32 unicode
     #
-    dsl_attr :skip_header_rows
+    dsl_attr :row_format, attr_reader: false
 
     # Number of file rows to skip from start of file
     #
     # Useful if the file starts with a preamble or header metadata
     #
-    # @return [Fixnum]
+    # @return [Integer]
     #
-    dsl_attr :skip_footer_rows
+    dsl_attr :skip_header_rows
 
     # Number of file rows to skip at end of file
     #
     # Useful if the file ends with a summary or notice
     #
-    # @return [Fixnum]
+    # @return [Integer]
     #
-    dsl_attr :row_format
+    dsl_attr :skip_footer_rows
 
     # Override original file encoding
     #
@@ -62,9 +66,9 @@ module Stockboy::Readers
     # Initialize a new fixed-width reader
     #
     # @param [Hash] opts
-    # @option opts [Array<Fixnum>, Hash<Fixnum>] headers
-    # @option opts [Fixnum] skip_header_rows
-    # @option opts [Fixnum] skip_footer_rows
+    # @option opts [Array<Integer>, Hash<Integer>] headers
+    # @option opts [Integer] skip_header_rows
+    # @option opts [Integer] skip_footer_rows
     # @option opts [String] encoding
     #
     def initialize(opts={}, &block)
@@ -76,12 +80,12 @@ module Stockboy::Readers
     end
 
     def parse(data)
-      @column_widths, @column_keys = nil, nil
+      validate_headers
       data.force_encoding(encoding) if encoding
       data = StringIO.new(data) unless data.is_a? StringIO
       skip_header_rows.times { data.readline }
-      records = data.reduce([]) do |a, row|
-        a.tap { a << parse_row(row) unless row.strip.empty? }
+      records = data.each_with_object([]) do |row, a|
+        a << parse_row(row) unless row.strip.empty?
       end
       skip_footer_rows.times { records.pop }
       records
@@ -94,22 +98,16 @@ module Stockboy::Readers
     private
 
     def column_widths
-      return @column_widths if @column_widths
-      @column_widths = case headers
+      @column_widths ||= case headers
       when Hash then headers.values
       when Array then headers
-      else
-        raise "Invalid headers set for #{self.class}"
       end
     end
 
     def column_keys
-      return @column_keys if @column_keys
-      @column_keys = case headers
+      @column_keys ||= case headers
       when Hash then headers.keys.map(&:freeze)
       when Array then (0 ... headers.length).to_a
-      else
-        raise "Invalid headers set for #{self.class}"
       end
     end
 
@@ -117,5 +115,14 @@ module Stockboy::Readers
       Hash[column_keys.zip(row.unpack(row_format))]
     end
 
+    def validate_headers
+      @column_widths, @column_keys, @row_format = nil, nil, nil
+      case headers
+      when Hash, Array then true
+      else raise ArgumentError, "Invalid headers set for #{self.class}, " \
+                                "got #{headers.class}, expected Hash or Array"
+      end
+    end
+
   end
 end

data/lib/stockboy/readers/spreadsheet.rb

@@ -21,38 +21,51 @@ module Stockboy::Readers
     # Spreadsheet sheet number, defaults to first
     #
     # @!attribute [rw] sheet
-    # @return [Fixnum]
+    # @return [Integer]
     #
     dsl_attr :sheet
 
     # Line number to look for headers, starts counting at 1, like in Excel
     #
+    # When specified without +first_row+, then the next row becomes the first
+    # data row by default.
+    #
     # @!attribute [rw] header_row
-    # @return [Fixnum]
+    # @return [Integer]
     #
     dsl_attr :header_row
 
     # Line number of first data row, starts counting at 1, like in Excel
     #
     # @!attribute [rw] first_row
-    # @return [Fixnum]
+    # @return [Integer]
     #
     dsl_attr :first_row
 
     # Line number of last data row, use negative numbers to count back from end
     #
     # @!attribute [rw] last_row
-    # @return [Fixnum]
+    # @return [Integer]
     #
     dsl_attr :last_row
 
     # Override to set headers manually
     #
+    # When specified, the first spreadsheet row is the default
+    # first data row, unless specified by +first_row+.
+    #
     # @!attribute [rw] headers
     # @return [Array]
     #
     dsl_attr :headers
 
+    # Options passed to underlying Roo library
+    #
+    # @!attribute [rw] options
+    # @return [Hash]
+    #
+    dsl_attr :options
+
     # @!endgroup
 
     # Initialize a new Spreadsheet reader
@@ -67,7 +80,7 @@ module Stockboy::Readers
       @last_row  = opts[:last_row]
       @header_row  = opts[:header_row]
       @headers = opts[:headers]
-      @roo_options = opts[:roo_options] || {}
+      @options = opts[:options] || {}
       DSL.new(self).instance_eval(&block) if block_given?
     end
 
@@ -81,15 +94,6 @@ module Stockboy::Readers
       end
     end
 
-    # Roo-specific options hash passed to underlying spreadsheet parser
-    #
-    # @!attribute [r] options
-    # @return [Hash]
-    #
-    def options
-      @roo_options
-    end
-
     private
 
     def enum_data_rows(table)
@@ -101,9 +105,9 @@ module Stockboy::Readers
         file.binmode
         file.write content
         file.fsync
-        table = Roo::Spreadsheet.open(file.path, @roo_options)
+        table = Roo::Spreadsheet.open(file.path, @options)
         table.default_sheet = sheet_number(table, @sheet)
-        table.header_line = @header_line if @header_line
+        table.header_line = @header_row if @header_row
         yield table
       end
     end
@@ -111,13 +115,21 @@ module Stockboy::Readers
     def sheet_number(table, id)
       case id
       when Symbol then table.sheets.public_send id
-      when Fixnum then table.sheets[id-1]
+      when Integer then table.sheets[id-1]
       when String then id
       end
     end
 
     def first_table_row(table)
-      @first_row || table.first_row
+      return @first_row if @first_row
+
+      if @headers
+        table.first_row
+      elsif @header_row
+        @header_row + 1
+      else
+        table.first_row + 1
+      end
     end
 
     def last_table_row(table)

data/lib/stockboy/translations/default_zero.rb

@@ -28,7 +28,7 @@ module Stockboy::Translations
   #
   class DefaultZero < Stockboy::Translator
 
-    # @return [Fixnum]
+    # @return [Integer]
     #
     def translate(context)
       value = field_value(context, field_key)

data/lib/stockboy/translations/integer.rb

@@ -2,7 +2,7 @@ require 'stockboy/translator'
 
 module Stockboy::Translations
 
-  # Translate string values to +Fixnum+
+  # Translate string values to +Integer+
   #
   # == Job template DSL
   #
@@ -20,7 +20,7 @@ module Stockboy::Translations
   #
   class Integer < Stockboy::Translator
 
-    # @return [Fixnum]
+    # @return [Integer]
     #
     def translate(context)
       value = field_value(context, field_key)

data/lib/stockboy/version.rb

@@ -1,3 +1,3 @@
 module Stockboy
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/spec_helper.rb

@@ -1,11 +1,7 @@
-if ENV['CI']
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
-end
-
-if ENV['COVERAGE']
+if ENV['COVERAGE'] || ENV['CI']
   require 'simplecov'
   SimpleCov.start do
+    add_filter "/.bundle/"
     add_filter "/spec/"
     add_group "Providers", "/providers/"
     add_group "Readers", "/readers/"

data/spec/stockboy/candidate_record_spec.rb

@@ -11,14 +11,6 @@ module Stockboy
        'birthday' => '1980-01-01'}
     end
 
-    describe "initialize" do
-      let(:map) { AttributeMap.new { id; email } }
-
-      it "takes a hash and attributes map" do
-        record = CandidateRecord.new(hash_attrs, map)
-      end
-    end
-
     describe "#to_hash" do
       it "remaps attributes" do
         map = AttributeMap.new { name from: 'full_name' }
@@ -78,12 +70,29 @@ module Stockboy
 
       context "with exception" do
         let(:map) { AttributeMap.new{ id as: [->(r){r.id.to_i}, ->(r){r.id / 0}] } }
+        let(:last_line) { __LINE__ - 1 }
+
         it { should eq({id: nil}) }
 
         context "while debugging" do
-          it "raises the error" do 
-            Stockboy.configuration.translation_error_handler = -> (error) { raise error }
-            expect { hash }.to(raise_error(Stockboy::TranslationError)) 
+          around do |example|
+            handler = Stockboy.configuration.translation_error_handler
+            example.run
+            Stockboy.configuration.translation_error_handler = handler
+          end
+
+          it "raises the error" do
+            captured = nil
+            Stockboy.configuration.translation_error_handler = ->(error) do
+              captured = error
+              raise error
+            end
+
+            expect { hash }.to raise_error(Stockboy::TranslationError)
+            expect(captured.message).to eq "Attribute [id] caused divided by 0"
+            expect(captured.key).to eq :id
+            expect(captured.record).to be record
+            expect(captured.backtrace[0]).to start_with "#{__FILE__}:#{last_line}:"
           end
         end
       end

data/spec/stockboy/configurator_spec.rb

@@ -78,7 +78,7 @@ module Stockboy
       it "initializes a block" do
         attribute_map = double
         expect(AttributeMap).to receive(:new).and_return(attribute_map)
-        subject.attributes &proc{}
+        subject.attributes do end
         expect(subject.config[:attributes]).to be attribute_map
       end
 
@@ -171,7 +171,7 @@ module Stockboy
         Readers.register :test_read, reader_class
         subject.provider :test_prov
         subject.reader :test_read
-        subject.attributes &proc{}
+        subject.attributes do end
       end
 
       it "returns a Job instance" do

data/spec/stockboy/provider_repeater_spec.rb

@@ -30,6 +30,10 @@ module Stockboy
         expect(calls).to eq ["1", "2", "3"]
       end
 
+      it "raises an error if no block was given" do
+        expect{ repeater.data }.to raise_error ArgumentError
+      end
+
     end
 
     describe "#each" do
@@ -104,5 +108,17 @@ module Stockboy
       end
     end
 
+    describe "#clear" do
+      subject(:repeater) { ProviderRepeater.new(provider) }
+
+      it "resets iterations and data" do
+        expect(repeater.data_iterations).to eq 0
+        repeater.data do |data| end
+        expect(repeater.data_iterations).to eq 1
+        repeater.clear
+        expect(repeater.data_iterations).to eq 0
+      end
+    end
+
   end
 end

data/spec/stockboy/providers/file_spec.rb

@@ -63,7 +63,7 @@ module Stockboy
         provider.file_name = "missing-file.csv"
         expect(provider.data).to be nil
         expect(provider.valid?).to be false
-        expect(provider.errors.first).to match /not found/
+        expect(provider.errors.first).to include "not found"
       end
 
       it "finds last matching file from string glob" do
@@ -82,6 +82,18 @@ module Stockboy
         expect(provider.data).to eq "2012-02-02\n"
       end
 
+      it "selects item from single list argument proc" do
+        provider.file_name = "*"
+        provider.pick = ->(list) { list[1] }
+        expect(provider.data).to eq "2012-01-01\n"
+      end
+
+      it "reduces to single item from two-argument proc" do
+        provider.file_name = "*"
+        provider.pick = ->(last, best) { last.include?("01") ? last : best }
+        expect(provider.data).to eq "2012-01-01\n"
+      end
+
       context "metadata validation" do
         before { provider.file_name = '*.csv' }
         let(:recently)  { Time.now - 60 }
@@ -130,6 +142,9 @@ module Stockboy
 
         expect(::File).to receive(:delete).with(target.path)
         provider.delete_data
+
+        expect(::File.exist?(non_matching_duplicate)).to be true
+        non_matching_duplicate.close
       end
     end