logidze 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 937e0b13769d464f7bb14dc1440951ea6a1462db
-  data.tar.gz: e7d117211dc9e24854b0171158996066aa56ade1
+  metadata.gz: d1a840d3c86c64317abe7c5b69a8dcc978e9efc7
+  data.tar.gz: 221465ea78ebb99cf8335415d5c378484d4ddb9a
 SHA512:
-  metadata.gz: fcdfe2828fa0fa360177a7839de761bc91b7e9bb81e9ce0d69482e28b3d2c1194a91e71dca9e13975d7eafc31839db3990f7b082fa37f132c43b51bad3245010
-  data.tar.gz: 3fd4562dd287fdcf8c1321e5ff8e225931cbc9b76913f1c90f9a4566f2610446f86febddfed60407988746a4ad765d397d469bef75eb06591938b2978198866c
+  metadata.gz: 414193540e8570e67f735664e42f09b97fc3e736d8110d0373192ab41b651cf6b597b863e194bc99fbba71a73500d0a96c3ab5205da55e23a709ac4eb76bc2e8
+  data.tar.gz: 7883e8e97309016d2b11b43744fdd07c15aea256408cb65d2d72c55ce1405d461ba6d3d684d5010ca00a8fa634122fe2efb5a7893e0d875dcaff3e783d8eaf4c

data/README.md

@@ -60,6 +60,18 @@ To backfill table data (i.e. create initial snapshots) add `backfill` option:
 rails generate logidze:model Post --backfill
 ```
 
+## Troubleshooting
+
+The most common problem is `"permission denied to set parameter "logidze.xxx"` caused by `ALTER DATABASE ...` query.
+Logidze requires at least database owner privileges (which is not always possible).
+
+Here is a quick and straightforward [workaround](https://github.com/palkan/logidze/issues/11#issuecomment-260703464) by [@nobodyzzz](https://github.com/nobodyzzz).
+
+**NOTE**: if you're using PostgreSQL >= 9.6 you need neither the workaround nor owner privileges because Logidze (>= 0.3.1) can work without `ALTER DATABASE ...`.
+
+Nevertheless, you still need super-user privileges to enable `hstore` extension (or you can use [PostgreSQL Extension Whitelisting](https://github.com/dimitri/pgextwlist)).
+
+
 ## Upgrade from previous versions
 
 We try to make upgrade process as simple as possible. For now, the only required action is to create and run a migration:
@@ -202,9 +214,9 @@ The `log_data` column has the following format:
         "c": {
             "attr": "new value",  // updated fields with new values
             "attr2": "new value"
-            }
-        },
+            },
         "r": 42 // Resposibility ID (if provided)
+      }
     ]
 }
 ```

data/bin/console

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require "rails"
 require "logidze"
 
 require "pry"

data/lib/generators/logidze/install/templates/migration.rb.erb

@@ -1,14 +1,19 @@
 class <%= @migration_class_name %> < ActiveRecord::Migration
+  require 'logidze/migration'
+  include Logidze::Migration
+
   def up
-    execute <<-SQL
-      DO $$
-        BEGIN
-        EXECUTE 'ALTER DATABASE ' || current_database() || ' SET logidze.disabled TO off';
-        EXECUTE 'ALTER DATABASE ' || current_database() || ' SET logidze.responsible TO off';
-        END;
-      $$
-      LANGUAGE plpgsql;
-    SQL
+    unless current_setting_missing_supported?
+      execute <<-SQL
+        DO $$
+          BEGIN
+          EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET logidze.disabled=' || quote_literal('');
+          EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET logidze.responsible=' || quote_literal('');
+          END;
+        $$
+        LANGUAGE plpgsql;
+      SQL
+    end
 
     execute <<-SQL
       CREATE OR REPLACE FUNCTION logidze_version(v bigint, data jsonb) RETURNS jsonb AS $body$
@@ -23,7 +28,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
                     'c',
                     logidze_exclude_keys(data, 'log_data')
                    );
-          IF current_setting('logidze.responsible') <> 'off' THEN
+          IF coalesce(#{current_setting('logidze.responsible')}, '') <> '' THEN
             buf := jsonb_set(buf, ARRAY['r'], to_jsonb(current_setting('logidze.responsible')));
           END IF;
           RETURN buf;

data/lib/generators/logidze/model/templates/migration.rb.erb

@@ -1,4 +1,7 @@
 class <%= @migration_class_name %> < ActiveRecord::Migration
+  require 'logidze/migration'
+  include Logidze::Migration
+ 
   def up
     <% unless only_trigger? %>
     add_column :<%= table_name %>, :log_data, :jsonb
@@ -7,7 +10,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
     execute <<-SQL
       CREATE TRIGGER logidze_on_<%= table_name %>
       BEFORE UPDATE OR INSERT ON <%= table_name %> FOR EACH ROW
-      WHEN (current_setting('logidze.disabled') <> 'on')
+      WHEN (coalesce(#{current_setting('logidze.disabled')}, '') <> 'on')
       EXECUTE PROCEDURE logidze_logger(<%= limit || '' %>);
     SQL
 

data/lib/logidze/history.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'active_support/core_ext/module/delegation'
+
 module Logidze
   # Log data wrapper
   class History

data/lib/logidze/migration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Logidze
+  # Contains helpers for handling different PG versions
+  module Migration
+    # Checks whether pg function `current_setting` support `missing_ok` argument
+    # (since 9.6)
+    def current_setting_missing_supported?
+      ActiveRecord::Base.connection.send(:postgresql_version) >= 90_600
+    end
+
+    def current_setting(name)
+      if current_setting_missing_supported?
+        "current_setting('#{name}', true)"
+      else
+        "current_setting('#{name}')"
+      end
+    end
+  end
+end

data/lib/logidze/responsible.rb

@@ -9,7 +9,7 @@ module Logidze # :nodoc:
           "SET LOCAL logidze.responsible = #{ActiveRecord::Base.connection.quote(responsible_id)};"
         )
         res = yield
-        ActiveRecord::Base.connection.execute "SET LOCAL logidze.responsible = DEFAULT;"
+        ActiveRecord::Base.connection.execute "SET LOCAL logidze.responsible TO DEFAULT;"
         res
       end
     end

data/lib/logidze/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Logidze
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/logidze.rb

@@ -19,9 +19,9 @@ module Logidze
   #   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';"
+      ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled TO on;"
       res = yield
-      ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled = DEFAULT;"
+      ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled TO DEFAULT;"
       res
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -185,6 +185,7 @@ files:
 - lib/logidze/history.rb
 - lib/logidze/history/type.rb
 - lib/logidze/history/version.rb
+- lib/logidze/migration.rb
 - lib/logidze/model.rb
 - lib/logidze/responsible.rb
 - lib/logidze/version.rb