panko_serializer 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f169a6a48bba339628ae84995ec2ee3bf66ef059e941be74a89dbe6ec4e983
-  data.tar.gz: dff287d42fe253ef3647f0555e47be7fea55ecc2cf1025cb6b0e55a734ca7806
+  metadata.gz: da5e3519b69aef1b8ada75ae3a245b6eb760a4168aad14e732288b1deaffdf57
+  data.tar.gz: 55dfcbe193da0e64285ebe006f98ac414b29a3f1270e7ae503986e3281332fc7
 SHA512:
-  metadata.gz: 6e7507ee84bf00be48b9a5e35c9f06aacf083216242925889e2f1f0dfb24d87ba1a3ddbdd77bbf580f3000c5671873344dd32e98eea77f84bf175b4cf7c746be
-  data.tar.gz: 0cb0515ccd98c7f260f81d7e1ecb1f684d70d03609b849fd2141d4a4630946622cbc34a6ae1666f6ca5a226066f959280b08bde5ad81f6c02e7d59cf9da6f466
+  metadata.gz: e49c292a8ffa051e82333f3ec89865c5a50643a150a18a2f0b4755f3a0a0cc3fbfce33bf853a66a3deaed6972f0824d5bf5a52537ff0c1d03c4152fee04659f1
+  data.tar.gz: 7c9084df275f4a096a7f58c95e14304fde32824ae415dc21d1979fab9726884a4d75c2654d060aecebc033751df89a81185a8f044fa887f08812b45d089a5fc7

data/.travis.yml

@@ -2,9 +2,9 @@ sudo: false
 cache: bundler
 language: ruby
 rvm:
-  - 2.5.5
-  - 2.6.3
-  - 2.7.0-preview1
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0-rc2
 
 env:
   global:
@@ -27,3 +27,8 @@ env:
   - "RAILS_VERSION=4.2.0"
   - "RAILS_VERSION=5.2.0"
   - "RAILS_VERSION=6.0.0"
+
+jobs:
+  exclude:
+    - rvm: 2.7.0-rc2
+    - env: RAILS_VERSION=4.2.0

data/docs/associations.md

@@ -13,7 +13,7 @@ class PostSerializer < Panko::Serializer
 end
 ```
 
-# Associations with aliases
+### Associations with aliases
 
 An association key name can be aliased with the `name` option.
 

data/docs/attributes.md

@@ -9,11 +9,11 @@ There are two types of attributes:
 
 ```ruby
 class UserSerializer < Panko::Serializer
- attributes :full_name
- 
- def full_name
-  "#{object.first_name} #{object.last_name}"
- end
+  attributes :full_name
+
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+   end
 end
 ```
 
@@ -32,9 +32,11 @@ The serializer's attribute methods can access the object being serialized as `ob
 
 ```ruby
 class PostSerializer < Panko::Serializer
- def author_name
-  "#{object.author.first_name} #{object.author.last_name}"
- end
+  attributes :author_name
+
+  def author_name
+    "#{object.author.first_name} #{object.author.last_name}"
+  end
 end
 ```
 
@@ -78,9 +80,16 @@ UserSerializer.new(only: [:name]).serialize(User.first)
 UserSerializer.new(except: [:name]).serialize(User.first)
 ```
 
+> **Note** that if you want to user filter on an associations, the `:name`
+> property is not taken into account.
+> If you have a `has_many :state_transitions, name: :history` association
+> defined, the key to use in filters is `:state_transitions`
+> (e.g. `{ except: [:state_statitions] }`)
+
 ## Filters For
 
-Sometimes you find yourself have the same filtering logic in actions in order to solve this duplication, Panko allows you to write the filters in the serializer.
+Sometimes you find yourself have the same filtering logic in actions in order to
+solve this duplication, Panko allows you to write the filters in the serializer.
 
 ```ruby
 class UserSerializer < Panko::Serializer
@@ -122,4 +131,3 @@ class PostSerializer < Panko::Serializer
   aliases created_at: :published_at
 end
 ```
-

data/docs/getting-started.md

@@ -31,6 +31,20 @@ class UserSerializer < Panko::Serializer
 end
 ```
 
+### Serializing an object
+
+And now serialize a single object
+
+```ruby
+# Using Oj serializer
+PostSerializer.new.serialize_to_json(Post.first)
+
+# or, similar to #serializable_hash
+PostSerializer.new.serialize(Post.first).to_json
+```
+
+### Using the serializers in a controller
+
 As you can see, defining serializers is simple and resembles ActiveModelSerializers 0.9,
 To utilize the `UserSerializer` inside a Rails controller and serialize some users, all we need to do is:
 
@@ -44,4 +58,3 @@ end
 ```
 
 And voila, we have endpoint which serialize users using Panko!
-

data/lib/panko/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Panko
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/panko_serializer.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
 
   spec.extensions << "ext/panko_serializer/extconf.rb"
 
-  spec.add_dependency "oj", "~> 3.9.0"
+  spec.add_dependency "oj", "~> 3.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panko_serializer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Yosi Attias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-26 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.0
 description: 
 email:
 - yosy101@gmail.com