active_model_persistence 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34c4046feea446188de7f1381ed024799bd8e545a50d9abf1e22f06ee0e06ee
-  data.tar.gz: 585c06a05af51efb5123efb0c98b618f9747955f9040852ea08835c6f962fdc6
+  metadata.gz: e3b8a31cdacf32baeaabb6d3c72631002098c9a35630d1c0aff5e836737e42dc
+  data.tar.gz: '00843ca11ad71c596c192d066efc3f43d7e531c068d12bea9866f58bea404b3e'
 SHA512:
-  metadata.gz: 846582f45f58f215e20ba67fb843898d3091c1af816d851689027d94c71c9973d4b5fc3d3b2798d4fd875a22d5a2fc7a5c2c3150f465cdd4aa29fee11e964f2c
-  data.tar.gz: 0ad54fb60bae3d74fceacb8aa94a860bbb399219ccd791ef2376e56b794ec52e706c01eb91bb0e1ff4fb4d4d93af6f72c187d591f657f176ba69f84f15dfa387
+  metadata.gz: 25984dd367fedae9ead6973601c042a164643e5aaa09e5198ebcc6a8f5dfe333eba73d37f34ca257f61a58f6aca7b6b9326727f337b2d159d5d0bd71db62e0bd
+  data.tar.gz: ca0ddf06112d7e70bb7898f8f3ba0a95f63f5db4f9cf3aee1f6a7d054b3fd5dfb705609844d42ff55d9eab05a7652fb6f2fa086ca8d1a7a97b79e61ee6811cfe

data/CHANGELOG.md

@@ -7,6 +7,13 @@
 
 The full change log is stored on [this project's GitHub releases page](https://github.com/jcouball/active_model_persistence/releases).
 
+## v0.5.0
+
+* 87b32e5 Fix the version file after the previous revert (#20)
+* f4f6c39 Revert "Add inheritance support (#14)" (#19)
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v0.5.0
+
 ## v0.4.0
 
 * e491e22 Set the version file back to the correct version (#17)

data/README.md

@@ -65,82 +65,6 @@ Employee.find_by_manager_id('boss') #=> [e1, e2]
 # etc.
 ```
 
-## Inheritance
-
-ActiveModelPersistence supports inheritance in models. Include
-`ActiveModelPersistence::Persistence` only in the base class.
-
-Here is an example with a `User` base class and two derived clases `Employee` and `Member`.
-Each derived class adds different attributes and indexes.
-
-```ruby
-require 'active_model_persistence'
-
-class User
-  include ActiveModelPersistence::Persistence
-
-  attribute :id, :integer
-  attribute :name, :string
-end
-
-class Employee < User
-  attribute :manager_id, :integer
-
-  index :manager_id, unique: false
-end
-
-class Member < User
-  attribute :joined_on, :date, default: Date.today
-
-  index :joined_on, unique: false
-end
-```
-
-As an example, say we have one instance of each class:
-
-```ruby
-user = User.create!(id: 1, name: 'User James')
-employee = Employee.create!(id: 2, name: 'Employee Bob', manager_id: nil)
-member = Member.create!(id: 3, name: 'Member Mary', joined_on: Date.parse('2022-01-01'))
-```
-
-The primary key is shared by all objects of these classes so it must be unique for
-all objects created from these classes. For instance:
-
-```ruby
-require 'rspec-expectations'
-include RSpec::Matchers
-
-# Creating a Member with the same primary key as a User will fail
-expect { Member.create!(id: 1, name: 'Member Jason') }.to(
-  raise_error(ActiveModelPersistence::UniqueConstraintError)
-)
-```
-
-Calling a find method such as `find` or `find_by_*` on a class will only return
-objects that are a kind of that class.
-
-That means calling a find method on `User` will return users, employees, or members:
-
-```ruby
-expect(User.find(1)).to eq(user)
-expect(User.find(2)).to eq(employee)
-expect(User.find(3)).to eq(member)
-```
-
-While calling a find method on `Employee` will only return employees:
-
-```ruby
-expect(Employee.find(1)).to be_nil
-expect(Employee.find(2)).to eq(employee)
-expect(Employee.find(3)).to be_nil
-```
-
-`all`, `count`, `delete_all`, `destroy_all` and other methods similarly limit what
-objects are acted upon based on what class they are called on.
-
-## API Documentation
-
 See [the full API documentation](https://jcouball.github.io/active_record_persistence/) for more details.
 
 ## Installation

data/lib/active_model_persistence/index.rb

@@ -15,18 +15,6 @@ module ActiveModelPersistence
     #
     attr_reader :name
 
-    # Identifies the base class this index applies to
-    #
-    # Objects that are not of this class or one of its subclasses will not be added to the index.
-    #
-    # @example
-    #   i = Index.new(name: 'id', base_class: self, key_source: :id, unique: true)
-    #   i.base_class == self #=> true
-    #
-    # @return [Class] the class this index applies to
-    #
-    attr_reader :base_class
-
     # 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.
@@ -34,7 +22,7 @@ module ActiveModelPersistence
     # 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', base_class: self, key_value_source: :id, unique: true)
+    #   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
@@ -49,7 +37,7 @@ module ActiveModelPersistence
     # when trying to add the second object.
     #
     # @example
-    #   i = Index.new(name: 'id', base_class: self, key_value_source: :id, unique: true)
+    #   i = Index.new(name: 'id', key_value_source: :id, unique: true)
     #   i.unique? # => true
     #
     # @return [Boolean] true if the index is unique
@@ -86,9 +74,8 @@ module ActiveModelPersistence
     # @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:, base_class:, key_value_source: nil, unique: false)
+    def initialize(name:, key_value_source: nil, unique: false)
       @name = name.to_s
-      @base_class = base_class
       @key_value_source = determine_key_value_source(name, key_value_source)
       @unique = unique
       @key_to_objects_map = {}
@@ -241,7 +228,7 @@ module ActiveModelPersistence
     # @api private
     #
     def remove_object_from_index(object, key)
-      key_to_objects_map[key].delete_if { |o| o.primary_key_value == object.primary_key_value }
+      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

data/lib/active_model_persistence/indexable.rb

@@ -60,7 +60,6 @@ module ActiveModelPersistence
     # make these class methods on that class.
     #
     module ClassMethods
-      # @!attribute [r] indexes
       # Returns a hash of indexes for the model keyed by name
       #
       # @example
@@ -68,7 +67,9 @@ module ActiveModelPersistence
       #
       # @return [Hash<String, ActiveModelPersistence::Index>] the indexes defined by the model
       #
-      # @api public
+      def indexes
+        @indexes ||= {}
+      end
 
       # Adds an index to the model
       #
@@ -97,7 +98,9 @@ module ActiveModelPersistence
         indexes[index_name.to_sym] = index
 
         singleton_class.define_method("find_by_#{index_name}") do |key|
-          index.objects(key).select { |object| object.is_a?(self) }
+          index.objects(key).tap do |objects|
+            objects.each { |o| o.instance_variable_set(:@previously_new_record, false) }
+          end
         end
       end
 
@@ -122,9 +125,7 @@ module ActiveModelPersistence
       # @return [void]
       #
       def update_indexes(object)
-        indexes.each_value do |index|
-          index.add_or_update(object) if object.is_a?(index.base_class)
-        end
+        indexes.each_value { |index| index.add_or_update(object) }
       end
 
       # Removes the given object from all defined indexes
@@ -143,9 +144,7 @@ module ActiveModelPersistence
       # @return [void]
       #
       def remove_from_indexes(object)
-        indexes.each_value do |index|
-          index.remove(object) if object.is_a?(index.base_class)
-        end
+        indexes.each_value { |index| index.remove(object) }
       end
 
       private
@@ -159,15 +158,12 @@ module ActiveModelPersistence
       def default_index_options(index_name)
         {
           name: index_name.to_sym,
-          base_class: self,
           unique: false
         }
       end
     end
 
     included do
-      cattr_reader :indexes, instance_accessor: false, default: {}
-
       # Adds the object to the indexes defined by the model
       #
       # @example

data/lib/active_model_persistence/persistence.rb

@@ -158,7 +158,7 @@ module ActiveModelPersistence
       # @return [Array<Object>] the model objects in the object store
       #
       def all
-        object_array.select { |object| object.is_a?(self) }.each
+        object_array.each
       end
 
       # The number of model objects saved in the object store
@@ -174,7 +174,7 @@ module ActiveModelPersistence
       # @return [Integer] the number of model objects in the object store
       #
       def count
-        object_array.select { |object| object.is_a?(self) }.size
+        object_array.size
       end
 
       alias size count
@@ -196,11 +196,30 @@ module ActiveModelPersistence
       # @return [void]
       #
       def destroy_all
-        objects_to_destroy = object_array.select { |object| object.is_a?(self) }
-        objects_to_destroy.each(&:destroy)
+        object_array.first.destroy while object_array.size.positive?
       end
 
-      alias delete_all destroy_all
+      # Removes all model objects from the object store
+      #
+      # Each saved model object's `#destroy` method is NOT called.
+      #
+      # @example
+      #   array_of_attributes = [
+      #     { id: 1, name: 'James' },
+      #     { id: 2, name: 'Frank' }
+      #   ]
+      #   ModelExample.create(array_of_attributes)
+      #   ModelExample.all.count #=> 2
+      #   ModelExample.destroy_all
+      #   ModelExample.all.count #=> 0
+      #
+      # @return [void]
+      #
+      def delete_all
+        @object_array = []
+        indexes.values.each(&:remove_all)
+        nil
+      end
 
       # private
 
@@ -210,12 +229,13 @@ module ActiveModelPersistence
       #
       # @api private
       #
+      def object_array
+        @object_array ||= []
+      end
     end
 
     # rubocop:disable Metrics/BlockLength
     included do
-      cattr_reader :object_array, instance_accessor: false, default: []
-
       # Returns true if this object hasn't been saved or destroyed yet
       #
       # @example
@@ -351,7 +371,7 @@ module ActiveModelPersistence
       def destroy
         if persisted?
           remove_from_indexes
-          self.class.object_array.delete_if { |o| o.primary_key_value == primary_key_value }
+          self.class.object_array.delete_if { |o| o.primary_key == primary_key }
         end
         @new_record = false
         @destroyed = true
@@ -409,14 +429,13 @@ module ActiveModelPersistence
       # Creates a record with values matching those of the instance attributes
       # and returns its id.
       #
-      # @return [Object] the primary_key_value of the created object
+      # @return [Object] the primary_key of the created object
       #
       # @api private
       #
       def _create
-        return false unless primary_key_value?
-
-        raise UniqueConstraintError if primary_key_index.include?(primary_key_value)
+        return false unless primary_key?
+        raise UniqueConstraintError if primary_key_index.include?(primary_key)
 
         self.class.object_array << self
 
@@ -424,7 +443,7 @@ module ActiveModelPersistence
 
         yield(self) if block_given?
 
-        primary_key_value
+        primary_key
       end
 
       # Updates an object that is already in the object store
@@ -434,7 +453,7 @@ module ActiveModelPersistence
       # @api private
       #
       def _update
-        raise RecordNotFound unless primary_key_index.include?(primary_key_value)
+        raise RecordNotFound unless primary_key_index.include?(primary_key)
 
         yield(self) if block_given?
 

data/lib/active_model_persistence/primary_key.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/core_ext/module'
-
 module ActiveModelPersistence
   # Exposes the `primary_key` accessor to read or write the primary key attribute value
   #
@@ -44,8 +42,7 @@ module ActiveModelPersistence
     # make these class methods on that class.
     #
     module ClassMethods
-      # @!attribute [rw] primary_key
-      # Identifies the attribute that the `primary_key_value` accessor maps to
+      # Identifies the attribute that the `primary_key` accessor maps to
       #
       # The primary key is 'id' by default.
       #
@@ -57,28 +54,33 @@ module ActiveModelPersistence
       #   end
       #   Employee.primary_key #=> :username
       #
-      # @return [String] the attribute that the `primary_key` accessor is an alias for
+      # @return [Symbol] the attribute that the `primary_key` accessor is an alias for
       #
-      # @api public
-    end
+      def primary_key
+        @primary_key ||= 'id'
+      end
 
-    included do
-      # @!attribute [r] primary_key
-      # Identifies the attribute that the `primary_key_value` accessor maps to
-      #
-      # The primary key is 'id' by default.
+      # Sets the attribute to use for the primary key
       #
       # @example
       #   class Employee
       #     include ActiveModelPersistence::PrimaryKey
       #     attribute :username, :string
-      #     self.primary_key = :username
+      #     primary_key = :username
       #   end
-      #   Employee.primary_key #=> :username
+      #   e = Employee.new(username: 'couballj')
+      #   e.primary_key #=> 'couballj'
+      #
+      # @param attribute [Symbol] the attribute to use for the primary key
+      #
+      # @return [void]
       #
-      # @return [String] the attribute that the `primary_key` accessor is an alias for
-      cattr_accessor :primary_key, default: 'id', instance_writer: false
+      def primary_key=(attribute)
+        @primary_key = attribute.to_s
+      end
+    end
 
+    included do
       # Returns the primary key attribute's value
       #
       # @example
@@ -92,8 +94,8 @@ module ActiveModelPersistence
       #
       # @return [Object] the primary key attribute's value
       #
-      def primary_key_value
-        __send__(primary_key)
+      def primary_key
+        __send__(self.class.primary_key)
       end
 
       # Sets the primary key atribute's value
@@ -112,8 +114,8 @@ module ActiveModelPersistence
       #
       # @return [void]
       #
-      def primary_key_value=(value)
-        __send__("#{primary_key}=", value)
+      def primary_key=(value)
+        __send__("#{self.class.primary_key}=", value)
       end
 
       # Returns true if the primary key attribute's value is not null or empty
@@ -131,8 +133,8 @@ module ActiveModelPersistence
       #
       # @return [Boolean] true if the primary key attribute's value is not null or empty
       #
-      def primary_key_value?
-        primary_key_value.present?
+      def primary_key?
+        primary_key.present?
       end
     end
   end

data/lib/active_model_persistence/primary_key_index.rb

@@ -47,7 +47,7 @@ module ActiveModelPersistence
       # @api private
       #
       def self.extended(base)
-        base.index('primary_key', key_value_source: :primary_key_value, unique: true)
+        base.index('primary_key', key_value_source: :primary_key, unique: true)
       end
     end
 

data/lib/active_model_persistence/version.rb

@@ -2,5 +2,5 @@
 
 module ActiveModelPersistence
   # The version of the active_model_persistence gem
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_persistence
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - James Couball