active_model_persistence 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c9021a01608e4ac248001eafc0a7c2265ab82666bc33add62e9a3f3586f6bbf
-  data.tar.gz: 4225a766baeb076abce4a27cbde7d8c742f02e660632855198ba6dda7a20434f
+  metadata.gz: a36224415c3d71eed1f01b39413b896af90a3b808f15c081800f31114c6105d4
+  data.tar.gz: f77057857a7cd5a6687017d2c9228e9c60ceb38a1cce75484ce40d93259de9d9
 SHA512:
-  metadata.gz: 8499b0d13d3acafcd5b45df2d8c3d22a171f2f428f7b1d6de961855af7d18b839c0be9c40163bbf74bb91fa5f9956e62e37a7bcfe691eeac3eb6057508abb412
-  data.tar.gz: fa9bab5a614c233c7c505f7f66f181abf87787d51902322c88408fe8802334f701ef5b7742e01bfa80ab3352a4765e9b811da1ba6ee145e3a80496e80a3fbaa6
+  metadata.gz: '084f1a34f5dbff248ab739cbe3ae95be6209d696db4b4b63191b6b5c6d0ee2b3674127b035a4eb1aef5529ae5400c5bce48d762d30193277e25865f595346ffe'
+  data.tar.gz: 4cba73228e285a16226418fade9a753c7378201db8bbe622ab8de1e0afb9c484bfc99fbbf2b59e438c2b801dec4101025cd4174ad277aa285ae1a94b1c6ee0a8

data/.rubocop.yml

@@ -8,6 +8,9 @@ AllCops:
   # RuboCop enforces rules depending on the oldest version of Ruby which
   # your project supports:
   TargetRubyVersion: 2.7
+  Exclude:
+    - bin/create-release
+    - vendor/**/*
 
 # The default max line length is 80 characters
 Layout/LineLength:

data/CHANGELOG.md

