json_resource 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbada0c6c6821280079957d75f002a39fa338c6566a4daf7cda3650b98fb29fd
-  data.tar.gz: a232cf53b5e86dd6e9df328786c5db0ab150747284e11682d5b51bf426fef46c
+  metadata.gz: f26ed85c08a888e816d5bece3c37bd373c6fb61df4042e80cd0bcb371dbfd23a
+  data.tar.gz: 48bc07b4f66618f635591dc24de3195ca19eb6fb8a2a253b6fe9d32f1de6ac8b
 SHA512:
-  metadata.gz: 1a8a3aae1d4e7b21df4e09cc5d8da6f807219e6fc3841c02ca200d9bce621aa222f5e4caa1ee61b190c6041d2b1269674dcaf9b3453e4d8ccdebf3bc41e3e518
-  data.tar.gz: ab5f72f1a266e1ba3e8ae993d951339c9f63c66a5960e241968931343233ce2bafdcf8667eb58378589e698b628573d0f4b2f9b54d427693667095c574348d5b
+  metadata.gz: c041eb4bf88f877a95f2330ec8d3c066b62621290d3f30a1121216c9eb57d1625282c5d3c0bfc34f23bfe96e345a7cbf43d7f3b5f72c6299a450f6f862983a0c
+  data.tar.gz: dd98b1e2d0e4fd314e848b3b777a31d1c5a33791c4f161e0dc452fdfcb9da0e6d7ed7c5beaf4115598bcdf6b6d12e2669bf6660300c9223b693ad7dafd7f12d7

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.2.0 - 2024-11-06
+
+- Add underscore inflection name
+- Fix has_attributes
+
+## 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
     
@@ -67,9 +68,9 @@ module JsonResource
         attribute_accessor_method name
       end
     
-      def attributes(*args)
+      def has_attributes(*args)
         options = args.extract_options!
-        args.each { |arg| has_attribute arg, options }
+        args.each { |arg| attribute arg, options }
       end
     
       def has_object(name, options = {})
@@ -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
@@ -161,7 +186,7 @@ module JsonResource
           string.camelcase(:upper)
         when :dasherize
           string.underscore.dasherize
-        when nil
+        when nil, :underscore
           string.underscore
         else
           string.public_send(inflection)

data/lib/json_resource/refinements.rb

@@ -202,7 +202,19 @@ module JsonResource
       def symbolize_keys
         transform_keys(&:to_sym)
       end
-      
+
+    end
+
+    refine Array do
+
+      def extract_options!
+        if last.is_a?(Hash) && last.instance_of?(Hash)
+          pop
+        else
+          {}
+        end
+      end
+
     end
 
   end

data/lib/json_resource/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_resource
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthias Grosser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,7 +24,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - mtgrosser@gmx.net
 executables: []
@@ -44,7 +58,7 @@ homepage: https://github.com/mtgrosser/json_resource
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,15 +66,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: Create Ruby objects from JSON data
 test_files: []