snapcher 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae3088224fb3c2293582c866c7c18c99b825ab26ae51a2a04cf7953561a89fca
-  data.tar.gz: 3ee807d9b9c5d492faac21d55075375428844529c618a23048abd5f2266e45c0
+  metadata.gz: cf06ee5a1a0a2a88b36aaf158a7968e6e43e076d48c5109312f299b00dd84f75
+  data.tar.gz: 0005bf88e3a4e16762aec1ba059a327bdb2c5e01e97f9727a5a4ac60db1abf42
 SHA512:
-  metadata.gz: 0adf58e67edcc55b01d4532aad99d852ab422b6e5f2188fefe905033486686af54e962ed1f555adc6541ca040b0af8cf52de18d446e95fcf00d50e0a9f426fad
-  data.tar.gz: 11b68211feff574a498ade576614adec9be7f8d63aa816f05a4f0163f015158ea88feb3d49f7948a49f74c70c549d475783a2e5ea7a6bd2307e39c2d23e8bf7b
+  metadata.gz: b9377f8a832c2ca08c13b9cdeb05651be64672d7058a96e8bf36ca82fb5b2142e8cc3f48c15f2555011dca32ab409ab20119c07e1822ca6b12e77f3efc30257b
+  data.tar.gz: e7c95f86a999f0000686f5a9f4afc55af69b0fc3cd451e8a9cf1d1970f1c06d50a14cefdfe72a9c0e057f1e012c0c1f1fd9240562446ee1141ee0298023e103e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snapcher (0.1.1)
+    snapcher (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -71,10 +71,6 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
     ast (2.4.2)
     base64 (0.1.1)
     builder (3.2.4)
@@ -108,7 +104,7 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.5)
     minitest (5.20.0)
-    net-imap (0.4.1)
+    net-imap (0.4.2)
       date
       net-protocol
     net-pop (0.1.2)
@@ -233,7 +229,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  appraisal
   debug (>= 1.8.0)
   rails (>= 7.0.0, < 7.1)
   railties

data/README.md

@@ -1,39 +1,78 @@
+![snapcher_logo](https://github.com/ryosk7/snapcher/blob/0-1-2/logo/snapcher_logo.png?raw=true)
+
+----------
+
 # Snapcher
+[![Gem Version](https://img.shields.io/gem/v/snapcher.svg)](http://rubygems.org/gems/snapcher)
+![GitHub](https://img.shields.io/github/license/ryosk7/snapcher)
+=======
 
-TODO: Delete this and the text below, and describe your gem
+**Snapcher** is an ORM extension that logs changes to specific columns to your model.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/snapcher`. To experiment with that code, run `bin/console` for an interactive prompt.
+When a change is made to a specific column, the difference between before and after the change is obtained and saved.
 
-## Installation
+To make it easier for analysts, save the table name, column name, and data before and after changes as separate columns.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Supported
 
-Install the gem and add to the application's Gemfile by executing:
+### Snapcher supports Ruby versions:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+* 3.1
+* 3.2
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Snapcher supports Rails versions:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+* 7.0
+* 7.1
 
-## Usage
+## Supported ORMs
+
+Snapcher is currently ActiveRecord-only.
 
-TODO: Write usage instructions here
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem "snapcher"
+```
 
-## Development
+Then, from your Rails app directory, create the `scannings` table:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+$ rails generate snapcher:install
+$ rails db:migrate
+```
+
+## Usage
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Simply call `scanning` on your models.
 
-## Contributing
+Use `column_name:` to select the column you want to log.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snapcher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/snapcher/blob/main/CODE_OF_CONDUCT.md).
+```ruby
+class User < ActiveRecord::Base
+  scanning column_name: "name"
+end
+```
 
-## License
+By default, whenever a user is created, updated or destroyed, a new scanning is created.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+user = User.create!(name: "Gillian Seed")
+user.scannings.count # => 1
+user.update!(name: "Mika Slayton")
+user.scannings.count # => 2
+user.destroy
+user.scannings.count # => 3
+```
 
-## Code of Conduct
+Scanning contain information regarding what action was taken on the model and what changes were made.
 
-Everyone interacting in the Snapcher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/snapcher/blob/main/CODE_OF_CONDUCT.md).
+```ruby
+user.update!(name: "Mika Slayton")
+snapcher = user.scannings.last
+snapcher.action # => "update"
+snapcher.before_params # => "Gillian Seed"
+snapcher.after_params # => "Mika Slayton"
+```

data/lib/snapcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Snapcher
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,30 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: snapcher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ryosk7
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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: Save snapshot of DB columns.
+date: 2023-10-24 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Snapcher is an ORM extension that logs changes to specific columns to your model.
+  When a change is made to a specific column, the difference between before and after the change is obtained and saved.
+  To make it easier for analysts, save the table name, column name, and data before and after changes as separate columns.
 email:
 - uchiryo7@gmail.com
 executables: []
@@ -50,6 +39,7 @@ files:
 - lib/snapcher/scanning.rb
 - lib/snapcher/sweeper.rb
 - lib/snapcher/version.rb
+- logo/snapcher_logo.png
 - sample-app/.dockerignore
 - sample-app/.gitattributes
 - sample-app/.gitignore
@@ -136,5 +126,6 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Save snapshot of DB columns.
+summary: Snapcher is an ORM extension that logs changes to specific columns to your
+  model.
 test_files: []