hansel-tracking 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49a1d4493cb3c73a3cc84addc62a70bb7249cd23e45e7768f9ed79ca4e6ad699
+  data.tar.gz: 76e9e78e357dcdec9f65a3ba8cdf5bfe18e71bcb414abd3570bbfc119eae57a7
+SHA512:
+  metadata.gz: 45f9ea153ad4bf3f9fb05d236c192fef49d14faa8c62a4f871a88b160d6c5215c43bad00ec307d9ae72e2e524bbbe68b3d7502db2752b6975b2ce377820f64bf
+  data.tar.gz: 80b6a1eb8752cd232f507490af5275e4874045fb521ea3195f8981e507ac9488a701f8ad575b26cb31111a1f525b37d59fb3614d5d8248bd91f8fc023878d013

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Rodolfo Matos
+
+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,39 @@
+[![Build Status](https://travis-ci.org/rodmatos/hansel.svg?branch=master)](https://travis-ci.org/rodmatos/hansel)
+
+# Hansel
+Hansel is tiny library that tracks change to followed models, has support for both syncronous tracking and asynchronous via the different ActiveJob backends that you can plug into your Rails application.
+Currently only supports for PostgreSQL databases.
+
+## Usage
+Import the concern in the models that you wish to track
+```ruby
+class Human < ApplicationRecord
+  include Hansel::Recordable
+end
+```
+And after every change to an `Human` record you can access its states through the `has_many :records` relationship - e.g. `Human.first.records # []`
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hansel'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Generate schema migration:
+```bash
+$ rails generate hansel:install
+```
+
+Migrate your database:
+```bash
+$ rails db:migrate
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Hansel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/hansel/install/install_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Hansel
+  # Generator for the Hansel::Record model
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path('templates', __dir__)
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    def add_hansel_migration
+      migration_template(
+        'create_records.rb.erb',
+        'db/migrate/create_records.rb',
+        migration_version: migration_version
+      )
+    end
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    end
+  end
+end

data/lib/generators/hansel/install/templates/create_records.rb.erb

@@ -0,0 +1,11 @@
+class CreateRecords < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :records do |t|
+      t.json :fields, default: {}
+      t.json :metadata, default: {}
+      t.references :recordable, polymorphic: true, index: true
+      t.references :previous_record, index: true, foreign_key: { to_table: :records }
+      t.datetime :created_at
+    end
+  end
+end

data/lib/hansel.rb

@@ -0,0 +1,4 @@
+require "hansel/railtie"
+require "hansel/models/record"
+require "hansel/concerns/recordable"
+require "hansel/jobs/create_record_job"

data/lib/hansel/concerns/recordable.rb

@@ -0,0 +1,15 @@
+require 'active_support/concern'
+
+# Include Recordable concern in the models that you wish to track
+module Hansel
+  module Recordable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :records, as: :recordable, class_name: 'Hansel::Record'
+      after_commit do
+        CreateRecordJob.perform_later(self.class.name, id, {})
+      end
+    end
+  end
+end

data/lib/hansel/jobs/create_record_job.rb

@@ -0,0 +1,29 @@
+module Hansel
+  module Recordable
+    # CreateRecordJob is responsable for the creation of a new Record
+    class CreateRecordJob < ActiveJob::Base
+      queue_as :default
+
+      def perform(model_name, id, metadata)
+        model = model_name.constantize.find_by_id(id)
+        Hansel::Record.create!(
+          recordable: model,
+          fields: serialize_model(model),
+          metadata: metadata,
+          previous_record: Hansel::Record.where(recordable_id: id).last
+        )
+        # TODO: change the way previous_record is being set, possible race conditions
+      end
+
+      def serialize_model(model)
+        begin
+          serializer_class = "::#{model.class.name}Serializer".constantize
+          serializer = serializer_class.new(model)
+          JSON.parse(serializer.to_json)
+        rescue NameError
+          model.attributes
+        end
+      end
+    end
+  end
+end

data/lib/hansel/models/record.rb

@@ -0,0 +1,7 @@
+module Hansel
+  class Record < ActiveRecord::Base
+    belongs_to :recordable, polymorphic: true
+    belongs_to :previous_record, class_name: "Hansel::Record"
+    validates :fields, presence: true
+  end
+end

data/lib/hansel/railtie.rb

@@ -0,0 +1,4 @@
+module Hansel
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/hansel/version.rb

@@ -0,0 +1,3 @@
+module Hansel
+  VERSION = '0.0.1'
+end

data/lib/tasks/hansel_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :hansel do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: hansel-tracking
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rodolfo Matos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- rod@rodmatos.xyz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/hansel/install/install_generator.rb
+- lib/generators/hansel/install/templates/create_records.rb.erb
+- lib/hansel.rb
+- lib/hansel/concerns/recordable.rb
+- lib/hansel/jobs/create_record_job.rb
+- lib/hansel/models/record.rb
+- lib/hansel/railtie.rb
+- lib/hansel/version.rb
+- lib/tasks/hansel_tasks.rake
+homepage: http://rodmatos.xyz
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Audit gem for Ruby on Rails projects
+test_files: []