memoar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cde30f618059a932082da948813fb53ffd689c8460abfafa6113f386f175406
+  data.tar.gz: 53976e030e2d42d6ac2e703cc2f524f7729e73287f5b1a2569e5d526369665ea
+SHA512:
+  metadata.gz: c2605fcfa2957ef36b8e78ed1a331619ba6ccd39ce39c3fab7b432287d4ee547a9ad0ca6c35e5f6bea0a67e160b60a85784dd123124f5c4e81dff0b8b30d0dc5
+  data.tar.gz: fe2f0240003dfcb560e743061c7eccdebaf22e27cd68bbe22efa8364b5e97add84f19ebc06b1f020269796ec1580c79262c590cc77eb8869f944d9848384f7e4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Stoyan Nikolov
+
+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,64 @@
+# Memoar
+
+Welcome to memoar! A simple versioning gem for ActiveRecord models using a JSON column.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```bash
+gem 'memoar'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install memoar
+```
+
+## Usage
+
+1. Generate a migration to add the version_log column to your model:
+
+```bash
+rails generate memoar:install ModelName
+```
+
+2. Run the migration:
+
+```bash
+rails db:migrate
+```
+
+3. In your ActiveRecord model, specify fields to track:
+
+```bash
+class Article < ApplicationRecord
+  track_changes_to :title, :content
+end
+```
+or with limit of recorded changes (default 50):
+
+```bash
+class Article < ApplicationRecord
+  track_changes_to :title, :content, limit: 10
+end
+```
+
+```bash
+article.previous_versions
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amigobg/memoar.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+task default: :test

data/lib/generators/memoar/install_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators/active_record"
+
+module Memoar
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_migration
+        migration_template "add_version_log_to_model.rb.erb", "db/migrate/#{timestamp}_add_version_log_to_#{table_name}.rb"
+      end
+
+      private
+        def timestamp
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        end
+    end
+  end
+end

data/lib/memoar/tracker.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'json'
+
+module Memoar
+  module Tracker
+    extend ActiveSupport::Concern
+
+    included do
+      after_update :track_changes
+    end
+
+    def previous_versions
+      raw = self[:version_log].presence || '[]'
+      JSON.parse(raw)
+    rescue JSON::ParserError
+      []
+    end
+
+    private
+      def track_changes
+        tracked = self.class.version_tracked_fields
+        changeset = previous_changes.slice(*tracked)
+
+        return if changeset.empty?
+
+        version_entry = {
+          changed_at: Time.current.utc.iso8601,
+          changes: changeset
+        }
+        
+        history = previous_versions
+        history << version_entry
+        history = history.last(self.class.version_log_limit)
+
+        self[:version_log] = history.to_json
+        update_column(:version_log, self[:version_log])
+      end
+
+      class_methods do
+        def track_changes_to(*fields, limit: 50)
+          @version_tracked_fields = fields.map(&:to_s)
+          @version_log_limit = limit
+        end
+
+        def version_tracked_fields
+          @version_tracked_fields || []
+        end
+
+        def version_log_limit
+          @version_log_limit || 50
+        end
+      end
+  end
+end

data/lib/memoar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Memoar
+  VERSION = "0.1.0"
+end

data/lib/memoar.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "memoar/version"
+require "memoar/tracker"
+
+module Memoar
+  class Error < StandardError; end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include Memoar::Tracker
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] = "test"
+require "logger"
+require "rails/all"
+require "minitest/autorun"
+require_relative "../lib/memoar"
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string  :name
+    t.string  :email
+    t.integer :age
+    t.json :version_log, default: []
+    t.timestamps
+  end
+end
+
+class User < ActiveRecord::Base
+  track_changes_to :name, :email, limit: 2
+end

data/test/test_memoar.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TestMemoar < Minitest::Test
+  def setup
+    User.create(name: "John Doe", email: "john@example.com", age: 18)
+    @user = User.last
+  end
+
+  def test_tracks_changes_to_user_fields
+    refute_nil ::Memoar::VERSION
+    assert_equal(["name", "email"], User.version_tracked_fields)
+    versions = @user.previous_versions
+    assert_equal(0, versions.size)
+    assert_equal("John Doe", @user.name)
+
+    @user.update!(name: "Jane Doe")
+    versions = @user.previous_versions
+    assert_equal("Jane Doe", @user.name)
+    assert_equal("john@example.com", @user.email)
+    assert_equal(18, @user.age)
+    assert_equal(1, versions.size)
+    
+    version = versions.first
+    assert_equal({"name" => ["John Doe", "Jane Doe"]}, version["changes"])
+    
+    @user.update!(email: "jane@example.com")
+    versions = @user.previous_versions
+    assert_equal("Jane Doe", @user.name)
+    assert_equal("jane@example.com", @user.email)
+    assert_equal(18, @user.age)
+    assert_equal(2, versions.size)
+    
+    version = versions.last
+    assert_equal({"email" => ["john@example.com", "jane@example.com"]}, version["changes"])
+    
+    @user.update!(age: 21)
+    assert_equal("Jane Doe", @user.name)
+    assert_equal("jane@example.com", @user.email)
+    assert_equal(21, @user.age)
+    versions = @user.previous_versions
+    assert_equal(2, versions.size)
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: memoar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stoyan Nikolov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-27 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Memoar tracks changes on specified model fields and stores them in a
+  JSON column.
+email:
+- s.nikolov@roomspilot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/memoar/install_generator.rb
+- lib/memoar.rb
+- lib/memoar/tracker.rb
+- lib/memoar/version.rb
+- test/test_helper.rb
+- test/test_memoar.rb
+homepage: https://github.com/amigobg/memoar
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/amigobg/memoar
+  changelog_uri: https://github.com/amigobg/memoar/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A simple versioning gem for ActiveRecord models using a JSON column.
+test_files: []