swift 0.10.0 → 0.11.0

data/lib/swift/adapter.rb

@@ -4,10 +4,6 @@ module Swift
   #
   # @abstract
   # @see      Swift::DB See Swift::DB for concrete adapters.
-  # @todo     For the time being all adapters are SQL and DBIC++ centric. It would be super easy to abstract though I
-  #           don't know if you would be better off doing it at the Ruby or DBIC++ level (or both).
-  #--
-  # TODO: Extension methods are undocumented.
   class Adapter
     attr_reader :options
 
@@ -29,69 +25,6 @@ module Swift
       prepare_get(scheme).execute(*resource.tuple.values_at(*scheme.header.keys)).first
     end
 
-    # Select one or more.
-    #
-    # @example All.
-    #   Swif.db.all(User)
-    # @example All with conditions and binds.
-    #   Swift.db.all(User, ':name = ? and :age > ?', 'Apple Arthurton', 32)
-    # @example Block form iterator.
-    #   Swift.db.all(User, ':age > ?', 32) do |user|
-    #     puts user.name
-    #   end
-    #
-    # @param  [Swift::Scheme] scheme     Concrete scheme subclass to load.
-    # @param  [String]        conditions Optional SQL 'where' fragment.
-    # @param  [Object, ...]   *binds     Optional bind values that accompany conditions SQL fragment.
-    # @param  [Proc]          &block     Optional 'each' iterator block.
-    # @return [Swift::Result]
-    # @see    Swift::Scheme.all
-    def all scheme, conditions = '', *binds, &block
-      where = "where #{exchange_names(scheme, conditions)}" unless conditions.empty?
-      prepare(scheme, "select * from #{scheme.store} #{where}").execute(*binds, &block)
-    end
-
-    # Select one.
-    #
-    # @example First.
-    #   Swif.db.first(User)
-    # @example First with conditions and binds.
-    #   Swift.db.first(User, ':name = ? and :age > ?', 'Apple Arthurton', 32)
-    # @example Block form iterator.
-    #   Swift.db.first(User, ':age > ?', 32) do |user|
-    #     puts user.name
-    #   end
-    #
-    # @param  [Swift::Scheme] scheme     Concrete scheme subclass to load.
-    # @param  [String]        conditions Optional SQL 'where' fragment.
-    # @param  [Object, ...]   *binds     Optional bind values that accompany conditions SQL fragment.
-    # @param  [Proc]          &block     Optional 'each' iterator block.
-    # @return [Swift::Scheme, nil]
-    # @see    Swift::Scheme.first
-    def first scheme, conditions = '', *binds, &block
-      where = "where #{exchange_names(scheme, conditions)}" unless conditions.empty?
-      prepare(scheme, "select * from #{scheme.store} #{where} limit 1").execute(*binds, &block).first
-    end
-
-    # Delete one or more.
-    #
-    # The SQL condition form of Swift::Adapter.destroy.
-    #
-    # @example All.
-    #   Swift.db.delete(User)
-    # @example All with conditions and binds.
-    #   Swift.db.delete(User, ':name = ? and :age > ?', 'Apple Arthurton', 32)
-    #
-    # @param  [Swift::Scheme] scheme     Concrete scheme subclass
-    # @param  [String]        conditions Optional SQL 'where' fragment.
-    # @param  [Object, ...]   *binds     Optional bind values that accompany conditions SQL fragment.
-    # @return [Swift::Result]
-    def delete scheme, conditions = '', *binds
-      sql =  "delete from #{scheme.store}"
-      sql += " where #{exchange_names(scheme, conditions)}" unless conditions.empty?
-      execute(sql, *binds)
-    end
-
     # Create one or more.
     #
     # @example Scheme.
@@ -152,7 +85,7 @@ module Swift
     #
     # @param  [Swift::Scheme]                                   scheme    Concrete scheme subclass to load.
     # @param  [Swift::Scheme, Hash, Array<Swift::Scheme, Hash>] resources The resources to be updated.
-    # @return [Swift::Scheme, Swift::Result<Swift::Scheme>]
+    # @return [Swift::Scheme, Swift::Result]
     # @note   Hashes will be coerced into a Swift::Scheme resource via Swift::Scheme#new
     # @note   Passing a scalar will result in a scalar.
     # @see    Swift::Scheme#update
@@ -172,33 +105,33 @@ module Swift
       resources.kind_of?(Array) ? result : result.first
     end
 
-    # Destroy one or more.
+    # Delete one or more.
     #
     # @example Scheme.
     #   user      = Swift.db.create(User, name: 'Apply Arthurton', age: 32)
     #   user.name = 'Arthur Appleton'
-    #   Swift.db.destroy(User, user)
+    #   Swift.db.delete(User, user)
     # @example Coerce hash to scheme.
     #   user      = Swift.db.create(User, name: 'Apply Arthurton', age: 32)
     #   user.name = 'Arthur Appleton'
-    #   Swif.db.destroy(User, user.tuple)
+    #   Swif.db.delete(User, user.tuple)
     # @example Multiple resources.
     #   apple = Swift.db.create(User, name: 'Apple Arthurton', age: 32)
     #   benny = Swift.db.create(User, name: 'Benny Arthurton', age: 30)
-    #   Swift.db.destroy(User, [apple, benny])
+    #   Swift.db.delete(User, [apple, benny])
     # @example Coerce multiple resources.
     #   apple = Swift.db.create(User, name: 'Apple Arthurton', age: 32)
     #   benny = Swift.db.create(User, name: 'Benny Arthurton', age: 30)
-    #   Swift.db.destroy(User, [apple.tuple, benny.tuple])
+    #   Swift.db.delete(User, [apple.tuple, benny.tuple])
     #
     # @param  [Swift::Scheme]                                   scheme    Concrete scheme subclass to load.
-    # @param  [Swift::Scheme, Hash, Array<Swift::Scheme, Hash>] resources The resources to be destroyed.
+    # @param  [Swift::Scheme, Hash, Array<Swift::Scheme, Hash>] resources The resources to be deleteed.
     # @return [Swift::Scheme, Array<Swift::Scheme>]
     # @note   Hashes will be coerced into a Swift::Scheme resource via Swift::Scheme#new
     # @note   Passing a scalar will result in a scalar.
-    # @see    Swift::Scheme#destroy
-    def destroy scheme, resources
-      statement = prepare_destroy(scheme)
+    # @see    Swift::Scheme#delete
+    def delete scheme, resources
+      statement = prepare_delete(scheme)
       result    = [resources].flatten.map do |resource|
         resource = scheme.new(resource) unless resource.kind_of?(scheme)
         keys     = resource.tuple.values_at(*scheme.header.keys)
@@ -215,76 +148,22 @@ module Swift
       resources.kind_of?(Array) ? result : result.first
     end
 
-
-    def migrate! scheme
-      keys   =  scheme.header.keys
-      fields =  scheme.header.map{|p| field_definition(p)}.join(', ')
-      fields += ", primary key (#{keys.join(', ')})" unless keys.empty?
-
-      execute("drop table if exists #{scheme.store} cascade")
-      execute("create table #{scheme.store} (#{fields})")
-    end
-
     protected
-      def exchange_names scheme, query
-        query.gsub(/:(\w+)/){ scheme.send($1.to_sym).field }
-      end
-
-      def returning?
-        raise NotImplementedError
-      end
-
-      def prepare_cached scheme, name, &block
-        @prepared               ||= Hash.new{|h,k| h[k] = Hash.new} # Autovivification please Matz!
-        @prepared[scheme][name] ||= prepare(scheme, yield)
-      end
-
       def prepare_get scheme
-        prepare_cached(scheme, :get) do
-          where = scheme.header.keys.map{|key| "#{key} = ?"}.join(' and ')
-          "select * from #{scheme.store} where #{where} limit 1"
-        end
+        raise NotImplementedError
       end
 
       def prepare_create scheme
-        prepare_cached(scheme, :create) do
-          values    = (['?'] * scheme.header.insertable.size).join(', ')
-          returning = "returning #{scheme.header.serial}" if scheme.header.serial and returning?
-          "insert into #{scheme.store} (#{scheme.header.insertable.join(', ')}) values (#{values}) #{returning}"
-        end
+        raise NotImplementedError
       end
 
       def prepare_update scheme
-        prepare_cached(scheme, :update) do
-          set   = scheme.header.updatable.map{|field| "#{field} = ?"}.join(', ')
-          where = scheme.header.keys.map{|key| "#{key} = ?"}.join(' and ')
-          "update #{scheme.store} set #{set} where #{where}"
-        end
-      end
-
-      def prepare_destroy scheme
-        prepare_cached(scheme, :destroy) do
-          where = scheme.header.keys.map{|key| "#{key} = ?"}.join(' and ')
-          "delete from #{scheme.store} where #{where}"
-        end
+        raise NotImplementedError
       end
 
-      def field_definition attribute
-        "#{attribute.field} " + field_type(attribute)
+      def prepare_delete scheme
+        raise NotImplementedError
       end
 
-      def field_type attribute
-        case attribute
-          when Type::String     then 'text'
-          when Type::Integer    then attribute.serial ? 'serial' : 'integer'
-          when Type::Float      then 'float'
-          when Type::BigDecimal then 'numeric'
-          when Type::Time       then 'timestamp'
-          when Type::Date       then 'date'
-          when Type::Boolean    then 'boolean'
-          when Type::IO         then 'blob'
-          else 'text'
-        end
-      end
   end # Adapter
 end # Swift

data/lib/swift/attribute.rb

@@ -29,6 +29,13 @@ module Swift
       define_scheme_methods(scheme)
     end
 
+    # The attributes field.
+    #
+    # @return [String]
+    def to_s
+      field.to_s
+    end
+
     # Evals attribute accessors for this attribute into the scheme.
     def define_scheme_methods scheme
       scheme.class_eval <<-RUBY, __FILE__, __LINE__ + 1

data/lib/swift/db.rb

@@ -1,6 +1,8 @@
+require 'swift/adapter/sql'
+
 module Swift
   module DB
-    class Mysql < Adapter
+    class Mysql < Adapter::Sql
       def initialize options = {}
         super options.update(driver: 'mysql')
       end
@@ -20,7 +22,7 @@ module Swift
       end
     end # Mysql
 
-    class Sqlite3 < Adapter
+    class Sqlite3 < Adapter::Sql
       def initialize options = {}
         super options.update(driver: 'sqlite3')
       end
@@ -54,7 +56,7 @@ module Swift
       end
     end # Sqlite3
 
-    class Postgres < Adapter
+    class Postgres < Adapter::Sql
       def initialize options = {}
         super options.update(driver: 'postgresql')
       end

data/lib/swift/migrations.rb

@@ -1,15 +1,58 @@
 module Swift
-  class Scheme
-    def self.migrations &migrations
-      (class << self; self end).send :define_method, :migrate!, lambda{|db = Swift.db| migrations.call(db) }
-    end
+  module Migrations
+    module ClassMethods
+      # @example
+      #   class User < Swift::Scheme
+      #     migrations do |db|
+      #       db.execute %q{create table users(id serial, name text, age int)}
+      #     end
+      #   end
+      #
+      # @param [Proc] &migrations
+      #
+      # @see Swift::Scheme
+      def migrations &migrations
+        define_singleton_method(:migrate!, lambda{|db = Swift.db| migrations.call(db)})
+      end
+
+      # @example
+      #   User.migrate!
+      #
+      # @param [Swift::Adapter] db
+      #
+      # @see Swift::Scheme
+      def migrate! db = Swift.db
+        db.migrate! self
+      end
+    end # ClassMethods
 
-    def self.migrate! db = Swift.db
-      db.migrate! self
-    end
-  end # Scheme
+    module InstanceMethods
+      # @example
+      #   db.migrate! User
+      #
+      # @param [Swift::Scheme] scheme
+      #
+      # @see Swift::Adapter::Sql
+      def migrate! scheme
+        keys   =  scheme.header.keys
+        fields =  scheme.header.map{|p| field_definition(p)}.join(', ')
+        fields += ", primary key (#{keys.join(', ')})" unless keys.empty?
+
+        execute("drop table if exists #{scheme.store} cascade")
+        execute("create table #{scheme.store} (#{fields})")
+      end
+    end # InstanceMethods
+  end # Migrations
 
   def self.migrate! name = nil
     schema.each{|scheme| scheme.migrate!(db(name)) }
   end
+
+  class Scheme
+    extend Migrations::ClassMethods
+  end
+
+  class Adapter::Sql
+    include Migrations::InstanceMethods
+  end
 end # Swift

data/lib/swift/scheme.rb

@@ -23,7 +23,7 @@ module Swift
     # @param [Hash] options Create resource and set attributes. <tt>{name: value}</tt>
     def initialize options = {}
       @tuple = scheme.header.new_tuple
-      options.each{|k, v| send(:"#{k}=", v)}
+      options.each{|k, v| public_send(:"#{k}=", v)}
     end
 
     # @example
@@ -36,7 +36,7 @@ module Swift
     #
     # @param [Hash] options Update attributes. <tt>{name: value}</tt>
     def update options = {}
-      options.each{|k, v| send(:"#{k}=", v)}
+      options.each{|k, v| public_send(:"#{k}=", v)}
       Swift.db.update(scheme, self)
     end
 
@@ -46,9 +46,9 @@ module Swift
     #     email:      'apple@arthurton.local',
     #     updated_at: Time.now
     #   )
-    #   apple.destroy
-    def destroy resources = self
-      Swift.db.destroy(scheme, resources)
+    #   apple.delete
+    def delete resources = self
+      Swift.db.delete(scheme, resources)
     end
 
     class << self
@@ -75,7 +75,7 @@ module Swift
       # @see Swift::Attribute#new
       def attribute name, type, options = {}
         header.push(attribute = type.new(self, name, options))
-        (class << self; self end).send(:define_method, name, lambda{ attribute })
+        define_singleton_method(name, lambda{ attribute })
       end
 
       # Define the store (table).
@@ -86,6 +86,13 @@ module Swift
         name ? @store = name : @store
       end
 
+      # Store (table) name.
+      #
+      # @return [String]
+      def to_s
+        store.to_s
+      end
+
       # Create (insert).
       #
       # @example
@@ -113,42 +120,31 @@ module Swift
         Swift.db.get(self, keys)
       end
 
-      # Select one or more.
+      # Prepare a statement for on or more executions.
       #
-      # @example All.
-      #   User.all
-      # @example All with conditions and binds.
-      #   User.all(':name = ? and :age > ?', 'Apple Arthurton', 32)
-      # @example Block form iterator.
-      #   User.all(':age > ?', 32) do |user|
-      #     puts user.name
-      #   end
+      # @example
+      #   sth = User.prepare("select * from #{User} where #{User.name} = ?")
+      #   sth.execute('apple') #=> Result
+      #   sth.execute('benny') #=> Result
       #
-      # @param  [String]        conditions Optional SQL 'where' fragment.
-      # @param  [Object, ...]   *binds     Optional bind values that accompany conditions SQL fragment.
-      # @param  [Proc]          &block     Optional 'each' iterator block.
-      # @return [Swift::Result]
-      def all conditions = '', *binds, &block
-        Swift.db.all(self, conditions, *binds, &block)
+      # @param  [String] statement Query statement.
+      # @return [Swift::Statement]
+      def prepare statement = ''
+        Swift.db.prepare(self, statement)
       end
 
-      # Select one.
+      # Execute a single statement.
       #
-      # @example First.
-      #   User.first
-      # @example First with conditions and binds.
-      #   User.first(':name = ? and :age > ?', 'Apple Arthurton', 32)
-      # @example Block form iterator.
-      #   User.first(User, 'age > ?', 32) do |user|
-      #     puts user.name
-      #   end
+      # @example
+      #   result = User.execute("select * from #{User} where #{User.name} = ?", 'apple')
+      #   sth.first # User object.
       #
-      # @param  [String]        conditions Optional SQL 'where' fragment.
-      # @param  [Object, ...]   *binds     Optional bind values that accompany conditions SQL fragment.
-      # @param  [Proc]          &block     Optional 'each' iterator block.
-      # @return [Swift::Scheme, nil]
-      def first conditions = '', *binds, &block
-        Swift.db.first(self, conditions, *binds, &block)
+      # @param  [String]  statement Query statement.
+      # @param  [*Object] binds     Bind values.
+      # @yield  [Swift::Result]
+      # @return [Swift::Result]
+      def execute statement = '', *binds, &block
+        Swift.db.execute(self, statement, *binds, &block)
       end
     end
   end # Scheme

data/lib/swift.rb

@@ -1,6 +1,7 @@
 # Extension.
 require_relative '../ext/swift'
 require_relative 'swift/adapter'
+require_relative 'swift/adapter/sql'
 require_relative 'swift/attribute'
 require_relative 'swift/db'
 require_relative 'swift/header'
@@ -40,7 +41,7 @@ require_relative 'swift/type'
 #   user.update
 #
 #   # Destroy
-#   user.destroy
+#   user.delete
 #
 # == See
 # * README.rdoc has more usage examples.

data/swift.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{swift}
-  s.version = "0.10.0"
+  s.version = "0.11.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Shane Hanna", "Bharanee 'Barney' Rathna"]
-  s.date = %q{2011-04-04}
+  s.authors = [%q{Shane Hanna}, %q{Bharanee 'Barney' Rathna}]
+  s.date = %q{2011-09-30}
   s.description = %q{A rational rudimentary database abstraction.}
-  s.email = ["shane.hanna@gmail.com", "deepfryed@gmail.com"]
-  s.extensions = ["ext/extconf.rb"]
+  s.email = [%q{shane.hanna@gmail.com}, %q{deepfryed@gmail.com}]
+  s.extensions = [%q{ext/extconf.rb}]
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
@@ -44,6 +44,7 @@ Gem::Specification.new do |s|
     "ext/swift.h",
     "lib/swift.rb",
     "lib/swift/adapter.rb",
+    "lib/swift/adapter/sql.rb",
     "lib/swift/attribute.rb",
     "lib/swift/db.rb",
     "lib/swift/header.rb",
@@ -56,6 +57,7 @@ Gem::Specification.new do |s|
     "swift.gemspec",
     "test/helper.rb",
     "test/house-explode.jpg",
+    "test/minitest_teardown_hack.rb",
     "test/test_adapter.rb",
     "test/test_encoding.rb",
     "test/test_error.rb",
@@ -63,35 +65,18 @@ Gem::Specification.new do |s|
     "test/test_io.rb",
     "test/test_pool.rb",
     "test/test_scheme.rb",
+    "test/test_swift.rb",
     "test/test_timestamps.rb",
     "test/test_transactions.rb",
     "test/test_types.rb",
     "test/test_validations.rb"
   ]
   s.homepage = %q{http://github.com/shanna/swift}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
   s.summary = %q{A rational rudimentary database abstraction.}
-  s.test_files = [
-    "examples/async.rb",
-    "examples/db.rb",
-    "examples/scheme.rb",
-    "test/helper.rb",
-    "test/test_adapter.rb",
-    "test/test_encoding.rb",
-    "test/test_error.rb",
-    "test/test_identity_map.rb",
-    "test/test_io.rb",
-    "test/test_pool.rb",
-    "test/test_scheme.rb",
-    "test/test_timestamps.rb",
-    "test/test_transactions.rb",
-    "test/test_types.rb",
-    "test/test_validations.rb"
-  ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/test/helper.rb

@@ -1,8 +1,11 @@
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'test'))
 
 require 'minitest/spec'
 require 'minitest/unit'
