flexirecord 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,15 +1,36 @@
+%YAML 1.1
+---
 
-CHANGELOG for FlexiRecord:
+# CHANGELOG for FlexiRecord:
 
-2007-02-10:
-- Changed the order of arguments passed to FlexiRecord::Reference#combine to match the documentation and renamed the method to FlexiRecord::Reference#connect.
-- Minor bugfix in FlexiRecord::Relationship#new
-- Added FlexiRecord::BaseRecord.add_connected_references as a more simple way to add many-to-many relations.
+- 2007-02-10:
+  - >
+    Changed the order of arguments passed to FlexiRecord::Reference#combine
+    to match the documentation and renamed the method to
+    FlexiRecord::Reference#connect.
+  - >
+    Minor bugfix in FlexiRecord::Relationship#new
+  - >
+    Added FlexiRecord::BaseRecord.add_connected_references as a more simple
+    way to add many-to-many relations.
 
-2007-02-11:
-- Renamed the word 'column' to 'attr' or 'attribute' at several places in the code and documentation.
-- Freezed record arrays, which are fetched through attributes for many-to-one or many-to-many relations.
-- Added a lock method, to lock tables in a nicier way.
+- 2007-02-11:
+  - >
+    Renamed the word 'column' to 'attr' or 'attribute' at several places in
+    the code and documentation.
+  - >
+    Freezed record arrays, which are fetched through attributes for
+    many-to-one or many-to-many relations.
+  - >
+    Added a lock method, to lock tables in a nicier way.
 
-Release of version 0.0.4.
+- Release of version 0.0.4.
+
+- 2007-02-11:
+  - >
+    Added FlexiRecord::BaseRecord#transaction method.
+  - >
+    Fixed a bug in the FlexiRecord::ListRecord module.
+  - >
+    'src_to_dst_attr' and 'dst_to_src_attr' arguments of FlexiRecord::Reference.new are now allowed to be nil.
 

data/lib/flexirecord.rb

@@ -123,7 +123,7 @@ module FlexiRecord
   # - LockMode::Share
   #   (Prohibits data changes in the table.)
   # - LockMode::ShareRowExclusive
-  #   (Prohibits data changes and other Share or ShareRowExclusive locks. Used instead of LockMode::Share to prohibit dead locks.)
+  #   (Prohibits data changes and other Share or ShareRowExclusive locks. Used instead of LockMode::Share to prohibit dead locks, where two processes holding share locks want to write to a table.)
   # - LockMode::Exclusive
   #   (Prohibits anything else than reading from the table.)
   # - LockMode::AccessExclusive
@@ -178,7 +178,7 @@ module FlexiRecord
 
     # Returns a new reference object, describing a relation where objects of the 'source_class' refer to objects of the 'destination_class'. The 'column_info' field describes the columns used for that reference. If the 'column_info' field is a string, the primary key is used in the destination class, and the primary key prefixed by the string given in 'column_info' is used as the foreign key in the source class. If 'column_info' is an array, it contains the columns in the source class, followed by the columns in the destination class. The field 'src_to_dst_attr' contains the name of the attribute in the source class, which is referring to one object of the destination class. The field 'dst_to_src_attr' contains the name of the attribute in the destination class, which is referring to one or many objects of the source class. After the reference has been created, reader, loader and setter functions are added to the 'source_class' and 'destination_class', to provide access to referenced and referring objects.
     # This method is private, use one of the child classes OneToOneReference or ManyToOneReference, which get the same arguments, to generate references of a given type.
-    def initialize(source_class, destination_class, column_info, src_to_dst_attr, dst_to_src_attr)
+    def initialize(source_class, destination_class, column_info, src_to_dst_attr, dst_to_src_attr=nil)
       unless source_class.kind_of? Class and destination_class.kind_of? Class
         raise TypeError, "Class expected"
       end
@@ -204,113 +204,119 @@ module FlexiRecord
       end
       @source_columns.freeze
       @destination_columns.freeze
-      @src_to_dst_attr = src_to_dst_attr.to_s.dup.freeze
-      @dst_to_src_attr = dst_to_src_attr.to_s.dup.freeze
-      # Work at the source class:
-      @source_class.set_loader(@src_to_dst_attr) do |source_records, arguments|
-        unless arguments.empty?
-          raise ArgumentError, "No extra arguments may be specified for outgoing reference columns."
-        end
-        destination_records = @destination_class.select_by_value_set(
-          @destination_columns,
-          source_records.collect { |source_record|
-            @source_columns.collect { |column| source_record[column] }
-          },
-          *arguments
-        )
-        destination_record_hash = {}
-        destination_records.each do |destination_record|
-          destination_record_hash[@destination_columns.collect { |column| destination_record[column] }] = destination_record
-          if self.one_to_one?
-            destination_record[@dst_to_src_attr] = nil
-          end
-        end
-        source_records.each do |source_record|
-          destination_record = 
-            destination_record_hash[@source_columns.collect { |column| source_record[column] }]
-          source_record[@src_to_dst_attr, *arguments] = destination_record
-          if destination_record and self.one_to_one?
-            destination_record[@dst_to_src_attr] = source_record
+      @src_to_dst_attr = src_to_dst_attr ? src_to_dst_attr.to_s.dup.freeze : nil
+      @dst_to_src_attr = dst_to_src_attr ? dst_to_src_attr.to_s.dup.freeze : nil
+      # Work at the source_class:
+      if @src_to_dst_attr
+        @source_class.set_loader(@src_to_dst_attr) do |source_records, arguments|
+          unless arguments.empty?
+            raise ArgumentError, "No extra arguments may be specified for outgoing reference columns."
           end
-        end
-        next destination_records
-      end
-      @source_columns.each_index do |column_index|
-        source_column = @source_columns[column_index]
-        destination_column = @destination_columns[column_index]
-        @source_class.set_reader(source_column) do |source_record, arguments|
-          destination_record = source_record[@src_to_dst_attr]
-          next destination_record ? destination_record[destination_column] : source_record[source_column]
-        end
-        @source_class.set_setter(source_column) do |source_record, value|
-          source_record.delete_from_cache(@src_to_dst_attr)
-          source_record[source_column] = value
-        end
-      end
-      if self.one_to_one?
-        @source_class.set_setter(@src_to_dst_attr) do |source_record, value|
-          old_destination_record = source_record[@src_to_dst_attr]
-          if old_destination_record
-            old_destination_record[@dst_to_src_attr] = nil
+          destination_records = @destination_class.select_by_value_set(
+            @destination_columns,
+            source_records.collect { |source_record|
+              @source_columns.collect { |column| source_record[column] }
+            },
+            *arguments
+          )
+          destination_record_hash = {}
+          destination_records.each do |destination_record|
+            destination_record_hash[@destination_columns.collect { |column| destination_record[column] }] = destination_record
+            if self.one_to_one? and @dst_to_src_attr
+              destination_record[@dst_to_src_attr] = nil
+            end
           end
-          source_record[@src_to_dst_attr] = value
-          if value
-            value[@dst_to_src_attr] = source_record
+          source_records.each do |source_record|
+            destination_record = 
+              destination_record_hash[@source_columns.collect { |column| source_record[column] }]
+            source_record[@src_to_dst_attr, *arguments] = destination_record
+            if destination_record and self.one_to_one? and @dst_to_src_attr
+              destination_record[@dst_to_src_attr] = source_record
+            end
           end
+          next destination_records
         end
-      end
-      # Work at the destination class:
-      @destination_class.set_loader(@dst_to_src_attr) do |destination_records, arguments|
-        unless arguments.empty?
-          unless arguments[0].respond_to? :to_str
-            raise "First argument of reader method is not a SQL snippet string."
+        @source_columns.each_index do |column_index|
+          source_column = @source_columns[column_index]
+          destination_column = @destination_columns[column_index]
+          @source_class.set_reader(source_column) do |source_record, arguments|
+            destination_record = source_record[@src_to_dst_attr]
+            next destination_record ? destination_record[destination_column] : source_record[source_column]
+          end
+          @source_class.set_setter(source_column) do |source_record, value|
+            source_record.delete_from_cache(@src_to_dst_attr)
+            source_record[source_column] = value
           end
-          arguments[0] = arguments[0].to_str
         end
-        source_records = @source_class.select_by_value_set(
-          @source_columns,
-          destination_records.collect { |destination_record|
-            @destination_columns.collect { |column| destination_record[column] }
-          },
-          *arguments
-        )
-        destination_record_hash = {}
-        destination_records.each do |destination_record|
-          destination_record_hash[@destination_columns.collect { |column| destination_record[column] }] = destination_record
-          destination_record[@dst_to_src_attr, *arguments] =
-            if self.many_to_one?
-              FlexiRecord::RecordArray.new(@source_class)
-            else
-              nil
+        if self.one_to_one? and @dst_to_src_attr
+          @source_class.set_setter(@src_to_dst_attr) do |source_record, value|
+            old_destination_record = source_record[@src_to_dst_attr]
+            if old_destination_record
+              old_destination_record[@dst_to_src_attr] = nil
             end
-        end
-        source_records.each do |source_record|
-          destination_record = destination_record_hash[@source_columns.collect { |column| source_record[column] }]
-          source_record[@src_to_dst_attr] = destination_record
-          if destination_record
-            if self.many_to_one?
-              destination_record[@dst_to_src_attr, *arguments] << source_record
-            else
-              destination_record[@dst_to_src_attr, *arguments] = source_record
+            source_record[@src_to_dst_attr] = value
+            if value
+              value[@dst_to_src_attr] = source_record
             end
           end
         end
-        if self.many_to_one?
+      end
+      # Work at the destination_class:
+      if @dst_to_src_attr
+        @destination_class.set_loader(@dst_to_src_attr) do |destination_records, arguments|
+          unless arguments.empty?
+            unless arguments[0].respond_to? :to_str
+              raise "First argument of reader method is not a SQL snippet string."
+            end
+            arguments[0] = arguments[0].to_str
+          end
+          source_records = @source_class.select_by_value_set(
+            @source_columns,
+            destination_records.collect { |destination_record|
+              @destination_columns.collect { |column| destination_record[column] }
+            },
+            *arguments
+          )
+          destination_record_hash = {}
           destination_records.each do |destination_record|
-            destination_record[@dst_to_src_attr, *arguments].freeze
+            destination_record_hash[@destination_columns.collect { |column| destination_record[column] }] = destination_record
+            destination_record[@dst_to_src_attr, *arguments] =
+              if self.many_to_one?
+                FlexiRecord::RecordArray.new(@source_class)
+              else
+                nil
+              end
           end
-        end
-        next source_records
-      end
-      if self.one_to_one?
-        @destination_class.set_setter(@dst_to_src_attr) do |destination_record, value|
-          old_source_record = destination_record[@dst_to_src_attr]
-          if old_source_record
-            old_source_record[@src_to_dst_attr] = nil
+          source_records.each do |source_record|
+            destination_record = destination_record_hash[@source_columns.collect { |column| source_record[column] }]
+            if @src_to_dst_attr
+              source_record[@src_to_dst_attr] = destination_record
+            end
+            if destination_record
+              if self.many_to_one?
+                destination_record[@dst_to_src_attr, *arguments] << source_record
+              else
+                destination_record[@dst_to_src_attr, *arguments] = source_record
+              end
+            end
+          end
+          if self.many_to_one?
+            destination_records.each do |destination_record|
+              destination_record[@dst_to_src_attr, *arguments].freeze
+            end
           end
-          destination_record[@dst_to_src_attr] = value
-          if value
-            value[@src_to_dst_attr] = destination_record
+          next source_records
+        end
+        if self.one_to_one? and @src_to_dst_attr
+          @destination_class.set_setter(@dst_to_src_attr) do |destination_record, value|
+            old_source_record = destination_record[@dst_to_src_attr]
+            if old_source_record
+              old_source_record[@src_to_dst_attr] = nil
+            end
+            destination_record[@dst_to_src_attr] = value
+            if value
+              value[@src_to_dst_attr] = destination_record
+            end
           end
         end
       end
@@ -352,7 +358,7 @@ module FlexiRecord
             end
             sql_snippet = sql_snippet.to_str
           end
-          # TODO: Do SELECT DISTINCT. (breaks for now, as ORDER BY expressions must appear in select list)
+          # TODO: Do SELECT DISTINCT perhaps? (breaks for now, as ORDER BY expressions must appear in select list)
           destination_records = unless source_records.empty?
             destination_class.sql(
               'SELECT ' << FlexiRecord::DefaultTableAlias << '.* FROM (' <<
@@ -1152,6 +1158,11 @@ module FlexiRecord
         end
       end
 
+      # Wraps the given block in a transaction of the database being used to store the object. See FlexiRecord::Connection#transaction for details of the command. This object is automatically passed to the FlexiRecord::Connection#transaction method, to rollback changes, in case an Error is raised.
+      def transaction(*arguments, &block)
+        self.class.transaction(self, *arguments, &block)
+      end
+
     public  # end of methods of BaseRecord
 
   end  # end of class BaseRecord
@@ -1174,7 +1185,7 @@ module FlexiRecord
     # Instead of UPDATEing or INSERTing a value, depending on the state of the object, it is always replaced in the database. When the special attribute 'void' is set, the record will be destroyed instead of saved.
     def save
       # TODO: improve efficiency, when a "REPLACE" command is available in PostgreSQL
-      self.class.transaction(self, :read_committed) do
+      transaction(:read_committed) do
         self.class.lock(:share_row_exclusive)
         @saved =
           self.class.select_by_value_set(self.class.primary_columns, [self.class.primary_columns.collect { |column| self.read(column) }]).length > 0
@@ -1482,21 +1493,19 @@ module FlexiRecord
   module ListRecord
 
     def save
-      self.class.transaction(self, :read_committed) do
+      transaction(:read_committed) do
         self.class.lock(:share_row_exclusive)
-         if self.position == :first
+        db_result = nil
+        if self.position == :first
           db_result = self.class.db_query1(
-            'SELECT COALESCE("position" - 1, 0) AS "result" ' <<
+            'SELECT "position" - 1 AS "result" ' <<
             'FROM ' << self.class.table << ' WHERE "position" NOTNULL ORDER BY "position" ASC)')
+          self.position = db_result ? db_result.result : 0
         elsif self.position == :last
           db_result = self.class.db_query1(
-            'SELECT COALESCE("position" + 1, 0) AS "result" ' <<
+            'SELECT "position" + 1 AS "result" ' <<
             'FROM ' << self.class.table << ' WHERE "position" NOTNULL ORDER BY "position" DESC')
-        end
-        if db_result
-          self.position = db_result.result
-        else
-          self.position = 0
+          self.position = db_result ? db_result.result : 0
         end
         return super
       end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: flexirecord
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2007-02-11 00:00:00 +00:00
+  version: 0.0.5
+date: 2007-02-13 00:00:00 +00:00
 summary: Object-Oriented Database Access Library
 require_paths: 
 - lib/