fluiddb 0.0.6 → 0.0.8

data/README.md

@@ -5,3 +5,6 @@ A semantic layer for db interaction
 ##install
 	gem install fluiddb
 
+##Examples
+
+See the tests for a reasonable run down on usage.

data/lib/FluidDb.rb

@@ -1,4 +1,5 @@
 require 'date'
+require 'time'
 require 'uri'
 
 module FluidDb
@@ -17,6 +18,15 @@ module FluidDb
     class Base
         
         @connection;
+        @uri
+
+        # Constructor.
+        #
+        # @param [String] uri a location for the resource to which we will attach, eg mysql://user:pass@127.0.0.1/foo
+        def initialize(uri)
+            @uri = uri
+            self.connect
+        end
 
         def format_to_sql( sql, params=nil )
             if params.nil? then
@@ -30,6 +40,9 @@ module FluidDb
                     elsif v.is_a? DateTime then
                     s = "'" + v.strftime( "%Y-%m-%d %H:%M:%S" ) + "'"
                     sql = sql.sub( "?", s )
+                    elsif v.is_a? Time then
+                    s = "'" + v.strftime( "%Y-%m-%d %H:%M:%S" ) + "'"
+                    sql = sql.sub( "?", s )
                     elsif v.kind_of? Date then
                     v = "'" + v.to_s + "'"
                     sql = sql.sub( "?", v.to_s )
@@ -42,7 +55,7 @@ module FluidDb
             
             return sql
         end
-
+        
         def convertTupleToHash( fields, tuple, j )
             hash = Hash.new
             0.upto( fields.length-1 ).each do |i|
@@ -50,12 +63,37 @@ module FluidDb
             end
             
             return hash
-        end        
+        end
         
+        def connect
+            raise NotImplementedError.new("You must implement 'connect'.")
+        end
+        
+        def close
+            raise NotImplementedError.new("You must implement 'close'.")
+        end
+
+        def reconnect
+            self.close
+            self.connect
+        end
+
+        # Return a single row from the database, given the sql parameter.
+        # Throwa an error for no data.
+        # Throws an error for more than 1 row
+        #
+        # @param [String] sql The SELECT statement to run
+        # @param [Array] parama The parameters to be added to the sql query. Ruby types are used to determine formatting and escaping.
         def queryForArray( sql, params )
             raise NotImplementedError.new("You must implement 'queryForArray'.")
         end
         
+        # Return a single value is returned from a single row from the database, given the sql parameter.
+        # Throwa an error for no data.
+        # Throws an error for more than 1 row
+        #
+        # @param [String] sql The SELECT statement to run
+        # @param [Array] parama The parameters to be added to the sql query. Ruby types are used to determine formatting and escaping.
         def queryForValue( sql, params )
             raise NotImplementedError.new("You must implement 'queryForValue'.")
         end
@@ -64,6 +102,11 @@ module FluidDb
             raise NotImplementedError.new("You must implement 'queryForResultset'.")
         end
         
+        # Execute an insert, update or delete, then check the impact that statement has on the data.
+        #
+        # @param [String] sql The SELECT statement to run
+        # @param [Array] parama The parameters to be added to the sql query. Ruby types are used to determine formatting and escaping.
+        # @param [String] expected_affected_rows The number of rows that should have been updated.
         def execute( sql, params, expected_affected_rows )
             raise NotImplementedError.new("You must implement 'execute'.")
         end

data/lib/FluidDb/Mysql.rb

@@ -5,12 +5,20 @@ module FluidDb
     
     class Mysql<Base
         
-        def initialize(uri)
+        # Connect to Db.
+        #
+        # @param [String] uri a location for the resource to which we will attach, eg mysql://user:pass@127.0.0.1/foo
+        def connect()
+            uri = @uri
             database = uri.path.sub( "/", "" )
             
             @connection = ::Mysql.new uri.host, uri.user, uri.password, database, nil, nil, ::Mysql::CLIENT_FOUND_ROWS
         end
         
+        def close
+            @connection.close
+        end
+        
         def queryForArray( sql, params )
             sql = self.format_to_sql( sql, params )
             results = @connection.query(sql)
@@ -60,7 +68,6 @@ module FluidDb
             
         end
         
-        
         def queryForResultset( sql, params )
             sql = self.format_to_sql( sql, params )
             results = @connection.query(sql)
@@ -82,7 +89,7 @@ module FluidDb
                 return list
             end
         end
-
+        
         def execute( sql, params, expected_affected_rows=nil )
             sql = self.format_to_sql( sql, params )
             #            puts "sql: #{sql}"
@@ -93,7 +100,7 @@ module FluidDb
                 raise ExpectedAffectedRowsError.new( "Expected affected rows, #{expected_affected_rows}, Actual affected rows, #{@connection.affected_rows}")
             end
         end
-
+        
         def insert( sql, params )
             self.execute( sql, params )
             return @connection.insert_id

data/lib/FluidDb/Mysql2.rb

@@ -4,8 +4,12 @@ require "mysql2"
 module FluidDb
     
     class Mysql2<Base
-
-        def initialize(uri)
+        
+        # Connect to Db.
+        #
+        # @param [String] uri a location for the resource to which we will attach, eg mysql://user:pass@127.0.0.1/foo
+        def connect()
+            uri = @uri
             host = uri.host
             database = uri.path.sub( "/", "" )
             
@@ -16,6 +20,10 @@ module FluidDb
                                                :flags => ::Mysql2::Client::FOUND_ROWS )
         end
         
+        def close
+            @connection.close
+        end
+        
         def queryForArray( sql, params )
             sql = self.format_to_sql( sql, params )
             results = @connection.query(sql)

data/lib/FluidDb/Pgsql.rb

@@ -5,13 +5,21 @@ module FluidDb
     
     class Pgsql<Base
         
-        def initialize(uri)
+        # Connect to Db.
+        #
+        # @param [String] uri a location for the resource to which we will attach, eg mysql://user:pass@127.0.0.1/foo
+        def connect()
+            uri = @uri
             host = uri.host
             database = uri.path.sub( "/", "" )
             
             @connection = PG.connect( dbname:uri.path.sub( "/", "" ) )
         end
-
+        
+        def close
+            @connection.close
+        end
+        
         def queryForArray( sql, params )
             sql = self.format_to_sql( sql, params )
             results = @connection.exec(sql)
@@ -36,7 +44,7 @@ module FluidDb
         def queryForValue( sql, params )
             sql = self.format_to_sql( sql, params )
             results = @connection.exec(sql)
-
+            
             #        if ( $result === false ) then
             #    $message = pg_last_error( $this->connection );
             #    throw new Fluid_ConnectionException( $message );
@@ -89,13 +97,13 @@ module FluidDb
                 raise ExpectedAffectedRowsError.new( "Expected affected rows, #{expected_affected_rows}, Actual affected rows, #{r.cmd_tuples}")
             end
         end
-
+        
         def insert( sql, params )
             raise "Pgsql uses SEQUENCES, so possibly easier to use 2 executes"
             #            self.execute( sql, params )
             #return @connection.last_id
         end
-
+        
     end
     
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluiddb
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies: []
 description: A semantic layer for db interaction
 email: guy@guyirvine.com