+require 'minitest_teardown_hack'
 require 'swift'
+require 'swift/migrations'
 require 'etc'
 
 class MiniTest::Spec
@@ -21,6 +24,9 @@ class MiniTest::Spec
         before do
           Swift.setup :default, adapter, connection_defaults.merge(adapter_defaults.fetch(adapter, {}))
         end
+        after do
+          Swift.db.close
+        end
         block.call(adapter)
       end
     end

data/test/minitest_teardown_hack.rb

@@ -0,0 +1,20 @@
+# TODO remove this once the patch gets applied to stock ruby 1.9
+class MiniTest::Spec < MiniTest::Unit::TestCase
+
+  def self.define_inheritable_method name, &block # :nodoc:
+    super_method = self.superclass.instance_method name
+
+    case name
+      when :teardown
+        define_method(name) do
+          instance_eval(&block)
+          super_method.bind(self).call if super_method
+        end
+      else
+        define_method(name) do
+          super_method.bind(self).call if super_method
+          instance_eval(&block)
+        end
+    end
+  end
+end

data/test/test_scheme.rb

@@ -11,6 +11,12 @@ describe 'scheme' do
       attribute :email,      Swift::Type::String
       attribute :verified,   Swift::Type::Boolean,  default: false
       attribute :created_at, Swift::Type::Time,     default: proc { Time.now }
+
+      migrations do |db|
+        db.execute %q{
+          create users(id serial, name text, age int, height real, email text, verified bool, created_at timestamp)
+        }
+      end
     end
   end
 
@@ -62,33 +68,16 @@ describe 'scheme' do
         assert_equal 1, Swift.db.execute(@user, 'select * from users').first.id
       end
 
-      it 'adapter should destroy valid instance' do
+      it 'adapter should delete valid instance' do
         user = @user.create
         assert_equal 1, user.id
 
-        assert Swift.db.destroy @user, user
+        assert Swift.db.delete @user, user
         assert_nil @user.get(id: 1)
       end
 
-      it 'adapter should barf when trying to destroy invalid instance' do
-        assert_raises(ArgumentError) { Swift.db.destroy @user, {id: nil, name: 'foo'} }
-      end
-
-      it 'adapter should delete all rows given scheme' do
-        user = @user.create
-        assert_equal 1, user.id
-
-        Swift.db.delete @user
-        assert_nil @user.get(id: 1)
-      end
-
-      it 'adapter should delete only relevant rows given condition & scheme' do
-        Swift.db.create(@user, [{name: 'dave'}, {name: 'mike'}])
-        assert_equal 2, @user.all.rows
-
-        Swift.db.delete @user, ':name = ?', 'dave'
-        assert_nil @user.first ':name = ?', 'dave'
-        assert @user.first ':name = ?', 'mike'
+      it 'adapter should barf when trying to delete an invalid instance' do
+        assert_raises(ArgumentError) { Swift.db.delete @user, {id: nil, name: 'foo'} }
       end
 
       it 'should not update without valid keys' do
@@ -99,7 +88,13 @@ describe 'scheme' do
       it 'should update with valid keys' do
         user = @user.create
         assert user.update(name: 'dave')
-        assert_equal 'dave', @user.first.name
+        assert_equal 'dave', @user.execute("select * from #{@user}").first.name
+      end
+
+      it 'should destroy' do
+        user = @user.create
+        assert user.update(name: 'dave')
+        assert user.delete
       end
     end
   end