@@ -6,3 +6,26 @@
 # Change Log
 
 The full change log is stored on [this project's GitHub releases page](https://github.com/jcouball/active_model_persistence/releases).
+
+## v0.3.0
+
+* 3b93fae List all changes in CHANGELOG.md instead of just a link (#10)
+* 76d8a0b Backfill previous released in the CHANGELOG.md (#9)
+* 67da6ed Add experimental script to create release (#8)
+* 7da26b6 Refactor #save and #save! (#7)
+* 81e3730 Add the #update and #update! methods (#6)
+* b4c5f20 Add .create! (#5)
+* 436ee3d Use "module ClassMethods" instead of "do class_methods" for ActiveConcern (#4)
+* 1be8b11 Run yard:audit before yard:coverage (#3)
+
+See https://github.com/ruby-git/ruby-git/releases/tag/v0.3.0
+
+## v0.2.0
+
+[Full Changelog](https://github.com/jcouball/active_model_persistence/compare/v0.1.0...v0.2.0)
+
+* ca12c6d Implement save! (#1)
+
+## v0.1.0
+
+Initial release

data/Rakefile

@@ -3,7 +3,7 @@
 # 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]
+task default: %w[spec rubocop yard yard:audit yard:coverage bundle:audit build]
 
 # Bundler Audit
 

data/bin/create-release

@@ -0,0 +1,537 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Run this script while in the root directory of the project with the default
+# branch checked out.
+
+require 'bump'
+require 'English'
+require 'fileutils'
+require 'optparse'
+require 'tempfile'
+
+# TODO: Right now the default branch and the remote name are hard coded
+
+class Options
+  attr_accessor :current_version, :next_version, :tag, :current_tag, :next_tag, :branch, :quiet
+
+  def initialize
+    yield self if block_given?
+  end
+
+  def release_type
+    raise 'release_type not set' if @release_type.nil?
+
+    @release_type
+  end
+
+  VALID_RELEASE_TYPES = %w[major minor patch].freeze
+
+  def release_type=(release_type)
+    unless VALID_RELEASE_TYPES.include?(release_type)
+      raise "release_type must be one of: #{VALID_RELEASE_TYPES.join(', ')}"
+    end
+
+    @release_type = release_type
+  end
+
+  def quiet
+    @quiet = false unless instance_variable_defined?(:@quiet)
+    @quiet
+  end
+
+  def current_version
+    @current_version ||= Bump::Bump.current
+  end
+
+  def next_version
+    current_version # Save the current version before bumping
+    @next_version ||= Bump::Bump.next_version(release_type)
+  end
+
+  def tag
+    @tag ||= "v#{next_version}"
+  end
+
+  def current_tag
+    @current_tag ||= "v#{current_version}"
+  end
+
+  def next_tag
+    tag
+  end
+
+  def branch
+    @branch ||= "release-#{tag}"
+  end
+
+  def default_branch
+    @default_branch ||= `git remote show '#{remote}'`.match(/HEAD branch: (.*?)$/)[1]
+  end
+
+  def remote
+    @remote ||= 'origin'
+  end
+
+  def to_s
+    <<~OUTPUT
+      release_type='#{release_type}'
+      current_version='#{current_version}'
+      next_version='#{next_version}'
+      tag='#{tag}'
+      branch='#{branch}'
+      quiet=#{quiet}
+    OUTPUT
+  end
+end
+
+class CommandLineParser
+  attr_reader :options
+
+  def initialize
+    @option_parser = OptionParser.new
+    define_options
+    @options = Options.new
+  end
+
+  def parse(args)
+    option_parser.parse!(remaining_args = args.dup)
+    parse_remaining_args(remaining_args)
+    # puts options unless options.quiet
+    options
+  end
+
+  private
+
+  attr_reader :option_parser
+
+  def parse_remaining_args(remaining_args)
+    error_with_usage('No release type specified') if remaining_args.empty?
+    @options.release_type = remaining_args.shift || nil
+    error_with_usage('Too many args') unless remaining_args.empty?
+  end
+
+  def error_with_usage(message)
+    warn <<~MESSAGE
+      ERROR: #{message}
+      #{option_parser}
+    MESSAGE
+    exit 1
+  end
+
+  def define_options
+    option_parser.banner = 'Usage: create_release --help | release-type'
+    option_parser.separator ''
+    option_parser.separator 'Options:'
+
+    define_quiet_option
+    define_help_option
+  end
+
+  def define_quiet_option
+    option_parser.on('-q', '--[no-]quiet', 'Do not show output') do |quiet|
+      options.quiet = quiet
+    end
+  end
+
+  def define_help_option
+    option_parser.on_tail('-h', '--help', 'Show this message') do
+      puts option_parser
+      exit 0
+    end
+  end
+end
+
+class ReleaseAssertions
+  attr_reader :options
+
+  def initialize(options)
+    @options = options
+  end
+
+  def make_assertions
+    bundle_is_up_to_date
+    in_git_repo
+    in_repo_toplevel_directory
+    on_default_branch
+    no_uncommitted_changes
+    local_and_remote_on_same_commit
+    tag_does_not_exist
+    branch_does_not_exist
+    docker_is_running
+    changelog_docker_container_exists
+    gh_command_exists
+  end
+
+  private
+
+  def gh_command_exists
+    print 'Checking that the gh command exists...'
+    `which gh > /dev/null 2>&1`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error 'The gh command was not found'
+    end
+  end
+
+  def docker_is_running
+    print 'Checking that docker is installed and running...'
+    `docker info > /dev/null 2>&1`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error 'Docker is not installed or not running'
+    end
+  end
+
+  def changelog_docker_container_exists
+    print 'Checking that the changelog docker container exists (might take time to build)...'
+    `docker build --file Dockerfile.changelog-rs --tag changelog-rs . 1>/dev/null`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error 'Failed to build the changelog-rs docker container'
+    end
+  end
+
+  def bundle_is_up_to_date
+    print 'Checking that the bundle is up to date...'
+    if File.exist?('Gemfile.lock')
+      print 'Running bundle update...'
+      `bundle update --quiet`
+      if $CHILD_STATUS.success?
+        puts 'OK'
+      else
+        error 'bundle update failed'
+      end
+    else
+      print 'Running bundle install...'
+      `bundle install --quiet`
+      if $CHILD_STATUS.success?
+        puts 'OK'
+      else
+        error 'bundle install failed'
+      end
+    end
+  end
+
+  def in_git_repo
+    print 'Checking that you are in a git repo...'
+    `git rev-parse --is-inside-work-tree --quiet > /dev/null 2>&1`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error 'You are not in a git repo'
+    end
+  end
+
+  def in_repo_toplevel_directory
+    print "Checking that you are in the repo's toplevel directory..."
+    toplevel_directory = `git rev-parse --show-toplevel`.chomp
+    if toplevel_directory == FileUtils.pwd
+      puts 'OK'
+    else
+      error "You are not in the repo's toplevel directory"
+    end
+  end
+
+  def on_default_branch
+    print 'Checking that you are on the default branch...'
+    current_branch = `git branch --show-current`.chomp
+    if current_branch == options.default_branch
+      puts 'OK'
+    else
+      error "You are not on the default branch '#{default_branch}'"
+    end
+  end
+
+  def no_uncommitted_changes
+    print 'Checking that there are no uncommitted changes...'
+    if `git status --porcelain | wc -l`.to_i.zero?
+      puts 'OK'
+    else
+      error 'There are uncommitted changes'
+    end
+  end
+
+  def no_staged_changes
+    print 'Checking that there are no staged changes...'
+    if `git diff --staged --name-only | wc -l`.to_i.zero?
+      puts 'OK'
+    else
+      error 'There are staged changes'
+    end
+  end
+
+  def local_and_remote_on_same_commit
+    print 'Checking that local and remote are on the same commit...'
+    local_commit = `git rev-parse HEAD`.chomp
+    remote_commit = `git ls-remote '#{options.remote}' '#{options.default_branch}' | cut -f 1`.chomp
+    if local_commit == remote_commit
+      puts 'OK'
+    else
+      error 'Local and remote are not on the same commit'
+    end
+  end
+
+  def local_tag_does_not_exist
+    print "Checking that local tag '#{options.tag}' does not exist..."
+
+    tags = `git tag --list "#{options.tag}"`.chomp
+    error 'Could not list tags' unless $CHILD_STATUS.success?
+
+    if tags.split.empty?
+      puts 'OK'
+    else
+      error "'#{options.tag}' already exists"
+    end
+  end
+
+  def remote_tag_does_not_exist
+    print "Checking that the remote tag '#{options.tag}' does not exist..."
+    `git ls-remote --tags --exit-code '#{options.remote}' #{options.tag} >/dev/null 2>&1`
+    if $CHILD_STATUS.success?
+      error "'#{options.tag}' already exists"
+    else
+      puts 'OK'
+    end
+  end
+
+  def tag_does_not_exist
+    local_tag_does_not_exist
+    remote_tag_does_not_exist
+  end
+
+  def local_branch_does_not_exist
+    print "Checking that local branch '#{options.branch}' does not exist..."
+
+    if `git branch --list "#{options.branch}" | wc -l`.to_i.zero?
+      puts 'OK'
+    else
+      error "'#{options.branch}' already exists."
+    end
+  end
+
+  def remote_branch_does_not_exist
+    print "Checking that the remote branch '#{options.branch}' does not exist..."
+    `git ls-remote --heads --exit-code '#{options.remote}' '#{options.branch}' >/dev/null 2>&1`
+    if $CHILD_STATUS.success?
+      error "'#{options.branch}' already exists"
+    else
+      puts 'OK'
+    end
+  end
+
+  def branch_does_not_exist
+    local_branch_does_not_exist
+    remote_branch_does_not_exist
+  end
+
+  def print(*args)
+    super unless options.quiet
+  end
+
+  def puts(*args)
+    super unless options.quiet
+  end
+
+  def error(message)
+    warn "ERROR: #{message}"
+    exit 1
+  end
+end
+
+class ReleaseCreator
+  attr_reader :options
+
+  def initialize(options)
+    @options = options
+  end
+
+  def create_release
+    create_branch
+    update_changelog
+    update_version
+    make_release_commit
+    create_tag
+    push_release_commit_and_tag
+    create_github_release
+    create_release_pull_request
+  end
+
+  private
+
+  def create_branch
+    print "Creating branch '#{options.branch}'..."
+    `git checkout -b "#{options.branch}" > /dev/null 2>&1`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error "Could not create branch '#{options.branch}'" unless $CHILD_STATUS.success?
+    end
+  end
+
+  def update_changelog
+    print 'Updating CHANGELOG.md...'
+    changelog_lines = File.readlines('CHANGELOG.md')
+    first_entry = changelog_lines.index { |e| e =~ /^## / }
+    error 'Could not find changelog insertion point' unless first_entry
+    FileUtils.rm('CHANGELOG.md')
+    File.write('CHANGELOG.md', <<~CHANGELOG.chomp)
+      #{changelog_lines[0..first_entry - 1].join.chomp}
+      ## #{options.tag}
+
+      #{changelog(to: 'HEAD').lines[2..].join}
+
+      See https://github.com/ruby-git/ruby-git/releases/tag/#{options.tag}
+
+      #{changelog_lines[first_entry..].join}
+    CHANGELOG
+    `git add CHANGELOG.md`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error 'Could not stage changes to CHANGELOG.md'
+    end
+  end
+
+  def update_version
+    print 'Updating version...'
+    message, status = Bump::Bump.run(options.release_type, commit: false)
+    error 'Could not bump version' unless status.zero?
+    version_file = Bump::Bump.file
+    `git add '#{version_file}'`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error "Could not stage changes to the version file '#{version_file}'"
+    end
+  end
+
+  def make_release_commit
+    print 'Making release commit...'
+    `git commit -s -m 'Release #{options.tag}'`
+    error 'Could not make release commit' unless $CHILD_STATUS.success?
+  end
+
+  def create_tag
+    print "Creating tag '#{options.tag}'..."
+    `git tag '#{options.tag}'`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error "Could not create tag '#{options.tag}'"
+    end
+  end
+
+  def push_release_commit_and_tag
+    print "Pushing branch '#{options.branch}' to remote..."
+    `git push --tags --set-upstream '#{options.remote}' '#{options.branch}' > /dev/null 2>&1`
+    if $CHILD_STATUS.success?
+      puts 'OK'
+    else
+      error 'Could not push release commit'
+    end
+  end
+
+  def changelog(from: options.current_tag, to: options.next_tag)
+    @changelog ||= begin
+      print "Generating changelog from #{from} to #{to}..."
+      pwd = FileUtils.pwd
+      command = "docker run --rm --volume '#{pwd}:/worktree' changelog-rs '#{from}' '#{to}'"
+      changelog = `#{command}`.chomp
+      if $CHILD_STATUS.success?
+        puts 'OK'
+        changelog.rstrip.lines[1..].join
+      else
+        error 'Could not generate the changelog'
+      end
+    end
+  end
+
+  def create_github_release
+    Tempfile.create do |f|
+      f.write changelog
+      f.close
+
+      print "Creating GitHub release '#{options.tag}'..."
+      tag = options.tag
+      `gh release create #{tag} --title 'Release #{tag}' --notes-file '#{f.path}' --target #{options.default_branch}`
+      if $CHILD_STATUS.success?
+        puts 'OK'
+      else
+        error 'Could not create release'
+      end
+    end
+  end
+
+  def create_release_pull_request
+    Tempfile.create do |f|
+      f.write <<~PR
+        ### Your checklist for this pull request
+        🚨Please review the [guidelines for contributing](https://github.com/ruby-git/ruby-git/blob/#{options.default_branch}/CONTRIBUTING.md) to this repository.
+
+        - [X] Ensure all commits include DCO sign-off.
+        - [X] Ensure that your contributions pass unit testing.
+        - [X] Ensure that your contributions contain documentation if applicable.
+
+        ### Description
+        #{changelog}
+
+        ### Next Steps
+
+        DO NOT MERGE THIS PULL REQUEST VIA THE GITHUB UI
+
+        * Get someone to review and approve the release pull request
+        * Merge the pull request manually from the command line with the following commands:
+
+        ```Ruby
+        git checkout #{options.default_branch}
+        git merge --ff-only #{options.branch}
+        git push
+        ````
+      PR
+      f.close
+
+      print 'Creating GitHub pull request...'
+      `gh pr create --title 'Release #{options.tag}' --body-file '#{f.path}' --base '#{options.default_branch}'`
+      if $CHILD_STATUS.success?
+        puts 'OK'
+      else
+        error 'Could not create release pull request'
+      end
+    end
+  end
+
+  def error(message)
+    warn "ERROR: #{message}"
+    exit 1
+  end
+
+  def print(*args)
+    super unless options.quiet
+  end
+
+  def puts(*args)
+    super unless options.quiet
+  end
+end
+
+options = CommandLineParser.new.parse(ARGV)
+ReleaseAssertions.new(options).make_assertions
+puts unless options.quiet
+ReleaseCreator.new(options).create_release
+
+puts <<~MESSAGE unless options.quiet
+  Release '#{options.tag}' created successfully
+  See the release notes at https://github.com/jcouball/release_testing/releases
+
+  Next steps:
+  * Get someone to review and approve the release pull request
+  * Merge the pull request manually from the command line with the following commands:
+
+  git checkout #{options.default_branch}
+  git merge --ff-only #{options.branch}
+  git push
+MESSAGE

data/lib/active_model_persistence/indexable.rb

@@ -56,7 +56,10 @@ module ActiveModelPersistence
     include ActiveModel::Attributes
     include ActiveModelPersistence::PrimaryKey
 
-    class_methods do
+    # When this module is included in another class, ActiveSupport::Concern will
+    # make these class methods on that class.
+    #
+    module ClassMethods
       # Returns a hash of indexes for the model keyed by name
       #
       # @example
@@ -148,6 +151,8 @@ module ActiveModelPersistence
 
       # Defines the default options for a new ActiveModelPersistence::Index
       #
+      # @return [Hash] the default options
+      #
       # @api private
       #
       def default_index_options(index_name)

data/lib/active_model_persistence/persistence.rb

@@ -53,11 +53,16 @@ module ActiveModelPersistence
     include ActiveModelPersistence::PrimaryKey
     include ActiveModelPersistence::PrimaryKeyIndex
 
-    class_methods do
-      # Creates a new model object in to the object store
+    # When this module is included in another class, ActiveSupport::Concern will
+    # make these class methods on that class.
+    #
+    module ClassMethods
+      # Creates a new model object in to the object store and returns it
       #
       # Create a new model object passing `attributes` and `block` to `.new` and then calls `#save`.
       #
+      # The new model object is returned even if it could not be saved to the object store.
+      #
       # @param attributes [Hash, Array<Hash>] attributes
       #
       #   The attributes to set on the model object. These are passed to the model's `.new` method.
@@ -94,6 +99,50 @@ module ActiveModelPersistence
         end
       end
 
+      # Creates a new model object in to the object store
+      #
+      # Raises an error if the object could not be created.
+      #
+      # Create a new model object passing `attributes` and `block` to `.new` and then calls `#save!`.
+      #
+      # @param attributes [Hash, Array<Hash>] attributes
+      #
+      #   The attributes to set on the model object. These are passed to the model's `.new` method.
+      #
+      #   Multiple model objects can be created by passing an array of attribute Hashes.
+      #
+      # @param block [Proc] options
+      #
+      #   The block to pass to the model's `.new` method.
+      #
+      # @example
+      #   m = ModelExample.new(id: 1, name: 'James')
+      #   m.id #=> 1
+      #   m.name #=> 'James'
+      #
+      # @example Multiple model objects can be created
+      #   array_of_attributes = [
+      #     { id: 1, name: 'James' },
+      #     { id: 2, name: 'Frank' }
+      #   ]
+      #   objects = ModelExample.create(array_of_attributes)
+      #   objects.class #=> Array
+      #   objects.size #=> 2
+      #   objects.first.id #=> 1
+      #   objects.map(&:name) #=> ['James', 'Frank']
+      #
+      # @return [Object, Array<Object>] the model object or array of model objects created
+      #
+      # @raise [ModelError] if the model object could not be created
+      #
+      def create!(attributes = nil, &block)
+        if attributes.is_a?(Array)
+          attributes.collect { |attr| create!(attr, &block) }
+        else
+          new(attributes, &block).tap(&:save!)
+        end
+      end
+
       # Return all model objects that have been saved to the object store
       #
       # @example
@@ -128,7 +177,7 @@ module ActiveModelPersistence
         object_array.size
       end
 
-      alias_method(:size, :count)
+      alias size count
 
       # Removes all model objects from the object store
       #
@@ -258,7 +307,7 @@ module ActiveModelPersistence
       #   object.save
       #   ModelExample.all.count #=> 1
       #
-      # @param _options [Hash] save options (currently unused)
+      # @param options [Hash] save options (currently unused)
       # @param block [Proc] a block to call after the save
       #
       # @yield [self] a block to call after the save
@@ -267,12 +316,12 @@ module ActiveModelPersistence
       #
       # @return [Boolean] true if the model object was saved
       #
-      def save(**_options, &block)
-        return false if destroyed?
-
-        result = new_record? ? _create(&block) : _update(&block)
-        update_indexes
-        result != false
+      def save(**options, &block)
+        save!(**options, &block)
+      rescue ModelError
+        false
+      else
+        true
       end
 
       # Calls #save and raises an error if #save returns false
@@ -293,8 +342,13 @@ module ActiveModelPersistence
       #
       # @return [Boolean] returns true or raises an error
       #
-      def save!(**options, &block)
-        save(**options, &block) || raise(ObjectNotSavedError.new('Failed to save the object', self))
+      def save!(**_options, &block)
+        raise ObjectDestroyedError if destroyed?
+        raise ObjectNotValidError unless valid?
+
+        new_record? ? _create(&block) : _update(&block)
+        update_indexes
+        true
       end
 
       # Deletes the object from the object store
@@ -328,10 +382,57 @@ module ActiveModelPersistence
         attributes == other.attributes
       end
 
+      # Updates the attributes of the model and saves it
+      #
+      # The attributes are updated from the passed in hash. If the object is invalid,
+      # the save will fail and false will be returned.
+      #
+      # @example
+      #   object = ModelExample.create(id: 1, name: 'James')
+      #   object.update(name: 'Frank')
+      #   object.find(1).name #=> 'Frank'
+      #
+      # @param attributes [Hash] the attributes to update
+      #
+      # @return [Boolean] true if the model object was saved, otherwise false
+      #
+      def update(attributes)
+        update!(attributes)
+      rescue ModelError
+        false
+      else
+        true
+      end
+
+      # Updates just like #update but an exception is raised of the model is invalid
+      #
+      # @example
+      #   object = ModelExample.create(id: 1, name: 'James')
+      #   object.update!(id: nil) #=> raises ObjectNotSavedError
+      #
+      # @param attributes [Hash] the attributes to update
+      #
+      # @return [Boolean] true if the model object was saved, otherwise an error is raised
+      #
+      # @raise [ObjectNotValidError] if the model object is invalid
+      # @raise [ObjectDestroyedError] if the model object was previously destroyed
+      #
+      def update!(attributes)
+        raise ObjectDestroyedError if destroyed?
+
+        assign_attributes(attributes)
+        save!
+      end
+
       private
 
       # Creates a record with values matching those of the instance attributes
       # and returns its id.
+      #
+      # @return [Object] the primary_key of the created object
+      #
+      # @api private
+      #
       def _create
         return false unless primary_key?
         raise UniqueContraintError if primary_key_index.include?(primary_key)
@@ -345,10 +446,18 @@ module ActiveModelPersistence
         primary_key
       end
 
+      # Updates an object that is already in the object store
+      #
+      # @return [Boolean] true if the object was update successfully, otherwise raises a ModelError
+      #
+      # @api private
+      #
       def _update
         raise RecordNotFound unless primary_key_index.include?(primary_key)
 
         yield(self) if block_given?
+
+        true
       end
     end
     # rubocop:enable Metrics/BlockLength

data/lib/active_model_persistence/primary_key.rb

@@ -38,7 +38,10 @@ module ActiveModelPersistence
     include ActiveModel::Model
     include ActiveModel::Attributes
 
-    class_methods do
+    # When this module is included in another class, ActiveSupport::Concern will
+    # make these class methods on that class.
+    #
+    module ClassMethods
       # Identifies the attribute that the `primary_key` accessor maps to
       #
       # The primary key is 'id' by default.

data/lib/active_model_persistence/primary_key_index.rb

@@ -16,7 +16,10 @@ module ActiveModelPersistence
     include ActiveModelPersistence::PrimaryKey
     include ActiveModelPersistence::Indexable
 
-    class_methods do
+    # When this module is included in another class, ActiveSupport::Concern will
+    # make these class methods on that class.
+    #
+    module ClassMethods
       # Finds an object in the :primary_key index whose primary matches the given value
       #
       # @example
@@ -37,10 +40,10 @@ module ActiveModelPersistence
         find_by_primary_key(primary_key_value).first
       end
 
-      private
-
       # Create the primary key index
       #
+      # @return [void]
+      #
       # @api private
       #
       def self.extended(base)
@@ -49,6 +52,12 @@ module ActiveModelPersistence
     end
 
     included do
+      # Returns the primary key index
+      #
+      # @return [ActiveModelPersistence::Index]
+      #
+      # @api private
+      #
       def primary_key_index
         self.class.indexes[:primary_key]
       end

data/lib/active_model_persistence/version.rb

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

data/lib/active_model_persistence.rb

@@ -18,31 +18,10 @@ module ActiveModelPersistence
   class UniqueConstraintError < ModelError; end
 
   # Raised when trying to save an invalid object
-  class ObjectNotSavedError < ModelError
-    # The object that was not saved
-    #
-    # @example
-    #   object = Object.new
-    #   error = ObjectNotSavedError.new('Invalid object', object)
-    #   error.object == object #=> true
-    #
-    # @return [Object] The object that was not saved
-    #
-    attr_reader :object
+  class ObjectNotValidError < ModelError; end
 
-    # Create a new error
-    #
-    # @example
-    #   ObjectNotSavedError.new('Invalid object', self)
-    #
-    # @param message [String] The error message
-    # @param object [Object] The object that was not saved
-    #
-    def initialize(message = nil, object = nil)
-      @object = object
-      super(message)
-    end
-  end
+  # Raised when trying to save! or update! an object that has already been destroyed
+  class ObjectDestroyedError < ModelError; end
 end
 
 require_relative 'active_model_persistence/index'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_persistence
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -197,6 +197,7 @@ files:
 - Rakefile
 - active_model_persistence.gemspec
 - bin/console
+- bin/create-release
 - bin/setup
 - lib/active_model_persistence.rb
 - lib/active_model_persistence/index.rb