data_snapshots 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 583f6e7d574b9396d4bbc8463bf0fc35f84cc7bf2657d0fe176ade97b4c0dfbb
+  data.tar.gz: c47701a19cad25187cd87fac48340ec8f994e70987b7a4f0074ba3d4fba9c80e
+SHA512:
+  metadata.gz: 2db23361ff2066cf6d38a797acbe669f0b68dce20cd314d49bc36b597c2f64bef0342f9fafd0644501508f6fef9ee1d433091e9a73d1286f14400a41493b24a7
+  data.tar.gz: 2dcdb729c511035c5ad3018e32ff89a12a6ca9533291eb96eb47fab922c473ee3ac20a87da64f639dc2777a9216fbc8245dc819e7ff692c3a2978f8a0ad3ead7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 k-p-jones
+
+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,28 @@
+# DataSnapshots
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data_snapshots'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install data_snapshots
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,32 @@
+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    = 'DataSnapshots'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+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/app/models/data_snapshots/snapshot.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DataSnapshots
+  class Snapshot < ApplicationRecord
+    validates :name, presence: true
+    validates :data, presence: true
+  end
+end

data/config/initializers/extensions.rb

@@ -0,0 +1 @@
+require 'data_snapshots/active_record_extension'

data/db/migrate/20210206113359_create_snapshots.rb

@@ -0,0 +1,12 @@
+class CreateSnapshots < ActiveRecord::Migration[6.0]
+  def change
+    create_table :data_snapshots_snapshots do |t|
+      t.string :name
+      t.integer :model_id
+      t.string :model_type
+      t.json :data
+
+      t.timestamps
+    end
+  end
+end

data/lib/data_snapshots.rb

@@ -0,0 +1,23 @@
+require 'data_snapshots/engine'
+require 'data_snapshots/configuration'
+
+module DataSnapshots
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.table_name_prefix
+    'data_snapshots_'
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.generate_snapshots(name:, collection:)
+    Array(collection).each do |instance|
+      instance.generate_snapshot(name: name)
+    end
+  end
+end

data/lib/data_snapshots/active_record_extension.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+class UnregisteredSnapshotError < StandardError
+end
+
+module DataSnapshots
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    def method_missing(method, *args, &block)
+      return super(method, *args, &block) unless method.to_s.end_with?('_snapshots')
+      match_data = method.to_s.match(/(?<snapshot_name>\w+)_snapshots/)
+      name = match_data[:snapshot_name]
+      fetch_snapshots(name)
+    end
+
+    def generate_snapshot(name:)
+      snapshot = DataSnapshots.configuration.snapshots[name]
+
+      unless snapshot
+        raise UnregisteredSnapshotError.new("Snapshot: #{name} has not been registered")
+      end
+
+      data = {}
+      snapshot[:methods].each do |name, method|
+        data[name] = method.call(self)
+      end
+
+      DataSnapshots::Snapshot.create!(
+        name: name,
+        model_id: self.id,
+        model_type: self.class.to_s,
+        data: data
+      )
+    end
+
+    private
+
+    def fetch_snapshots(name)
+      DataSnapshots::Snapshot.where(name: name)
+                             .where(model_id: self.id)
+                             .where(model_type: self.class.to_s)
+                             .order(:created_at)      
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, DataSnapshots::ActiveRecordExtension)

data/lib/data_snapshots/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DataSnapshots
+  class Configuration
+    attr_reader :snapshots
+
+    def initialize
+      @snapshots = {}
+    end
+
+    def register_snapshot(name:)
+      return unless block_given?
+      snapshots[name] = { methods: {} }
+      yield snapshots[name][:methods]
+    end
+  end
+end

data/lib/data_snapshots/engine.rb

@@ -0,0 +1,4 @@
+module DataSnapshots
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/data_snapshots/version.rb

@@ -0,0 +1,3 @@
+module DataSnapshots
+  VERSION = '0.1.0'
+end

data/lib/tasks/data_snapshots_tasks.rake

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: data_snapshots
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- k-p-jones
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.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: database_cleaner
+  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: Flexible data snapshotting for Ruby on Rails.
+email:
+- kenjones620@yahoo.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/data_snapshots/snapshot.rb
+- config/initializers/extensions.rb
+- db/migrate/20210206113359_create_snapshots.rb
+- lib/data_snapshots.rb
+- lib/data_snapshots/active_record_extension.rb
+- lib/data_snapshots/configuration.rb
+- lib/data_snapshots/engine.rb
+- lib/data_snapshots/version.rb
+- lib/tasks/data_snapshots_tasks.rake
+homepage: https://github.com/k-p-jones/data_snapshots
+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.4
+signing_key:
+specification_version: 4
+summary: Data snapshots for Rails apps.
+test_files: []