ncore 3.7.1 → 3.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6562d9f0e6fca58cc5ad061d9461006dc509f92e960a55ed83bd127fd1d503
-  data.tar.gz: f61859177171d285d7442dfdee1a66964b318bb14824b7e409da2e3e27b92e0d
+  metadata.gz: 0b92860b930948dd670a333583cd9e20ce4608929eb0c5f968234fe0cace69d3
+  data.tar.gz: 00e9f32713a037614ff36b322600b95338e23957ed165388c69269a4f9c129df
 SHA512:
-  metadata.gz: 2b702ea0bc616e2aabbd685ac53579759e59176865e562f383aff61682f3cb6defc5aa177ec398a0a9b18229bd8f5a78d5fc5e390f61ce722998e5301bd7dfa1
-  data.tar.gz: e2ab8234b5fc0358ba38f2460065dfe029ee92d59d575dbb7f35c9d5b8edb71aff8d15fb0278a50678401a71bea55705eb12bda756e4c99295430d45ae16cbee
+  metadata.gz: fdaddd93c446f6c57d76d490f742d64683e1218f1c9628b2fb6de984d1fc586911746f9f7ffb126e057ffc5b3d57d896bbea3545d1e99276499743b1b884d95b
+  data.tar.gz: d5af6a87561366c3fc1e92823dd64e281016b8c3b0128edd17998b7ae48879eb590f0b9ca56a6b342baa98784cac7b3aeea8a4418631ae12b0b0f0607ae24eee

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+#### 3.8.1
+
+- Add option to disable some_attr?() definition
+
+#### 3.8.0
+
+- Add has_one association helper
+- Make belongs_to return existing data even when association_key is blank
+- Make reload() public for singleton resources
+- Optimize calling some_attr?() by defining such methods directly.
+  Previously these calls went through method_missing.
+
 #### 3.7.1
 
 - Don't send both mixed and lowercase headers for accept, user-agent

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2023 Notioneer, Inc.
+Copyright (c) 2014-2024 Notioneer, Inc.
 
 MIT License
 

data/lib/ncore/associations.rb

@@ -1,6 +1,89 @@
 module NCore
   module Associations
 
+    # assoc_name       - singular association name
+    # :association_key - key used by the association to reference the parent
+    #                    defaults to `attrib_name+'_id'`
+    # :class_name      - Module::Class of the child association, as a string
+    def has_one(assoc_name, association_key: nil, class_name: nil)
+      assoc_name = assoc_name.to_s
+      parent_key = association_key&.to_s || "#{attrib_name}_id"
+      klass      = class_name || "#{module_name}::#{assoc_name.camelize}"
+
+      # def item({})
+      class_eval <<-A1, __FILE__, __LINE__+1
+        def #{assoc_name}(params={})
+          return nil unless id
+          reload = params.delete :reload
+          cacheable = params.except(:credentials, :request).empty?
+          params = parse_request_params(params).reverse_merge credentials: api_creds
+          params[:#{parent_key}] = id
+          if cacheable
+            # only cache unfiltered, default api call
+            @attribs[:#{assoc_name}] = (!reload && @attribs[:#{assoc_name}]) || #{klass}.first(params)
+          else
+            #{klass}.first(params)
+          end
+        end
+      A1
+
+      # def create_item({})
+      # will always return the object; check .errors? or .valid? to see how it went
+      class_eval <<-C1, __FILE__, __LINE__+1
+        def create_#{assoc_name}(params={})
+          raise UnsavedObjectError unless id
+          params = parse_request_params(params).reverse_merge credentials: api_creds
+          params[:#{parent_key}] = id
+          #{klass}.create(params)
+        end
+      C1
+
+      # def create_item!({})
+      class_eval <<-C2, __FILE__, __LINE__+1
+        def create_#{assoc_name}!(params={})
+          raise UnsavedObjectError unless id
+          params = parse_request_params(params).reverse_merge credentials: api_creds
+          params[:#{parent_key}] = id
+          #{klass}.create!(params)
+        end
+      C2
+
+      # def update_item({})
+      # will always return the object; check .errors? or .valid? to see how it went
+      class_eval <<-U1, __FILE__, __LINE__+1
+        def update_#{assoc_name}(params={})
+          raise UnsavedObjectError unless id
+          #{assoc_name}.update(params)
+        end
+      U1
+
+      # def update_item!({})
+      class_eval <<-U2, __FILE__, __LINE__+1
+        def update_#{assoc_name}!(params={})
+          raise UnsavedObjectError unless id
+          #{assoc_name}.update!(params)
+        end
+      U2
+
+      # def delete_item({})
+      # will always return the object; check .errors? or .valid? to see how it went
+      class_eval <<-D1, __FILE__, __LINE__+1
+        def delete_#{assoc_name}(params={})
+          raise UnsavedObjectError unless id
+          #{assoc_name}.delete(params)
+        end
+      D1
+
+      # def delete_item!({})
+      class_eval <<-D2, __FILE__, __LINE__+1
+        def delete_#{assoc_name}!(params={})
+          raise UnsavedObjectError unless id
+          #{assoc_name}.delete!(params)
+        end
+      D2
+    end
+
+
     # assoc_name       - plural association name
     # :association_key - key used by the association to reference the parent
     #                    defaults to `attrib_name+'_id'`
@@ -111,6 +194,7 @@ module NCore
       D2
     end
 
+
     # assoc_name       - singular association name
     # :association_key - key on this resource used to reference the parent association
     #                    defaults to `assoc_name+'_id'`
@@ -125,12 +209,14 @@ module NCore
       class_eval <<-P1, __FILE__, __LINE__+1
         attr :#{parent_key}
         def #{assoc_name}(params={})
-          return nil unless #{parent_key}
+          reload = params.delete :reload
           params = parse_request_params(params).reverse_merge credentials: api_creds
           if params.except(:credentials, :request).empty?
             # only cache unfiltered, default api call
-            @attribs[:#{assoc_name}] ||= #{klass}.find(#{parent_key}, params)
+            @attribs[:#{assoc_name}] = nil if reload
+            @attribs[:#{assoc_name}] ||= #{parent_key} && #{klass}.find(#{parent_key}, params)
           else
+            return nil unless #{parent_key}
             #{klass}.find(#{parent_key}, params)
           end
         end

data/lib/ncore/attributes.rb

@@ -8,7 +8,10 @@ module NCore
 
 
     module ClassMethods
-      def attr(*attrs)
+      # attr(:name, ...)
+      #   adds: obj.name  => raw json type
+      #         obj.name? => bool
+      def attr(*attrs, predicate: true)
         attrs.each do |attr|
           check_existing_method(attr)
           class_eval <<-AR, __FILE__, __LINE__+1
@@ -16,10 +19,14 @@ module NCore
               self[:#{attr}]
             end
           AR
+          attr_boolean :"#{attr}?" if predicate
         end
       end
 
-      def attr_datetime(*attrs)
+      # attr_datetime(:updated_at, ...)
+      #   adds: obj.updated_at  => Time, or raw json type if not parseable
+      #         obj.updated_at? => bool
+      def attr_datetime(*attrs, predicate: true)
         attrs.each do |attr|
           check_existing_method(attr)
           class_eval <<-AD, __FILE__, __LINE__+1
@@ -36,10 +43,14 @@ module NCore
               self[:#{attr}]
             end
           AD
+          attr_boolean :"#{attr}?" if predicate
         end
       end
 
-      def attr_decimal(*attrs)
+      # attr_decimal(:amount, ...)
+      #   adds: obj.amount  => BigMoney if String, else raw json type
+      #         obj.amount? => bool
+      def attr_decimal(*attrs, predicate: true)
         attrs.each do |attr|
           check_existing_method(attr)
           class_eval <<-AD, __FILE__, __LINE__+1
@@ -52,6 +63,21 @@ module NCore
               end
             end
           AD
+          attr_boolean :"#{attr}?" if predicate
+        end
+      end
+
+      # attr_boolean(:active, :active?, ...)
+      #   adds: obj.active
+      #   adds: obj.active? - in attrs hash, this looks for the key :active, not :active?
+      def attr_boolean(*attrs)
+        attrs.each do |attr|
+          check_existing_method(attr)
+          class_eval <<-AB, __FILE__, __LINE__+1
+            def #{attr}
+              !! self[:#{attr.to_s.sub(/\?$/,'')}]
+            end
+          AB
         end
       end
 

data/lib/ncore/methods/find_single.rb

@@ -19,8 +19,6 @@ module NCore
       'singleton'
     end
 
-    private
-
     def reload(find_params={})
       params = parse_request_params(find_params).reverse_merge credentials: api_creds
       parsed, @api_creds = request(:get, resource_path, params)

data/lib/ncore/version.rb

@@ -1,3 +1,3 @@
 module NCore
-  VERSION = '3.7.1'
+  VERSION = '3.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ncore
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.8.1
 platform: ruby
 authors:
 - Notioneer Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-27 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: NCore - Gem for building REST API clients