hashme 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f50c8f90a959db106926caadbdaee800ed55073
-  data.tar.gz: 422d08c967c35172445489d6716b1a799f53b299
+SHA256:
+  metadata.gz: 157002395c66c0c5a0d4ffe7c13cf16f93a5ee016a8c42c9388362b7f80b65ae
+  data.tar.gz: '032850cb9db195516320a53afc10432d918b0f066fc4d0ed0cf7291216a336f5'
 SHA512:
-  metadata.gz: 417b46455a892130eb7e4b8781dccfa7530ac10cf93d656863c78d3ebc5b59a2f81b8378acc9736944bd25062f37c65eb475ce8522b8af961b888802300318dd
-  data.tar.gz: 0c8c5cd1b21333070e76c6e74f9c40095c4f48117086a72be98f61db7a0201f79cfb83ac5c3468e8ebaf6bf5d52e093bc5bb88671af8a08c737bd72b8feba15b
+  metadata.gz: 1c6820691be9c3b71e0e570d3bb4a37315e896e3203096017905750f9c18aa122039bc7a889dc67a1ff24ae2af7da2956803de806490e7224e3b40bda2de0f6c
+  data.tar.gz: 8e397827a0eb98c019e88b2a4d6155817693d50be1e90c33f6ff8a295dbd980198c24887daae41d68a3965fa50e96a987fa125e379c7503b8d0878c86da3b1fd

data/README.md

@@ -120,6 +120,13 @@ u.errors.first     # [:email, "can't be blank"]
 
 ## History
 
+### 0.3.0 - 2023-01-23
+
+* Making `CastArray` provide the whole `Array` API by inherityin from it
+* Removing default value fallback to fix bug with booleans
+* Adding support for `URI` objects typecasting
+* Adding `Boolean` as an alias of `TrueClass`
+
 ### 0.2.6 - 2017-09-12
 
  * Setting ActiveModel minimum to 4.0, adding travis config to test both 4.0 and 5.0. (@samlown)
@@ -158,7 +165,7 @@ u.errors.first     # [:email, "can't be blank"]
  * Refactoring to use `class_attribute` for properties hash for improved inheritance.
 
 ### 0.1.1 - 2014-01-21
- 
+
  * Fixing dependency on ActiveModel >= 3.0
 
 ### 0.1.0 - 2014-01-15

data/hashme.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activemodel", ">= 4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/hashme/attributes.rb

@@ -1,7 +1,7 @@
 module Hashme
   module Attributes
     include Enumerable
-    
+
     extend Forwardable
 
     def_delegators :_attributes, :to_a,

data/lib/hashme/casted_array.rb

@@ -2,60 +2,83 @@ require 'forwardable'
 
 module Hashme
 
-  # The Hashme CastedArray is a special object wrapper that allows other Model's
-  # or Objects to be stored in an array, but maintain casted ownership.
-  #
-  # Adding objects will automatically assign the Array's owner, as opposed
-  # to the array itself.
-  #
-  class CastedArray
-    extend Forwardable
-
+  # The Hashme CastedArray is a special Array that typecasts each item according to a given property
+  class CastedArray < Array
     attr_reader :property
 
-    def_delegators :@_array,
-      :to_a, :==, :eql?, :size,
-      :first, :last, :at, :length,
-      :each, :reject, :empty?, :map, :collect,
-      :clear, :pop, :shift, :delete, :delete_at,
-      :encode_json, :as_json, :to_json,
-      :inspect, :any?
-
-    def initialize(property, owner, values = [])
-      @_array = []
+    def initialize(property, vals = [])
       @property = property
-      if values.respond_to?(:each)
-        values.each do |value|
-          self.push(value)
-        end
-      end
+      super build_all(vals)
+    end
+
+    def <<(val)
+      super build(val)
+    end
+
+    def push(*vals)
+      super *build_all(vals)
+    end
+
+    alias append push
+
+    def concat(*arrays)
+      super *arrays.map { |array| build_all(array) }
     end
 
-    def <<(obj)
-      @_array << instantiate_and_build(obj)
+    def insert(index, *vals)
+      super index, *build_all(vals)
     end
 
-    def push(obj)
-      @_array.push(instantiate_and_build(obj))
+    def unshift(*vals)
+      super *build_all(vals)
     end
 
-    def unshift(obj)
-      @_array.unshift(instantiate_and_build(obj))
+    alias prepend unshift
+
+    def replace(array)
+      super build_all(array)
     end
-    
-    def [] index
-      @_array[index]
+
+    def []=(*args)
+      args = args.dup
+      args[-1] = build(args[-1])
+      super *args
     end
 
-    def []= index, obj
-      @_array[index] = instantiate_and_build(obj)
+    def fill(*args, &block)
+      if block
+        super *args do |index|
+          val = block.call(index)
+          build(val)
+        end
+      else
+        args = args.dup
+        args[0] = build(args[0])
+        super *args
+      end
     end
-    
+
+    def collect!(&block)
+      if block
+        super do |element|
+          val = block.call(element)
+          build(val)
+        end
+      else
+        super
+      end
+    end
+
+    alias map! collect!
+
     protected
 
-    def instantiate_and_build(obj)
-      property.build(self, obj)
+    def build_all(vals)
+      vals.map { |val| build(val) }
     end
 
+    def build(val)
+      property.build(val)
+    end
   end
 end

data/lib/hashme/properties.rb

@@ -14,7 +14,7 @@ module Hashme
     def set_attribute(name, value)
       property = get_property(name)
       if property
-        value = property.build(self, value)
+        value = property.build(value)
         if value.nil?
           delete(property.name)
         else
@@ -45,9 +45,9 @@ module Hashme
         set_attribute(key, value)
       end
     end
-    
+
     private
-    
+
     def get_property(name)
       self.class.properties[name.to_sym]
     end
@@ -68,7 +68,7 @@ module Hashme
       def define_property_methods(property)
         # Getter
         define_method(property.name) do
-          get_attribute(property.name) || property.default
+          get_attribute(property.name)
         end
         # Setter
         define_method "#{property.name}=" do |value|

data/lib/hashme/property.rb

@@ -33,11 +33,11 @@ module Hashme
     end
 
     # Build a new object of the type defined by the property.
-    def build(owner, value)
+    def build(value)
       if array && value.is_a?(Array)
-        CastedArray.new(self, owner, value)
+        CastedArray.new(self, value)
       else
-        PropertyCasting.cast(self, owner, value)
+        PropertyCasting.cast(self, value)
       end
     end
 

data/lib/hashme/property_casting.rb

@@ -1,5 +1,8 @@
 module Hashme
 
+  # Alias TrueClass as Boolean, so that it can be used as property types
+  Boolean = TrueClass
+
   # Special property casting for reveiving data from sources without Ruby types, such as query
   # parameters from an API or JSON documents.
   #
@@ -7,10 +10,10 @@ module Hashme
   module PropertyCasting
     extend self
 
-    CASTABLE_TYPES = [String, Symbol, TrueClass, Integer, Float, BigDecimal, DateTime, Time, Date, Class]
+    CASTABLE_TYPES = [String, Symbol, TrueClass, Integer, Float, BigDecimal, DateTime, Time, Date, Class, URI]
 
     # Automatically typecast the provided value into an instance of the provided type.
-    def cast(property, owner, value)
+    def cast(property, value)
       return nil if value.nil?
       type = property.type
       if value.instance_of?(type) || type == Object
@@ -186,5 +189,12 @@ module Hashme
       nil
     end
 
+    # Typecast a value to URI
+    def typecast_to_uri(value)
+      URI(value)
+    rescue ArgumentError
+      nil
+    end
+
   end
 end

data/lib/hashme/validations/casted_attribute_validator.rb

@@ -1,7 +1,7 @@
 module Hashme
   module Validations
     class CastedAttributeValidator < ActiveModel::EachValidator
-      
+
       def validate_each(document, attribute, value)
         is_array = value.is_a?(Array) || value.is_a?(CastedArray)
         values = is_array ? value : [value]

data/lib/hashme/version.rb

@@ -1,3 +1,3 @@
 module Hashme
-  VERSION = "0.2.6"
+  VERSION = "0.3.0"
 end

data/lib/hashme.rb

@@ -2,6 +2,8 @@ require "hashme/version"
 
 # External dependencies
 
+require "uri"
+
 require "active_model"
 require "active_model/naming"
 require "active_model/serialization"

data/spec/hashme/base_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
 describe Hashme do
-  
+
   before :each do
     @model = Class.new do
       include Hashme
       property :name, String
     end
   end
-  
+
   describe '.build' do
     it "should create a Model and give a block to build it" do
       expect(@model).to receive(:call_in_block)

data/spec/hashme/casted_array_spec.rb

@@ -1,11 +1,6 @@
 require 'spec_helper'
 
 describe Hashme::CastedArray do
-
-  let :owner do
-    double()
-  end
-
   let :submodel do
     Class.new do
       include Hashme
@@ -13,43 +8,124 @@ describe Hashme::CastedArray do
     end
   end
 
-  describe "#initialize" do
-    let :property do
-      Hashme::Property.new(:name, String)
-    end
-    before :each do
-      @obj = Hashme::CastedArray.new(property, owner, ['test'])
-    end
+  let :property do
+    Hashme::Property.new(:item, submodel)
+  end
+
+  subject do
+    Hashme::CastedArray.new(property, [{:name => 'test'}])
+  end
 
+  describe "#initialize" do
     it "should prepare array" do
-      expect(@obj.length).to eql(1)
+      expect(subject.length).to eql(1)
     end
 
     it "should set property" do
-      expect(@obj.property).to eql(property)
+      expect(subject.property).to eql(property)
     end
 
     it "should instantiate and cast each value" do
-      expect(@obj.first).to eql("test")
-      expect(@obj.first.class).to eql(String)
+      expect(subject.first.class).to eql(submodel)
+      expect(subject.first.name).to eql('test')
     end
   end
 
-  describe "adding to array" do
-    subject do
-      Hashme::CastedArray.new(property, owner, [{:name => 'test'}])
-    end
-    let :property do
-      Hashme::Property.new(:item, submodel)
-    end
+  it "should cast items added to the array" do
+    subject << {:name => 'test2'}
+    expect(subject.last.class).to eql(submodel)
+    expect(subject.last.name).to eql('test2')
+  end
 
-    it "should cast new items" do
-      subject << {:name => 'test2'}
-      expect(subject.last.class).to eql(submodel)
-      expect(subject.first.name).to eql('test')
-      expect(subject.last.name).to eql('test2')
-    end
+  it "should cast items using `push`" do
+    subject.push({ :name => 'test2'}, { :name => 'test3' })
+    expect(subject.last.class).to eql(submodel)
+    expect(subject.last.name).to eql('test3')
+  end
+
+  it "should cast items using `concat`" do
+    subject.concat([{ :name => 'test2'}], [{ :name => 'test3' }])
+    expect(subject.last.class).to eql(submodel)
+    expect(subject.last.name).to eql('test3')
+  end
+
+  it "should cast items using `insert`" do
+    subject.insert(0, { :name => 'test2'}, { :name => 'test3' })
+    expect(subject[1].class).to eql(submodel)
+    expect(subject[1].name).to eql('test3')
+  end
+
+  it "should cast items using `unshift`" do
+    subject.unshift({ :name => 'test2'}, { :name => 'test3' })
+    expect(subject[1].class).to eql(submodel)
+    expect(subject[1].name).to eql('test3')
+  end
+
+  it "should cast items using `replace`" do
+    subject.replace([{ :name => 'test2'}, { :name => 'test3' }])
+    expect(subject[1].class).to eql(submodel)
+    expect(subject[1].name).to eql('test3')
+  end
+
+  it "should cast items using `[]=`" do
+    subject[5, 10] = { :name => 'test2'}
+    expect(subject[5].class).to eql(submodel)
+    expect(subject[5].name).to eql('test2')
+  end
+
+  it "should cast items using fill with block" do
+    subject.fill(0) { |index| { :name => "test#{index}" } }
+    expect(subject.last.class).to eql(submodel)
+    expect(subject.last.name).to eql('test0')
+  end
+
+  it "should cast items using fill without block" do
+    subject.fill({ :name => "test-filled" }, 0)
+    expect(subject.last.class).to eql(submodel)
+    expect(subject.last.name).to eql('test-filled')
+  end
+
+  it "should cast items using `collect!` with a block" do
+    subject.collect! { |item| { :name => "Mapped #{item.name}" } }
+    expect(subject.first.name).to eql('Mapped test')
+  end
 
+  it "should support Enumerable methods" do
+    map = subject.map(&:name)
+    expect(map).to be_an(Enumerable)
+    expect(map.first).to eql('test')
   end
 
+  it "should compare for equality with CastedArrays" do
+    same = Hashme::CastedArray.new(property, [{:name => 'test'}])
+    different = Hashme::CastedArray.new(property, [{:name => 'test2'}])
+
+    expect(subject == same).to be(true)
+    expect(subject.eql?(same)).to be(true)
+
+    expect(subject == different).to be(false)
+    expect(subject.eql?(different)).to be(false)
+  end
+
+  it "should compare for equality with Arrays" do
+    same = [submodel.new(:name => 'test')]
+    different = [submodel.new(:name => 'test2')]
+
+    expect(subject == same).to be(true)
+    expect(subject.eql?(same)).to be(true)
+
+    expect(subject == different).to be(false)
+    expect(subject.eql?(different)).to be(false)
+  end
+
+  it "should be compared for equality with Arrays" do
+    same = [submodel.new(:name => 'test')]
+    different = [submodel.new(:name => 'test2')]
+
+    expect(same == subject).to be(true)
+    expect(same.eql?(subject)).to be(true)
+
+    expect(different == same).to be(false)
+    expect(different.eql?(same)).to be(false)
+  end
 end

data/spec/hashme/properties_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Hashme::Properties do
-  
+
   before :all do
     @aux_model = Class.new do
       include Hashme
@@ -39,7 +39,7 @@ describe Hashme::Properties do
     it "should set and cast attribute with property" do
       property = model.send(:properties)[:name]
       name = "Fred Flinstone"
-      expect(property).to receive(:build).with(obj, name).and_return(name)
+      expect(property).to receive(:build).with(name).and_return(name)
       obj.set_attribute(:name, name)
       expect(obj[:name]).to eql(name)
     end
@@ -111,12 +111,18 @@ describe Hashme::Properties do
       obj.desc = "test"
       expect(obj.desc).to eql("test")
     end
-    
+
     it "should return nil on property with no default" do
       model.property :nickname, String
       expect(obj.nickname).to be_nil
     end
 
+    it 'should not return the default value when a Boolean is set to false' do
+      model.property :flag, TrueClass, :default => true
+      obj.flag = false
+      expect(obj.flag).to be(false)
+    end
+
     it "should create helper method with support for default values" do
       model.property :name, String, :default => "Sam"
       expect(obj.name).to eql("Sam")

data/spec/hashme/property_casting_spec.rb

@@ -12,10 +12,11 @@ class Course
   property :started_on, Date
   property :updated_at, DateTime
   property :active, TrueClass
-  property :very_active, TrueClass
+  property :very_active, Boolean
   property :klass, Class
   property :currency, String, :default => 'EUR'
   property :symbol, Symbol
+  property :uri, URI
 end
 
 describe Hashme::PropertyCasting do
@@ -598,19 +599,19 @@ describe Hashme::PropertyCasting do
     end
   end
 
-  describe 'when type primitive is a Boolean' do
+  describe 'when type primitive is a TrueClass' do
 
     [ true, 'true', 'TRUE', '1', 1, 't', 'T' ].each do |value|
       it "returns true when value is #{value.inspect}" do
         course.active = value
-        expect(course['active']).to be_truthy
+        expect(course['active']).to be(true)
       end
     end
 
     [ false, 'false', 'FALSE', '0', 0, 'f', 'F' ].each do |value|
       it "returns false when value is #{value.inspect}" do
         course.active = value
-        expect(course['active']).to be_falsey
+        expect(course['active']).to be(false)
       end
     end
 
@@ -620,5 +621,29 @@ describe Hashme::PropertyCasting do
         expect(course['active']).to be_nil
       end
     end
+
+    it "supports Boolean as an alias of TrueClass" do
+      course.very_active = 't'
+      expect(course['very_active']).to be(true)
+    end
+
+  end
+
+  describe 'when type primitive is an URI' do
+    it 'returns same value if an uri' do
+      value = URI('https://invopop.com')
+      course.uri = value
+      expect(course['uri']).to equal(value)
+    end
+
+    it 'returns an URI if parses as one' do
+      course.uri = 'https://invopop.com'
+      expect(course['uri']).to eql(URI('https://invopop.com'))
+    end
+
+    it 'does not typecast non-uri values' do
+      course.uri = 1234
+      expect(course['uri']).to be_nil
+    end
   end
 end

data/spec/hashme/property_spec.rb

@@ -6,10 +6,6 @@ describe Hashme::Property do
     described_class
   end
 
-  let :owner do
-    double()
-  end
-
   let :submodel do
     Class.new do
       include Hashme
@@ -61,7 +57,7 @@ describe Hashme::Property do
     context "without an array" do
       it "should build a new object" do
         prop = subject.new(:date, Time)
-        obj = prop.build(owner, "2013-06-02T12:00:00Z")
+        obj = prop.build("2013-06-02T12:00:00Z")
         expect(obj.class).to eql(Time)
         expect(obj).to eql(Time.utc(2013, 6, 2, 12, 0, 0))
       end
@@ -70,13 +66,13 @@ describe Hashme::Property do
     context "with an array" do
       it "should convert regular array to casted array" do
         prop = subject.new(:dates, [Time])
-        obj = prop.build(owner, ["2013-06-02T12:00:00"])
+        obj = prop.build(["2013-06-02T12:00:00"])
         expect(obj.class).to eql(Hashme::CastedArray)
         expect(obj.first.class).to eql(Time)
       end
       it "should handle complex objects" do
         prop = subject.new(:items, [submodel])
-        obj = prop.build(owner, [{:name => 'test'}])
+        obj = prop.build([{:name => 'test'}])
         expect(obj.class).to eql(Hashme::CastedArray)
         expect(obj.first.class).to eql(submodel)
         expect(obj.first.name).to eql('test')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashme
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Easily define simple models that can be easily serialized and de-serialized.