seri 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a080e5eb873ba467789a339f0ceefa26e8f86b9c88f92d11f55b97a5bba86d0
-  data.tar.gz: 30b4ef48887b9a4083c64623f46294079078add3176ef45ee92a9dfbe98e4f66
+  metadata.gz: 6cfa2981681193432bc52036121c8481f8558594fb4162e5ca7938e911ade897
+  data.tar.gz: 005d6c9f9fa17d6aac6d1ec719cb4acd87e713782f46621899ff53c199ff9702
 SHA512:
-  metadata.gz: 5e8fe5badf7bfc337d91e02540a1df44f66de49786e9b8c1da6cfd59b631f613bdf9e3aba61ad972d366716dfe32c21b527bc4b67373d3cd59a61e672952e226
-  data.tar.gz: 65d6c70dfea3489728816beffd1c4febbabf2076607f06daa55991a4f1ac9cfbd5526ac6fab32bd2b78d5a89f534b9e844f8e3a53f2f69a6692fa3ebf95b106e
+  metadata.gz: b004ae3a8febfd4ba2869390f7ba91a982835f44c83813fc8423b19ff214f28804feeb960659ca9e09c7a0fb25c92eb3d9d16cff7541acc6a584eb71d4f954cf
+  data.tar.gz: 13dc8907b0083bbd8e251b10b23f58781d561e8f26deaefe013f56a825072bc640f08a58c3abddb9594a9074e61482a1fc324b7bb67c7c9a6e68d3f18c908edc

data/.circleci/config.yml

@@ -40,6 +40,12 @@ jobs:
                             --format progress \
                             $TEST_FILES
 
+      # run rubocop
+      - run:
+          name: run rubocop
+          command: |
+            bundle exec rubocop .
+
       # collect reports
       - store_test_results:
           path: /tmp/test-results

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Style/Documentation:
+  Enabled: false
+# This is causing breaking changes:
+Style/ExpandPathArguments:
+  Enabled: false

data/Gemfile

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

data/Gemfile.lock

@@ -1,18 +1,25 @@
 PATH
   remote: .
   specs:
-    seri (0.1.2)
+    seri (0.1.5)
       appsignal (~> 2.7)
       oj (~> 3.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    appsignal (2.7.2)
+    appsignal (2.9.5)
       rack
+    ast (2.4.0)
     diff-lcs (1.3)
-    oj (3.7.4)
-    rack (2.0.6)
+    jaro_winkler (1.5.2)
+    oj (3.7.11)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rack (2.0.7)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -27,6 +34,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.5.0)
 
 PLATFORMS
   ruby
@@ -35,6 +52,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.67.2)
   seri!
 
 BUNDLED WITH

data/Rakefile

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

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "serializer"
+require 'bundler/setup'
+require 'serializer'
 
 # 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"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/serializer/group_serializer.rb

@@ -1,9 +1,10 @@
 class GroupSerializer
-  def initialize(objects, serializer: nil)
+  def initialize(objects, serializer: nil, scope: {})
     raise ArgumentError, 'serializer needs to be specified' if serializer.nil?
 
     @objects = objects
     @serializer = serializer
+    @scope = scope
   end
 
   def to_json(*)
@@ -12,9 +13,13 @@ class GroupSerializer
       'Group serializer',
       @serializer.to_s
     ) do
-      result = @objects.map { |object| @serializer.new(object).to_h }
-
-      Oj.dump(result, mode: :json)
+      Oj.dump(to_h, mode: :json)
     end
   end
+
+  def to_h
+    @objects
+      .map { |object| @serializer.new(object, scope: @scope) }
+      .map(&:to_h)
+  end
 end

data/lib/serializer/version.rb

@@ -1,3 +1,3 @@
 class Serializer
-  VERSION = "0.1.5"
+  VERSION = '1.0.0'.freeze
 end

data/lib/serializer.rb

@@ -4,11 +4,11 @@ require 'serializer/group_serializer'
 class Serializer
   class SerializerError < StandardError; end
 
-  ARRAYS = %w(
+  ARRAYS = %w[
     Array
     ActiveRecord_AssociationRelation
     ActiveRecord_Associations_CollectionProxy
-  )
+  ].freeze
 
   Attribute = Struct.new(:key, :condition, :from, :serializer, :options)
 
@@ -32,24 +32,7 @@ class Serializer
     self.class.attributes.each_with_object({}) do |attribute, obj|
       next if attribute.condition && !public_send(attribute.condition)
 
-      extraction_key = attribute.from || attribute.key
-
-      # 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
-      value = if attribute.options.has_key?(:static_value)
-                attribute.options.fetch(:static_value)
-              elsif respond_to?(extraction_key)
-                public_send(extraction_key)
-              elsif object.respond_to?(extraction_key)
-                object.public_send(extraction_key)
-              else
-                raise SerializerError, "unknown attribute '#{extraction_key}'"
-              end
-
-      obj[attribute.key] = serialize_value(value, attribute.serializer)
+      obj[attribute.key] = serialize_value(attribute)
     end
   end
 
@@ -61,13 +44,35 @@ class Serializer
 
   private
 
-  def serialize_value(value, serializer)
-    return value unless serializer
+  def serialize_value(attribute)
+    value = extract_value(attribute)
+    serializer = attribute.serializer
 
     if ARRAYS.any? { |match| value.class.to_s.end_with?(match) }
       value.map { |v| serializer.new(v).to_h }
-    else
+    elsif serializer
       serializer.new(value).to_h
+    else
+      value
+    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 extract_value(attribute)
+    extraction_key = attribute.from || attribute.key
+
+    if attribute.options.key?(:static_value)
+      attribute.options.fetch(:static_value)
+    elsif respond_to?(extraction_key)
+      public_send(extraction_key)
+    elsif object.respond_to?(extraction_key)
+      object.public_send(extraction_key)
+    else
+      raise SerializerError, "unknown attribute '#{extraction_key}'"
     end
   end
 end

data/seri.gemspec

@@ -1,32 +1,35 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "serializer/version"
+require 'serializer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "seri"
+  spec.name          = 'seri'
   spec.version       = Serializer::VERSION
-  spec.authors       = ["grdw"]
-  spec.email         = ["gerard@wetransfer.com"]
+  spec.authors       = ['grdw']
+  spec.email         = ['gerard@wetransfer.com']
 
-  spec.summary       = %q{A basic serializer}
-  spec.description   = %q{A basic serializer which can suite as a replacement to other gems}
-  spec.homepage      = "https://github.com/grdw/seri"
-  spec.license       = "MIT"
+  spec.summary       = 'A basic serializer'
+  spec.description   = 'A basic serializer'
+  spec.homepage      = 'https://github.com/grdw/seri'
+  spec.license       = 'MIT'
 
   # 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('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # 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 do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "oj", "~> 3.7"
-  spec.add_dependency "appsignal", "~> 2.7"
+  spec.add_dependency 'appsignal', '~> 2.7'
+  spec.add_dependency 'oj', '~> 3.7'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.67.2'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: seri
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - grdw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2019-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: appsignal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: appsignal
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: A basic serializer which can suite as a replacement to other gems
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.67.2
+description: A basic serializer
 email:
 - gerard@wetransfer.com
 executables: []
@@ -90,6 +104,7 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile