seri 1.1.8 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f7782dc18bb6021bb43d59ab8c76392f88032f435a7563e75476d97444c34d
-  data.tar.gz: e1fe3ab5fe370e738cf79c827b670b9e904694b438faada1dc21252693bfa5bd
+  metadata.gz: b195c3ae8c5ec78fa54317184b782970fe1d22d1b19f446d6297b5959a90b06b
+  data.tar.gz: df3042fb5c2f291fec12b63ece1036a5e75549503ea6896ac8ac167da0cb2e91
 SHA512:
-  metadata.gz: 667e2b777ef649ce89df198a88802747c22da168e31165935a994a6b957ccada60ff15232a86e6d959ebfceae509fcb1e0fc51a2fba8a0d9b8097dd71ef14a99
-  data.tar.gz: c367bffecbacf6408632fe00531129b77b8e874f85c2fef67cceab996ab5c7246eaa8011df225bc40f1fe154972d0399af60f0cfe8ee65e9af038aae2bb6acde
+  metadata.gz: 030be24706b3a319c34cf167e4a9f833314235e61fcdb45f41974db8819d4de5d31cd3215d4c3bc5c0bca718bbeb81cf3ce666b0e068347c9ce89db3ed1e07bf
+  data.tar.gz: 3d563d73ab5fc270b27ef032a0b2ab8bf2e2fe5069088f541236e04c0150044bb039214dcc0418e81171de19fc43551ac5e7cbae5a788edcd34f7ec76a1edd0a

data/.circleci/config.yml

@@ -4,7 +4,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-       - image: circleci/ruby:2.5.3-node-browsers
+       - image: circleci/ruby:2.7.1
 
     working_directory: ~/repo
 
@@ -21,6 +21,7 @@ jobs:
       - run:
           name: install dependencies
           command: |
+            gem install bundler:1.17.3
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
       - save_cache:

data/.rubocop.yml

@@ -1,8 +1,14 @@
+AllCops:
+  NewCops: disable
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 Style/Documentation:
   Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
 # This is causing breaking changes:
 Style/ExpandPathArguments:
   Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Gemfile.lock

@@ -1,22 +1,27 @@
 PATH
   remote: .
   specs:
-    seri (1.1.7)
+    seri (2.0.0)
       oj (~> 3.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
+    coderay (1.1.3)
     diff-lcs (1.3)
-    jaro_winkler (1.5.2)
-    oj (3.10.5)
-    parallel (1.17.0)
-    parser (2.6.2.1)
-      ast (~> 2.4.0)
-    psych (3.1.0)
+    method_source (1.0.0)
+    oj (3.10.14)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -30,25 +35,29 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.67.2)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      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.6)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.5.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 0.67.2)
+  rubocop (~> 0.82)
   seri!
 
 BUNDLED WITH

data/README.md

@@ -33,13 +33,15 @@ Or install it yourself as:
 A serializer can be used as such:
 
 ```ruby
+require 'seri'
+
 # example class:
 class Car
   attr_accessor :mileage
 end
 
 # example serializer:
-class CarSerializer < Serializer
+class CarSerializer < Seri::Serializer
   attribute :mileage
   attribute :brand
   attribute :mileage_alias, from: :mileage
@@ -94,14 +96,14 @@ Result from `#to_json`:
 }
 ```
 
-In turn there's also a `GroupSerializer` available which can take a group of
+In turn there's also a `Seri::GroupSerializer` available which can take a group of
 cars and turn them into a serialized Array. If we extend the example from
 earlier we can do:
 
 ```ruby
 # example:
 cars = [car, car]
-group_serializer = GroupSerializer.new(cars, serializer: CarSerializer)
+group_serializer = Seri::GroupSerializer.new(cars, serializer: CarSerializer)
 
 group_serializer.to_json
 ```
@@ -148,11 +150,11 @@ class B
   end
 end
 
-class ASerializer < Serializer
+class ASerializer < Seri::Serializer
   attribute :some_amazing_attribute
 end
 
-class BSerializer < Serializer
+class BSerializer < Seri::Serializer
   attribute :lots_of_a, from: :aaa, serializer: ASerializer
 end
 ```

data/lib/seri.rb

@@ -0,0 +1 @@
+require 'serializer'

data/lib/serializer.rb

@@ -3,34 +3,36 @@ require 'serializer/value'
 require 'serializer/value_fetcher'
 require 'serializer/group_serializer'
 
-class Serializer
-  Attribute = Struct.new(:key, :condition, :from, :serializer, :options)
+module Seri
+  class Serializer
+    Attribute = Struct.new(:key, :condition, :from, :serializer, :options)
 
