seri 1.1.11 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93d4a3c7d7f2166ee7b8f3a32a398b4047f46d19a73ce59cca497cc74843cfe4
-  data.tar.gz: 4e1e7a46dc70f2f1a0d9ffb93b11b625da277beee9593348736f91fd912a31f6
+  metadata.gz: 7a3a1187f09d0137341747e027fab35d148056c102fc4344e1019e29128d5e0e
+  data.tar.gz: af33fc079fff5f053fa28b5b914a82c9989e201002cf1e626d45d941f8277efe
 SHA512:
-  metadata.gz: 0ce7148279857a7c35a535e250124dbb2b2a3957b246ab0c737d631ec9129451977f53e9abdb65d403acd72650587648d497dad330c80f710c31033b5cbff563
-  data.tar.gz: d433c26c41157799e77a6f8d786b3d7418cfe6147fe70187dd34dc9c44eea617b6ce9918df0c375e77e2fa1203607d968e1c7a3a098cd9b8c1cb365a53ae71ec
+  metadata.gz: f6b36c95ee331cdc57125bb115b85780ed4fd7bf9181feecf6c4f9e40858967e68ca7d5ebb92de05cea1bf927a28bf295f46417d5bf905c32e3ad767ac839e05
+  data.tar.gz: 32b3c7ccc01c298d2f131922ee93dafbb213be35c553bcc79211bebfc374b3a1cbfdb4586cfd7bd311a411c4852aa335ef8a654de917432f4c2c4a60a4272c6b

data/.circleci/config.yml

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

data/.rubocop.yml

@@ -1,3 +1,5 @@
+AllCops:
+  NewCops: disable
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
@@ -8,31 +10,5 @@ Style/FrozenStringLiteralComment:
 # This is causing breaking changes:
 Style/ExpandPathArguments:
   Enabled: false
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: false
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: false
-Lint/DeprecatedOpenSSLConstant:
-  Enabled: false
-Lint/MixedRegexpCaptureTypes:
-  Enabled: false
-Lint/RaiseException:
-  Enabled: false
-Lint/StructNewOverride:
-  Enabled: false
-Style/ExponentialNotation:
-  Enabled: false
-Style/HashEachMethods:
-  Enabled: false
-Style/HashTransformKeys:
-  Enabled: false
-Style/HashTransformValues:
-  Enabled: false
-Style/RedundantFetchBlock:
-  Enabled: false
-Style/RedundantRegexpCharacterClass:
-  Enabled: false
-Style/RedundantRegexpEscape:
-  Enabled: false
-Style/SlicingWithRange:
+Gemspec/RequiredRubyVersion:
   Enabled: false

data/Gemfile.lock

@@ -1,46 +1,51 @@
 PATH
   remote: .
   specs:
-    seri (1.1.11)
+    seri (2.0.4)
       oj (~> 3.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
-    diff-lcs (1.3)
-    oj (3.10.6)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    oj (3.11.7)
     parallel (1.19.2)
-    parser (2.7.1.4)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rake (13.0.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.5)
+    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.2)
-    rubocop (0.86.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.7.0)
 
@@ -48,11 +53,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (>= 2.2.10)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.82)
   seri!
 
 BUNDLED WITH
-   1.17.3
+   2.2.21

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

data/lib/serializer/value_fetcher.rb

@@ -1,61 +1,53 @@
-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
+module Seri
+  class Serializer
+    class ValueFetcher
+      class SerializerError < StandardError; end
 
-    private_class_method :new
+      def self.fetch(attribute, object, serializer)
+        new(attribute, object, serializer).fetch
+      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
+      private_class_method :new
 
-    def fetch
-      serializer = @attribute.serializer
+      def initialize(attribute, object, serializer)
+        @attribute = attribute
+        @values = [
+          StaticValue.new(attribute),
+          SerializedValue.new(attribute, serializer),
+          HashValue.new(attribute, object),
+          ObjectValue.new(attribute, object)
+        ]
+      end
 
-      return value unless serializer
+      def fetch
+        serializer = @attribute.serializer
 
-      if array?
-        value.map { |item| serializer.new(item).to_h }
-      else
-        serializer.new(value).to_h
-      end
-    end
+        return value unless serializer
 
-    # 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
-
-        extracted_value.value
       end
-    end
 
-    def array?
-      ARRAYS.any? { |match| value.class.to_s.end_with?(match) }
+      # 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
 end

data/lib/serializer/version.rb

@@ -1,3 +1,5 @@
-class Serializer
-  VERSION = '1.1.11'.freeze
+module Seri
+  class Serializer
+    VERSION = '2.0.4'.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']
 
@@ -26,7 +26,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'oj', '~> 3.7'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '>= 2.2.10'
+  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.82'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seri
 version: !ruby/object:Gem::Version
-  version: 1.1.11
+  version: 2.0.4
 platform: ruby
 authors:
 - grdw
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -26,18 +26,32 @@ dependencies:
         version: '3.7'
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.10
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -123,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A basic serializer