breathing 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62878c327e1da216456749f0d3d3b154a4d8d11528226f90cc7dadf855d2e6f2
-  data.tar.gz: 7a27d00aca80c0a3837d1bfc7778ee1d507c2deb7719127a53745a86f25aa439
+  metadata.gz: 78f7bd77e2aacd87fe91b8e42eeb8dd590fac1a067c90c092a8069fa9d2a391f
+  data.tar.gz: cb6802aa877aa675fe62170d7d3fde082b1262439c33409a5a38169c90a05c8e
 SHA512:
-  metadata.gz: 86f14f92c0a6b4953307c6a733daf0c378726f0e3d9f97703c29ff3e34ead58568b4b3d0d62ddd2cd34da40b6d1056cc6a6e1b096030276d6313745844a25998
-  data.tar.gz: 51cb295e2097b87d2ba21faf62495087a5cae5a7db695e7703e219cbde57f883b4f776d39ca68258299ba6f33347c1bca3ce1608580b27f5a2e251f978c3c86f
+  metadata.gz: 1610bf010d660a7f0c1f00ed61b3235e75497220ef2b21c0f9a5c200b2c670c8495cbf905b782c7202f0236549e086296141d6e3d1b5fd1c24684d3a3af69335
+  data.tar.gz: 22d2262edfd99554875fbbaec0edac113c5e970a41f32126f7ebf18cc7b141987f9c58b1da1c02f4c1257e8f07a07e4a9a269c8876f6957bcc10cbac3767b161

data/README.md

@@ -6,7 +6,7 @@ Logging mechanism using database triggers to store the old and new row states in
 ## Install
 
 ```
-gem install 'breathing'
+gem install breathing
 ```
 
 ## Usage
@@ -49,6 +49,30 @@ Cleanup command.
 
 - Output file `breathing.xlsx`
 
+### out
+
+```
+% DATABASE_URL="mysql2://user:pass@host:port/database" breathing out --table users --id 1
+```
+
+```
++----------------+------------------------+--------+----+-----+------+----------------------------+----------------------------+
+|                                                            users                                                             |
++----------------+------------------------+--------+----+-----+------+----------------------------+----------------------------+
+| change_logs.id | change_logs.created_at | action | id | age | name | created_at                 | updated_at                 |
++----------------+------------------------+--------+----+-----+------+----------------------------+----------------------------+
+| 1              | 2020-12-18 22:43:32    | INSERT | 10  | 20  | a    | 2020-12-18 13:43:32.316923 | 2020-12-18 13:43:32.316923 |
+| 2              | 2020-12-18 22:43:32    | UPDATE | 10  | 21  | a    | 2020-12-18 13:43:32.316923 | 2020-12-18 13:43:32.319706 |
+| 3              | 2020-12-18 22:43:32    | DELETE | 10  | 21  | a    | 2020-12-18 13:43:32.316923 | 2020-12-18 13:43:32.319706 |
++----------------+------------------------+--------+----+-----+------+----------------------------+----------------------------+
+```
+
+### tail
+
+```
+% DATABASE_URL="mysql2://user:pass@host:port/database" breathing tail --table users --id 1
+```
+
 ## Compatibility
 
 - Ruby 2.3.0+

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.4'
+  s.version     = '0.0.9'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Akira Kusumoto']
   s.email       = ['akirakusumo10@gmail.com']
@@ -20,10 +20,11 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.add_runtime_dependency 'thor'
 
-  s.add_dependency 'activerecord', ['>= 5.0.0']
+  s.add_dependency 'activerecord', ['>= 6.0.0']
   s.add_dependency 'hairtrigger'
   s.add_dependency 'mysql2'
   s.add_dependency 'pg'
+  s.add_dependency 'terminal-table'
   s.add_dependency 'rubyXL', ['>= 3.4.0']
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rspec', '~> 3.9'

data/lib/breathing.rb

@@ -4,6 +4,7 @@ require 'breathing/installer'
 require 'breathing/trigger'
 require 'breathing/change_log'
 require 'breathing/excel'
+require 'breathing/terminal_table'
 
 module Breathing
   VERSION = Gem.loaded_specs['breathing'].version.to_s
@@ -28,5 +29,24 @@ module Breathing
       ActiveRecord::Base.establish_connection
       Breathing::Excel.new.create
     end
+
+    def render_terminal_table(table_name:, id: 1)
+      ActiveRecord::Base.establish_connection
+      puts Breathing::TerminalTable.new(table_name).render(id: id)
+    end
+
+    def tail_f(table_name:, id: 1)
+      ActiveRecord::Base.establish_connection
+      table = Breathing::TerminalTable.new(table_name)
+
+      loop do
+        text = table.render(id: id)
+        if text.present?
+          puts text
+          id = table.last_id + 1
+        end
+        sleep 5
+      end
+    end
   end
 end

