pod4 0.6.2

data/spec/pg_interface_spec.rb

@@ -0,0 +1,452 @@
+require 'pod4/pg_interface'
+
+require_relative 'shared_examples_for_interface'
+require_relative 'fixtures/database'
+
+
+class TestPgInterface < PgInterface
+  set_table  :customer
+  set_id_fld :id
+end
+
+class SchemaPgInterface < PgInterface
+  set_schema :public
+  set_table  :customer
+  set_id_fld :id
+end
+
+class BadPgInterface1 < PgInterface
+  set_table :customer
+end
+
+class BadPgInterface2 < PgInterface
+  set_id_fld :id
+end
+
+
+describe TestPgInterface do
+
+  def db_setup(connect)
+    client = PG.connect(connect)
+
+    client.exec(%Q|drop table if exists customer;|)
+
+    client.exec(%Q|
+      create table customer ( 
+        id        serial,
+        name      text,
+        level     real      null,
+        day       date      null,
+        timestamp timestamp null,
+        price     money     null,
+        qty       numeric   null );| )
+
+  ensure
+    client.finish if client
+  end
+
+
+  def fill_data(ifce)
+    @data.each{|r| ifce.create(r) }
+  end
+
+
+  before(:all) do
+    @connect_hash = DB[:pg]
+    db_setup(@connect_hash)
+
+    @data = []
+    @data << { name:      'Barney',
+               level:     1.23,
+               day:       Date.parse("2016-01-01"),
+               timestamp: Time.parse('2015-01-01 12:11'),
+               price:     BigDecimal.new("1.24"),
+               qty:       BigDecimal.new("1.25") }
+
+    @data << { name:      'Fred',
+               level:     2.34,
+               day:       Date.parse("2016-02-02"),
+               timestamp: Time.parse('2015-01-02 12:22'),
+               price:     BigDecimal.new("2.35"),
+               qty:       BigDecimal.new("2.36") }
+
+    @data << { name:      'Betty',
+               level:     3.45,
+               day:       Date.parse("2016-03-03"),
+               timestamp: Time.parse('2015-01-03 12:33'),
+               price:     BigDecimal.new("3.46"),
+               qty:       BigDecimal.new("3.47") }
+
+  end
+
+
+  before do
+    # TRUNCATE TABLE also resets the identity counter
+    interface.execute(%Q|truncate table customer restart identity;|)
+  end
+
+
+  let(:interface) do
+    TestPgInterface.new(@connect_hash)
+  end
+
+  #####
+
+
+  it_behaves_like 'an interface' do
+
+    let(:interface) do
+      TestPgInterface.new(@connect_hash)
+    end
+
+    let(:record) { {name: 'Barney'} }
+
+  end
+  ##
+ 
+
+  describe 'PgInterface.set_schema' do
+    it 'takes one argument' do
+      expect( PgInterface ).to respond_to(:set_schema).with(1).argument
+    end
+  end
+  ##
+
+
+  describe 'PgInterface.schema' do
+    it 'returns the schema' do
+      expect( SchemaPgInterface.schema ).to eq :public
+    end
+
+    it 'is optional' do
+      expect{ TestPgInterface.schema }.not_to raise_exception
+      expect( TestPgInterface.schema ).to eq nil
+    end
+  end
+  ##
+
+
+  describe 'PgInterface.set_table' do
+    it 'takes one argument' do
+      expect( PgInterface ).to respond_to(:set_table).with(1).argument
+    end
+  end
+  ##
+  
+
+  describe 'PgInterface.table' do
+    it 'returns the table' do
+      expect( TestPgInterface.table ).to eq :customer
+    end
+  end
+  ##
+
+
+  describe 'PgInterface.set_id_fld' do
+    it 'takes one argument' do
+      expect( PgInterface ).to respond_to(:set_id_fld).with(1).argument
+    end
+  end
+  ##
+
+
+  describe 'PgInterface.id_fld' do
+    it 'returns the ID field name' do
+      expect( TestPgInterface.id_fld ).to eq :id
+    end
+  end
+  ##
+
+
+  describe '#new' do
+
+    it 'requires a TinyTds connection string' do
+      expect{ TestPgInterface.new        }.to raise_exception ArgumentError
+      expect{ TestPgInterface.new(nil)   }.to raise_exception ArgumentError
+      expect{ TestPgInterface.new('foo') }.to raise_exception ArgumentError
+
+      expect{ TestPgInterface.new(@connect_hash) }.not_to raise_exception
+    end
+
+  end
+  ##
+  
+
+  describe '#quoted_table' do
+
+    it 'returns just the table when the schema is not set' do
+      expect( interface.quoted_table ).to eq( %Q|"customer"| )
+    end
+
+    it 'returns the schema plus table when the schema is set' do
+      ifce = SchemaPgInterface.new(@connect_hash)
+      expect( ifce.quoted_table ).to eq( %|"public"."customer"| )
+    end
+
+  end
+  ##
+
+
+  describe '#create' do
+
+    let(:hash) { {name: 'Bam-Bam', price: 4.44} }
+    let(:ot)   { Octothorpe.new(name: 'Wilma', price: 5.55) }
+
+    it 'raises a Pod4::DatabaseError if anything goes wrong' do
+      expect{ interface.create(one: 'two') }.to raise_exception DatabaseError
+    end
+
+    it 'creates the record when given a hash' do
+      # kinda impossible to seperate these two tests
+      id = interface.create(hash)
+
+      expect{ interface.read(id) }.not_to raise_exception
+      expect( interface.read(id).to_h ).to include hash
+    end
+
+    it 'creates the record when given an Octothorpe' do
+      id = interface.create(ot)
+
+      expect{ interface.read(id) }.not_to raise_exception
+      expect( interface.read(id).to_h ).to include ot.to_h
+    end
+
+    it 'shouldnt have a problem with record values of nil' do
+      record = {name: 'Ranger', price: nil}
+      expect{ interface.create(record) }.not_to raise_exception
+      id = interface.create(record)
+      expect( interface.read(id).to_h ).to include(record)
+    end
+
+  end
+  ##
+
+
+  describe '#read' do
+    before { fill_data(interface) }
+
+    it 'returns the record for the id as an Octothorpe' do
+      rec = interface.read(2)
+      expect( rec ).to be_a_kind_of Octothorpe
+      expect( rec.>>.name ).to eq 'Fred'
+    end
+
+    it 'raises a Pod4::CantContinue if the ID is bad' do
+      expect{ interface.read(:foo) }.to raise_exception CantContinue
+    end
+
+    it 'returns an empty Octothorpe if no record matches the ID' do
+      expect{ interface.read(99) }.not_to raise_exception
+      expect( interface.read(99) ).to be_a_kind_of Octothorpe
+      expect( interface.read(99) ).to be_empty
+    end
+
+    it 'returns real fields as Float' do
+      level = interface.read(1).>>.level
+
+      expect( level ).to be_a_kind_of Float
+      expect( level ).to be_within(0.001).of( @data.first[:level] )
+    end
+
+    it 'returns date fields as Date' do
+      date = interface.read(1).>>.day
+
+      expect( date ).to be_a_kind_of Date
+      expect( date ).to eq @data.first[:day]
+    end
+
+    it 'returns datetime fields as Time' do
+      timestamp = interface.read(1).>>.timestamp
+
+      expect( timestamp ).to be_a_kind_of Time
+      expect( timestamp ).to eq @data.first[:timestamp]
+    end
+
+    it 'returns numeric fields as BigDecimal' do
+      qty = interface.read(1).>>.qty
+
+      expect( qty ).to be_a_kind_of BigDecimal
+      expect( qty ).to eq @data.first[:qty]
+    end
+
+    it 'returns money fields as BigDecimal' do
+      price   = interface.read(1).>>.price
+
+      expect( price ).to be_a_kind_of BigDecimal
+      expect( price ).to eq @data.first[:price]
+    end
+
+  end
+  ##
+
+
+  describe '#list' do
+    before { fill_data(interface) }
+
+    it 'has an optional selection parameter, a hash' do
+      # Actually it does not have to be a hash, but FTTB we only support that.
+      expect{ interface.list(name: 'Barney') }.not_to raise_exception
+    end
+
+    it 'returns an array of Octothorpes that match the records' do
+      # convert each OT to a hash and remove the ID key
+      arr = interface.list.map {|ot| x = ot.to_h; x.delete(:id); x }
+
+      expect( arr ).to match_array @data
+    end
+
+    it 'returns a subset of records based on the selection parameter' do
+      expect( interface.list(name: 'Fred').size ).to eq 1
+
+      expect( interface.list(name: 'Betty').first.to_h ).
+        to include(name: 'Betty')
+
+    end
+
+    it 'returns an empty Array if nothing matches' do
+      expect( interface.list(name: 'Yogi') ).to eq([])
+    end
+
+    it 'raises ArgumentError if the selection criteria is nonsensical' do
+      expect{ interface.list('foo') }.to raise_exception ArgumentError
+    end
+
+  end
+  ##
+  
+
+  describe '#update' do
+    before { fill_data(interface) }
+
+    let(:id) { interface.list.first[:id] }
+
+    def float_price(row)
+      row[:price] = row[:price].to_f
+      row
+    end
+
+    it 'updates the record at ID with record parameter' do
+      record = {name: 'Booboo', price: 99.99}
+      interface.update(id, record)
+
+      # It so happens that TinyTds returns money as BigDecimal --
+      # this is a really good thing, even though it screws with our test.
+      expect( float_price( interface.read(id).to_h ) ).to include(record)
+    end
+
+    it 'raises a CantContinue if anything weird happens with the ID' do
+      expect{ interface.update(99, name: 'Booboo') }.
+        to raise_exception CantContinue
+
+    end
+
+    it 'raises a DatabaseError if anything weird happens with the record' do
+      expect{ interface.update(id, smarts: 'more') }.
+        to raise_exception DatabaseError
+
+    end
+
+    it 'shouldnt have a problem with record values of nil' do
+      record = {name: 'Ranger', price: nil}
+      expect{ interface.update(id, record) }.not_to raise_exception
+      expect( interface.read(id).to_h ).to include(record)
+    end
+
+  end
+  ##
+
+
+  describe '#delete' do
+
+    def list_contains(id)
+      interface.list.find {|x| x[interface.id_fld] == id }
+    end
+
+    let(:id) { interface.list.first[:id] }
+
+    before { fill_data(interface) }
+
+    it 'raises CantContinue if anything hinky happens with the id' do
+      expect{ interface.delete(:foo) }.to raise_exception CantContinue
+      expect{ interface.delete(99)   }.to raise_exception CantContinue
+    end
+
+    it 'makes the record at ID go away' do
+      expect( list_contains(id) ).to be_truthy
+      interface.delete(id)
+      expect( list_contains(id) ).to be_falsy
+    end
+
+  end
+  ##
+
+
+  describe '#execute' do
+
+    let(:sql) { 'delete from customer where cast(price as numeric) < 2.0;' }
+
+    before { fill_data(interface) }
+
+    it 'requires an SQL string' do
+      expect{ interface.execute      }.to raise_exception ArgumentError
+      expect{ interface.execute(nil) }.to raise_exception ArgumentError
+      expect{ interface.execute(14)  }.to raise_exception ArgumentError
+    end
+
+    it 'raises some sort of Pod4 error if it runs into problems' do
+      expect{ interface.execute('delete from not_a_table') }.
+        to raise_exception Pod4Error
+
+    end
+
+    it 'executes the string' do
+      expect{ interface.execute(sql) }.not_to raise_exception
+      expect( interface.list.size ).to eq(@data.size - 1)
+      expect( interface.list.map{|r| r[:name] } ).not_to include 'Barney'
+    end
+
+  end
+  ##
+
+
+  describe '#select' do
+
+    before { fill_data(interface) }
+
+    it 'requires an SQL string' do
+      expect{ interface.select      }.to raise_exception ArgumentError
+      expect{ interface.select(nil) }.to raise_exception ArgumentError
+      expect{ interface.select(14)  }.to raise_exception ArgumentError
+    end
+
+    it 'raises some sort of Pod4 error if it runs into problems' do
+      expect{ interface.select('select * from not_a_table') }.
+        to raise_exception Pod4Error
+
+    end
+
+    it 'returns the result of the sql' do
+      sql1 = 'select name from customer where cast(price as numeric) < 2.0;'
+      sql2 = 'select name from customer where cast(price as numeric) < 0.0;'
+
+      expect{ interface.select(sql1) }.not_to raise_exception
+      expect( interface.select(sql1) ).to eq( [{name: 'Barney'}] )
+      expect( interface.select(sql2) ).to eq( [] )
+    end
+
+    it 'works if you pass a non-select' do
+      # By which I mean: still executes the SQL; returns []
+      sql = 'delete from customer where cast(price as numeric) < 2.0;'
+      ret = interface.select(sql)
+
+      expect( interface.list.size ).to eq(@data.size - 1)
+      expect( interface.list.map{|r| r[:name] } ).not_to include 'Barney'
+      expect( ret ).to eq( [] )
+    end
+
+  end
+  ##
+
+
+end
+

data/spec/pod4_spec.rb

@@ -0,0 +1,88 @@
+require 'logger'
+
+require 'pod4'
+require 'pod4/param'
+require 'pod4/errors'
+
+
+describe Pod4 do
+
+  # Magically replaces the real Param module
+  let(:param) { class_double(Pod4::Param).as_stubbed_const }
+
+  after(:all) { Param.reset }
+
+
+  it 'has a version' do
+    expect( Pod4::VERSION ).not_to be_nil
+  end
+  ##
+
+
+  describe "Pod4.set_logger" do
+
+    it "calls Param.set" do
+      l = Logger.new(STDOUT)
+      expect(param).to receive(:set).with(:logger, l)
+      Pod4.set_logger(l)
+    end
+
+  end
+  ##
+
+
+  describe 'Pod4.logger' do
+
+    it 'returns the logger as set' do
+      l = Logger.new(STDOUT)
+      Pod4.set_logger(l)
+
+      expect( Pod4.logger ).to eq l
+    end
+
+    it 'still works if no-one set the logger' do
+      expect{ Pod4.logger }.not_to raise_exception
+      expect( Pod4.logger ).to be_a_kind_of Logger
+    end
+
+  end
+  ##
+  
+
+  describe 'Pod4::NotImplemented' do
+    it 'is an exception' do
+      expect( Pod4::NotImplemented ).not_to be_nil
+      expect( Pod4::NotImplemented.ancestors ).to include Exception
+    end
+  end
+  ##
+
+
+  describe 'Pod4::Pod4Error' do
+    it 'is an exception' do
+      expect( Pod4::Pod4Error ).not_to be_nil
+      expect( Pod4::Pod4Error.ancestors ).to include Exception
+    end
+  end
+  ##
+
+
+  describe 'Pod4::DatabaseError' do
+    it 'is an exception based on Pod4Error' do
+      expect( Pod4::DatabaseError ).not_to be_nil
+      expect( Pod4::DatabaseError.ancestors ).to include Pod4::Pod4Error
+    end
+  end
+  ##
+
+
+  describe 'Pod4::ValidationError' do
+    it 'is an exception based on Pod4Error' do
+      expect( Pod4::ValidationError ).not_to be_nil
+      expect( Pod4::ValidationError.ancestors ).to include Pod4::Pod4Error
+    end
+  end
+  ##
+
+
+end