jdunphy-sequel_revisioned 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-02
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.rdoc
+lib/sequel_revisioned.rb
+lib/sequel_revisioned/sequel_revisioned.rb

data/README.rdoc

@@ -0,0 +1,62 @@
+= sequel_revisioned
+
+== DESCRIPTION:
+
+Sequel plugin designed to maintain a revision history of an object.
+
+Sequel_revisioned will create a revision table and model specific to the class that calls
+`is :revisioned`.  It's set up this way to allow multiple tables to maintain revisions
+without interfering with each other.
+
+== USAGE
+
+    class Post < Sequel::Model
+      is :revisioned, :watch => [:title, :body, :synopsis]
+      
+    end
+
+    $ p = Post[n]
+    $ p.revisions
+    => Array of post's revisions
+    $ p.roll_back(x)
+    => Rolls watched fields back to the sate of revision x
+    
+    $ revision = p.revisions.first
+    $ revision.class.name
+    => PostRevision
+    $ revision.table_name
+    => post_revisions
+    
+    
+== REQUIREMENTS:
+
+  Sequel >= 2.9.0 
+  
+== INSTALL:
+
+  sudo gem install jdunphy-sequel_revisioned --source http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jacob Dunphy
+
+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/lib/sequel_revisioned.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module SequelRevisioned
+  VERSION = '0.0.1'
+end
+
+module Sequel
+  class InvalidRevisionError < StandardError; end
+end
+
+require 'sequel_revisioned/sequel_revisioned'

data/lib/sequel_revisioned/sequel_revisioned.rb

@@ -0,0 +1,116 @@
+module Sequel
+  module Plugins
+    module Revisioned      
+      
+      def self.apply(model, options = {})
+        revision_model_name = "::#{model.name}Revision"
+        eval "
+class #{revision_model_name} < Sequel::Model
+  before_create :set_created_at
+  before_create :set_version
+  many_to_one :#{model.name.underscore}
+  
+  def next_revision
+    if version && post_id
+      self.class.find(:post_id => post_id, :version => version + 1)
+    end
+  end
+  
+  def previous_revision
+    if version && post_id && version > 1
+      self.class.find(:post_id => post_id, :version => version - 1)
+    end
+  end
+  
+  private 
+  
+    def set_version
+      if last_revision = #{model.name.underscore}.revisions.first
+        self.version = last_revision.version + 1
+      else
+        self.version = 1
+      end
+    end
+    
+    def set_created_at
+      self.created_at ||= Time.now
+    end
+end
+"
+        revision_model = revision_model_name.constantize
+        unless revision_model.table_exists?
+          migration = "
+          class CreateRevisions < Sequel::Migration
+            def up
+              create_table :#{revision_model.table_name} do
+                primary_key  :id
+                integer      :#{model.name.underscore}_id
+                integer      :version
+                timestamp    :created_at
+                #{additional_migration_columns(model, options)}
+              end
+            end
+          end
+          CreateRevisions.apply(DB, :up)
+          #{revision_model_name}.columns"  
+          # TODO - This last line feels really hacky.  
+          #  The #generate_revision code below doesn't work without it.
+          #  It seems like I have to load the schema into the model
+          eval migration
+        end
+        
+        model.class_eval "
+          one_to_many :revisions, :class => '#{revision_model}', :order => :version.desc
+          after_save :generate_revision
+          @@watched_columns = [#{Array(options[:watch]).map {|w| ":#{w.to_s}"}.join(",")}]
+          
+          def self.revision_class; #{revision_model}; end
+        "
+      end
+      
+      def self.additional_migration_columns(model, options = {})
+        if options[:watch]
+          Array(options[:watch]).map do |column|
+            "#{model.db_schema[column.to_sym][:type]} :#{column}"
+          end.join("\n")
+        end
+      end
+
+      module InstanceMethods
+        
+        def roll_back(version)
+          revision = revisions.detect {|rev| rev.version == version.to_i }
+          raise Sequel::InvalidRevisionError unless revision
+          self.class.watched_columns.each do |col|
+            send("#{col}=", revision.send(col))
+          end
+        end
+        
+        def watched_data
+          data = {}
+          self.class.watched_columns.each do |col|
+            data[col] = send(col)
+          end
+          data
+        end
+        private :watched_data
+        
+        def generate_revision
+          revision = self.class.revision_class.new(watched_data)
+          add_revision(revision)
+          revision.save
+        end
+        private :generate_revision
+      end
+      
+      module ClassMethods
+        
+        def watched_columns
+          class_variable_get(:@@watched_columns)
+        end
+      end
+
+    end
+  end
+end
+  

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: jdunphy-sequel_revisioned
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jacob Dunphy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.9.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Sequel plugin designed to maintain a revision history of an object.  Sequel_revisioned will create a revision table and model specific to the class that calls `is :revisioned`.  It's set up this way to allow multiple tables to maintain revisions without interfering with each other.
+email: 
+- jacob.dunphy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- lib/sequel_revisioned.rb
+- lib/sequel_revisioned/sequel_revisioned.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: sequel_revisioned
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Sequel plugin designed to maintain a revision history of an object
+test_files: []
+