baza 0.0.0 → 0.0.1

data/Gemfile

@@ -15,4 +15,5 @@ group :development do
   gem "bundler", ">= 1.0.0"
   gem "jeweler", "~> 1.8.4"
   gem "sqlite3"
+  gem "mysql2"
 end

data/Gemfile.lock

@@ -18,6 +18,7 @@ GEM
       ruby_process
       tsafe
       wref
+    mysql2 (0.3.11)
     php4r (0.0.4)
       datet
       http2
@@ -49,6 +50,7 @@ DEPENDENCIES
   datet
   jeweler (~> 1.8.4)
   knjrbfw
+  mysql2
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
   sqlite3

data/README.rdoc

@@ -1,6 +1,111 @@
 = baza
 
-Description goes here.
+A database abstraction layer for Ruby.
+
+== Installation
+
+Is fairly painless.
+  gem install baza
+
+== Connection to a database.
+
+=== MySQL
+  db = Baza::Db.new(:type => :mysql, :subtype => :mysql2, :host => "localhost", :user => "my_user", :pass => "my_password", :port => 3306, :db => "my_database")
+
+=== SQLite3
+  db = Baza::Db.new(:type => :sqlite3, :path => "/path/to/file.sqlite3")
+
+== Queries
+
+=== Select
+  db.select(:users, {:name => "Kasper"}, {:orderby => "age"}) do |row|
+    puts "Row: #{row}"
+  end
+  
+  name = "Kasper"
+  db.q("SELECT * FROM users WHERE name = '#{db.esc(name)}' ORDER BY age") do |row|
+    puts "Row: #{row}"
+  end
+
+=== Inserting
+  db.insert(:users, {:name => "Kasper", :age => 27})
+  id = db.last_id
+
+It can also return the ID at the same time
+  id = db.insert(:users, {:name => "Kasper", :age => 27}, :return_id => true)
+
+Inserting multiple rows in one query is also fairly painless:
+  db.insert_multi(:users, [
+    {:name => "Kasper", :age => 27},
+    {:name => "Christina", :age => 25},
+    {:name => "Charlotte", :age => 23}
+  ])
+
+=== Update
+  db.update(:users, {:name => "Kasper Johansen"}, {:name => "Kasper"})
+
+=== Delete
+  db.delete(:users, {:name => "Kasper"})
+
+=== Upsert
+The following example handels a row that will be inserted with {:name => "Kasper", :age => 27} if it doesnt exist or rows with {:name => "Kasper"} will have their their age updated to 27.
+  db.upsert(:users, {:name => "Kasper"}, {:age => 27})
+
+== Structure
+
+=== Table creation
+  db.tables.create(:users, {
+    :columns => [
+      {:name => :id, :type => :int, :autoincr => true, :primarykey => true},
+      {:name => :name, :type => :varchar}
+    ],
+    :indexes => [
+      :name
+    ]
+  })
+
+=== Table dropping
+  table = db.tables[:users]
+  table.drop
+
+=== Table listing
+  array_of_tables = db.tables.list
+
+Or you can use blocks:
+  db.tables.list do |table|
+    puts "Table-name: #{table.name}"
+  end
+
+=== Table renaming
+  table = db.tables[:users]
+  table.rename(:new_table_name)
+
+=== Column listing
+  table = db.tables[:users]
+  cols = table.columns
+
+Or a specific column:
+  col = table.column(:id)
+  puts "Column: #{col.name} #{col.type}(#{col.maxlength})"
+
+== Copying databases
+  db_mysql = Baza::Db.new(:type => :mysql, :subtype => :mysql2, ...)
+  db_sqlite = Baza::Db.new(:type => :sqlite3, :path => ...)
+  
+  db_mysql.copy_to(db_sqlite)
+
+== Dumping SQL to an IO
+  db = Baza::Db.new(...)
+  dump = Baza::Dump.new(:db => db)
+  str_io = StringIO.new
+  dump.dump(str_io)
+
+== Transactions
+  db.transaction do
+    1000.times do
+      db.insert(:users, {:name => "Kasper"})
+    end
+  end
 
 == Contributing to baza
  

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/baza.gemspec

@@ -0,0 +1,103 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "baza"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kasper Johansen"]
+  s.date = "2013-04-16"
+  s.description = "A database abstraction layer, model framework and database framework."
+  s.email = "kj@gfish.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "baza.gemspec",
+    "include/db.rb",
+    "include/dbtime.rb",
+    "include/drivers/.DS_Store",
+    "include/drivers/mysql/mysql.rb",
+    "include/drivers/mysql/mysql_columns.rb",
+    "include/drivers/mysql/mysql_indexes.rb",
+    "include/drivers/mysql/mysql_sqlspecs.rb",
+    "include/drivers/mysql/mysql_tables.rb",
+    "include/drivers/sqlite3/libknjdb_java_sqlite3.rb",
+    "include/drivers/sqlite3/libknjdb_sqlite3_ironruby.rb",
+    "include/drivers/sqlite3/sqlite3.rb",
+    "include/drivers/sqlite3/sqlite3_columns.rb",
+    "include/drivers/sqlite3/sqlite3_indexes.rb",
+    "include/drivers/sqlite3/sqlite3_sqlspecs.rb",
+    "include/drivers/sqlite3/sqlite3_tables.rb",
+    "include/dump.rb",
+    "include/idquery.rb",
+    "include/model.rb",
+    "include/model_custom.rb",
+    "include/model_handler.rb",
+    "include/model_handler_sqlhelper.rb",
+    "include/query_buffer.rb",
+    "include/revision.rb",
+    "include/row.rb",
+    "include/sqlspecs.rb",
+    "lib/baza.rb",
+    "spec/baza_spec.rb",
+    "spec/db_spec_encoding_test_file.txt",
+    "spec/info_mysql_example.rb",
+    "spec/info_sqlite3.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kaspernj/baza"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "A database abstraction layer, model framework and database framework."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<datet>, [">= 0"])
+      s.add_runtime_dependency(%q<wref>, [">= 0"])
+      s.add_runtime_dependency(%q<knjrbfw>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<mysql2>, [">= 0"])
+    else
+      s.add_dependency(%q<datet>, [">= 0"])
+      s.add_dependency(%q<wref>, [">= 0"])
+      s.add_dependency(%q<knjrbfw>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<mysql2>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<datet>, [">= 0"])
+    s.add_dependency(%q<wref>, [">= 0"])
+    s.add_dependency(%q<knjrbfw>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<mysql2>, [">= 0"])
+  end
+end
+

data/include/db.rb

@@ -17,10 +17,57 @@ Knj.gem_require([:wref, :datet])
 class Baza::Db
   attr_reader :sep_col, :sep_table, :sep_val, :opts, :conn, :conns, :int_types
   
-  def initialize(opts)
-    self.setOpts(opts) if opts != nil
+  #Returns an array containing hashes of information about each registered driver.
+  def self.drivers
+    path = "#{File.dirname(__FILE__)}/drivers"
+    drivers = []
+    
+    Dir.foreach(path) do |file|
+      next if file.to_s.slice(0, 1) == "."
+      fp = "#{path}/#{file}"
+      next unless File.directory?(fp)
+      
+      driver_file = "#{fp}/#{file}.rb"
+      class_name = "#{file.slice(0, 1).to_s.upcase}#{file.slice(1, file.length)}".to_sym
+      
+      drivers << {
+        :name => file,
+        :driver_path => driver_file,
+        :class_name => class_name
+      }
+    end
     
-    @int_types = ["int", "bigint", "tinyint", "smallint", "mediumint"]
+    return drivers
+  end
+  
+  #Tries to create a database-object based on the given object which could be a SQLite3 object or a MySQL 2 object (or other supported).
+  def self.from_object(args)
+    args = {:object => args} if !args.is_a?(Hash)
+    raise "No :object was given." if !args[:object]
+    
+    Baza::Db.drivers.each do |driver|
+      require driver[:driver_path]
+      
+      const = Baza::Driver.const_get(driver[:class_name])
+      next unless const.respond_to?(:from_object)
+      
+      obj = const.from_object(args)
+      if obj.is_a?(Hash) and obj[:type] == :success
+        if obj[:args]
+          return Baza::Db.new(obj[:args])
+        else
+          raise "Didnt know what to do."
+        end
+      end
+    end
+    
+    raise "Could not figure out what to do what object of type: '#{args[:object].class.name}'."
+  end
+  
+  def initialize(opts)
+    @conn = opts.delete(:driver) if opts[:driver]
+    self.opts = opts if opts != nil
+    @int_types = [:int, :bigint, :tinyint, :smallint, :mediumint]
     
     if !@opts[:threadsafe]
       require "monitor"
@@ -41,7 +88,7 @@ class Baza::Db
     return @opts
   end
   
-  def setOpts(arr_opts)
+  def opts=(arr_opts)
     @opts = {}
     arr_opts.each do |key, val|
       @opts[key.to_sym] = val
@@ -163,28 +210,36 @@ class Baza::Db
     end
   end
   
+  COPY_TO_ALLOWED_ARGS = [:tables, :debug]
   #Copies the content of the current database to another instance of Baza::Db.
   def copy_to(db, args = {})
-    data["tables"].each do |table|
+    debug = args[:debug]
+    raise "No tables given." if !data[:tables]
+    
+    data[:tables].each do |table|
       table_args = nil
-      table_args = args["tables"][table["name"].to_s] if args and args["tables"] and args["tables"][table["name"].to_s]
-      next if table_args and table_args["skip"]
-      table.delete("indexes") if table.key?("indexes") and args["skip_indexes"]
-      db.tables.create(table["name"], table)
+      table_args = args[:tables][table[:name.to_sym]] if args and args[:tables] and args[:tables][table[:name].to_sym]
+      next if table_args and table_args[:skip]
+      table.delete(:indexes) if table.key?(:indexes) and args[:skip_indexes]
+      
+      table_name = table.delete(:name)
+      puts "Creating table: '#{table_name}'." if debug
+      db.tables.create(table_name, table)
       
       limit_from = 0
       limit_incr = 1000
       
       loop do
+        puts "Copying rows (#{limit_from}, #{limit_incr})." if debug
         ins_arr = []
-        q_rows = self.select(table["name"], {}, {"limit_from" => limit_from, "limit_to" => limit_incr})
+        q_rows = self.select(table_name, {}, {:limit_from => limit_from, :limit_to => limit_incr})
         while d_rows = q_rows.fetch
           col_args = nil
           
-          if table_args and table_args["columns"]
+          if table_args and table_args[:columns]
             d_rows.each do |col_name, col_data|
-              col_args = table_args["columns"][col_name.to_s] if table_args and table_args["columns"]
-              d_rows[col_name] = "" if col_args and col_args["empty"]
+              col_args = table_args[:columns][col_name.to_sym] if table_args and table_args[:columns]
+              d_rows[col_name] = "" if col_args and col_args[:empty]
             end
           end
           
@@ -193,7 +248,8 @@ class Baza::Db
         
         break if ins_arr.empty?
         
-        db.insert_multi(table["name"], ins_arr)
+        puts "Insertering #{ins_arr.length} rows." if debug
+        db.insert_multi(table_name, ins_arr)
         limit_from += limit_incr
       end
     end
@@ -210,7 +266,7 @@ class Baza::Db
     end
     
     return {
-      "tables" => tables_ret
+      :tables => tables_ret
     }
   end
   
@@ -265,12 +321,22 @@ class Baza::Db
     return sql if args and args[:return_sql]
     
     self.conn_exec do |driver|
-      driver.query(sql)
+      begin
+        driver.query(sql)
+      rescue => e
+        self.add_sql_to_error(e, sql) if @opts[:sql_to_error]
+        raise e
+      end
+      
       return driver.lastID if args and args[:return_id]
       return nil
     end
   end
   
+  def add_sql_to_error(error, sql)
+    error.message << " (SQL: #{sql})"
+  end
+  
   #Returns the correct SQL-value for the given value. If it is a number, then just the raw number as a string will be returned. nil's will be NULL and strings will have quotes and will be escaped.
   def sqlval(val)
     return @conn.sqlval(val) if @conn.respond_to?(:sqlval)
@@ -300,14 +366,21 @@ class Baza::Db
     
     if @esc_driver.respond_to?(:insert_multi)
       if args and args[:return_sql]
-        return [@esc_driver.insert_multi(tablename, arr_hashes, args)]
+        res =  @esc_driver.insert_multi(tablename, arr_hashes, args)
+        if res.is_a?(String)
+          return [res]
+        elsif res.is_a?(Array)
+          return res
+        else
+          raise "Unknown result: '#{res.class.name}'."
+        end
       end
       
       self.conn_exec do |driver|
         return driver.insert_multi(tablename, arr_hashes, args)
       end
     else
-      ret = [] if args and (args[:return_id] or args[:return_sql])
+      ret = []
       arr_hashes.each do |hash|
         if ret
           ret << self.insert(tablename, hash, args)
@@ -372,6 +445,7 @@ class Baza::Db
     end
   end
   
+  SELECT_ARGS_ALLOWED_KEYS = [:limit, :limit_from, :limit_to]
   #Makes a select from the given arguments: table-name, where-terms and other arguments as limits and orders. Also takes a block to avoid raping of memory.
   def select(tablename, arr_terms = nil, args = nil, &block)
     #Set up vars.
@@ -402,18 +476,18 @@ class Baza::Db
     end
     
     if args != nil
-      if args["orderby"]
-        sql << " ORDER BY #{args["orderby"]}"
+      if args[:orderby]
+        sql << " ORDER BY #{args[:orderby]}"
       end
       
-      if args["limit"]
-        sql << " LIMIT #{args["limit"]}"
+      if args[:limit]
+        sql << " LIMIT #{args[:limit]}"
       end
       
-      if args["limit_from"] and args["limit_to"]
-        raise "'limit_from' was not numeric: '#{args["limit_from"]}'." if !(Float(args["limit_from"]) rescue false)
-        raise "'limit_to' was not numeric: '#{args["limit_to"]}'." if !(Float(args["limit_to"]) rescue false)
-        sql << " LIMIT #{args["limit_from"]}, #{args["limit_to"]}"
+      if args[:limit_from] and args[:limit_to]
+        raise "'limit_from' was not numeric: '#{args[:limit_from]}'." if !(Float(args[:limit_from]) rescue false)
+        raise "'limit_to' was not numeric: '#{args[:limit_to]}'." if !(Float(args[:limit_to]) rescue false)
+        sql << " LIMIT #{args[:limit_from]}, #{args[:limit_to]}"
       end
     end
     
@@ -437,7 +511,7 @@ class Baza::Db
   #===Examples
   # row = db.single(:users, {:lastname => "Doe"})
   def single(tablename, arr_terms = nil, args = {})
-    args["limit"] = 1
+    args[:limit] = 1
     
     #Experienced very weird memory leak if this was not done by block. Maybe bug in Ruby 1.9.2? - knj
     self.select(tablename, arr_terms, args) do |data|
@@ -549,8 +623,13 @@ class Baza::Db
       end
     end
     
-    self.conn_exec do |driver|
-      return driver.query(string)
+    begin
+      self.conn_exec do |driver|
+        return driver.query(string)
+      end
+    rescue => e
+      e.message << " (SQL: #{string})" if @opts[:sql_to_error]
+      raise e
     end
   end