jsonapi-deserializable 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '00948aee890ce50979d9e79091d3d773c718c81d'
-  data.tar.gz: be1b26548249485868b080a05d232119ac5c7f71
+  metadata.gz: ac770df506999a1b03b79a97722d3697c74e31cb
+  data.tar.gz: 31d3323da426ffc8e9c73bd5241d5335a233a13a
 SHA512:
-  metadata.gz: 1f74445bc44fef0931df10075cf8cdd359c91c8c178c4ba2a59318168094f18b9ca5ca30f131f3a6d401497d41c33cd3c628f79069294dae41cc168f5de2bfa6
-  data.tar.gz: a2bff5fd5dd4442935088c08208f400d0c79fc08363c2b8742df0d70f33f979883b051bacc460d1b3ba2cf9c5d31e622c399cd2bf34051f8dd04bfa1fee129d4
+  metadata.gz: b09ba8b3d06401c0ddaa52546a22ae729bb198713231944bb8a4b71b97179de36c5f929ceaaaf2d16780e2be0e910b6df918423ead4b75ae3fdc6c465bb52522
+  data.tar.gz: 7371a9283581c85d3c155436f622ee24372dfe7019adcc5df30c98fa171c1e52c4f28ad98a4380b064c5817cb7f37fefc08b12cf463b7968e2678f31b44a1e20

data/README.md

@@ -9,6 +9,11 @@ hashes.
 [![codecov](https://codecov.io/gh/jsonapi-rb/jsonapi-deserializable/branch/master/graph/badge.svg)](https://codecov.io/gh/jsonapi-rb/deserializable)
 [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/jsonapi-rb/Lobby)
 
+## Resources
+
+* Chat: [gitter](http://gitter.im/jsonapi-rb)
+* Twitter: [@jsonapirb](http://twitter.com/jsonapirb)
+* Docs: [jsonapi-rb.org](http://jsonapi-rb.org)
 
 ## Usage and documentation
 

data/lib/jsonapi/deserializable/relationship.rb

@@ -1,5 +1,4 @@
 require 'jsonapi/deserializable/relationship/dsl'
-require 'jsonapi/parser/relationship'
 
 module JSONAPI
   module Deserializable
@@ -21,10 +20,10 @@ module JSONAPI
       end
 
       def initialize(payload)
-        Parser::Relationship.parse!(payload)
         @document = payload
         @data = payload['data']
         deserialize!
+
         freeze
       end
 
@@ -45,23 +44,19 @@ module JSONAPI
       end
 
       def deserialize_has_one
+        block = self.class.has_one_block
+        return {} unless block
         id = @data && @data['id']
         type = @data && @data['type']
-        if self.class.has_one_block
-          self.class.has_one_block.call(@document, id, type)
-        else
-          { id: id, type: type }
-        end
+        block.call(@document, id, type)
       end
 
       def deserialize_has_many
+        block = self.class.has_many_block
+        return {} unless block && @data.is_a?(Array)
         ids = @data.map { |ri| ri['id'] }
         types = @data.map { |ri| ri['type'] }
-        if self.class.has_many_block
-          self.class.has_many_block.call(@document, ids, types)
-        else
-          { ids: ids, types: types }
-        end
+        block.call(@document, ids, types)
       end
     end
   end

data/lib/jsonapi/deserializable/relationship/dsl.rb

@@ -2,12 +2,19 @@ module JSONAPI
   module Deserializable
     class Relationship
       module DSL
+        DEFAULT_HAS_ONE_REL_BLOCK = proc do |_val, id, type|
+          { type: type, id: id }
+        end
+        DEFAULT_HAS_MANY_REL_BLOCK = proc do |_val, ids, types|
+          { types: types, ids: ids }
+        end
+
         def has_one(&block)
-          self.has_one_block = block
+          self.has_one_block = block || DEFAULT_HAS_ONE_REL_BLOCK
         end
 
         def has_many(&block)
-          self.has_many_block = block
+          self.has_many_block = block || DEFAULT_HAS_MANY_REL_BLOCK
         end
       end
     end

data/lib/jsonapi/deserializable/resource.rb

@@ -1,6 +1,4 @@
-require 'jsonapi/deserializable/resource/configuration'
 require 'jsonapi/deserializable/resource/dsl'
-require 'jsonapi/parser/resource'
 
 module JSONAPI
   module Deserializable
@@ -10,47 +8,42 @@ module JSONAPI
       class << self
         attr_accessor :type_block, :id_block, :attr_blocks,
                       :has_one_rel_blocks, :has_many_rel_blocks,
-                      :configuration
+                      :default_attr_block, :default_has_one_rel_block,
+                      :default_has_many_rel_block,
+                      :key_formatter
       end
 
-      @class_cache = {}
-
-      self.configuration       = Configuration.new
       self.attr_blocks         = {}
       self.has_one_rel_blocks  = {}
       self.has_many_rel_blocks = {}
+      self.key_formatter       = proc { |k| k }
 
       def self.inherited(klass)
         super
-        klass.configuration       = configuration.dup
         klass.type_block          = type_block
         klass.id_block            = id_block
         klass.attr_blocks         = attr_blocks.dup
         klass.has_one_rel_blocks  = has_one_rel_blocks.dup
         klass.has_many_rel_blocks = has_many_rel_blocks.dup
-      end
-
-      def self.configure
-        yield(configuration)
-      end
-
-      def self.[](name)
-        @class_cache[name] ||= Class.new(self)
+        klass.default_attr_block  = default_attr_block
+        klass.default_has_one_rel_block   = default_has_one_rel_block
+        klass.default_has_many_rel_block  = default_has_many_rel_block
+        klass.key_formatter = key_formatter
       end
 
       def self.call(payload)
         new(payload).to_h
       end
 
-      def initialize(payload)
-        Parser::Resource.parse!(payload)
-        @document = payload
-        @data = @document['data']
+      def initialize(payload, root: '/data')
+        @data = payload || {}
+        @root = root
         @type = @data['type']
         @id   = @data['id']
         @attributes    = @data['attributes'] || {}
         @relationships = @data['relationships'] || {}
         deserialize!
+
         freeze
       end
 
@@ -63,13 +56,9 @@ module JSONAPI
 
       private
 
-      def configuration
-        self.class.configuration
-      end
-
       def register_mappings(keys, path)
         keys.each do |k|
-          @reverse_mapping[k] = path
+          @reverse_mapping[k] = @root + path
         end
       end
 
@@ -81,17 +70,20 @@ module JSONAPI
       end
 
       def deserialize_type
-        block = self.class.type_block || configuration.default_type
+        block = self.class.type_block
+        return {} unless block
+
         hash = block.call(@type)
-        register_mappings(hash.keys, '/data/type')
+        register_mappings(hash.keys, '/type')
         hash
       end
 
       def deserialize_id
-        return {} unless @id
-        block = self.class.id_block || configuration.default_id
-        hash  = block.call(@id)
-        register_mappings(hash.keys, '/data/id')
+        block = self.class.id_block
+        return {} unless @id && block
+
+        hash = block.call(@id)
+        register_mappings(hash.keys, '/id')
         hash
       end
 
@@ -102,12 +94,11 @@ module JSONAPI
       end
 
       def deserialize_attr(key, val)
-        hash = if self.class.attr_blocks.key?(key)
-                 self.class.attr_blocks[key].call(val)
-               else
-                 configuration.default_attribute.call(key, val)
-               end
-        register_mappings(hash.keys, "/data/attributes/#{key}")
+        block = self.class.attr_blocks[key] || self.class.default_attr_block
+        return {} unless block
+
+        hash = block.call(val, self.class.key_formatter.call(key))
+        register_mappings(hash.keys, "/attributes/#{key}")
         hash
       end
 
@@ -118,36 +109,38 @@ module JSONAPI
       end
 
       def deserialize_rel(key, val)
-        hash = if val['data'].is_a?(Array)
-                 deserialize_has_many_rel(key, val)
-               else
-                 deserialize_has_one_rel(key, val)
-               end
-        register_mappings(hash.keys, "/data/relationships/#{key}")
-        hash
+        if val['data'].is_a?(Array)
+          deserialize_has_many_rel(key, val)
+        else
+          deserialize_has_one_rel(key, val)
+        end
       end
 
       # rubocop: disable Metrics/AbcSize
       def deserialize_has_one_rel(key, val)
+        block = self.class.has_one_rel_blocks[key] ||
+                self.class.default_has_one_rel_block
+        return {} unless block
+
         id   = val['data'] && val['data']['id']
         type = val['data'] && val['data']['type']
-        if self.class.has_one_rel_blocks.key?(key)
-          self.class.has_one_rel_blocks[key].call(val, id, type)
-        else
-          configuration.default_has_one.call(key, val, id, type)
-        end
+        hash = block.call(val, id, type, self.class.key_formatter.call(key))
+        register_mappings(hash.keys, "/relationships/#{key}")
+        hash
       end
       # rubocop: enable Metrics/AbcSize
 
       # rubocop: disable Metrics/AbcSize
       def deserialize_has_many_rel(key, val)
+        block = self.class.has_many_rel_blocks[key] ||
+                self.class.default_has_many_rel_block
+        return {} unless block && val['data'].is_a?(Array)
+
         ids   = val['data'].map { |ri| ri['id'] }
         types = val['data'].map { |ri| ri['type'] }
-        if self.class.has_many_rel_blocks.key?(key)
-          self.class.has_many_rel_blocks[key].call(val, ids, types)
-        else
-          configuration.default_has_many.call(key, val, ids, types)
-        end
+        hash = block.call(val, ids, types, self.class.key_formatter.call(key))
+        register_mappings(hash.keys, "/relationships/#{key}")
+        hash
       end
       # rubocop: enable Metrics/AbcSize
     end

data/lib/jsonapi/deserializable/resource/dsl.rb

@@ -2,24 +2,54 @@ module JSONAPI
   module Deserializable
     class Resource
       module DSL
+        DEFAULT_TYPE_BLOCK = proc { |t| { type: t } }
+        DEFAULT_ID_BLOCK   = proc { |i| { id: i } }
+        DEFAULT_ATTR_BLOCK = proc { |v, k| { k.to_sym => v } }
+        DEFAULT_HAS_ONE_BLOCK = proc do |_, i, t, k|
+          { "#{k}_id".to_sym => i, "#{k}_type".to_sym => t }
+        end
+        DEFAULT_HAS_MANY_BLOCK = proc do |_, i, t, k|
+          { "#{k}_ids".to_sym => i, "#{k}_types".to_sym => t }
+        end
+
         def type(&block)
-          self.type_block = block
+          self.type_block = block || DEFAULT_TYPE_BLOCK
         end
 
         def id(&block)
-          self.id_block = block
+          self.id_block = block || DEFAULT_ID_BLOCK
         end
 
         def attribute(key, &block)
-          attr_blocks[key.to_s] = block
+          attr_blocks[key.to_s] = block || DEFAULT_ATTR_BLOCK
+        end
+
+        def attributes(*keys, &block)
+          if keys.empty?
+            self.default_attr_block = block || DEFAULT_ATTR_BLOCK
+          else
+            keys.each { |k| attribute(k, &block) }
+          end
+        end
+
+        def has_one(key = nil, &block)
+          if key
+            has_one_rel_blocks[key.to_s] = block || DEFAULT_HAS_ONE_BLOCK
+          else
+            self.default_has_one_rel_block = block || DEFAULT_HAS_ONE_BLOCK
+          end
         end
 
-        def has_one(key, &block)
-          has_one_rel_blocks[key.to_s] = block
+        def has_many(key = nil, &block)
+          if key
+            has_many_rel_blocks[key.to_s] = block || DEFAULT_HAS_MANY_BLOCK
+          else
+            self.default_has_many_rel_block = block || DEFAULT_HAS_MANY_BLOCK
+          end
         end
 
-        def has_many(key, &block)
-          has_many_rel_blocks[key.to_s] = block
+        def key_format(callable = nil, &block)
+          self.key_formatter = callable || block
         end
       end
     end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-deserializable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: jsonapi-parser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,8 +63,6 @@ files:
 - lib/jsonapi/deserializable/relationship.rb
 - lib/jsonapi/deserializable/relationship/dsl.rb
 - lib/jsonapi/deserializable/resource.rb
-- lib/jsonapi/deserializable/resource/configurable.rb
-- lib/jsonapi/deserializable/resource/configuration.rb
 - lib/jsonapi/deserializable/resource/dsl.rb
 homepage: https://github.com/jsonapi-rb/jsonapi-deserializable
 licenses:
@@ -100,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Deserialize JSON API payloads.

data/lib/jsonapi/deserializable/resource/configurable.rb

@@ -1,17 +0,0 @@
-require 'jsonapi/deserializable/resource/configuration'
-
-module JSONAPI
-  module Deserializable
-    module Configurable
-      def self.included(klass)
-        klass.class_eval do
-          extend ClassMethods
-          include InstanceMethods
-        end
-      end
-      module ClassMethods
-
-      end
-    end
-  end
-end

data/lib/jsonapi/deserializable/resource/configuration.rb

@@ -1,28 +0,0 @@
-module JSONAPI
-  module Deserializable
-    class Resource
-      class Configuration
-        DEFAULT_TYPE_BLOCK = proc { |t| { type: t } }
-        DEFAULT_ID_BLOCK   = proc { |i| { id: i } }
-        DEFAULT_ATTR_BLOCK = proc { |k, v| { k.to_sym => v } }
-        DEFAULT_HAS_ONE_BLOCK = proc do |k, _, i, t|
-          { "#{k}_id".to_sym => i, "#{k}_type".to_sym => t }
-        end
-        DEFAULT_HAS_MANY_BLOCK = proc do |k, _, i, t|
-          { "#{k}_ids".to_sym => i, "#{k}_types".to_sym => t }
-        end
-
-        attr_accessor :default_type, :default_id, :default_attribute,
-                      :default_has_one, :default_has_many
-
-        def initialize
-          self.default_type       = DEFAULT_TYPE_BLOCK
-          self.default_id         = DEFAULT_ID_BLOCK
-          self.default_attribute  = DEFAULT_ATTR_BLOCK
-          self.default_has_one    = DEFAULT_HAS_ONE_BLOCK
-          self.default_has_many   = DEFAULT_HAS_MANY_BLOCK
-        end
-      end
-    end
-  end
-end