extant 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59966f18b3d32352d1ab9700a02a424c1dc812f7
+  data.tar.gz: 5b8021c55eef67a6643fd7c50fdf6828953f814c
+SHA512:
+  metadata.gz: bc0226bf520414c661d44cfd55a6398553fdc72c1e57144c50317492b4e554eca5bd920a1da12ae5c9a4bf72f327d4f60d4fa12432dd47c289ff05e744368443
+  data.tar.gz: 198d0d6440bb0c89aa66957a1d836c4edc0c82901a56c328b0683fab6083933979509da904cdc7dc5c5c587de299a38fa2aa7632f89685f0cbfe60e458a4458f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 NCC Group Domain Services
+
+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,80 @@
+# Extant
+
+_Sponsored by NCC Group Domain Services_
+
+Extant provides attribute management for Ruby objects. It is somewhat similar to
+`attr_accessor`, except it does many additional things like, type coercion,
+change tracking (dirty attributes), and most importantly tracking of existence.
+
+## Installation
+
+``` terminal
+$ gem install extant
+```
+
+or in your **Gemfile**
+
+``` ruby
+gem 'extant'
+```
+
+## Getting Started
+
+```ruby
+class Widget
+  include Extant::Attributes
+
+  attribute :name, String
+  attribute :price, Integer
+  attribute :production_ready, Extant::Coercers::Boolean, default: false
+end
+```
+
+Basic Usage
+```ruby
+widget = Widget.new(
+  name: 'Doodad',
+  price: 100
+)
+
+widget.name              # => 'Doodad'
+widget.price             # => 100
+widget.production_ready  # => false
+
+widget.attributes  # => { name: 'Doodad', price: 100, production_ready: false }
+```
+
+Coercion
+```ruby
+widget = Widget.new(
+  price: 'not a number'
+)
+
+widget.extant_attributes[:price].coerced?          # => false
+widget.price                                       # => nil
+widget.extant_attributes[:price].pre_coerce_value  # => 'not a number'
+```
+
+Existence
+```ruby
+widget = Widget.new
+
+widget.name                           # => nil
+widget.extant_attributes[:name].set?  # => false
+
+widget = Widget.new(
+  name: nil
+)
+
+widget.name                               # => nil
+widget.extant_attributes[:name].set?      # => true
+widget.extant_attributes[:name].coerced?  # => true
+```
+
+## Contributing
+
+1. Fork
+2. Make changes
+3. Pull request
+4. Celebrate
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :environment do
+end

data/extant.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'extant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "extant"
+  spec.version       = Extant::VERSION
+  spec.authors       = ["NCC Group Domain Services"]
+  spec.email         = ["brady.love@nccgroup.trust", "emily.dobervich@nccgroup.trust"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{Extant, it helps you manage your attributes' existance.}
+  spec.description   = %q{Define attributes, readers and writers on classes.}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "pry-doc"
+end

data/lib/extant.rb

@@ -0,0 +1,8 @@
+require 'extant/version'
+require 'extant/unset_value'
+require 'extant/uncoerced_value'
+require 'extant/attributes'
+
+module Extant
+
+end

data/lib/extant/attribute.rb

@@ -0,0 +1,78 @@
+module Extant
+  class Attribute
+    attr_reader :name, :coercer_class, :pre_coerce_value, :value
+
+    def initialize(name, value, definition)
+      self.name = name
+      self.has_been_coereced = false
+      self.definition = definition
+
+      if UnsetValue == value
+        @value = nil
+        self.is_unset = true
+      else
+        set_value(value)
+      end
+    end
+
+    def value=(val)
+      set_value(val)
+      self.value_has_changed = true
+    end
+
+    def coerced?
+      !!has_been_coereced
+    end
+
+    def has_changed?
+      !!value_has_changed
+    end
+
+    def unset?
+      !set?
+    end
+
+    def set?
+      !is_unset
+    end
+
+    def coercer_name
+      coercer_class.try(:coercer_name)
+    end
+
+    def inspect
+      "<Extant::Attribute:#{self.object_id} Name: :#{name} Value: #{value.inspect}>"
+    end
+
+    private
+
+    def coercer_class
+      definition.coercer_class
+    end
+
+    def set_value(val)
+      self.pre_coerce_value = val
+
+      @value = if coercer_class
+        coercer = coercer_class.new(val)
+        coercer.coerce.tap { self.has_been_coereced = coercer.coerced? }
+      else
+        self.has_been_coereced = true
+        val
+      end
+
+      if UncoercedValue == @value
+        @value = nil
+
+        if definition.allow_nil && pre_coerce_value == nil
+          self.has_been_coereced = true
+        end
+      end
+
+      self.is_unset = false
+    end
+
+    attr_accessor :value_has_changed, :has_been_coereced, :is_unset, :definition
+    attr_writer :name, :coercer_class, :pre_coerce_value
+  end
+end

data/lib/extant/attribute_definition.rb

@@ -0,0 +1,28 @@
+module Extant
+  class AttributeDefinition
+    attr_accessor :name, :type, :coercer_class, :has_default, :default_value,
+                  :allow_nil
+
+    def initialize(model, name, opts={})
+      self.name = name
+      self.type = opts[:type]
+      self.has_default = opts.key?(:default)
+      self.default_value = opts[:default]
+      self.allow_nil = opts.fetch(:allow_nil, true)
+
+      if type
+        self.coercer_class = Extant::Coercers.find(type)
+      end
+
+      model.instance_eval do
+        define_method name do
+          extant_attributes[name].value
+        end
+
+        define_method "#{name}=" do |val|
+          extant_attributes[name].value = val
+        end
+      end
+    end
+  end
+end

data/lib/extant/attributes.rb

@@ -0,0 +1,130 @@
+require 'extant/attribute'
+require 'extant/attribute_definition'
+
+module Extant
+  module Attributes
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def attribute_definitions
+        @attributes ||= {}
+      end
+
+      def attribute(name, type=nil, **opts)
+        opts[:type] = type
+        attribute_definitions[name] = AttributeDefinition.new(self, name, opts)
+      end
+    end
+
+    def initialize(attrs={})
+      attrs = Hash[attrs.map{ |k, v| [k.to_sym, v] }]
+      attribute_definitions.each do |k, definition|
+        value = if attrs.key?(k)
+          attrs[k]
+        else
+          UnsetValue
+        end
+
+        if UnsetValue == value && definition.has_default
+          value = definition.default_value.is_a?(Proc) ? definition.default_value.call : definition.default_value
+        end
+
+        extant_attributes[k] =
+          Extant::Attribute.new(k, value, definition)
+      end
+
+      self.original_extant_attributes = extant_attributes
+    end
+
+    def attributes
+      self.class.attribute_definitions.each_with_object({}) do |(k, _), attrs|
+        attrs[k] = send(k)
+      end
+    end
+
+    def attribute_definitions
+      self.class.attribute_definitions
+    end
+
+    def extant_attributes
+      @extant_attributes ||= {}
+    end
+
+    def set_attributes
+      self.class.attribute_definitions.each_with_object({}) do |(k, _), attrs|
+        if extant_attributes[k].set?
+          attrs[k] = send(k)
+        end
+      end
+    end
+
+    def changed_attributes
+      self.class.attribute_definitions.each_with_object({}) do |(k, _), attrs|
+        if extant_attributes[k].has_changed?
+          attrs[k] = send(k)
+        end
+      end
+    end
+
+    def each_extant_attribute
+      extant_attributes.values.each do |v|
+        yield v
+      end
+    end
+
+    def update_attributes(attrs={})
+      attrs.each do |k, v|
+        send("#{k}=".to_sym, v) if respond_to?("#{k}=".to_sym)
+      end
+
+      self
+    end
+
+    def dirty?(attr=nil)
+      if attr
+        !!changed_extant_attributes[attr]
+      else
+        changed_extant_attributes.any?
+      end
+    end
+
+    def original_extant_attributes
+      @original_extant_attributes ||= {}
+    end
+
+    def with(attrs={}, metadata={})
+      new_instance = self.class.new(self.attributes)
+      new_instance.update_attributes(attrs)
+
+      new_instance.send(:with_metadata=, metadata)
+      new_instance.send(:original_extant_attributes=, original_extant_attributes)
+      new_instance
+    end
+
+    def with_metadata
+      @with_metadata || {}
+    end
+
+    private
+
+    attr_writer :with_metadata
+
+    def changed_extant_attributes
+      self.class.attribute_definitions.each_with_object({}) do |(k, _), attrs|
+        if extant_attributes[k].has_changed?
+          attrs[k] = extant_attributes[k]
+        end
+      end
+    end
+
+    def original_extant_attributes=(attrs={})
+      attrs.each do |k, v|
+        original_extant_attributes[k] = v.dup
+      end
+    end
+  end
+end
+
+require 'extant/coercers'

data/lib/extant/coercers.rb

@@ -0,0 +1,47 @@
+module Extant
+  module Coercers
+    def self.find(type)
+      if type.is_a?(::Hash)
+        coercer_options = {
+          hash_format: type
+        }
+
+        type = HashCoercerBuilder.build(coercer_options)
+      end
+
+      if type.is_a?(::Array)
+        coercer_options = {
+          array_format: type
+        }
+
+        type = ArrayCoercerBuilder.build(coercer_options)
+      end
+
+      if type.is_a?(Class) && type.ancestors.include?(Extant::Coercers::Base)
+        coercer_class = type
+      else
+        coercer_class = Object.const_get("Extant::Coercers::#{type}")
+
+        unless coercer_class.method_defined?(:coerce)
+          raise "#{type} must respond to #coerce"
+        end
+      end
+
+      coercer_class
+    end
+  end
+end
+
+require 'extant/coercers/base'
+
+require 'extant/coercers/boolean'
+require 'extant/coercers/date_time'
+require 'extant/coercers/fixnum'
+require 'extant/coercers/float'
+require 'extant/coercers/hash'
+require 'extant/coercers/array'
+require 'extant/coercers/integer'
+require 'extant/coercers/string'
+require 'extant/coercers/symbol'
+require 'extant/coercers/time'
+require 'extant/coercers/uuid'

data/lib/extant/coercers/array.rb

@@ -0,0 +1,56 @@
+module Extant::Coercers
+  class Array < Base
+    class << self
+      attr_accessor :value_type
+    end
+
+    def coerce
+      return ArgumentError unless value.respond_to?(:to_a)
+      result = value.to_a
+      return ArgumentError unless result.is_a?(::Array)
+
+      if value_type
+        result = result.map do |v|
+          coerce_value(v)
+        end
+      end
+
+      self.coerced = true
+
+      result
+    rescue ArgumentError
+      UncoercedValue
+    end
+
+    private
+
+    def coerce_value(v)
+      coercer = value_type.new(v)
+      result = coercer.coerce
+      raise ArgumentError unless coercer.coerced?
+      result
+    end
+
+    def key_type
+      self.class.key_type
+    end
+
+    def value_type
+      self.class.value_type
+    end
+  end
+
+  class ArrayCoercerBuilder
+    def self.build(opts)
+      value_type_local = Extant::Coercers.find(opts[:array_format].first)
+
+      Class.new(Extant::Coercers::Array) do
+        self.value_type = value_type_local
+
+        def self.coercer_name
+          'array'
+        end
+      end
+    end
+  end
+end

data/lib/extant/coercers/base.rb

@@ -0,0 +1,27 @@
+module Extant::Coercers
+  class Base
+    UncoercedValue = Extant::UncoercedValue
+
+    def self.coercer_name
+      self.name.split("::").last.gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+    end
+
+    def initialize(value, options={})
+      self.value = value
+      self.coerced = false
+      self.options = {}
+    end
+
+    def coerce
+      rase NotImplementedError.new("#{self.class.name} must implement #{coerce}")
+    end
+
+    def coerced?
+      coerced
+    end
+
+    private
+
+    attr_accessor :value, :coerced, :options
+  end
+end

data/lib/extant/coercers/boolean.rb

@@ -0,0 +1,15 @@
+module Extant::Coercers
+  class Boolean < Base
+    def coerce
+      if [true, "true", 1].include?(value)
+        self.coerced = true
+        return true
+      elsif [false, "false", 0].include?(value)
+        self.coerced = true
+        return false
+      end
+
+      Extant::UncoercedValue
+    end
+  end
+end

data/lib/extant/coercers/date_time.rb

@@ -0,0 +1,16 @@
+module Extant::Coercers
+  class DateTime < Base
+    def coerce
+      if value.is_a?(::DateTime)
+        self.coerced = true
+        return value
+      end
+
+      result = ::DateTime.parse(value.to_s)
+      self.coerced = true
+      result
+    rescue ArgumentError
+      UncoercedValue
+    end
+  end
+end

data/lib/extant/coercers/fixnum.rb

@@ -0,0 +1,11 @@
+module Extant::Coercers
+  class Fixnum < Base
+    def coerce
+      result = Integer(value)
+      self.coerced = true
+      result
+    rescue ArgumentError, TypeError
+      UncoercedValue
+    end
+  end
+end

data/lib/extant/coercers/float.rb

@@ -0,0 +1,11 @@
+module Extant::Coercers
+  class Float < Base
+    def coerce
+      result = Float(value)
+      self.coerced = true
+      result
+    rescue ArgumentError, TypeError
+      UncoercedValue
+    end
+  end
+end

data/lib/extant/coercers/hash.rb

@@ -0,0 +1,63 @@
+module Extant::Coercers
+  class Hash < Base
+    class << self
+      attr_accessor :key_type, :value_type
+    end
+
+    def coerce
+      result = ::Hash[value]
+
+      if key_type && value_type
+        result = result.each_with_object({}) do |(k, v), h|
+          h[coerce_key(k)] = coerce_value(v)
+        end
+      end
+
+      self.coerced = true
+
+      result
+    rescue ArgumentError
+      UncoercedValue
+    end
+
+    private
+
+    def coerce_key(v)
+      coercer = key_type.new(v)
+      result = coercer.coerce
+      raise ArgumentError unless coercer.coerced?
+      result
+    end
+
+    def coerce_value(v)
+      coercer = value_type.new(v)
+      result = coercer.coerce
+      raise ArgumentError unless coercer.coerced?
+      result
+    end
+
+    def key_type
+      self.class.key_type
+    end
+
+    def value_type
+      self.class.value_type
+    end
+  end
+
+  class HashCoercerBuilder
+    def self.build(opts)
+      key_type_local = Extant::Coercers.find(opts[:hash_format].keys.first)
+      value_type_local = Extant::Coercers.find(opts[:hash_format].values.first)
+
+      Class.new(Extant::Coercers::Hash) do
+        self.key_type = key_type_local
+        self.value_type = value_type_local
+
+        def self.coercer_name
+          'hash'
+        end
+      end
+    end
+  end
+end

data/lib/extant/coercers/integer.rb

@@ -0,0 +1,11 @@
+module Extant::Coercers
+  class Integer < Base
+    def coerce
+      result = Integer(value)
+      self.coerced = true
+      result
+    rescue ArgumentError, TypeError
+      UncoercedValue
+    end
+  end
+end

data/lib/extant/coercers/string.rb

@@ -0,0 +1,10 @@
+module Extant::Coercers
+  class String < Base
+    def coerce
+      return UncoercedValue if value == nil
+
+      self.coerced = true
+      value.to_s
+    end
+  end
+end

data/lib/extant/coercers/symbol.rb

@@ -0,0 +1,20 @@
+module Extant::Coercers
+  class Symbol < Base
+    def coerce
+      return UncoercedValue if value == nil
+
+      if value.is_a?(::String)
+        result = value.to_sym
+      elsif value.is_a?(::Symbol)
+        result = value
+      else
+        raise ArgumentError
+      end
+
+      self.coerced = true
+      result
+    rescue ArgumentError
+      UncoercedValue
+    end
+  end
+end

data/lib/extant/coercers/time.rb

@@ -0,0 +1,18 @@
+require 'time'
+
+module Extant::Coercers
+  class Time < Base
+    def coerce
+      if value.is_a?(::Time)
+        self.coerced = true
+        return value
+      end
+
+      result = ::Time.parse(value.to_s)
+      self.coerced = true
+      result
+    rescue ArgumentError
+      UncoercedValue
+    end
+  end
+end

data/lib/extant/coercers/uuid.rb

@@ -0,0 +1,14 @@
+module Extant::Coercers
+  class Uuid < Base
+    UUID_REGEX = /\A[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}\z/i
+
+    def coerce
+      if value.to_s =~ UUID_REGEX
+        self.coerced = true
+        value.to_s
+      else
+        UncoercedValue
+      end
+    end
+  end
+end

data/lib/extant/uncoerced_value.rb

@@ -0,0 +1,7 @@
+require 'singleton'
+
+module Extant
+  class UncoercedValue
+    include Singleton
+  end
+end

data/lib/extant/unset_value.rb

@@ -0,0 +1,7 @@
+require 'singleton'
+
+module Extant
+  class UnsetValue
+    include Singleton
+  end
+end

data/lib/extant/version.rb

@@ -0,0 +1,3 @@
+module Extant
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: extant
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- NCC Group Domain Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Define attributes, readers and writers on classes.
+email:
+- brady.love@nccgroup.trust
+- emily.dobervich@nccgroup.trust
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- extant.gemspec
+- lib/extant.rb
+- lib/extant/attribute.rb
+- lib/extant/attribute_definition.rb
+- lib/extant/attributes.rb
+- lib/extant/coercers.rb
+- lib/extant/coercers/array.rb
+- lib/extant/coercers/base.rb
+- lib/extant/coercers/boolean.rb
+- lib/extant/coercers/date_time.rb
+- lib/extant/coercers/fixnum.rb
+- lib/extant/coercers/float.rb
+- lib/extant/coercers/hash.rb
+- lib/extant/coercers/integer.rb
+- lib/extant/coercers/string.rb
+- lib/extant/coercers/symbol.rb
+- lib/extant/coercers/time.rb
+- lib/extant/coercers/uuid.rb
+- lib/extant/uncoerced_value.rb
+- lib/extant/unset_value.rb
+- lib/extant/version.rb
+homepage: 
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Extant, it helps you manage your attributes' existance.
+test_files: []
+has_rdoc: