restpack_serializer 0.6.8 → 0.6.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7af1bc27d7c8835c4661909c30fc9dd85db99379
-  data.tar.gz: cdd08668865b3200810f2f296a6729b5aa29a1e1
+SHA256:
+  metadata.gz: 5cbdfc54c01006c75a8db9b73a60b7dc713e17257e77991b82bf4b3f3d22b537
+  data.tar.gz: 126c3c857097eb24d9f45aa1d9a1a2b40363f1246edc869350249b6fba30c3f8
 SHA512:
-  metadata.gz: a9186bacc0ef4f585bd8e053e2ba678f980ce263f026fb6623812076bc22f3dc0d10490ac29f4bf31fa0c397dd205e86e96a59825c5cda097516a01914612fd5
-  data.tar.gz: e7e1ab1b5d90c07c5868a106888a0079f8fa3e4ad638ec97ba2d7d5b2114f75cd9d63e6f4898563fe208625d8bac8f02496c60b2633c5582ee55dac0349784cc
+  metadata.gz: 6002f9e445e71c1d4353b7954421dc80d6e1742ff5444f5701e3612a78a2cbd21b03de9a2347b0d8f534034e75a3d5badfdd75a7a26c037ef7897f394a5f7784
+  data.tar.gz: 7f81b17da0dd9cf8855108a00174c8ac0ce9df55732f87b0a1691f838abf90f18d7711363cdbf8b43326b759350250ef9e84e4dbc08b0e0c93280798205c20fb

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby-version:
+          - 2.1
+          - 2.2
+          - 2.3
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - run: bundle exec rake test

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.7.2

data/Gemfile

@@ -3,3 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
+gem 'memory_profiler', require: false
+
+if RUBY_VERSION < "2.2"
+  gem "sqlite3", "~> 1.3.0"
+end

data/Rakefile

@@ -4,4 +4,5 @@ RestPack::Gem::Tasks.load_tasks
 desc "Run some performance tests"
 task :perf do
   require_relative 'performance/perf.rb'
+  require_relative 'performance/mem.rb'
 end

data/lib/restpack_serializer.rb

@@ -6,7 +6,7 @@ require_relative 'restpack_serializer/serializable'
 require_relative 'restpack_serializer/factory'
 require_relative 'restpack_serializer/result'
 
-Kaminari::Hooks.init
+Kaminari::Hooks.init if defined?(Kaminari::Hooks)
 
 module RestPack
   module Serializer

data/lib/restpack_serializer/serializable.rb

@@ -34,7 +34,7 @@ module RestPack
     def as_json(model, context = {})
       return if model.nil?
       if model.kind_of?(Array)
-        return model.map { |item| as_json(item, context) }
+        return model.map { |item| self.class.new.as_json(item, context) }
       end
 
       apply_whitelist_and_blacklist(context)
@@ -57,11 +57,15 @@ module RestPack
       end
 
       add_custom_attributes(data)
-      add_links(model, data) unless self.class.associations.empty?
+      add_links(model, data) if self.class.has_associations?
 
       data
     end
 
+    def to_json(model, context = {})
+      as_json(model, context).to_json
+    end
+
     def custom_attributes
       nil
     end
@@ -140,9 +144,13 @@ module RestPack
       end
 
       def has_user_defined_method?(method_name)
-        user_defined_methods = self.user_defined_methods || []
-        return true if user_defined_methods.include?(method_name)
-        return self.superclass.try(:has_user_defined_method?, method_name)
+        if user_defined_methods && user_defined_methods.include?(method_name)
+          true
+        elsif superclass.respond_to?(:has_user_defined_method?)
+          superclass.has_user_defined_method?(method_name)
+        else
+          false
+        end
       end
 
       def memoized_has_user_defined_method?(method_name)
@@ -165,6 +173,10 @@ module RestPack
         new.as_json(model, context)
       end
 
+      def to_json(model, context = {})
+        new.as_json(model, context).to_json
+      end
+
       def serialize(models, context = {})
         models = [models] unless models.kind_of?(Array)
 

data/lib/restpack_serializer/serializable/side_loading.rb

@@ -44,8 +44,12 @@ module RestPack::Serializer::SideLoading
       end
     end
 
+    def has_associations?
+      @can_includes
+    end
+
     def associations
-      return [] unless @can_includes
+      return [] unless has_associations?
       can_includes.map do |include|
         association = association_from_include(include)
         association if supported_association?(association.macro)

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.6.8'
+    VERSION = '0.6.13'
   end
 end

data/performance/mem.rb

@@ -0,0 +1,49 @@
+require 'memory_profiler'
+require_relative '../lib/restpack_serializer'
+
+class SimpleSerializer
+  include RestPack::Serializer
+  attributes :id, :title
+end
+
+simple_model = {
+  id: "123",
+  title: 'This is the title',
+}
+
+# warmup
+SimpleSerializer.as_json(simple_model)
+
+report = MemoryProfiler.report do
+  SimpleSerializer.as_json(simple_model)
+end
+
+puts "="*64
+puts "Simple Serializer:"
+puts "="*64
+
+report.pretty_print(detailed_report: false)
+
+class ComplexSerializer
+  include RestPack::Serializer
+
+  attributes :a, :b, :c, :d, :e, :f, :g, :h, :i, :j, :k, :l, :m, :n, :o, :p, :q, :r, :s, :t
+end
+
+complex_model = {
+  a: 1, b: 2, c: 3, d: 4, e: 5, f: 6, g: 7, h: 8, i: 9, j: 10,
+  k: 11, l: 12, m: 13, n: 14, o: 15, p: 16, q: 17, r: 18, s: 19, t: 20,
+}
+
+# warmup
+ComplexSerializer.as_json(complex_model)
+
+report = MemoryProfiler.report do
+  ComplexSerializer.as_json(complex_model)
+end
+
+puts "="*64
+puts "Complex Serializer:"
+puts "="*64
+
+report.pretty_print(detailed_report: false)

data/restpack_serializer.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'activesupport', ['>= 4.0.3', '< 6.0']
-  gem.add_dependency 'activerecord', ['>= 4.0.3', '< 6.0']
-  gem.add_dependency 'kaminari', '~> 0.17.0'
-  gem.add_dependency 'kaminari-mongoid', '~> 0.1'
+  gem.add_dependency 'activesupport', ['>= 4.0.3', '< 7.0']
+  gem.add_dependency 'activerecord', ['>= 4.0.3', '< 7.0']
+  gem.add_dependency 'kaminari', ['>= 0.17.0', '< 2.0']
 
   gem.add_development_dependency 'restpack_gem', '~> 0.0.9'
   gem.add_development_dependency 'rake', '~> 11.3'
@@ -30,5 +29,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'database_cleaner', '~> 1.5'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'bump'
-  gem.add_development_dependency 'protected_attributes_continued', '~> 1.2'
 end

data/spec/fixtures/db.rb

@@ -1,12 +1,13 @@
 require 'sqlite3'
 require 'active_record'
-require 'protected_attributes_continued'
 
 ActiveRecord::Base.establish_connection(
   :adapter => 'sqlite3',
   :database => 'test.db'
 )
 
+ActiveRecord::Migration.verbose = false
+
 ActiveRecord::Schema.define(:version => 1) do
   create_table "artists", :force => true do |t|
     t.string   "name"
@@ -66,8 +67,6 @@ end
 
 module MyApp
   class Artist < ActiveRecord::Base
-    attr_accessible :name, :website
-
     has_many :albums
     has_many :songs
     has_many :payments
@@ -76,7 +75,6 @@ module MyApp
   end
 
   class Album < ActiveRecord::Base
-    attr_accessible :title, :year, :artist
     scope :classic, -> { where("year < 1950") }
 
     belongs_to :artist
@@ -85,34 +83,27 @@ module MyApp
   end
 
   class AlbumReview < ActiveRecord::Base
-    attr_accessible :message
     belongs_to :album
   end
 
   class Song < ActiveRecord::Base
     default_scope -> { order(id: :asc) }
 
-    attr_accessible :title, :artist, :album
-
     belongs_to :artist
     belongs_to :album
   end
 
   class Payment < ActiveRecord::Base
-    attr_accessible :amount, :artist
-
     belongs_to :artist
     belongs_to :fan
   end
 
   class Fan < ActiveRecord::Base
-    attr_accessible :name
     has_many :payments
     has_many :artists, :through => :albums
   end
 
   class Stalker < ActiveRecord::Base
-    attr_accessible :name
     has_and_belongs_to_many :artists
   end
 end

data/spec/serializable/serializer_spec.rb

@@ -79,6 +79,27 @@ describe RestPack::Serializer do
     end
   end
 
+  context "serializer instance variables" do
+    class MemoizingSerializer
+      include RestPack::Serializer
+
+      attributes :id, :memoized_id
+
+      def memoized_id
+        @memoized_id ||= id
+      end
+    end
+
+    it "does not reuse instance variable values" do
+      people = [Person.new(id: 123), Person.new(id: 456)]
+      serialized = MemoizingSerializer.as_json(people)
+      expect(serialized).to eq([
+        { id: "123", memoized_id: "123" },
+        { id: "456", memoized_id: "456" }
+      ])
+    end
+  end
+
   class PersonSerializer
     include RestPack::Serializer
     attributes :id, :name, :description, :href, :admin_info, :string_keys
@@ -292,6 +313,20 @@ describe RestPack::Serializer do
     end
   end
 
+  describe "to_json" do
+    context "class method" do
+      it "delegates to as_json" do
+        expect(PersonSerializer.as_json(person).to_json).to eq(PersonSerializer.to_json(person))
+      end
+    end
+
+    context "instance method" do
+      it "delegates to as_json" do
+        expect(serializer.as_json(person).to_json).to eq(serializer.to_json(person))
+      end
+    end
+  end
+
   describe "#model_class" do
     it "extracts the Model name from the Serializer name" do
       expect(PersonSerializer.model_class).to eq(Person)

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ require './spec/fixtures/serializers'
 require './spec/support/factory'
 require 'database_cleaner'
 require 'coveralls'
+
+Coveralls::Output.silent = true unless ENV["CI"]
 Coveralls.wear!
 FactoryGirl.find_definitions
 
@@ -20,10 +22,6 @@ RSpec.configure do |config|
     DatabaseCleaner.strategy = :transaction
   end
 
-  config.before(:each, :js => true) do
-    DatabaseCleaner.strategy = :truncation
-  end
-
   config.before(:each) do
     DatabaseCleaner.start
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.13
 platform: ruby
 authors:
 - Gavin Joyce
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2021-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: 4.0.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 4.0.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: 4.0.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,35 +49,27 @@ dependencies:
         version: 4.0.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
-- !ruby/object:Gem::Dependency
-  name: kaminari-mongoid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: restpack_gem
   requirement: !ruby/object:Gem::Requirement
@@ -190,20 +182,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: protected_attributes_continued
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 description: Model serialization, paging, side-loading and filtering
 email:
 - gavinjoyce@gmail.com
@@ -211,10 +189,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -235,6 +213,7 @@ files:
 - lib/restpack_serializer/serializable/single.rb
 - lib/restpack_serializer/serializable/sortable.rb
 - lib/restpack_serializer/version.rb
+- performance/mem.rb
 - performance/perf.rb
 - restpack_serializer.gemspec
 - spec/factory/factory_spec.rb
@@ -259,7 +238,7 @@ files:
 homepage: https://github.com/RestPack
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -274,9 +253,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Model serialization, paging, side-loading and filtering
 test_files:

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.1
-script: bundle exec rake test