activerecord-null 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bb3c3183d7c9c124c3858a72534649bf8e501f6371942e8a1a06697df1caadf
-  data.tar.gz: c280cf8d79aba38ded094dd6140f2ff4f7075b295531326f4e23ecb2df7a4524
+  metadata.gz: f5da1cf27cad7e88a6c6696874f43ea35670baea4ba390b6d19d2ab9f044d842
+  data.tar.gz: fd69ad9dfe3b66e186aecb8b6b8411d814fad60ad908d2816e0e9a0ac2ad0a39
 SHA512:
-  metadata.gz: c861a1f9cb0cc2685e6a611810521539ae1c6e91bff2864607d44f342380d1822bb9cd7f0ed32b9791d6e52dcc7e8c57b7a7ee01371964b6df25c0b8df83b3a5
-  data.tar.gz: 9aa04f050ad57a08a6005b8ac01b27548644a4098e301452a58d3c8f5d66c4d76efc158b5d6cb1347c36ae7906e2b01c00eaba0add423621c4a54963b9687f5e
+  metadata.gz: 5c9f845b168b47184197bfc10367fc4a7b93bec34e9f31e01a81a88c64b4a55e7b1d09e911ed08cf19eb562738cc9255f43e43a03d5a832ced57d295e642fcca
+  data.tar.gz: a7fb4fe100e29d9151d2fefd5696db658171f4c061a0ded77424b7c1d2e947db4fec50c4c5d6cb0132a56463b22bfddc0da98ce064670d02c1713b159b1042bf

data/CHANGELOG.md

@@ -5,8 +5,16 @@ 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
+## [0.1.2] - 2025-06-17
+
+## [0.1.1] - 2024-10-25
 
 ### Added
 
-- Initial release
+- `null?` method to both parent class objects and null objects
+- Null objects now have default nil values for attributes of the mimic model class
+- `Null()` method can now accept a hash of attribute names and values to assign to the null object
+- `has_query_constraints?` method to null objects
+- `respond_to?` method to null objects
+- `_read_attribute` method to null objects
+- Null class now return false for `composite_primary_key?`

data/README.md

@@ -48,6 +48,26 @@ It will even work with associations.
 User.null.posts # => []
 ```
 
+By default, the null object will have the same attributes as the original model and will return `nil` for all attributes.
+
+You can override this by passing a hash to the `Null` method where the key is an array of attributes and the value is the value to return for the attribute.
+
+```ruby
+class User < ApplicationRecord
+  Null([:name, :team_name] => "Unknown") do
+    def other_attribute = "Other"
+  end
+end
+```
+
+You may also pass a callable to the hash which will be used to determine the value for the attribute.
+
+```ruby
+class User < ApplicationRecord
+  Null([:name, :team_name] => -> { "Unknown" })
+end
+```
+
 ## 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.

data/lib/activerecord/null/mimic.rb

@@ -17,6 +17,18 @@ module ActiveRecord
         def self.table_name = @mimic_model_class.to_s.tableize
 
         def self.primary_key = @mimic_model_class.primary_key
+
+        def self.define_attribute_methods(attribute_names, value: nil)
+          attribute_names.each do |attribute_name|
+            unless method_defined?(attribute_name)
+              if value.is_a?(Proc)
+                define_method(attribute_name, &value)
+              else
+                define_method(attribute_name) { value }
+              end
+            end
+          end
+        end
       end
 
       def mimic_model_class = self.class.mimic_model_class
@@ -34,12 +46,16 @@ module ActiveRecord
         end
       end
 
+      def null? = true
+
       def destroyed? = false
 
       def new_record? = false
 
       def persisted? = false
 
+      def _read_attribute(_) = nil
+
       def method_missing(method, ...)
         reflections = mimic_model_class.reflect_on_all_associations
         if (reflection = reflections.find { |r| r.name == method })
@@ -63,7 +79,7 @@ module ActiveRecord
       private
 
       def define_memoized_association(method, value)
-        define_singleton_method(method) do
+        self.class.define_method(method) do
           if instance_variable_defined?(:"@#{method}")
             instance_variable_get(:"@#{method}")
           else

data/lib/activerecord/null/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveRecord
   module Null
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/activerecord/null.rb

@@ -15,25 +15,62 @@ module ActiveRecord
     # Define a Null class for the given class.
     #
     # @example
-    #   class Business
+    #   class Business < ApplicationRecord
     #     Null do
     #       def name = "None"
     #     end
     #   end
     #
     #   Business.null # => #<Business::Null:0x0000000000000000>
+    #   Business.null.name # => "None"
     #
-    def Null(klass = self, &)
+    #   class User < ApplicationRecord
+    #     Null([:name, :team_name] => "Unknown")
+    #   end
+    #
+    #   User.null.name # => "Unknown"
+    #   User.null.team_name # => "Unknown"
+    #
+    # @param inherit [Class] The class from which the Null object inherits attributes
+    # @param assignments [Array] The attributes to assign to the null object
+    def Null(inherit = self, assignments = {}, &)
+      if inherit.is_a?(Hash)
+        assignments = inherit
+        inherit = self
+      end
       null_class = Class.new do
         include ::ActiveRecord::Null::Mimic
-        mimics klass
+        mimics inherit
 
         include Singleton
+
+        class << self
+          def method_missing(method, ...)
+            mimic_model_class.respond_to?(method) ? mimic_model_class.send(method, ...) : super
+          end
+
+          def respond_to_missing?(method, include_private = false)
+            mimic_model_class.respond_to?(method, include_private) || super
+          end
+        end
+      end
+      null_class.class_eval(&) if block_given?
+
+      nil_assignments = inherit.attribute_names
+      if assignments.any?
+        assignments.each do |attributes, value|
+          nil_assignments -= attributes
+          null_class.define_attribute_methods(attributes, value:)
+        end
       end
-      null_class.class_eval(&)
-      const_set(:Null, null_class)
+      null_class.define_attribute_methods(nil_assignments)
+      inherit.const_set(:Null, null_class)
+
+      inherit.define_singleton_method(:null) { null_class.instance }
+    end
 
-      define_singleton_method(:null) { null_class.instance }
+    def self.extended(base)
+      base.define_method(:null?) { false }
     end
   end
 end

data/test/activerecord/test_null.rb

@@ -15,13 +15,15 @@ end
 
 class Post < ApplicationRecord
   belongs_to :user
+
+  Null([:description] => -> { "From the callable!" })
 end
 
 class User < ApplicationRecord
   belongs_to :business
   has_many :posts
 
-  Null do
+  Null([:team_name, :other] => "Unknown") do
     def name = "None"
   end
 end
@@ -33,7 +35,23 @@ class ActiveRecord::TestNull < Minitest::Spec
     end
   end
 
+  describe ".has_query_constraints?" do
+    it "returns false" do
+      expect(User::Null.has_query_constraints?).must_equal false
+    end
+  end
+
+  describe ".composite_primary_key?" do
+    it "returns false" do
+      expect(User::Null.composite_primary_key?).must_equal false
+    end
+  end
+
   describe "Null" do
+    it "is null" do
+      expect(User.null.null?).must_equal true
+    end
+
     it "is not persisted" do
       expect(User.null.persisted?).must_equal false
     end
@@ -82,5 +100,35 @@ class ActiveRecord::TestNull < Minitest::Spec
       expect(User.null.posts).must_be_kind_of ActiveRecord::Relation
       expect(User.null.posts.to_a).must_equal []
     end
+
+    it "has default nil values for attributes of the mimic model class" do
+      expect(Post.null.title).must_be_nil
+    end
+
+    it "creates a Null object without a block" do
+      expect(Post.null).must_be_instance_of Post::Null
+    end
+
+    it "assigns the named attributes with the given values" do
+      expect(User.null.team_name).must_equal "Unknown"
+    end
+
+    it "assigns callable values to attributes" do
+      expect(Post.null.description).must_equal "From the callable!"
+    end
+
+    it "reads attributes and returns nil" do
+      expect(Post.null._read_attribute(:description)).must_be_nil
+    end
+
+    it "responds to mimic methods" do
+      expect(Post.null.respond_to?(:description)).must_equal true
+    end
+  end
+
+  describe "Parent class object" do
+    it "is not null" do
+      expect(User.new.null?).must_equal false
+    end
   end
 end

data/test/support/schema.rb

@@ -5,11 +5,13 @@ ActiveRecord::Schema.define do
 
   create_table :users do |t|
     t.string :name
+    t.integer :team_name
     t.references :business
   end
 
   create_table :posts do |t|
     t.string :title
+    t.string :description
     t.references :user
   end
 end

data/test/test_helper.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-null
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Jim Gay
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -49,7 +48,6 @@ 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
@@ -64,8 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Null Objects for ActiveRecord
 test_files: []