breathing 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 815ec172eb186702177838e5213fb84c471b15dc7a4bdd7c951a97c78d9666c2
-  data.tar.gz: d05a272b946c324ca9f0031e291840ca58d21069607ffc2e8b0579e9a99ecb76
+  metadata.gz: 62878c327e1da216456749f0d3d3b154a4d8d11528226f90cc7dadf855d2e6f2
+  data.tar.gz: 7a27d00aca80c0a3837d1bfc7778ee1d507c2deb7719127a53745a86f25aa439
 SHA512:
-  metadata.gz: f5130a4714437d96c658266626989a86feb1c670d62308168dc64b009a0ea660aa86d8ede410acba4fdd6bb0a33504248f0c6ecca1e9b95ecc74293783ea03c5
-  data.tar.gz: 1c624939e64701ab5dc42bcbac6ac46cfae7ece8dd967ee1d960c6f1a209b63c42bdaf0d454e50a8bd06d1fe29982967c85098af683da1b0e93c7c3a85a197e0
+  metadata.gz: 86f14f92c0a6b4953307c6a733daf0c378726f0e3d9f97703c29ff3e34ead58568b4b3d0d62ddd2cd34da40b6d1056cc6a6e1b096030276d6313745844a25998
+  data.tar.gz: 51cb295e2097b87d2ba21faf62495087a5cae5a7db695e7703e219cbde57f883b4f776d39ca68258299ba6f33347c1bca3ce1608580b27f5a2e251f978c3c86f

data/.circleci/config.yml

@@ -6,8 +6,7 @@ executors:
     docker:
       - image: circleci/ruby:2.6
         environment:
-          DB_USER: 'root'
-          DB_PASS: 'root'
+          DB_USER: root
           DB_HOST: '127.0.0.1'
       - image: circleci/mysql:8-ram
         environment:
@@ -15,6 +14,10 @@ executors:
           MYSQL_ROOT_PASSWORD: root
           MYSQL_DATABASE: breathing_test
         command: [--default-authentication-plugin=mysql_native_password]
+      - image: circleci/postgres:10.6-alpine-ram
+        environment:
+          POSTGRES_USER: root
+          POSTGRES_DB: breathing_test
 
 commands:
   setup_bundle:
@@ -35,6 +38,9 @@ commands:
       - run:
           name: Wait for DB
           command: dockerize -wait tcp://127.0.0.1:3306 -timeout 1m
+      - run:
+          name: Wait for DB
+          command: dockerize -wait tcp://127.0.0.1:5432 -timeout 1m
 
 jobs:
   test:
@@ -43,7 +49,8 @@ jobs:
       - checkout
       - setup_bundle
       - wait_for_db
-      - run: bundle exec rspec ./spec
+      - run: DB=mysql DB_PASS=root bundle exec rspec ./spec
+      - run: DB=pg bundle exec rspec ./spec
 
 workflows:
   version: 2

data/README.md

@@ -5,15 +5,8 @@ Logging mechanism using database triggers to store the old and new row states in
 
 ## Install
 
-Put this line in your Gemfile:
-
-```
-gem 'breathing'
-```
-
-Then bundle:
 ```
-% bundle
+gem install 'breathing'
 ```
 
 ## Usage
@@ -24,6 +17,8 @@ Just run the following command.
 
 ```
 % DATABASE_URL="mysql2://user:pass@host:port/database" breathing install
+or
+% DATABASE_URL="postgres://user:pass@host:port/database" breathing install
 ```
 
 - Create table `change_logs`
@@ -46,12 +41,20 @@ Cleanup command.
     - change_logs_update_{table_name}
     - change_logs_delete_{table_name}
 
-### export
+### Export
 
 ```
 % DATABASE_URL="mysql2://user:pass@host:port/database" breathing export
 ```
 
+- Output file `breathing.xlsx`
+
+## Compatibility
+
+- Ruby 2.3.0+
+- MySQL 5.7.0+
+- PostgreSQL 8.0+
+
 ## Copyright
 
 Copyright (c) 2020 Akira Kusumoto. See MIT-LICENSE file for further details.

data/breathing.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'breathing'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Akira Kusumoto']
   s.email       = ['akirakusumo10@gmail.com']