data/lib/breathing/change_log.rb

@@ -12,5 +12,39 @@ module Breathing
       names = before_data.keys.present? ? before_data.keys : after_data.keys
       names.reject { |name| name == 'id' }
     end
+
+    def data
+      action == 'DELETE' ? before_data : after_data
+    end
+
+    def data_attributes
+      data_column_names.each.with_object('change_logs.id'         => id,
+                                         'change_logs.created_at' => created_at.to_s(:db),
+                                         'action'                 => action,
+                                         'id'                     => transaction_id) do |name, hash|
+        hash[name] = data[name]
+      end
+    end
+
+    def diff
+      return nil if action != 'UPDATE'
+
+      changed_attribute_columns.each.with_object({}) do |column_name, diff_hash|
+        diff_hash[column_name] = {before_data[column_name] => after_data[column_name]}
+      end
+    end
+
+    def attributes_for_excel
+      {
+        'change_logs.id' => id,
+        'created_at'     => created_at.to_s(:db),
+        'table_name'     => table_name,
+        'action'         => action,
+        'id'             => transaction_id,
+        'diff'           => diff.to_s,
+        'before_data'    => before_data.to_s,
+        'after_data'     => after_data.to_s,
+      }
+    end
   end
 end

data/lib/breathing/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'thor'
 require 'breathing'
 
@@ -6,26 +7,51 @@ module Breathing
     default_command :export
 
     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 'out', 'output stdout'
+    method_option :type, aliases: '-t', default: 'terminal_table', type: :string
+    method_option :table, type: :string, required: true
+    method_option :id, default: 1, type: :numeric
+    def out
+      if options[:table] == 'terminal_table'
+        Breathing.render_terminal_table(table_name: options[:table], id: options[:id].to_i)
+      else
+        # TODO
+        # Breathing.export(table_name: options[:table], id: options[:id].to_i)
+      end
+    end
+
+    desc 'tail', 'tail terminal_table'
+    method_option :table, type: :string, required: true
+    method_option :id, default: 1, type: :numeric
+    def tail
+      Breathing.tail_f(table_name: options[:table], id: options[:id].to_i)
+    end
+
     desc 'version', 'Show Version'
+
     def version
       say "Version: #{Breathing::VERSION}"
     end

data/lib/breathing/excel.rb

@@ -11,64 +11,82 @@ module Breathing
     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|
+      table_names.sort.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)
+        rows = Breathing::ChangeLog.where(table_name: table_name).where('id >= ?', id).order(:id).to_a
 
-        if first_row = rows.first
-          add_header_row(sheet, first_row)
-        end
+        next if rows.size.zero?
+
+        add_header_row(sheet, rows.first)
         add_body_rows(sheet, rows)
         add_style(sheet)
       end
 
+      add_change_logs_sheet(id) if table_names.size.positive?
+
       @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)
+      header_color = 'ddedf3' # blue
+      row.data_attributes.keys.each.with_index do |header_column, column_index|
+        cell = sheet.add_cell(0, column_index, header_column)
+        cell.change_fill(header_color)
       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])
+      rows.each.with_index(1) do |row, row_number|
+        row.data_attributes.each.with_index do |(column_name, value), column_index|
+          cell = sheet.add_cell(row_number, column_index, value)
           if row.action == 'UPDATE' && column_name != 'updated_at' && row.changed_attribute_columns.include?(column_name)
-            cell_object.change_fill('ffff00') # color: yellow
+            cell.change_fill('ffff00') # color: yellow
           elsif row.action == 'DELETE'
-            cell_object.change_fill('d9d9d9') # color: grey
+            cell.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|
+      sheet.sheet_data.rows.each.with_index do |row, row_index|
+        row.cells.each.with_index do |cell, column_index|
           %i[top bottom left right].each do |direction|
             cell.change_border(direction, 'thin')
           end
+          cell.change_border(:bottom, 'double') if row_index.zero?
 
-          cell.change_border(:bottom, 'medium') if i.zero?
+          cell_width = cell.value.to_s.size + 2
+          sheet.change_column_width(column_index, cell_width) if cell_width > sheet.get_column_width(column_index)
         end
       end
+
       sheet.change_row_horizontal_alignment(0, 'center')
     end
+
+    def add_change_logs_sheet(id)
+      sheet = @workbook.add_worksheet(Breathing::ChangeLog.table_name)
+
+      change_logs = Breathing::ChangeLog.where('id >= ?', id).order(:id)
+      change_logs.first.attributes_for_excel.keys.each.with_index do |header_column, column_index|
+        cell = sheet.add_cell(0, column_index, header_column)
+        cell.change_fill('ddedf3') # blue
+      end
+
+      change_logs.each.with_index(1) do |change_log, row_number|
+        change_log.attributes_for_excel.each.with_index do |(_column_name, value), column_index|
+          sheet.add_cell(row_number, column_index, value)
+        end
+      end
+
+      add_style(sheet)
+    end
   end
 end

data/lib/breathing/installer.rb

@@ -8,9 +8,9 @@ module Breathing
 
   class Installer
     def install
-      raise Breathing::UnsupportedError, "Version MySQL 5.6 is not supported." unless database_version_valid?
+      raise Breathing::UnsupportedError, "Version MySQL 5.6 is not supported." unless database_supported_version?
 
-      create_log_table unless log_table_exists?
+      create_log_table
 
       models.each do |model|
         column_names = model.columns.map(&:name)
@@ -21,14 +21,13 @@ module Breathing
     end
 
     def uninstall
-      drop_log_table if log_table_exists?
-
+      drop_log_table
       models.each { |model| Breathing::Trigger.new(model, log_table_name).drop }
     end
 
     private
 
-    def database_version_valid?
+    def database_supported_version?
       connection = ActiveRecord::Base.connection
       connection.adapter_name == "PostgreSQL" || (connection.adapter_name == 'Mysql2' && connection.raw_connection.info[:version].to_f >= 5.7)
     end
@@ -39,26 +38,22 @@ module Breathing
 
     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
+        create_table table_name, if_not_exists: true do |t|
+          t.datetime :created_at,     null: false, index: true
+          t.string   :table_name,     null: false
+          t.string   :action,         null: false
+          t.string   :transaction_id, null: false
+          t.json     :before_data,    null: false
+          t.json     :after_data,     null: false
+
           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)
+      puts "DROP TABLE #{log_table_name}"
+      ActiveRecord::Base.connection.drop_table(log_table_name, if_exists: true)
     end
 
     def models

data/lib/breathing/terminal_table.rb

@@ -0,0 +1,30 @@
+require 'breathing'
+require 'terminal-table'
+
+module Breathing
+  class TerminalTable
+    attr_reader :last_id
+
+    def initialize(table_name)
+      @last_id    = 1
+      @table_name = table_name
+    end
+
+    def render(id: 1)
+      rows = Breathing::ChangeLog.where(table_name: @table_name).where("id >= ? ", id).order(:id)
+
+      return if rows.size.zero?
+
+      @table = Terminal::Table.new(title:    rows.first.table_name,
+                                   headings: rows.first.data_attributes.keys,
+                                   rows:     rows.map { |row| row.data_attributes.values })
+
+      @last_id = rows.last.id
+      @table.to_s
+    end
+
+    def rows
+      @table.rows
+    end
+  end
+end

data/lib/breathing/trigger.rb

@@ -11,59 +11,25 @@ module Breathing
     end
 
     def create
-      trigger_name = "#{log_table_name}_insert_#{model.table_name}"
-
-      unless exists?(trigger_name)
-        puts "CREATE TRIGGER #{trigger_name}"
+      exists_trigger_names = ActiveRecord::Base.connection.triggers.keys
 
-        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,
-                  '{}',
-                  #{row_to_json(model.columns, 'NEW')},
-                  CURRENT_TIMESTAMP);
-          SQL
-        end
-      end
+      trigger_name = "#{log_table_name}_insert_#{model.table_name}"
+      create_insert_trigger(trigger_name, model) if exists_trigger_names.exclude?(trigger_name)
 
       trigger_name = "#{log_table_name}_update_#{model.table_name}"
-      unless exists?(trigger_name)
-        puts "CREATE TRIGGER #{trigger_name}"
-
-        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,
-                      #{row_to_json(model.columns, 'OLD')},
-                      #{row_to_json(model.columns, 'NEW')},
-                      CURRENT_TIMESTAMP);
-          SQL
-        end
-      end
+      create_update_trigger(trigger_name, model) if exists_trigger_names.exclude?(trigger_name)
 
       trigger_name = "#{log_table_name}_delete_#{model.table_name}"
-      unless exists?(trigger_name)
-        puts "CREATE TRIGGER #{trigger_name}"
-        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);
-          SQL
-        end
-      end
+      create_delete_trigger(trigger_name, model) if exists_trigger_names.exclude?(trigger_name)
     end
 
     def drop
-      %w[insert update delete].each do |action|
-        trigger_name = "#{log_table_name}_#{action}_#{model.table_name}"
+      trigger_names = %w[insert update delete].map { |action| "#{log_table_name}_#{action}_#{model.table_name}" }
 
+      trigger_names.each do |trigger_name|
         begin
           sql = "DROP TRIGGER IF EXISTS #{trigger_name}"
-          if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+          if postgresql?
             sql << " ON #{model.table_name} CASCADE;"
             sql << " DROP FUNCTION IF EXISTS #{trigger_name} CASCADE;"
           end
@@ -77,12 +43,50 @@ module Breathing
 
     private
 
-    def exists?(trigger_name)
-      ActiveRecord::Base.connection.triggers.keys.include?(trigger_name)
+    def postgresql?
+      ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+    end
+
+    def create_trigger(name)
+      puts "CREATE TRIGGER #{name}"
+      ActiveRecord::Base.connection.create_trigger(name) # hairtrigger gem
+    end
+
+    def create_insert_trigger(trigger_name, model)
+      create_trigger(trigger_name).on(model.table_name).after(:insert) do
+        <<-SQL
+          INSERT INTO #{log_table_name} (created_at, action, table_name, transaction_id, before_data, after_data)
+          VALUES (CURRENT_TIMESTAMP, 'INSERT', '#{model.table_name}', NEW.id,
+                  '{}',
+                  #{row_to_json(model.columns, 'NEW')});
+        SQL
+      end
+    end
+
+    def create_update_trigger(trigger_name, model)
+      create_trigger(trigger_name).on(model.table_name).before(:update).of(:updated_at) do
+        <<-SQL
+          INSERT INTO #{log_table_name} (created_at, action, table_name, transaction_id, before_data, after_data)
+              VALUES (CURRENT_TIMESTAMP, 'UPDATE', '#{model.table_name}', NEW.id,
+                      #{row_to_json(model.columns, 'OLD')},
+                      #{row_to_json(model.columns, 'NEW')});
+        SQL
+      end
+    end
+
+    def create_delete_trigger(trigger_name, model)
+      create_trigger(trigger_name).on(model.table_name).after(:delete) do
+        <<-SQL
+           INSERT INTO #{log_table_name} (created_at, action, table_name, transaction_id, before_data, after_data)
+           VALUES (CURRENT_TIMESTAMP, 'DELETE', '#{model.table_name}', OLD.id,
+                  #{row_to_json(model.columns, 'OLD')},
+                  '{}');
+        SQL
+      end
     end
 
     def row_to_json(columns, state)
-      if ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+      if postgresql?
         "row_to_json(#{state}.*)"
       else
         json_object_values = columns.each.with_object([]) do |column, array|

data/spec/breathing/excel_spec.rb

@@ -23,13 +23,18 @@ describe Breathing::Excel do
     end
 
     it 'multi sheets' do
-      User.create!(name: 'a', age: 20)
+      user = User.create!(name: 'a', age: 20)
+      user.update!(age: 21)
+      user.destroy!
       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)
+        expect(workbook.sheets.map(&:name)).to eq(%w[departments users change_logs])
+        change_logs_sheet = workbook.worksheets.last
+
+        expect(change_logs_sheet.sheet_data.size).to eq(Breathing::ChangeLog.count + 1)
       end
     end
   end

data/spec/breathing/terminal_table_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Breathing::TerminalTable do
+  describe '#render' do
+    before { Breathing::Installer.new.install }
+    after do
+      Breathing::Installer.new.uninstall if ActiveRecord::Base.connection.adapter_name == "Mysql2"
+    end
+
+    it do
+      user = User.create!(name: 'a', age: 20)
+      user.update!(age: 21)
+      user.destroy!
+      expect(Breathing::ChangeLog.count).to eq(3)
+
+      table = Breathing::TerminalTable.new(:users)
+      puts table.render(id: 1)
+
+      expect(table.rows.size).to eq(3)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breathing
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.9
 platform: ruby
 authors:
 - Akira Kusumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: hairtrigger
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  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
@@ -143,9 +157,11 @@ files:
 - lib/breathing/cli.rb
 - lib/breathing/excel.rb
 - lib/breathing/installer.rb
+- lib/breathing/terminal_table.rb
 - lib/breathing/trigger.rb
 - spec/app.rb
 - spec/breathing/excel_spec.rb
+- spec/breathing/terminal_table_spec.rb
 - spec/breathing_spec.rb
 - spec/database.yml
 - spec/spec_helper.rb
@@ -175,6 +191,7 @@ summary: Audit logging for database
 test_files:
 - spec/app.rb
 - spec/breathing/excel_spec.rb
+- spec/breathing/terminal_table_spec.rb
 - spec/breathing_spec.rb
 - spec/database.yml
 - spec/spec_helper.rb