userializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8542c96c9a4351c5f5938bf260c61f6f97bf0e7a5cf9763325a76c45b70e3741
+  data.tar.gz: fb19b8e8ddab2c52402c5273d129000a10f607d2b0b9d53a7ac3aa56d09bfed7
+SHA512:
+  metadata.gz: 6e9d0f07bf62c25b23c88974bcc536c8ce42500bdfeb4c800d19d63f5d2b630212cd4bc67aabd403b2ec4e1a8364a5847c0fd8564abec5d9feeb4149b4ab9a17
+  data.tar.gz: dca8b690e2fb0095acb779a2849f304b6dac736d50759eb2de2c978db10268b3bdbcb95ad8abc465a72f7505c2e16a8575b83c0696f920c5aaa5a6fa4fac587e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in userializer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    userializer (0.1.0)
+      activesupport
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    oj (3.7.12)
+    rake (10.4.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  userializer!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,33 @@
+# Userializer
+
+Ruby object JSON serializer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'userializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install userializer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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`. 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/AlexisMontagne/userializer.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "userializer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/userializer.rb

@@ -0,0 +1,19 @@
+require 'userializer/version'
+require 'userializer/base_serializer'
+require 'userializer/array_serializer'
+
+module USerializer
+  NS_SEPARATOR = '::'.freeze
+
+  class << self
+    def serializer_for(obj)
+      infered_serializer_class(obj.class)
+    end
+
+    def infered_serializer_class(kls)
+      (kls.name + 'Serializer').split(NS_SEPARATOR).inject(Object) do |o, c|
+        o.const_get(c)
+      end
+    end
+  end
+end

data/lib/userializer/array_serializer.rb

@@ -0,0 +1,47 @@
+require 'oj'
+
+module USerializer
+  class HeterogeneousArray < StandardError; end
+
+  class ArraySerializer
+    def initialize(objs, opts = {})
+      @objs = objs.compact
+      @opts = opts
+      @meta = opts[:meta]
+
+      clss = @objs.map(&:class).uniq
+      obj_class = clss.first
+
+      raise HeterogeneousArray if clss.count > 1
+
+      @root_key = opts[:root] || ActiveSupport::Inflector.pluralize(
+        ActiveSupport::Inflector.underscore(obj_class.name).split('/').last
+      ).to_sym
+
+      @serializer = opts[:each_serializer] || USerializer.infered_serializer_class(
+        obj_class
+      )
+    end
+
+    def merge_root(res, opts)
+      @objs.each do |obj|
+        @serializer.new(obj, @opts).merge_root(res, @root_key, false, opts)
+      end
+    end
+
+    def to_hash
+      res = {}
+
+      merge_root(res, @opts)
+      res[:meta] = @meta if @meta
+
+      res
+    end
+
+    def to_json
+      Oj.dump(to_hash, mode: :compat)
+    end
+
+    def scope; @opts[:scope]; end
+  end
+end

data/lib/userializer/attribute.rb

@@ -0,0 +1,19 @@
+module USerializer
+  class Attribute
+    attr_reader :key
+
+    def initialize(key, opts, block)
+      @key = key
+      @opts = opts
+      @block = block
+
+      @conditional_block = opts[:if] || proc { true }
+    end
+
+    def merge_attributes(res, ser, opts)
+      return unless @conditional_block.call(ser.object, opts)
+
+      res[@key] = @block ? @block.call(ser.object, opts) : ser.send(@key)
+    end
+  end
+end

data/lib/userializer/base_serializer.rb

@@ -0,0 +1,113 @@
+require 'oj'
+require 'active_support/inflector/methods'
+require 'userializer/has_one'
+require 'userializer/has_many'
+require 'userializer/attribute'
+
+module USerializer
+  class BaseSerializer
+    class << self
+      def inherited(subclass)
+        subclass.attrs = self.attrs || { id: Attribute.new(:id, {}, nil) }
+        subclass.relations = self.relations || {}
+      end
+
+      def attributes(*attrs, &block)
+        attrs = attrs.first if attrs.first.class.is_a?(Array)
+        opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
+
+        attrs.each { |attr| @attrs[attr] = Attribute.new(attr, opts, block) }
+      end
+
+      def has_one(*attrs)
+        attrs = attrs.first if attrs.first.class.is_a?(Array)
+        opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
+
+        attrs.each { |attr| @relations[attr] = HasOne.new(attr, opts) }
+      end
+
+      def has_many(*attrs)
+        attrs = attrs.first if attrs.first.class.is_a?(Array)
+        opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
+
+        attrs.each { |attr| @relations[attr] = HasMany.new(attr, opts) }
+      end
+
+      attr_accessor :attrs, :relations
+    end
+
+    attr_reader :obj, :meta, :opts
+
+    alias object obj
+
+    def initialize(obj, opts = {})
+      @obj = obj
+      @opts = opts
+      @meta = opts[:meta]
+      @except = Set.new([opts[:except]].flatten.compact)
+
+      @root_key = (opts[:root] || ActiveSupport::Inflector.underscore(
+        obj.class.name
+      ).split('/').last).to_sym
+    end
+
+    def serializable_hash(opts)
+      res = {}
+
+      attributes.each { |attr| attr.merge_attributes(res, self, opts) }
+      relations.each do |rel|
+        rel.merge_attributes(res, self, opts)
+      end
+
+      res
+    end
+
+    def merge_root(res, key, single, opts)
+      if single
+        res[key] = serializable_hash(opts)
+      else
+        res[key] ||= []
+
+        id = @obj.id
+
+        if res[key].detect { |v| id && v[:id] == id }
+          return
+        else
+          res[key] << serializable_hash(opts)
+        end
+      end
+
+      relations.each { |rel| rel.merge_root(res, self, opts) }
+    end
+
+    def to_hash
+      res = {}
+
+      merge_root(res, @root_key, true, @opts.slice(:scope))
+
+      res[:meta] = @meta if @meta
+
+      res
+    end
+
+    def to_json
+      Oj.dump(to_hash, mode: :compat)
+    end
+
+    def method_missing(mth); @obj.send(mth); end
+
+    private
+
+    def attributes
+      @attributes ||= (self.class.attrs || {}).values.reject do |attr|
+        @except.include?(attr.key)
+      end
+    end
+
+    def relations
+      @relations ||= (self.class.relations || {}).values.reject do |rel|
+        @except.include?(rel.key)
+      end
+    end
+  end
+end

data/lib/userializer/has_many.rb

@@ -0,0 +1,28 @@
+module USerializer
+  class HasMany
+    attr_reader :key
+
+    def initialize(key, opts)
+      @key = key
+
+      @opts = opts
+      @id_key = "#{ActiveSupport::Inflector.singularize(key)}_ids".to_sym
+
+      @conditional_block = opts[:if] || proc { true }
+    end
+
+    def merge_attributes(res, ser, opts)
+      return unless @conditional_block.call(ser.object, opts)
+
+      res[@id_key] = (ser.send(@key) || []).compact.map(&:id).compact
+    end
+
+    def merge_root(res, ser, opts)
+      objs = ser.send(@key) || []
+
+      return if objs.empty? || !@conditional_block.call(ser.object, opts)
+
+      ArraySerializer.new(objs, @opts).merge_root(res, opts)
+    end
+  end
+end

data/lib/userializer/has_one.rb

@@ -0,0 +1,48 @@
+module USerializer
+  class HasOne
+    def initialize(key, opts)
+      @key = key
+      @opts = opts
+      @id_key = "#{key}_id".to_sym
+      @root_key = opts[:root]&.to_sym
+
+      @serializer = opts[:serializer]
+
+      @conditional_block = opts[:if] || proc { true }
+    end
+
+    attr_reader :id_key, :key
+
+    def merge_attributes(res, ser, opts)
+      return unless @conditional_block.call(ser.object, opts)
+
+      obj = ser.send(@key)
+      res[@id_key] = obj&.id
+    end
+
+    def merge_root(res, ser, opts)
+      obj = ser.send(@key)
+
+      return if obj.nil? || !@conditional_block.call(ser.object, opts)
+
+      serializer(obj).merge_root(res, root_key(obj), false, opts)
+    end
+
+    private
+
+    def serializer(obj)
+      return @serializer.new(obj, @opts) if @serializer
+      return obj.serialize if obj.respond_to?(:serialize)
+
+      USerializer.infered_serializer_class(obj.class).new(obj, @opts)
+    end
+
+    def root_key(obj)
+      return @root_key if @root_key
+
+      ActiveSupport::Inflector.pluralize(
+        ActiveSupport::Inflector.underscore(obj.class.name).split('/').last
+      ).to_sym
+    end
+  end
+end

data/lib/userializer/version.rb

@@ -0,0 +1,3 @@
+module USerializer
+  VERSION = "0.1.0"
+end

data/userializer.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "userializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "userializer"
+  spec.version       = USerializer::VERSION
+  spec.authors       = ["Alexis Montagne"]
+  spec.email         = ["alexis.montagne@gmail.com"]
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/upfluence/userializer'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "oj"
+  spec.add_dependency "activesupport"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: userializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexis Montagne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write a longer description or delete this line.
+email:
+- alexis.montagne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/userializer.rb
+- lib/userializer/array_serializer.rb
+- lib/userializer/attribute.rb
+- lib/userializer/base_serializer.rb
+- lib/userializer/has_many.rb
+- lib/userializer/has_one.rb
+- lib/userializer/version.rb
+- userializer.gemspec
+homepage: https://github.com/upfluence/userializer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []