logidze 0.0.1 → 0.1.0

data/lib/logidze.rb

@@ -1,5 +1,25 @@
+# frozen_string_literal: true
 require "logidze/version"
 
+# Logidze provides tools for adding in-table JSON-based audit to DB tables
+# and ActiveRecord extensions to work with changes history.
 module Logidze
-  # Your code goes here...
+  require 'logidze/history'
+  require 'logidze/model'
+  require 'logidze/has_logidze'
+
+  require 'logidze/engine' if defined?(Rails)
+
+  # Temporary disable DB triggers.
+  #
+  # @example
+  #   Logidze.without_logging { Post.update_all(active: true) }
+  def self.without_logging
+    ActiveRecord::Base.transaction do
+      ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled = 'on';"
+      res = yield
+      ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled = DEFAULT;"
+      res
+    end
+  end
 end

data/lib/logidze/engine.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'logidze'
+
+module Logidze
+  class Engine < Rails::Engine # :nodoc:
+    initializer "extend ActiveRecord with Logidze" do |_app|
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, Logidze::HasLogidze
+      end
+    end
+  end
+end

data/lib/logidze/has_logidze.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'active_support'
+
+module Logidze
+  # Add `has_logidze` method to AR::Base
+  module HasLogidze
+    extend ActiveSupport::Concern
+
+    module ClassMethods # :nodoc:
+      # Include methods to work with history.
+      #
+      # rubocop:disable Style/PredicateName
+      def has_logidze
+        include Logidze::Model
+      end
+    end
+  end
+end

data/lib/logidze/history.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+module Logidze
+  # Log data coder used for attribute serialization
+  class History
+    # History key
+    HISTORY = 'h'
+    # Version key
+    VERSION = 'v'
+
+    # Represents one log item
+    class Version
+      # Timestamp key
+      TS = 'ts'
+      # Changes key
+      CHANGES = 'c'
+
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+
+      def version
+        data.fetch(VERSION)
+      end
+
+      def changes
+        data.fetch(CHANGES)
+      end
+
+      def time
+        data.fetch(TS)
+      end
+    end
+
+    def self.dump(object)
+      ActiveSupport::JSON.encode(object)
+    end
+
+    def self.load(json)
+      new(json) unless json.nil?
+    end
+
+    attr_reader :data
+
+    delegate :size, to: :versions
+
+    def initialize(data)
+      @data = data
+    end
+
+    def versions
+      @versions ||= data.fetch(HISTORY).map { |v| Version.new(v) }
+    end
+
+    # Returns current version number
+    def version
+      data.fetch(VERSION)
+    end
+
+    # Change current version
+    def version=(val)
+      data.store(VERSION, val)
+    end
+
+    def current_version
+      find_by_version(version)
+    end
+
+    def previous_version
+      find_by_version(version - 1)
+    end
+
+    def next_version
+      find_by_version(version + 1)
+    end
+
+    # Return diff from the initial state to specified time or version.
+    # Optional `data` paramater can be used as initial diff state.
+    def changes_to(time: nil, version: nil, data: {}, from: 0)
+      raise ArgumentError, "Time or version must be specified" if time.nil? && version.nil?
+      filter = time.nil? ? method(:version_filter) : method(:time_filter)
+      versions.each_with_object(data.dup) do |v, acc|
+        next if v.version < from
+        break acc if filter.call(v, version, time)
+        acc.merge!(v.changes)
+      end
+    end
+
+    # Return diff object representing changes since specified time or version.
+    #
+    # @example
+    #
+    #   diff_from(time: 2.days.ago)
+    #   #=> { "id" => 1, "changes" => { "title" => { "old" => "Hello!", "new" => "World" } } }
+    # rubocop:disable Metrics/AbcSize
+    def diff_from(time: nil, version: nil)
+      raise ArgumentError, "Time or version must be specified" if time.nil? && version.nil?
+
+      from_version = version.nil? ? find_by_time(time) : find_by_version(version)
+      from_version ||= versions.first
+
+      base = changes_to(version: from_version.version)
+      diff = changes_to(version: self.version, data: base, from: from_version.version + 1)
+
+      build_changes(base, diff)
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Return true iff time greater or equal to the first version time
+    def exists_ts?(time)
+      versions.present? && versions.first.time <= time
+    end
+
+    # Return true iff time corresponds to current version
+    def current_ts?(time)
+      (current_version.time <= time) &&
+        (next_version.nil? || (next_version.time < time))
+    end
+
+    # Return version by number or nil
+    def find_by_version(num)
+      versions.find { |v| v.version == num }
+    end
+
+    # Return nearest (from the bottom) version to the specified time
+    def find_by_time(time)
+      versions.reverse.find { |v| v.time <= time }
+    end
+
+    def ==(other)
+      return super unless other.is_a?(self.class)
+      data == other.data
+    end
+
+    def as_json(options = {})
+      data.as_json(options)
+    end
+
+    private
+
+    def build_changes(a, b)
+      b.each_with_object({}) do |kv, acc|
+        acc[kv.first] = { "old" => a[kv.first], "new" => kv.last } unless kv.last == a[kv.first]
+      end
+    end
+
+    def version_filter(item, version, _)
+      item.version > version
+    end
+
+    def time_filter(item, _, time)
+      item.time > time
+    end
+  end
+end

data/lib/logidze/model.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+require 'active_support'
+
+module Logidze
+  # Extends model with methods to browse history
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      serialize :log_data, Logidze::History
+
+      delegate :version, :size, to: :log_data, prefix: "log"
+    end
+
+    module ClassMethods # :nodoc:
+      # Return records reverted to specified time
+      def at(ts)
+        all.map { |record| record.at(ts) }.compact
+      end
+
+      # Return changes made to records since specified time
+      def diff_from(ts)
+        all.map { |record| record.diff_from(ts) }
+      end
+
+      # Alias for Logidze.without_logging
+      def without_logging(&block)
+        Logidze.without_logging(&block)
+      end
+    end
+
+    # Use this to convert Ruby time to milliseconds
+    TIME_FACTOR = 1_000
+
+    # Return a dirty copy of record at specified time
+    # If time is less then the first version, then return nil.
+    # If time is greater then the last version, then return self.
+    def at(ts)
+      ts = parse_time(ts)
+      return nil unless log_data.exists_ts?(ts)
+      return self if log_data.current_ts?(ts)
+
+      object_at = dup
+      object_at.apply_diff(log_data.changes_to(time: ts))
+    end
+
+    # Revert record to the version at specified time (without saving to DB)
+    def at!(ts)
+      ts = parse_time(ts)
+      return self if log_data.current_ts?(ts)
+      return false unless log_data.exists_ts?(ts)
+
+      apply_diff(log_data.changes_to(time: ts))
+    end
+
+    # Return a dirty copy of specified version of record
+    def at_version(version)
+      return self if log_data.version == version
+      return nil unless log_data.find_by_version(version)
+
+      object_at = dup
+      object_at.apply_diff(log_data.changes_to(version: version))
+    end
+
+    # Revert record to the specified version (without saving to DB)
+    def at_version!(version)
+      return self if log_data.version == version
+      return false unless log_data.find_by_version(version)
+
+      apply_diff(log_data.changes_to(version: version))
+    end
+
+    # Return diff object representing changes since specified time.
+    #
+    # @example
+    #
+    #   post.diff_from(2.days.ago)
+    #   #=> { "id" => 1, "changes" => { "title" => { "old" => "Hello!", "new" => "World" } } }
+    def diff_from(ts)
+      ts = parse_time(ts)
+      { "id" => id, "changes" => log_data.diff_from(time: ts) }
+    end
+
+    # Restore record to the previous version.
+    # Return false if no previous version found, otherwise return updated record.
+    def undo!
+      version = log_data.previous_version
+      return false if version.nil?
+      switch_to!(version.version)
+    end
+
+    # Restore record to the _future_ version (if `undo!` was applied)
+    # Return false if no future version found, otherwise return updated record.
+    def redo!
+      version = log_data.next_version
+      return false if version.nil?
+      switch_to!(version.version)
+    end
+
+    # Restore record to the specified version.
+    # Return false if version is unknown.
+    def switch_to!(version)
+      return false unless at_version!(version)
+      log_data.version = version
+      self.class.without_logging { save! }
+    end
+
+    protected
+
+    def apply_diff(diff)
+      diff.each { |k, v| send("#{k}=", v) }
+      self
+    end
+
+    def parse_time(ts)
+      case ts
+      when Numeric
+        ts.to_i
+      when String
+        (Time.parse(ts).to_r * TIME_FACTOR).to_i
+      when Date
+        (ts.to_time.to_r * TIME_FACTOR).to_i
+      when Time
+        (ts.to_r * TIME_FACTOR).to_i
+      end
+    end
+  end
+end

data/lib/logidze/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Logidze
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/logidze.gemspec

@@ -17,10 +17,15 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activerecord", "~>4"
+  spec.add_dependency "rails", ">= 4.2.6"
 
   spec.add_development_dependency "pg", "~>0.18"
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rspec", ">= 3.4"
+  spec.add_development_dependency "rspec-rails", ">= 3.4"
+  spec.add_development_dependency "database_cleaner", "~> 1.5"
+  spec.add_development_dependency "simplecov", ">= 0.3.8"
+  spec.add_development_dependency "ammeter", "~> 1.1.3"
+  spec.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.2.6
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,86 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: PostgreSQL JSON-based auditing
 email:
 - dementiev.vm@gmail.com
@@ -91,15 +161,36 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bench/Makefile
+- bench/Readme.md
 - bench/bench.sql
 - bench/hstore_trigger_setup.sql
+- bench/jsonb_minus_2_setup.sql
+- bench/jsonb_minus_setup.sql
+- bench/keys2_trigger_setup.sql
 - bench/keys_trigger_setup.sql
+- bin/console
+- bin/setup
+- circle.yml
+- gemfiles/rails42.gemfile
+- gemfiles/rails5.gemfile
+- lib/generators/logidze/install/USAGE
+- lib/generators/logidze/install/install_generator.rb
+- lib/generators/logidze/install/templates/hstore.rb.erb
+- lib/generators/logidze/install/templates/migration.rb.erb
+- lib/generators/logidze/model/USAGE
+- lib/generators/logidze/model/model_generator.rb
+- lib/generators/logidze/model/templates/migration.rb.erb
 - lib/logidze.rb
+- lib/logidze/engine.rb
+- lib/logidze/has_logidze.rb
+- lib/logidze/history.rb
+- lib/logidze/model.rb
 - lib/logidze/version.rb
 - logidze.gemspec
 homepage: http://github.com/palkan/logidze
@@ -122,9 +213,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: PostgreSQL JSON-based auditing
 test_files: []
-has_rdoc: