ja2r 0.4.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c57261c49614b634002798afb8e910871587b82430fe03fbcb07ede01e00da5
-  data.tar.gz: 6962fea0c94bd87ce6a2b567ebae944ca8b28b560fb4141b9471314dc7526e8a
+  metadata.gz: 85329bfdaab8daf72abc6e3b3abd412a17a7c8bc3fc7a50edee17f1fd0fc11fb
+  data.tar.gz: 3e29a68124549de538bd97a435d81167968274dd575f533cd2da327f88bceda4
 SHA512:
-  metadata.gz: b67fb5528e863a0e9aff8d60b98d8b188d4d243df133df1b726e0fc8f38b65d9c558e1d082469a65285f9fb1be8bc932346b12c669637eecc63233e5b763c373
-  data.tar.gz: 8ec89d361eece21bb856f0849216f9b4a8bdf74a07ee79c5891cf3d499de47708e06860f7eaf116040693edd6aa3223f2113e045da18d6e6d805f7165b17f47a
+  metadata.gz: 95da927b61189a1e50992983ee8cd1ac668fc83fddc22044e3260da815c0d7ede6a0f2813266d0e1a085003a261240c0a243086ee0d844b28ec2598d1e1dfc47
+  data.tar.gz: f730cd5323db36e8f41cf5a19b539a640edce2943d29df34ba053f12c551b779f814b4b77ec99e128a448da6d2f9bbbe9e43500928705c3bf27e2511714a34e4

data/README.md

@@ -1,7 +1,8 @@
 # JA2R
 
 [![Gem Version](https://badge.fury.io/rb/ja2r.svg)](https://badge.fury.io/rb/ja2r)
-[![Build Status](https://travis-ci.org/mkon/ja2r.svg?branch=master)](https://travis-ci.org/mkon/ja2r)
+![](https://github.com/mkon/ja2r/workflows/Test/badge.svg?branch=master)
+[![Depfu](https://badges.depfu.com/badges/c63f1c5b6394bba4eb73d3b1063cc0be/overview.svg)](https://depfu.com/github/mkon/ja2r?project_id=5963)
 
 JASON-API to Ruby Object
 
@@ -41,3 +42,18 @@ JSON
 bart = JA2R.parse(JSON.parse(json))
 bart.sister.name # Lisa
 ```
+
+## Options
+
+You can pass options to `JA2R#parse` as second argument. Currently the only supported options are:
+
+| Name          | Type    | Description                                                                                                            |
+|---------------|---------|------------------------------------------------------------------------------------------------------------------------|
+| safe_traverse | boolean | When setting this option to true, unknown relationships or attributes will return nil instead of raising NoMethodError |
+
+Example:
+
+```ruby
+bart = JA2R.parse(hash, safe_traverse: true)
+bart.uncle&.name # nil
+```

data/lib/ja2r.rb

@@ -3,13 +3,14 @@ require 'active_support/core_ext/hash'
 
 module JA2R
   autoload :Element,       'ja2r/element'
+  autoload :InvalidData,   'ja2r/invalid_data'
   autoload :KlassRegistry, 'ja2r/klass_registry'
   autoload :Parser,        'ja2r/parser'
 
   module_function
 
-  def parse(hash)
-    Parser.new(hash).call
+  def parse(hash, options = {})
+    Parser.new(hash, options).call
   end
 
   def klass_for(hash)

data/lib/ja2r/element.rb

@@ -1,7 +1,8 @@
 module JA2R
   class Element
-    def initialize(origin_data)
+    def initialize(origin_data, options = {})
       @origin_data = origin_data.with_indifferent_access
+      @options = options
       @relationships = origin_data['relationships'] ? convert_relationships(origin_data['relationships']) : {}
     end
 
@@ -42,22 +43,27 @@ module JA2R
       return attributes[symbol] if attributes&.key? symbol
       return relationships[symbol] if relationships&.key? symbol
 
-      super
+      safe_traverse? ? nil : super
     end
 
     def respond_to_missing?(symbol, include_all = false)
       return true if attributes&.key?(symbol)
       return true if relationships&.key?(symbol)
 
-      super
+      safe_traverse? ? true : super
+    end
+
+    def safe_traverse?
+      @options[:safe_traverse]
     end
 
     def convert_relationships(hash)
       hash.each_with_object(ActiveSupport::HashWithIndifferentAccess.new) do |(key, data), memo|
-        memo[key] = if data&.[]('data').is_a?(Array)
-                      data['data'].map { |d| KlassRegistry.instantiate(d) }
-                    elsif data&.[]('data').is_a?(Hash)
-                      KlassRegistry.instantiate(data&.[]('data'))
+        memo[key] = case data&.[]('data')
+                    when Array
+                      data['data'].map { |d| KlassRegistry.instantiate(d, @options) }
+                    when Hash
+                      KlassRegistry.instantiate(data&.[]('data'), @options)
                     end
       end
     end

data/lib/ja2r/invalid_data.rb

@@ -0,0 +1,10 @@
+module JA2R
+  class InvalidData < RuntimeError
+    def initialize(message, data)
+      @data = data
+      super message
+    end
+
+    attr_reader :data
+  end
+end

data/lib/ja2r/klass_registry.rb

@@ -2,10 +2,10 @@ module JA2R
   module KlassRegistry
     extend self
 
-    def instantiate(hash)
+    def instantiate(hash, options)
       return unless hash&.key? 'type'
 
-      lookup(hash['type']).new(hash)
+      lookup(hash['type']).new(hash, options)
     end
 
     def lookup(type)

data/lib/ja2r/parser.rb

@@ -1,12 +1,15 @@
 module JA2R
   class Parser
-    def initialize(hash)
+    def initialize(hash, options = {})
       @hash = hash
+      @options = options
       @object_space = []
     end
 
     def call
       data = parse_data
+      raise InvalidData.new('Hash does not appear to be valid json-api', @hash) unless data
+
       parse_included
       object_space.each do |object|
         assign_relationships object, object_map
@@ -19,28 +22,29 @@ module JA2R
     attr_reader :hash, :object_space
 
     def parse_data
-      if hash&.[]('data').is_a?(Array)
+      case hash&.[]('data')
+      when Array
         parse_list
-      elsif hash&.[]('data').is_a?(Hash)
+      when Hash
         parse_single
       end
     end
 
     def parse_single
-      root = KlassRegistry.instantiate(hash['data'])
+      root = KlassRegistry.instantiate(hash['data'], @options)
       object_space << root
       root
     end
 
     def parse_list
-      root = hash['data'].map { |data| KlassRegistry.instantiate(data) }
+      root = hash['data'].map { |data| KlassRegistry.instantiate(data, @options) }
       object_space.push(*root)
       root
     end
 
     def parse_included
       hash['included']&.map do |data|
-        object_space.push KlassRegistry.instantiate(data)
+        object_space.push KlassRegistry.instantiate(data, @options)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ja2r
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.3
 platform: ruby
 authors:
 - mkon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2021-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: 1.18.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: 1.18.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.32.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +97,7 @@ files:
 - README.md
 - lib/ja2r.rb
 - lib/ja2r/element.rb
+- lib/ja2r/invalid_data.rb
 - lib/ja2r/klass_registry.rb
 - lib/ja2r/parser.rb
 homepage: https://github.com/mkon/ja2r
@@ -111,14 +112,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Simple JSON-API to ruby object conversion