yas 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e35b3a0968c6150304165fe2217c029c2a3aba84
-  data.tar.gz: 3af1252eebbdf6c190cb6ec37d1fd5dd43d03e8c
+  metadata.gz: 14bc3ae92e4d7b9e86b4231edfb5f44cb5d04e1f
+  data.tar.gz: 149294a84a65f4eb2bc726c8cdbf41fe6c16593c
 SHA512:
-  metadata.gz: f85ed79e75ff056a7da1916d8c3bd1e977e2095eb8f59d630362f2db0ecfedde39f2a60076a7a6597002039a70624363729480ce14f9c2d1a5cddc62eea84789
-  data.tar.gz: ff1c0ff63ca04b9fbc5b2076eb54d53f9bef8b1ce318e052d2af2fffb88ba638fc0ed50370d7a4c4d6d22b3e04c5d0ed5e414a7e2a20ff36dbc79cdc67983e6f
+  metadata.gz: 04efb2cbe5b897de52da85c02244b127b2ba65bc512ba8e510c7b1a516814cb8f37a71bdda8b62cdd3b94898ef262503754428b138346260a2494d30d937ead4
+  data.tar.gz: 69c588d7f01c2f2a2a96ba37fdebcc5b82a78beb6e1ef3c85586e70b782b988bbea57f50128d58bcd4ec64a70ccfb7c027cab7d759aeede50cf01131b45bba83

data/README.markdown

@@ -1,6 +1,6 @@
 # YAS
 
-YAS (Yet Another Schema) is an extensible hash validator for Ruby.
+YAS (Yet Another Schema) is an extensible hash validator for Ruby used to maintain hash integrity.
 Using YAS, you can enforce a specific key to be required, rename them, perform automatic type conversion, and other goodies.
 
 
@@ -14,39 +14,34 @@ Using YAS, you can enforce a specific key to be required, rename them, perform a
     require 'yas'
 
     class MySchema < YAS::Schema
-      rename :foo => :bar
+      rename :bar => :foo
     end
 
     h = { bar: "value" }
     h.validate! MySchema
-    puts h[:foo]  # "value"
-    puts h[:bar]  # nil
+    h[:foo]  # "value"
+    h[:bar]  # nil
 
 
 ## Extensions
 
-You can extend the behavior of YAS by writing your own custom extensions, but `YAS::Schema` already comes with a set of awesome default extensions that you can immediately use:
+You can extend the behavior of YAS by writing your own custom extensions.
+`YAS::Schema` already comes with a set of awesome default extensions that you can immediately use.
+Optionally, you may also use `YAS::SchemaBase` if you want to start off from a clean slate.
 
-* `attribute name, &block` or `key name, &block`
 
-  Declares an attribute/key with various requirements.
+### Default Extensions
 
-* `rename`
 
-  Rename keys.
+#### Attribute
 
-* `migrate`
+Declares an attribute/key with various requirements.
+The Attribute extension allows you to specify certain requirements/restrictions for a given key.
 
-  Migrate the value of a key.
+    attribute name, &block
+    key name, &block
 
-* `whitelist`
-
-  Provide a set of keys that you only care to see.
-
-
-### Attribute Extension
-
-The Attribute extension allows you to specify certain requirements/restrictions for a given key:
+Example:
 
     class MySchema < YAS::Schema
       key :email do
@@ -71,7 +66,7 @@ List of directives you can use:
 
 * `type(T)`
 
-  Sets the type of this key. Will perform type check if specified. Can be nested if type is a YAS::Schema!
+  Sets the type of this key. Will perform type check if specified. Can be nested if type is a `YAS::Schema`!
 
 * `auto_convert`
 
@@ -81,14 +76,24 @@ List of directives you can use:
 
   Runs the block to set the default value for this key, if it's missing or nil.
 
+* `alter(&block)`
+
+  Adjust the value of this key. Can be useful if you want to enforce certain formatting, such as upper/lowercase, unique arrays, etc.
+  Value returned by block will be used as the new value for this key, which then gets validated by the `validate_value` block.
+
 * `validate_value(&block)`
 
-  Custom validation method to check the value of a key. This is useful in cases where you only want certain values to be stored (e.g a number between 1-10 only)
+  Custom validation method to check the value of a key. This is useful in cases where you only want certain values to be stored (e.g a number between 1-10 only).
+  Return true to indicate value passes validation, false for fail.
 
 
-### Rename Extension
+#### Rename
 
-Using `rename` to rename keys. Useful to maintain hash integrity.
+Using `rename` to rename keys.
+
+    rename :from => :to
+
+Example:
 
     class UserSchema < YAS::Schema
       rename :username => :nickname
@@ -98,9 +103,13 @@ Using `rename` to rename keys. Useful to maintain hash integrity.
     hash[:nickname] # 'jdoe'
 
 
-### Migrate Extension
+#### Migrate
+
+Migrate the value of a key. This is useful if you have keys whose values are in the old format and you want to convert them to the new format.
 
-You can also migrate the values. This is useful if you have hash whose values are in the old format and you want to convert them to the new format.
+    migrate :key, &block 
+
+Example:
 
     class UserSchema < YAS::Schema
       migrate :nicknames do |v|
@@ -112,10 +121,14 @@ You can also migrate the values. This is useful if you have hash whose values ar
     hash[:nicknames] # ['jdoe']
 
 
-### Whitelist Extension
+#### Whitelist
 
 Whitelist allows you to remove unneeded keys.
 
+    whitelist [keys]
+
+Example:
+
     class UserSchema < YAS::Schema
       whitelist :name, :address
     end
@@ -125,3 +138,20 @@ Whitelist allows you to remove unneeded keys.
     hash[:address] # ['123 Main St']
     hash[:phone] # nil
     hash[:comment] # nil
+
+
+#### Symbolize
+
+Symbolize keys in your hash.
+This does not perform deep symbolize. See nested Attribute validation if you want deep symbolize.
+
+    symbolize true|false
+
+Example:
+
+    class UserSchema < YAS::Schema
+      symbolize true
+    end
+    hash = { 'name' => 'jdoe', 'address' => '123 Main St' }
+    hash.validate!(UserSchema)
+    hash[:name] # ['jdoe']

data/lib/yas/ext/attribute.rb

@@ -6,7 +6,6 @@ class YAS::AttributeExt
   module ClassMethods
 
     def key attr, &block
-      attr = attr.to_s.to_sym
       new_attr = Attribute.new(attr)
       new_attr.instance_eval &block if block
       attributes[attr] = new_attr
@@ -50,11 +49,12 @@ class YAS::AttributeExt
     @type = nil
     @auto_convert = false
     @default_block = nil
-    @check_value_block = nil
+    @alter_block = nil
+    @validate_value_block = nil
 
 
     def initialize name
-      @name = name.to_s.to_sym
+      @name = name
     end
 
 
@@ -116,33 +116,44 @@ class YAS::AttributeExt
     #   validate_value { |v| v == "John" }
     #
     def validate_value &block
-      @check_value_block = block
+      @validate_value_block = block
       self
     end
 
 
-    # Check the default value.
+    # Perform adjustment to the value of this Attribute.
     #
-    # @param value The value of this attribute to validate.
+    # @yield [v] Value of the Attribute.
     #
-    def trigger_default_directive
-      @default_block.call if has_default?
+    # @example
+    #   alter { |v| v == "John" }
+    #
+    def alter &block
+      @alter_block = block
+      self
     end
 
 
-    # Check value.
+    # Validates attribute, except the required directive.
+    # First it executes the {default} directive, then {auto_convert} to type,
+    # then {type} validation, then finally the {validate} directive.
     #
-    def trigger_content_directive value
-      if @check_value_block
-        raise YAS::ValidationError, "Content validation error: #{value}" unless
-          @check_value_block.call(value)
-      end
-      value
+    # @return The final value after the validation.
+    #
+    def validate value
+      value = trigger_default_directive if value.nil?
+      trigger_validate_value_directive(trigger_alter_directive(trigger_type_directive(value)))
+    end
+
+
+    private
+
+
+    def trigger_default_directive
+      @default_block.call if has_default?
     end
 
 
-    # Check type.
-    #
     def trigger_type_directive value
       if @type
         # Run auto-conversion first.
@@ -162,8 +173,6 @@ class YAS::AttributeExt
     end
 
 
-    # Auto convert the value
-    #
     def trigger_auto_convert_directive value
       if @auto_convert
         if @type == Integer
@@ -184,15 +193,18 @@ class YAS::AttributeExt
     end
 
 
-    # Validates attribute, except the required directive.
-    # First it executes the {default} directive, then {auto_convert} to type,
-    # then {type} validation, then finally the {validate} directive.
-    #
-    # @return The final value after the validation.
-    #
-    def validate value
-      value = trigger_default_directive if value.nil?
-      trigger_content_directive(trigger_type_directive(value))
+    def trigger_alter_directive value
+      value = @alter_block.call(value) if @alter_block
+      value
+    end
+
+
+    def trigger_validate_value_directive value
+      if @validate_value_block
+        raise YAS::ValidationError, "Content validation error: #{value}" unless
+          @validate_value_block.call(value)
+      end
+      value
     end
 
   end

data/lib/yas/ext/rename.rb

@@ -10,8 +10,7 @@ class YAS::RenameExt
 
   module ClassMethods
     def rename map
-      smap = YAS.symbolize(map)
-      rename_keys.merge!(smap)
+      rename_keys.merge!(map)
     end
 
     def rename_keys
@@ -26,17 +25,18 @@ class YAS::RenameExt
 
 
   def self.when_schema_inherited superschema, subschema
-    superschema.rename_keys.each do |from, value|
-      subschema.rename_keys[key] = value
+    superschema.rename_keys.each do |from, to|
+      subschema.rename_keys[key] = to
     end
   end
 
 
   def self.apply schema, hash
     schema.rename_keys.each do |from, to|
-      hash.has_key?(from) and
-        hash[to] = hash[from] and
+      if hash.has_key?(from)
+        hash[to] = hash[from]
         hash.delete(from)
+      end
     end
   end
 

data/lib/yas/ext/symbolize.rb

@@ -0,0 +1,30 @@
+# Symbolize keys
+#
+
+class YAS::SymbolizeExt
+
+  module ClassMethods
+    def symbolize sym = nil
+      @symbolize = sym if !sym.nil? && (sym.class == TrueClass || sym.class == FalseClass)
+      @symbolize
+    end
+  end
+
+
+  def self.when_used schema
+    schema.extend ClassMethods
+  end
+
+
+  def self.when_schema_inherited superschema, subschema
+    subschema.symbolize(superschema.symbolize)
+  end
+
+
+  def self.apply schema, hash
+    hash.keys.each do |key|
+      hash[(key.to_sym rescue key) || key] = hash.delete(key)
+    end if schema.symbolize
+  end
+
+end

data/lib/yas/schema.rb

@@ -1,7 +1,7 @@
 class YAS::SchemaBase
 
   def self.use ext
-    raise YAS::ExtensionError, "Duplicate Extension" if exts.any? { |e| e == ext }
+    raise YAS::ExtensionError, "Duplicate Extension. Extension #{ext} is already used." if exts.include?(ext)
     raise YAS::ExtensionError, "Wrong Extension Format" unless ext.respond_to?(:apply) && ext.respond_to?(:when_used)
     exts << ext
     ext.when_used(self)
@@ -38,6 +38,7 @@ end
 
 class YAS::Schema < YAS::SchemaBase
 
+  use YAS::SymbolizeExt
   use YAS::RenameExt
   use YAS::WhitelistExt
   use YAS::MigrateExt

data/lib/yas/version.rb

@@ -1,5 +1,5 @@
 module YAS
   GEM_NAME = "yas"
   NAME = "YAS"
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/yas.rb

@@ -1,11 +1,10 @@
-require 'securerandom'
-require 'json'
 require 'time'
 
 require 'yas/version'
 require 'yas/errors'
 require 'yas/helper'
 
+require 'yas/ext/symbolize'
 require 'yas/ext/rename'
 require 'yas/ext/attribute'
 require 'yas/ext/migrate'

data/test/ext/test_attribute.rb

@@ -87,7 +87,14 @@ class TestAttribute < Minitest::Test
   end
 
 
-  def test_content
+  def test_alter
+    attr = Attribute.new(:batman).alter { |v| v.uniq!; v.compact!; v }
+    value = attr.validate(["Jim", "John", "Jim", "Kim", "Sally"])
+    assert_equal ["Jim", "John", "Kim", "Sally"], value
+  end
+
+
+  def test_validate_value
     attr = Attribute.new(:batman).validate_value { |v| v == "John" }
     assert_raises YAS::ValidationError do
       attr.validate("Jim")
@@ -138,6 +145,11 @@ class AttributeSchema < YAS::Schema
     auto_convert
   end
 
+  key 'geo' do
+    type Float
+    auto_convert
+  end
+
 end
 
 
@@ -157,9 +169,11 @@ class TestAttributeExt < Minitest::Test
     hash = {
       name: "someone",
       number: 10,
+      'geo' => '10.20',
     }
     hash.validate! AttributeSchema
     assert_equal "someone", hash[:name]
+    assert_equal 10.20, hash['geo']
   end
 
 

data/test/ext/test_rename.rb

@@ -2,21 +2,24 @@ require './test/helper.rb'
 
 class RenameSchema < YAS::Schema
   rename :addr => :address
+  rename 'home' => 'office'
 end
 
 
+
 class TestRenameExt < Minitest::Test
 
   def test_rename_ext
     hash = {
       addr: "Some address",
+      'home' => 'home address',
       untouched: "Nothing"
     }
     hash.validate! RenameSchema
     assert_equal "Some address", hash[:address]
+    assert_equal "home address", hash['office']
     assert_equal "Nothing", hash[:untouched]
     assert_nil hash[:addr]
-    assert_equal 2, hash.length
   end
 
 end

data/test/ext/test_symbolize.rb

@@ -0,0 +1,23 @@
+require './test/helper.rb'
+
+
+class SymbolizedSchema < YAS::Schema
+  symbolize true
+end
+
+
+class TestSymbolizeExt < Minitest::Test
+
+  def test_symbolize
+    hash = {
+      'first_name': "john",
+      'last_name': "doe",
+    }
+    hash.validate! SymbolizedSchema
+    assert_equal "john", hash[:first_name]
+    assert_equal "doe", hash[:last_name]
+    assert_nil hash['first_name']
+    assert_nil hash['last_name']
+  end
+
+end

data/test/test_schema.rb

@@ -57,6 +57,27 @@ end
 
 class TestSchema < Minitest::Test
 
+  def test_duplicate_ext
+    assert_raises YAS::ExtensionError do
+      Class.new(YAS::Schema) do
+        use YAS::RenameExt
+      end
+    end
+  end
+
+
+  def test_invalid_ext_format
+    bad_ext = Class.new do
+    end
+
+    assert_raises YAS::ExtensionError do
+      Class.new(YAS::Schema) do
+        use bad_ext
+      end
+    end
+  end
+
+
   def test_validate_not_bang_does_not_overwrite_original
     hash = {
       names: "john",
@@ -66,6 +87,7 @@ class TestSchema < Minitest::Test
     assert_equal "john", hash[:names]
   end
 
+
   def test_inherited_schema_should_inherit_extensions
     hash = {
       names: "john",
@@ -77,6 +99,7 @@ class TestSchema < Minitest::Test
     assert_nil hash[:book]
   end
 
+
   def test_complex_schema
     hash = {
       name: "john",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yas
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-01 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,14 +66,15 @@ files:
 - lib/yas/ext/attribute.rb
 - lib/yas/ext/migrate.rb
 - lib/yas/ext/rename.rb
+- lib/yas/ext/symbolize.rb
 - lib/yas/ext/whitelist.rb
 - lib/yas/hash.rb
-- lib/yas/helper.rb
 - lib/yas/schema.rb
 - lib/yas/version.rb
 - test/ext/test_attribute.rb
 - test/ext/test_migrate.rb
 - test/ext/test_rename.rb
+- test/ext/test_symbolize.rb
 - test/ext/test_whitelist.rb
 - test/helper.rb
 - test/test_schema.rb

data/lib/yas/helper.rb

@@ -1,10 +0,0 @@
-module YAS
-
-  def self.symbolize hash
-    hash.inject({}) do |memo,(k,v)|
-      memo[k.to_sym] = v
-      memo
-    end
-  end
-
-end