-  def self.attributes
-    @attributes ||= []
-  end
+    def self.attributes
+      @attributes ||= []
+    end
 
-  def self.attribute(key, condition: nil, from: nil, serializer: nil, **options)
-    attributes.push(Attribute.new(key, condition, from, serializer, options))
-  end
+    def self.attribute(key, condition: nil, from: nil, serializer: nil, **options)
+      attributes.push(Attribute.new(key, condition, from, serializer, options))
+    end
 
-  attr_accessor :object, :scope
+    attr_accessor :object, :scope
 
-  def initialize(object, scope: {})
-    @object = object
-    @scope = scope
-  end
+    def initialize(object, scope: {})
+      @object = object
+      @scope = scope
+    end
 
-  # Loops over all attributes and skips if a condition is defined and falsey
-  def to_h
-    self.class.attributes.each_with_object({}) do |attribute, obj|
-      next if attribute.condition && !public_send(attribute.condition)
+    # Loops over all attributes and skips if a condition is defined and falsey
+    def to_h
+      self.class.attributes.each_with_object({}) do |attribute, obj|
+        next if attribute.condition && !public_send(attribute.condition)
 
-      obj[attribute.key] = ValueFetcher.fetch(attribute, object, self)
+        obj[attribute.key] = ValueFetcher.fetch(attribute, object, self)
+      end
     end
-  end
 
-  def to_json(*)
-    Oj.dump(to_h, mode: :json)
+    def to_json(*)
+      Oj.dump(to_h, mode: :json)
+    end
   end
 end

data/lib/serializer/group_serializer.rb

@@ -1,19 +1,21 @@
-class GroupSerializer
-  def initialize(objects, serializer: nil, scope: {})
-    raise ArgumentError, 'serializer needs to be specified' if serializer.nil?
+module Seri
+  class GroupSerializer
+    def initialize(objects, serializer: nil, scope: {})
+      raise ArgumentError, 'serializer needs to be specified' if serializer.nil?
 
-    @objects = objects
-    @serializer = serializer
-    @scope = scope
-  end
+      @objects = objects
+      @serializer = serializer
+      @scope = scope
+    end
 
-  def to_json(*)
-    Oj.dump(to_h, mode: :json)
-  end
+    def to_json(*)
+      Oj.dump(to_h, mode: :json)
+    end
 
-  def to_h
-    @objects
-      .map { |object| @serializer.new(object, scope: @scope) }
-      .map(&:to_h)
+    def to_h
+      @objects
+        .map { |object| @serializer.new(object, scope: @scope) }
+        .map(&:to_h)
+    end
   end
 end

data/lib/serializer/value.rb

@@ -1,58 +1,62 @@
-class Value
-  def initialize(attribute, scope = nil)
-    @attribute = attribute
-    @scope = scope
-  end
-
-  def extraction_key
-    @attribute.from || @attribute.key
-  end
-
-  def precondition?
-    raise NotImplementedError, 'needs a method called precondition?'
-  end
-
-  def value
-    raise NotImplementedError, 'needs a method called value'
-  end
-end
-
-class StaticValue < Value
-  def precondition?
-    @attribute.options.key?(:static_value)
-  end
-
-  def value
-    @attribute.options.fetch(:static_value)
-  end
-end
-
-class SerializedValue < Value
-  def precondition?
-    @scope.respond_to?(extraction_key)
-  end
-
-  def value
-    @scope.public_send(extraction_key)
-  end
-end
-
-class HashValue < Value
-  def precondition?
-    @scope.is_a?(Hash) && @scope.key?(extraction_key)
-  end
-
-  def value
-    @scope.fetch(extraction_key)
-  end
-end
-
-class ObjectValue < Value
-  def precondition?
-    @scope.respond_to?(extraction_key)
-  end
-
-  def value
-    @scope.public_send(extraction_key)
+module Seri
+  class Serializer
+    class Value
+      def initialize(attribute, scope = nil)
+        @attribute = attribute
+        @scope = scope
+      end
+
+      def extraction_key
+        @attribute.from || @attribute.key
+      end
+
+      def precondition?
+        raise NotImplementedError, 'needs a method called precondition?'
+      end
+
+      def value
+        raise NotImplementedError, 'needs a method called value'
+      end
+    end
+
+    class StaticValue < Value
+      def precondition?
+        @attribute.options.key?(:static_value)
+      end
+
+      def value
+        @attribute.options.fetch(:static_value)
+      end
+    end
+
+    class SerializedValue < Value
+      def precondition?
+        @scope.respond_to?(extraction_key)
+      end
+
+      def value
+        @scope.public_send(extraction_key)
+      end
+    end
+
+    class HashValue < Value
+      def precondition?
+        @scope.is_a?(Hash)
+      end
+
+      def value
+        @scope[extraction_key]
+      end
+    end
+
+    class ObjectValue < Value
+      def precondition?
+        @scope.respond_to?(extraction_key)
+      end
+
+      def value
+        @scope.public_send(extraction_key)
+      end
+    end
   end
 end

data/lib/serializer/value_fetcher.rb

@@ -1,59 +1,53 @@
-class ValueFetcher
-  class SerializerError < StandardError; end
+module Seri
+  class Serializer
+    class ValueFetcher
+      class SerializerError < StandardError; end
 
-  ARRAYS = %w[
-    Array
-    ActiveRecord_AssociationRelation
-    ActiveRecord_Associations_CollectionProxy
-  ].freeze
-
-  def self.fetch(attribute, object, serializer)
-    new(attribute, object, serializer).fetch
-  end
+      def self.fetch(attribute, object, serializer)
+        new(attribute, object, serializer).fetch
+      end
 
-  private_class_method :new
+      private_class_method :new
 
-  def initialize(attribute, object, serializer)
-    @attribute = attribute
-    @values = [
-      StaticValue.new(attribute),
-      SerializedValue.new(attribute, serializer),
-      HashValue.new(attribute, object),
-      ObjectValue.new(attribute, object)
-    ]
-  end
+      def initialize(attribute, object, serializer)
+        @attribute = attribute
+        @values = [
+          StaticValue.new(attribute),
+          SerializedValue.new(attribute, serializer),
+          HashValue.new(attribute, object),
+          ObjectValue.new(attribute, object)
+        ]
+      end
 
-  def fetch
-    serializer = @attribute.serializer
+      def fetch
+        serializer = @attribute.serializer
 
-    return value unless serializer
+        return value unless serializer
 
-    if array?
-      value.map { |item| serializer.new(item).to_h }
-    else
-      serializer.new(value).to_h
-    end
-  end
-
-  # Fetches a value from an attribute by checking if there's a ..
-  # .. static value set, or a ..
-  # .. method defined in the serializer, or a ..
-  # .. method/attribute defined in the object or ..
-  # .. it raises an error
-  def value
-    @value ||= begin
-      extracted_value = @values.detect(&:precondition?)
-
-      if extracted_value.nil?
-        raise SerializerError,
-              "unknown attribute '#{@values[0].extraction_key}'"
+        if value.is_a?(Enumerable) && !value.is_a?(Hash)
+          value.map { |item| serializer.new(item).to_h }
+        else
+          serializer.new(value).to_h
+        end
       end
 
-      extracted_value.value
+      # Fetches a value from an attribute by checking if there's a ..
+      # .. static value set, or a ..
+      # .. method defined in the serializer, or a ..
+      # .. method/attribute defined in the object or ..
+      # .. it raises an error
+      def value
+        @value ||= begin
+          extracted_value = @values.detect(&:precondition?)
+
+          if extracted_value.nil?
+            raise SerializerError,
+                  "unknown attribute '#{@values[0].extraction_key}'"
+          end
+
+          extracted_value.value
+        end
+      end
     end
   end
-
-  def array?
-    ARRAYS.any? { |match| value.class.to_s.end_with?(match) }
-  end
 end

data/lib/serializer/version.rb

@@ -1,3 +1,5 @@
-class Serializer
-  VERSION = '1.1.8'.freeze
+module Seri
+  class Serializer
+    VERSION = '2.0.1'.freeze
+  end
 end

data/seri.gemspec

@@ -4,7 +4,7 @@ require 'serializer/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'seri'
-  spec.version       = Serializer::VERSION
+  spec.version       = Seri::Serializer::VERSION
   spec.authors       = ['grdw']
   spec.email         = ['gerard@wetransfer.com']
 
@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'oj', '~> 3.7'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry', '~> 0.13'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+  spec.add_development_dependency 'rubocop', '~> 0.82'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seri
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 2.0.1
 platform: ruby
 authors:
 - grdw
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: '0.82'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: '0.82'
 description: A basic serializer
 email:
 - gerard@wetransfer.com
@@ -98,6 +112,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/seri.rb
 - lib/serializer.rb
 - lib/serializer/group_serializer.rb
 - lib/serializer/value.rb
@@ -108,7 +123,7 @@ homepage: https://github.com/grdw/seri
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A basic serializer
 test_files: []