jsonapi-serializable 0.1.3 → 0.2.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -76,22 +82,16 @@ files:
 - lib/jsonapi/serializable.rb
 - lib/jsonapi/serializable/error.rb
 - lib/jsonapi/serializable/error_dsl.rb
-- lib/jsonapi/serializable/fieldset.rb
 - lib/jsonapi/serializable/link.rb
 - lib/jsonapi/serializable/relationship.rb
 - lib/jsonapi/serializable/relationship/dsl.rb
 - lib/jsonapi/serializable/renderer.rb
 - lib/jsonapi/serializable/resource.rb
-- lib/jsonapi/serializable/resource/attributes.rb
 - lib/jsonapi/serializable/resource/conditional_fields.rb
-- lib/jsonapi/serializable/resource/id.rb
+- lib/jsonapi/serializable/resource/dsl.rb
 - lib/jsonapi/serializable/resource/key_format.rb
-- lib/jsonapi/serializable/resource/links.rb
-- lib/jsonapi/serializable/resource/meta.rb
-- lib/jsonapi/serializable/resource/relationships.rb
-- lib/jsonapi/serializable/resource/temp_id.rb
-- lib/jsonapi/serializable/resource/temp_id.rb~
-- lib/jsonapi/serializable/resource/type.rb
+- lib/jsonapi/serializable/resource/relationship.rb
+- lib/jsonapi/serializable/resource/relationship/dsl.rb
 - lib/jsonapi/serializable/resource_builder.rb
 homepage: https://github.com/jsonapi-rb/jsonapi-serializable
 licenses:
@@ -113,7 +113,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: Conveniently serialize JSON API resources.

data/lib/jsonapi/serializable/fieldset.rb

@@ -1,7 +0,0 @@
-module JSONAPI
-  module Serializable
-    class FieldSet
-
-    end
-  end
-end

data/lib/jsonapi/serializable/resource/attributes.rb

@@ -1,73 +0,0 @@
-module JSONAPI
-  module Serializable
-    class Resource
-      # Mixin to handle resource attributes.
-      module Attributes
-        def self.prepended(klass)
-          super
-          klass.class_eval do
-            extend DSL
-            class << self
-              attr_accessor :attribute_blocks
-            end
-            self.attribute_blocks = {}
-          end
-        end
-
-        def initialize(*)
-          super
-          @_attributes = {}
-        end
-
-        # @see JSONAPI::Serializable::Resource#as_jsonapi
-        def as_jsonapi(fields: nil, include: [])
-          super.tap do |hash|
-            attrs =
-              requested_attributes(fields).each_with_object({}) do |(k, v), h|
-                h[k] = instance_eval(&v)
-              end
-            hash[:attributes] = attrs if attrs.any?
-          end
-        end
-
-        # @api private
-        def requested_attributes(fields)
-          self.class.attribute_blocks
-              .select { |k, _| fields.nil? || fields.include?(k) }
-        end
-
-        # DSL methods for declaring attributes.
-        module DSL
-          def inherited(klass)
-            super
-            klass.attribute_blocks = attribute_blocks.dup
-          end
-
-          # Declare an attribute for this resource.
-          #
-          # @param [Symbol] name The key of the attribute.
-          # @yieldreturn [Hash, String, nil] The block to compute the value.
-          #
-          # @example
-          #   attribute(:name) { @object.name }
-          def attribute(name, _options = {}, &block)
-            block ||= proc { @object.public_send(name) }
-            attribute_blocks[name.to_sym] = block
-          end
-
-          # Declare a list of attributes for this resource.
-          #
-          # @param [Array] *args The attributes keys.
-          #
-          # @example
-          #   attributes :title, :body, :date
-          def attributes(*args)
-            args.each do |attr|
-              attribute(attr)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource/id.rb

@@ -1,48 +0,0 @@
-module JSONAPI
-  module Serializable
-    class Resource
-      # Mixin to handle resource id.
-      module Id
-        def self.prepended(klass)
-          super
-          klass.class_eval do
-            extend DSL
-            class << self
-              attr_accessor :id_block
-            end
-          end
-        end
-
-        def initialize(*)
-          super
-          @_id = instance_eval(&self.class.id_block).to_s
-        end
-
-        # @see JSONAPI::Serializable::Resource#as_jsonapi
-        def as_jsonapi(*)
-          super.tap do |hash|
-            hash[:id] = @_id
-          end
-        end
-
-        # DSL methods for declaring the resource id.
-        module DSL
-          def inherited(klass)
-            super
-            klass.id_block = id_block
-          end
-
-          # Declare the JSON API id of this resource.
-          #
-          # @yieldreturn [String] The id of the resource.
-          #
-          # @example
-          #   id { @user.id.to_s }
-          def id(&block)
-            self.id_block = block
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource/links.rb

