lazy_lazer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a24047c46cd370e8fb1d092129dacb1816f50ebc
-  data.tar.gz: 072b5a1b15857682e4317eb8f275685462199e3e
+  metadata.gz: 5ccb5b8a20cfa62e4ef74b7932724ef9c9f85629
+  data.tar.gz: 5f7ad225cf5db86c6bb46625e2738aa8bd547cf1
 SHA512:
-  metadata.gz: de1fb716edf702586d593c085256d984ee3bd8cf0be8811381ac1d6eec10451146fa16f0e88f89a9561ad54d2242a255fc5351c1c6f0d961a2b01dc0e1c62f2d
-  data.tar.gz: ada536d3a04d7ce62beff22a4e2afb1d1cf38bf1aa51cae3f08e1e2bed9f2848cecb42b5af8d047c4cea6a2260864749ee9ac5975748f525bbc51c72f29749c8
+  metadata.gz: 7846d9d05da36c2436f1a5b64005544dd1080d8515b0a1814d3a395288c3b5306c383fa163de03402a06f364a98ac58418ae0a6180f3e36f1b164e6aca56ee8e
+  data.tar.gz: eb973fec67fe6a6371c7ebd16bd67975dfab424068f87af1643b98ec8095fee98e31667b704523f4c57a2ff0b1c3be56474cd9f13ccfa016eadd2bf1870031d7

data/README.md

@@ -1,11 +1,10 @@
-**lazy lazer**
-
-**features**:
-- simple codebase (~110 lines of code, ~200 lines of tests)
-- doesn't inherit all of the Hash and Enumerable cruft
-- super lazy, doesn't even parse attributes until it's necessary
+<p align="center">
+  <img src="https://raw.githubusercontent.com/avinashbot/lazy_lazer/master/logo.png" width="500">
+</p>
 
 ```ruby
+require 'lazy_lazer'
+
 class User
   include LazyLazer
 
@@ -32,3 +31,14 @@ user.age         #=> 21
 user.favorite_ice_cream         #=> "chocolate"
 user.reload.favorite_ice_cream  #=> "vanilla"
 ```
+
+<p align="center">
+licensed under
+<a href="https://github.com/avinashbot/lazy_lazer/blob/master/LICENSE.txt">mit</a>
+-
+created for
+<a href="https://github.com/avinashbot/redd">redd</a>
+-
+logo font is
+<a href="https://www.behance.net/gallery/3588289/Zaguatica">zaguatica</a>
+</p>

data/lib/lazy_lazer/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module LazyLazer
-  VERSION = '0.3.0'
+  # The gem's semantic version number.
+  VERSION = '0.3.1'
 end

data/lib/lazy_lazer.rb

@@ -3,7 +3,7 @@
 require_relative 'lazy_lazer/version'
 require_relative 'lazy_lazer/errors'
 
-# LazyLazer
+# The LazyLazer root that's included
 module LazyLazer
   # Hook into `include LazyLazer`.
   # @param [Module] base the object to include the methods in
@@ -22,8 +22,8 @@ module LazyLazer
   end
 
   # Get the source key from an instance
-  # @param [Object] instance the instance
-  # @param [Symbol] key the property key
+  # @param instance [Object] the instance
+  # @param key [Symbol] the property key
   # @return [Symbol] the source key if found or the passed key if not found
   def self.source_key(instance, key)
     instance.class.lazer_metadata[:from].fetch(key, key)
@@ -32,7 +32,7 @@ module LazyLazer
   # The methods to extend the class with.
   module ClassMethods
     # Copies parent properties into subclasses.
-    # @param [Class] klass the subclass
+    # @param klass [Class] the subclass
     # @return [void]
     def inherited(klass)
       klass.instance_variable_set(:@lazer_metadata, @lazer_metadata)
@@ -44,8 +44,8 @@ module LazyLazer
     end
 
     # Define a property.
-    # @param [Symbol] name the name of the property method
-    # @param [Hash] options the options to create the property with
+    # @param name [Symbol] the name of the property method
+    # @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 [Object, Proc] :default the default value to return if not provided
@@ -65,7 +65,7 @@ module LazyLazer
   # The methods to extend the instance with.
   module InstanceMethods
     # Create a new instance of the class from a set of source attributes.
-    # @param [Hash] attributes the model attributes
+    # @param attributes [Hash] the model attributes
     # @return [void]
     def initialize(attributes = {})
       # Check that all required attributes exist.
@@ -79,7 +79,7 @@ module LazyLazer
     end
 
     # Converts all the attributes that haven't been converted yet and returns the final hash.
-    # @param [Boolean] strict whether to fully load all attributes
+    # @param strict [Boolean] whether to fully load all attributes
     # @return [Hash] a hash representation of the model
     def to_h(strict = true)
       if strict
@@ -91,14 +91,13 @@ module LazyLazer
 
     # @abstract Provides reloading behaviour for lazy loading.
     # @return [Hash] the result of reloading the hash
-    # @note if necessary, subclasses can make this method private, so this isn't tested.
     def lazer_reload
       self.fully_loaded = true
       {}
     end
 
     # Reload the object. Calls {#lazer_reload}, then merges the results into the internal store.
-    # Also evicts the internal cache of the new keys.
+    # Also clears out the internal cache.
     # @return [self] the updated object
     def reload
       new_attributes = lazer_reload
@@ -108,7 +107,7 @@ module LazyLazer
     end
 
     # Return the value of the attribute.
-    # @param [Symbol] name the attribute name
+    # @param name [Symbol] the attribute name
     # @raise MissingAttribute if the key was not found
     def read_attribute(name)
       # Returns the cached attribute.
@@ -150,7 +149,7 @@ module LazyLazer
     end
 
     # Return the value of the attribute, returning nil if not found
-    # @param [Symbol] name the attribute name
+    # @param name [Symbol] the attribute name
     def [](name)
       read_attribute(name)
     rescue MissingAttribute
@@ -158,14 +157,14 @@ module LazyLazer
     end
 
     # Update an attribute.
-    # @param [Symbol] attribute the attribute to update
+    # @param attribute [Symbol] the attribute to update
     # @param [Object] value the new value
     def write_attribute(attribute, value)
       @_lazer_cache[attribute] = value
     end
 
     # Update multiple attributes at once.
-    # @param [Hash<Symbol, Object>] new_attributes the new attributes
+    # @param new_attributes [Hash<Symbol, Object>] the new attributes
     def assign_attributes(new_attributes)
       new_attributes.each { |key, value| write_attribute(key, value) }
     end
@@ -178,7 +177,7 @@ module LazyLazer
 
     private
 
-    # @param [Boolean] state the new state
+    # @param state [Boolean] the new state
     def fully_loaded=(state)
       @_lazer_fully_loaded = state
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_lazer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-20 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/lazy_lazer.rb
 - lib/lazy_lazer/errors.rb
 - lib/lazy_lazer/version.rb
+- logo.png
 homepage: https://github.com/avinashbot/lazy_lazer
 licenses:
 - MIT