jsonapi-serializable 0.1.1.beta4 → 0.1.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializable
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta4
+  version: 0.1.1
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-renderer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta3
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1.beta3
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: Powerful DSL for building resource classes - efficient and flexible rendering.
 email: lucas.hosseini@gmail.com
 executables: []
@@ -60,18 +74,24 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/jsonapi/serializable.rb
-- lib/jsonapi/serializable/abstract_resource.rb
-- lib/jsonapi/serializable/abstract_resource_dsl.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/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/key_transform.rb
+- lib/jsonapi/serializable/resource/links.rb
+- lib/jsonapi/serializable/resource/meta.rb
+- lib/jsonapi/serializable/resource/relationships.rb
+- lib/jsonapi/serializable/resource/type.rb
 - lib/jsonapi/serializable/resource_builder.rb
-- lib/jsonapi/serializable/resource_dsl.rb
-homepage: https://github.com/jsonapi-rb/serializable
+homepage: https://github.com/jsonapi-rb/jsonapi-serializable
 licenses:
 - MIT
 metadata: {}
@@ -86,12 +106,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Conveniently serialize JSON API resources.

data/lib/jsonapi/serializable/abstract_resource.rb

@@ -1,122 +0,0 @@
-require 'jsonapi/serializable/link'
-require 'jsonapi/serializable/relationship'
-require 'jsonapi/serializable/abstract_resource_dsl'
-
-module JSONAPI
-  module Serializable
-    class AbstractResource
-      include AbstractResourceDSL
-
-      class << self
-        attr_accessor :id_block,
-                      :type_val, :type_block,
-                      :meta_val, :meta_block,
-                      :attribute_blocks,
-                      :relationship_blocks,
-                      :link_blocks
-      end
-
-      self.attribute_blocks    = {}
-      self.relationship_blocks = {}
-      self.link_blocks         = {}
-
-      def self.inherited(klass)
-        super
-        klass.type_val            = type_val
-        klass.type_block          = type_block
-        klass.id_block            = id_block
-        klass.meta_val            = meta_val
-        klass.meta_block          = meta_block
-        klass.attribute_blocks    = attribute_blocks.dup
-        klass.relationship_blocks = relationship_blocks.dup
-        klass.link_blocks         = link_blocks.dup
-      end
-
-      def initialize(exposures = {})
-        exposures.each { |k, v| instance_variable_set("@#{k}", v) }
-        @_exposures     = exposures
-        @_type          = _type
-        @_id            = _id
-        @_attributes    = {}
-        @_relationships = _relationships
-        @_meta          = _meta
-        @_links         = _links
-      end
-
-      def as_jsonapi(fields: nil, include: [])
-        {}.tap do |hash|
-          hash[:id]    = @_id
-          hash[:type]  = @_type
-          hash[:links] = @_links if @_links.any?
-          hash[:meta]  = @_meta  unless @_meta.nil?
-
-          attrs = requested_attributes(fields)
-          hash[:attributes] = attrs if attrs.any?
-
-          rels = requested_relationships(fields, include)
-          hash[:relationships] = rels if rels.any?
-        end
-      end
-
-      def jsonapi_type
-        @_type
-      end
-
-      def jsonapi_id
-        @_id
-      end
-
-      def jsonapi_related(include)
-        @_relationships
-          .select { |k, _| include.include?(k) }
-          .each_with_object({}) { |(k, v), h| h[k] = v.related_resources }
-      end
-
-      private
-
-      def _type
-        self.class.type_val || instance_eval(&self.class.type_block)
-      end
-
-      def _id
-        instance_eval(&self.class.id_block)
-      end
-
-      def _relationships
-        self.class.relationship_blocks
-            .each_with_object({}) do |(k, v), h|
-          h[k] = Relationship.new(@_exposures, &v)
-        end
-      end
-
-      def _meta
-        if self.class.meta_block
-          instance_eval(&self.class.meta_block)
-        else
-          self.class.meta_val
-        end
-      end
-
-      def _links
-        self.class.link_blocks
-            .each_with_object({}) do |(k, v), h|
-          h[k] = Link.as_jsonapi(@_exposures, &v)
-        end
-      end
-
-      def requested_attributes(fields)
-        self.class.attribute_blocks
-            .select { |k, _| fields.nil? || fields.include?(k) }
-            .each_with_object({}) { |(k, v), h| h[k] = instance_eval(&v) }
-      end
-
-      def requested_relationships(fields, include)
-        @_relationships
-          .select { |k, _| fields.nil? || fields.include?(k) }
-          .each_with_object({}) do |(k, v), h|
-          h[k] = v.as_jsonapi(include.include?(k))
-        end
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/abstract_resource_dsl.rb

@@ -1,130 +0,0 @@
-module JSONAPI
-  module Serializable
-    module AbstractResourceDSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        # @overload type(value)
-        #   Declare the JSON API type of this resource.
-        #   @param [String] value The value of the type.
-        #
-        #   @example
-        #     type 'users'
-        #
-        # @overload type(value)
-        #   Declare the JSON API type of this resource.
-        #   @yieldreturn [String] The value of the type.
-        #
-        #   @example
-        #     type { @user.admin? ? "admin" : "users" }
-        def type(value = nil, &block)
-          self.type_val = value
-          self.type_block = 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
-
-        # @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
-
-        # 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) { @user.name }
-        def attribute(name, &block)
-          attribute_blocks[name] = block
-        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
-        #     data { @user.posts.map { |p| PostResource.new(post: p) } }
-        #   end
-        #
-        # @example
-        #   relationship :author do
-        #     data do
-        #       @post.author && UserResource.new(user: @post.author)
-        #     end
-        #     linkage_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, &block)
-          relationship_blocks[name] = block
-        end
-        alias has_many   relationship
-        alias has_one    relationship
-        alias belongs_to relationship
-
-        # 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

data/lib/jsonapi/serializable/relationship_dsl.rb

@@ -1,109 +0,0 @@
-require 'jsonapi/serializable/resource_builder'
-
-module JSONAPI
-  module Serializable
-    module RelationshipDSL
-      # Declare the related resources for this relationship.
-      # @param [String,Constant,Hash{Symbol=>String,Constant}] resource_class
-      # @yieldreturn The related resources for this relationship.
-      #   If it is nil, an object implementing the Serializable::Resource
-      #   interface, an empty array, or an array of objects implementing the
-      #   Serializable::Resource interface, then it is used as is.
-      #   Otherwise an appropriate Serializable::Resource subclass is inferred
-      #   from the object(s)' namespace/class, the resource_class parameter if
-      #   provided, and the @_resource_inferer.
-      #
-      # @example
-      #   resources do
-      #     @user.posts.map { |p| PostResource.new(post: p) }
-      #   end
-      #
-      # @example
-      #   resources do
-      #     @post.author && UserResource.new(user: @user.author)
-      #   end
-      #
-      # @example
-      #   resources do
-      #     @user.posts
-      #   end
-      # end
-      #
-      # @example
-      #   resources SerializablePost do
-      #     @user.posts
-      #   end
-      #
-      # @example
-      #   resources "SerializableUser" do
-      #     @post.author
-      #   end
-      def resources(resource_class = nil)
-        # NOTE(beauby): Lazify computation since it is only needed when
-        #   the corresponding relationship is included.
-        @_resources_block = proc do
-          _resources_for(yield, resource_class)
-        end
-      end
-
-      # Explicitly declare linkage data.
-      # @yieldreturn The resource linkage.
-      def data(&block)
-        # NOTE(beauby): Lazify computation since it is only executed when
-        #   the corresponding relationship is included (or no links and
-        #   no meta was specified).
-        @_linkage_block = block
-      end
-
-      # @overload meta(value)
-      #   Declare the meta information for this relationship.
-      #   @param [Hash] value The meta information hash.
-      #
-      #   @example
-      #     meta paginated: true
-      #
-      # @overload meta(&block)
-      #   Declare the meta information for this relationship.
-      #   @yieldreturn [Hash] The meta information hash.
-      #
-      #   @example
-      #     meta do
-      #       { paginated: true }
-      #     end
-      def meta(value = nil)
-        @_meta = value || yield
-      end
-
-      # Declare a link for this relationship. The properties of the link are set
-      #   by providing a block in which the DSL methods of
-      #   +JSONAPI::Serializable::Link+ are called.
-      # @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}/relationships/posts"
-      #   end
-      #
-      # @example
-      #    link(:related) do
-      #      href "http://api.example.com/users/#{@user.id}/posts"
-      #      meta authorization_needed: true
-      #    end
-      def link(name, &block)
-        @_links[name] = Link.as_jsonapi(@_exposures, &block)
-      end
-
-      private
-
-      # @api private
-      def _resources_for(objects, resource_class)
-        resource_class ||= @_resource_inferer
-
-        ResourceBuilder.build(objects, @_exposures, resource_class)
-      end
-    end
-  end
-end

data/lib/jsonapi/serializable/resource_dsl.rb

@@ -1,33 +0,0 @@
-module JSONAPI
-  module Serializable
-    module ResourceDSL
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      module ClassMethods
-        def attribute(attr, &block)
-          block ||= proc { @object.public_send(attr) }
-          super(attr, &block)
-        end
-
-        def attributes(*args)
-          args.each do |attr|
-            attribute(attr)
-          end
-        end
-
-        def relationship(rel, resource_class = nil, &block)
-          rel_block = proc do
-            resources(resource_class) { @object.public_send(rel) }
-            instance_eval(&block) unless block.nil?
-          end
-          super(rel, &rel_block)
-        end
-        alias has_many   relationship
-        alias has_one    relationship
-        alias belongs_to relationship
-      end
-    end
-  end
-end