pod4 0.7.1 → 0.7.2

data/lib/pod4/tds_interface.rb

@@ -13,8 +13,7 @@ module Pod4
   ##
   # Pod4 Interface for requests on a SQL table via TinyTds.
   #
-  # If your DB table is one-one with your model, you shouldn't need to override
-  # anything.
+  # If your DB table is one-one with your model, you shouldn't need to override anything.
   #
   # Example:
   #     class CustomerInterface < SwingShift::TdsInterface
@@ -30,9 +29,8 @@ module Pod4
 
     class << self
       #--
-      # These are set in the class because it keeps the model code cleaner: the
-      # definition of the interface stays in the interface, and doesn't leak
-      # out into the model.
+      # These are set in the class because it keeps the model code cleaner: the definition of the
+      # interface stays in the interface, and doesn't leak out into the model.
       #++
 
 
@@ -86,23 +84,15 @@ module Pod4
 
 
     ##
-    # Initialise the interface by passing it a TinyTds connection hash.
-    # For testing ONLY you can also pass an object which pretends to be a
-    # TinyTds client, in which case the hash is pretty much ignored.
+    # Initialise the interface by passing it a TinyTds connection hash.# For testing ONLY you can
+    # also pass an object which pretends to be a TinyTds client, in which case the hash is pretty
+    # much ignored.
     #
     def initialize(connectHash, testClient=nil)
-
-      raise(Pod4Error, 'no call to set_db in the interface definition') \
-        if self.class.db.nil?
-
-      raise(Pod4Error, 'no call to set_table in the interface definition') \
-        if self.class.table.nil?
-
-      raise(Pod4Error, 'no call to set_id_fld in the interface definition') \
-        if self.class.id_fld.nil?
-
-      raise(ArgumentError, 'invalid connection hash') \
-        unless connectHash.kind_of?(Hash)
+      raise(Pod4Error, 'no call to set_db in the interface definition') if self.class.db.nil?
+      raise(Pod4Error, 'no call to set_table in the interface definition') if self.class.table.nil?
+      raise(Pod4Error, 'no call to set_id_fld in the interface definition') if self.class.id_fld.nil?
+      raise(ArgumentError, 'invalid connection hash') unless connectHash.kind_of?(Hash)
 
       @connect_hash = connectHash.dup
       @test_client  = testClient 
@@ -127,8 +117,8 @@ module Pod4
 
 
     ##
-    # Selection is a hash or something like it: keys should be field names. We
-    # return any records where the given fields equal the given values.
+    # Selection is a hash or something like it: keys should be field names. We return any records
+    # where the given fields equal the given values.
     #
     def list(selection=nil)
 
@@ -154,8 +144,9 @@ module Pod4
 
     ##
     # Record is a hash of field: value
-    # By a happy coincidence, insert returns the unique ID for the record,
-    # which is just what we want to do, too.
+    #
+    # By a happy coincidence, insert returns the unique ID for the record, which is just what we
+      # want to do, too.
     #
     def create(record)
       raise(ArgumentError, "Bad type for record parameter") \
@@ -190,9 +181,8 @@ module Pod4
       Octothorpe.new( select(sql).first )
 
     rescue => e
-      # select already wrapped any error in a Pod4::DatabaseError, but in this
-      # case we want to try to catch something. (Side note: TinyTds' error
-      # class structure is a bit poor...)
+      # select already wrapped any error in a Pod4::DatabaseError, but in this case we want to try
+      # to catch something. (Side note: TinyTds' error class structure is a bit poor...)
       raise CantContinue, "Problem reading record. Is '#{id}' really an ID?" \
         if e.cause.class   == TinyTds::Error \
         && e.cause.message =~ /invalid column/i
@@ -202,8 +192,8 @@ module Pod4
 
 
     ##
-    # ID is whatever you set in the interface using set_id_fld
-    # record should be a Hash or Octothorpe.
+    # ID is whatever you set in the interface using set_id_fld record should be a Hash or
+      # Octothorpe.
     #
     def update(id, record)
       raise(ArgumentError, "Bad type for record parameter") \
@@ -242,15 +232,14 @@ module Pod4
     ##
     # Run SQL code on the server. Return the results.
     #
-    # Will return an array of records, or you can use it in block mode, like
-    # this:
+    # Will return an array of records, or you can use it in block mode, like this:
     #
     #     select("select * from customer") do |r|
     #       # r is a single record
     #     end
     #
-    # The returned results will be an array of hashes (or if you passed a
-    # block, of whatever you returned from the block).
+    # The returned results will be an array of hashes (or if you passed a block, of whatever you
+    # returned from the block).
     #
     def select(sql)
       raise(ArgumentError, "Bad sql parameter") unless sql.kind_of?(String)
@@ -323,8 +312,9 @@ module Pod4
 
     ##
     # Close the connection to the database.
-    # We don't actually use this, but it's here for completeness. Maybe a
-    # caller will find it useful.
+    #
+    # We don't actually use this, but it's here for completeness. Maybe a caller will find it
+    # useful.
     #
     def close
       Pod4.logger.info(__FILE__){ "Closing connection to DB" }
@@ -369,8 +359,10 @@ module Pod4
       case fld
         when DateTime, Time
           %Q|'#{fld.to_s[0..-7]}'|
-        when String, Date
+        when Date
           %Q|'#{fld}'|
+        when String
+          %Q|'#{fld.gsub("'", "''")}'|
         when BigDecimal
           fld.to_f
         when nil
@@ -386,8 +378,8 @@ module Pod4
       raise CantContinue, "'No record found with ID '#{id}'" if read(id).empty?
     end
 
-
   end
 
 
 end
+

data/lib/pod4/typecasting.rb

@@ -6,13 +6,11 @@ module Pod4
 
 
   ##
-  # A mixin to give you some more options to control how Pod4 maps the
-  # interface to the model.
+  # A mixin to give you some more options to control how Pod4 maps the interface to the model.
   #
-  # Eventually we will actually have typecasting in here. For now all this
-  # allows you to do is enforce an encoding -- which will be of use if you are
-  # dealing with MSSQL, or with certain interfaces which appear to deal with
-  # the code page poorly:
+  # Eventually we will actually have typecasting in here. For now all this allows you to do is
+  # enforce an encoding -- which will be of use if you are dealing with MSSQL, or with certain
+  # interfaces which appear to deal with the code page poorly:
   #
   #     class FOo < Pod4::Model
   #       include Pod4::TypeCasting
@@ -27,10 +25,9 @@ module Pod4
     ##
     # A little bit of magic, for which I apologise. 
     #
-    # When you include this module it actually adds the methods in ClassMethods
-    # to the class as if you had called `extend TypeCasting:ClassMethds` *AND*
-    # adds the methods in InstanceMethods as if you had written `prepend
-    # TypeCasting::InstanceMethods`.  
+    # When you include this module it actually adds the methods in ClassMethods to the class as if
+    # you had called `extend TypeCasting:ClassMethds` *AND* adds the methods in InstanceMethods as
+    # if you had written `prepend TypeCasting::InstanceMethods`.  
     #
     # In my defence: I didn't want to have to make you remember to do that...
     #

data/lib/pod4/version.rb

@@ -1,3 +1,3 @@
 module Pod4 
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/lib/pod4.rb

@@ -11,22 +11,21 @@ require_relative 'pod4/alert'
 ##
 # Pod4, which:
 #
-# * will gather data from absolutely anything. Nebulous, Sequel, Pg,
-#   TinyTds, whatever. Add your own on the fly.
+# * will gather data from absolutely anything. Nebulous, Sequel, Pg, TinyTds, whatever. Add your
+#   own on the fly.
 #
-# * will allow you to define models which are genuinely represent the data
-#   your way, not the way the data source sees it.
+# * will allow you to define models which are genuinely represent the data your way, not the way
+#   the data source sees it.
 #
-# * is hopefully simple and clean; just a very light helper layer with the
-#   absolute minimum of magic or surprises for the developer. 
+# * is hopefully simple and clean; just a very light helper layer with the absolute minimum of
+#   magic or surprises for the developer. 
 #
 # For more information:
 # 
 # * There is a short tutorial in the readme.
 #
-# * you should look at the contract Pod4 makes with its
-#   callers -- you should find all that you need in the classes Pod4::Interface
-#   and Pod4::Model. 
+# * you should look at the contract Pod4 makes with its callers -- you should find all that you
+#   need in the classes Pod4::Interface and Pod4::Model. 
 #
 # * Or, read the tests, of course.
 #

data/md/fixme.md

@@ -1,22 +1,3 @@
 Things I Wish I Could Do
 ========================
 
-* TinyTds gem fails to cast date fields as date. Nothing we can do about that,
-  AFAICS.
-
-
-Things To Do
-============
-
-* I had a note here on how SequelInterface does not support the table and
-  quoted_table variables. Well, these definitely aren't part of the contract:
-  how would NebulousInterface support them? But there might be an issue with
-  passing selection parameters to SequelInterface.list if the schema is set. We
-  need to tie down a test for that and fix it if it exists.
-
-* TinyTDS just updated to 1.0 and ... fell over.  We need to work out what's
-  going on there.
-
-* Ideally interfaces should support parameterised insertion. Ideally in a
-  manner consistent for all interfaces...
-

data/pod4.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = spec.files.grep(%r{^md/})
 
   spec.add_runtime_dependency "devnull",    '~>0.1'
-  spec.add_runtime_dependency "octothorpe", '~>0.2'
+  spec.add_runtime_dependency "octothorpe", '~>0.3'
 
 =begin
   # for bundler, management, etc etc

data/spec/jruby/pg_interface_spec.rb

@@ -1,3 +1,6 @@
+# This is a copy of spec/mri/pg_interface_spec.rb; you can use it to judge
+# whether pg_jruby is currently a good drop-in replacement for pg...  :(
+
 require 'pod4/pg_interface'
 require 'pg'
 
@@ -219,6 +222,13 @@ describe TestPgInterface do
       expect( interface.read(id).to_h ).to include(record)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      record = {name: %Q|T'Challa""|, 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
   ##
 
@@ -353,6 +363,12 @@ describe TestPgInterface do
       expect( interface.read(id).to_h ).to include(record)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      record = {name: %Q|T'Challa""|, price: nil}
+      expect{ interface.update(id, record) }.not_to raise_exception
+      expect( interface.read(id).to_h ).to include(record)
+    end
+
   end
   ##
 

data/spec/mri/pg_interface_spec.rb

@@ -219,6 +219,13 @@ describe TestPgInterface do
       expect( interface.read(id).to_h ).to include(record)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      record = {name: %Q|T'Challa""|, 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
   ##
 
@@ -353,6 +360,12 @@ describe TestPgInterface do
       expect( interface.read(id).to_h ).to include(record)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      record = {name: %Q|T'Challa""|, price: nil}
+      expect{ interface.update(id, record) }.not_to raise_exception
+      expect( interface.read(id).to_h ).to include(record)
+    end
+
   end
   ##
 

data/spec/{common → mri}/sequel_interface_spec.rb

@@ -5,7 +5,7 @@ require 'date'
 require 'time'
 require 'bigdecimal'
 
-require_relative 'shared_examples_for_interface'
+require_relative '../common/shared_examples_for_interface'
 
 
 class TestSequelInterface < SequelInterface
@@ -238,6 +238,13 @@ describe TestSequelInterface do
       expect( interface.read(id).to_h ).to include(record)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      record = {name: "T'Challa[]", 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
   ##
 
@@ -372,6 +379,12 @@ describe TestSequelInterface do
       expect( interface.read(id).to_h ).to include(record)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      record = {name: "T'Challa[]", price: nil}
+      expect{ interface.update(id, record) }.not_to raise_exception
+      expect( interface.read(id).to_h ).to include(record)
+    end
+
   end
   ##
 

data/spec/mri/tds_interface_spec.rb

@@ -259,6 +259,13 @@ describe TestTdsInterface do
       expect( interface.read(id).to_h ).to include(hash2)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      hash2 = {name: "T'Challa[]", price: nil}
+      expect{ interface.create(hash2) }.not_to raise_exception
+      id = interface.create(hash2)
+      expect( interface.read(id).to_h ).to include(hash2)
+    end
+
   end
   ##
 
@@ -394,6 +401,12 @@ describe TestTdsInterface do
       expect( interface.read(id).to_h ).to include(record)
     end
 
+    it 'shouldnt have a problem with strings containing special characters' do
+      record = {name: "T'Challa[]", price: nil}
+      expect{ interface.update(id, record) }.not_to raise_exception
+      expect( interface.read(id).to_h ).to include(record)
+    end
+
   end
   ##
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pod4
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Andy Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devnull
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 description: |
   Provides a simple, common framework to talk to a bunch of data sources,
   using model classes which consist of a bare minimum of DSL plus vanilla Ruby
@@ -85,13 +85,13 @@ files:
 - spec/common/null_interface_spec.rb
 - spec/common/param_spec.rb
 - spec/common/pod4_spec.rb
-- spec/common/sequel_interface_spec.rb
 - spec/common/shared_examples_for_interface.rb
 - spec/common/spec_helper.rb
 - spec/doc_no_pending.rb
 - spec/fixtures/database.rb
 - spec/jruby/pg_interface_spec.rb
 - spec/mri/pg_interface_spec.rb
+- spec/mri/sequel_interface_spec.rb
 - spec/mri/tds_interface_spec.rb
 - spec/spec_helper.rb
 - tags
@@ -129,13 +129,12 @@ test_files:
 - spec/common/null_interface_spec.rb
 - spec/common/param_spec.rb
 - spec/common/pod4_spec.rb
-- spec/common/sequel_interface_spec.rb
 - spec/common/shared_examples_for_interface.rb
 - spec/common/spec_helper.rb
 - spec/doc_no_pending.rb
 - spec/fixtures/database.rb
 - spec/jruby/pg_interface_spec.rb
 - spec/mri/pg_interface_spec.rb
+- spec/mri/sequel_interface_spec.rb
 - spec/mri/tds_interface_spec.rb
 - spec/spec_helper.rb
-has_rdoc: