objectifyhash 2.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 725c8e28f27aa16476e95d07b9ee76389db8c3e2
+  data.tar.gz: 1324184f85b193430984b55e8fb8077056fc15f2
+SHA512:
+  metadata.gz: d561bb269d84025f9ace330065e74b457533b62dee1efdbd31b72cba18b19228ca83c6ab2c84713188e528f11040a9165838a70cb4eb6e74602dfd6fd0c5dad0
+  data.tar.gz: 8255df63d8336618e2e1195b048b8ceafe3a0603bb8f9afb8a520304124448cd5b8ec9121b1e1dcc9610d5408f92db95a739b5daaedaf94df6624bbfa19f4556

data/License.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2016, Sky UK Limited
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/objectifyhash.rb

@@ -0,0 +1,158 @@
+# coding: utf-8
+
+module ObjectifyHash
+  alias_method :eql?, :==
+  attr_accessor :values_to_compare
+
+  EXCEPTIONS     = {
+      data: Proc.new do | value | value; end
+  }
+  NULLABLE_KEYS = []
+
+  class GenericObject
+    include ObjectifyHash
+
+    def initialize hash
+      convert_and_define hash
+    end
+
+  end
+
+
+  def convert_and_define hash
+    @original_hash = hash
+    @values_to_compare||=[]
+    @original_hash.each do |key, value|
+      key = 'klass' if key == 'class'
+      key = key.to_sym
+      case
+        when key == :id
+          set :guid, value
+        when key == :method
+          set :verb, value
+        when EXCEPTIONS.key?( key )
+          set key, EXCEPTIONS[ key ].call( value )
+        when value.is_a?(Hash)
+          klass  = get_new_class key
+          # puts "Going to instanciate class based on #{key}"
+          object = klass.new( value )
+          # puts 'success'
+          set key, object
+        when value.is_a?(Array)
+          set key, objectify_array(value, key)
+        else
+          set key, value
+      end
+    end
+
+    NULLABLE_KEYS.each do |key|
+      unless self.respond_to?( key )
+        set key, nil
+      end
+    end
+
+  end
+
+
+  def objectify_array array,name
+    array.map do |elem|
+      if EXCEPTIONS.key? name
+        EXCEPTIONS[ name ].call( elem )
+      else
+        if elem.is_a? Hash
+          klass = get_new_class name.to_s.sub(/s$/, '').to_sym
+          klass.new elem
+        else
+          elem
+        end
+      end
+    end
+  end
+
+  def get_new_class name
+    name = "#{name.capitalize}_".to_sym if Object.constants.include? name.capitalize.to_sym
+    self.class.const_defined?(name.capitalize) ?
+        self.class.const_get(name.capitalize) :
+        self.class.const_set(name.capitalize, ObjectifyHash::GenericObject)
+  end
+
+
+  def set key, value
+    method_name = Object.instance_methods.include?( key ) ? :"_#{key}_" : key.to_sym
+    @values_to_compare.push method_name
+    self.__send__(:define_singleton_method, method_name, Proc.new do value; end )
+  end
+
+  def values_at *args
+    args.map do |key|
+      self.respond_to?( key ) ? self.method( key ).call : nil
+    end
+  end
+
+  def ignore_equal key = nil
+    @ignore_equal||=[]
+    @ignore_equal.push key if key
+    @ignore_equal
+  end
+
+  def == other
+    return false unless other.respond_to? :values_to_compare
+    return false unless self.values_to_compare - other.values_to_compare == [] #should not use == cuz arrays can have different orders
+    (self.values_to_compare - ignore_equal ).each do |value|
+      return false unless self.method(value).() == other.method(value).()
+    end
+    return true
+  end
+
+
+  def method_missing m, *args, &block
+    super m, *args, &block if args.length > 0 or block_given?
+    nil
+  end
+
+  #retro bunker compatibility
+  def [] val
+    $stderr.puts 'DEPRECATION WARNING #[] CALLED ON OBJECT'
+    raise NameError unless self.respond_to?( val.to_sym )
+    self.method( val ).call
+  end
+
+  def to_h
+    h = {}
+    values_to_compare.each do |m|
+      if self.method( m ).().nil? and NULLABLE_KEYS.include?( m )
+        next
+      end
+      if self.method( m ).().respond_to? :values_to_compare
+        h[ m.to_sym ] = self.method( m ).().to_h
+      elsif self.method( m ).().is_a? Array
+        h[ m.to_sym ] = un_objectify_array( self.method( m ).() )
+      else
+        h[ m.to_sym ] = self.method( m ).()
+      end
+    end
+    return h
+  end
+
+  def empty?
+    self.values_to_compare.empty?
+  end
+
+  private
+    def un_objectify_array array
+    array.map do |v|
+      if v.is_a? Array
+        un_objectify_array v
+      elsif v.respond_to? :values_to_compare
+        v.to_h
+      else
+        v
+      end
+    end
+  end
+
+
+
+
+end
+

data/lib/objectifyhash/hash.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+class Hash
+  def to_obj
+    ObjectifyHash::GenericObject.new( self )
+  end
+end

data/lib/objectifyhash/version.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+module ObjectifyHash
+  VERSION = "2.3.0"
+end

data/test/hash_to_obj_test.rb

@@ -0,0 +1,308 @@
+# coding: utf-8
+require 'minitest/autorun'
+require 'json'
+require_relative File.join('..','lib','objectifyhash')
+require_relative File.join('..','lib','objectifyhash', 'hash')
+
+class A
+  include ObjectifyHash
+
+  ObjectifyHash::EXCEPTIONS.merge!( {duration: Proc.new do 100; end})
+
+
+end
+class Hash2ObjTest < Minitest::Test
+  attr_accessor :a, :hash
+
+  # Called before every test method runs. Can be used
+  # to set up fixture information.
+  def setup
+    a = '{
+    "content": {
+    "class": "batatas",
+    "assetId": "e473a2f7-dc12-42d3-9933-fd5bd67a32e0",
+    "totalLicenses": 10,
+    "type": "EST",
+    "offerId": "51d4f5d9-ba88-427a-b430-274e9663980c",
+    "purchaseDate": "2015-07-07T09:23:17.49Z",
+    "ownerId": "6ecb8629-374a-4063-81da-c329f29b405d",
+    "ownership": "UserOwnership",
+    "canPlay": true,
+    "playbackRules": {},
+    "canSendToStb": false,
+    "canSendSpecs": {},
+    "content": {
+    "asset": {
+      "duration":1
+    },
+    "resume": {},
+    "contents": [
+    {
+    "asset": {
+    "title": "Back to the Future",
+    "altTitle": "Back to the Future - Season",
+    "slug": "back-to-the-future",
+    "shortSynopsis": "A high school student is accidentally sent 30 years into the past in a time-traveling sports car invented by his friend, Dr. Emmett Brown, and must make sure his high-school-age parents unite in order to save his own existence.",
+    "duration": 0,
+    "number": 1,
+    "year": 0,
+    "rel": "asset",
+    "lastUpdateDate": "2015-03-24T13:52:02Z",
+    "assetType": "Season",
+    "catalogSection": "Movies",
+    "id": "11eb97d3-c8ee-4502-a9dd-410c8b4dd66a",
+    "links": [
+    {
+    "rel": "self",
+    "href": "https://qa.skystore.com/api/webP3/v2/catalog/assets/11eb97d3-c8ee-4502-a9dd-410c8b4dd66a/back-to-the-future",
+    "needsAuthentication": false
+    },
+    {
+    "rel": "image",
+    "href": "http://qa.skystore.com/api/img/asset/en/F80DF38A-D09C-41C9-A419-81C6CF8582F3_3E1EE8E3-D376-4687-8C57-CC57475DE4FE_2015-6-22-T11-11-30.jpg?s={{w}}x{{h}}",
+    "needsAuthentication": false
+    }
+    ]
+    },
+    "resume": {
+    "asset": {
+    "title": "Back to the Future",
+    "altTitle": "Back to the Future - Movie",
+    "slug": "back-to-the-future",
+    "shortSynopsis": "A high school student is accidentally sent 30 years into the past in a time-traveling sports car invented by his friend, Dr. Emmett Brown, and must make sure his high-school-age parents unite in order to save his own existence.",
+    "duration": 116,
+    "year": 1985,
+    "rel": "asset",
+    "lastUpdateDate": "2015-01-09T11:36:08Z",
+    "assetType": "Programme",
+    "catalogSection": "Movies",
+    "id": "86b39480-87e6-4a99-891a-563fb780871b",
+    "links": [
+    {
+    "rel": "self",
+    "href": "https://qa.skystore.com/api/webP3/v2/catalog/assets/86b39480-87e6-4a99-891a-563fb780871b/back-to-the-future",
+    "needsAuthentication": false
+    },
+    {
+    "rel": "image",
+    "href": "http://qa.skystore.com/api/img/asset/en/F80DF38A-D09C-41C9-A419-81C6CF8582F3_72C3E254-7095-45BB-BF83-3055E08CC204_2015-6-22-T11-12-46.jpg?s={{w}}x{{h}}",
+    "needsAuthentication": false
+    }
+    ]
+    },
+    "video": {
+    "playbackPositionInSeconds": 0,
+    "progressPercent": 0,
+    "links": [
+    {
+    "rel": "videoOptions",
+    "href": "https://qa.skystore.com/api/webP3/v2/user/entitlements/fa879cad-8753-4040-8702-fd0937eeb7f4/86b39480-87e6-4a99-891a-563fb780871b/video/options",
+    "needsAuthentication": true
+    }
+    ]
+    }
+    },
+    "links": [
+    {
+    "rel": "self",
+    "href": "https://qa.skystore.com/api/webP3/v2/user/entitlements/fa879cad-8753-4040-8702-fd0937eeb7f4/11eb97d3-c8ee-4502-a9dd-410c8b4dd66a",
+    "needsAuthentication": true
+    }
+    ]
+    },
+{
+    "asset": {
+    "title": "Back to the Future FAKE ",
+    "altTitle": "Back to the Future - Season",
+    "slug": "back-to-the-future",
+    "shortSynopsis": "A high school student is accidentally sent 30 years into the past in a time-traveling sports car invented by his friend, Dr. Emmett Brown, and must make sure his high-school-age parents unite in order to save his own existence.",
+    "duration": 0,
+    "number": 1,
+    "year": 0,
+    "rel": "asset",
+    "lastUpdateDate": "2015-03-24T13:52:02Z",
+    "assetType": "Season",
+    "catalogSection": "Movies",
+    "id": "11eb97d3-c8ee-4502-a9dd-410c8b4dd66a",
+    "links": [
+    {
+    "rel": "self",
+    "href": "https://qa.skystore.com/api/webP3/v2/catalog/assets/11eb97d3-c8ee-4502-a9dd-410c8b4dd66a/back-to-the-future",
+    "needsAuthentication": false
+    },
+    {
+    "rel": "image",
+    "href": "http://qa.skystore.com/api/img/asset/en/F80DF38A-D09C-41C9-A419-81C6CF8582F3_3E1EE8E3-D376-4687-8C57-CC57475DE4FE_2015-6-22-T11-11-30.jpg?s={{w}}x{{h}}",
+    "needsAuthentication": false
+    }
+    ]
+    },
+    "resume": {
+    "asset": {
+    "title": "Back to the Future",
+    "altTitle": "Back to the Future - Movie",
+    "slug": "back-to-the-future",
+    "shortSynopsis": "A high school student is accidentally sent 30 years into the past in a time-traveling sports car invented by his friend, Dr. Emmett Brown, and must make sure his high-school-age parents unite in order to save his own existence.",
+    "duration": 116,
+    "year": 1985,
+    "rel": "asset",
+    "lastUpdateDate": "2015-01-09T11:36:08Z",
+    "assetType": "Programme",
+    "catalogSection": "Movies",
+    "id": "86b39480-87e6-4a99-891a-563fb780871b",
+    "links": [
+    {
+    "rel": "self",
+    "href": "https://qa.skystore.com/api/webP3/v2/catalog/assets/86b39480-87e6-4a99-891a-563fb780871b/back-to-the-future",
+        "needsAuthentication": false
+    },
+    {
+    "rel": "image",
+    "href": "http://qa.skystore.com/api/img/asset/en/F80DF38A-D09C-41C9-A419-81C6CF8582F3_72C3E254-7095-45BB-BF83-3055E08CC204_2015-6-22-T11-12-46.jpg?s={{w}}x{{h}}",
+    "needsAuthentication": false
+    }
+    ]
+    },
+    "video": {
+    "playbackPositionInSeconds": 0,
+    "progressPercent": 0,
+    "links": [
+    {
+    "rel": "videoOptions",
+    "href": "https://qa.skystore.com/api/webP3/v2/user/entitlements/fa879cad-8753-4040-8702-fd0937eeb7f4/86b39480-87e6-4a99-891a-563fb780871b/video/options",
+        "needsAuthentication": true
+    }
+    ]
+    }
+    },
+    "links": [
+    {
+    "rel": "self",
+    "href": "https://qa.skystore.com/api/webP3/v2/user/entitlements/fa879cad-8753-4040-8702-fd0937eeb7f4/11eb97d3-c8ee-4502-a9dd-410c8b4dd66a",
+    "needsAuthentication": true
+    }
+    ]
+    }
+    ]
+    },
+    "id": "fa879cad-8753-4040-8702-fd0937eeb7f4",
+    "links": [
+    {
+    "rel": "deviceStatus",
+    "href": "https://qa.skystore.com/api/webP3/v2/user/devices/status",
+    "needsAuthentication": true
+    }
+    ]
+    },
+    "meta": {
+    "httpCode": 200
+    }
+    }'
+
+
+
+    @hash = JSON.parse a
+    @a = A.new
+    @a.convert_and_define hash
+  end
+
+
+  def test_basic_nesting_key
+   assert_equal a.content.assetId, hash['content']['assetId']
+  end
+
+  def test_correct_name_space
+    assert_equal a.content.class, A::Content
+  end
+
+  def test_custom_exception
+    assert_equal a.content.content.asset.duration, 100
+  end
+
+  def test_arrays_are_arrays
+    assert a.content.content.contents.is_a?( Array)
+  end
+  def test_no_list_namespace
+    assert a.content.content.contents.first.is_a?( A::Content::Content::Content)  #notice the missing Contents class
+  end
+
+  def test_deep_obj_with_arrays
+    assert_equal a.content.content.contents.first.asset.title,  hash['content']['content']['contents'].first['asset']['title']
+  end
+  def test_deep_obj_with_arrays_via_last
+    assert_equal a.content.content.contents.last.asset.title,  hash['content']['content']['contents'].last['asset']['title']
+  end
+  def test_camel_case_name
+    assert_equal a.content.totalLicenses,  hash['content']['totalLicenses']
+  end
+
+
+  def test_custom_nullable_keys
+    c = a.to_h
+    ObjectifyHash::NULLABLE_KEYS.concat [:type]
+    b = ObjectifyHash::GenericObject.new c
+    assert b.content.content.contents.last.type.nil?
+  end
+
+  def test_to_obj
+    assert_equal hash.to_obj.methods(false), a.methods(false)
+  end
+
+  def test_cloned_obj_is_eq
+    assert_equal @a, @a.clone #dup won't work because it doesn't copy singleton methods made by objectifyhash
+  end
+
+  def test_object_is_different
+    b = ObjectifyHash::GenericObject.new({a: 1, b:2, c: {kunamis: 'frescos'}})
+    assert !(@a == b)
+  end
+
+  def test_can_ignore_some_fields
+    b = ObjectifyHash::GenericObject.new({a: 1, b:2, c: {kunamis: 'frescos'}})
+    c = ObjectifyHash::GenericObject.new({a: 1, b:2, c: {kunamis: 'frescos'}})
+
+    b.ignore_equal :c
+
+    assert_equal b,c
+  end
+
+  def test_to_h
+    a      = {a: 1, b:{c: 2}, d: [1,3,4,[{z:1, y:[1]}]]}
+    object = a.to_obj
+    assert_equal a, object.to_h
+  end
+
+  def test_nil_if_does_not_have
+    assert_nil @a.eyjafjallajökull
+  end
+
+  def test_not_empty
+    refute(a.empty?)
+  end
+
+  def test_convert_class_to_klass
+    assert_equal 'batatas', a.content.klass
+  end
+
+  def test_is_empty
+    ObjectifyHash::NULLABLE_KEYS.clear
+    h = ObjectifyHash::GenericObject.new({})
+    assert h.empty?
+  end
+
+  def test_allows_top_level_constants
+    h = {details: {files: [{name:'file A'}]}, process: '31B'}
+    o = ObjectifyHash::GenericObject.new(h)
+    assert_equal( {name:'file A'},  o.details.files.first.to_h)
+    assert_equal '31B',  o.process
+    #caviat
+    assert o.details.files.first.is_a? ObjectifyHash::GenericObject::File_
+  end
+
+  def test_circuvent_preexisting_methods
+    h = {send:{define_singleton_method: 1}}
+    o = ObjectifyHash::GenericObject.new(h)
+    assert_equal 1, o._send_._define_singleton_method_
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: objectifyhash
+version: !ruby/object:Gem::Version
+  version: 2.3.0
+platform: ruby
+authors:
+- Arthur Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: This gem allows you to easily turn your hashes into objects, great for
+  dealing with rest api's
+email:
+- arthur.silva@sky.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- License.txt
+- lib/objectifyhash.rb
+- lib/objectifyhash/hash.rb
+- lib/objectifyhash/version.rb
+- test/hash_to_obj_test.rb
+homepage: https://github.com/sky-uk/skystore-contrib-gem-objectifyhash
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This gem allows you to easily turn your hashes into objects
+test_files: []