breathing 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dd890230542703d28a6dcc8e7b6f1213cabf089027ebddc91280edda54cb322
-  data.tar.gz: e29abf8900cc93a231c8ac1d12763d89bc8719ded8ddcb1fb68f5d7d7de6aa61
+  metadata.gz: 9b0a34aef932a21f7369a766114261c484fcc68cdb32ec50e81c721da2f13d0a
+  data.tar.gz: eb6c8c5370a13e422674c9256032eeb650a4a58e018eed78f33c234a7a9cbc41
 SHA512:
-  metadata.gz: 8ebf6e138f187609e34aee5f26f16b33a94efd98afb248a69c43286e4fe00e8496b176d8b3d8baa2a6dd59485b8ea7958dd1982c4ee329475f3bef04de1b3b86
-  data.tar.gz: 798a892f5c78b97b4b7b7b61c6de09c74488953476901cd640da8e77e90d436d909e4873b9bc99f36f8d42db7ab53adf1a8fc7bad1be117e82f11af5432e36ad
+  metadata.gz: 91a00104ce4496d7250df3664624cd3cd5fb1b6af4d48f57445fbd7f0e798a4e4dd2003d0a2cfc3b1bc1e31d4729971abcfc0086701208a37b1a1975522527da
+  data.tar.gz: 4dc36063b0e355d5f245660136b2c439bacf16bf2da61fe899ee05b19a51f17c09e2036e1f6aa4505671c1f89cd4f4c637f0f58baf1adf0d1776bf6379594ccf

data/.circleci/config.yml

@@ -0,0 +1,53 @@
+version: 2.1
+
+executors:
+  default:
+    working_directory: ~/app
+    docker:
+      - image: circleci/ruby:2.6
+        environment:
+          DB_USER: 'root'
+          DB_PASS: 'root'
+          DB_HOST: '127.0.0.1'
+      - image: circleci/mysql:8-ram
+        environment:
+          MYSQL_USER: root
+          MYSQL_ROOT_PASSWORD: root
+          MYSQL_DATABASE: breathing_test
+        command: [--default-authentication-plugin=mysql_native_password]
+
+commands:
+  setup_bundle:
+    steps:
+      - restore_cache:
+          key: bundle-{{ checksum "breathing.gemspec" }}
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          key: bundle-{{ checksum "breathing.gemspec" }}
+          paths:
+          - vendor/bundle
+
+  wait_for_db:
+    steps:
+      - run:
+          name: Wait for DB
+          command: dockerize -wait tcp://127.0.0.1:3306 -timeout 1m
+
+jobs:
+  test:
+    executor: default
+    steps:
+      - checkout
+      - setup_bundle
+      - wait_for_db
+      - run: bundle exec rspec ./spec
+
+workflows:
+  version: 2
+
+  test:
+    jobs:
+      - test

data/README.md

@@ -28,9 +28,9 @@ Just run the following command.
 
 - Create table `change_logs`
 - Create triggers
-    - breathing_insert_{table_name}
-    - breathing_update_{table_name}
-    - breathing_delete_{table_name}
+    - change_logs_insert_{table_name}
+    - change_logs_update_{table_name}
+    - change_logs_delete_{table_name}
 
 ### Uninstall
 
@@ -40,7 +40,17 @@ Cleanup command.
 % DATABASE_URL="mysql2://user:pass@host:port/database" breathing uninstall
 ```
 
-- Drop table `change_logs` and triggers
+- Drop table `change_logs`
+- Drop triggers
+    - change_logs_insert_{table_name}
+    - change_logs_update_{table_name}
+    - change_logs_delete_{table_name}
+
+### export
+
+```
+% DATABASE_URL="mysql2://user:pass@host:port/database" breathing export
+```
 
 ## Copyright
 

data/breathing.gemspec

@@ -2,13 +2,13 @@ $:.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'breathing'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Akira Kusumoto']
   s.email       = ['akirakusumo10@gmail.com']
   s.homepage    = 'https://github.com/bluerabbit/breathing'
-  s.summary     = 'audit logging for database'
-  s.description = 'audit logging for database'
+  s.summary     = 'Audit logging for database'
+  s.description = 'Audit logging for database'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -21,6 +21,7 @@ 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_development_dependency 'mysql2'
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rspec', '~> 3.9'

data/lib/breathing.rb

@@ -1,3 +1,35 @@
-class Breathing
+require 'active_record'
+require 'breathing/installer'
+require 'breathing/trigger'
+require 'breathing/change_log'
+require 'breathing/excel'
+
+module Breathing
   VERSION = Gem.loaded_specs['breathing'].version.to_s
+
+  class << self
+    def install
+      establish_connection
+      Breathing::Installer.new.install
+    end
+
+    def uninstall
+      establish_connection
+      Breathing::Installer.new.uninstall
+    end
+
+    def clear
+      establish_connection
+      Breathing::ChangeLog.delete_all
+    end
+
+    def export
+      establish_connection
+      Breathing::Excel.new.create
+    end
+
+    def establish_connection
+      ActiveRecord::Base.establish_connection(url: ENV['DATABASE_URL'])
+    end
+  end
 end

data/lib/breathing/change_log.rb

@@ -0,0 +1,16 @@
+require 'active_record'
+
+module Breathing
+  class ChangeLog < ActiveRecord::Base
+    def changed_attribute_columns
+      before_data.each.with_object([]) do |(column, value), columns|
+        columns << column if after_data[column] != value
+      end
+    end
+
+    def data_column_names
+      names = before_data.keys.present? ? before_data.keys : after_data.keys
+      names.reject { |name| name == 'id' }
+    end
+  end
+end

data/lib/breathing/cli.rb

@@ -1,9 +1,29 @@
 require 'thor'
 require 'breathing'
 
-class Breathing
+module Breathing
   class Cli < Thor
-    default_command :version
+    default_command :install
+
+    desc 'install', 'Create table change_logs and create triggers'
+    def install
+      Breathing.install
+    end
+
+    desc 'uninstall', 'Drop table change_logs and drop triggers'
+    def uninstall
+      Breathing.uninstall
+    end
+
+    desc 'clear', 'Delete all records in change_logs table'
+    def clear
+      Breathing.clear
+    end
+
+    desc 'export', 'output xlsx'
+    def export
+      Breathing.export
+    end
 
     desc 'version', 'Show Version'
     def version

data/lib/breathing/excel.rb

@@ -0,0 +1,74 @@
+require 'rubyXL'
+require 'rubyXL/convenience_methods'
+require 'breathing'
+
+module Breathing
+  class Excel
+    def initialize
+      @workbook = RubyXL::Workbook.new
+    end
+
+    def create(id: 1, file_name: 'breathing.xlsx')
+      sheet       = @workbook[0]
+      table_names = Breathing::ChangeLog.where('id >= ?', id).group(:table_name).pluck(:table_name)
+      table_names.each do |table_name|
+        if sheet.sheet_name == 'Sheet1'
+          sheet.sheet_name = table_name
+        else
+          sheet = @workbook.add_worksheet(table_name)
+        end
+
+        rows = Breathing::ChangeLog.where(table_name: table_name).where('id >= ?', id).order(:id)
+
+        if first_row = rows.first
+          add_header_row(sheet, first_row)
+        end
+        add_body_rows(sheet, rows)
+        add_style(sheet)
+      end
+
+      @workbook.write(file_name)
+    end
+
+    private
+
+    def add_header_row(sheet, row)
+      sheet.add_cell(0, 0, 'change_logs.id').change_font_bold(true)
+      sheet.add_cell(0, 1, 'action').change_font_bold(true)
+      sheet.add_cell(0, 2, 'id').change_font_bold(true)
+      row.data_column_names.each.with_index(3) do |column_name, i|
+        sheet.add_cell(0, i, column_name).change_font_bold(true)
+      end
+    end
+
+    def add_body_rows(sheet, rows)
+      rows.each.with_index(1) do |row, i|
+        sheet.add_cell(i, 0, row.id)
+        sheet.add_cell(i, 1, row.action)
+        sheet.add_cell(i, 2, row.transaction_id)
+        row.data_column_names.each.with_index(3) do |column_name, j|
+          data        = row.action == 'DELETE' ? row.before_data : row.after_data
+          cell_object = sheet.add_cell(i, j, data[column_name])
+          if row.action == 'UPDATE' && column_name != 'updated_at' && row.changed_attribute_columns.include?(column_name)
+            cell_object.change_fill('ffff00') # color: yellow
+          elsif row.action == 'DELETE'
+            cell_object.change_fill('d9d9d9') # color: grey
+          end
+        end
+      end
+    end
+
+    def add_style(sheet)
+      sheet.sheet_data.rows.each.with_index do |row, i|
+        row.cells.each do |cell|
+          %i[top bottom left right].each do |direction|
+            cell.change_border(direction, 'thin')
+          end
+
+          cell.change_border(:bottom, 'medium') if i.zero?
+        end
+      end
+      sheet.change_row_horizontal_alignment(0, 'center')
+    end
+  end
+end

data/lib/breathing/installer.rb

@@ -0,0 +1,71 @@
+require 'active_record'
+require 'breathing'
+require 'breathing/trigger'
+require 'breathing/change_log'
+
+module Breathing
+  class Installer
+    def install
+      create_log_table unless log_table_exists?
+
+      models.each do |model|
+        column_names = model.columns.map(&:name)
+        if column_names.include?('id') && column_names.include?('updated_at')
+          Breathing::Trigger.new(model, log_table_name).create
+        end
+      end
+    end
+
+    def uninstall
+      drop_log_table if log_table_exists?
+
+      models.each { |model| Breathing::Trigger.new(model, log_table_name).drop }
+    end
+
+    private
+
+    def log_table_name
+      Breathing::ChangeLog.table_name
+    end
+
+    def create_log_table(table_name: log_table_name)
+      ActiveRecord::Schema.define version: 0 do
+        create_table table_name, force: false do |t|
+          t.string :action, null: false
+          t.string :table_name, null: false
+          t.string :transaction_id, null: false
+          t.json :before_data, null: false
+          t.json :after_data, null: false
+          t.datetime :created_at, null: false, index: true
+          t.index %w[table_name transaction_id]
+        end
+      end
+    end
+
+    def drop_log_table
+      sql = "DROP TABLE #{log_table_name}"
+      puts sql
+      ActiveRecord::Base.connection.execute(sql)
+    end
+
+    def log_table_exists?
+      ActiveRecord::Base.connection.table_exists?(log_table_name)
+    end
+
+    def models
+      ignores = %w[schema_migrations ar_internal_metadata] << log_table_name
+
+      ActiveRecord::Base.connection.tables.each do |table_name|
+        next if ignores.include?(table_name) || Object.const_defined?(table_name.classify)
+
+        eval <<-EOS
+          class #{table_name.classify} < ActiveRecord::Base
+            self.table_name = :#{table_name}
+          end
+        EOS
+      end
+
+      ActiveRecord::Base.descendants.reject(&:abstract_class).reject { |m| ignores.include? m.table_name }
+    end
+  end
+end

data/lib/breathing/trigger.rb

@@ -0,0 +1,100 @@
+require 'active_record'
+require 'breathing/change_log'
+
+module Breathing
+  class Trigger
+    attr_reader :model, :log_table_name
+
+    def initialize(model, log_table_name)
+      @model          = model
+      @log_table_name = log_table_name
+    end
+
+    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`)
+          VALUES ('INSERT', '#{model.table_name}', NEW.id,
+                  JSON_OBJECT(),
+                  JSON_OBJECT(#{json_object_values(model.columns, 'NEW')}),
+                  CURRENT_TIMESTAMP);
+        END;
+        SQL
+      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`)
+              VALUES ('UPDATE', '#{model.table_name}', NEW.id,
+                      JSON_OBJECT(#{json_object_values(model.columns, 'OLD')}),
+                      JSON_OBJECT(#{json_object_values(model.columns, 'NEW')}),
+                      CURRENT_TIMESTAMP);
+          end if;
+        END;
+        SQL
+      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(),
+                  CURRENT_TIMESTAMP);
+        END;
+        SQL
+      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}"
+          puts sql
+          ActiveRecord::Base.connection.execute(sql)
+        rescue StandardError => e
+          puts "#{e.message} trigger_name:#{trigger_name}"
+        end
+      end
+    end
+
+    private
+
+    def exists?(trigger_name)
+      @trigger_names ||= ActiveRecord::Base.connection.select_rows('SHOW TRIGGERS').map { |row| row.first }
+      @trigger_names.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(',')
+    end
+  end
+end

data/spec/app.rb

@@ -11,7 +11,15 @@ ActiveRecord::Schema.define version: 0 do
     t.integer :age, null: false
     t.timestamps null: false
   end
+
+  create_table :departments, force: true do |t|
+    t.string :name, null: false
+    t.timestamps null: false
+  end
 end
 
 class User < ActiveRecord::Base
 end
+
+class Department < ActiveRecord::Base
+end

data/spec/breathing/excel_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Breathing::Excel do
+  describe '#create' do
+    before { Breathing::Installer.new.install }
+    after { Breathing::Installer.new.uninstall }
+
+    it do
+      user = User.create!(name: 'a', age: 20)
+      user.update!(age: 21)
+      user.destroy!
+      expect(Breathing::ChangeLog.count).to eq(3)
+
+      Tempfile.open(['tmp', '.xlsx']) do |file|
+        Breathing::Excel.new.create(file_name: file.path)
+        workbook = RubyXL::Parser.parse(file.path)
+        expect(workbook.sheets[0].name).to eq('users')
+        user_sheet = workbook.worksheets[0]
+        expect(user_sheet.sheet_data.size).to eq(Breathing::ChangeLog.where(table_name: :users).count + 1)
+      end
+    end
+
+    it 'multi sheets' do
+      User.create!(name: 'a', age: 20)
+      Department.create!(name: 'a')
+
+      Tempfile.open(['tmp', '.xlsx']) do |file|
+        Breathing::Excel.new.create(file_name: file.path)
+        workbook = RubyXL::Parser.parse(file.path)
+        expect(workbook.sheets.size).to eq(2)
+      end
+    end
+  end
+end

data/spec/breathing_spec.rb

@@ -4,4 +4,37 @@ describe Breathing do
   it 'has a version number' 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({})
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breathing
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Akira Kusumoto
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.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: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: audit logging for database
+description: Audit logging for database
 email:
 - akirakusumo10@gmail.com
 executables:
@@ -88,6 +102,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - MIT-LICENSE
@@ -96,8 +111,13 @@ files:
 - breathing.gemspec
 - exe/breathing
 - lib/breathing.rb
+- lib/breathing/change_log.rb
 - lib/breathing/cli.rb
+- lib/breathing/excel.rb
+- lib/breathing/installer.rb
+- lib/breathing/trigger.rb
 - spec/app.rb
+- spec/breathing/excel_spec.rb
 - spec/breathing_spec.rb
 - spec/database.yml
 - spec/spec_helper.rb
@@ -123,9 +143,10 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
-summary: audit logging for database
+summary: Audit logging for database
 test_files:
 - spec/app.rb
+- spec/breathing/excel_spec.rb
 - spec/breathing_spec.rb
 - spec/database.yml
 - spec/spec_helper.rb