activerecord-null 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bb3c3183d7c9c124c3858a72534649bf8e501f6371942e8a1a06697df1caadf
+  data.tar.gz: c280cf8d79aba38ded094dd6140f2ff4f7075b295531326f4e23ecb2df7a4524
+SHA512:
+  metadata.gz: c861a1f9cb0cc2685e6a611810521539ae1c6e91bff2864607d44f342380d1822bb9cd7f0ed32b9791d6e52dcc7e8c57b7a7ee01371964b6df25c0b8df83b3a5
+  data.tar.gz: 9aa04f050ad57a08a6005b8ac01b27548644a4098e301452a58d3c8f5d66c4d76efc158b5d6cb1347c36ae7906e2b01c00eaba0add423621c4a54963b9687f5e

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-10-23
+
+### Added
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jim Gay
+
+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,69 @@
+# ActiveRecord::Null
+
+Create null objects for ActiveRecord models.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add activerecord-null
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install activerecord-null
+
+## Usage
+
+Extend your primary abstract class with `ActiveRecord::Null`.
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+  extend ActiveRecord::Null
+end
+```
+
+Define a null object for the model.
+
+```ruby
+class User < ApplicationRecord
+  has_many :posts
+  Null do
+    def name = "None"
+  end
+end
+```
+
+This will create a Singleton class `User::Null` that mimics the `User` class.
+
+Use the null object.
+
+```ruby
+User.null
+```
+
+It will even work with associations.
+
+```ruby
+User.null.posts # => []
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Releasing
+
+Run `rake build:checksum` to build the gem and generate the checksum. This will also update the version number in the gemspec file.
+
+Run `rake release` to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
+
+This will leave a new commit with the version number incremented in the version file and the changelog updated with the new version. Push the changes to the repository.
+
+## Contributing
+
+This gem is managed with [Reissue](https://github.com/SOFware/reissue).
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SOFware/activerecord-null.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test
+
+require "reissue/gem"
+
+Reissue::Task.create :reissue do |task|
+  task.version_file = "lib/activerecord/null/version.rb"
+end

data/lib/activerecord/null/mimic.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActiveRecord
+  module Null
+    module Mimic
+      extend ActiveSupport::Concern
+
+      included do
+        def self.mimics(mimic_model_class)
+          @mimic_model_class = mimic_model_class
+        end
+
+        def self.mimic_model_class = @mimic_model_class
+
+        def self.table_name = @mimic_model_class.to_s.tableize
+
+        def self.primary_key = @mimic_model_class.primary_key
+      end
+
+      def mimic_model_class = self.class.mimic_model_class
+
+      attr_reader :id
+
+      def [](*)
+      end
+
+      def is_a?(klass)
+        if klass == mimic_model_class
+          true
+        else
+          super
+        end
+      end
+
+      def destroyed? = false
+
+      def new_record? = false
+
+      def persisted? = false
+
+      def method_missing(method, ...)
+        reflections = mimic_model_class.reflect_on_all_associations
+        if (reflection = reflections.find { |r| r.name == method })
+          case reflection.macro
+          when :has_many
+            define_memoized_association(method, reflection.klass.none)
+          when :has_one, :belongs_to
+            define_memoized_association(method, reflection.klass.null)
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        mimic_model_class.reflect_on_all_associations.map(&:name).include?(method) || super
+      end
+
+      private
+
+      def define_memoized_association(method, value)
+        define_singleton_method(method) do
+          if instance_variable_defined?(:"@#{method}")
+            instance_variable_get(:"@#{method}")
+          else
+            instance_variable_set(:"@#{method}", value)
+          end
+        end
+        value
+      end
+    end
+  end
+end

data/lib/activerecord/null/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Null
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/null.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "null/version"
+require_relative "null/mimic"
+module ActiveRecord
+  # Extend any ActiveRecord class with this module to add a null object.
+  # Add it to your primary abstract class.
+  #
+  # @example
+  #   class ApplicationRecord < ActiveRecord::Base
+  #     primary_abstract_class
+  #     extend ActiveRecord::Null
+  #   end
+  module Null
+    # Define a Null class for the given class.
+    #
+    # @example
+    #   class Business
+    #     Null do
+    #       def name = "None"
+    #     end
+    #   end
+    #
+    #   Business.null # => #<Business::Null:0x0000000000000000>
+    #
+    def Null(klass = self, &)
+      null_class = Class.new do
+        include ::ActiveRecord::Null::Mimic
+        mimics klass
+
+        include Singleton
+      end
+      null_class.class_eval(&)
+      const_set(:Null, null_class)
+
+      define_singleton_method(:null) { null_class.instance }
+    end
+  end
+end

data/lib/activerecord-null.rb

@@ -0,0 +1 @@
+require_relative "activerecord/null"

data/test/activerecord/test_null.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+  extend ActiveRecord::Null
+end
+
+class Business < ApplicationRecord
+  Null do
+    def name = "None"
+  end
+end
+
+class Post < ApplicationRecord
+  belongs_to :user
+end
+
+class User < ApplicationRecord
+  belongs_to :business
+  has_many :posts
+
+  Null do
+    def name = "None"
+  end
+end
+
+class ActiveRecord::TestNull < Minitest::Spec
+  describe ".null" do
+    it "returns a null object" do
+      expect(User.null).must_be_instance_of User::Null
+    end
+  end
+
+  describe "Null" do
+    it "is not persisted" do
+      expect(User.null.persisted?).must_equal false
+    end
+
+    it "is not a new record" do
+      expect(User.null.new_record?).must_equal false
+    end
+
+    it "is not destroyed" do
+      expect(User.null.destroyed?).must_equal false
+    end
+
+    it "has a nil id" do
+      expect(User.null.id).must_be_nil
+    end
+
+    it "is a User" do
+      expect(User.null.is_a?(User)).must_equal true
+    end
+
+    it "is a User::Null" do
+      expect(User.null.is_a?(User::Null)).must_equal true
+    end
+
+    it "has a mimic model class" do
+      expect(User.null.mimic_model_class).must_equal User
+    end
+
+    it "responds to associations" do
+      expect(User.null.respond_to?(:business)).must_equal true
+    end
+
+    it "has the mimic model class's table name" do
+      expect(User::Null.table_name).must_equal "users"
+    end
+
+    it "has the mimic model class's primary key" do
+      expect(User::Null.primary_key).must_equal "id"
+    end
+
+    it "has a null belongs_to association" do
+      expect(User.null.business).must_be_instance_of Business::Null
+    end
+
+    it "has an empty relation for has_many association" do
+      expect(User.null.posts).must_be_kind_of ActiveRecord::Relation
+      expect(User.null.posts.to_a).must_equal []
+    end
+  end
+end

data/test/support/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define do
+  create_table :businesses do |t|
+    t.string :name
+  end
+
+  create_table :users do |t|
+    t.string :name
+    t.references :business
+  end
+
+  create_table :posts do |t|
+    t.string :title
+    t.references :user
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "simplecov" if ENV["CI"]
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "active_record"
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+load "test/support/schema.rb"
+
+require "activerecord/null"
+
+require "minitest/autorun"

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-null
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Gay
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Create Null Objects for ActiveRecord models with automatic support for
+  empty associations.
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activerecord-null.rb
+- lib/activerecord/null.rb
+- lib/activerecord/null/mimic.rb
+- lib/activerecord/null/version.rb
+- test/activerecord/test_null.rb
+- test/support/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/SOFware/activerecord-null
+licenses: []
+metadata:
+  homepage_uri: https://github.com/SOFware/activerecord-null
+  source_code_uri: https://github.com/SOFware/activerecord-null
+  changelog_uri: https://github.com/SOFware/activerecord-null/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.9
+signing_key:
+specification_version: 4
+summary: Null Objects for ActiveRecord
+test_files: []