ncore 3.3.1 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e96bdc957fc537987137e4029761a2783ddc947de794cf95e90234fa9adda3
-  data.tar.gz: eace234486547704df6dcdad2963fb4f2d7cab5de6effbdb7f47a9889fc73737
+  metadata.gz: c66806c855a5d52a9461e2bc48542dff6b5f9d7628c5bc3a850dbd3a99fdef11
+  data.tar.gz: eeee6c280d80ab935925e883c39d493b8d9dafa39c4d1c6019055781ecf6ce77
 SHA512:
-  metadata.gz: 6cff9f32d5f2eb0c79bb15e05e1e60384e4a13ebb9eaf8dc750ada0cb4d49e093ffb0692ef6530f8be672bf53280816f725095496911c00453fefcc19d771309
-  data.tar.gz: c4099d3db77792c8775e3ce1ba215203f896f03ca549401c70d3f95ee0bf4877eaa3b9a6404929b55f2d48dfafb6f562c64cf3f85b19f7cd3a9b26084b58fc86
+  metadata.gz: 9c9d20b236e6dd742ee5863a6bcfff5908993354cef3944ba1d17c930278400df01099ac957d40421bd63d2c7384cadfe8414126d14abe5471b97350d1f3e2b3
+  data.tar.gz: da4473efcb0e5796d9eedf65b0edf1e438c3e5a67a813f0d69f62770e95dbd0cf2e4473349a5e560d030e513c532f07d8d9fb815151c35ded21586547e5ee6de

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+#### 3.4.0
+
+- Add SomeResource#wait_for and WaitTimeout
+
+#### 3.3.4
+
+- Fix :cache option on Ruby 3.0
+
+#### 3.3.3
+
+- Handle recursion in #inspect
+
+#### 3.3.2
+
+- Ruby 3.0 compatibility
+
 #### 3.3.1
 
 - Fix module_parent when using ActiveSupport 5.2

data/lib/ncore/attributes.rb

@@ -160,10 +160,14 @@ module NCore
     end
 
 
-    def load(data:, errors: nil, metadata: nil)
-      self.metadata = metadata || {}.with_indifferent_access
-      self.errors = parse_errors(errors)
-      data.each do |k,v|
+    def load(args={})
+      raise ArgumentError, "Missing :data" unless args.key?(:data)
+      extra_keys = args.keys - %i(data errors metadata)
+      raise ArgumentError, "Unexpected keys: #{extra_keys.inpsect}" if extra_keys.any?
+
+      self.metadata = args[:metadata] || {}.with_indifferent_access
+      self.errors = parse_errors(args[:errors])
+      args[:data].each do |k,v|
         if respond_to? "#{k}="
           send "#{k}=", self.class.interpret_type(v, api_creds)
         else

data/lib/ncore/base.rb

@@ -11,6 +11,7 @@ module NCore
       include Identity
       include Lifecycle
       include Util
+      include Wait
     end
 
     module ClassMethods

data/lib/ncore/client_cache.rb

@@ -26,7 +26,7 @@ module NCore
         end
 
         if store && req[:method] == :get
-          store.fetch request_cache_key(req.slice(:url, :headers)), cache_opts do
+          store.fetch request_cache_key(**req.slice(:url, :headers)), cache_opts do
             super
           end
         else

data/lib/ncore/exceptions.rb

@@ -15,22 +15,41 @@ module NCore
         class RecordNotFound < Error ; end
         class UnsavedObjectError < Error ; end
 
-        class RecordInvalid < Error
+        class RecordError < Error
           attr_reader :object
 
-          def initialize(object)
+          def initialize(object, msg: nil)
             @object = object
-            cl_name = object.class_name if object.respond_to?(:class_name)
-            cl_name ||= object.class.class_name if object.class.respond_to?(:class_name)
-            cl_name ||= object.name if object.respond_to?(:name)
-            cl_name ||= object.class.name
-            msg = "\#{cl_name} Invalid: \#{object.errors.to_a.join(' ')}"
+            msg ||= "Error on \#{class_name_for(object)}"
             super msg
           end
 
           def errors
             object&.errors
           end
+
+          private
+
+          def class_name_for(object)
+            n   = object.class_name if object.respond_to?(:class_name)
+            n ||= object.class.class_name if object.class.respond_to?(:class_name)
+            n ||= object.name if object.respond_to?(:name)
+            n ||= object.class.name
+          end
+        end
+
+        class RecordInvalid < RecordError
+          def initialize(object)
+            msg = "\#{class_name_for(object)} Invalid: \#{object.errors.to_a.join(' ')}"
+            super object, msg: msg
+          end
+        end
+
+        class WaitTimeout < RecordError
+          def initialize(object)
+            msg = "Timeout waiting for condition on \#{class_name_for(object)}"
+            super object, msg: msg
+          end
         end
 
         class QueryError < Error

data/lib/ncore/singleton_base.rb

@@ -10,6 +10,7 @@ module NCore
       include Identity
       include Lifecycle
       include Util
+      include Wait
     end
 
     module ClassMethods

data/lib/ncore/util.rb

@@ -62,7 +62,15 @@ module NCore
 
 
     def inspect
-      "#<#{self.class}:0x#{'%016x'%self.object_id} id: #{id.inspect}, attribs: #{@attribs.except(:id).inspect}, metadata: #{metadata.inspect}>"
+      base = "#{self.class}:0x#{'%016x'%self.object_id} id: #{id.inspect}"
+      @@inspect_chain ||= []
+      return "#<#{base}, ...>" if @@inspect_chain.include? self
+      begin
+        @@inspect_chain.push self
+        "#<#{base}, attribs: #{@attribs.except(:id).inspect}, metadata: #{metadata.inspect}>"
+      ensure
+        @@inspect_chain.pop
+      end
     end
 
   end

data/lib/ncore/version.rb

@@ -1,3 +1,3 @@
 module NCore
-  VERSION = '3.3.1'
+  VERSION = '3.4.0'
 end

data/lib/ncore/wait.rb

@@ -0,0 +1,27 @@
+module NCore
+  module Wait
+    extend ActiveSupport::Concern
+
+    private
+
+    def wait_for(seconds, &block)
+      return unless seconds
+      seconds = 45 if seconds == true
+      end_by = seconds.seconds.from_now
+      cnt = 0
+      until Time.current > end_by
+        wait = [end_by-Time.current, retry_in(cnt)].min
+        cnt += 1
+        sleep wait
+        reload
+        return true if block.call
+      end
+      raise self.class.module_parent::WaitTimeout, self
+    end
+
+    def retry_in(count)
+      (count**1.7).round + 1
+    end
+
+  end
+end

data/lib/ncore.rb

@@ -16,6 +16,7 @@ require 'pp'
   identity
   lifecycle
   util
+  wait
   base
   singleton_base
 ).each do |f|

data/ncore.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activemodel', '>= 5.2', '< 6.2'
   spec.add_dependency 'excon', '~> 0.32'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ncore
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors:
 - Notioneer Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -48,16 +48,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
@@ -121,6 +121,7 @@ files:
 - lib/ncore/singleton_base.rb
 - lib/ncore/util.rb
 - lib/ncore/version.rb
+- lib/ncore/wait.rb
 - ncore.gemspec
 homepage: https://notioneer.com/
 licenses:
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: NCore - Gem for building REST API clients