@@ -1,67 +0,0 @@
-require 'jsonapi/serializable/link'
-
-module JSONAPI
-  module Serializable
-    class Resource
-      # Mixin for handling resource links.
-      module Links
-        def self.prepended(klass)
-          super
-          klass.class_eval do
-            extend DSL
-            class << self
-              attr_accessor :link_blocks
-            end
-            self.link_blocks = {}
-          end
-        end
-
-        def initialize(*)
-          super
-          @_links = self.class.link_blocks.each_with_object({}) do |(k, v), h|
-            h[k] = Link.as_jsonapi(@_exposures, &v)
-          end
-        end
-
-        # @see JSONAPI::Serializable::Resource#as_jsonapi
-        def as_jsonapi(*)
-          super.tap do |hash|
-            hash[:links] = @_links if @_links.any?
-          end
-        end
-
-        # DSL methods for declaring resource links.
-        module DSL
-          def inherited(klass)
-            super
-            klass.link_blocks = link_blocks.dup
-          end
-
-          # Declare a link for this resource. The properties of the link are set
-          #   by providing a block in which the DSL methods of
-          #   +JSONAPI::Serializable::Link+ are called, or the value of the link
-          #   is returned directly.
-          # @see JSONAPI::Serialiable::Link
-          #
-          # @param [Symbol] name The key of the link.
-          # @yieldreturn [Hash, String, nil] The block to compute the value, if
-          #   any.
-          #
-          # @example
-          #   link(:self) do
-          #     "http://api.example.com/users/#{@user.id}"
-          #   end
-          #
-          # @example
-          #    link(:self) do
-          #      href "http://api.example.com/users/#{@user.id}"
-          #      meta is_self: true
-          #    end
-          def link(name, &block)
-            link_blocks[name] = block
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource/meta.rb

@@ -1,62 +0,0 @@
-module JSONAPI
-  module Serializable
-    class Resource
-      # Mixin for handling resource meta.
-      module Meta
-        def self.prepended(klass)
-          super
-          klass.class_eval do
-            extend DSL
-            class << self
-              attr_accessor :meta_val, :meta_block
-            end
-          end
-        end
-
-        def initialize(*)
-          super
-          @_meta = if self.class.meta_block
-                     instance_eval(&self.class.meta_block)
-                   else
-                     self.class.meta_val
-                   end
-        end
-
-        # @see JSONAPI::Serializable::Resource#as_jsonapi
-        def as_jsonapi(*)
-          super.tap do |hash|
-            hash[:meta] = @_meta unless @_meta.nil?
-          end
-        end
-
-        # DSL methods for declaring resource meta.
-        module DSL
-          def inherited(klass)
-            super
-            klass.meta_val   = meta_val
-            klass.meta_block = meta_block
-          end
-
-          # @overload meta(value)
-          #   Declare the meta information for this resource.
-          #   @param [Hash] value The meta information hash.
-          #
-          #   @example
-          #     meta key: value
-          #
-          # @overload meta(&block)
-          #   Declare the meta information for this resource.
-          #   @yieldreturn [String] The meta information hash.
-          #   @example
-          #     meta do
-          #       { key: value }
-          #     end
-          def meta(value = nil, &block)
-            self.meta_val = value
-            self.meta_block = block
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource/relationships.rb

@@ -1,95 +0,0 @@
-require 'jsonapi/serializable/relationship'
-
-module JSONAPI
-  module Serializable
-    class Resource
-      # Mixin to handle resource relationships.
-      module Relationships
-        def self.prepended(klass)
-          super
-          klass.class_eval do
-            extend DSL
-            class << self
-              attr_accessor :relationship_blocks
-            end
-            self.relationship_blocks = {}
-          end
-        end
-
-        def initialize(*)
-          super
-          @_relationships = self.class.relationship_blocks
-                                .each_with_object({}) do |(k, v), h|
-            h[k] = Relationship.new(@_exposures, &v)
-          end
-        end
-
-        # @see JSONAPI::Serializable::Resource#as_jsonapi
-        def as_jsonapi(fields: nil, include: [])
-          super.tap do |hash|
-            rels = requested_relationships(fields)
-                   .each_with_object({}) do |(k, v), h|
-              h[k] = v.as_jsonapi(include.include?(k))
-            end
-            hash[:relationships] = rels if rels.any?
-          end
-        end
-
-        # @api private
-        def requested_relationships(fields)
-          @_relationships
-            .select { |k, _| fields.nil? || fields.include?(k) }
-        end
-
-        # DSL methods for declaring relationships.
-        module DSL
-          def inherited(klass)
-            super
-            klass.relationship_blocks = relationship_blocks.dup
-          end
-
-          # Declare a relationship for this resource. The properties of the
-          #   relationship are set by providing a block in which the DSL methods
-          #   of +JSONAPI::Serializable::Relationship+ are called.
-          # @see JSONAPI::Serializable::Relationship
-          #
-          # @param [Symbol] name The key of the relationship.
-          #
-          # @example
-          #   relationship :posts do
-          #     resources { @user.posts.map { |p| PostResource.new(post: p) } }
-          #   end
-          #
-          # @example
-          #   relationship :author do
-          #     resources do
-          #       @post.author && UserResource.new(user: @post.author)
-          #     end
-          #     data do
-          #       { type: 'users', id: @post.author_id }
-          #     end
-          #     link(:self) do
-          #       "http://api.example.com/posts/#{@post.id}/relationships/author"
-          #     end
-          #     link(:related) do
-          #       "http://api.example.com/posts/#{@post.id}/author"
-          #     end
-          #     meta do
-          #       { author_online: @post.author.online? }
-          #     end
-          #   end
-          def relationship(name, options = {}, &block)
-            rel_block = proc do
-              data(options[:class]) { @object.public_send(name) }
-              instance_eval(&block) unless block.nil?
-            end
-            relationship_blocks[name.to_sym] = rel_block
-          end
-          alias has_many   relationship
-          alias has_one    relationship
-          alias belongs_to relationship
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource/temp_id.rb

@@ -1,13 +0,0 @@
-module JSONAPI
-  module Serializable
-    class Resource
-      module TempId
-        def as_jsonapi(*)
-          super.tap do |hash|
-            hash[:'temp-id'] = @object.temp_id if @object.respond_to?(:temp_id)
-          end
-        end
-      end
-    end
-  end
-end