requisite 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ae33af68416be1beb8abf9c3384934e4c93f1a46ab089c05436956a7391e3a
-  data.tar.gz: ef8a85a1fb0af0aedee42f635283590306016e0101adef510365f065ae6cb908
+  metadata.gz: 828a5465ab9ec59c47bda9e6ab72c34e9bdbab05536ab99ad45c3cdaec933f16
+  data.tar.gz: b1c387023439e720d6600310604828d672abd8dd4eabb25d0412bcec423c4529
 SHA512:
-  metadata.gz: 35f9ebfbf4ff91f05067c422e27b13caed813d926093f0c5bf792375be57cdb03a5451e8690a999417826334d762484e63eb58025c0eafda6bade2db210d5615
-  data.tar.gz: 362d50d708a1d1f80002dc751fa41cf5baf8ed1dea3cd66725e80472df2fd1dcb9d9224964699cd06a3deecfccd8e7c10466dc852a89731b8b55169f65c0fceb
+  metadata.gz: eb0c6e6e4cc10fb351e01334754196f2a65ced999a32980f416a2c226b4ea1a76a77b0a1b0523e408de9b372fc40676ab7e9482290f28d13d983947ae750a9f9
+  data.tar.gz: 3269605161e8264e04dc0640637a107d4db5ef079f635e31c674cc35cb409eb32ccb991a3f17bcebe4f31bedcd6616fbfb09856829a86f5a802f67f998df9ac1

data/README.md

@@ -38,7 +38,7 @@ class UserApiModel < Requisite::ApiModel
     attribute! :username
     attribute :real_name
   end
-  
+
   # method with the name of of an attribute will be called to calculate the mapped value
   def real_name
     "#{attribute_from_model(:first_name)} #{attribute_from_model(:last_name)}"
@@ -88,10 +88,10 @@ Example:
 class UserApiModel < Requisite::ApiModel
   serialized_attributes do
     attribute :id, stringify: true
-    attribute :custom_attributes, rename: :custom_data 
+    attribute :custom_attributes, rename: :custom_data
     attribute :is_awesome, default: true
     attribute :awesome_score, rename: :score, stringify: true, default: 9001
-    attribute :age, type: Fixnum,
+    attribute :age, type: Integer,
     attribute :tired, type: Requisite::Boolean
   end
 end
@@ -131,7 +131,7 @@ With typed hashes, only values specified with a type are permitted:
 ```ruby
 class UserApiModel < Requisite::ApiModel
   serialized_attributes do
-    attribute :data, typed_hash: { is_awesome: Requisite::Boolean, score: Fixnum, name: String  }
+    attribute :data, typed_hash: { is_awesome: Requisite::Boolean, score: Integer, name: String  }
   end
 end
 
@@ -198,7 +198,27 @@ class ApiUser < Requisite::ApiModel
     raise IdentifierNotFoundError unless identifier
   end
 end
-```  
+```
+
+#### Around each attribute
+
+An `around_each_attribute` method can be defined to wrap each attribute fetch in a block. This can be useful for instrumenting processing on a per attribute basis.
+
+```ruby
+class ApiUser < Requisite::ApiModel
+  serialized_attributes do
+    attribute :id, type: String
+    attribute :email, type: String
+  end
+
+  def around_each_attribute(name, &block)
+    start = Time.now
+    yield
+    end = Time.now
+    puts "Fetching #{name} took #{end - start}"
+  end
+end
+```
 
 #### Thanks
 

data/lib/requisite/boundary_object.rb

@@ -4,14 +4,17 @@ module Requisite
       def attribute(name, options={})
         attribute_keys << name
         define_method(name) do
-          resolved_name = options[:rename] || name
-          result = self.send(:convert, resolved_name)
-          result = self.send(:parse_typed_hash, resolved_name, options[:typed_hash]) if options[:typed_hash]
-          result = self.send(:parse_scalar_hash, resolved_name) if options[:scalar_hash]
-          result = self.send(:parse_typed_array, resolved_name, options[:typed_array]) if options[:typed_array]
-          result = options[:default] if (options.key?(:default) && empty_result?(result))
-          raise_bad_type_if_type_mismatch(result, options[:type]) if options[:type] && result
-          result = result.to_s if options[:stringify]
+          result = nil
+          self.send(:around_each_attribute, name) do
+            resolved_name = options[:rename] || name
+            result = self.send(:convert, resolved_name)
+            result = self.send(:parse_typed_hash, resolved_name, options[:typed_hash]) if options[:typed_hash]
+            result = self.send(:parse_scalar_hash, resolved_name) if options[:scalar_hash]
+            result = self.send(:parse_typed_array, resolved_name, options[:typed_array]) if options[:typed_array]
+            result = options[:default] if (options.key?(:default) && empty_result?(result))
+            raise_bad_type_if_type_mismatch(result, options[:type]) if options[:type] && result
+            result = result.to_s if options[:stringify]
+          end
           result
         end
       end
@@ -19,13 +22,16 @@ module Requisite
       def attribute!(name, options={})
         attribute_keys << name
         define_method(name) do
-          resolved_name = options[:rename] || name
-          result = self.send(:convert!, resolved_name)
-          result = self.send(:parse_typed_hash, resolved_name, options[:typed_hash]) if options[:typed_hash]
-          result = self.send(:parse_scalar_hash, resolved_name) if options[:scalar_hash]
-          result = self.send(:parse_typed_array, resolved_name, options[:typed_array]) if options[:typed_array]
-          result = result.to_s if options[:stringify]
-          raise_bad_type_if_type_mismatch(result, options[:type]) if options[:type]
+          result = nil
+          self.send(:around_each_attribute, name) do
+            resolved_name = options[:rename] || name
+            result = self.send(:convert!, resolved_name)
+            result = self.send(:parse_typed_hash, resolved_name, options[:typed_hash]) if options[:typed_hash]
+            result = self.send(:parse_scalar_hash, resolved_name) if options[:scalar_hash]
+            result = self.send(:parse_typed_array, resolved_name, options[:typed_array]) if options[:typed_array]
+            result = result.to_s if options[:stringify]
+            raise_bad_type_if_type_mismatch(result, options[:type]) if options[:type]
+          end
           result
         end
       end
@@ -46,6 +52,10 @@ module Requisite
 
     private
 
+    def around_each_attribute(name)
+      yield
+    end
+
     self.singleton_class.send(:alias_method, :a, :attribute)
     self.singleton_class.send(:alias_method, :a!, :attribute!)
 

data/lib/requisite/version.rb

@@ -1,3 +1,3 @@
 module Requisite
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/test/requisite/api_model_test.rb

@@ -107,7 +107,7 @@ module Requisite
     end
 
     it 'attribute can be stringified after type check' do
-      DummyApiModel.serialized_attributes { attribute :num, stringify: true, type: Fixnum }
+      DummyApiModel.serialized_attributes { attribute :num, stringify: true, type: Integer }
       response = DummyApiModel.new(params_hash)
       _(response.to_hash).must_equal(:num => '12')
     end
@@ -202,7 +202,7 @@ module Requisite
 
       describe 'with typed arrays' do
         it 'allows arrays of one type' do
-          DummyApiModel.serialized_attributes { attribute :ids, typed_array: Fixnum }
+          DummyApiModel.serialized_attributes { attribute :ids, typed_array: Integer }
           response = DummyApiModel.new({ids: [1, 2, 3]})
           _(response.to_hash).must_equal(:ids => [1, 2, 3])
         end

data/test/requisite/api_user_test.rb

@@ -1,15 +1,17 @@
 require 'test_helper'
+require 'benchmark'
 
 # Example Object
 class ApiUser < Requisite::ApiModel
+
   serialized_attributes do
     attribute :id, type: String
     attribute :user_id
     attribute :email, type: String
     attribute :name, type: String
-    attribute :created_at, type: Fixnum
+    attribute :created_at, type: Integer
     attribute :last_seen_user_agent, type: String
-    attribute :last_request_at, type: Fixnum
+    attribute :last_request_at, type: Integer
     attribute :unsubscribed_from_emails, type: Requisite::Boolean
     attribute :update_last_request_at, type: Requisite::Boolean
     attribute :new_session, type: Requisite::Boolean
@@ -17,7 +19,7 @@ class ApiUser < Requisite::ApiModel
     attribute :company
     attribute :companies
   end
-  
+
   # Ensure that at least one identifier is passed
   def preprocess_model
     identifier = attribute_from_model(:id)
@@ -25,10 +27,30 @@ class ApiUser < Requisite::ApiModel
     identifier ||= attribute_from_model(:email)
     raise StandardError unless identifier
   end
-  
+
+  def last_attribute_fetch_time
+    @last_attribute_fetch_time
+  end
+
+  def attribute_names
+    @attribute_names
+  end
+
+  def around_each_attribute(name)
+    @last_attribute_fetch_time = nil
+    @attribute_names ||= []
+
+    result = nil
+
+    @last_attribute_fetch_time = Benchmark.measure do
+      result = yield
+    end.total
+    @attribute_names << name
+  end
+
   # We want to accept someone sending `created_at` or `created` as parameters
   def created_at
-    with_type!(Fixnum) { attribute_from_model(:created_at) || attribute_from_model(:created) }
+    with_type!(Integer) { attribute_from_model(:created_at) || attribute_from_model(:created) }
   end
 end
 
@@ -71,13 +93,13 @@ module Requisite
       })
       user.name.must_equal('Bob')
     end
-    
+
     it 'raises an error without an identifier' do
       user_request_params = { :name => 'Bob' }
       user = ApiUser.new(user_request_params)
       proc { user.to_hash }.must_raise(StandardError)
     end
-    
+
     it 'raises an error when created or created_at is not of the right type' do
       user_request_params = { :user_id => 'abcdef', :created => 'Thursday' }
       user = ApiUser.new(user_request_params)
@@ -116,7 +138,7 @@ module Requisite
         :new_attribute => 'hi'
       })
     end
-    
+
     it 'accepts a user model' do
       user_model = UserModel.new
       user_model.user_id = 'abcdef'
@@ -129,7 +151,7 @@ module Requisite
       })
       user.name.must_equal('Bob')
     end
-    
+
     it 'accepts a user model and renders nils if asked' do
       user_model = UserModel.new
       user_model.user_id = 'abcdef'
@@ -152,5 +174,16 @@ module Requisite
       })
       user.name.must_equal('Bob')
     end
+
+    it 'calls around_each_attribute for each attribute' do
+      user_model = UserModel.new
+      user_model.user_id = 'abcdef'
+      user = ApiUser.new(user_model)
+
+      user.to_hash(show_nil: true)
+
+      user.attribute_names.must_equal [:id, :user_id, :email, :name, :last_seen_user_agent, :last_request_at, :unsubscribed_from_emails, :update_last_request_at, :new_session, :custom_data, :company, :companies]
+      user.last_attribute_fetch_time.must_be :>, 0
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: requisite
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - James Osler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -82,7 +82,7 @@ homepage: https://www.intercom.io
 licenses:
 - Apache License Version 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,9 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Strongly defined models for HTTP APIs
 test_files: