json_resource 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbada0c6c6821280079957d75f002a39fa338c6566a4daf7cda3650b98fb29fd
-  data.tar.gz: a232cf53b5e86dd6e9df328786c5db0ab150747284e11682d5b51bf426fef46c
+  metadata.gz: 9c5d0ad6feca66b6bd7524037d69edf9da40ba45c5f25a6441ef4543d174e5ad
+  data.tar.gz: 6ee0efc65381f5243b3da05ef710dc7a8ea6e296708e2a4224c680b728fb9331
 SHA512:
-  metadata.gz: 1a8a3aae1d4e7b21df4e09cc5d8da6f807219e6fc3841c02ca200d9bce621aa222f5e4caa1ee61b190c6041d2b1269674dcaf9b3453e4d8ccdebf3bc41e3e518
-  data.tar.gz: ab5f72f1a266e1ba3e8ae993d951339c9f63c66a5960e241968931343233ce2bafdcf8667eb58378589e698b628573d0f4b2f9b54d427693667095c574348d5b
+  metadata.gz: f534f05c6e7748186cfb3373c3b55c5891d0c572be08b917f380d4cf49443a60dbdda258a3dda9778edd9b623eb4f4d45cff2c5223423c8ad450cacfde050030
+  data.tar.gz: 0f7703523f9b619ce117fb889fd6f9eba4738a6ceeed9d5e043edc54c1c057f25ba4d788da958b2a7121ddd93a5688787477618f0a247ff294305b804dc89a77

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.0 – 2023-11-01
+
+- Improve BigDecimal conversion
+
 ## 1.0.0
 
 - First release

data/README.md

@@ -62,3 +62,68 @@ posts.first.body => 'Lorem ipsum'
 posts.first.status_text => 'published'
 posts.first.comments.first.author => 'Mr. Spock'
 ```
+
+## Instantiation
+
+To instantiate collections, use `collection_from_json` on a JSON array.
+
+To instantiate single objects, use `from_json` on a JSON hash.
+
+
+## Field types
+
+Attributes can have one of the following types:
+
+| Type        | Conversion          | Options                   |
+| ----------- | ------------------- | ------------------------- |
+| `:string`   | `value`             |                           |
+| `:integer`  | `value.to_i`        |                           |
+| `:float`    | `value.to_f`        |                           |
+| `:boolean`  | any of `[true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON']` | |
+| `:decimal`  | direct, or `to_d`   | `:precision`, `:scale`    |
+| `:date`     | `Date.parse`        |                           |
+| `:time`     | `Time.parse`        |                           |
+
+
+## Extracting data
+
+Sometimes, APIs return data wrapped within arrays of hashes of arrays etc:
+
+```json
+{
+  "data": [
+    {
+      "status": "ok"
+    },
+    {
+      "planets": [
+        {
+          "name": "Earth",
+          "mass": 5.9722E+24,
+          "orbit": 1.000
+        },
+        {
+          "name": "Jupiter",
+          "mass": 1.8990E+27,
+          "orbit": 5.205
+        }
+      ]
+    }
+  ]
+}
+```
+
+```ruby
+class Planet
+  include JsonResource::Model
+  
+  attribute :name, type: :string
+  attribute :mass, type: :decimal, precision: 10, scale: 4
+end
+```
+
+To dig for this data, a call-sequence can be provided as the `root` option.
+
+```ruby
+planets = Planet.collection_from_json(json, root: %w[data [1] planets])
+```

data/lib/json_resource/model.rb

@@ -3,6 +3,7 @@ module JsonResource
 
   module Model
     TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON'].to_set
+    BIGDECIMAL_PRECISION = 18
     
     def self.included(base)
       base.extend ClassMethods
@@ -23,7 +24,7 @@ module JsonResource
           if path = attribute_path(name)
             value = json_dig(json, *path)
             if !value.nil? && type = attribute_type(name)
-              value = cast_to(type, value)
+              value = cast_to(type, value, name)
             end
             attrs[name] = value
           end
@@ -46,7 +47,7 @@ module JsonResource
     
       def collection_from_json(obj, defaults: {}, root: nil)
         json = parse(obj)
-        json = json_dig(json, root) if root
+        json = json_dig(json, *root) if root
         json.map { |hsh| from_json(hsh, defaults: defaults) }.compact
       end
     
@@ -95,16 +96,20 @@ module JsonResource
       end
 
       [:attribute, :object, :collection].each do |method_name|
+        define_method "#{method_name}_options" do |name|
+          send(method_name.to_s.pluralize).try(:[], name)
+        end
+        
         define_method "#{method_name}_path" do |name|
-          options = send(method_name.to_s.pluralize)
-          Array(options[name].try(:[], :path)).presence || [inflect(name)]
+          options = send("#{method_name}_options", name)
+          Array(options.try(:[], :path)).presence || [inflect(name)]
         end
       end
 
       def attribute_type(name)
         attributes[name] && attributes[name][:type]
       end
-    
+      
       def object_class(name)
         if objects[name] && class_name = objects[name][:class_name]
           class_name.constantize
@@ -121,13 +126,13 @@ module JsonResource
         end
       end
     
-      def cast_to(type, value)  # only called for non-nil values
+      def cast_to(type, value, name)  # only called for non-nil values
         case type
         when :string    then value
         when :integer   then value.to_i
         when :float     then value.to_f
         when :boolean   then cast_to_boolean(value)
-        when :decimal   then BigDecimal(value)
+        when :decimal   then cast_to_big_decimal(value, **attribute_options(name))
         when :date      then value.presence && Date.parse(value)
         when :time      then value.presence && Time.parse(value)
         else
@@ -142,6 +147,26 @@ module JsonResource
           TRUE_VALUES.include?(value)
         end
       end
+      
+      def cast_to_big_decimal(value, scale: nil, precision: nil, **)
+        cast_value = case value
+        when ::Float
+          precision ||= BIGDECIMAL_PRECISION
+          float_precision = precision.to_i > ::Float::DIG + 1 ? ::Float::DIG + 1 : precision.to_i
+          BigDecimal(value, float_precision)
+        when ::Numeric
+          BigDecimal(value, precision || BIGDECIMAL_PRECISION)
+        when ::String
+          begin
+            value.to_d
+          rescue ArgumentError
+            BigDecimal(0)
+          end
+        else
+          value.respond_to?(:to_d) ? value.to_d : BigDecimal(value.to_s)
+        end
+        scale ? cast_value.round(scale) : cast_value
+      end
 
       def parse(obj)
         case obj

data/lib/json_resource/version.rb

@@ -1,3 +1,3 @@
 module JsonResource
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_resource
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthias Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="