ncore 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c93d49d552806a8439994a201a54ae1550be771c5ba3e855131317267492efb
-  data.tar.gz: a20b77b20173293816a3a2f753561b3cfc0a962644db0696f4a2f5d7dedf024d
+  metadata.gz: b9823810517052d731b6290cf93b9bd942f25164aed98940860be7c37b7514b5
+  data.tar.gz: 851945716245d8308d5b14a7fc17afb4207ea25f4dff049779ab8e9f2d1a5a3e
 SHA512:
-  metadata.gz: 9ef44487b9cc0def0b5dc9be8f34bac4a13ae3fd1226f5e2d87d1a02cc111d52565a142a92e7619493b9d236eb68837832b9eee62e6fdae86b0bc2c0cf64d44f
-  data.tar.gz: 9337020d9f962ef43852d859981fa2f67a198fd51f6ad3ced23ecbc4aeafea6ff4b67b651abf41e0868ede636490383dd4e7746c2607ed0bf4b4f01c9c03ab0f
+  metadata.gz: 02103dd4eb28433b6311192c37f727e31708a2d5b4ccd2c46888d13a661f6916c906dbd90ad42e03f00592ab6c267fd46d560c69636070a6ee7ddf50c4f4c037
+  data.tar.gz: ee2d1391f5042222d448aebb3ef96f521eb535d3d0e1d23f6bb715bd2cf836f64d6d8a72527d95efd0af05a2881556111000acb5e65082fa8289f605a90ed51d

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+#### 3.9.0
+
+- Add inspection filter for attributes
+- Fix generation of query params when values are Hashes
+
+#### 3.8.1
+
+- Add option to disable some_attr?() definition
+
 #### 3.8.0
 
 - Add has_one association helper

data/lib/ncore/attributes.rb

@@ -11,25 +11,22 @@ module NCore
       # attr(:name, ...)
       #   adds: obj.name  => raw json type
       #         obj.name? => bool
-      def attr(*attrs)
+      def attr(*attrs, predicate: true)
         attrs.each do |attr|
           check_existing_method(attr)
           class_eval <<-AR, __FILE__, __LINE__+1
             def #{attr}
               self[:#{attr}]
             end
-
-            def #{attr}?
-              !! self[:#{attr}]
-            end
           AR
+          attr_boolean :"#{attr}?" if predicate
         end
       end
 
       # attr_datetime(:updated_at, ...)
       #   adds: obj.updated_at  => Time, or raw json type if not parseable
       #         obj.updated_at? => bool
-      def attr_datetime(*attrs)
+      def attr_datetime(*attrs, predicate: true)
         attrs.each do |attr|
           check_existing_method(attr)
           class_eval <<-AD, __FILE__, __LINE__+1
@@ -45,18 +42,15 @@ module NCore
             rescue ArgumentError, TypeError
               self[:#{attr}]
             end
-
-            def #{attr}?
-              !! self[:#{attr}]
-            end
           AD
+          attr_boolean :"#{attr}?" if predicate
         end
       end
 
       # attr_decimal(:amount, ...)
       #   adds: obj.amount  => BigMoney if String, else raw json type
       #         obj.amount? => bool
-      def attr_decimal(*attrs)
+      def attr_decimal(*attrs, predicate: true)
         attrs.each do |attr|
           check_existing_method(attr)
           class_eval <<-AD, __FILE__, __LINE__+1
@@ -68,11 +62,22 @@ module NCore
                 self[:#{attr}]
               end
             end
+          AD
+          attr_boolean :"#{attr}?" if predicate
+        end
+      end
 
-            def #{attr}?
-              !! self[:#{attr}]
+      # 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
-          AD
+          AB
         end
       end
 

data/lib/ncore/base.rb

@@ -1,17 +1,20 @@
 module NCore
   module Base
     extend ActiveSupport::Concern
-    
+
     included do
       extend Associations
       include ActiveModel
       include Attributes
       include Client
       include Client::Cache
+      include FilterAttributes
       include Identity
       include Lifecycle
       include Util
       include Wait
+
+      self.filter_attributes = []
     end
 
     module ClassMethods

data/lib/ncore/client.rb

@@ -88,17 +88,26 @@ module NCore
 
       def build_query_string(params)
         if params.any?
-          query_string = params.sort.map do |k,v|
-            if v.is_a?(Array)
+          query_string = params.sort.filter_map do |k,v|
+            case v
+            when Array
               if v.empty?
-                "#{k.to_s}[]="
+                "#{CGI::escape(k.to_s)}[]"
               else
                 v.sort.map do |v2|
-                  "#{k.to_s}[]=#{CGI::escape(v2.to_s)}"
+                  "#{CGI::escape(k.to_s)}[]=#{CGI::escape(v2.to_s)}"
+                end.join('&')
+              end
+            when Hash
+              if v.empty?
+                nil
+              else
+                v.sort.map do |k2, v2|
+                  "#{CGI::escape(k.to_s)}[#{k2}]=#{CGI::escape(v2.to_s)}"
                 end.join('&')
               end
             else
-              "#{k.to_s}=#{CGI::escape(v.to_s)}"
+              "#{CGI::escape(k.to_s)}=#{CGI::escape(v.to_s)}"
             end
           end.join('&')
           "?#{query_string}"

data/lib/ncore/filter_attributes.rb

@@ -0,0 +1,43 @@
+module NCore
+  module FilterAttributes
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def filter_attributes
+        @filter_attributes || superclass.filter_attributes
+      end
+
+      def filter_attributes=(filter_attributes)
+        @inspection_filter = nil
+        @filter_attributes = filter_attributes
+      end
+
+      def inspection_filter
+        if @filter_attributes
+          @inspection_filter ||= ActiveSupport::ParameterFilter.new @filter_attributes
+        else
+          superclass.inspection_filter
+        end
+      end
+
+    end
+
+
+    def inspect
+      base = "#{self.class}:0x#{'%016x'%self.object_id} id: #{id.inspect}"
+      inspect_chain = Thread.current[:inspect_chain] ||= []
+      return "#<#{base}, ...>" if inspect_chain.include? self
+      begin
+        inspect_chain.push self
+        attribs = @attribs.except(:id).each.with_object({}) do |(k,v),h|
+          h[k] = v.nil? ? nil : self.class.inspection_filter.filter_param(k,v)
+        end
+        "#<#{base}, attribs: #{attribs.inspect}, metadata: #{metadata.inspect}>"
+      ensure
+        inspect_chain.pop
+      end
+    end
+
+  end
+end

data/lib/ncore/singleton_base.rb

@@ -7,10 +7,13 @@ module NCore
       include ActiveModel
       include Attributes
       include Client
+      include FilterAttributes
       include Identity
       include Lifecycle
       include Util
       include Wait
+
+      self.filter_attributes = []
     end
 
     module ClassMethods

data/lib/ncore/util.rb

@@ -63,18 +63,5 @@ module NCore
 
     delegate :factory, to: :class
 
-
-    def 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
 end

data/lib/ncore/version.rb

@@ -1,3 +1,3 @@
 module NCore
-  VERSION = '3.8.0'
+  VERSION = '3.9.0'
 end

data/lib/ncore.rb

@@ -15,6 +15,7 @@ require 'pp'
   exceptions
   identity
   lifecycle
+  filter_attributes
   util
   wait
   base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ncore
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Notioneer Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -101,6 +101,7 @@ files:
 - lib/ncore/collection.rb
 - lib/ncore/configuration.rb
 - lib/ncore/exceptions.rb
+- lib/ncore/filter_attributes.rb
 - lib/ncore/identity.rb
 - lib/ncore/lifecycle.rb
 - lib/ncore/methods/all.rb
@@ -142,7 +143,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