data_snapshots 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 583f6e7d574b9396d4bbc8463bf0fc35f84cc7bf2657d0fe176ade97b4c0dfbb
-  data.tar.gz: c47701a19cad25187cd87fac48340ec8f994e70987b7a4f0074ba3d4fba9c80e
+  metadata.gz: 40cbe4d1f45ed3d90d838d1b427a5e9276b614f06036a9b6f009896aed8501b8
+  data.tar.gz: e1466ef30d15e726cee9ab95b21cf3df287a0855f8f15896aac0affab095b6f0
 SHA512:
-  metadata.gz: 2db23361ff2066cf6d38a797acbe669f0b68dce20cd314d49bc36b597c2f64bef0342f9fafd0644501508f6fef9ee1d433091e9a73d1286f14400a41493b24a7
-  data.tar.gz: 2dcdb729c511035c5ad3018e32ff89a12a6ca9533291eb96eb47fab922c473ee3ac20a87da64f639dc2777a9216fbc8245dc819e7ff692c3a2978f8a0ad3ead7
+  metadata.gz: 7284a6584066c19a6130c53a1eeb13f7961118ea5f9bf73ed218b2d7097172c33f6322146b1a64b332112e2c8ba124e97eca2e6adaa308c0be67493d2f612bb5
+  data.tar.gz: 23561e9dbb1ce28a998c3d46dac97bcead9bd09d3ee44c9ae3159880777c058c4a427a3e5a7e82b983ad7c8b88115a14927d3a8301226ed68455151369660f43

data/README.md

@@ -1,28 +1,79 @@
-# DataSnapshots
-Short description and motivation.
+# data_snapshots
 
-## Usage
-How to use my plugin.
+Simple, flexible data snapshotting for your Rails app.
 
 ## Installation
-Add this line to your application's Gemfile:
+Run the following command to add `data_snapshots` to your Gemfile:
+``` shell
+bundle add data_snapshots
+```
+Once installed, copy and run the migration:
+```shell
+bundle exec rails data_snapshots_engine:install:migrations
+bundle exec rails db:migrate
+```
+## Registering a model snapshot
+A model snapshot is a collection of methods that run against a model instance. Methods will be passed the instance when the snapshot is generated.
+
+You can register your snapshots in an initializer:
 
 ```ruby
-gem 'data_snapshots'
+DataSnapshots.configure  do  |c|
+  c.register_snapshot name: :user_assignments do |methods|
+    methods[:total] = ->(instance) { instance.assignments.count }
+    methods[:total_complete] = ->(instance) { instance.assignments.where(complete: true).count }
+  end
+end
 ```
 
-And then execute:
-```bash
-$ bundle
+## Registering a generic snapshot
+A generic snapshot is a collection of methods that will not be passed a model instance when the snapshot is generated. You can declare a snapshot as generic by passing `model: false` as an argument when registering the snapshot:
+
+```ruby
+DataSnapshots.configure  do  |c|
+  c.register_snapshot name: :totals, model: false do |methods|
+    methods[:total_users] = ->() { User.count }
+    methods[:total_assignments] = ->() { Assignments.count }
+  end
+end
 ```
 
-Or install it yourself as:
-```bash
-$ gem install data_snapshots
+## Generating model snapshots
+Model snapshots can either be generated on the individual instance:
+```ruby
+user = User.last
+user.generate_snapshot(name: :user_assignments)
+```
+Or you can generate them with a collection of records:
+```ruby
+DataSnapshots.generate_snapshots(name: :user_assignments, collection: User.all)
 ```
 
-## Contributing
-Contribution directions go here.
+## Generating generic snapshots
+Generic snapshots can be created by passing the name of the snapshot to `DataSnapshots.generate_snapshot`
+```ruby
+DataSnapshots.generate_snapshot(name: :total_users)
+```
+
+## Fetching snapshots
+`data_snapshots` comes with a `<NAME>_snapshots` method so its easy to fetch all the snapshots taken against a particular instance:
+```ruby
+user.user_assignments_snapshots
+```
+You can fetch your generic snapshots by calling `DataSnapshots.fetch_snapshots` and passing the name of your snapshot:
+```ruby
+DataSnapshots.fetch_snapshots(name: :total_users)
+```
+This method can also be used to fetch _ALL_ model snapshots with the given name.
+
+## Viewing snapshot data
+
+Snapshot data is stored as JSON in the database and can be accessed easily:
+
+```ruby
+snapshot.data # => { 'key' => 'value' }
+```
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The gem is available as open source under the terms of the  [MIT License](https://opensource.org/licenses/MIT). 

data/lib/data_snapshots.rb

@@ -1,6 +1,12 @@
 require 'data_snapshots/engine'
 require 'data_snapshots/configuration'
 
+class UnregisteredSnapshotError < StandardError
+end
+
+class IncompatibleSnapshotError < StandardError
+end
+
 module DataSnapshots
   class << self
     attr_accessor :configuration
@@ -20,4 +26,31 @@ module DataSnapshots
       instance.generate_snapshot(name: name)
     end
   end
+
+  def self.generate_snapshot(name:)
+    snapshot = DataSnapshots.configuration.snapshots[name]
+
+    unless snapshot
+      raise UnregisteredSnapshotError.new("Snapshot: #{name} has not been registered")
+    end
+
+    if snapshot[:model]
+      raise IncompatibleSnapshotError.new(
+        "Snapshot: #{name} is a model snapshot, this method is for generic snapshots." \
+        "Try calling #generate_snapshot(name: #{name}) on an instance of the appropriate model." \
+        "Alternatively, call DataSnapshots.generate_snapshots(name: #{name}, collection: [Array of instances])"
+      )
+    end
+
+    data = {}
+    snapshot[:methods].each do |key, method|
+      data[key] = method.call()
+    end
+
+    DataSnapshots::Snapshot.create!(name: name, data: data)
+  end
+
+  def self.fetch_snapshots(name:)
+    DataSnapshots::Snapshot.where(name: name).order(:created_at)
+  end
 end

data/lib/data_snapshots/active_record_extension.rb

@@ -2,9 +2,6 @@
 
 require 'active_support/concern'
 
-class UnregisteredSnapshotError < StandardError
-end
-
 module DataSnapshots
   module ActiveRecordExtension
     extend ActiveSupport::Concern

data/lib/data_snapshots/configuration.rb

@@ -8,9 +8,9 @@ module DataSnapshots
       @snapshots = {}
     end
 
-    def register_snapshot(name:)
+    def register_snapshot(name:, model: true)
       return unless block_given?
-      snapshots[name] = { methods: {} }
+      snapshots[name] = { methods: {}, model: model }
       yield snapshots[name][:methods]
     end
   end

data/lib/data_snapshots/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_snapshots
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - k-p-jones
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails