lazy_lazer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b97391a59b7f022f99a5211abffff9d9baeb907
+  data.tar.gz: 54639abaacb86f5be191f3d0d98fcc0172486587
+SHA512:
+  metadata.gz: 44492444116d6d9fee06516379daa59801977ffe9dbdf5578534711030a43e06ae019d1ec38ec6a913300089fc5189b8b2c56eec356ee8ee58976f2a3f5ad2c6
+  data.tar.gz: 192948daba02e2c91815856085bf115fc1d072c6615f45dcd34934ca52f3ac95fd4cc2d670c4b561df43d1102450669d9a0420c0b2d3314e363de5c1b4c520ca

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+
+# Dumb, but also brand new.
+Style/NumericPredicate:
+  Enabled: false
+
+# Stop rubocop from complaining about large `describe` blocks.
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# Lower severity of complexity metrics.
+Metrics/AbcSize:
+  Severity: refactor
+Metrics/CyclomaticComplexity:
+  Severity: refactor
+Metrics/PerceivedComplexity:
+  Severity: refactor

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lazy_lazer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec -fp' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { 'spec' }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Avinash Dwarapu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+**lazy lazer**
+
+**features**:
+- simple codebase (~100 lines of code)
+- doesn't inherit all of the Hash and Enumerable cruft
+- super lazy, doesn't even parse attributes until it's necessary
+
+```ruby
+class User
+  include LazyLazer
+
+  # User.new(first_name: 'John')  #=> Error: missing `id`
+  # User.new(id: 1).id?  #=> true
+  property :id, required: true
+
+  # user = User.new(id: 1)
+  # user.email  #=> nil
+  property :email, default: nil
+
+  # user = User.new(id: 1)
+  # user.preferred_language  #=> :en_US
+  property :preferred_language, default: :en_US
+
+  # user = User.new(id: 1, first_name: 'John')
+  # user.name  #=> 'John'
+  # user.first_name  #=> NoMethodError: ...
+  property :last_name, default: -> { '<last name>' }
+
+  # user = User.new(id: 1, created_at: 1502834161)
+  # user.created_at  #=> 2017-08-15 22:56:13 +0100
+  property :created_at, with: ->(time) { Time.at(time) }
+
+  # user = User.new(id: 1, age: '45')
+  # user.age  #=> 45
+  property :age, with: :to_i
+
+  def reload
+    update_attributes!(...) # update your attributes somehow
+    fully_loaded = true # model is fully updated, no more lazy loading necessary
+    self # a rails convention, totally optional
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.options = ['--fail-level', 'convention']
+end
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/_guard-core

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require_relative '../lib/lazy_lazer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/guard

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lazy_lazer.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lazy_lazer/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'lazy_lazer'
+  spec.version  = LazyLazer::VERSION
+  spec.authors  = ['Avinash Dwarapu']
+  spec.email    = ['avinash@dwarapu.me']
+
+  spec.summary  = 'Create lazily loadable models.'
+  spec.homepage = 'https://github.com/avinashbot/lazy_lazer'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/lib/lazy_lazer/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module LazyLazer
+  # This is raised when a required attribute isn't included.
+  class RequiredAttribute < StandardError; end
+
+  # Raised when a missing attribute is called but a default isn't present.
+  class MissingAttribute < StandardError; end
+end

data/lib/lazy_lazer/utilities.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module LazyLazer
+  # Utility methods.
+  # @api private
+  module Utilities
+    # Get a value from a hash, calling the default if needed.
+    # @param [Hash] source the hash to lookup
+    # @param [Symbol] key the key to lookup
+    # @param [Proc, Object] default the default value or Proc to call
+    # @return the object or the default value
+    def self.lookup_default(source, key, default)
+      return source[key] if source.key?(key)
+      return default.call if default.is_a?(Proc)
+      default
+    end
+
+    # Transforms a value using a "transformer" supplied using :with.
+    # @param [Object] value the value to transform
+    # @param [nil, Symbol, Proc] transformer the transformation method
+    # @param [Object] context the context to run the proc in
+    # @return [Object] the result of applying the transformation to the value
+    def self.transform_value(value, transformer)
+      case transformer
+      when nil
+        value
+      when Symbol
+        value.public_send(transformer)
+      when Proc
+        transformer.call(value)
+      end
+    end
+  end
+end

data/lib/lazy_lazer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LazyLazer
+  VERSION = '0.1.0'
+end

data/lib/lazy_lazer.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative 'lazy_lazer/version'
+require_relative 'lazy_lazer/errors'
+require_relative 'lazy_lazer/utilities'
+
+# LazyLazer is a lazy loading model.
+module LazyLazer
+  # Hook into `include LazyLazer`.
+  # @param [Module] base the object to include the methods in
+  # @return [void]
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.include(InstanceMethods)
+    base.instance_variable_set(:@_lazer_properties, {})
+    base.instance_variable_set(:@_lazer_required_properties, [])
+  end
+
+  # The methods to extend the class with.
+  module ClassMethods
+    # Copies parent properties into subclasses.
+    # @param [Class] klass the subclass
+    # @return [void]
+    def inherited(klass)
+      klass.instance_variable_set(:@_lazer_properties, @_lazer_properties)
+      klass.instance_variable_set(:@_lazer_required_properties, @_lazer_required_properties)
+    end
+
+    # @return [Hash<Symbol, Hash>] defined properties and their options
+    def properties
+      @_lazer_properties
+    end
+
+    # Define a property.
+    # @param [Symbol] name the name of the property method
+    # @param [Hash] options 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 [Symbol, Array<Symbol>] :from (name) the key(s) to get
+    #   the value of the property from
+    # @option options [Object, Proc] :default the default value to return if
+    #   not provided
+    # @option options [Proc, Symbol] :with an optional transformation to apply
+    #   to the value of the key
+    def property(name, **options)
+      sym_name = name.to_sym
+      properties[sym_name] = options
+      @_lazer_required_properties << sym_name if options[:required]
+      define_method(name) { read_attribute(name) }
+    end
+  end
+
+  # The base model class. This could be included directly.
+  module InstanceMethods
+    # Initializer.
+    #
+    # @param [Hash] attributes the model attributes
+    # @return [void]
+    def initialize(attributes = {})
+      # Check all required attributes.
+      self.class.instance_variable_get(:@_lazer_required_properties).each do |prop|
+        raise RequiredAttribute, "#{self} requires `#{prop}`" unless attributes.key?(prop)
+      end
+
+      @_lazer_attribute_source = attributes.dup
+      @_lazer_attribute_cache = {}
+    end
+
+    # @param [Boolean] strict whether to fully load all attributes
+    # @return [Hash] a hash representation of the model
+    def to_h(strict = true)
+      if strict
+        remaining = @_lazer_attribute_source.keys - @_lazer_attribute_cache.keys
+        remaining.each do |key|
+          @_lazer_attribute_cache[key] = read_attribute(key)
+        end
+      end
+      @_lazer_attribute_cache
+    end
+
+    # Reload the object.
+    def reload; end
+
+    # Return the value of the attribute.
+    # @param [Symbol] name the attribute name
+    # @raise MissingAttribute if the key was not found
+    # @note this differs from the Rails implementation and raises {MissingAttribute} if the
+    #   attribute wasn't found.
+    def read_attribute(name)
+      return @_lazer_attribute_cache[name] if @_lazer_attribute_cache.key?(name)
+      reload if self.class.properties.key?(name) && !fully_loaded?
+      options = self.class.properties.fetch(name, {})
+
+      if !@_lazer_attribute_source.key?(name) && !options.key?(:default)
+        raise MissingAttribute, "#{name} is missing for #{self}"
+      end
+      uncoerced = Utilities.lookup_default(@_lazer_attribute_source, name, options[:default])
+      Utilities.transform_value(uncoerced, options[:with])
+    end
+    alias [] read_attribute
+
+    # Update an attribute.
+    # @param [Symbol] attribute the attribute to update
+    # @param [Object] value the new value
+    def write_attribute(attribute, value)
+      @_lazer_attribute_cache[attribute] = value
+    end
+
+    # Update multiple attributes at once.
+    # @param [Hash<Symbol, Object>] new_attributes the new attributes
+    def assign_attributes(new_attributes)
+      new_attributes.each { |key, value| write_attribute(key, value) }
+    end
+    alias attributes= assign_attributes
+
+    # @return [Boolean] whether the object is done with lazy loading
+    def fully_loaded?
+      @_lazer_fully_loaded ||= false
+    end
+
+    private
+
+    # @param [Boolean] state the new state
+    def fully_loaded=(state)
+      @_lazer_fully_loaded = state
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: lazy_lazer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Avinash Dwarapu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- avinash@dwarapu.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/setup
+- lazy_lazer.gemspec
+- lib/lazy_lazer.rb
+- lib/lazy_lazer/errors.rb
+- lib/lazy_lazer/utilities.rb
+- lib/lazy_lazer/version.rb
+homepage: https://github.com/avinashbot/lazy_lazer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Create lazily loadable models.
+test_files: []