seri 1.1.10 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 394f107e4e7ca59a2c4951316e4223ed8f9dec2d14d70610be80079a69974cb2
-  data.tar.gz: 59e58c2f0802df12dff7f3ec1da988978d95c2c1e427113124b3c488fa4bed0c
+  metadata.gz: 97c393ef117d1729bbd8459bdd47c1726e8a6a1436e39cb73bb2108bd0817bec
+  data.tar.gz: 519552ef6a2ce6de01293fcbfce32a7afdbc4535d56233bda5d8c4687b45e3db
 SHA512:
-  metadata.gz: 004c1bf17667b3da131e4695e9a093d04d4a975ebf4f86644b0bdd4765753b4549120115484ab8285d275b938cc299e31e6270359a9a37a87b5ca055c44f885c
-  data.tar.gz: c3870a1ecd13aae4f159fa8b82547c06edb0015bad397822bb209a0d34e85b2d535545bd5d03ddd7defa542b5f316f352f3c57f7208d28c14224153e79ebc173
+  metadata.gz: a8df6fab6b789c59070760a40c5a95251933bda9eaaace98b2eed8275e75b35e967877640195fd4a04f3592c7b62c4adb51aeaf3bd0f00a2169b50ab6d2af755
+  data.tar.gz: 6fee2110d91fd341a46d234a4203059e95623f721d31b12637c2369302e22d00541616b24b3e35eb55eba6450d0e3c6755642a9ce84408f02d517f6230a0f596

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,3 +10,5 @@ Style/FrozenStringLiteralComment:
 # This is causing breaking changes:
 Style/ExpandPathArguments:
   Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Gemfile.lock

@@ -1,43 +1,51 @@
 PATH
   remote: .
   specs:
-    seri (1.1.10)
+    seri (2.0.3)
       oj (~> 3.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.4)
-    oj (3.10.6)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
+    ast (2.4.1)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    oj (3.10.18)
+    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)
+    rake (13.0.3)
+    regexp_parser (1.8.2)
     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)
+    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.82.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.7.0.1)
+      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, < 2.0)
+    rubocop-ast (0.8.0)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.7.0)
 
@@ -46,10 +54,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.82)
   seri!
 
 BUNDLED WITH
-   1.17.3
+   2.2.5

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.10'.freeze
+module Seri
+  class Serializer
+    VERSION = '2.0.3'.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,6 +27,7 @@ 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.82'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seri
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 2.0.3
 platform: ruby
 authors:
 - grdw
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2021-01-12 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
@@ -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
@@ -123,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A basic serializer
 test_files: []