active_model_persistence 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4358309182de30b6d706336fdebb8d8e4b803d35cfc75c86074cb2fe96230a92
+  data.tar.gz: 3003146bc077bacff57e3d62ee55fb4ced6a3cec443a6250bd27e1b59cb17285
+SHA512:
+  metadata.gz: ec9030ea8eff12cf3d05bcaee715b846069cc4c7358c473c2688d198c73db949b79364089c10860a28b9a9ee83fe1a22f3d2bc049c4078026cfd2204d3b61082
+  data.tar.gz: 74a2bcd9bf79fbd3747f365cf8c7c7059fec276d61e2880d36870daba6c2c12cb9e85d359d6216edff526c5f3a39da5f7e655272e06c8dbe89eb3de6c6781193

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 2.7
+
+# The default max line length is 80 characters
+Layout/LineLength:
+  Max: 120
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length:
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "*.gemspec"

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_model_persistence.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 James Couball
+
+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,102 @@
+# active_model_persistence
+
+[![Gem Version](https://badge.fury.io/rb/active_model_persistence.svg)](https://badge.fury.io/rb/active_model_persistence)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Documentation](https://img.shields.io/badge/Documentation-OK-green.svg)](https://jcouball.github.io/github_pages_rake_tasks/)
+
+A gem to add in-memory persistence to Models built with ActiveModel.
+
+The goals of this gem are:
+
+* Add ActiveRecord-like meta-programming to configure Models used for ETI (Extract,
+  Transform, Load) work where a lot of data is loaded from desparate sources, transformed
+  in memory, and then written to other sources.
+* Make creation of these model objects consistent across several different teams,
+* Make it so easy to create model objects that teams will use these models instead
+  of using hashs
+* Encourage a separation from the models from the business logic of reading, transforming,
+  and writing the data
+* Make it easy to use FactoryBot to generate test data instead of having to maintain a
+  bunch of fixture files.
+
+An example model built with this gem might look like this:
+
+```ruby
+require 'active_model_persistence'
+
+class Employee
+  include ActiveModelPersistence::Persistence
+
+  # Use ActiveModel attributes and validations to define the model's state
+
+  attribute :id, :string
+  attribute :name, :string
+  attribute :manager_id, :string
+
+  validates :id, presence: true
+  validates :name, presence: true
+
+  # A unique index is automatically created on the primary key attribute (which is :id by default)
+  # index :id, unique: true
+
+  # You can set the primary key attribute if you are using a different attribute for
+  # the primary key using the statement `self.primary_key = attribute_name`
+
+  # Indexes are non-unique by default and create a `find_by_{index_name}` method on
+  # the model class.
+  index :manager_id
+end
+```
+
+Use the employee model like you would an ActiveRecord model:
+
+```ruby
+e1 = Enmployee.create(id: 'jdoe1', name: 'John Doe', manager_id: 'boss')
+e2 = Enmployee.create(id: 'jdoe2', name: 'Bob Doe', manager_id: 'boss')
+e3 = Enmployee.create(id: 'boss', name: 'Boss Person')
+
+# The `find` method looks up objects by the primary key and returns a single object or nil
+Employee.find('jdoe1') #=> [e1]
+
+# The `find_by_*` methods return a (possibly empty) object array based on the indexes
+# declared in the model class.
+Employee.find_by_manager_id('boss') #=> [e1, e2]
+
+# etc.
+```
+
+See [the full API documentation](https://jcouball.github.io/active_record_persistence/) for more details.
+
+## Installation
+
+Add this line to your application's Gemfile (or equivalent comamnd in the project's gemspec):
+
+```ruby
+gem 'active_model_persistence'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it manually using the `gem` command:
+
+```shell
+gem install active_model_persistence
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_model_persistence.
+
+## 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,89 @@
+# frozen_string_literal: true
+
+# The default task
+
+desc 'Run the same tasks that the CI build will run'
+task default: %w[spec rubocop yard yard:coverage yard:audit bundle:audit build]
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+CLEAN << 'pkg'
+CLOBBER << 'Gemfile.lock'
+
+# Bump
+
+require 'bump/tasks'
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w[
+    --format progress
+    --format json --out rubocop-report.json
+  ]
+end
+
+CLEAN << 'rubocop-report.json'
+
+# YARD
+
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w[lib/**/*.rb examples/**/*]
+end
+
+CLEAN << '.yardoc'
+CLEAN << 'doc'
+
+# Yardstick
+
+desc 'Run yardstick to show missing YARD doc elements'
+task :'yard:audit' do
+  sh "yardstick 'lib/**/*.rb'"
+end
+
+# Yardstick coverage
+
+require 'yardstick/rake/verify'
+
+Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+  verify.threshold = 100
+end
+
+# Publish YARD documentation to GitHub
+
+require 'github_pages_rake_tasks'
+
+GithubPagesRakeTasks::PublishTask.new do |task|
+  # task.doc_dir = 'documentation'
+  task.verbose = true
+end

data/active_model_persistence.gemspec

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'lib/active_model_persistence/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'active_model_persistence'
+  spec.version = ActiveModelPersistence::VERSION
+  spec.authors = ['James Couball']
+  spec.email = ['couballj@verizonmedia.com']
+
+  spec.summary = 'Adds in-memory persistence to ActiveModel models'
+  spec.description = <<~DESCRIPTION
+    Adds in-memory persistence to ActiveModel models
+  DESCRIPTION
+  spec.homepage = 'https://github.com/jcouball/active_model_persistence'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.metadata['source_code_uri']}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Runtime dependencies
+  spec.add_dependency 'activemodel', '~> 7.0'
+  spec.add_dependency 'activesupport', '~> 7.0'
+
+  # Development dependencies
+  spec.add_development_dependency 'bump', '~> 0.10'
+  spec.add_development_dependency 'bundler-audit', '~> 0.9'
+  spec.add_development_dependency 'github_pages_rake_tasks', '~> 0.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.24'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'yardstick', '~> 0.9'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'active_model_persistence'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_model_persistence/index.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+
+module ActiveModelPersistence
+  # An Index keeps a map from a key to zero of more objects
+  # @api public
+  #
+  class Index
+    # The name of the index
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_source: :id, unique: true)
+    #   i.name # => 'id'
+    #
+    # @return [String] The name of the index
+    #
+    attr_reader :name
+
+    # Defines how the object's key value is calculated
+    #
+    # If a proc is provided, it will be called with the object as an argument to get the key value.
+    #
+    # If a symbol is provided, it will identify the method to call on the object to get the key value.
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_value_source: :id, unique: true)
+    #   i.key_value_source # => :id
+    #
+    # @return [Symbol, Proc] the method name or proc used to calculate the index key
+    #
+    attr_reader :key_value_source
+
+    # Determines if a key value can index more than one object
+    #
+    # The default value is false.
+    #
+    # If true, if two objects have the same key, a UniqueContraintError will be raised
+    # when trying to add the second object.
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_value_source: :id, unique: true)
+    #   i.unique? # => true
+    #
+    # @return [Boolean] true if the index is unique
+    #
+    attr_reader :unique
+
+    alias unique? unique
+
+    # Create an Index
+    #
+    # @example An object that can be indexed must include Indexable (which includes PrimaryKey)
+    #   Employee = Struct.new(:id, :name, keyword_init: true)
+    #     include ActiveModelPersistence::Indexable
+    #   end
+    #   e1 = Employee.new(id: 1, name: 'James')
+    #   e2 = Employee.new(id: 2, name: 'Frank')
+    #   e3 = Employee.new(id: 1, name: 'Margaret') # Note e1.id == e3.id
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_source: :id, unique: true)
+    #   i.name # => 'id'
+    #   i.key_source # => :id -- get the key value by calling the 'id' method on object
+    #   i.unique # => true -- each key can only have one object associated with it
+    #
+    #   i.objects(e1.id) # => []
+    #   i.add(e1)
+    #   i.add(e2)
+    #   i.objects(e1.id) # => [e1]
+    #   i.objects(e2.id) # => [e2]
+    #   i.add(e3) # => raises a UniqueContraintError since e1.id == e3.id
+    #   i.add(e1) # => raises an ObjectAlreadyInIndexError
+    #
+    # @param name [String] the name of the index
+    # @param key_value_source [Symbol, Proc] the attribute name or proc used to calculate the index key
+    # @param unique [Boolean] when true the index will only allow one object per key
+    #
+    def initialize(name:, key_value_source: nil, unique: false)
+      @name = name.to_s
+      @key_value_source = determine_key_value_source(name, key_value_source)
+      @unique = unique
+      @key_to_objects_map = {}
+    end
+
+    # Returns the objects that match the key
+    #
+    # A unique index will return an Array containing zero or one objects. A non-unique
+    # index will return an array containing zero or more objects.
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_source: :id, unique: true)
+    #   e = Employee.new(id: 1, name: 'James')
+    #   i.object(e.id) # => []
+    #   i.add(e.id, e)
+    #   i.object(e.id) # => [e]
+    #
+    # @param key [Object] the key to search for
+    #
+    # @return [Array<Object>] the objects that match the key
+    #
+    def objects(key)
+      key_to_objects_map[key] || []
+    end
+
+    # Returns true if the index contains an object with the given key
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_source: :id, unique: true)
+    #   e = Employee.new(id: 1, name: 'James')
+    #   i.include?(e.id) # => false
+    #   i << e
+    #   i.include?(e.id) # => true
+    #
+    # @param key [Object] the key to search for
+    #
+    # @return [Boolean] true if the index contains an object with the given key
+    #
+    def include?(key)
+      key_to_objects_map.key?(key)
+    end
+
+    # Adds an object to the index
+    #
+    # If the object was already in the index using a different key, remote the object
+    # from the index using the previous key before adding it again.
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_source: :id, unique: true)
+    #   e = Employee.new(id: 1, name: 'James')
+    #   i << e
+    #   i.objects(1) # => [e]
+    #   e.id = 2
+    #   i << e
+    #   i.objects(1) # => []
+    #   i.objects(2) # => [e]
+    #
+    # @param object [Object] the object to add to the index
+    #
+    # @return [Index] self so calls can be chained
+    #
+    # @raise [UniqueConstraintError] if the index is unique and there is already an index
+    #   entry for the same key
+    #
+    def add_or_update(object)
+      previous_key = object.previous_index_key(name)
+      key = key_value_for(object)
+
+      return if previous_key == key
+
+      remove(object, previous_key) unless previous_key.nil?
+
+      add(object, key) unless key.nil?
+
+      self
+    end
+
+    alias << add_or_update
+
+    # Removes an object from the index
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_source: :id, unique: true)
+    #   e = Employee.new(id: 1, name: 'James')
+    #   i << e
+    #   i.objects(1) # => [e]
+    #   i.remove(e)
+    #   i.objects(1) # => []
+    #
+    # @param object [Object] the object to remove from the index
+    # @param key [Object] the object's key in the index
+    #   If nil (the default), call the object.previous_index_key to get the key.
+    #   `previous_index_key` is implemented by the Indexable concern.
+    #
+    # @return [void]
+    #
+    # @raise [ObjectNotInIndexError] if the object is not in the index
+    #
+    def remove(object, key = nil)
+      key ||= object.previous_index_key(name)
+
+      raise ActiveModelPersistence::ObjectNotInIndexError if key.nil?
+
+      remove_object_from_index(object, key)
+
+      nil
+    end
+
+    # Removes all objects from the index
+    #
+    # @example
+    #   i = Index.new(name: 'id', key_source: :id, unique: true)
+    #   e1 = Employee.new(id: 1, name: 'James')
+    #   e2 = Employee.new(id: 2, name: 'Frank')
+    #   i << e1 << e2
+    #   i.objects(1) # => [e1]
+    #   i.objects(2) # => [e2]
+    #   i.remove_all
+    #   i.objects(1) # => []
+    #   i.objects(2) # => []
+    #
+    # @return [void]
+    #
+    def remove_all
+      @key_to_objects_map.each_pair do |_key, objects|
+        objects.each do |object|
+          object.clear_index_key(name)
+        end
+      end
+      @key_to_objects_map = {}
+      nil
+    end
+
+    protected
+
+    # The map of keys to objects
+    #
+    # @return [Hash<Object, Array<Object>>] the map from key to an array objects added for that key
+    #
+    # @api private
+    #
+    attr_reader :key_to_objects_map
+
+    private
+
+    # Remove an object from the index with no additional checks
+    #
+    # @return [void]
+    #
+    # @api private
+    #
+    def remove_object_from_index(object, key)
+      key_to_objects_map[key].delete_if { |o| o.primary_key == object.primary_key }
+      key_to_objects_map.delete(key) if key_to_objects_map[key].empty?
+      object.clear_index_key(name)
+    end
+
+    # Adds an object to the index
+    #
+    # @param object [Object] the object to add to the index
+    # @param key [Object] the object's key in the index
+    #
+    # @return [void]
+    #
+    # @raise [UniqueConstraintError] if the index is unique and there is already an index
+    #   entry for the same key
+    #
+    # @api private
+    #
+    def add(object, key)
+      raise UniqueConstraintError if unique? && include?(key)
+
+      key_to_objects_map[key] = [] unless key_to_objects_map.include?(key)
+      key_to_objects_map[key] << object
+      object.save_index_key(name, key)
+    end
+
+    # Uses the `key_value_source` to calculate the key value for the given object
+    #
+    # @param object [Object] the object to calculate the key value for
+    #
+    # @return [Object] the key value
+    #
+    # @api private
+    #
+    def key_value_for(object)
+      if key_value_source.is_a?(Proc)
+        key_value_source.call(object)
+      else
+        object.send(key_value_source)
+      end
+    end
+
+    # Determine the value for key_value_source
+    #
+    # @return [Symbol, Proc] the value for key_value_source
+    #
+    # @api private
+    #
+    def determine_key_value_source(name, key_value_source)
+      @key_value_source =
+        case key_value_source
+        when nil
+          name.to_sym
+        when Proc
+          key_value_source
+        else
+          key_value_source.to_sym
+        end
+    end
+  end
+end