hist 0.2.0

data/app/models/hist/config.rb

@@ -0,0 +1,10 @@
+require "singleton"
+
+module Hist
+  class Config
+    include Singleton
+
+    attr_accessor :default_diff_exclude
+  end
+
+end

data/app/models/hist/hist_config.rb

@@ -0,0 +1,124 @@
+module Hist
+  class HistConfig
+
+    def initialize(associations:nil, model:, max_versions:, max_pendings:, include: [], exclude: [], auto_version:)
+      @associations = associations
+      @model = model
+      @max_versions = max_versions
+      @max_pendings = max_pendings
+      @include = include
+      @exclude = exclude
+      @auto_version = auto_version
+    end
+
+    def auto_version
+      @auto_version
+    end
+
+    def max_versions
+      @max_versions
+    end
+
+    def max_pendings
+      @max_pendings
+    end
+
+    def include
+      @include
+    end
+
+    def exclude
+      @exclude
+    end
+
+    def model
+      @model
+    end
+
+    # Support STI
+    def associations(obj: nil, klass: nil, exclude_through:false)
+      return [] if @associations.nil?
+
+      klass = obj.class if obj.present?
+      klass = self.model.constantize if klass.nil?
+
+      if @associations.present?
+        if @associations.has_key? :all
+          return all_associations(klass: klass, exclude_through: exclude_through)
+        elsif @associations.has_key? :has_many
+          return all_associations(klass: klass, type: :has_many, exclude_through: exclude_through)
+        elsif @associations.has_key? :belongs_to
+          return all_associations(klass: klass,type: :belongs_to, exclude_through: exclude_through)
+        end
+      end
+
+      return_assocs = []
+      @associations.each do |k, _|
+        return_assocs << (klass.reflect_on_all_associations.select { |a| a.name == k})[0] if valid_association(klass: klass, assoc: k, exclude_through: exclude_through)
+      end
+
+      return_assocs
+    end
+
+    def valid_association(klass:, assoc:, exclude_through:false)
+      all_assocs = klass.reflect_on_all_associations
+      association_details = all_assocs.select { |a| a.name == assoc }[0]
+
+      if association_details.present?
+        if exclude_through and association_details.class == ActiveRecord::Reflection::HasManyReflection
+          through_associations = all_assocs.select { |assoc| assoc.class == ActiveRecord::Reflection::ThroughReflection}
+          if through_associations.present?
+            assoc_check = through_associations.select { |assoc| assoc.options[:through] == assoc }
+            return false if assoc_check.present?
+          end
+        end
+        return true
+      end
+      return false
+    end
+
+    def all_associations(klass:, type: nil, exclude_through:false)
+      if type.nil?
+        associations = klass.reflect_on_all_associations
+      else
+        associations = klass.reflect_on_all_associations(type)
+      end
+
+      if exclude_through
+        through_associations = associations.select { |assoc| assoc.class == ActiveRecord::Reflection::ThroughReflection}
+
+        through_associations.each do |t_assoc|
+          assoc_to_delete = associations.select { |assoc| assoc.name == t_assoc.options[:through]}
+          associations.delete(assoc_to_delete[0]) if assoc_to_delete.present?
+        end
+      end
+
+      associations
+    end
+
+    def update_associations_on_save(klass:, assoc:)
+      if @associations.blank?
+        return false
+      end
+
+      if @associations.has_key? :all
+        return true if @associations[:all][:update_associations_on_save].nil? || @associations[:all][:update_associations_on_save]
+      elsif @associations.has_key? :has_many
+        return true if @associations[:has_many][:update_associations_on_save].nil? || @associations[:has_many][:update_associations_on_save]
+      elsif @associations.has_key? :belongs_to
+        return true if @associations[:belongs_to][:update_associations_on_save].nil? || @associations[:belongs_to][:update_associations_on_save]
+      end
+
+      item = @associations[assoc]
+      return true if !item.nil? and (item[:update_associations_on_save].nil? || item[:update_associations_on_save])
+
+      return false
+    end
+
+    def options
+      @options
+    end
+
+  end
+
+end

data/app/models/hist/model.rb

@@ -0,0 +1,214 @@
+module Hist
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      #attribute :ver_id, :integer
+      #attribute :pending_id, :integer
+      #attribute :hist_whodunnit, :string
+      #attribute :hist_extra, :string
+    end
+
+    class_methods do
+      def has_hist(associations: nil, max_versions:-1, max_pendings: -1, include: [], exclude: [], auto_version: true)
+        @hist_config = ::Hist::HistConfig.new(associations: associations, model: Hist.model(klass: self), max_versions: max_versions, max_pendings: max_pendings, include: include, exclude: exclude, auto_version: auto_version)
+      end
+
+      def hist_config
+        @hist_config
+      end
+
+      def hist_new_pendings(user: nil, extra: nil, only: 'kept')
+        ::Hist::Pending.get(obj: nil, user: user, extra: extra, only: only)
+      end
+    end
+
+    def hist_save_actions
+      Hist::Pending.find(self.pending_id).discard unless self.pending_id.nil?
+
+      # Need to fix associations... won't update properly on parent save cause rails is baka.
+      if self.pending_id.present? || self.ver_id.present?
+        current = ApplicationRecord.fix_save_associations(obj: self)
+      else
+        current = self
+      end
+
+      # Does this happen  after reload?
+      u = self.hist_whodunnit if self.record_hist_whodunnit?
+      e = self.hist_extra if self.record_hist_extra?
+      current.record_version(user: u, extra: e) if self.class.base_class.hist_config.auto_version
+
+      if self.pending_id.present? || self.ver_id.present?
+        self.reload
+      else
+        self.reload_hist
+      end
+    end
+
+    def hist_around_save
+      self.class.transaction do
+        yield
+        self.hist_save_actions
+      end
+    end
+
+    def hist_after_save
+      self.class.transaction do
+        hist_save_actions
+      end
+    end
+
+    # @api public
+    def record_version(user: nil, extra: nil)
+      ::Hist::Version.put(obj: self, user: user, extra: extra)
+    end
+
+    def record_pending(user: nil, extra: nil)
+      ::Hist::Pending.put(obj: self, user: user, extra: extra)
+    end
+
+    def version_at_temp(date)
+      @versions ||= ::Hist::Version.raw_get(obj: self)
+      @versions.each do |ver|
+        #raise "Date.parse: " + Date.parse(ver.created_at.to_s).to_s + " and date: " + date.to_s + " And equals: " + (Date.parse(ver.created_at.to_s) <= date).to_s + " and ver_id: " + ver.id.to_s
+        if Date.parse(ver.created_at.to_s) <= date
+          #raise ver.reify.ver_id.to_s
+          return ver.reify
+        end
+      end
+      return @versions.last.reify if @version.present?
+      return self
+    end
+
+    def version_at(date)
+      @versions ||= ::Hist::Version.get(obj: self)
+      @versions.each do |ver|
+        #raise "Date.parse: " + Date.parse(ver.created_at.to_s).to_s + " and date: " + date.to_s + " And equals: " + (Date.parse(ver.created_at.to_s) <= date).to_s + " and ver_id: " + ver.id.to_s
+        if Date.parse(ver.hist_created_at.to_s) <= date
+          #raise ver.reify.ver_id.to_s
+          return ver
+        end
+      end
+      return @versions.last if @version.present?
+      return self
+    end
+
+    def raw_versions(user: nil, extra: nil, only: 'kept')
+      @raw_versions ||= ::Hist::Version.raw_get(obj: self, user: nil, extra: nil, only: only)
+      @raw_versions
+    end
+
+    def versions(user: nil, extra: nil, only: 'kept')
+      @versions ||= ::Hist::Version.get(obj: self, user: nil, extra: nil, only: only)
+      @versions
+    end
+
+    def raw_pendings(user: nil, extra: nil, only: 'kept')
+      @raw_pendings ||= ::Hist::Pending.raw_get(obj: self, user: nil, extra: nil, only: only)
+      @raw_pendings
+    end
+
+    def pendings(user: nil, extra: nil, only: 'kept')
+      @pendings ||= ::Hist::Pending.get(obj: self, user: nil, extra: nil, only: only)
+      @pendings
+    end
+
+    def diff_hist(ver:nil, pending: nil, type: :json, exclude: [], include: [], associations: nil, only_diffs: false)
+      if ver.present?
+        return Hist::ApplicationRecord.diff(obj: self, ver: ver, type: type, exclude: exclude, include: include, associations: associations, only_diffs: only_diffs)
+      elsif pending.present?
+        return Hist::ApplicationRecord.diff(obj: self, pending: pending, type: type, exclude: exclude, include: include, associations: associations, only_diffs: only_diffs)
+      else
+        raise 'Error: either ver or pending parameter is required for diff_history'
+      end
+
+    end
+
+    def reload_hist
+      @versions = nil
+      @raw_versions = nil
+      @pendings = nil
+      @raw_pendings = nil
+    end
+
+    def reload
+      reload_hist
+      super
+    end
+
+    def hist_json(exclude: [], include: [], associations: nil)
+      Hist::ApplicationRecord.to_json(obj: self, exclude: exclude, include: include, associations: associations)
+    end
+
+    # Attributes essentially... defined as methods as just don't want to save this data as part of the JSON hash
+    def ver_id
+      @ver_id
+    end
+
+    def ver_id=(value)
+      @ver_id = value
+    end
+
+    def pending_id
+      @pending_id
+    end
+
+    def pending_id=(value)
+      @pending_id = value
+    end
+
+    def hist_created_at=(value)
+      @hist_created_at = value
+    end
+
+    def hist_created_at
+      @hist_created_at
+    end
+
+    def hist_whodunnit
+      @hist_whodunnit
+    end
+
+    def hist_whodunnit=(value)
+      @hist_whodunnit_user_set = true
+      @hist_whodunnit = value
+    end
+
+    def system_hist_whodunnit=(value)
+      @hist_whodunnit_user_set = false
+      @hist_whodunnit = value
+    end
+
+    def hist_extra
+      @hist_extra
+    end
+
+    def hist_extra=(value)
+      @hist_whodunnit_extra_set = true
+      @hist_extra = value
+    end
+
+    def system_hist_extra=(value)
+      @hist_whodunnit_extra_set = false
+      @hist_extra = value
+    end
+
+    def record_hist_whodunnit?
+      @hist_whodunnit_user_set
+    end
+
+    def record_hist_extra?
+      @hist_whodunnit_extra_set
+    end
+
+
+    # Type normally isn't part of the JSON output... try to fix that here...
+    #def as_json(options={})
+      #if self.type.present?
+        #super(options.merge({:methods => :type}))
+      #else
+        #super
+      #end
+    #end
+  end
+end

data/app/models/hist/pending.rb

@@ -0,0 +1,53 @@
+module Hist
+  class Pending < Hist::ApplicationRecord
+
+    self.table_name = "hist_pendings"
+
+    def self.start_pending
+      ActiveRecord::Base.transaction do
+        yield
+        raise ActiveRecord::Rollback, "Don't save pending object changes"
+      end
+    end
+
+    def self.get_new_raw(klass:, user: nil, extra: nil, only: 'kept')
+      if user.nil?
+        if extra.nil?
+          versions = self.where(model: Hist.model(klass: klass), obj_id: nil).send(only).reverse
+        else
+          versions = self.where(model: Hist.model(klass: klass), obj_id: nil, extra: extra).send(only).reverse
+        end
+
+      else
+        if extra.nil?
+          # .to_s to support either user object or username
+          versions = self.where(model: Hist.model(klass: klass), obj_id: nil, user: user.to_s).send(only).reverse
+        else
+          # .to_s to support either user object or username
+          versions = self.where(model: Hist.model(klass: klass), obj_id: nil, user: user.to_s, extra: extra).send(only).reverse
+        end
+      end
+
+      versions
+    end
+
+    def self.get_new(klass:, user: nil, extra: nil, only: 'kept')
+      hash_versions = self.get_new_raw(klass: klass, user: user, extra: extra, only: only)
+      versions = hash_versions.map {|v| v.reify }
+      versions
+    end
+
+    def self.put(obj:, user: nil, extra: nil)
+      # Trim old pendings
+      # TODO: make this more efficient
+      if obj.class.base_class.hist_config.max_pendings >= 0
+        versions = self.class.raw_get(obj: obj, only: 'discarded')
+        if versions.size >= obj.class.base_class.hist_config.max_pendings
+          versions.last.destroy!
+        end
+      end
+
+      super
+    end
+  end
+end

data/app/models/hist/version.rb

@@ -0,0 +1,20 @@
+module Hist
+  class Version < Hist::ApplicationRecord
+
+    self.table_name = "hist_versions"
+
+    def self.put(obj:, user: nil, extra: nil)
+      # Trim old versions
+      # TODO: make this more efficient
+      if obj.class.base_class.hist_config.max_versions >= 0
+        versions = self.raw_get(obj: obj)
+        if versions.size >= obj.class.base_class.hist_config.max_versions
+          versions.last.destroy!
+        end
+      end
+
+      super
+    end
+
+  end
+end

data/app/views/hist/_modal_popup.html.erb

@@ -0,0 +1,29 @@
+<%= stylesheet_link_tag    "hist/application", media: "all" %>
+<%= javascript_include_tag "hist/application" %>
+
+<div class="modal-dialog" id="hist_modal_container" tabindex="-1" aria-labelledby="modalLabel-hist_modal_container" aria-hidden="true">
+  <div class="modal-content">
+    <div class="modal-header">
+      <button type="button" class="close" data-dismiss="modal">
+        <span aria-hidden="true">&times;</span>
+        <span class="sr-only">Close</span>
+      </button>
+      <div class="hist-title-left">
+        <h4 class="modal-title"><%= @left_title %></h4>
+      </div>
+      <div class="hist-title-right">
+        <h4 class="modal-title"><%= @right_title %></h4>
+      </div>
+
+    </div>
+    <div class="modal-body">
+      <div id="histAceDiff">
+
+      </div>
+    </div>
+    <div style="clear:both;"></div>
+    <div class="modal-footer">
+      <div class="pull-left"><button type="button" class="btn btn-link" data-dismiss="modal">Close</button></div>
+    </div>
+  </div>
+</div>