log_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a3bac03cb5e151d6994bfbcddcf876d6d1ff4bb
+  data.tar.gz: d8197dba004608c3f58e82f2ad2254dd33f9666e
+SHA512:
+  metadata.gz: 8533007d4d2f356397df004ddfadca193bf83112878d4f889f5e374ba0dcd09d6cc87aa5c2b0ad08b9822d0d2d25eddce640cef12df126ee4a63a13dad55b6a9
+  data.tar.gz: e1b55ac03f7fa8d1353e10bc4cf3957777b034d4a3e17bf26997b271d9daff8a7bd469a28430d7c6e725c40686b429df326e593006c86663c4410e8ca4d965c5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+.byebug_history

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in log_table.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Daisuke Shimamoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# LogTable
+
+The LogTable gem will read your Active Record model and generate a  table to store logs to.
+It will additionally create triggers which will do the actual saving into the log table.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log_table'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log_table
+
+## Usage
+
+WIP
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/diskshima/log_table. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "log_table"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/log_table/version.rb

@@ -0,0 +1,3 @@
+module LogTable
+  VERSION = "0.1.0"
+end

data/lib/log_table.rb

@@ -0,0 +1,47 @@
+#
+# log_table.rb
+# Copyright (C) 2015 Daisuke Shimamoto <diskshima@gmail.com>
+#
+# Distributed under terms of the MIT license.
+#
+
+require 'log_table/version'
+require 'hairtrigger'
+
+module LogTable
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    ##
+    # add_log_trigger will add hairtrigger triggers to the model.
+    # It will generate triggers for :insert and :update.
+    #
+    # Options:
+    #
+    # - :table_name - Specify table name of the log table.
+    #
+    def add_log_trigger(options = {})
+      col_names = column_names
+
+      db_columns = col_names.map { |col_name|
+        col_name == 'id' ? "#{name.underscore}_id" : "#{col_name}"
+      }.join(', ')
+
+      values = col_names.map { |col| "NEW.#{col}" }.join(', ')
+
+      log_table_name = options[:table_name] || "#{table_name}_log"
+
+      insert_sql = "INSERT INTO #{log_table_name}(#{db_columns}) VALUES (#{values})"
+
+      trigger.after(:insert) do
+        insert_sql
+      end
+
+      trigger.after(:update) do
+        insert_sql
+      end
+    end
+  end
+end

data/lib/tasks/db/generate_log_table.rake

@@ -0,0 +1,57 @@
+require 'ostruct'
+require 'erb'
+
+namespace :db do
+  desc 'Create a database migration for log tables'
+  task generate_log_table: :environment do
+    args = ENV['MODEL']
+
+    unless args
+      $stderr.puts 'Please specify at the model with MODEL=CamelCaseModelName'
+      next
+    end
+
+    models = args.split(',')
+    clazzes = models.map { |model_name| Object.const_get(model_name) }
+
+    if clazzes.any? { |clazz| !(clazz < ActiveRecord::Base) }
+      $stderr.puts 'The models must be an ActiveRecord model.'
+      next
+    end
+
+    migration_with_action = 'create_log_tables'
+    file_name = ActiveRecord::Migration.next_migration_number(0) + '_' + migration_with_action + '.rb'
+
+    ns = OpenStruct.new
+    ns.tables = []
+    ns.migration_class_name = migration_with_action.camelize
+
+    clazzes.each do |clazz|
+      tables = ns.tables
+      table = OpenStruct.new
+      table.model_id_col_name = "#{clazz.name.underscore}_id"
+
+      table.attributes = clazz.columns.map do |col|
+        if col.name == 'id'
+          OpenStruct.new(name: table.model_id_col_name, type: :integer)
+        else
+          col
+        end
+      end
+
+      table.name = "#{clazz.table_name}_log"
+      tables << table
+    end
+
+    file_path = File.join('db', 'migrate', file_name)
+    template_file_path = File.join(File.dirname(__FILE__), 'templates',
+      'create_log_table.erb')
+    template_file = File.read(template_file_path)
+
+    File.open(file_path, 'w') do |f|
+      erb_binding = ns.instance_eval { binding }
+      f.write ERB.new(template_file, nil, '-').result(erb_binding)
+    end
+    puts "Written to #{file_path}"
+  end
+end

data/lib/tasks/db/generate_log_trigger_migration.rake

@@ -0,0 +1,22 @@
+namespace :db do
+  desc 'Create a migration to generate log triggers'
+  task generate_log_trigger_migration: :environment do
+    args = ENV['MODEL']
+
+    models = args.split(',')
+    clazzes = models.map { |model_name| Object.const_get(model_name) }
+
+    clazzes.each do |clazz|
+      include_log_triggers(clazz)
+    end
+
+    Rake::Task['db:generate_trigger_migration'].invoke
+  end
+
+  def include_log_triggers(clazz)
+    clazz.class_eval do
+      include LogTable
+      add_log_trigger
+    end
+  end
+end

data/lib/tasks/db/templates/create_log_table.erb

@@ -0,0 +1,13 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+<% tables.each do |table| %>
+    create_table :<%= table.name %> do |t|
+<% table.attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+    end
+
+    add_index :<%= table.name %>, :<%= table.model_id_col_name %>
+<% end %>
+  end
+end

data/log_table.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log_table/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'log_table'
+  spec.version       = LogTable::VERSION
+  spec.authors       = ['Daisuke Shimamoto']
+  spec.email         = ['diskshima@gmail.com']
+
+  spec.summary       = %q{Creates a migration for a log table and triggers}
+  spec.description   = %q{log_table creates a log table for the given Active Record model and triggers to write into it.}
+  spec.homepage      = 'https://github.com/diskshima/log_table'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hairtrigger', '~> 0.2.16'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'm', '~> 1.4'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: log_table
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daisuke Shimamoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hairtrigger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: log_table creates a log table for the given Active Record model and triggers
+  to write into it.
+email:
+- diskshima@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/log_table.rb
+- lib/log_table/version.rb
+- lib/tasks/db/generate_log_table.rake
+- lib/tasks/db/generate_log_trigger_migration.rake
+- lib/tasks/db/templates/create_log_table.erb
+- log_table.gemspec
+homepage: https://github.com/diskshima/log_table
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Creates a migration for a log table and triggers
+test_files: []
+has_rdoc: