stockboy 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5447e324b114a19041b667593624345a3e74255e
-  data.tar.gz: 66cfa4b6d78f3a7c8e861d4f943e024f59973e30
+  metadata.gz: f39685f84983ede11ee77ffe5ab39982e37ddac7
+  data.tar.gz: c16642a9c384a71c72def32658d8e4764ab46b14
 SHA512:
-  metadata.gz: 8021a777554ad4978179e4b428e452cc4050b772d4a15426d20478fe542f293503dc1204bdf7038c39f108657d01fe4712d2011abe47bdbd24f8b8cb01e1cef5
-  data.tar.gz: 6a5bdf862e2de473579833bc5596f30c5f6d938418975697370aa51083b70353f7b60a92defb909c5d8ec6f14dab169b504de2576c0bdab7dd0daaf12c55e8f5
+  metadata.gz: 3d7f4377f7973b9e88d91ea807c12987385e594ca9f55b1594dbdc652ad8aea3cf674e431394ed840d60b11454404975cf4d9dc77b3a8a3409a760b1668316ef
+  data.tar.gz: 7dd65ee93fbf9a6df91f052b5505fe13d2b4d1ae2901a612a7ccd87589f1f5662cf8154f5d7d397a4d59779c23cd4ddf4abbee5c70f78a0204130c9cd329e9f5

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.10.0 / 2015-01-23
+
+* [FEATURE]     Option to ignore unwanted attributes from output
+ 
 ## 0.9.0 / 2014-05-19
 
 * [FEATURE]     Add JSON reader 

data/README.md

@@ -210,6 +210,17 @@ Translations are applied in order when given as an array. Since translators are
 designed to handle invalid data, they will catch exceptions and return a `nil`
 so it's a good idea to have default values at the end of the chain.
 
+#### ignore:
+If a field needs to be omitted when exporting to hash (to avoid downstream
+clients clobbering existing values with nil), specify the option with a
+callable object or a symbol that can be called against the output field value:
+
+    email ignore: ->(r) { not r.email.include?("@") }
+    score ignore: :zero?
+
+The callable object receives the whole record context like when translating
+with the "as" option.
+
 #### Built-in attribute translators: 
 
 * [`:boolean`][bool]

data/lib/stockboy/attribute.rb

@@ -3,9 +3,22 @@ module Stockboy
   # Struct-like value object for holding mapping & translation details from
   # input data fields
   #
-  class Attribute < Struct.new(:to, :from, :translators)
+  class Attribute < Struct.new(:to, :from, :translators, :ignore_condition)
+    def ignore?(context)
+      if Symbol === ignore_condition
+        context.public_send(to).public_send(ignore_condition)
+      elsif ignore_condition.respond_to?(:call)
+        ignore_condition.call(context)
+      else
+        false
+      end
+    end
+
     def inspect
-      "#<Stockboy::Attribute to=#{to.inspect}, from=#{from.inspect}, translators=#{translators}>"
+      "#<Stockboy::Attribute to=#{to.inspect}, from=#{from.inspect}%s%s>" % [
+        (", translators=#{translators}" if translators),
+        (", ignore=#{ignore_condition.inspect}" if ignore_condition)
+      ]
     end
   end
 end

data/lib/stockboy/attribute_map.rb

@@ -52,8 +52,9 @@ module Stockboy
       from = opts.fetch(:from, key)
       from = from.to_s.freeze if from.is_a? Symbol
       translators = Array(opts[:as]).map { |t| Translations.translator_for(to, t) }
+      ignore_condition = opts[:ignore]
       define_singleton_method(key) { @map[key] }
-      @map[key] = Attribute.new(to, from, translators)
+      @map[key] = Attribute.new(to, from, translators, ignore_condition)
     end
 
     # Fetch the attribute corresponding to the source field name

data/lib/stockboy/candidate_record.rb

@@ -19,6 +19,7 @@ module Stockboy
       @map = map
       @table = reuse_frozen_hash_keys(attrs, map)
       @tr_table = Hash.new
+      @ignored_fields = []
       freeze
     end
 
@@ -27,11 +28,24 @@ module Stockboy
     # @return [Hash]
     #
     def to_hash
+      bulk_hash.tap do |out|
+        tmp_context = SourceRecord.new(out, @table)
+        @map.each_with_object(out) do |col|
+          out.delete(col.to) if ignore?(col, tmp_context)
+        end
+      end
+    end
+    alias_method :attributes, :to_hash
+
+    # Mapped output hash including ignored values
+    #
+    # @return [Hash]
+    #
+    def bulk_hash
       Hash.new.tap do |out|
         @map.each { |col| out[col.to] = translate(col) }
       end
     end
-    alias_method :attributes, :to_hash
 
     # Return the original values mapped to attribute keys
     #
@@ -80,7 +94,7 @@ module Stockboy
     #   input.email       # => "ME@EXAMPLE.COM  "
     #
     def input
-      SourceRecord.new(self.raw_hash, @table)
+      SourceRecord.new(raw_hash, @table)
     end
 
     # Data structure representing the record's mapped & translated output values
@@ -91,7 +105,7 @@ module Stockboy
     #   output.email       # => "me@example.com"
     #
     def output
-      MappedRecord.new(self.to_hash)
+      MappedRecord.new(bulk_hash)
     end
 
     private
@@ -102,14 +116,24 @@ module Stockboy
         fields = raw_hash
         tr_input = col.translators.reduce(input) do |value, tr|
           begin
-            fields[col.to] = tr[value]
+            fields[key] = tr[value]
             SourceRecord.new(fields, @table)
           rescue
-            fields[col.to] = nil
+            fields[key] = nil
             break SourceRecord.new(fields, @table)
           end
         end
-        @tr_table[col.to] = tr_input.public_send(col.to)
+        @tr_table[key] = tr_input.public_send(key)
+      end
+    end
+
+    def ignore?(col, context)
+      return true if @ignored_fields.include? col.to
+      if col.ignore?(context)
+        @ignored_fields << col.to
+        true
+      else
+        false
       end
     end
 

data/lib/stockboy/job.rb

@@ -196,12 +196,12 @@ module Stockboy
     # @return [String]
     #
     def inspect
-      prov = "provider=#{(Stockboy::Providers.all.key(provider.class) || provider.class)}"
-      read = "reader=#{(Stockboy::Readers.all.key(reader.class) || reader.class)}"
+      prov = "provider=#{Providers.all.key(provider.class) || provider.class}"
+      read = "reader=#{Readers.all.key(reader.class) || reader.class}"
       attr = "attributes=#{attributes.map(&:to)}"
       filt = "filters=#{filters.keys}"
       cnts = "record_counts=#{record_counts}"
-      "#<#{self.class}:#{self.object_id} #{[prov, read, attr, filt, cnts].join(', ')}>"
+      "#<#{self.class}:#{self.object_id} #{prov}, #{read}, #{attr}, #{filt}, #{cnts}>"
     end
 
     private

data/lib/stockboy/readers/csv.rb

@@ -94,11 +94,27 @@ module Stockboy::Readers
 
     private
 
+    # Clean incoming data based on set encoding or best information
+    #
+    #  1. Assign the given input encoding setting if available
+    #  2. Scrub invalid characters for the encoding. (Scrubbing does not apply
+    #     for BINARY input, which is undefined.)
+    #  3. Encode to UTF-8 with considerations for undefined input. The main
+    #     issue are control characters that are absent in UTF-8 (and ISO-8859-1)
+    #     but are common printable characters in Windows-1252, so we preserve
+    #     this range as a best guess.
+    #  4. Delete null bytes that are inserted as terminators by some "CSV" output
+    #  5. Delete leading/trailing garbage lines based on settings
+    #
     def sanitize(data)
-      data.force_encoding(encoding) if encoding
-      data = data.encode(universal_newline: true)
-                 .delete(0.chr)
-                 .chomp
+      data = data.dup
+      data.force_encoding encoding if encoding
+      data.scrub!
+      data.encode! Encoding::UTF_8, universal_newline: true, fallback: proc { |c|
+        c.force_encoding(Encoding::Windows_1252) if (127..159).cover? c.ord
+      }
+      data.delete! 0.chr
+      data.chomp!
       from = row_start_index(data, skip_header_rows)
       to = row_end_index(data, skip_footer_rows)
       data[from..to]

data/lib/stockboy/translations/date.rb

@@ -46,12 +46,42 @@ module Stockboy::Translations
       ::Date.parse(value)
     end
 
-    def separator(value)
-      value.include?(?/) ? ?/ : ?-
-    end
+    module PatternMatching
+      private
+
+      module ClassMethods
+        def match(*patterns)
+          @patterns = patterns
+        end
+        attr_reader :patterns
+      end
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      # Match date strings with 4-digit year
+      MATCH_YYYY = %r"\A\d{1,2}(/|-)\d{1,2}\1\d{4}\z"
+      SLASH = '/'.freeze
+
+      # @return [Date]
+      #
+      def parse_date(value)
+        ::Date.strptime(value, date_format(value))
+      end
+
+      def date_format(value)
+        self.class.patterns[yy_index(value) + sep_index(value)].freeze
+      end
 
-    # Match date strings with 2-digit year
-    MATCH_YYYY = %r"\A\d{1,2}(/|-)\d{1,2}\1\d{4}\z"
+      def yy_index(value)
+        value =~ MATCH_YYYY ? 0 : 2
+      end
+
+      def sep_index(value)
+        value.include?(SLASH) ? 1 : 0
+      end
+    end
 
   end
 end

data/lib/stockboy/translations/uk_date.rb

@@ -1,5 +1,5 @@
 require 'stockboy/translator'
-require 'stockboy/translations/us_date'
+require 'stockboy/translations/date'
 
 module Stockboy::Translations
 
@@ -26,14 +26,10 @@ module Stockboy::Translations
   #   record.check_in = "1/2/12"
   #   date.translate(record, :check_in) # => #<Date 2012-02-01>
   #
-  class UKDate < Stockboy::Translations::USDate
+  class UKDate < Stockboy::Translations::Date
+    include Stockboy::Translations::Date::PatternMatching
 
-    private
-
-    def date_format(value)
-      x = separator(value)
-      value =~ MATCH_YYYY ? "%d#{x}%m#{x}%Y" : "%d#{x}%m#{x}%y"
-    end
+    match '%d-%m-%Y', '%d/%m/%Y', '%d-%m-%y', '%d/%m/%y'
 
   end
 end

data/lib/stockboy/translations/us_date.rb

@@ -27,19 +27,9 @@ module Stockboy::Translations
   #   date.translate(record, :check_in) # => #<Date 2012-02-01>
   #
   class USDate < Stockboy::Translations::Date
+    include Stockboy::Translations::Date::PatternMatching
 
-    private
-
-    # @return [Date]
-    #
-    def parse_date(value)
-      ::Date.strptime(value, date_format(value))
-    end
-
-    def date_format(value)
-      x = separator(value)
-      value =~ MATCH_YYYY ?  "%m#{x}%d#{x}%Y" : "%m#{x}%d#{x}%y"
-    end
+    match '%m-%d-%Y', '%m/%d/%Y', '%m-%d-%y', '%m/%d/%y'
 
   end
 end

data/lib/stockboy/version.rb

@@ -1,3 +1,3 @@
 module Stockboy
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ if ENV['DEBUG']
   require 'pry'
 end
 
-
+require 'rspec/its'
 require 'ostruct'
 require 'savon'
 require 'savon/mock/spec_helper'

data/spec/stockboy/attribute_map_spec.rb

@@ -7,6 +7,7 @@ module Stockboy
     subject do
       AttributeMap.new do
         email
+        score      ignore: :zero?
         updated_at from: 'statusDate', as: [proc{ |v| Date.parse(v) }]
       end
     end
@@ -43,6 +44,10 @@ module Stockboy
       subject[:updated_at].translators.first.call("2012-01-01").should == Date.new(2012,1,1)
     end
 
+    it "sets ignore conditions" do
+      expect( subject[:score].ignore_condition ).to be :zero?
+    end
+
     it "has attr accessors" do
       subject.email.should be_a Attribute
     end
@@ -52,8 +57,8 @@ module Stockboy
     end
 
     it "is enumerable" do
-      subject.map(&:from).should == ["email", "statusDate"]
-      subject.map(&:to).should == [:email, :updated_at]
+      subject.map(&:from).should == ["email", "score", "statusDate"]
+      subject.map(&:to).should == [:email, :score, :updated_at]
     end
 
     describe "#insert" do

data/spec/stockboy/attribute_spec.rb

@@ -4,8 +4,28 @@ require 'stockboy/attribute'
 module Stockboy
   describe Attribute do
     it "describes its attrs" do
-      attr = Attribute.new :outfield, "infield", [:one, :two]
-      attr.inspect.should == %{#<Stockboy::Attribute to=:outfield, from="infield", translators=[:one, :two]>}
+      attr = Attribute.new :outfield, "infield", [:one, :two], :nil?
+      attr.inspect.should == %{#<Stockboy::Attribute to=:outfield, from="infield", translators=[:one, :two], ignore=:nil?>}
+    end
+
+    describe :ignore? do
+      it "is false by default" do
+        attr = Attribute.new :email, "email", []
+        attr.ignore?(double email: "").should be false
+      end
+
+      it "extracts symbols from a record" do
+        attr = Attribute.new :email, "email", [], :blank?
+        attr.ignore?(double email: "").should be true
+        attr.ignore?(double email: "@").should be false
+      end
+
+      it "yields records to a proc" do
+        attr = Attribute.new :email, "email", [], ->(r) { not r.email.include? "@" }
+        attr.ignore?(double email: "").should be true
+        attr.ignore?(double email: "@").should be false
+      end
+
     end
   end
 end

data/spec/stockboy/candidate_record_spec.rb

@@ -33,6 +33,13 @@ module Stockboy
         subject = CandidateRecord.new(hash_attrs, map).to_hash
         subject[:full_name].class.should == String
       end
+
+      it "omits ignored attributes" do
+        invalid_email = ->(r) { r.email.include?('example.com') }
+        map = AttributeMap.new { id ; email ignore: invalid_email }
+        subject = CandidateRecord.new(hash_attrs, map).to_hash
+        subject.should == { :id => '1' }
+      end
     end
 
     describe "#raw_hash" do
@@ -82,7 +89,7 @@ module Stockboy
     describe "#to_model" do
       it "should instantiate a new model" do
         model = Class.new(OpenStruct)
-        model.should_receive(:new).with({id: '1', name: 'Arthur Dent'})
+        expect(model).to receive(:new).with({id: '1', name: 'Arthur Dent'})
         map = AttributeMap.new { id; name from: 'full_name' }
         subject = CandidateRecord.new(hash_attrs, map)
 
@@ -113,6 +120,12 @@ module Stockboy
           subject = CandidateRecord.new(hash_attrs, map)
           subject.output.name.should == 'Arthur Dent'
         end
+
+        it "returns translated values for ignored keys" do
+          map = AttributeMap.new { email ignore: ->(r){ r.email.include?("example.com") } }
+          subject = CandidateRecord.new(hash_attrs, map)
+          subject.output.email.should == "adent@example.com"
+        end
       end
     end
 
@@ -137,12 +150,12 @@ module Stockboy
 
       it "returns nil when raw field is unmatched" do
         key = subject.partition({beta: proc{ |raw| raw.name =~ /B/ }})
-        key.should be_nil
+        key.should be nil
       end
 
       it "returns nil when translated field is unmatched" do
         key = subject.partition({beta: proc{ |raw,out| out.name =~ /B/ }})
-        key.should be_nil
+        key.should be nil
       end
     end
 

data/spec/stockboy/configurator_spec.rb

@@ -37,7 +37,7 @@ module Stockboy
       end
 
       it "initializes arguments" do
-        provider_class.should_receive(:new).with(password:'foo')
+        expect(provider_class).to receive(:new).with(password:'foo')
         subject.provider :ftp, password: 'foo'
       end
     end
@@ -68,7 +68,7 @@ module Stockboy
 
       it "initializes arguments" do
         reader_stub = double(:reader)
-        reader_class.should_receive(:new).with(col_sep: '|').and_return(reader_stub)
+        expect(reader_class).to receive(:new).with(col_sep: '|').and_return(reader_stub)
         subject.reader reader_class, col_sep: '|'
         subject.config[:reader].should == reader_stub
       end
@@ -77,7 +77,7 @@ module Stockboy
     describe "#attributes" do
       it "initializes a block" do
         attribute_map = double
-        AttributeMap.should_receive(:new).and_return(attribute_map)
+        expect(AttributeMap).to receive(:new).and_return(attribute_map)
         subject.attributes &proc{}
         subject.config[:attributes].should be attribute_map
       end
@@ -85,7 +85,7 @@ module Stockboy
       it "replaces existing attributes" do
         subject.attribute :first_name
         subject.attributes do last_name end
-        subject.config[:attributes][:first_name].should be_nil
+        subject.config[:attributes][:first_name].should be nil
         subject.config[:attributes][:last_name].should be_an Attribute
       end
     end

data/spec/stockboy/filter_chain_spec.rb

@@ -17,7 +17,7 @@ module Stockboy
       let(:chain) { FilterChain.new(no_angels: filter1, no_daleks: filter2) }
 
       it "calls reset on all members" do
-        filter2.should_receive(:reset)
+        expect(filter2).to receive(:reset)
         chain.reset
       end
 

data/spec/stockboy/filter_spec.rb

@@ -21,21 +21,21 @@ module Stockboy
 
       context "matching raw value" do
         it "returns true for match" do
-          filter.call(double(species:"babylichtus"), empty_values).should be_true
+          filter.call(double(species:"babylichtus"), empty_values).should be true
         end
 
         it "returns false for no match" do
-          filter.call(double(species:"triceratops"), empty_values).should be_false
+          filter.call(double(species:"triceratops"), empty_values).should be false
         end
       end
 
       context "matching translated value" do
         it "returns true for match" do
-          filter.call(empty_values, double(species:"babelfish")).should be_true
+          filter.call(empty_values, double(species:"babelfish")).should be true
         end
 
         it "returns false for no match" do
-          filter.call(empty_values, double(species:"rhinoceros")).should be_false
+          filter.call(empty_values, double(species:"rhinoceros")).should be false
         end
       end
     end

data/spec/stockboy/filters/missing_email_spec.rb

@@ -5,22 +5,22 @@ describe Stockboy::Filters::MissingEmail do
   subject(:filter) { described_class.new(:e) }
   it 'allows email addresses' do
     record = OpenStruct.new(e: 'me@example.com')
-    filter.call(record, record).should be_false
+    filter.call(record, record).should be false
   end
 
   it 'catches empty strings' do
     record = OpenStruct.new(e: '')
-    filter.call(record, record).should be_true
+    filter.call(record, record).should be true
   end
 
   it 'catches hyphen placeholders' do
     record = OpenStruct.new(e: '-')
-    filter.call(record, record).should be_true
+    filter.call(record, record).should be true
   end
 
   it 'uses translated output value' do
     input = OpenStruct.new(e: '', other: 'me@example.com')
     output = OpenStruct.new(e: input.other)
-    filter.call(input, output).should be_false
+    filter.call(input, output).should be false
   end
 end

data/spec/stockboy/job_spec.rb

@@ -85,22 +85,22 @@ module Stockboy
       end
 
       it "should read a file from a path" do
-        File.should_receive(:read).with("#{jobs_path}/test_job.rb")
+        expect(File).to receive(:read).with("#{jobs_path}/test_job.rb")
         Job.define("test_job")
       end
 
       it "assigns a registered provider from a symbol" do
-        Stockboy::Providers.should_receive(:find)
-                           .with(:ftp)
-                           .and_return(TestProvider)
+        expect(Stockboy::Providers).to receive(:find)
+                                       .with(:ftp)
+                                       .and_return(TestProvider)
         job = Job.define("test_job")
         job.provider.should be_a TestProvider
       end
 
       it "assigns a registered reader from a symbol" do
-        Stockboy::Readers.should_receive(:find)
-                         .with(:csv)
-                         .and_return(TestReader)
+        expect(Stockboy::Readers).to receive(:find)
+                                     .with(:csv)
+                                     .and_return(TestReader)
         job = Job.define("test_job")
         job.reader.should be_a TestReader
       end
@@ -247,9 +247,9 @@ module Stockboy
       end
 
       it "indicates if the job has been processed" do
-        job.processed?.should be_false
+        job.processed?.should be false
         job.process
-        job.processed?.should be_true
+        job.processed?.should be true
       end
     end
 

data/spec/stockboy/provider_repeater_spec.rb

@@ -76,7 +76,7 @@ module Stockboy
 
     describe "#data_size" do
       subject(:repeater) { ProviderRepeater.new(provider) }
-      its(:data_size) { should be_nil }
+      its(:data_size) { should be nil }
 
       context "after iterating" do
         before { repeater.data do |data| end }
@@ -86,7 +86,7 @@ module Stockboy
 
     describe "#data_time" do
       subject(:repeater) { ProviderRepeater.new(provider) }
-      its(:data_time) { should be_nil }
+      its(:data_time) { should be nil }
 
       context "after iterating" do
         before { repeater.data do |data| end }
@@ -96,7 +96,7 @@ module Stockboy
 
     describe "#data?" do
       subject(:repeater) { ProviderRepeater.new(provider) }
-      its(:data?) { should be_nil }
+      its(:data?) { should be nil }
 
       context "after iterating" do
         before { repeater.data do |data| end }

data/spec/stockboy/provider_spec.rb

@@ -76,7 +76,7 @@ module Stockboy
 
     describe "#data_size" do
       subject(:provider) { ProviderSubclass.new }
-      its(:data_size) { should be_nil }
+      its(:data_size) { should be nil }
 
       context "after fetching" do
         before { provider.fetch_data }
@@ -86,7 +86,7 @@ module Stockboy
 
     describe "#data_time" do
       subject(:provider) { ProviderSubclass.new }
-      its(:data_time) { should be_nil }
+      its(:data_time) { should be nil }
 
       context "after fetching" do
         before { provider.fetch_data }
@@ -96,7 +96,7 @@ module Stockboy
 
     describe "#data?" do
       subject(:provider) { ProviderSubclass.new }
-      its(:data?) { should be_nil }
+      its(:data?) { should be nil }
 
       context "after fetching" do
         before { provider.fetch_data }

data/spec/stockboy/providers/file_spec.rb

@@ -52,7 +52,7 @@ module Stockboy
 
       context "with an unmatched string" do
         before { provider.file_name = "missing" }
-        it { should be_nil }
+        it { should be nil }
       end
     end
 
@@ -61,8 +61,8 @@ module Stockboy
 
       it "fails with an error if the file doesn't exist" do
         provider.file_name = "missing-file.csv"
-        provider.data.should be_nil
-        provider.valid?.should be_false
+        provider.data.should be nil
+        provider.valid?.should be false
         provider.errors.first.should match /not found/
       end
 
@@ -90,21 +90,21 @@ module Stockboy
         it "skips old files with :since" do
           expect_any_instance_of(::File).to receive(:mtime).and_return last_week
           provider.since = recently
-          provider.data.should be_nil
+          provider.data.should be nil
           provider.errors.first.should == "no new files since #{recently}"
         end
 
         it "skips large files with :file_smaller" do
           expect_any_instance_of(::File).to receive(:size).and_return 1001
           provider.file_smaller = 1000
-          provider.data.should be_nil
+          provider.data.should be nil
           provider.errors.first.should == "file size larger than 1000"
         end
 
         it "skips small files with :file_larger" do
           expect_any_instance_of(::File).to receive(:size).and_return 999
           provider.file_larger = 1000
-          provider.data.should be_nil
+          provider.data.should be nil
           provider.errors.first.should == "file size smaller than 1000"
         end
       end

data/spec/stockboy/providers/ftp_spec.rb

@@ -49,8 +49,8 @@ module Stockboy
         provider.client { |f| connection = f }
 
         connection.should be_a Net::FTP
-        connection.binary.should be_true
-        connection.passive.should be_true
+        connection.binary.should be true
+        connection.passive.should be true
       end
 
       it "should return yielded result" do
@@ -94,7 +94,7 @@ module Stockboy
 
         provider.file_newer = Time.new(2010,1,1)
 
-        provider.data.should be_nil
+        provider.data.should be nil
       end
     end
 

data/spec/stockboy/providers/imap_spec.rb

@@ -64,7 +64,7 @@ module Stockboy
 
       context "with no messages found" do
         before { mock_imap_search [] => [] }
-        it { should be_nil }
+        it { should be nil }
       end
 
       context "with a found message" do
@@ -79,7 +79,7 @@ module Stockboy
 
         context "validating incorrect filename string" do
           before { provider.attachment = "wrong_report.csv" }
-          it { should be_nil }
+          it { should be nil }
         end
 
         context "validating correct filename pattern" do
@@ -89,7 +89,7 @@ module Stockboy
 
         context "validating incorrect filename pattern" do
           before { provider.attachment = /^wrong.*\.csv$/ }
-          it { should be_nil }
+          it { should be nil }
         end
 
         context "validating correct smaller size" do
@@ -99,7 +99,7 @@ module Stockboy
 
         context "validating incorrect smaller size" do
           before { provider.smaller_than = 10 }
-          it { should be_nil }
+          it { should be nil }
         end
 
         context "validating correct larger size" do
@@ -109,7 +109,7 @@ module Stockboy
 
         context "validating correct larger size" do
           before { provider.larger_than = 2048 }
-          it { should be_nil }
+          it { should be nil }
         end
 
       end

data/spec/stockboy/providers_spec.rb

@@ -4,25 +4,25 @@ require 'stockboy/providers'
 module Stockboy
   describe Providers do
 
-    let(:provider) { double("provider") }
+    let(:provider) { Class.new }
 
     describe ".register" do
       it "registers a key and class" do
-        Providers.register(:snailmail, provider).should === provider
+        Providers.register(:snailmail, provider).should be provider
       end
     end
 
     describe ".find" do
       it "returns a provider class" do
         Providers.register(:snailmail, provider)
-        Providers.find(:snailmail).should === provider
+        Providers.find(:snailmail).should be provider
       end
     end
 
     describe ".[]" do
       it "returns a provider class" do
         Providers.register(:snailmail, provider)
-        Providers[:snailmail].should === provider
+        Providers[:snailmail].should be provider
       end
     end
 

data/spec/stockboy/readers/csv_spec.rb

@@ -7,10 +7,10 @@ module Stockboy
     subject(:reader) { Stockboy::Readers::CSV.new }
 
     describe "default options" do
-      its(:row_sep)          { should be_nil }
-      its(:col_sep)          { should be_nil }
-      its(:quote_char)       { should be_nil }
-      its(:headers)          { should be_true }
+      its(:row_sep)          { should be nil }
+      its(:col_sep)          { should be nil }
+      its(:quote_char)       { should be nil }
+      its(:headers)          { should be true }
       its(:skip_header_rows) { should == 0 }
       its(:skip_footer_rows) { should == 0 }
     end
@@ -51,6 +51,15 @@ module Stockboy
           [{"city" => "Vancouver", "state" => nil, "country" => "Canada"}]
       end
 
+      it "scrubs invalid encoding characters in Unicode" do
+        reader.headers = %w[depart arrive]
+        reader.encoding = 'UTF-8'
+        garbage = 191.chr.force_encoding('UTF-8')
+        data = "Z#{garbage}rich,Genève"
+        reader.parse(data).should ==
+          [{"depart" => "Z\u{FFFD}rich", "arrive" => "Genève"}]
+      end
+
       it "strips preamble header rows" do
         reader.skip_header_rows = 2
         data = "IGNORE\r\nCOMMENTS\r\nid,name\r\n42,Arthur Dent"

data/spec/stockboy/readers/spreadsheet_spec.rb

@@ -85,12 +85,12 @@ module Stockboy
 
     describe "#sheet", pending: "Hard to test this due to roo. Needs a test case with fixtures" do
       let(:sheets)      { ['Towels', 'Lemons'] }
-      let(:expectation) { mock(:spreadsheet, sheets: sheets).should_receive(:default_sheet=) }
-      let(:spreadsheet) { expectation }
+      let(:be_selected) { receive(:default_sheet=) }
+      let(:spreadsheet) { double(:spreadsheet, sheets: sheets) }
       before { subject.stub!(:with_spreadsheet).and_yield(spreadsheet) }
 
       context "with :first" do
-        let(:spreadsheet) { expectation.with('Towels') }
+        before { expect(spreadsheet).to be_selected.with('Towels') }
 
         it "calls on first sheet by name" do
           subject.sheet = :first
@@ -99,7 +99,7 @@ module Stockboy
       end
 
       context "with a string" do
-        let(:spreadsheet) { expectation.with('Towels') }
+        before { expect(spreadsheet).to be_selected.with('Towels') }
 
         it "passes unchanged" do
           subject.sheet = 'Towels'
@@ -108,7 +108,7 @@ module Stockboy
       end
 
       context "with an integer" do
-        let(:spreadsheet) { expectation.with('Towels') }
+        before { expect(spreadsheet).to be_selected.with('Towels') }
 
         it "gets sheet name" do
           subject.sheet = 1

data/spec/stockboy/readers/xml_spec.rb

@@ -15,8 +15,8 @@ module Stockboy
           elements:             ['SomeNested', 'Record']
         )
 
-        reader.options[:strip_namespaces].should be_true
-        reader.options[:advanced_typecasting].should be_true
+        reader.options[:strip_namespaces].should be true
+        reader.options[:advanced_typecasting].should be true
         reader.options[:convert_tags_to].should be_a Proc
         reader.options[:parser].should == :nokogiri
         reader.elements.should == ['some_nested', 'record']
@@ -32,8 +32,8 @@ module Stockboy
           elements ['SomeNested', 'Record']
         end
 
-        reader.options[:strip_namespaces].should be_true
-        reader.options[:advanced_typecasting].should be_true
+        reader.options[:strip_namespaces].should be true
+        reader.options[:advanced_typecasting].should be true
         reader.options[:convert_tags_to].should be_a Proc
         reader.options[:parser].should == :nokogiri
         reader.elements.should == ['some_nested', 'record']

data/spec/stockboy/readers_spec.rb

@@ -8,21 +8,21 @@ module Stockboy
 
     describe ".register" do
       it "registers a key for a reader class" do
-        Readers.register(:markup, reader_class).should == reader_class
+        Readers.register(:markup, reader_class).should be reader_class
       end
     end
 
     describe ".find" do
       it "returns a reader class" do
         Readers.register(:markup, reader_class)
-        Readers.find(:markup).should == reader_class
+        Readers.find(:markup).should be reader_class
       end
     end
 
     describe ".[]" do
       it "returns a reader class" do
         Readers.register(:markup, reader_class)
-        Readers[:markup].should == reader_class
+        Readers[:markup].should be reader_class
       end
     end
 

data/spec/stockboy/template_file_spec.rb

@@ -18,7 +18,7 @@ module Stockboy
 
     describe ".template_path" do
       it "returns nil when missing" do
-        TemplateFile.find("not_here").should be_nil
+        TemplateFile.find("not_here").should be nil
       end
 
       it "returns a file path when found" do

data/spec/stockboy/translations/date_spec.rb

@@ -10,7 +10,7 @@ module Stockboy
     describe "#call" do
       it "returns nil for an empty string" do
         result = subject.call start: ""
-        result.should be_nil
+        result.should be nil
       end
 
       it "returns a date unmodified" do

data/spec/stockboy/translations/decimal_spec.rb

@@ -9,7 +9,7 @@ module Stockboy
     describe "#call" do
       it "returns nil for an empty string" do
         result = subject.call total: ""
-        result.should be_nil
+        result.should be nil
       end
 
       it "returns a decimal" do

data/spec/stockboy/translations/integer_spec.rb

@@ -9,7 +9,7 @@ module Stockboy
     describe "#call" do
       it "returns nil for an empty string" do
         result = subject.call id: ""
-        result.should be_nil
+        result.should be nil
       end
 
       it "returns an integer" do

data/spec/stockboy/translations/time_spec.rb

@@ -9,7 +9,7 @@ module Stockboy
     describe "#call" do
       it "returns nil for an empty string" do
         result = subject.call start: ""
-        result.should be_nil
+        result.should be nil
       end
 
       it "returns a time" do

data/spec/stockboy/translations/uk_date_spec.rb

@@ -9,7 +9,7 @@ module Stockboy
     describe "#call" do
       it "returns nil for an empty string" do
         result = subject.call start: ""
-        result.should be_nil
+        result.should be nil
       end
 
       it "translates DD/MM/YYYY" do

data/spec/stockboy/translations/us_date_spec.rb

@@ -9,7 +9,7 @@ module Stockboy
     describe "#call" do
       it "returns nil for an empty string" do
         result = subject.call start: ""
-        result.should be_nil
+        result.should be nil
       end
 
       it "translates MM/DD/YYYY" do

data/spec/stockboy/translations_spec.rb

@@ -68,11 +68,11 @@ module Stockboy
 
     describe ".find" do
       it "returns a callable translator" do
-        callable = ->(i){ i.upcase }
+        callable = ->(i){ i.message.upcase }
         Translations.register :shout, callable
 
-        Translations.find(:shout).should == callable
-        Translations[:shout].should == callable
+        Translations.find(:shout).should be callable
+        Translations[:shout].should be callable
       end
     end
 

data/stockboy.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-its"
   # s.add_development_dependency "vcr"
 
   s.add_runtime_dependency "roo", ">= 1.12.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stockboy
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Andrew Vit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: roo
   requirement: !ruby/object:Gem::Requirement