lp-serializable 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebe7636f819ea8ef0a8d767c433ea4cf31c4d318faa565805c6fd2cde0eb2935
-  data.tar.gz: a5a79b4a4ecf642bf42dab71f1bb02f776e0a588c4056589509c4a5967846cd0
+  metadata.gz: 89210875f4b075f10a9f32cd2aa6f8835338e6870b474c3e6ac43cb07ef9e032
+  data.tar.gz: dbc7937ef61666166931ca2897feb58c257a194bf216eb602303c32fa6a9fb5c
 SHA512:
-  metadata.gz: 28f964bd06efa651464ce7b8de98583669a27cb2d5e1f26568f5e037e0dbe60b3a0fdac57493b825ad3a0d0a27b14cf86fc39fd734c0c73c227b88fcb616dfb9
-  data.tar.gz: d8efaa562ce377fc1ca186307dbb254c3ee00e1426858fd64bdbadf61e51daab5f19ea76aaff1388a97e58a84483f4b5ad536caeacc48956736835e12c250a3b
+  metadata.gz: bc82ab5cafd065632241e73a015c0e12f01753a201426e5929f10f6f726e6ccc5dad8c3c90523f3cf7a0dcdab6f0353ff8c1f0f66786922cf8196fa7a16cc61a
+  data.tar.gz: edba6bfea1317854dfa1c49ab205fb0296762cfd711276abfb03a89b9d69f81a1858d37369f59c5d840b8b58b212f49710d5a9ca3a354ffa62869dc4ccc4291f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lp-serializable (0.2.2)
+    lp-serializable (0.2.3)
       activesupport (>= 4.2)
       fast_jsonapi (>= 1.3)
 
@@ -52,7 +52,7 @@ GEM
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.8.0)
-    fast_jsonapi (1.3)
+    fast_jsonapi (1.5)
       activesupport (>= 4.2)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -41,7 +41,7 @@ class MoviesController < ApplicationController
   def show
     movie = Movie.find(params[:id])
     movie_hash = serializable(movie)
-    render json: movie
+    render json: movie_hash
   end
 end
 ```
@@ -52,7 +52,13 @@ end
 class MovieSerializer
   include FastJsonapi::ObjectSerializer
 
-  attributes :name, :year
+  attributes :name
+  
+  attribute :year, if: Proc.new { |object| object.year.present? }
+  
+  attribute :last_updated do |object|
+    object.updated_at
+  end
 
   has_many :actors
   belongs_to :owner
@@ -97,7 +103,7 @@ hash = serialize_and_flatten(movie)
     "id": "3",
     "type": "movie",
     "name": "test movie",
-    "year": null,
+    "last_updated": "2019-04-26 18:55:46 UTC",
     "actors": [
         {
             "id": "1",
@@ -157,7 +163,8 @@ Attribute `:actors` will trigger `ActorSerializer` to serialize the actors colle
 Supported options include:
 
 - `:fields` ([Sparse Fieldsets](https://github.com/Netflix/fast_jsonapi#sparse-fieldsets))
-- `:params` ([Params / Conditional Attributes](https://github.com/Netflix/fast_jsonapi#params))
+- `:params` ([Params](https://github.com/Netflix/fast_jsonapi#params))
+- [Conditional Attributes](https://github.com/Netflix/fast_jsonapi#conditional-attributes)
 
 Other options are "supported" but may yeild unexpected results, as Serializable's hash flattening prioritizes deeply nested data structures.
 
@@ -178,7 +185,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lp-serializable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/LaunchPadLab/lp-serializable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -186,4 +193,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Lp::Serializable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lp-serializable/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Lp::Serializable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/LaunchPadLab/lp-serializable/blob/master/CODE_OF_CONDUCT.md).

data/lib/fast_jsonapi/object_serializer.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/object'
 require 'active_support/concern'
 require 'active_support/inflector'
 require 'fast_jsonapi/serialization_core'
+require 'fast_jsonapi/attribute'
 
 module FastJsonapi
   module ObjectSerializer
@@ -149,11 +150,17 @@ module FastJsonapi
 
       def attributes(*attributes_list, &block)
         attributes_list = attributes_list.first if attributes_list.first.class.is_a?(Array)
+        options = attributes_list.last.is_a?(Hash) ? attributes_list.pop : {}
         self.attributes_to_serialize = {} if self.attributes_to_serialize.nil?
+        
         attributes_list.each do |attr_name|
           method_name = attr_name
           key = run_key_transform(method_name)
-          attributes_to_serialize[key] = block || method_name
+          attributes_to_serialize[key] = Attribute.new(
+            key: key,
+            method: block || method_name,
+            options: options
+          )
         end
       end
 

data/lib/fast_jsonapi/serialization_core.rb

@@ -73,12 +73,9 @@ module FastJsonapi
       end
 
       def attributes_hash(record, params = {})
-        attributes_to_serialize.each_with_object({}) do |(key, method), attr_hash|
-          attr_hash[key] = if method.is_a?(Proc)
-            method.arity == 1 ? method.call(record) : method.call(record, params)
-          else
-            record.public_send(method)
-          end
+        attributes = attributes_to_serialize
+        attributes.each_with_object({}) do |(_k, attribute), hash|
+          attribute.serialize(record, params, hash)
         end
       end
 

data/lib/lp/serializable/version.rb

@@ -1,5 +1,5 @@
 module Lp
   module Serializable
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
-end
+end

data/lp-serializable.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["mrjonesbot"]
   spec.email         = ["nate@mrjones.io"]
 
-  spec.summary       = "Serialize with Fast JSON API, flatten like AWS"
+  spec.summary       = "Serialize with Fast JSON API, flatten like AMS"
   spec.description   = "JSON API(jsonapi.org) serializer wrapper methods that work with Rails and can be used to serialize any kind of ruby object with AMS style output."
   spec.homepage      = "https://www.github.com/launchpadlab/lp-serializable"
   spec.license       = "MIT"
@@ -46,4 +46,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency(%q<byebug>, [">= 0"])
 
   spec.add_dependency "fast_jsonapi", '>= 1.3'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lp-serializable
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - mrjonesbot
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -273,5 +273,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Serialize with Fast JSON API, flatten like AWS
+summary: Serialize with Fast JSON API, flatten like AMS
 test_files: []