logidze 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1a840d3c86c64317abe7c5b69a8dcc978e9efc7
-  data.tar.gz: 221465ea78ebb99cf8335415d5c378484d4ddb9a
+  metadata.gz: 34c35c39f7c5dc042b1c13298bdb0347f6d2c811
+  data.tar.gz: c4e3a0f86bdb6fcffa45286d55a4d42a59343074
 SHA512:
-  metadata.gz: 414193540e8570e67f735664e42f09b97fc3e736d8110d0373192ab41b651cf6b597b863e194bc99fbba71a73500d0a96c3ab5205da55e23a709ac4eb76bc2e8
-  data.tar.gz: 7883e8e97309016d2b11b43744fdd07c15aea256408cb65d2d72c55ce1405d461ba6d3d684d5010ca00a8fa634122fe2efb5a7893e0d875dcaff3e783d8eaf4c
+  metadata.gz: 29f671a66d9fe528c17baa1416f803a4aba38f0e58e5a4cad5398c28641212c4b956a29004f225babe10ca35c9690e17b1c9d6e5576339d1358ae56f1b4e728a
+  data.tar.gz: 438261164cf4ea8c792ab089cc0cbafdff31c3086c12025f0fe35907b3a5efbbd5882563eebeec50ce8954b83d788c3a688077246077a90f65fe05845465640d

data/.travis.yml

@@ -1,27 +1,17 @@
 language: ruby
 cache: bundler
 
+dist: trusty
+sudo: false
+
+addons:
+  postgresql: "9.6"
+
 env:
   global:
     - LOGIDZE_DB_USER=postgres
     - LOGIDZE_DB_NAME=logidze
 
-before_install:
-  - sudo /etc/init.d/postgresql stop
-  - sudo apt-get -y remove --purge postgresql-9.1
-  - sudo apt-get -y remove --purge postgresql-9.2
-  - sudo apt-get -y remove --purge postgresql-9.3
-  - sudo apt-get -y remove --purge postgresql-9.4
-  - sudo apt-get -y autoremove
-  - sudo apt-key adv --keyserver keys.gnupg.net --recv-keys 7FCC7D46ACCC4CF8
-  - sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main 9.5" >> /etc/apt/sources.list.d/postgresql.list'
-  - sudo apt-get update
-  - sudo apt-get -y install postgresql-9.5
-  - sudo sh -c 'echo "local all postgres trust" > /etc/postgresql/9.5/main/pg_hba.conf'
-  - sudo sh -c 'echo -n "host all all 127.0.0.1/32 trust" >> /etc/postgresql/9.5/main/pg_hba.conf'
-  - sudo /etc/init.d/postgresql restart
-  - psql --version
-
 before_script:
   - bundle exec rake dummy:db:create
   - psql -U postgres -d logidze -c 'CREATE EXTENSION IF NOT EXISTS hstore;'

data/CHANGELOG.md

@@ -1,18 +1,36 @@
-# 0.3.0
-- Add `--update` option to install migration generator
-- Add `--only-trigger` option to model migration generator
-- Add [Responsibility](https://github.com/palkan/logidze/issues/4) feature
+# Change log
 
-# 0.2.3
-- Support Ruby >= 2.1
+## master
 
-# 0.2.2
-- Add `--backfill` option to model migration
-- Handle legacy data (that doesn't have log data)
+## 0.4.0 (2017-01-14)
 
-# 0.2.1
-- Support both Rails 4 and 5
+- Add `--blacklist` and `--whitelist` options to model migration generator. ([@charlie-wasp][])
 
-# 0.2.0 (**Incompatible with 0.1.0**)
+## 0.3.0
 
-- Rails 5 support
+- Add `--update` option to install migration generator. ([@palkan][])
+
+- Add `--only-trigger` option to model migration generator. ([@palkan][])
+
+- Add [Responsibility](https://github.com/palkan/logidze/issues/4) feature. ([@palkan][])
+
+## 0.2.3
+
+- Support Ruby >= 2.1. ([@palkan][])
+
+## 0.2.2
+
+- Add `--backfill` option to model migration. ([@palkan][])
+
+- Handle legacy data (that doesn't have log data). ([@palkan][])
+
+## 0.2.1
+
+- Support both Rails 4 and 5. ([@palkan][])
+
+## 0.2.0 (**Incompatible with 0.1.0**)
+
+- Rails 5 support. ([@palkan][])
+
+[@palkan]: https://github.com/palkan
+[@charlie-wasp]: https://github.com/charlie-wasp

data/README.md

@@ -60,6 +60,15 @@ To backfill table data (i.e. create initial snapshots) add `backfill` option:
 rails generate logidze:model Post --backfill
 ```
 
+You can log only particular columns changes. There are mutually exclusive `blacklist` and `whitelist` options for this:
+
+```ruby
+# track all columns, except `created_at` and `active`
+rails generate logidze:model Post --blacklist=created_at active
+# track only `title` and `body` columns
+rails generate logidze:model Post --whitelist=title body
+```
+
 ## Troubleshooting
 
 The most common problem is `"permission denied to set parameter "logidze.xxx"` caused by `ALTER DATABASE ...` query.
@@ -234,7 +243,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/palkan
 
 ## TODO
 
-- Exclude columns from the log.
 - Enhance update_all to support mass-logging.
 - Other DB adapters.
 

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

@@ -15,8 +15,15 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
       SQL
     end
 
+    <% if update? %>
     execute <<-SQL
-      CREATE OR REPLACE FUNCTION logidze_version(v bigint, data jsonb) RETURNS jsonb AS $body$
+      DROP FUNCTION IF EXISTS logidze_version(bigint, jsonb);
+      DROP FUNCTION IF EXISTS logidze_snapshot(jsonb);
+    SQL
+    <% end %>
+
+    execute <<-SQL
+      CREATE OR REPLACE FUNCTION logidze_version(v bigint, data jsonb, blacklist text[] DEFAULT '{}') RETURNS jsonb AS $body$
         DECLARE
           buf jsonb;
         BEGIN
@@ -26,7 +33,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
                    'v',
                     v,
                     'c',
-                    logidze_exclude_keys(data, 'log_data')
+                    logidze_exclude_keys(data, VARIADIC array_append(blacklist, 'log_data'))
                    );
           IF coalesce(#{current_setting('logidze.responsible')}, '') <> '' THEN
             buf := jsonb_set(buf, ARRAY['r'], to_jsonb(current_setting('logidze.responsible')));
@@ -36,12 +43,12 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
       $body$
       LANGUAGE plpgsql;
 
-      CREATE OR REPLACE FUNCTION logidze_snapshot(item jsonb) RETURNS jsonb AS $body$
+      CREATE OR REPLACE FUNCTION logidze_snapshot(item jsonb, blacklist text[] DEFAULT '{}') RETURNS jsonb AS $body$
         BEGIN
           return json_build_object(
             'v', 1,
             'h', jsonb_build_array(
-                   logidze_version(1, item)
+                   logidze_version(1, item, blacklist)
                  )
             );
         END;
@@ -103,20 +110,22 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
           merged jsonb;
           iterator integer;
           item record;
+          columns_blacklist text[];
         BEGIN
+          columns_blacklist := TG_ARGV[1];
 
           IF TG_OP = 'INSERT' THEN
 
-            NEW.log_data := logidze_snapshot(to_jsonb(NEW.*));
+            NEW.log_data := logidze_snapshot(to_jsonb(NEW.*), columns_blacklist);
           
           ELSIF TG_OP = 'UPDATE' THEN
           
             IF OLD.log_data is NULL OR OLD.log_data = '{}'::jsonb THEN
-              NEW.log_data := logidze_snapshot(to_jsonb(NEW.*));
+              NEW.log_data := logidze_snapshot(to_jsonb(NEW.*), columns_blacklist);
               RETURN NEW;
             END IF;
 
-            history_limit := TG_ARGV[0];
+            history_limit := NULLIF(TG_ARGV[0], 'null');
             current_version := (NEW.log_data->>'v')::int;
 
             IF NEW = OLD THEN
@@ -149,7 +158,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
             NEW.log_data := jsonb_set(
               NEW.log_data,
               ARRAY['h', size::text],
-              logidze_version(new_v, changes),
+              logidze_version(new_v, changes, columns_blacklist),
               true
             );
 
@@ -174,9 +183,9 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
   def down
     <% unless update? %>
     execute <<-SQL
-      DROP FUNCTION logidze_version(bigint, jsonb) CASCADE;
+      DROP FUNCTION logidze_version(bigint, jsonb, text[]) CASCADE;
       DROP FUNCTION logidze_compact_history(jsonb) CASCADE;
-      DROP FUNCTION logidze_snapshot(jsonb) CASCADE;
+      DROP FUNCTION logidze_snapshot(jsonb, text[]) CASCADE;
       DROP FUNCTION logidze_logger() CASCADE;
     SQL
     <% end %>

data/lib/generators/logidze/model/model_generator.rb

@@ -15,7 +15,14 @@ module Logidze
       class_option :only_trigger, type: :boolean, optional: true,
                                   desc: "Create trigger-only migration"
 
+      class_option :blacklist, type: :array, optional: true
+      class_option :whitelist, type: :array, optional: true
+
       def generate_migration
+        if options[:blacklist] && options[:whitelist]
+          $stderr.puts "Use only one: --whitelist or --blacklist"
+          exit(1)
+        end
         migration_template "migration.rb.erb", "db/migrate/#{migration_file_name}"
       end
 
@@ -45,6 +52,38 @@ module Logidze
         def only_trigger?
           options[:only_trigger]
         end
+
+        def columns_blacklist
+          array = if !options[:whitelist]
+                    options[:blacklist]
+                  else
+                    class_name.constantize.column_names - options[:whitelist]
+                  end
+
+          array || []
+        end
+
+        def logidze_logger_parameters
+          if limit.nil? && columns_blacklist.empty?
+            ''
+          elsif !limit.nil? && columns_blacklist.empty?
+            limit
+          elsif !limit.nil? && !columns_blacklist.empty?
+            "#{limit}, #{format_pgsql_array(columns_blacklist)}"
+          elsif limit.nil? && !columns_blacklist.empty?
+            "null, #{format_pgsql_array(columns_blacklist)}"
+          end
+        end
+
+        def logidze_snapshot_parameters
+          return 'to_jsonb(t)' if columns_blacklist.empty?
+
+          "to_jsonb(t), #{format_pgsql_array(columns_blacklist)}"
+        end
+
+        def format_pgsql_array(ruby_array)
+          "'{" + ruby_array.join(', ') + "}'"
+        end
       end
 
       private

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

@@ -11,13 +11,13 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
       CREATE TRIGGER logidze_on_<%= table_name %>
       BEFORE UPDATE OR INSERT ON <%= table_name %> FOR EACH ROW
       WHEN (coalesce(#{current_setting('logidze.disabled')}, '') <> 'on')
-      EXECUTE PROCEDURE logidze_logger(<%= limit || '' %>);
+      EXECUTE PROCEDURE logidze_logger(<%= logidze_logger_parameters %>);
     SQL
 
     <% if backfill? %>
     execute <<-SQL
       UPDATE <%= table_name %> as t
-      SET log_data = logidze_snapshot(to_jsonb(t));
+      SET log_data = logidze_snapshot(<%= logidze_snapshot_parameters %>);
     SQL
     <% end %>
   end

data/lib/logidze/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails