logidze 0.11.0 → 1.2.0

data/lib/logidze/utils/check_pending.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "./function_definitions"
+require_relative "./pending_migration_error"
+
+module Logidze
+  module Utils
+    # This Rack middleware is used to verify that all functions are up to date
+    class CheckPending
+      def initialize(app)
+        @app = app
+        @needs_check = true
+        @mutex = Mutex.new
+      end
+
+      delegate :connection, to: ActiveRecord::Base
+
+      def call(env)
+        @mutex.synchronize do
+          if @needs_check
+            notify_or_raise! if needs_migration?
+          end
+          @needs_check = false
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def notify_or_raise!
+        case Logidze.on_pending_upgrade
+        when :warn
+          warn "\n**************************************************\n"\
+               "⛔️  WARNING: Logidze needs an upgrade and might not work correctly.\n"\
+               "Please, make sure to run `bundle exec rails generate logidze:install --update` "\
+               "and apply generated migration."\
+               "\n**************************************************\n\n"
+        when :raise
+          raise Logidze::Utils::PendingMigrationError, "Logidze needs upgrade. Run `bundle exec rails generate logidze:install --update` and apply generated migration."
+        end
+      end
+
+      def needs_migration?
+        (library_function_versions - pg_function_versions).any?
+      end
+
+      def pg_function_versions
+        Logidze::Utils::FunctionDefinitions.from_db.map { |func| [func.name, func.version] }
+      end
+
+      def library_function_versions
+        @library_function_versions ||= Logidze::Utils::FunctionDefinitions.from_fs.map { |func| [func.name, func.version] }
+      end
+    end
+  end
+end

data/lib/logidze/utils/function_definitions.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Logidze
+  module Utils
+    class FuncDef < Struct.new(:name, :version, :signature); end
+
+    module FunctionDefinitions
+      class << self
+        def from_fs
+          function_paths = Dir.glob(File.join(__dir__, "..", "..", "generators", "logidze", "install", "functions", "*.sql"))
+          function_paths.map do |path|
+            name = path.match(/([^\/]+)\.sql/)[1]
+
+            file = File.open(path)
+            header, version_comment = file.readline, file.readline
+
+            signature = parse_signature(header)
+            version = parse_version(version_comment)
+            FuncDef.new(name, version, signature)
+          end
+        end
+
+        def from_db
+          query = <<~SQL
+            SELECT pp.proname, pg_get_functiondef(pp.oid) AS definition
+            FROM pg_proc pp
+            WHERE pp.proname like 'logidze_%'
+            ORDER BY pp.oid;
+          SQL
+          ActiveRecord::Base.connection.execute(query).map do |row|
+            version = parse_version(row["definition"])
+            FuncDef.new(row["proname"], version, nil)
+          end
+        end
+
+        private
+
+        def parse_version(line)
+          line.match(/version:\s+(\d+)/)&.[](1).to_i
+        end
+
+        def parse_signature(line)
+          parameters = line.match(/CREATE OR REPLACE FUNCTION\s+[\w_]+\((.*)\)/)[1]
+          parameters.split(/\s*,\s*/).map { |param| param.split(/\s+/, 2).last.sub(/\s+DEFAULT .*$/, "") }.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/logidze/utils/pending_migration_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Logidze
+  module Utils
+    class PendingMigrationError < StandardError
+      if Rails::VERSION::MAJOR >= 6
+        require "active_record"
+        require "active_support/actionable_error"
+        include ActiveSupport::ActionableError
+
+        action "Upgrade Logidze" do
+          Rails::Generators.invoke("logidze:install", ["--update"])
+          ActiveRecord::Tasks::DatabaseTasks.migrate
+          if ActiveRecord::Base.dump_schema_after_migration
+            ActiveRecord::Tasks::DatabaseTasks.dump_schema(
+              ActiveRecord::Base.connection_db_config
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/logidze/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logidze
-  VERSION = "0.11.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,127 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.2.0
 platform: ruby
 authors:
 - palkan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: ammeter
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-next-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
-  type: :development
+        version: '0.9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ammeter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: fx
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: rubocop-md
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -136,54 +150,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: PostgreSQL JSON-based auditing
+description: PostgreSQL JSONB-based model changes tracking
 email:
 - dementiev.vm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitattributes"
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- assets/pg_log_data_chart.png
-- bench/performance/README.md
-- bench/performance/diff_bench.rb
-- bench/performance/insert_bench.rb
-- bench/performance/memory_profile.rb
-- bench/performance/setup.rb
-- bench/performance/update_bench.rb
-- bench/triggers/Makefile
-- bench/triggers/Readme.md
-- bench/triggers/bench.sql
-- bench/triggers/hstore_trigger_setup.sql
-- bench/triggers/jsonb_minus_2_setup.sql
-- bench/triggers/jsonb_minus_setup.sql
-- bench/triggers/keys2_trigger_setup.sql
-- bench/triggers/keys_trigger_setup.sql
-- bin/console
-- bin/setup
-- gemfiles/rails42.gemfile
-- gemfiles/rails5.gemfile
-- gemfiles/rails52.gemfile
-- gemfiles/rails6.gemfile
-- gemfiles/railsmaster.gemfile
+- lib/generators/logidze/fx_helper.rb
+- lib/generators/logidze/inject_sql.rb
 - lib/generators/logidze/install/USAGE
+- lib/generators/logidze/install/functions/logidze_capture_exception.sql
+- lib/generators/logidze/install/functions/logidze_compact_history.sql
+- lib/generators/logidze/install/functions/logidze_filter_keys.sql
+- lib/generators/logidze/install/functions/logidze_logger.sql
+- lib/generators/logidze/install/functions/logidze_snapshot.sql
+- lib/generators/logidze/install/functions/logidze_version.sql
 - 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/install/templates/migration_fx.rb.erb
 - lib/generators/logidze/model/USAGE
 - lib/generators/logidze/model/model_generator.rb
 - lib/generators/logidze/model/templates/migration.rb.erb
+- lib/generators/logidze/model/triggers/logidze.sql
 - lib/logidze.rb
 - lib/logidze/engine.rb
 - lib/logidze/has_logidze.rb
@@ -191,15 +184,14 @@ files:
 - lib/logidze/history/type.rb
 - lib/logidze/history/version.rb
 - lib/logidze/ignore_log_data.rb
-- lib/logidze/ignore_log_data/association.rb
 - lib/logidze/ignore_log_data/cast_attribute_patch.rb
-- lib/logidze/ignore_log_data/ignored_columns.rb
 - lib/logidze/meta.rb
-- lib/logidze/migration.rb
 - lib/logidze/model.rb
+- lib/logidze/utils/check_pending.rb
+- lib/logidze/utils/function_definitions.rb
+- lib/logidze/utils/pending_migration_error.rb
 - lib/logidze/version.rb
 - lib/logidze/versioned_association.rb
-- logidze.gemspec
 homepage: http://github.com/palkan/logidze
 licenses:
 - MIT
@@ -209,7 +201,7 @@ metadata:
   documentation_uri: http://github.com/palkan/logidze
   homepage_uri: http://github.com/palkan/logidze
   source_code_uri: http://github.com/palkan/logidze
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -217,15 +209,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.10
+signing_key:
 specification_version: 4
-summary: PostgreSQL JSON-based auditing
+summary: PostgreSQL JSONB-based model changes tracking
 test_files: []

data/.gitattributes

@@ -1,3 +0,0 @@
-assets/**/* linguist-vendored
-bench/**/* linguist-vendored
-.github/**/* linguist-vendored

data/.github/ISSUE_TEMPLATE.md

@@ -1,20 +0,0 @@
-<!--
-  This template is for bug reports. If you are reporting a bug, please continue on. If you are here for another reason, 
-  feel free to skip the rest of this template.
--->
-
-### Tell us about your environment
-
-**Ruby Version:**
-
-**Rails Version:**
-
-**PostgreSQL Version:**
-
-**Logidze Version:**
-
-### What did you do?
-
-### What did you expect to happen?
-
-### What actually happened?