sequel-revisions 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b638d9cddc49884c2e02153531cb651e74e8f465
-  data.tar.gz: 7f44a3fa58deb5145a6aef9bbd59e55ec02017ec
+  metadata.gz: 78b1a7fff0b37569c9483503d58542a6859878a0
+  data.tar.gz: abcc54a0f00e59827389312a65ffb359f3e2a64b
 SHA512:
-  metadata.gz: 531a84641e345fc5270b0b2f81af0ca4b99a57882bd97dffb662773d49713aa1f1d423cc15b857405cf4dede7783f9ce1908501c51a0c43760e9edd3f1ea8af0
-  data.tar.gz: 11bedd40539e7b727b4afc91980cfa0ed14b78cfe2917d3471e4eefcdd07e139715ec9ba80e1dd52602b0f4309eaf0c66c7b142dd24f06bf3a3f602692eb44a5
+  metadata.gz: 2bfd8bf7a0b2cdda5a17352d05703f821629ce039aabe3c573c648e13be490551f3dfb725315c9c36f27c2bd9edc255ff985f22f2855a4a627b150ed48f062c3
+  data.tar.gz: e7f8355ceb4db7b8450315a628a048f28866e5b1f71d8db3ef7772762643895fdef17bfabddf2d8f294b55016ced5131c9b38fb5a80c7fe4214c8c2b139f7677

data/lib/sequel/plugins/revisions.rb

@@ -1,93 +1,202 @@
 require 'sequel'
 require 'json'
 
-module Sequel::Plugins
-  module Revisions
-    def self.apply(model, options = {})
-      options = {
-        model_name: "#{model.name}Revisions",
-        table_name: "#{model.table_name.to_s.singularize}_revisions",
-        exclude: [:created_at, :updated_at],
-        meta: nil
-      }.merge(options)
-
-      base_name = options[:model_name]
-
-      mods = options[:model_name].split("::")
-      if mods.length > 1
-        mobject = Object.const_get mods[0..mods.length-2].join("::")
-        base_name = mods.last
-      else
-        mobject = Object
+module Sequel
+  module Plugins
+    module Revisions
+      def self.apply(model, options = {})
+        options = set_options(model, options)
+        model.class_eval do
+          @revisions_polymorphic = options[:polymorphic]
+          @revisions_embedded_in = options[:embedded_in]
+          @revisions_on          = options[:on]
+          @revisions_meta        = options[:meta]
+          @revisions_exclude     = options[:exclude]
+        end
       end
 
-      # Dynamically create Model class
-      klass = Class.new(Sequel::Model(options[:table_name].to_sym))
-      klass.class_eval do
-        @@lmeta = options[:meta]
-        plugin :timestamps
-        plugin :serialization
+      def self.configure(model, options = {})
+        options = set_options(model, options)
 
-        serialize_attributes :json, :meta
-        serialize_attributes :json, :changes
-        many_to_one model.table_name.to_sym, class: model.name
+        base_name = options[:model_name]
 
-        def before_create
-          # ToDo: This should not call to_json. Maybe a bug?
-          self[:meta] = @@lmeta.call().to_json unless @@lmeta.nil?
-          super
+        mods = options[:model_name].split("::")
+        if mods.length > 1
+          mobject = Object.const_get mods[0..mods.length-2].join("::")
+          base_name = mods.last
+        else
+          mobject = Object
+        end
+
+        # Don't redefine
+        unless mobject.const_defined?(base_name)
+          klass = setup_revisions_model(model, options)
+          # Actually define the class in the module
+          mobject.const_set base_name, klass
         end
+
+        # Configure associations / methods on models
+        setup_model(model, options)
       end
 
-      # Actually define the class in the module
-      mobject.const_set base_name, klass
+      module ClassMethods
+        Plugins.inherited_instance_variables(self,
+          :@revisions_polymorphic => :dup,
+          :@revisions_embedded_in => :dup,
+          :@revisions_on => :dup,
+          :@revisions_exclude => :dup,
+          :@revisions_meta => nil)
 
-      model.class_eval do
-        plugin :dirty
-        one_to_many :revisions, class: options[:model_name]
+        def revisions_polymorphic?
+          @revisions_polymorphic
+        end
 
-        def revert
-          return if revisions.empty?
+        def revisions_embedded_in
+          @revisions_embedded_in
+        end
 
-          last = revisions.last
-          changes = last.changes
-          changes.keys.each do |key|
-            send("#{key}=", changes[key][0])
+        def revisions_on? action
+          # We track everything by default
+          unless @revisions_on
+            true
+          else
+            @revisions_on.include? action
           end
         end
 
-        def revert!
-          revert
-          save
+        def revisions_meta
+          @revisions_meta
+        end
+
+        def revisions_exclude
+          @revisions_exclude
         end
       end
-    end
 
-    def self.configure(model, options = {})
-    end
+      module InstanceMethods
 
-    module ClassMethods
-    end
+        def before_update
+          super
+          track_changes(:update) if model.revisions_on? :update
+        end
+
+        def before_destroy
+          super
+          track_changes(:destroy) if model.revisions_on? :destroy
+        end
+
+        def after_create
+          super
+          track_changes(:create) if model.revisions_on? :create
+        end
+
+      private
+
+        def track_changes(action)
+          case action
+          when :update
+            return if changed_columns.empty?
+            # Map the changed fields into an object
+            changes = changed_columns.inject({}) do |obj, key|
+              obj[key] = column_change(key)
+              obj
+            end
+          when :create
+            changes = (columns - model.revisions_exclude).inject({}) do |obj, key|
+              obj[key] = [nil, send(key)]
+              obj
+            end
+          when :destroy
+            changes = (columns - model.revisions_exclude).inject({}) do |obj, key|
+              obj[key] = [send(key), nil]
+              obj
+            end
+          end
 
-    module InstanceMethods
+          #
+          meta = model.revisions_meta.call() unless model.revisions_meta.nil?
 
-      def before_update
-        track_changes
-        super
+          if model.revisions_embedded_in.nil?
+            add_revision(changes: changes, action: action, meta: meta)
+          else
+            trackable = self.send(model.revisions_embedded_in)
+            add_revision(changes: changes, action: action, meta: meta, trackable: trackable)
+          end
+        end
       end
 
     private
 
-      def track_changes
-        return if changed_columns.empty?
+      def self.set_options(model, options)
+        model_name = options[:polymorphic] ? "Revision" : "#{model.name}Revision"
+        table_name = options[:polymorphic] ? "revisions" : "#{model.table_name.to_s.singularize}_revisions"
+
+        options = {
+          model_name: model_name,
+          table_name: table_name,
+          exclude: [:id, :created_at, :updated_at],
+          meta: nil
+        }.merge(options)
+      end
+
+      def self.setup_revisions_model(model, options)
+        # Dynamically create Model class
+        klass = Class.new(Sequel::Model(options[:table_name].to_sym))
+        klass.class_eval do
+          plugin :timestamps
+          plugin :serialization
+
+          serialize_attributes :json, :meta
+          serialize_attributes :json, :changes
+        end
+
+        if options[:polymorphic]
+          klass.class_eval do
+            many_to_one :trackable, polymorphic: true
+            many_to_one :embeddable, polymorphic: true
+          end
+        else
+          klass.class_eval do
+            many_to_one model.table_name.to_sym, class: model.name
+          end
+        end
+
+        klass
+      end
+
+      def self.setup_model(model, options)
+        model.class_eval do
+          plugin :dirty
+
+          def revert
+            return if revisions.empty?
+
+            last = revisions.last
+            changes = last.changes
+            changes.keys.each do |key|
+              send("#{key}=", changes[key][0])
+            end
+          end
 
-        # Map the changed fields into an object
-        changes = changed_columns.inject({}) do |obj, key|
-          obj[key] = column_change(key)
-          obj
+          def revert!
+            revert
+            save
+          end
         end
 
-        add_revision(changes: changes)
+        if options[:polymorphic]
+          model.class_eval do
+            one_to_many :revisions, as: :trackable
+          end
+        elsif options[:embedded_in]
+          model.class_eval do
+            one_to_many :revisions, as: :embeddable
+          end
+        else
+          model.class_eval do
+            one_to_many :revisions, class: options[:model_name]
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-revisions
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Fabian Becker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -38,34 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel_polymorphic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: Use this plugin to track field changes and revert your model to an older
   state.
 email: halfdan@xnorfz.de