amalgalite 0.7.1 → 0.7.3

data/HISTORY

@@ -1,4 +1,22 @@
-= Changelog
+= Amalgalite Changelog
+== Version 0.7.3 - 2009-02-08
+
+=== Enhancements
+
+* added Database#first_row_from
+* added Database#first_value_from
+
+=== Bug Fixes
+
+* clean up ruby warnings when run with -w
+* fix documenation on Database#execute
+
+== Version 0.7.2 - 2009-01-24
+=== Enhancements
+
+* added quoting and escaping of text support, used for database drivers
+* added ability to access columns of the schame in original definition order
+
 == Version 0.7.1 - 2009-01-18
 
 === Enhancements
@@ -15,59 +33,50 @@
 
 == Version 0.6.0 - 2009-01-10
 
-=== Major Enhancements
+=== Enhancements
 
 * Added ability to define custom SQL functions implemented in Ruby
 * Added ability to define custom SQL aggregates implemented in Ruby
 * Added support for Ruby busy handlers
 * Added database 'interrupt' support
 * Added support for Ruby progress handlers
-
-=== Minor Enhancement
-
 * update to SQLite version 3.6.7
 
 == Version 0.5.1 - 2008-11-30
 
-=== Minor Enhancement
+=== Enhancements
 
 * update to SQLite version 3.6.6.2
 
 == Version 0.5.0 - 2008-11-16
 
-=== Major Enhancement
+=== Enhancements
 
 * amalgalite-pack-into-db has been reworked into amalgalite-pack
 * ruby code that is packed into a database for later requiring can now be
   compressed
-
-=== Minor Enhancement
-
 * update to SQLite version 3.6.5
 
 == Version 0.4.2 - 2008-10-12
 
-=== Minor Enhancements
+=== Enhancements
 
 * release of windows gem
 
 == Version 0.4.1 - 2008-09-28
 
-=== Minor Enhancement
+=== Enhancements
 
 * update to SQLite3 version 3.6.3
 * change rdoc template to darkfish
 
 == Version 0.4.0 - 2008-09-14
 
-=== Major Enhancements
+=== Enhancements
 * update to SQLite3 version 3.6.2 and enable the RTree option by default
 * Amalgalite::Requires module allowing ruby code to be 'required' from columns in an SQLite database
 * Amagalite::Requires::Bootstrap extension module enabling low level boot
   strapping of the pure ruby Amalgalite code from an sqlite database
-
-=== Minor Enhancements
-
 * more indepth information about indexes is available via the Index class
 * add support for sqlite3_status and sqlite3_db_status information
 
@@ -108,15 +117,13 @@
 
 == Version 0.2.0 - 2008-07-04
 
-=== Major Enhancements
+=== Enhancements
 * blob support, both incremental access and normal access
-
-=== Minor Enhancements
 * added examples/gem_db.rb script demonstrating taps and prepared statements
 * added examples/schema-info.rb script demonstrating meta information
 * added examples/blob.rb demonstrating incremental blob IO
 * added access to the SQLite3 errcode and errmsg api
-  
+
 === Bugfixes
 * added taps.rb for requiring
 * fixed prepared statement reset

data/ext/amalgalite3.c

@@ -81,6 +81,45 @@ VALUE am_sqlite3_set_temp_directory( VALUE self, VALUE new_dir )
     return Qnil;
 }
 
+VALUE amalgalite_format_string( char* pattern, VALUE string )
+{
+    VALUE to_s= rb_funcall( string, rb_intern("to_s"), 0 );
+    VALUE str = StringValue( to_s );
+    char *p   = sqlite3_mprintf(pattern, RSTRING(str)->ptr);
+    VALUE rv  = Qnil;
+    if ( NULL != p ) {
+        rv  = rb_str_new2( p );
+        sqlite3_free( p );
+    } else {
+        rb_raise( rb_eNoMemError, "Unable to quote string" );
+    } 
+
+    return rv;
+}
+/*
+ * call-seq:
+ *  Amalgalite::SQLite.escape( string ) => escaped_string
+ *
+ * Takes the input string and escapes each ' (single quote) character by
+ * doubling it.
+ */
+VALUE am_sqlite3_escape( VALUE self, VALUE string )
+{ 
+    return ( Qnil == string ) ? Qnil : amalgalite_format_string( "%q", string );
+}
+
+/*
+ * call-seq:
+ *  Amalgalite::SQLite.quote( string ) => quoted-escaped string
+ *
+ * Takes the input string and surrounds it with single quotes, it also escapes
+ * each embedded single quote with double quotes.
+ */
+VALUE am_sqlite3_quote( VALUE self, VALUE string )
+{
+    return ( Qnil == string ) ? Qnil : amalgalite_format_string( "%Q", string );
+}
+
 /*
  * call-seq:
  *    Amalgalite::SQLite3.complete?( ... , opts = { :utf16 => false }) -> True, False
@@ -216,6 +255,9 @@ void Init_amalgalite3()
     rb_define_module_function(mAS, "temp_directory", am_sqlite3_get_temp_directory, 0);
     rb_define_module_function(mAS, "temp_directory=", am_sqlite3_set_temp_directory, 1);
 
+    rb_define_module_function(mAS, "escape", am_sqlite3_escape, 1);
+    rb_define_module_function(mAS, "quote", am_sqlite3_quote, 1);
+
     /*
      * class encapsulating a single Stat
      */

data/gemspec.rb

@@ -22,7 +22,7 @@ Amalgalite::GEM_SPEC = Gem::Specification.new do |spec|
   # add dependencies here
   # spec.add_dependency("rake", ">= 0.8.1")
   spec.add_dependency("configuration", ">= 0.0.5")
-  spec.add_dependency("arrayfields", ">= 4.5.0")
+  spec.add_dependency("arrayfields", ">= 4.7.0")
   
 
   if ext_conf = Configuration.for_if_exist?("extension") then

data/lib/amalgalite/column.rb

@@ -47,13 +47,18 @@ module Amalgalite
     # true if the column is AUTO INCREMENT, false otherwise
     attr_accessor :auto_increment
 
-    ## 
+    # The index (starting with 0) of this column in the table definition
+    # or result set
+    attr_accessor :order
+
+    ##
     # Create a column with its name and associated table
     #
-    def initialize( db, table, name)
+    def initialize( db, table, name, order)
       @db                 = db
       @name               = name
       @table              = table
+      @order              = Float(order).to_i
       @declared_data_type = nil
       @default_value      = nil
     end

data/lib/amalgalite/database.rb

@@ -74,11 +74,11 @@ module Amalgalite
         VALID.include? mode
       end
     end
-    
-   include Amalgalite::SQLite3::Constants
 
-   # list of valid modes for opening an Amalgalite::Database
-   VALID_MODES = {
+    include Amalgalite::SQLite3::Constants
+
+    # list of valid modes for opening an Amalgalite::Database
+    VALID_MODES = {
       "r"  => Open::READONLY,
       "r+" => Open::READWRITE,
       "w+" => Open::READWRITE | Open::CREATE,
@@ -138,6 +138,7 @@ module Amalgalite
       @type_map       = ::Amalgalite::TypeMaps::DefaultMap.new
       @functions      = Hash.new 
       @aggregates     = Hash.new
+      @utf16          = false
 
       unless VALID_MODES.keys.include?( mode ) 
         raise InvalidModeError, "#{mode} is invalid, must be one of #{VALID_MODES.keys.join(', ')}" 
@@ -181,15 +182,30 @@ module Amalgalite
       @api.last_insert_rowid
     end
 
+    ##
+    # SQL escape the input string
+    #
+    def escape( s )
+      Amalgalite::SQLite3.escape( s )
+    end
+
+    ##
+    # Surround the give string with single-quotes and escape any single-quotes
+    # in the string
+    def quote( s )
+      Amalgalite::SQLite3.quote( s )
+    end
+
     ##
     # Is the database utf16 or not?  A database is utf16 if the encoding is not
     # UTF-8.  Database can only be UTF-8 or UTF-16, and the default is UTF-8
     #
     def utf16?
-      unless @utf16.nil?
-        @utf16 = (encoding != "UTF-8") 
-      end
       return @utf16
+      #if @utf16.nil?
+      #  @utf16 = (encoding != "UTF-8") 
+      #end
+      #return @utf16
     end
 
     ## 
@@ -261,8 +277,13 @@ module Amalgalite
     # If called with a block and there are result rows, then they are iteratively
     # yielded to the block.
     #
-    # If no block passed and there are results, then a ResultSet is returned.
-    # Otherwise nil is returned.  On an error an exception is thrown.
+    # If no block is passed, then all the results are returned as an arrayfields
+    # instance.  This is an array with field name access.
+    #
+    # If no block is passed, and there are no results, then an empty Array is
+    # returned.
+    #
+    # On an error an exception is thrown
     #
     # This is just a wrapper around the preparation of an Amalgalite Statement and
     # iterating over the results.
@@ -310,6 +331,31 @@ module Amalgalite
       self.profile_tap = nil
     end
 
+    ##
+    # Execute a sql statment, and only return the first row of results.  This
+    # is a shorthand method when you only want a single row of results from a
+    # query.
+    #
+    # It is in all other was, exactly like #execute()
+    #
+    def first_row_from( sql, *bind_params ) 
+      stmt = prepare( sql )
+      stmt.bind( *bind_params)
+      row = stmt.next_row
+      stmt.close
+      return row
+    end
+
+    ##
+    # Execute an sql statement, and return only the first column of the first
+    # row.  
+    #
+    # It is in all other ways, exactly like #first_row_from()
+    #
+    def first_value_from( sql, *bind_params )
+      return first_row_from( sql, *bind_params).first
+    end
+
     ##
     # call-seq:
     #   db.trace_tap = obj 
@@ -842,7 +888,6 @@ module Amalgalite
     end
     alias :progress_handler :define_progress_handler
 
-
     ##
     # call-seq:
     #   db.remove_progress_handler
@@ -851,6 +896,6 @@ module Amalgalite
     def remove_progress_handler
       @api.progress_handler( nil, nil )
     end
- end
+  end
 end
 

data/lib/amalgalite/schema.rb

@@ -17,8 +17,7 @@ module Amalgalite
 
     attr_reader :catalog
     attr_reader :schema 
-    attr_reader :tables
-    attr_reader :views
+    attr_writer :dirty
     attr_reader :db
 
     #
@@ -28,32 +27,56 @@ module Amalgalite
       @db = db
       @catalog = catalog
       @schema = schema
-
+      @tables = {}
+      @views  = {}
+      @dirty  = true
       load_schema!
     end
 
+    def dirty?() @dirty; end
+    def dirty!() @dirty = true; end
+
     #
     # load the schema from the database
     def load_schema!
       load_tables
       load_views
+      @dirty = false
+    end
+
+    ##
+    # return the tables, reloading if dirty
+    def tables
+      load_schema! if dirty?
+      return @tables
     end
 
     ##
     # load all the tables
     #
     def load_tables
-      @tables = {}
-      @db.execute("SELECT tbl_name, sql FROM sqlite_master WHERE type = 'table'") do |table_info|
+      @db.execute("SELECT tbl_name FROM sqlite_master WHERE type = 'table'") do |table_info|
+        table = load_table( table_info['tbl_name'] )
+        table.indexes = load_indexes( table )
+        @tables[table.name] = table
+      end
+      return @tables
+    end
+
+    ##
+    # Load a single table
+    def load_table( table_name )
+      rows = @db.execute("SELECT tbl_name, sql FROM sqlite_master WHERE type = 'table' AND tbl_name = ?", table_name)
+      table_info = rows.first
+      table = nil
+      if table_info then 
         table = Amalgalite::Table.new( table_info['tbl_name'], table_info['sql'] )
         table.columns = load_columns( table )
         table.schema = self
         table.indexes = load_indexes( table )
-
-        @tables[table.name] = table
       end
-
-      @tables
+      @tables[table.name] = table
+      return table
     end
 
     ## 
@@ -68,13 +91,13 @@ module Amalgalite
         end
       end
 
-      @db.execute("PRAGMA index_list( #{table.name} );") do |idx_list|
+      @db.execute("PRAGMA index_list( #{@db.quote(table.name)} );") do |idx_list|
         idx = indexes[idx_list['name']]
-        
+
         idx.sequence_number = idx_list['seq']
         idx.unique          = Boolean.to_bool( idx_list['unique'] )
 
-        @db.execute("PRAGMA index_info( #{idx.name} );") do |col_info|
+        @db.execute("PRAGMA index_info( #{@db.quote(idx.name)} );") do |col_info|
           idx.columns << table.columns[col_info['name']]
         end
       end
@@ -86,8 +109,9 @@ module Amalgalite
     #
     def load_columns( table )
       cols = {}
-      @db.execute("PRAGMA table_info(#{table.name})") do |row|
-        col = Amalgalite::Column.new( "main", table.name, row['name'] )
+      idx = 0
+      @db.execute("PRAGMA table_info(#{@db.quote(table.name)})") do |row|
+        col = Amalgalite::Column.new( "main", table.name, row['name'], row['cid'])
 
         col.default_value = row['dflt_value']
         @db.api.table_column_metadata( "main", table.name, col.name ).each_pair do |key, value|
@@ -95,21 +119,39 @@ module Amalgalite
         end
         col.schema = self
         cols[col.name] = col
+        idx += 1
       end
-      cols
+      return cols
+    end
+
+    ##
+    # return the views, reloading if dirty
+    #
+    def views
+      reload_schema! if dirty?
+      return @views
+    end
+
+    ##
+    # load a single view
+    #
+    def load_view( name )
+      rows = @db.execute("SELECT name, sql FROM sqlite_master WHERE type = 'view' AND name = ?", name )
+      view_info = rows.first
+      view = Amalgalite::View.new( view_info['name'], view_info['sql'] )
+      view.schema = self
+      return view
     end
 
     ##
     # load all the views for the database
     #
     def load_views
-      @views = {}
       @db.execute("SELECT name, sql FROM sqlite_master WHERE type = 'view'") do |view_info|
-        view = Amalgalite::View.new( view_info['name'], view_info['sql'] )
-        view.schema = self
+        view = load_view( view_info['name'] )
         @views[view.name] = view
       end
-      @views
+      return @views
     end
   end
 end

data/lib/amalgalite/statement.rb

@@ -14,7 +14,6 @@ module Amalgalite
     include ::Amalgalite::SQLite3::Constants
 
     attr_reader :db
-    attr_reader :sql
     attr_reader :api
 
     class << self
@@ -29,11 +28,13 @@ module Amalgalite
     #
     def initialize( db, sql )
       @db = db
-      prepare_method   =  @db.utf16? ? :prepare16 : :prepare
+      #prepare_method   =  @db.utf16? ? :prepare16 : :prepare
+      prepare_method   =  :prepare
       @param_positions = {}
       @stmt_api        = @db.api.send( prepare_method, sql )
       @blobs_to_write  = []
       @rowid_index     = nil
+      @result_meta     = nil
     end
 
     ##
@@ -328,7 +329,7 @@ module Amalgalite
           tbl_name = @stmt_api.column_table_name( idx ) 
           col_name = @stmt_api.column_origin_name( idx ) 
 
-          column_meta.schema = ::Amalgalite::Column.new( db_name, tbl_name, col_name )
+          column_meta.schema = ::Amalgalite::Column.new( db_name, tbl_name, col_name, idx )
           column_meta.schema.declared_data_type = @stmt_api.column_declared_type( idx )
 
           # only check for rowid if we have a table name and it is not the

data/lib/amalgalite/table.rb

@@ -31,6 +31,16 @@ module Amalgalite
       @indexes = {}
       @columns = {}
     end
+
+    # the Columns in original definition order
+    def columns_in_order
+      @columns.values.sort_by { |c| c.order }
+    end
+
+    # the column names in original definition order
+    def column_names
+      columns_in_order.map { |c| c.name }
+    end
   end
 end
 

data/lib/amalgalite/type_maps/default_map.rb

@@ -22,7 +22,7 @@ module Amalgalite::TypeMaps
         @methods_handling_sql_types ||= {
           'date'      => %w[ date ],
           'datetime'  => %w[ datetime ],
-          'time'      => %w[ timestamp ],
+          'time'      => %w[ timestamp time ],
           'float'     => %w[ double real numeric decimal ],
           'integer'   => %w[ integer tinyint smallint int int2 int4 int8 bigint serial bigserial ],
           'string'    => %w[ text char varchar character ],

data/lib/amalgalite/version.rb

@@ -9,7 +9,7 @@ module Amalgalite
 
     MAJOR   = 0
     MINOR   = 7
-    BUILD   = 1
+    BUILD   = 3
 
     #
     # return the Version as an array of MAJOR, MINOR, BUILD

data/spec/database_spec.rb

@@ -330,7 +330,6 @@ describe Amalgalite::Database do
     end
 
     rudeness.join
-    other.join
 
     executions.should > 10
     had_error.should be_an_instance_of( ::Amalgalite::SQLite3::Error )
@@ -381,4 +380,42 @@ describe Amalgalite::Database do
     @iso_db.rollback
     @iso_db.should_not be_in_transaction
   end
+
+  it "can escape quoted strings" do
+    @iso_db.escape( "It's a happy day!" ).should == "It''s a happy day!"
+  end
+
+  it "can quote and escape single quoted strings" do
+    @iso_db.quote( "It's a happy day!" ).should == "'It''s a happy day!'"
+  end
+
+  it "can escape a symbol" do
+    @iso_db.escape( :stuff ).should == "stuff"
+  end
+  
+  it "can quote a symbol" do
+    @iso_db.quote( :stuff ).should == "'stuff'"
+  end
+
+  it "returns the first row of results as a convenience" do
+    row =  @iso_db.first_row_from("SELECT c.name, c.two_letter, count(*) AS count 
+                                     FROM country c
+                                     JOIN subcountry sc
+                                       ON c.two_letter  = sc.country 
+                                 GROUP BY c.name, c.two_letter
+                                 ORDER BY count DESC")
+    row.length.should == 3
+    row[0].should == "United Kingdom"
+    row[1].should == "GB"
+    row[2].should == 232
+    row['name'].should == "United Kingdom"
+    row['two_letter'].should == "GB"
+    row['count'].should == 232
+  end
+
+  it "returns the first value of results as a conveinience" do
+    val = @iso_db.first_value_from("SELECT count(*) from subcountry ")
+    val.should == 3995
+  end
+
 end

data/spec/schema_spec.rb

@@ -20,24 +20,39 @@ describe Amalgalite::Schema do
 
   it "loads the schema of a database" do
     schema = @iso_db.schema
+    schema.load_tables
     schema.tables.size.should == 2
   end
 
+  it "lazily loads new table schema" do
+    @iso_db.schema.tables.size.should == 2
+    sql = "CREATE TABLE t1 ( a, b, c )"
+    @iso_db.execute( sql )
+    @iso_db.schema.tables.size.should == 2
+    @iso_db.schema.dirty!
+    @iso_db.schema.tables['t1'].column_names.should == %w[ a b c ]
+    @iso_db.schema.tables.size.should == 3
+  end
+
   it "loads the views in the database" do
     sql = "CREATE VIEW v1 AS SELECT c.name, c.two_letter, s.name, s.subdivision FROM country AS c JOIN subcountry AS s ON c.two_letter = s.country"
     @iso_db.execute( sql )
+    @iso_db.schema.load_views
     @iso_db.schema.views.size.should == 1
     @iso_db.schema.views["v1"].sql.should == sql
   end
 
   it "loads the tables and columns" do
-    @iso_db.schema.tables.size.should == 2
     ct = @iso_db.schema.tables['country']
     ct.name.should == "country"
     ct.columns.size.should == 3
     ct.indexes.size.should == 2
+    ct.column_names.should == %w[ name two_letter id ]
+    @iso_db.schema.tables.size.should == 2
+
 
     ct.columns['two_letter'].should be_primary_key
+    ct.columns['two_letter'].declared_data_type.should == "TEXT"
     ct.columns['name'].should_not be_nullable
     ct.columns['name'].should be_not_null_constraint
     ct.columns['name'].should_not be_has_default_value

data/spec/sqlite3_spec.rb

@@ -32,4 +32,22 @@ describe "Amalgalite::SQLite3" do
     Amalgalite::SQLite3.temp_directory = nil
     Amalgalite::SQLite3.temp_directory.should == nil
   end
+
+  it "can escape quoted strings" do
+    Amalgalite::SQLite3.escape( "It's a happy day!" ).should == "It''s a happy day!"
+  end
+
+  it "can escape a symble into a string" do
+    Amalgalite::SQLite3.escape( :stuff ).should == "stuff"
+    Amalgalite::SQLite3.escape( :"stuff'n" ).should == "stuff''n"
+  end
+
+  it "can quote and escape single quoted strings" do
+    Amalgalite::SQLite3.quote( "It's a happy day!" ).should == "'It''s a happy day!'"
+  end
+
+  it "can quote and escape symbols" do
+    Amalgalite::SQLite3.quote( :stuff ).should == "'stuff'"
+    Amalgalite::SQLite3.quote( :"stuff'n" ).should == "'stuff''n'"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: amalgalite
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors: 
 - Jeremy Hinegardner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-18 00:00:00 -07:00
+date: 2009-02-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 4.5.0
+        version: 4.7.0
     version: 
 description: Amalgalite embeds the SQLite database engine in a ruby extension.  There is no need to install SQLite separately.    Look in the examples/ directory to see  * general usage * blob io * schema information * custom functions * custom aggregates * requiring ruby code from a database  Also Scroll through Amalgalite::Database for a quick example, and a general overview of the API.
 email: jeremy@hinegardner.org