dm-is-versioned 0.9.7

data/History.txt

@@ -0,0 +1 @@
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Timothy Bennett
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/dm-is-versioned.rb
+lib/dm-is-versioned/is/version.rb
+lib/dm-is-versioned/is/versioned.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/versioned_spec.rb

data/README.txt

@@ -0,0 +1,3 @@
+= dm-is-versioned
+
+DataMapper plugin enabling simple versioning of models.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'spec'
+require 'spec/rake/spectask'
+require 'pathname'
+
+ROOT = Pathname(__FILE__).dirname.expand_path
+require ROOT + 'lib/dm-is-versioned/is/version'
+
+AUTHOR = "Bernerd Schaefer"
+EMAIL  = "bj.schaefer@gmail.com"
+GEM_NAME = "dm-is-versioned"
+GEM_VERSION = DataMapper::Is::Versioned::VERSION
+GEM_DEPENDENCIES = [["dm-core", GEM_VERSION]]
+GEM_CLEAN = ["log", "pkg"]
+GEM_EXTRAS = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO ] }
+
+PROJECT_NAME = "datamapper"
+PROJECT_URL  = "http://github.com/sam/dm-more/tree/master/dm-is-versioned"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = "DataMapper plugin enabling simple versioning of models"
+
+require ROOT.parent + 'tasks/hoe'
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+desc "Install #{GEM_NAME} #{GEM_VERSION} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{GEM_NAME} -v#{GEM_VERSION} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{GEM_NAME} #{GEM_VERSION} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}, :verbose => false
+  end
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/lib/dm-is-versioned/is/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Is
+    module Versioned
+      VERSION = "0.9.7"
+    end
+  end
+end

data/lib/dm-is-versioned/is/versioned.rb

@@ -0,0 +1,127 @@
+module DataMapper
+  module Is
+    ##
+    # = Is Versioned
+    # The Versioned module will configure a model to be versioned.
+    #
+    # The is-versioned plugin functions differently from other versioning
+    # solutions (such as acts_as_versioned), but can be configured to
+    # function like it if you so desire.
+    #
+    # The biggest difference is that there is not an incrementing 'version'
+    # field, but rather, any field of your choosing which will be unique
+    # on update.
+    #
+    # == Setup
+    # For simplicity, I will assume that you have loaded dm-timestamps to
+    # automatically update your :updated_at field. See versioned_spec for
+    # and example of updating the versioned field yourself.
+    #
+    #   class Story
+    #     include DataMapper::Resource
+    #     property :id, Serial
+    #     property :title, String
+    #     property :updated_at, DateTime
+    #
+    #     is_versioned :on => [:updated_at]
+    #   end
+    #
+    # == Auto Upgrading and Auto Migrating
+    #
+    #   Story.auto_migrate! # => will run auto_migrate! on Story::Version, too
+    #   Story.auto_upgrade! # => will run auto_upgrade! on Story::Version, too
+    #
+    # == Usage
+    #
+    #   story = Story.get(1)
+    #   story.title = "New Title"
+    #   story.save # => Saves this story and creates a new version with the
+    #              #    original values.
+    #   story.versions.size # => 1
+    #
+    #   story.title = "A Different New Title"
+    #   story.save
+    #   story.versions.size # => 2
+    #
+    # TODO: enable replacing a current version with an old version.
+    module Versioned
+
+      def is_versioned(options = {})
+        on = options[:on]
+
+        class << self; self end.class_eval do
+          define_method :const_missing do |name|
+            storage_name = Extlib::Inflection.tableize(self.name + "Version")
+            model = DataMapper::Model.new(storage_name)
+
+            if name == :Version
+              properties.each do |property|
+                options = property.options
+                options[:key] = true if property.name == on || options[:serial] == true
+                options[:serial] = false
+                model.property property.name, property.type, options
+              end
+
+              self.const_set("Version", model)
+            else
+              super(name)
+            end
+          end
+        end
+
+        self.after_class_method :auto_migrate! do
+          self::Version.auto_migrate!
+        end
+
+        self.after_class_method :auto_upgrade! do
+          self::Version.auto_upgrade!
+        end
+
+        self.before :attribute_set do |property, value|
+          pending_version_attributes[property] ||= self.attribute_get(property)
+        end
+
+        self.after :update do |result|
+          if result && dirty_attributes.has_key?(properties[on])
+            self.class::Version.create(self.attributes.merge(pending_version_attributes))
+            self.pending_version_attributes.clear
+          end
+
+          result
+        end
+
+        include DataMapper::Is::Versioned::InstanceMethods
+      end
+
+
+      module InstanceMethods
+        ##
+        # Returns a hash of original values to be stored in the
+        # versions table when a new version is created. It is
+        # cleared after a version model is created.
+        #
+        # --
+        # @return <Hash>
+        def pending_version_attributes
+          @pending_version_attributes ||= {}
+        end
+
+        ##
+        # Returns a collection of other versions of this resource.
+        # The versions are related on the models keys, and ordered
+        # by the version field.
+        #
+        # --
+        # @return <Collection>
+        def versions
+          query = {}
+          version = self.class.const_get("Version")
+          self.class.key.zip(self.key) { |property, value| query[property.name] = value }
+          query.merge(:order => version.key.collect { |key| key.name.desc })
+          version.all(query)
+        end
+      end
+
+    end # Versioned
+  end # Is
+end # DataMapper

data/lib/dm-is-versioned.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'pathname'
+
+gem 'dm-core', '~>0.9.7'
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-versioned' / 'is' / 'versioned.rb'
+
+# Include the plugin in Resource
+module DataMapper
+  module Resource
+    module ClassMethods
+      include DataMapper::Is::Versioned
+    end # module ClassMethods
+  end # module Resource
+end # module DataMapper

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-versioned'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '~>0.9.7'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

data/spec/versioned_spec.rb

@@ -0,0 +1,155 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+class Story
+  include DataMapper::Resource
+
+  property :id, Integer, :serial => true
+  property :title, String
+  property :updated_at, DateTime
+
+  before :save do
+    # For the sake of testing, make sure the updated_at is always unique
+    time = self.updated_at ? self.updated_at + 1 : Time.now
+    self.updated_at = time if self.dirty?
+  end
+
+  is_versioned :on => :updated_at
+
+end
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::Is::Versioned' do
+    describe "inner class" do
+      it "should be present" do
+        Story::Version.should be_a_kind_of(Class)
+      end
+
+      it "should have a default storage name" do
+        Story::Version.storage_name.should == "story_versions"
+      end
+
+      it "should have its parent's properties" do
+        Story.properties.each do |property|
+          Story::Version.properties.should have_property(property.name)
+        end
+      end
+    end # inner class
+
+    describe "#auto_migrate!" do
+      before do
+        Story::Version.should_receive(:auto_migrate!)
+      end
+      it "should get called on the inner class" do
+        Story.auto_migrate!
+      end
+    end # #auto_migrate!
+
+    describe "#auto_upgrade!" do
+      before do
+        Story::Version.should_receive(:auto_upgrade!)
+      end
+      it "should get called on the inner class" do
+        Story.auto_upgrade!
+      end
+    end # #auto_upgrade!
+
+    describe "#create" do
+      before do
+        Story.auto_migrate!
+        Story.create(:title => "A Very Interesting Article")
+      end
+      it "should not create a versioned copy" do
+        Story::Version.all.size.should == 0
+      end
+    end # #create
+
+    describe "#save" do
+      before do
+        Story.auto_migrate!
+      end
+
+      describe "(with new resource)" do
+        before do
+          @story = Story.new(:title => "A Story")
+          @story.save
+        end
+        it "should not create a versioned copy" do
+          Story::Version.all.size.should == 0
+        end
+      end
+
+      describe "(with a clean existing resource)" do
+        before do
+          @story = Story.create(:title => "A Story")
+          @story.save
+        end
+
+        it "should not create a versioned copy" do
+          Story::Version.all.size.should == 0
+        end
+      end
+
+      describe "(with a dirty existing resource)" do
+        before do
+          @story = Story.create(:title => "A Story")
+          @story.title = "An Inner Update"
+          @story.title = "An Updated Story"
+          @story.save
+        end
+
+        it "should create a versioned copy" do
+          Story::Version.all.size.should == 1
+        end
+
+        it "should not have the same value for the versioned field" do
+          @story.updated_at.should_not == Story::Version.first.updated_at
+        end
+
+        it "should save the original value, not the inner update" do
+          # changes to the story between saves shouldn't be updated.
+          @story.versions.last.title.should == "A Story"
+        end
+      end
+
+    end # #save
+
+    describe "#pending_version_attributes" do
+      before do
+        @story = Story.create(:title => "A Story")
+      end
+
+      it "should be updated when a property changes" do
+        @story.title = "A New Title"
+        @story.pending_version_attributes[:title].should == "A Story"
+      end
+
+      it "should be cleared when a resource is saved" do
+        @story.title = "A New Title"
+        @story.save
+        @story.pending_version_attributes.should be_empty
+      end
+    end # #pending_version_attributes
+
+    describe "#versions" do
+      before do
+        Story.auto_migrate!
+        @story = Story.create(:title => "A Story")
+      end
+
+      it "should return an empty array when there are no versions" do
+        @story.versions.should == []
+      end
+
+      it "should return a collection when there are versions" do
+        @story.versions.should == Story::Version.all(:id => @story.id)
+      end
+
+      it "should not return another object's versions" do
+        @story2 = Story.create(:title => "A Different Story")
+        @story2.title = "A Different Title"
+        @story2.save
+        @story.versions.should == Story::Version.all(:id => @story.id)
+      end
+    end # #versions
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-versioned
+version: !ruby/object:Gem::Version 
+  version: 0.9.7
+platform: ruby
+authors: 
+- Bernerd Schaefer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: DataMapper plugin enabling simple versioning of models
+email: 
+- bj.schaefer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- LICENSE
+- TODO
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- lib/dm-is-versioned.rb
+- lib/dm-is-versioned/is/version.rb
+- lib/dm-is-versioned/is/versioned.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/versioned_spec.rb
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-is-versioned
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: datamapper
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin enabling simple versioning of models
+test_files: []
+