bright_serializer 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 411805a8af30f74b73f325ddbd820914d524a3134d1d5d0b9346eb738e9eda59
-  data.tar.gz: 13f44da90680dc3e4058c9888c3711d7c4adb0933ff827757d3aafd95696fbc1
+  metadata.gz: 77aa6c33f823a9f96b4d8a73fac9f7a87cf7892431d6e0f3cd1186b9da9fdf6b
+  data.tar.gz: b9820f01f3cf1d5d86588741b0f7af93521c4b55c5dc7352940b3cb1bebdc3e7
 SHA512:
-  metadata.gz: d962a5e41755e14504f97a61b32530e7e5e5236e497b884a6fdf23e599b07ad41ab62acb0e9487b7b0fa39882bbe65dbd6df0f99c74a4a15dc10800095fab422
-  data.tar.gz: 9ed35fa977a777408c84a93ff4e917c0a1f12cadd785b5d88906df8d691a3801138c9144c173ce375e5140bdfe785272149839f7f5358cc843eb0b1459c5223c
+  metadata.gz: 2093dc003212c566476fb83ebb95cc0e9951e5652d0e4a0e1ee667a110581c09cf48ea6170948d3636792f70fa7c10be8acc5f1ff068d567c51fee81fa87235b
+  data.tar.gz: f1163513f3b3d2085f13165fd9f9f29712a9f2cab7486c8041daa7fb04d6719dc102df7fea428451c14eb7ff8677c7bde0c62f8ba4d64f0cef0262e7604387bd

data/.rubocop.yml

@@ -2,6 +2,9 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
+AllCops:
+  NewCops: enable
+
 Metrics/BlockLength:
   Enabled: false
 

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Change log
+
+## master (unreleased)
+
+* Your contribution
+
+## 0.2.3 (2021-01-04)
+
+* Update dependencies ([v0.2.2...v0.2.3](https://github.com/petalmd/bright_serializer/compare/v0.2.2...v0.2.3))
+
+## 0.2.2 (2020-07-22)
+
+* Run CI build on all supported Ruby versions ([#11](https://github.com/petalmd/bright_serializer/pull/11))
+* Update Rubocop 0.78.0 => 0.88.0 and run auto-correction
+* Deep transform entity keys ([#12](https://github.com/petalmd/bright_serializer/pull/12))
+
+## 0.2.1 (2020-07-21)
+
+* Handle set_key_transform inherited from a parent serializer ([#10](https://github.com/petalmd/bright_serializer/pull/10))
+
+## 0.2.0 (2020-07-17)
+
+* Add RubyGems version badge
+* Handle inherit from a parent serializer
+* Define entity in serializer for grape_swagger ([#9](https://github.com/petalmd/bright_serializer/pull/9))
+
+## 0.1.1 (2020-07-13)
+ 
+* Add description in gemspec file
+* Add content in CHANGELOG.md
+
+## 0.1.0 (2020-07-13)
+
+* First release

data/Gemfile.lock

@@ -1,52 +1,59 @@
 PATH
   remote: .
   specs:
-    bright_serializer (0.1.0)
+    bright_serializer (0.2.3)
       oj (~> 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    concurrent-ruby (1.1.5)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
-    faker (2.9.0)
-      i18n (>= 1.6, < 1.8)
-    i18n (1.7.0)
+    faker (2.15.1)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    oj (3.10.0)
-    parallel (1.19.1)
-    parser (2.7.0.0)
-      ast (~> 2.4.0)
+    oj (3.10.18)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.37.1)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby

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/bright_serializer.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jean-Francis Bastien']
   spec.email         = ['jfbastien@petalmd.com']
 
-  spec.summary       = 'T O D O: Write a short summary, because RubyGems requires one.'
-  spec.description   = 'T O D O: Write a longer description or delete this line.'
+  spec.summary       = 'Light and fast Ruby serializer'
+  spec.description   = 'BrightSerializer is a minimalist implementation serializer for Ruby objects.'
   spec.homepage      = 'https://github.com/petalmd/bright_serializer'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.5'
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|.github)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

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
+        Inflector.deep_transform_keys_in_object!(@definition) { |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,18 @@
+# frozen_string_literal: true
+
+module BrightSerializer
+  module Entity
+    class Parser
+      attr_reader :model, :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,52 @@ 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
+
+    # File active_support/core_ext/hash/keys.rb, line 156
+    def deep_transform_keys_in_object!(object, &block)
+      case object
+      when Hash
+        object.keys.each do |key| # rubocop:disable Style/HashEachMethods
+          value = object.delete(key)
+          object[yield(key)] = deep_transform_keys_in_object!(value, &block)
+        end
+        object
+      when Array
+        object.map! { |e| deep_transform_keys_in_object!(e, &block) }
+      else
+        object
+      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
@@ -11,6 +12,7 @@ module BrightSerializer
     DEFAULT_OJ_OPTIONS = { mode: :compat, time_format: :ruby, use_to_json: true }.freeze
 
     def self.included(base)
+      super
       base.extend ClassMethods
       base.instance_variable_set(:@attributes_to_serialize, [])
     end
@@ -31,7 +33,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 +51,16 @@ 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)
+        subclass.instance_variable_set(:@transform_method, @transform_method) unless subclass.transform_method
+      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 +83,20 @@ 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.0'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bright_serializer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -80,14 +80,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 'T O D O: Write a longer description or delete this line.'
+description: BrightSerializer is a minimalist implementation serializer for Ruby objects.
 email:
 - jfbastien@petalmd.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -101,6 +100,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
@@ -129,5 +130,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: 'T O D O: Write a short summary, because RubyGems requires one.'
+summary: Light and fast Ruby serializer
 test_files: []

data/.github/workflows/build.yml

@@ -1,24 +0,0 @@
-name: Build
-
-on: [push]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.7
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-    - name: Bundle install
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-    - name: Specs
-      run: bundle exec rake
-    - name: Rubocop
-      run: bundle exec rubocop
-