versions 0.1.0 → 0.2.0

data/test/unit/auto_test.rb

@@ -29,8 +29,25 @@ class AutoTest < Test::Unit::TestCase
         @version = BadVersion.create('title' => 'Socrate')
       end
 
-      should 'raise an exception on update' do
-        assert_raise(NoMethodError) { subject.update_attributes('title' => 'Aristotle') }
+      context 'if changed' do
+        should 'clone on update' do
+          assert_difference('Version.count', 1) do
+            subject.update_attributes('title' => 'Aristotle')
+          end
+
+
+          assert_difference('Version.count', 1) do
+            subject.update_attributes('title' => 'Augustin')
+          end
+        end
+      end
+      
+      context 'if not changed' do
+        should 'not clone on update' do
+          assert_difference('Version.count', 0) do
+            subject.update_attributes('title' => 'Socrate')
+          end
+        end
       end
     end
 
@@ -92,7 +109,7 @@ class AutoTest < Test::Unit::TestCase
           subject.update_attributes('title' => 'Aristotle')
           assert_equal 2, subject.number
 
-          subject.update_attributes('title' => 'Aristotle')
+          subject.update_attributes('title' => 'Kierkegaard')
           assert_equal 3, subject.number
         end
       end

data/test/unit/multi_test.rb

@@ -23,15 +23,12 @@ class MultiTest < Test::Unit::TestCase
     include Versions::Multi
 
     set_table_name :pages
-    has_multiple :foos, :class_name => 'MultiTest::SimpleVersion'
+    has_multiple :foos, :class_name => 'MultiTest::SimpleVersion', :inverse => 'node'
   end
 
   class Version < ActiveRecord::Base
     set_table_name :versions
     include Versions::Auto
-    def should_clone?
-      changed?
-    end
   end
   class Page < ActiveRecord::Base
     set_table_name :pages
@@ -82,16 +79,12 @@ class MultiTest < Test::Unit::TestCase
     end
 
     should 'rollback if foo save fails on create' do
+      page = nil
       assert_difference('MultiTest::SimpleVersion.count', 0) do
         assert_difference('MultiTest::SimplePage.count', 0) do
-          assert_raise(ActiveRecord::RecordInvalid) do
-            begin
-              page = SimplePage.create('foo_attributes' => {'title' => 'Fly'})
-            rescue ActiveRecord::RecordInvalid => err
-              assert_equal 'Validation failed: Foo title should not contain letter y', err.message
-              raise
-            end
-          end
+          page = SimplePage.new('foo_attributes' => {'title' => 'Fly'})
+          assert !page.save
+          assert_contains page.errors.full_messages, 'Foo title should not contain letter y'
         end
       end
     end
@@ -102,6 +95,18 @@ class MultiTest < Test::Unit::TestCase
       assert !page.update_attributes('foo_attributes' => {'title' => 'fly'})
       assert_equal 'should not contain letter y', page.errors['foo_title']
     end
+
+    should 'find owner back using inverse' do
+      page = SimplePage.create
+      assert_equal page, page.foo.node
+    end
+
+    should 'list foos' do
+      page = SimplePage.create('foo_attributes' => {'title' => 'One'})
+      page.foo = SimpleVersion.new('title' => 'Two')
+      page.save
+      assert_equal 2, page.foos.size
+    end
   end
 
   context 'A class with multiple auto versions' do
@@ -111,12 +116,12 @@ class MultiTest < Test::Unit::TestCase
         assert page.update_attributes('version_attributes' => {'title' => 'newTitle'})
       end
     end
-    
+
     should 'mark new version as not dirty after create' do
       page = Page.create
       assert !page.version.changed?
     end
-    
+
     should 'mark new version as not dirty after update' do
       page = Page.create
       assert page.update_attributes('version_attributes' => {'title' => 'Yodle'})
@@ -136,5 +141,44 @@ class MultiTest < Test::Unit::TestCase
         assert page.update_attributes('version_attributes' => {'title' => 'One'})
       end
     end
+
+
+    should 'list versions' do
+      page = Page.create('version_attributes' => {'title' => 'One'})
+      assert page.update_attributes('version_attributes' => {'title' => 'Two'})
+      assert page.update_attributes('version_attributes' => {'title' => 'Three'})
+      assert_equal 3, page.versions.size
+    end
+  end
+
+  context 'Defining association with custom foreign_key' do
+    should 'not raise an exception if the key exists' do
+      assert_nothing_raised do
+        class Book < ActiveRecord::Base
+          set_table_name :pages
+          include Versions::Multi
+          has_multiple :versions, :class_name => 'MultiTest::SimpleVersion', :inverse => 'big_book', :foreign_key => 'node_id'
+          has_multiple :versions, :class_name => 'MultiTest::SimpleVersion', :inverse => :big_book, :foreign_key => :node_id
+        end
+      end
+    end
+
+    should 'raise an exception if the key does not exist' do
+      assert_raise(TypeError) do
+        class Book < ActiveRecord::Base
+          set_table_name :pages
+          include Versions::Multi
+          has_multiple :versions, :class_name => 'MultiTest::SimpleVersion', :inverse => 'big_book', :foreign_key => 'bug_id'
+        end
+      end
+
+      assert_raise(TypeError) do
+        class Book < ActiveRecord::Base
+          set_table_name :pages
+          include Versions::Multi
+          has_multiple :versions, :class_name => 'MultiTest::SimpleVersion', :inverse => :big_book, :foreign_key => :bug_id
+        end
+      end
+    end
   end
 end

data/versions.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{versions}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gaspard Bucher"]
-  s.date = %q{2010-02-14}
+  s.date = %q{2010-02-15}
   s.description = %q{A list of libraries to work with ActiveRecord model versioning: Auto (duplicate on save), Multi (hide many versions behind a single one), Transparent (hide versions from outside world), Property (define properties on model, store them in versions)}
   s.email = %q{gaspard@teti.ch}
   s.extra_rdoc_files = [
@@ -24,16 +24,18 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "lib/versions.rb",
+     "lib/versions/after_commit.rb",
+     "lib/versions/attachment.rb",
      "lib/versions/auto.rb",
      "lib/versions/destroy.rb",
      "lib/versions/multi.rb",
      "lib/versions/shared_attachment.rb",
-     "lib/versions/shared_attachment/attachment.rb",
-     "lib/versions/shared_attachment/owner.rb",
-     "lib/versions/transparent.rb",
      "lib/versions/version.rb",
      "test/fixtures.rb",
+     "test/fixtures/files/bird.jpg",
+     "test/fixtures/files/lake.jpg",
      "test/helper.rb",
+     "test/unit/after_commit_test.rb",
      "test/unit/attachment_test.rb",
      "test/unit/auto_test.rb",
      "test/unit/multi_test.rb",
@@ -49,6 +51,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/fixtures.rb",
      "test/helper.rb",
+     "test/unit/after_commit_test.rb",
      "test/unit/attachment_test.rb",
      "test/unit/auto_test.rb",
      "test/unit/multi_test.rb",
@@ -63,15 +66,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<property>, [">= 0.8.1"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
       s.add_runtime_dependency(%q<activerecord>, [">= 0"])
     else
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<property>, [">= 0.8.1"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<activerecord>, [">= 0"])
     end
   else
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<property>, [">= 0.8.1"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<activerecord>, [">= 0"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: versions
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Gaspard Bucher
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-14 00:00:00 +01:00
+date: 2010-02-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.8.1
     version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
   type: :runtime
@@ -59,16 +69,18 @@ files:
 - README.rdoc
 - Rakefile
 - lib/versions.rb
+- lib/versions/after_commit.rb
+- lib/versions/attachment.rb
 - lib/versions/auto.rb
 - lib/versions/destroy.rb
 - lib/versions/multi.rb
 - lib/versions/shared_attachment.rb
-- lib/versions/shared_attachment/attachment.rb
-- lib/versions/shared_attachment/owner.rb
-- lib/versions/transparent.rb
 - lib/versions/version.rb
 - test/fixtures.rb
+- test/fixtures/files/bird.jpg
+- test/fixtures/files/lake.jpg
 - test/helper.rb
+- test/unit/after_commit_test.rb
 - test/unit/attachment_test.rb
 - test/unit/auto_test.rb
 - test/unit/multi_test.rb
@@ -106,6 +118,7 @@ summary: A list of libraries to work with ActiveRecord model versioning
 test_files: 
 - test/fixtures.rb
 - test/helper.rb
+- test/unit/after_commit_test.rb
 - test/unit/attachment_test.rb
 - test/unit/auto_test.rb
 - test/unit/multi_test.rb

data/lib/versions/shared_attachment/attachment.rb

@@ -1,66 +0,0 @@
-module Versions
-  # This module enables file attachments to versions. The file is shared between versions if
-  # it is not changed. The Attachment only stores a reference to the file which is saved in the
-  # filesystem.
-  module SharedAttachment
-    class Attachment < ::ActiveRecord::Base
-      set_table_name 'attachments'
-      after_destroy :destroy_file
-      after_save    :write_file
-
-      def unlink(model)
-        link_count = model.class.count(:conditions => ["attachment_id = ? AND id != ?", self.id, model.id])
-        if link_count == 0
-          destroy
-        end
-      end
-
-      def file=(file)
-        @file = file
-        self[:filename] = get_filename(file)
-      end
-
-      def filepath
-        @filepath ||= begin
-          digest = Digest::SHA1.hexdigest(self[:id].to_s)
-          "#{digest[0..0]}/#{digest[1..1]}/#{filename}"
-        end
-      end
-
-      private
-      def write_file
-        after_commit do
-          make_file(filepath, @file)
-        end
-      end
-
-      def destroy_file
-        after_commit do
-          remove_file
-        end
-      end
-
-      def make_file(path, data)
-        FileUtils::mkpath(File.dirname(path)) unless File.exist?(File.dirname(path))
-        if data.respond_to?(:rewind)
-          data.rewind
-        end
-        File.open(path, "wb") { |f| f.syswrite(data.read) }
-      end
-
-      def remove_file
-        FileUtils.rm(filepath)
-      end
-
-      def get_filename(file)
-        # make sure name is not corrupted
-        fname = file.original_filename.gsub(/[^a-zA-Z\-_0-9\.]/,'')
-        if fname[0..0] == '.'
-          # Forbid names starting with a dot
-          fname = Digest::SHA1.hexdigest(Time.now.to_i.to_s)[0..6]
-        end
-        fname
-      end
-    end # Attachment
-  end # SharedAttachment
-end # Versions

data/lib/versions/shared_attachment/owner.rb

@@ -1,77 +0,0 @@
-
-module Zena
-  module Use
-
-    # The attachement module provides shared file attachments to a class with a copy-on-write
-    # pattern.
-    # Basically the module provides 'file=' and 'file' methods.
-    module SharedAttachment
-      module ClassMethods
-        def set_attachment_class(class_name)
-          belongs_to :attachment,
-                     :class_name => class_name,
-                     :foreign_key => 'attachment_id'
-        end
-      end
-
-      def self.included(base)
-        base.class_eval do
-          before_create  :save_attachment
-          before_update  :attachment_before_update
-          before_destroy :attachment_before_destroy
-
-          extend Zena::Use::SharedAttachment::ClassMethods
-          set_attachment_class 'Zena::Use::SharedAttachment::Attachment'
-        end
-      end
-
-      def file=(file)
-        if attachment
-          @attachment_to_unlink = self.attachment
-          self.attachment = nil
-        end
-        @attachment_need_save = true
-        self.build_attachment(:file => file)
-      end
-
-      def filepath
-        attachment ? attachment.filepath : nil
-      end
-
-      private
-        def save_attachment
-          if @attachment_need_save
-            @attachment_need_save = nil
-            attachment.save
-          else
-            true
-          end
-        end
-
-        def attachment_before_update
-          if @attachment_to_unlink
-            @attachment_to_unlink.unlink(self)
-            @attachment_to_unlink = nil
-          end
-          save_attachment
-        end
-
-        def attachment_before_destroy
-          if attachment = self.attachment
-            attachment.unlink(self)
-          else
-            true
-          end
-        end
-
-        def unlink_attachment_mark
-          @attachment_to_unlink = self.attachment
-        end
-
-        def unlink_attachment
-        end
-
-
-    end # SharedAttachment
-  end # Use
-end # Zena

data/lib/versions/transparent.rb

@@ -1,98 +0,0 @@
-module Zena
-  module Use
-    # This module lets the user use a node as if it was not versioned and will
-    # take care of routing the attributes between the node and the version.
-    module TransparentVersion
-
-      def self.included(base)
-        base.class_eval do
-          # When writing attributes, we send everything that we do not know of
-          # to the version.
-          def attributes_with_multi_version=(attributes)
-            columns = self.class.column_names
-            version_attributes = {}
-            attributes.keys.each do |k|
-              if !respond_to?("#{k}=") && !columns.include?(k)
-                version_attributes[k] = attributes.delete(k)
-              end
-            end
-            version.attributes = version_attributes
-            self.attributes_without_multi_version = attributes
-          end
-
-          alias_method_chain :attributes=, :multi_version
-        end
-      end
-
-      private
-        # We need method_missing in forms, normal access in templates should be made
-        # through 'node.version.xxxx', not 'node.xxxx'.
-        def method_missing(meth, *args)
-          method = meth.to_s
-          if !args.empty? || method[-1..-1] == '?' || self.class.column_names.include?(method)
-            super
-          elsif version.respond_to?(meth)
-            version.send(meth)
-          else
-            #version.prop[meth.to_s]
-            super
-          end
-        end
-
-        # Any attribute starting with 'v_' belongs to the 'version' or 'redaction'
-        # Any attribute starting with 'c_' belongs to the 'version' or 'redaction' content
-        # FIXME: performance: create methods on the fly so that next calls will not pass through 'method_missing'. #189.
-        # FIXME: this should not be used anymore. Remove.
-        # def method_missing(meth, *args)
-        #   if meth.to_s =~ /^(v_|c_|d_)(([\w_\?]+)(=?))$/
-        #     target = $1
-        #     method = $2
-        #     value  = $3
-        #     mode   = $4
-        #     if mode == '='
-        #       begin
-        #         # set
-        #         unless recipient = redaction
-        #           # remove trailing '='
-        #           redaction_error(meth.to_s[0..-2], "could not be set (no redaction)")
-        #           return
-        #         end
-        #
-        #         case target
-        #         when 'c_'
-        #           if recipient.content_class && recipient = recipient.redaction_content
-        #             recipient.send(method,*args)
-        #           else
-        #             redaction_error(meth.to_s[0..-2], "cannot be set") # remove trailing '='
-        #           end
-        #         when 'd_'
-        #           recipient.prop[method[0..-2]] = args[0]
-        #         else
-        #           recipient.send(method,*args)
-        #         end
-        #       rescue NoMethodError
-        #         # bad attribute, just ignore
-        #       end
-        #     else
-        #       # read
-        #       recipient = version
-        #       if target == 'd_'
-        #         version.prop[method]
-        #       else
-        #         recipient = recipient.content if target == 'c_'
-        #         return nil unless recipient
-        #         begin
-        #           recipient.send(method,*args)
-        #         rescue NoMethodError
-        #           # bad attribute
-        #           return nil
-        #         end
-        #       end
-        #     end
-        #   else
-        #     super
-        #   end
-        # end
-    end
-  end
-end