lazy_lazer 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fb46e247acf0646c4244899d168dd1cc0071aa4
-  data.tar.gz: e5520c2f153d78ce06664ac034bab8a9ffa51e47
+  metadata.gz: 1f995a4141541e28c93522484e53a3a0e7d36048
+  data.tar.gz: 27aee5cf991dcf61f80fd915c328769a7c3d0889
 SHA512:
-  metadata.gz: c82968d52509e29b0cef1afe8be25ffab2bf6a4230bfcf5237986dbcf27c03b71d051f3061e83b73953bbdd5323b3363a0319aa00e1a561bef94a0b118cc4ab3
-  data.tar.gz: 6bb1896b4df5936b43b88bd9d99200384fad86951a3f37bdda6742678e1629e61216e8ae42f9892bdfafef0b350b770a4119fa5e5d50a101a75b793a599fdd3f
+  metadata.gz: fd15e803ab225318bd4d93664e6756096814605bf084f2b4e7de84f10a63e3656a2c3e637d01f109c6bb962dfff8b7cded01259698c6385dd2c18fbac256521a
+  data.tar.gz: 3826025a30d3dce79d0a2b44dc067e7c59e01bfecf68704192713c39d078b9a1a8e4673bf797b0ba3f1787bf0739e355edac2d3427811cfe0f5c546e7ccfc7c5

data/lib/lazy_lazer/internal_model.rb

@@ -4,7 +4,7 @@ module LazyLazer
   # A delegator for internal operations.
   class InternalModel
     # Create an internal model with a reference to a public model.
-    # @param key_metadata [Hash<Symbol, KeyMetadata>] a reference to a property hash
+    # @param key_metadata [KeyMetadataStore] a reference to a metadata store
     # @param parent [LazyLazer] a reference to a LazyLazer model
     def initialize(key_metadata, parent)
       @key_metadata = key_metadata
@@ -17,12 +17,17 @@ module LazyLazer
     # @raise RequiredAttribute if a required attribute is missing
     # @return [void]
     def verify_required!
-      @key_metadata.each do |key_name, meta|
-        next if !meta.required? || @source_hash.key?(meta.source_key)
+      @key_metadata.required_properties.each do |key_name|
+        next if @source_hash.key?(@key_metadata.get(key_name).source_key)
         raise RequiredAttribute, "#{@parent} requires `#{key_name}`"
       end
     end
 
+    # @return [Array] the identity properties
+    def identity_properties
+      @key_metadata.identity_properties
+    end
+
     # Converts all unconverted keys and packages them as a hash.
     # @return [Hash] the converted hash
     def parent_to_h
@@ -70,7 +75,7 @@ module LazyLazer
     # @return [KeyMetadata] the key metadata, if found
     # @raise MissingAttribute if the key metadata wasn't found
     def ensure_metadata_exists(key_name)
-      return @key_metadata[key_name] if @key_metadata.key?(key_name)
+      return @key_metadata.get(key_name) if @key_metadata.contains?(key_name)
       raise MissingAttribute, "`#{key_name}` isn't defined for #{@parent}"
     end
 

data/lib/lazy_lazer/key_metadata.rb

@@ -6,40 +6,33 @@ module LazyLazer
   # Simple PORO for key metadata. Yay value objects!
   class KeyMetadata
     # @return [Symbol] the key to fetch the value from
-    attr_reader :source_key
+    attr_accessor :source_key
+
+    # @return [Boolean] whether the key must exist when creating the model
+    attr_accessor :required
+
+    # @return [Boolean] whether the key is used for equality comparision
+    attr_accessor :identity
+
+    # @return [Boolean] whether the key must exist when loaded
+    attr_accessor :runtime_required
 
     # @return [Proc, Object] the default value or generator
-    attr_reader :default
+    attr_accessor :default
 
     # @return [Proc, Symbol, nil] the method or proc that transforms the return value
-    attr_reader :transform
+    attr_accessor :transform
 
     # Load attributes from a {LazyLazer::ClassMethods#property} method signature.
     # @see LazyLazer::ClassMethods#property
-    def self.from_options(key_name, *boolean_options, **options)
+    def initialize(key_name, *boolean_options, **options)
       boolean_options.each_with_object(options) { |sym, hsh| hsh[sym] = true }
-      KeyMetadata.new(
-        source_key: options[:from] || key_name,
-        required: !!options[:required],
-        runtime_required: !options.key?(:default) && !options[:nil],
-        transform: options[:with],
-        default: options[:default]
-      )
-    end
-
-    # Create a new KeyMetadata value object with all the properties.
-    # @param source_key [Symbol] the key to fetch the value from
-    # @param required [Boolean] whether the key must exist when creating the model
-    # @param runtime_required [Boolean] whether the key must exist when loaded
-    # @param default [Proc, Object] the default value or generator
-    # @param transform [Proc, Symbol, nil] the method or proc that transforms the return value
-    def initialize(source_key:, required:, runtime_required:, default:, transform:)
-      @source_key = source_key
-      @required = required
-      @runtime_required = runtime_required
-      @default = default
-      @transform = transform
-      freeze
+      self.source_key = options[:from] || key_name
+      self.required = !!options[:required]
+      self.identity = !!options[:identity]
+      self.runtime_required = !options.key?(:default) && !options[:nil]
+      self.transform = options[:with]
+      self.default = options[:default]
     end
 
     # @return [Boolean] whether the key must exist when creating the model
@@ -47,6 +40,11 @@ module LazyLazer
       @required
     end
 
+    # @return [Boolean] whether the key is used for equality comparision
+    def identity?
+      @identity
+    end
+
     # @return [Boolean] whether the key must exist when loaded
     def runtime_required?
       @runtime_required

data/lib/lazy_lazer/key_metadata_store.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module LazyLazer
+  # The key metadata collection class
+  class KeyMetadataStore
+    # @return [Array<Symbol>] the required properties
+    attr_reader :required_properties
+
+    # @return [Array<Symbol>] the identity properties
+    attr_reader :identity_properties
+
+    def initialize
+      @collection = {}
+      @required_properties = []
+      @identity_properties = []
+    end
+
+    # Add a KeyMetadata to the store.
+    # @param key [Symbol] the key
+    # @param meta [KeyMetadata] the key metadata
+    # @return [KeyMetadata] the provided meta
+    def add(key, meta)
+      @collection[key] = meta
+      @required_properties << key if meta.required?
+      @identity_properties << key if meta.identity?
+      meta
+    end
+
+    # @return [Array<Symbol>] the keys in the store
+    def keys
+      @collection.keys
+    end
+
+    # @return [Boolean] whether the store contains the key
+    def contains?(key)
+      @collection.key?(key)
+    end
+
+    # @return [KeyMetadata] fetch the metadata from the store
+    def get(key)
+      @collection.fetch(key)
+    end
+  end
+end

data/lib/lazy_lazer/version.rb

@@ -2,5 +2,5 @@
 
 module LazyLazer
   # The gem's semantic version number.
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/lib/lazy_lazer.rb

@@ -2,6 +2,7 @@
 
 require_relative 'lazy_lazer/errors'
 require_relative 'lazy_lazer/internal_model'
+require_relative 'lazy_lazer/key_metadata_store'
 require_relative 'lazy_lazer/key_metadata'
 require_relative 'lazy_lazer/version'
 
@@ -17,7 +18,7 @@ module LazyLazer
   def self.included(base)
     base.extend(ClassMethods)
     base.include(InstanceMethods)
-    base.instance_variable_set(:@lazer_metadata, {})
+    base.instance_variable_set(:@_lazer_metadata, KeyMetadataStore.new)
   end
 
   # The methods to extend the class with.
@@ -26,12 +27,7 @@ module LazyLazer
     # @param klass [Class] the subclass
     # @return [void]
     def inherited(klass)
-      klass.instance_variable_set(:@lazer_metadata, @lazer_metadata.dup)
-    end
-
-    # @return [Hash<Symbol, Hash>] the lazer configuration for this model
-    def lazer_metadata
-      @lazer_metadata
+      klass.instance_variable_set(:@_lazer_metadata, @_lazer_metadata.dup)
     end
 
     # Define a property.
@@ -40,6 +36,7 @@ module LazyLazer
     # @param options [Hash] the options to create the property with
     # @option options [Boolean] :required (false) whether existence of this property should be
     #   checked on model creation
+    # @option options [Boolean] :identity (false) use this key for equality comparisions
     # @option options [Boolean] :nil (false) shortcut for default: nil
     # @option options [Object, Proc] :default the default value to return if not provided
     # @option options [Symbol] :from (name) the key in the source object to get the property from
@@ -57,7 +54,7 @@ module LazyLazer
     #   end
     def property(name, *bool_options, **options)
       sym_name = name.to_sym
-      @lazer_metadata[sym_name] = KeyMetadata.from_options(sym_name, *bool_options, **options)
+      @_lazer_metadata.add(sym_name, KeyMetadata.new(sym_name, *bool_options, **options))
       define_method(sym_name) { read_attribute(sym_name) }
     end
   end
@@ -69,13 +66,25 @@ module LazyLazer
     # @return [void]
     # @raise RequiredAttribute if an attribute marked as required wasn't found
     def initialize(attributes = {})
-      @_lazer_model = InternalModel.new(self.class.lazer_metadata, self)
+      @_lazer_model = InternalModel.new(self.class.instance_variable_get(:@_lazer_metadata), self)
       @_lazer_model.merge!(attributes)
       @_lazer_model.verify_required!
       @_lazer_writethrough = {}
       @_lazer_loaded = false
     end
 
+    # Equality check.
+    # @param other [Object] the other object
+    # @return [Boolean]
+    def ==(other)
+      return false if self.class != other.class
+      return super if @_lazer_model.identity_properties.empty?
+      @_lazer_model.identity_properties.each do |key_name|
+        return false if self[key_name] != other[key_name]
+      end
+      true
+    end
+
     # Converts all the attributes that haven't been converted yet and returns the final hash.
     # @return [Hash] a hash representation of the model
     def to_h

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy_lazer
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Avinash Dwarapu
@@ -132,6 +132,7 @@ files:
 - lib/lazy_lazer/errors.rb
 - lib/lazy_lazer/internal_model.rb
 - lib/lazy_lazer/key_metadata.rb
+- lib/lazy_lazer/key_metadata_store.rb
 - lib/lazy_lazer/version.rb
 - logo.png
 homepage: https://github.com/avinashbot/lazy_lazer