@@ -21,8 +21,10 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'thor'
 
   s.add_dependency 'activerecord', ['>= 5.0.0']
-  s.add_dependency 'rubyXL', ['>= 3.4.0']
+  s.add_dependency 'hairtrigger'
   s.add_dependency 'mysql2'
+  s.add_dependency 'pg'
+  s.add_dependency 'rubyXL', ['>= 3.4.0']
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rspec', '~> 3.9'
 end

data/lib/breathing.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+require 'hairtrigger'
 require 'breathing/installer'
 require 'breathing/trigger'
 require 'breathing/change_log'

data/lib/breathing/cli.rb

@@ -3,7 +3,7 @@ require 'breathing'
 
 module Breathing
   class Cli < Thor
-    default_command :install
+    default_command :export
 
     desc 'install', 'Create table change_logs and create triggers'
     def install

data/lib/breathing/installer.rb

@@ -4,8 +4,12 @@ require 'breathing/trigger'
 require 'breathing/change_log'
 
 module Breathing
+  class UnsupportedError < StandardError; end
+
   class Installer
     def install
+      raise Breathing::UnsupportedError, "Version MySQL 5.6 is not supported." unless database_version_valid?
+
       create_log_table unless log_table_exists?
 
       models.each do |model|
@@ -24,6 +28,11 @@ module Breathing
 
     private
 
+    def database_version_valid?
+      connection = ActiveRecord::Base.connection
+      connection.adapter_name == "PostgreSQL" || (connection.adapter_name == 'Mysql2' && connection.raw_connection.info[:version].to_f >= 5.7)
+    end
+
     def log_table_name
       Breathing::ChangeLog.table_name
     end

data/lib/breathing/trigger.rb

@@ -12,69 +12,61 @@ module Breathing
 
     def create
       trigger_name = "#{log_table_name}_insert_#{model.table_name}"
+
       unless exists?(trigger_name)
         puts "CREATE TRIGGER #{trigger_name}"
-        ActiveRecord::Base.connection.execute <<-SQL
-        CREATE TRIGGER #{trigger_name}
-        AFTER INSERT
-        ON #{model.table_name}
-        FOR EACH ROW
-        BEGIN
-          INSERT INTO #{log_table_name} (`action`, `table_name`, `transaction_id`, `before_data`, `after_data`, `created_at`)
+
+        ActiveRecord::Base.connection.create_trigger(trigger_name).on(model.table_name).after(:insert) do
+          <<-SQL
+          INSERT INTO #{log_table_name} (action, table_name, transaction_id, before_data, after_data, created_at)
           VALUES ('INSERT', '#{model.table_name}', NEW.id,
-                  JSON_OBJECT(),
-                  JSON_OBJECT(#{json_object_values(model.columns, 'NEW')}),
+                  '{}',
+                  #{row_to_json(model.columns, 'NEW')},
                   CURRENT_TIMESTAMP);
-        END;
-        SQL
+          SQL
+        end
       end
 
       trigger_name = "#{log_table_name}_update_#{model.table_name}"
       unless exists?(trigger_name)
         puts "CREATE TRIGGER #{trigger_name}"
-        ActiveRecord::Base.connection.execute <<-SQL
-        CREATE TRIGGER #{trigger_name}
-        BEFORE UPDATE
-        ON #{model.table_name}
-        FOR EACH ROW
-        BEGIN
-          IF (OLD.updated_at != NEW.updated_at) THEN
-              INSERT INTO #{log_table_name} (`action`, `table_name`, `transaction_id`, `before_data`, `after_data`, `created_at`)
+
+        ActiveRecord::Base.connection.create_trigger(trigger_name).on(model.table_name).before(:update).of(:updated_at) do
+          <<-SQL
+          INSERT INTO #{log_table_name} (action, table_name, transaction_id, before_data, after_data, created_at)
               VALUES ('UPDATE', '#{model.table_name}', NEW.id,
-                      JSON_OBJECT(#{json_object_values(model.columns, 'OLD')}),
-                      JSON_OBJECT(#{json_object_values(model.columns, 'NEW')}),
+                      #{row_to_json(model.columns, 'OLD')},
+                      #{row_to_json(model.columns, 'NEW')},
                       CURRENT_TIMESTAMP);
-          end if;
-        END;
-        SQL
+          SQL
+        end
       end
 
       trigger_name = "#{log_table_name}_delete_#{model.table_name}"
       unless exists?(trigger_name)
         puts "CREATE TRIGGER #{trigger_name}"
-        ActiveRecord::Base.connection.execute <<-SQL
-        CREATE TRIGGER #{trigger_name}
-        AFTER DELETE
-        ON #{model.table_name}
-        FOR EACH ROW
-        BEGIN
-          INSERT INTO #{log_table_name} (`action`, `table_name`, `transaction_id`, `before_data`, `after_data`, `created_at`)
-          VALUES ('DELETE', '#{model.table_name}', OLD.id,
-                  JSON_OBJECT(#{json_object_values(model.columns, 'OLD')}),
-                  JSON_OBJECT(),
+        ActiveRecord::Base.connection.create_trigger(trigger_name).on(model.table_name).after(:delete) do
+          <<-SQL
+           INSERT INTO #{log_table_name} (action, table_name, transaction_id, before_data, after_data, created_at)
+           VALUES ('DELETE', '#{model.table_name}', OLD.id,
+                  #{row_to_json(model.columns, 'OLD')},
+                  '{}',
                   CURRENT_TIMESTAMP);
-        END;
-        SQL
+          SQL
+        end
       end
     end
 
     def drop
       %w[insert update delete].each do |action|
         trigger_name = "#{log_table_name}_#{action}_#{model.table_name}"
-        next unless exists?(trigger_name)
 
         begin
-          sql = "DROP TRIGGER #{trigger_name}"
+          sql = "DROP TRIGGER IF EXISTS #{trigger_name}"
+          if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+            sql << " ON #{model.table_name} CASCADE;"
+            sql << " DROP FUNCTION IF EXISTS #{trigger_name} CASCADE;"
+          end
           puts sql
           ActiveRecord::Base.connection.execute(sql)
         rescue StandardError => e
@@ -86,15 +78,19 @@ module Breathing
     private
 
     def exists?(trigger_name)
-      @trigger_names ||= ActiveRecord::Base.connection.select_rows('SHOW TRIGGERS').map { |row| row.first }
-      @trigger_names.include?(trigger_name)
+      ActiveRecord::Base.connection.triggers.keys.include?(trigger_name)
     end
 
-    def json_object_values(columns, state)
-      columns.each.with_object([]) do |column, array|
-        array << "'#{column.name}'"
-        array << "#{state}.#{column.name}"
-      end.join(',')
+    def row_to_json(columns, state)
+      if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+        "row_to_json(#{state}.*)"
+      else
+        json_object_values = columns.each.with_object([]) do |column, array|
+          array << "'#{column.name}'"
+          array << "#{state}.#{column.name}"
+        end
+        "JSON_OBJECT(#{json_object_values.join(',')})"
+      end
     end
   end
 end

data/spec/app.rb

@@ -2,7 +2,7 @@ require 'active_record'
 require 'breathing'
 
 ActiveRecord::Base.establish_connection(
-  YAML.load(ERB.new(File.read('spec/database.yml')).result)['test']
+  YAML.load(ERB.new(File.read('spec/database.yml')).result)["test_#{ENV['DB'] || 'mysql'}"]
 )
 
 ActiveRecord::Schema.define version: 0 do

data/spec/breathing/excel_spec.rb

@@ -3,7 +3,9 @@ require 'spec_helper'
 describe Breathing::Excel do
   describe '#create' do
     before { Breathing::Installer.new.install }
-    after { Breathing::Installer.new.uninstall }
+    after do
+      Breathing::Installer.new.uninstall if ActiveRecord::Base.connection.adapter_name == "Mysql2"
+    end
 
     it do
       user = User.create!(name: 'a', age: 20)

data/spec/breathing_spec.rb

@@ -5,36 +5,41 @@ describe Breathing do
     expect(Breathing::VERSION).not_to be nil
   end
 
-  before { Breathing::Installer.new.install }
-  after { Breathing::Installer.new.uninstall }
-
-  it do
-    expect(Breathing::ChangeLog.count).to eq(0)
-
-    # INSERT
-    user = User.create!(name: 'a', age: 20)
-    expect(Breathing::ChangeLog.count).to eq(1)
-
-    log = Breathing::ChangeLog.where(table_name: user.class.table_name, transaction_id: user.id).last
-    expect(log.before_data).to eq({})
-    expect(log.after_data['name']).to eq('a')
-    expect(log.after_data['age']).to eq(20)
-
-    # UPDATE
-    user.update!(age: 21)
-    expect(Breathing::ChangeLog.count).to eq(2)
-
-    log = Breathing::ChangeLog.where(table_name: user.class.table_name, transaction_id: user.id).last
-    expect(log.before_data['age']).to eq(20)
-    expect(log.after_data['age']).to eq(21)
-    expect(log.before_data['name']).to eq(log.after_data['name'])
-    expect(log.changed_attribute_columns).to eq(%w[age updated_at])
-
-    # DELETE
-    user.destroy!
-    expect(Breathing::ChangeLog.count).to eq(3)
-    log = Breathing::ChangeLog.where(table_name: user.class.table_name, transaction_id: user.id).last
-    expect(log.before_data['name']).to eq('a')
-    expect(log.after_data).to eq({})
+  describe 'change_logs' do
+    before { Breathing::Installer.new.install }
+
+    after do
+      Breathing::Installer.new.uninstall if ActiveRecord::Base.connection.adapter_name == "Mysql2"
+    end
+
+    it do
+      expect(Breathing::ChangeLog.count).to eq(0)
+
+      # INSERT
+      user = User.create!(name: 'a', age: 20)
+      expect(Breathing::ChangeLog.count).to eq(1)
+
+      log = Breathing::ChangeLog.where(table_name: user.class.table_name, transaction_id: user.id).last
+      expect(log.before_data).to eq({})
+      expect(log.after_data['name']).to eq('a')
+      expect(log.after_data['age']).to eq(20)
+
+      # UPDATE
+      user.update!(age: 21)
+      expect(Breathing::ChangeLog.count).to eq(2)
+
+      log = Breathing::ChangeLog.where(table_name: user.class.table_name, transaction_id: user.id).last
+      expect(log.before_data['age']).to eq(20)
+      expect(log.after_data['age']).to eq(21)
+      expect(log.before_data['name']).to eq(log.after_data['name'])
+      expect(log.changed_attribute_columns).to eq(%w[age updated_at])
+
+      # DELETE
+      user.destroy!
+      expect(Breathing::ChangeLog.count).to eq(3)
+      log = Breathing::ChangeLog.where(table_name: user.class.table_name, transaction_id: user.id).last
+      expect(log.before_data['name']).to eq('a')
+      expect(log.after_data).to eq({})
+    end
   end
 end

data/spec/database.yml

@@ -1,11 +1,18 @@
-test:
+test_mysql:
   adapter:   mysql2
   encoding:  utf8mb4
   charset:   utf8mb4
   collation: utf8mb4_general_ci
-  pool:      5
   username:  <%= ENV.fetch("DB_USER") { 'root' } %>
   password:  <%= ENV.fetch("DB_PASS") { '' } %>
   host:      <%= ENV.fetch("DB_HOST") { '127.0.0.1' } %>
   socket:    /tmp/mysql.sock
-  database: breathing_test
+  database:  breathing_test
+
+test_pg:
+  adapter:   postgresql
+  encoding:  unicode
+  username:  <%= ENV.fetch("DB_USER") { 'root' } %>
+  password:  <%= ENV.fetch("DB_PASS") { '' } %>
+  host:      <%= ENV.fetch("DB_HOST") { '127.0.0.1' } %>
+  database:  breathing_test

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ require 'active_record'
 require 'breathing'
 require_relative 'app'
 
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
 RSpec.configure do |config|
   config.around do |example|
     ActiveRecord::Base.transaction do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breathing
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Akira Kusumoto
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: rubyXL
+  name: hairtrigger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +153,7 @@ homepage: https://github.com/bluerabbit/breathing
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Audit logging for database
 test_files: