bright_serializer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66d2b2229c0eeb734471ecc020e89ed4fb9046790683758688a17b9bf15c4810
-  data.tar.gz: be732a5bc2a0f9ffec0dd41cfdab67ebdd65441c43ee9cf59945d863b29b7f08
+  metadata.gz: 124b91b1e579f871a02ebdc415fc663c3053ea9a45592a3bcf37cae0f3ef6f20
+  data.tar.gz: c59949c767f3391e97e38d332ecaf14a93525ea5971edf260a044af5b66ee513
 SHA512:
-  metadata.gz: 885d120ebade43457feea87a3f325cd4eaefd44070eedf13222a466824e44c0cd2a597161ac95c0bf5187955c201bcba7422f1bb1084851e01cc098f8e32b6e9
-  data.tar.gz: 21b5fa304294af30334c49bb5098e022615ab1c279437ee8d5cfbcbd1cfcab2a02612bebb8c675467eda4b5f9af72f758698557e21daac656fae5dba98283f33
+  metadata.gz: a716280c2dc9064f639f9e67ccf0ab24ae4cf0060293d5d0d77bad889598857cd1aadc75612cc38a8ffe564d57b8e24f97e699d9fa46efdad03964a890b6a856
+  data.tar.gz: 0311226ca9be88fcc43d690486de25195c25cd7ccdf0bad636b0b4707dc50a01a07b7f830071d947f01ee6d4660b04122f9fed601a5113c2ee2e83600b639d53

data/.github/workflows/build.yml

@@ -20,5 +20,4 @@ jobs:
     - name: Specs
       run: bundle exec rake
     - name: Rubocop
