yukata 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 035f88b6930ea44d8b6a545f46cc846b866e2a10
-  data.tar.gz: 252211c052cf19518c3eccc446c2b7e6e8360fb3
+  metadata.gz: 68d1cd6c9e92b7ccbba49d39f24f4d20355a6c96
+  data.tar.gz: 8c9fab7697bc288497caecd0089dfde6e9310d57
 SHA512:
-  metadata.gz: 077988b2e4d2b82763619357b229277ad1c06af0b882c7e7d2a0fbfb2b964cc74c36209932432275b5e4ad1c5c1a600da32ed617a5ebfacb88b389b4d7376499
-  data.tar.gz: 999f22be5fd3aea13a36a4371928f78734a65598cd4186dbdb7ce8bbfe8e39a7ef9d6efe1821302fdc490377b4e104381b785f40c45f977d118d3be28c8373e4
+  metadata.gz: aaa51bd713c2164695f872340028cedcb1e9e5c2555a67c468a3e15e2294f73e79b171e71fdc41d9129f58e6f5fb086055a59bd786a83014995ba7bdf8f9f4a3
+  data.tar.gz: 34cd56683a72bad059963563054c9f20742e6398a55ac3113be0cb771732247421c68a1809d88ba8727f3b8e395df3edffa998408be328c062ff3b5a92680c7b

data/README.md

@@ -2,6 +2,60 @@
 
 A light weight, no dependency, plain old ruby objects on steroids.
 
+## Example
+
+```ruby
+require 'yukata'
+require 'pp'
+
+class Author < Yukata::Base
+  attribute :name, String
+end
+
+class Book < Yukata::Base
+  attribute :title,  String
+  attribute :author, Author
+  attribute :created_at, Date, default: -> { Date.today }
+end
+
+book = Book.new({
+  title: 'Hunt For Red October',
+  author: {
+    name: 'Tom Clancy'
+  }
+})
+
+pp book
+```
+
+## Creating A Coercion
+
+This library comes with a custom coercion library. It's fairly straight forward.
+
+```ruby
+Yukata.coercer.register(String, URI) do |string, type|
+  #
+  # Maybe do some fancy string cleanup before you coerce it
+  #
+  URI(string)
+end
+```
+
+Then require that coercion to make sure it's loaded and all you simply have to
+do now is just do the following.
+
+```ruby
+require 'pp'
+
+class Website < Yukata::Base
+  attribute :uri, URI
+end
+
+website = Website.new({uri: 'http://example.com'})
+
+pp website
+```
+
 ## Contributing
 
 1. Fork it

data/lib/yukata.rb

@@ -1,6 +1,8 @@
 require 'json'
 
 require 'yukata/version'
+require 'yukata/errors'
+require 'yukata/coercion'
 require 'yukata/coercer'
 
 module Yukata
@@ -11,4 +13,13 @@ end
 
 require 'yukata/attribute'
 require 'yukata/base'
-require 'yukata/coercions'
+
+require 'yukata/coercions/date'
+require 'yukata/coercions/date_time'
+require 'yukata/coercions/fixnum'
+require 'yukata/coercions/float'
+require 'yukata/coercions/integer'
+require 'yukata/coercions/string'
+require 'yukata/coercions/time'
+require 'yukata/coercions/hash'
+require 'yukata/coercions/boolean'

data/lib/yukata/attribute.rb

@@ -8,7 +8,8 @@ module Yukata
     # @param type [Class] the class this attribute represents
     # @param options [Hash] extra options that can be prescribed
     def initialize(type=String, options={})
-      @type    = type
+      @type = type
+
       if options[:default].is_a?(Proc)
         @default = options[:default]
       else
@@ -19,10 +20,5 @@ module Yukata
     def default
       @default.call
     end
-
-    def coerce(obj)
-      return obj if obj.is_a?(type)
-      Yukata.coercer.coerce(obj, type)
-    end
   end
 end

data/lib/yukata/base.rb

@@ -45,23 +45,20 @@ module Yukata
       self.attributes[name] = attr
       variable = "@#{name}"
 
-      # SETTER
-      setter = "#{name}="
-      define_method(setter) do |arg|
-        instance_variable_set(variable, attr.coerce(arg))
+      define_method("#{name}=") do |object|
+        val = Yukata.coercer.coerce(object, attr.type)
+        instance_variable_set(variable, val)
       end
 
-      # GETTER
       define_method(name) do
         val = instance_variable_get(variable)
-        unless val # Need to set the default
+        unless val
           val = attr.default
           instance_variable_set(variable, val)
         end
         val
       end
 
-      Yukata.coercer.register(Hash, self) { |obj, type| type.new(obj) }
     end
   end
 end

data/lib/yukata/coercer.rb

@@ -1,8 +1,10 @@
 module Yukata
   class Coercer
     def initialize
-      @coercions = Hash.new do |hash, key|
-        hash[key] = Hash.new { -> (object) { object } }
+      @coercions = Hash.new do |hash, origin|
+        hash[origin] = Hash.new do |h, target|
+          h[target] = Coercion.new(origin, target)
+        end
       end
       @mutex = Mutex.new
     end
@@ -12,8 +14,10 @@ module Yukata
     # @param origin [Class] the class to convert
     # @param target [Class] what the origin will be converted to
     def register(origin, target, &block)
+      raise(ArgumentError, 'block is required') unless block_given?
+
       @mutex.synchronize do
-        @coercions[origin][target] = block
+        @coercions[origin][target] = Coercion.new(origin, target, &block)
       end
     end
 
@@ -30,9 +34,7 @@ module Yukata
     # @param object [Object] the object to coerce
     # @param target [Class] what you want the object to turn in to
     def coerce(object, target)
-      @mutex.synchronize do
-        @coercions[object.class][target].call(object)
-      end
+      @coercions[object.class][target].call(object)
     end
   end
 end

data/lib/yukata/coercion.rb

@@ -0,0 +1,17 @@
+module Yukata
+  # @author Matthew A. Johnston
+  class Coercion
+    # Just passes the object on through
+    PASS_THROUGH = ->(obj, _) { obj }
+
+    def initialize(origin, target, &block)
+      @origin  = origin
+      @target  = target
+      @block   = block_given? ? block : PASS_THROUGH
+    end
+
+    def call(object)
+      @block.call(object, @target)
+    end
+  end
+end

data/lib/yukata/coercions/array.rb

@@ -0,0 +1 @@
+Yukata.coercer.coerce(Array, String) { |obj, _| obj.to_s }

data/lib/yukata/coercions/boolean.rb

@@ -0,0 +1,8 @@
+unless defined?(Boolean)
+  class Boolean
+  end
+end
+
+Yukata.coercer.register(String, Boolean) do |string, _|
+  %w(1 on t true y yes).include?(string.downcase)
+end

data/lib/yukata/coercions/hash.rb

@@ -0,0 +1,2 @@
+Yukata.coercer.register(Hash, String) { |obj, _| obj.to_s }
+Yukata.coercer.register(Hash, Array) { |obj, _| obj.to_a }

data/lib/yukata/coercions/string.rb

@@ -1,5 +1,26 @@
-Yukata.coercer.register(String, Time)     { |obj, type| type.parse(obj) }
-Yukata.coercer.register(String, Date)     { |obj, type| type.parse(obj) }
-Yukata.coercer.register(String, DateTime) { |obj, type| type.parse(obj) }
+Yukata.coercer.register(String, Time) do |obj, type|
+  begin
+    type.parse(obj)
+  rescue ArgumentError
+    nil
+  end
+end
+
+Yukata.coercer.register(String, Date) do |obj, type|
+  begin
+    type.parse(obj)
+  rescue ArgumentError
+    nil
+  end
+end
+
+Yukata.coercer.register(String, DateTime) do |obj, type|
+  begin
+    type.parse(obj)
+  rescue ArgumentError
+    nil
+  end
+end
+
 Yukata.coercer.register(String, Integer)  { |obj, _| obj.to_i }
-Yukata.coercer.register(String, Float)    { |obj, _| obj.to_f }
+Yukata.coercer.register(String, Float) { |obj, _| obj.to_f }

data/lib/yukata/version.rb

@@ -1,3 +1,3 @@
 module Yukata
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yukata
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthew Johnston
@@ -71,11 +71,14 @@ files:
 - lib/yukata/attribute.rb
 - lib/yukata/base.rb
 - lib/yukata/coercer.rb
-- lib/yukata/coercions.rb
+- lib/yukata/coercion.rb
+- lib/yukata/coercions/array.rb
+- lib/yukata/coercions/boolean.rb
 - lib/yukata/coercions/date.rb
 - lib/yukata/coercions/date_time.rb
 - lib/yukata/coercions/fixnum.rb
 - lib/yukata/coercions/float.rb
+- lib/yukata/coercions/hash.rb
 - lib/yukata/coercions/integer.rb
 - lib/yukata/coercions/string.rb
 - lib/yukata/coercions/time.rb

data/lib/yukata/coercions.rb

@@ -1,12 +0,0 @@
-module Yukata
-  module Coercions
-  end
-end
-
-require 'yukata/coercions/date'
-require 'yukata/coercions/date_time'
-require 'yukata/coercions/fixnum'
-require 'yukata/coercions/float'
-require 'yukata/coercions/integer'
-require 'yukata/coercions/string'
-require 'yukata/coercions/time'