bright_serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 411805a8af30f74b73f325ddbd820914d524a3134d1d5d0b9346eb738e9eda59
+  data.tar.gz: 13f44da90680dc3e4058c9888c3711d7c4adb0933ff827757d3aafd95696fbc1
+SHA512:
+  metadata.gz: d962a5e41755e14504f97a61b32530e7e5e5236e497b884a6fdf23e599b07ad41ab62acb0e9487b7b0fa39882bbe65dbd6df0f99c74a4a15dc10800095fab422
+  data.tar.gz: 9ed35fa977a777408c84a93ff4e917c0a1f12cadd785b5d88906df8d691a3801138c9144c173ce375e5140bdfe785272149839f7f5358cc843eb0b1459c5223c

data/.github/workflows/build.yml

@@ -0,0 +1,24 @@
+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
+

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# IDE files
+.idea/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bright_serializer.gemspec
+gemspec
+
+gem 'oj', require: false
+
+group :test do
+  gem 'faker'
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    bright_serializer (0.1.0)
+      oj (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.4.4)
+    faker (2.9.0)
+      i18n (>= 1.6, < 1.8)
+    i18n (1.7.0)
+      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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      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)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bright_serializer!
+  bundler (~> 2)
+  faker
+  oj
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jean-Francis Bastien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+[![Actions Status](https://github.com/petalmd/bright_serializer/workflows/Build/badge.svg)](https://github.com/petalmd/bright_serializer/actions?query=workflow%3ABuild)
+
+# BrightSerializer
+
+This is a very light and fast gem to serialize object in a Ruby project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bright_serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bright_serializer
+
+## Usage and features
+
+### Basic
+
+Create a class and include `BrightSerializer::Serializer`
+
+```ruby
+class AccountSerializer
+  include BrightSerializer::Serializer
+  attributes :id, :first_name, :last_name
+  
+  # With a block
+  attribute :name do |object|
+    "#{object.first_name} #{object.last_name}"
+  end
+  
+  # With a block shorter
+  attribute :created_at, &:to_s
+end
+
+AccountSerializer.new(Account.first).to_h
+AccountSerializer.new(Account.first).to_json
+```
+
+### Params
+
+You can pass params to your serializer. For example to have more context with the authenticated user.
+
+```ruby
+class AccountSerializer
+  include BrightSerializer::Serializer
+  attributes :id, :first_name, :last_name
+  
+  attribute :friend do |object, params|
+    object.is_friend_with? params[:current_user]
+  end
+end
+
+current_user = Account.find(authenticated_account_id)
+AccountSerializer.new(Account.first, params: { current_user: current_user }).to_json
+```
+
+### Conditional Attributes
+
+Attribute can be remove from serialization by passing a `proc` to the option `if`. If the proc return `true` the attibute 
+ will be serialize. `object` and `params` or accessible. 
+
+```ruby
+class AccountSerializer
+  include BrightSerializer::Serializer
+  attributes :id, :first_name, :last_name
+  
+  attribute :email, if: -> { |object, params| params[:current_user].is_admin? }
+end
+```
+
+### Transform keys
+
+By default, keys or not transformed.
+
+```ruby
+class AccountSerializer
+  include BrightSerializer::Serializer
+  set_key_transform :underscore
+end
+
+set_key_transform :underscore # "first_name" => "first_name"
+set_key_transform :camel # "first_name" => "FirstName"
+set_key_transform :camel_lower # "first_name" => "firstName"
+set_key_transform :dash # "first_name" => "first-name"
+```
+
+### Instance serializer fieldsets
+
+```ruby
+class AccountSerializer
+  include BrightSerializer::Serializer
+  attributes :id, :first_name, :last_name
+end
+
+# Only serialize first_name and last_name
+AccountSerializer.new(Account.first, fields: [:first_name, :last_name]).to_json
+```
+
+### Relations
+
+For now, relations or declared like any other attribute.
+
+```ruby
+class FriendSerializer
+  include BrightSerializer::Serializer
+  attributes :id, :first_name, :last_name
+end
+
+class AccountSerializer
+  include BrightSerializer::Serializer
+  attributes :id, :first_name, :last_name
+  
+  attribute :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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## New release
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/petalmd/bright_serializer. 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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bright_serializer.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bright_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bright_serializer'
+  spec.version       = BrightSerializer::VERSION
+  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.homepage      = 'https://github.com/petalmd/bright_serializer'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/petalmd/bright_serializer'
+    spec.metadata['changelog_uri'] = 'https://github.com/petalmd/bright_serializer/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'oj', '~> 3'
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'faker', '~> 2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/bright_serializer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'bright_serializer/version'
+
+module BrightSerializer
+  require_relative 'bright_serializer/serializer'
+end

data/lib/bright_serializer/attribute.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BrightSerializer
+  class Attribute
+    attr_reader :key, :block, :condition
+    attr_accessor :transformed_key
+
+    def initialize(key, condition, &block)
+      @key = key
+      @condition = condition
+      @block = block
+    end
+
+    def serialize(object, params)
+      return unless object
+
+      value =
+        if @block
+          @block.arity.abs == 1 ? object.instance_eval(&@block) : object.instance_exec(object, params, &@block)
+        elsif object.is_a?(Hash)
+          object[key]
+        else
+          object.send(key)
+        end
+
+      value.respond_to?(:serializable_hash) ? value.serializable_hash : value
+    end
+
+    def condition?(object, params)
+      return true unless @condition
+
+      @condition.call(object, params)
+    end
+  end
+end

data/lib/bright_serializer/inflector.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Inflector
+  CAMEL_REGEX = /(_[a-zA-Z])/.freeze
+  UNDERSCORE_REGEX = /(.)([A-Z])/.freeze
+
+  class << self
+    def camel(term)
+      return term.capitalize! unless term.include?('_')
+
+      term.capitalize!
+      term.gsub!(CAMEL_REGEX) { Regexp.last_match(1).delete('_').upcase! }
+    end
+
+    def camel_lower(term)
+      return term unless term.include?('_')
+
+      term.gsub!(CAMEL_REGEX) { Regexp.last_match(1).delete('_').upcase! }
+    end
+
+    def underscore(camel_cased_word)
+      camel_cased_word.gsub!(UNDERSCORE_REGEX, '\1_\2')
+      camel_cased_word.downcase!
+      camel_cased_word
+    end
+
+    def dash(underscored_word)
+      underscored_word.tr!('_', '-')
+      underscored_word
+    end
+  end
+end

data/lib/bright_serializer/serializer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'oj'
+require 'set'
+require_relative 'attribute'
+require_relative 'inflector'
+
+module BrightSerializer
+  module Serializer
+    SUPPORTED_TRANSFORMATION = %i[camel camel_lower dash underscore].freeze
+    DEFAULT_OJ_OPTIONS = { mode: :compat, time_format: :ruby, use_to_json: true }.freeze
+
+    def self.included(base)
+      base.extend ClassMethods
+      base.instance_variable_set(:@attributes_to_serialize, [])
+    end
+
+    def initialize(object, **options)
+      @object = object
+      @params = options.delete(:params)
+      @fields = Set.new(options.delete(:fields))
+    end
+
+    def serialize(object)
+      self.class.attributes_to_serialize.each_with_object({}) do |attribute, result|
+        next if @fields.any? && !@fields.include?(attribute.key)
+        next unless attribute.condition?(object, @params)
+
+        result[attribute.transformed_key] = attribute.serialize(object, @params)
+      end
+    end
+
+    def serializable_hash
+      if @object.respond_to?(:size) && !@object.respond_to?(:each_pair)
+        @object.map { |o| serialize o }
+      else
+        serialize(@object)
+      end
+    end
+
+    alias to_hash serializable_hash
+
+    def serializable_json(*_args)
+      ::Oj.dump(to_hash, DEFAULT_OJ_OPTIONS)
+    end
+
+    alias to_json serializable_json
+
+    module ClassMethods
+      attr_reader :attributes_to_serialize, :transform_method
+
+      def attributes(*attributes, **options, &block)
+        attributes.each do |key|
+          attribute = Attribute.new(key, options[:if], &block)
+          attribute.transformed_key = run_transform_key(key)
+          @attributes_to_serialize << attribute
+        end
+      end
+
+      alias attribute attributes
+
+      def set_key_transform(transform_name) # rubocop:disable Naming/AccessorMethodName
+        unless SUPPORTED_TRANSFORMATION.include?(transform_name)
+          raise ArgumentError "Invalid transformation: #{SUPPORTED_TRANSFORMATION}"
+        end
+
+        @transform_method = transform_name
+      end
+
+      def run_transform_key(input)
+        if transform_method
+          Inflector.send(@transform_method, input.to_s).to_sym
+        else
+          input.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/bright_serializer/version.rb

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: bright_serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean-Francis Bastien
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'T O D O: Write a longer description or delete this line.'
+email:
+- jfbastien@petalmd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bright_serializer.gemspec
+- lib/bright_serializer.rb
+- lib/bright_serializer/attribute.rb
+- lib/bright_serializer/inflector.rb
+- lib/bright_serializer/serializer.rb
+- lib/bright_serializer/version.rb
+homepage: https://github.com/petalmd/bright_serializer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/petalmd/bright_serializer
+  source_code_uri: https://github.com/petalmd/bright_serializer
+  changelog_uri: https://github.com/petalmd/bright_serializer/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: 'T O D O: Write a short summary, because RubyGems requires one.'
+test_files: []