-      run: bundle exec rubocop
-
+      run: bundle exec rubocop --parallel

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+* Your contribution
+
+## 0.2.0 (2020-07-17)
+
+* Add RubyGems version badge
+* Handle inherit from a parent serializer
+* Define entity in serializer for grape_swagger (#9)
+
 ## 0.1.1 (2020-07-13)
  
 * Add description in gemspec file

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bright_serializer (0.1.1)
+    bright_serializer (0.2.0)
       oj (~> 3)
 
 GEM

data/README.md

@@ -1,4 +1,5 @@
 [![Actions Status](https://github.com/petalmd/bright_serializer/workflows/Build/badge.svg)](https://github.com/petalmd/bright_serializer/actions?query=workflow%3ABuild)
+[![Gem Version](https://badge.fury.io/rb/bright_serializer.svg)](https://badge.fury.io/rb/bright_serializer)
 
 # BrightSerializer
 
@@ -124,6 +125,27 @@ class AccountSerializer
 end
 ```
 
+### Entity
+
+You can define the entity of your serializer to generate documentation with the option `entity`.
+The feature was build to work with [grape-swagger](https://github.com/ruby-grape/grape-swagger). 
+For more information about defining a model entity see the [Swagger documentation](https://swagger.io/specification/v2/?sbsearch=array%20response#schema-object).
+
+```ruby
+class AccountSerializer
+  include BrightSerializer::Serializer
+  attribute :id, entity: { type: :string, description: 'The id of the account' }
+  attribute :name
+
+  attribute :friends,
+    entity: { 
+      type: :array, items: { ref: 'FriendSerializer' }, description: 'The list the account friends.'
+     } do |object|
+    FriendSerializer.new(object.friends)
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/bright_serializer/attribute.rb

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
+require_relative 'entity/base'
+
 module BrightSerializer
   class Attribute
-    attr_reader :key, :block, :condition
+    attr_reader :key, :block, :condition, :entity
     attr_accessor :transformed_key
 
-    def initialize(key, condition, &block)
+    def initialize(key, condition, entity, &block)
       @key = key
       @condition = condition
       @block = block
+      @entity = entity ? Entity::Base.new(entity) : nil
     end
 
     def serialize(object, params)

data/lib/bright_serializer/entity/base.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'parser'
+
+module BrightSerializer
+  module Entity
+    class Base
+      DEFAULT_DEFINITION = { type: :undefined }.freeze
+
+      # https://swagger.io/specification/v2/?sbsearch=array%20response#schema-object
+
+      def initialize(definition)
+        @definition = definition
+      end
+
+      def to_h
+        @definition.transform_keys! { |k| Inflector.camel_lower k.to_s }
+        parse_ref!
+        @definition
+      end
+
+      def parse_ref!
+        object = nested_hash(@definition, 'ref')
+        return unless object
+
+        ref_entity_name = Inflector.constantize(object.delete('ref')).entity_name
+        relation = "#/definitions/#{ref_entity_name}"
+        object['$ref'] = relation
+      end
+
+      def nested_hash(obj, key)
+        if obj.respond_to?(:key?) && obj.key?(key)
+          obj
+        elsif obj.respond_to?(:each)
+          r = nil
+          obj.find { |*a| r = nested_hash(a.last, key) }
+          r
+        end
+      end
+    end
+  end
+end

data/lib/bright_serializer/entity/parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BrightSerializer
+  module Entity
+    class Parser
+      attr_reader :model
+      attr_reader :endpoint
+
+      def initialize(model, endpoint)
+        @model = model
+        @endpoint = endpoint
+      end
+
+      def call
+        @model.entity
+      end
+    end
+  end
+end

data/lib/bright_serializer/inflector.rb

@@ -28,5 +28,36 @@ class Inflector
       underscored_word.tr!('_', '-')
       underscored_word
     end
+
+    # File activesupport/lib/active_support/inflector/methods.rb, line 271
+    def constantize(camel_cased_word)
+      names = camel_cased_word.split('::')
+
+      # Trigger a built-in NameError exception including the ill-formed constant in the message.
+      Object.const_get(camel_cased_word) if names.empty?
+
+      # Remove the first blank element in case of '::ClassName' notation.
+      names.shift if names.size > 1 && names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name, false)
+          next candidate unless Object.const_defined?(name)
+
+          # Go down the ancestors to check if it is owned directly. The check
+          # stops when we reach Object or the end of ancestors tree.
+          constant = constant.ancestors.each_with_object(constant) do |ancestor, const|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name, false)
+          end
+
+          # owner is in Object, so raise
+          constant.const_get(name, false)
+        end
+      end
+    end
   end
 end

data/lib/bright_serializer/serializer.rb

@@ -4,6 +4,7 @@ require 'oj'
 require 'set'
 require_relative 'attribute'
 require_relative 'inflector'
+require_relative 'entity/base'
 
 module BrightSerializer
   module Serializer
@@ -31,7 +32,7 @@ module BrightSerializer
     end
 
     def serializable_hash
-      if @object.respond_to?(:size) && !@object.respond_to?(:each_pair)
+      if @object.respond_to?(:each) && !@object.respond_to?(:each_pair)
         @object.map { |o| serialize o }
       else
         serialize(@object)
@@ -49,9 +50,15 @@ module BrightSerializer
     module ClassMethods
       attr_reader :attributes_to_serialize, :transform_method
 
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set(:@attributes_to_serialize, []) unless subclass.attributes_to_serialize
+        subclass.attributes_to_serialize.concat(@attributes_to_serialize)
+      end
+
       def attributes(*attributes, **options, &block)
         attributes.each do |key|
-          attribute = Attribute.new(key, options[:if], &block)
+          attribute = Attribute.new(key, options[:if], options[:entity], &block)
           attribute.transformed_key = run_transform_key(key)
           @attributes_to_serialize << attribute
         end
@@ -74,6 +81,19 @@ module BrightSerializer
           input.to_sym
         end
       end
+
+      def entity
+        {}.tap do |result|
+          @attributes_to_serialize.each do |attribute|
+            entity_value = attribute.entity&.to_h || BrightSerializer::Entity::Base::DEFAULT_DEFINITION
+            result.merge!(attribute.transformed_key => entity_value)
+          end
+        end
+      end
+
+      def entity_name
+        name.split('::').last.downcase
+      end
     end
   end
 end

data/lib/bright_serializer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BrightSerializer
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bright_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -101,6 +101,8 @@ files:
 - bright_serializer.gemspec
 - lib/bright_serializer.rb
 - lib/bright_serializer/attribute.rb
+- lib/bright_serializer/entity/base.rb
+- lib/bright_serializer/entity/parser.rb
 - lib/bright_serializer/inflector.rb
 - lib/bright_serializer/serializer.rb
 - lib/bright_serializer/version.rb