lazy_lazer 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87770d766cb1cb91b1a3ce364d73798d4755b3c7
-  data.tar.gz: 9836626f19ab5a49e6b5e77e1839da36c3c6d4e3
+  metadata.gz: 02623a4fd292219e52a37ab7ff9403f19a04341f
+  data.tar.gz: '0609a64cf39456530d98a0d317055256cf004317'
 SHA512:
-  metadata.gz: 8edcaba9086ee82a9faf1a967dc96bc2c70788b1203b897afd9fca8e009cbb4c4bdf2521c035fc70f26f1f1267fafbc4381b417f8d0c9391e7d22e21d1a69ca1
-  data.tar.gz: 21860070fa84bbc2c19d12f1d535cd0227c235e6ebf8af5ed49275d4c0928d25001bb82a70809871fdda68ec15dfb1c69759fe58e5ea55f4ff7035d01afbd63e
+  metadata.gz: 315a2b347aca6b3c668f167cd086ede566861f9c1c5a5ebf6dad5ddf3d41fb7409007af3e8f812d7f75aa94487d35940bef90a076d589d0c3bcf4bddfe0fc3b0
+  data.tar.gz: 12020aba963d98ab204e3809a60327d7d447adf014a4bfada76aa3ff04745ddd1db3be95bee301ba6339a120d6088d9bb1aaa56cb880e4c1ef88a9d18270c17f

data/README.md

@@ -8,22 +8,34 @@ require 'lazy_lazer'
 class User
   include LazyLazer
 
-  property :id, :identity, :required
+  property :name, :required
   property :email, default: 'unknown@example.com'
   property :created_at, from: :creation_time_utc, with: ->(t) { Time.at(t) }
   property :age, with: :to_i
   property :twitter_handle, :nil
   property :favorite_ice_cream
 
+  def try_another_flavor!
+    if exists_locally?(:favorite_ice_cream)
+      puts "#{name} currently likes #{favorite_ice_cream}."
+    else
+      puts "#{name} doesn't have a favorite ice cream flavor yet."
+    end
+    invalidate(:favorite_ice_cream)
+    puts "#{name} just tried #{favorite_ice_cream}. They love it!"
+  end
+
+  private
+
   def lazer_reload
     fully_loaded! # mark model as fully updated
     { favorite_ice_cream: %w[vanilla strawberry chocolate].sample }
   end
 end
 
-user = User.new(id: 152, creation_time_utc: 1500000000, age: '21')
+user = User.new(name: 'Blinky', creation_time_utc: 1500000000, age: '21')
 
-user.id             #=> 152
+user.name             #=> 'Blinky'
 user.email          #=> "unknown@example.com"
 user.created_at     #=> 2017-07-14 03:40:00 +0100
 user.age            #=> 21
@@ -32,6 +44,10 @@ user.twitter_handle #=> nil
 user.favorite_ice_cream         #=> "chocolate"
 user.favorite_ice_cream         #=> "chocolate"
 user.reload.favorite_ice_cream  #=> "vanilla"
+
+user.try_another_flavor!
+#=> Blinky currently likes vanilla.
+#=> Blinky just tried strawberry. They love it!
 ```
 
 <p align="center">

data/lib/lazy_lazer.rb

@@ -60,6 +60,11 @@ module LazyLazer
 
   # The methods to extend the instance with.
   module InstanceMethods
+    extend Forwardable
+
+    def_delegators :@_lazer_model, :to_h, :inspect, :read_attribute, :write_attribute, :fully_loaded?, :fully_loaded!, :not_fully_loaded!, :invalidate, :exists_locally?
+    private :fully_loaded!, :not_fully_loaded!, :invalidate, :exists_locally?
+
     # Create a new instance of the class from a set of source attributes.
     # @param attributes [Hash] the model attributes
     # @return [void]
@@ -82,34 +87,6 @@ module LazyLazer
       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
-      @_lazer_model.parent_to_h
-    end
-
-    # @return [String] a human-friendly view of the model
-    def inspect
-      @_lazer_model.parent_inspect
-    end
-
-    # Reload the object. Calls {#lazer_reload}, then merges the results into the internal store.
-    # Also clears out the internal cache.
-    # @return [self] the updated object
-    def reload
-      new_attributes = lazer_reload.to_h
-      @_lazer_model.merge!(new_attributes)
-      self
-    end
-
-    # Return the value of the attribute.
-    # @param key_name [Symbol] the attribute name
-    # @return [Object] the returned value
-    # @raise MissingAttribute if the key was not found
-    def read_attribute(key_name)
-      @_lazer_model.read_attribute(key_name.to_sym)
-    end
-
     # Return the value of the attribute, returning nil if not found.
     # @param key_name [Symbol] the attribute name
     # @return [Object] the returned value
@@ -119,14 +96,6 @@ module LazyLazer
       nil
     end
 
-    # Update an attribute.
-    # @param key_name [Symbol] the attribute to update
-    # @param new_value [Object] the new value
-    # @return [Object] the written value
-    def write_attribute(key_name, new_value)
-      @_lazer_model.write_attribute(key_name, new_value)
-    end
-
     # Update multiple attributes at once.
     # @param new_attributes [Hash<Symbol, Object>] the new attributes
     # @return [self] the updated object
@@ -136,9 +105,13 @@ module LazyLazer
     end
     alias attributes= assign_attributes
 
-    # @return [Boolean] whether the object is done with lazy loading
-    def fully_loaded?
-      @_lazer_model.fully_loaded
+    # Reload the object. Calls {#lazer_reload}, then merges the results into the internal store.
+    # Also clears out the internal cache.
+    # @return [self] the updated object
+    def reload
+      new_attributes = lazer_reload.to_h
+      @_lazer_model.merge!(new_attributes)
+      self
     end
 
     private
@@ -146,27 +119,7 @@ module LazyLazer
     # @abstract Provides reloading behaviour for lazy loading.
     # @return [Hash] the result of reloading the hash
     def lazer_reload
-      fully_loaded!
       {}
     end
-
-    # Mark a key as tainted, forcing a reload on the next lookup.
-    # @param key_name [Symbol] the key to invalidate
-    # @return [void]
-    def invalidate(key_name)
-      @_lazer_model.invalidate(key_name)
-    end
-
-    # Mark the model as fully loaded.
-    # @return [void]
-    def fully_loaded!
-      @_lazer_model.fully_loaded = true
-    end
-
-    # Mark the model as not fully loaded.
-    # @return [void]
-    def not_fully_loaded!
-      @_lazer_model.fully_loaded = false
-    end
   end
 end

data/lib/lazy_lazer/internal_model.rb

@@ -3,9 +3,6 @@
 module LazyLazer
   # A delegator for internal operations.
   class InternalModel
-    # @return [Boolean] whether the model is fully loaded
-    attr_accessor :fully_loaded
-
     # Create an internal model with a reference to a public model.
     # @param key_metadata [KeyMetadataStore] a reference to a metadata store
     # @param parent [LazyLazer] a reference to a LazyLazer model
@@ -18,34 +15,27 @@ module LazyLazer
       @fully_loaded = false
     end
 
-    # Verify that all the keys marked as required are present.
-    # @raise RequiredAttribute if a required attribute is missing
-    # @return [void]
-    def verify_required!
-      @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 required_properties
-      @key_metadata.required_properties
-    end
-
     # Converts all unconverted keys and packages them as a hash.
     # @return [Hash] the converted hash
-    def parent_to_h
+    def to_h
       todo = @key_metadata.keys - @cache_hash.keys
       todo.each_with_object(@cache_hash) { |key, cache| cache[key] = load_key_from_source(key) }.dup
     end
 
     # @return [String] the string representation of the parent
-    def parent_inspect
+    def inspect
       "#<#{@parent.class.name} (#{@fully_loaded ? 'loaded' : 'unloaded'}): [" + \
         @cache_hash.keys.join(', ') + ']>'
     end
 
+    # Whether the key doesn't need to be lazily loaded.
+    # @param key_name [Symbol] the key to check
+    # @return [Boolean] whether the key exists locally.
+    def exists_locally?(key_name)
+      ensure_metadata_exists(key_name)
+      @source_hash.key?(@key_metadata.get(key_name).source_key)
+    end
+
     # Mark a key as tainted, forcing a reload on the next lookup.
     # @param key_name [Symbol] the key to invalidate
     # @return [void]
@@ -58,11 +48,12 @@ module LazyLazer
     # @return [Object] the returned value
     # @raise MissingAttribute if the attribute wasn't found and there isn't a default
     def read_attribute(key_name)
-      if @invalidated.include?(key_name)
+      key_name_sym = key_name.to_sym
+      if @invalidated.include?(key_name_sym)
         @parent.reload
-        @invalidated.delete(key_name)
+        @invalidated.delete(key_name_sym)
       end
-      @cache_hash[key_name] ||= load_key_from_source(key_name)
+      @cache_hash[key_name_sym] ||= load_key_from_source(key_name_sym)
     end
 
     # Update an attribute.
@@ -76,7 +67,42 @@ module LazyLazer
       @cache_hash[key_name] = new_value
     end
 
+    # Mark the model as fully loaded.
+    # @return [void]
+    def fully_loaded!
+      @fully_loaded = true
+    end
+
+    # Mark the model as not fully loaded.
+    # @return [void]
+    def not_fully_loaded!
+      @fully_loaded = false
+    end
+
+    # @return [Boolean] whether the object is done with lazy loading
+    def fully_loaded?
+      @fully_loaded
+    end
+
+    # Verify that all the keys marked as required are present.
+    # @api private
+    # @raise RequiredAttribute if a required attribute is missing
+    # @return [void]
+    def verify_required!
+      @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
+
+    # @api private
+    # @return [Array] the identity properties
+    def required_properties
+      @key_metadata.required_properties
+    end
+
     # Merge a hash into the model.
+    # @api private
     # @param attributes [Hash<Symbol, Object>] the attributes to merge
     def merge!(attributes)
       @cache_hash.clear

data/lib/lazy_lazer/key_metadata.rb

@@ -9,10 +9,10 @@ module LazyLazer
     attr_accessor :source_key
 
     # @return [Boolean] whether the key must exist when creating the model
-    attr_accessor :required
+    attr_writer :required
 
     # @return [Boolean] whether the key must exist when loaded
-    attr_accessor :runtime_required
+    attr_writer :runtime_required
 
     # @return [Proc, Object] the default value or generator
     attr_accessor :default

data/lib/lazy_lazer/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lazy_lazer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Avinash Dwarapu