activerecord-null 0.1.0 → 0.1.1

checksums.yaml

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

data/CHANGELOG.md

@@ -5,6 +5,14 @@ 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.1] - 2024-10-25
+
+### Added
+
+- `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
+
 ## [0.1.0] - 2024-10-23
 
 ### Added

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,6 +46,8 @@ module ActiveRecord
         end
       end
 
+      def null? = true
+
       def destroyed? = false
 
       def new_record? = false
@@ -63,7 +77,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.1"
   end
 end

data/lib/activerecord/null.rb

@@ -15,25 +15,52 @@ 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
       end
-      null_class.class_eval(&)
-      const_set(:Null, null_class)
+      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.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
@@ -34,6 +36,10 @@ class ActiveRecord::TestNull < Minitest::Spec
   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 +88,27 @@ 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
+  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,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-null
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-23 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord