encore 0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 663990f322867daf2d604b90b17d6f041c5efc38
-  data.tar.gz: ea1a8ac943113bad1c8f1d8134221277ce869b77
+  metadata.gz: 67ae9330944ea710370dd8ea1032b1a7b47267dd
+  data.tar.gz: 5a6156f14a3d3c1d753b6d5e9ce31ca8a365b6e3
 SHA512:
-  metadata.gz: 3ec3e4388cc983e2de0d9c418998d9840db145c4bd89103a087272a2d4429a7661087849d2d1ded571b7c1d8b43a817f6b7fa830070b9abbb03fc74d6f454ac2
-  data.tar.gz: 69b5beb8f26e43a18fead232548f9681a292e49887eb36882a0a2d018b716d8ce59126fb9155313c152f80c01c2af91484b1ee0e6538ee8db2708d4f08da985c
+  metadata.gz: e4c6e0c8c5e7868808950430b841eee3a5bf6390491eadd41d96910399a01aed48d8436bec65871da3bcf10481b6440ab4d18daffdcb98071b07a045da9b2344
+  data.tar.gz: d4a85a515aec1882439173b62004239fe8e0adcfafde0f0bde7d49b801f813839f9f469f52987c40e11cee1d87a6691074b63f443f227efb249a1b1d06a9759c

data/README.md

@@ -45,9 +45,7 @@ class PostSerializer < Encore::Serializer::Base
   # By default, root_key will be the pluralized model
   # name. If you want to set a custom root_key, you can
   # do that:
-  def self.root_key
-    :blog_posts
-  end
+  root_key :blog_posts
 end
 ```
 
@@ -118,9 +116,7 @@ Since we don’t want all associations to be exposed, we also need to allow the
 class PostSerializer < Encore::Serializer::Base
   # ...
 
-  def self.can_include
-    [:author, :comments]
-  end
+  can_include :author, :comments
 end
 ```
 
@@ -167,9 +163,7 @@ If you want the `comments` to **always** be included when you request a `post`,
 class PostSerializer < Encore::Serializer::Base
   # ...
 
-  def self.always_include
-    [:comments]
-  end
+  always_include :comments
 end
 ```
 

data/lib/encore/serializer/base.rb

@@ -23,27 +23,47 @@ module Encore
       end
 
       # Specify which resources the API can be included in the "linked" top-level key.
-      def self.can_include
-        []
+      def self.can_include(*value)
+        if value.any?
+          @can_include = value.flatten
+        else
+          @can_include ||= []
+        end
       end
 
       # Specify which resources the API always include in the "linked" top-level key.
-      def self.always_include
-        []
+      def self.always_include(*value)
+        if value.any?
+          @always_include = value.flatten
+        else
+          @always_include ||= []
+        end
       end
 
       # Specify which resources the API exposes URL to.
       # Default is can_include + always_include.
-      def self.can_access
-        can_include | always_include
+      def self.can_access(*value)
+        if value.any?
+          @can_access = value.flatten
+        else
+          @can_access ||= can_include | always_include
+        end
       end
 
-      def self.root_key
-        model_class.name.pluralize.underscore.to_sym
+      def self.root_key(value = nil)
+        if value
+          @root_key = value
+        else
+          @root_key ||= model_class.name.pluralize.underscore.to_sym
+        end
       end
 
-      def self.key_mappings
-        {}
+      def self.key_mappings(value = nil)
+        if value
+          @key_mappings = value
+        else
+          @key_mappings ||= {}
+        end
       end
     end
   end

data/lib/encore/serializer/linked_resource_manager.rb

@@ -8,7 +8,6 @@ module Encore
       def self.add(linked_ids, object)
         included_models = linked_ids.keys.map { |key| key.downcase }
         included_models << object.klass.name.downcase
-        included_models << object.klass.name.downcase.pluralize
 
         linked_ids.reduce({}) do |memo, (model, ids)|
           klass = model.constantize

data/lib/encore/version.rb

@@ -1,3 +1,3 @@
 module Encore
-  VERSION = '0.2'
+  VERSION = '0.2.1'
 end

data/spec/encore/persister/key_mappings_spec.rb

@@ -22,9 +22,7 @@ describe Encore::Persister do
         :name
       end
 
-      def key_mappings
-        { snake_case_key: :name }
-      end
+      key_mappings snake_case_key: :name
     end
   end
 

data/spec/encore/serializer/linked/always_include_resources_spec.rb

@@ -58,9 +58,7 @@ describe Encore::Serializer do
       spawn_serializer('UserSerializer') do
         attributes :name
 
-        def always_include
-          %i(project)
-        end
+        always_include :project
       end
     end
 
@@ -74,9 +72,7 @@ describe Encore::Serializer do
       spawn_serializer('UserSerializer') do
         attributes :name
 
-        def always_include
-          %i(project)
-        end
+        always_include :project
       end
     end
 

data/spec/encore/serializer/linked/can_include_resources_spec.rb

@@ -58,9 +58,7 @@ describe Encore::Serializer do
       spawn_serializer('UserSerializer') do
         attributes :name
 
-        def can_include
-          %i(project)
-        end
+        can_include :project
       end
     end
 

data/spec/encore/serializer/linked/linked_resources_spec.rb

@@ -26,16 +26,12 @@ describe Encore::Serializer do
     spawn_serializer('ProjectSerializer') do
       attributes :name
 
-      def can_include
-        %i(user users)
-      end
+      can_include :user, :users
     end
     spawn_serializer('UserSerializer') do
       attributes :name
 
-      def can_include
-        %i(project)
-      end
+      can_include :project
     end
   end
 

data/spec/encore/serializer/linked/links_includes/links_includes_has_many_spec.rb

@@ -33,23 +33,17 @@ describe Encore::Serializer do
     spawn_serializer('ProjectSerializer') do
       attributes :name
 
-      def can_include
-        %i(organization user users)
-      end
+      can_include :organization, :user, :users
     end
     spawn_serializer('UserSerializer') do
       attributes :name
 
-      def can_include
-        %i(project)
-      end
+      can_include :project
     end
     spawn_serializer('OrganizationSerializer') do
       attributes :name
 
-      def can_include
-        %i(projects)
-      end
+      can_include :projects
     end
   end
 
@@ -77,8 +71,8 @@ describe Encore::Serializer do
   end
 
   context 'already included resource' do
-    it { expect(serialized[:linked][:projects][0][:links][:users]).to eq([user1.id.to_s]) }
-    it { expect(serialized[:linked][:projects][1][:links][:users]).to eq([user2.id.to_s]) }
+    it { expect(serialized[:linked][:projects][0][:links][:users]).to eq({ href: '/users?project_id=1', type: 'users' }) }
+    it { expect(serialized[:linked][:projects][1][:links][:users]).to eq({ href: '/users?project_id=2', type: 'users' }) }
   end
 
   context 'not included resource' do

data/spec/encore/serializer/linked/links_includes/links_includes_has_one_spec.rb

@@ -33,23 +33,17 @@ describe Encore::Serializer do
     spawn_serializer('ProjectSerializer') do
       attributes :name
 
-      def can_include
-        %i(organization user users)
-      end
+      can_include :organization, :user, :users
     end
     spawn_serializer('UserSerializer') do
       attributes :name
 
-      def can_include
-        %i(project)
-      end
+      can_include :project
     end
     spawn_serializer('OrganizationSerializer') do
       attributes :name
 
-      def can_include
-        %i(projects)
-      end
+      can_include :projects
     end
   end
 

data/spec/encore/serializer/links_resource_spec.rb

@@ -34,9 +34,7 @@ describe Encore::Serializer do
         spawn_serializer('UserSerializer') do
           attributes :name, :links
 
-          def can_include
-            %i(project)
-          end
+          can_include :project
         end
         spawn_model('Project') do
           has_many :users
@@ -64,9 +62,7 @@ describe Encore::Serializer do
         spawn_serializer('UserSerializer') do
           attributes :name, :links
 
-          def can_include
-            %i(project)
-          end
+          can_include :project
         end
         spawn_model('Project') do
           has_many :users
@@ -94,13 +90,9 @@ describe Encore::Serializer do
         spawn_serializer('UserSerializer') do
           attributes :name, :links
 
-          def can_include
-            %i(project)
-          end
+          can_include :project
 
-          def can_access
-            []
-          end
+          can_access []
         end
         spawn_model('Project') do
           has_many :users
@@ -128,13 +120,9 @@ describe Encore::Serializer do
         spawn_serializer('UserSerializer') do
           attributes :name, :links
 
-          def can_include
-            %i(project)
-          end
+          can_include :project
 
-          def can_access
-            []
-          end
+          can_access []
         end
         spawn_model('Project') do
           has_many :users
@@ -162,9 +150,7 @@ describe Encore::Serializer do
       spawn_serializer('UserSerializer') do
         attributes :name, :links
 
-        def can_include
-          %i(project)
-        end
+        can_include :project
       end
       spawn_model('Project') do
         has_many :users
@@ -208,9 +194,7 @@ describe Encore::Serializer do
       spawn_serializer('UserSerializer') do
         attributes :name, :links
 
-        def can_include
-          %i(projects)
-        end
+        can_include :projects
       end
       spawn_model('Project') do
         belongs_to :user
@@ -255,9 +239,7 @@ describe Encore::Serializer do
       spawn_serializer('UserSerializer') do
         attributes :name, :links
 
-        def can_include
-          %i(project)
-        end
+        can_include :project
       end
       spawn_model('Project')
       spawn_serializer('ProjectSerializer') do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: encore
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel