restpack_serializer 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 999010d07a5c68b823e2f2c36496dd1a8b2adbcc
-  data.tar.gz: 16eca8065b150b5694aa041564f8598361004544
+  metadata.gz: c62e329e0e5ad1a715c774afa67cf2fa73c9ecbf
+  data.tar.gz: a3a127d3888cf16b3b3561ad01990c1728716b88
 SHA512:
-  metadata.gz: a0be747ac4aa315149718107badbfc1327c2c70fc772679deae2c533ed24442a6be4199249644f1aa35eaaabbe408f053530dbc477a28fa88a3e694379ba1bbd
-  data.tar.gz: b0a43b5d5423e078ce5d521aa8853882f50c7d2d5329ffdc70e21a79bf15aeada5f53fa74299cb3cdefb6a511c5a1233a1428a5a8e3286e73497b3e873aebaf5
+  metadata.gz: fb603fa7f78a4a8349bf64ecebcc4fb02f2cbd3956bd4aff643dd4450409ec98e99714bc12c307972d50def980edaa4c61e2a408a17ba043d3ad363f7d8f3b55
+  data.tar.gz: c9631648c26608e0718b17348402eb46a6b666d165ed4773772ec37b659e9170cae5794c58e675802f2973109e9017cb8393d928fc41a1d43100e8f7493bcc0c

data/README.md

@@ -63,6 +63,8 @@ end
 class AlbumSerializer
   include RestPack::Serializer
   attributes :id, :title, :year, :artist_id, :extras
+  optional :score
+
   can_include :artists, :songs
   can_filter_by :year
 
@@ -78,6 +80,18 @@ end
 AlbumSerializer.as_json(album, { admin?: true })
 ```
 
+All `attributes` are serialized by default. If you'd like to skip an attribute, you can pass an option in the `@context` as follows:
+
+```ruby
+AlbumSerializer.as_json(album, { include_title?: false })
+```
+
+You can also define `optional` attributes which aren't included by default. To include:
+
+```ruby
+AlbumSerializer.as_json(album, { include_score?: true })
+```
+
 ## Exposing an API
 
 The `AlbumSerializer` provides `page` and `resource` methods which provide paged collection and singular resource GET endpoints.
@@ -114,8 +128,7 @@ AlbumSerializer.page(params, Albums.where("year < 1950"), { admin?: true })
 ```
 
 Other features:
- * [Dynamically Include/Exclude Attributes](https://github.com/RestPack/restpack_serializer/blob/master/spec/serializable/serializer_spec.rb#L42)
- * [Custom Attributes Hash](https://github.com/RestPack/restpack_serializer/blob/master/spec/serializable/serializer_spec.rb#L46)
+ * [Custom Attributes Hash](https://github.com/RestPack/restpack_serializer/blob/master/spec/serializable/serializer_spec.rb#L55)
 
 ## Paging
 

data/lib/restpack_serializer/serializable/attributes.rb

@@ -14,6 +14,10 @@ module RestPack::Serializer::Attributes
       attrs.each { |attr| attribute attr }
     end
 
+    def optional(*attrs)
+      attrs.each { |attr| optional_attribute attr }
+    end
+
     def transform(attrs = [], transform_lambda)
       attrs.each { |attr| transform_attribute(attr, transform_lambda) }
     end
@@ -34,23 +38,43 @@ module RestPack::Serializer::Attributes
       define_include_method name
     end
 
+    def optional_attribute(name, options={})
+      add_to_serializable(name, options)
+      define_attribute_method name
+      define_optional_include_method name
+    end
+
     def define_attribute_method(name)
       unless method_defined?(name)
         define_method name do
           value = self.default_href if name == :href
-          value ||= @model.send(name)
+          if @model.is_a?(Hash)
+            value ||= @model[name] || @model[name.to_s]
+          else
+            value ||= @model.send(name)
+          end
           value = value.to_s if name == :id
           value
         end
       end
     end
 
-    def define_include_method(name)
+    def define_optional_include_method(name)
+      define_include_method(name, false)
+    end
+
+    def define_include_method(name, include_by_default=true)
       method = "include_#{name}?".to_sym
 
       unless method_defined?(method)
-        define_method method do
-          @context[method].nil? || @context[method]
+        if include_by_default
+          define_method method do
+            @context[method].nil? || @context[method]
+          end
+        else
+          define_method method do
+            @context[method].present?
+          end
         end
       end
     end

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.5.7'
+    VERSION = '0.5.8'
   end
 end

data/spec/serializable/attributes_spec.rb

@@ -4,6 +4,8 @@ describe RestPack::Serializer::Attributes do
   class CustomSerializer
     include RestPack::Serializer
     attributes :a, :b, :c
+    attributes :d, :e
+    optional :sometimes, :maybe
     attribute :old_attribute, :key => :new_key
     transform [:gonzaga], lambda { |name, model| model.send(name).downcase }
   end
@@ -11,11 +13,11 @@ describe RestPack::Serializer::Attributes do
   subject(:attributes) { CustomSerializer.serializable_attributes }
 
   it "correctly models specified attributes" do
-    expect(attributes.length).to be(5)
+    expect(attributes.length).to be(9)
   end
 
   it "correctly maps normal attributes" do
-    [:a, :b, :c].each do |attr|
+    [:a, :b, :c, :d, :e].each do |attr|
       expect(attributes[attr]).to eq(attr)
     end
   end
@@ -24,6 +26,26 @@ describe RestPack::Serializer::Attributes do
     expect(attributes[:new_key]).to eq(:old_attribute)
   end
 
+  describe "optional attributes" do
+    let(:model) { OpenStruct.new(a: 'A', sometimes: 'SOMETIMES', gonzaga: 'GONZAGA') }
+    let(:context) { {} }
+    subject(:as_json) { CustomSerializer.as_json(model, context) }
+
+    context 'with no includes context' do
+      it "excludes by default" do
+        expect(as_json[:sometimes]).to eq(nil)
+      end
+    end
+
+    context 'with an includes context' do
+      let(:context) { { include_sometimes?: true } }
+
+      it "allows then to be included" do
+        expect(as_json[:sometimes]).to eq('SOMETIMES')
+      end
+    end
+  end
+
   describe '#transform_attributes' do
     let(:model) { OpenStruct.new(gonzaga: 'IS A SCHOOL') }
 
@@ -33,4 +55,15 @@ describe RestPack::Serializer::Attributes do
       expect(as_json[:gonzaga]).to eq('is a school')
     end
   end
+
+  describe "model as a hash" do
+    let(:model) { { a: 'A', 'b' => 'B' } }
+
+    subject(:as_json) { CustomSerializer.as_json(model, include_gonzaga?: false) }
+
+    it 'uses the transform method on the model attribute' do
+      expect(as_json[:a]).to eq('A')
+      expect(as_json[:b]).to eq('B')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport