alba 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3999a63b9564e6bf0a7b00dfeb64a19d6d076c94047f7ee869a4ac4a38c6646
-  data.tar.gz: dd7244bf63111e4795639a62dac91a744e51adb38f6a88d851c9cc6de3043dc0
+  metadata.gz: 3fc2741e03be6373aa324768358a1acf4b713ec43bba5daf80d133a08d0cc12b
+  data.tar.gz: 7228dc09384d5d4d6e99456a6f14d6e0cb3d678483cd59a7439d6a150f463e4b
 SHA512:
-  metadata.gz: f93aaadf9b8fae4b9ae334f87647c3b0f1645147fd237b62f12451f4306f5cb6699ed25c935b563b68ab45c965bb1cfb8f2c73e08b23899a477384c37124d325
-  data.tar.gz: adb456a4796782e725bffa5720d1b5e6f831c1e0ec215721a814b331890f4a1d0ebe592e7e906239138729dd81586ad6e1c850ece61c5495ce829551feada9a1
+  metadata.gz: 0fb68a3a1c786aa1b776246d08fd23bada8d4c7fcff0ea2ba33a49a1410d9b1e839407450ff2d1137f531a8e80738977369a4f857199d3bb65c98b140d7cd6b9
+  data.tar.gz: fcfb93544bab6b48e6ae24946992231a6023df52763d807dad276f1468c1ce77d255fe637de3a72efacffe2d20915d203ddc1f247908c4f6e4d69ae6ea4c97da

data/.github/workflows/main.yml

@@ -8,11 +8,16 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        ruby: [2.5, 2.6, 2.7, 3.0, head, truffleruby]
+        ruby: [2.5, 2.6, 2.7, 3.0, head, jruby, truffleruby]
+        gemfile: [all, without_active_support, without_oj]
         exclude:
+          - os: windows-latest
+            ruby: jruby
           - os: windows-latest
             ruby: truffleruby
     runs-on: ${{ matrix.os }}
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -23,3 +28,7 @@ jobs:
     - name: Run the default task
       run: |
         bundle exec rake
+    - name: CodeCov
+      uses: codecov/codecov-action@v1
+      with:
+        files: ./coverage/coverage.xml

data/.rubocop.yml

@@ -42,6 +42,11 @@ Metrics/ParameterLists:
   Exclude:
     - 'lib/alba/resource.rb'
 
+# We need to eval resource code to test errors on resource classes
+Security/Eval:
+  Exclude:
+    - 'test/**/*.rb'
+
 Style/ConstantVisibility:
   Exclude:
     - 'lib/alba/version.rb'
@@ -61,3 +66,7 @@ Style/InlineComment:
 
 Style/MethodCallWithArgsParentheses:
   Enabled: false
+
+# There are so many cases we just want `if` expression!
+Style/MissingElse:
+  EnforcedStyle: case

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.1] - 2021-04-15
+
+- [Fix] Don't cache resource class for `Alba.serialize` [9ed5253]
+- [Improve] Warn when `ActiveSupport` or `Oj` are absent [d3ab3eb]
+- [Fix] Delete unreachable `to_hash` method on Association [1ba1f90]
+- [Fix] Stringify key before transforming [b4eb79e]
+- [Misc] Support Ruby 2.5.0 and above, not 2.5.7 and above [43f1d17]
+- [Fix] Remove accidentally added `p` debug [5d0324b]
+
 ## [1.0.0] - 2021-04-07
 
 This is the first major release of Alba and it includes so many features. To see all the features you can have a look at [README](https://github.com/okuramasafumi/alba/blob/master/README.md#features).

data/Gemfile

@@ -4,14 +4,18 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'activesupport', require: false # For backend
-gem 'coveralls', require: false # For test coverage
 gem 'minitest', '~> 5.14' # For test
-gem 'oj', '~> 3.11', platform: :ruby, require: false # For backend
 gem 'rake', '~> 13.0' # For test and automation
 gem 'rubocop', '>= 0.79.0', require: false # For lint
 gem 'rubocop-minitest', '~> 0.11.0', require: false # For lint
 gem 'rubocop-performance', '~> 1.10.1', require: false # For lint
 gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
 gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint
-gem 'ruby-prof', require: false # For performance profiling
+gem 'simplecov', '~> 0.21.0', require: false # For test coverage
+gem 'simplecov-cobertura', require: false # For test coverage
 gem 'yard', require: false
+
+platforms :ruby do
+  gem 'oj', '~> 3.11', require: false # For backend
+  gem 'ruby-prof', require: false # For performance profiling
+end

data/README.md

@@ -1,28 +1,38 @@
 [![Gem Version](https://badge.fury.io/rb/alba.svg)](https://badge.fury.io/rb/alba)
-[![Build Status](https://travis-ci.com/okuramasafumi/alba.svg?branch=master)](https://travis-ci.com/okuramasafumi/alba)
-[![Coverage Status](https://coveralls.io/repos/github/okuramasafumi/alba/badge.svg?branch=master)](https://coveralls.io/github/okuramasafumi/alba?branch=master)
+[![CI](https://github.com/okuramasafumi/alba/actions/workflows/main.yml/badge.svg)](https://github.com/okuramasafumi/alba/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/okuramasafumi/alba/branch/master/graph/badge.svg?token=3D3HEZ5OXT)](https://codecov.io/gh/okuramasafumi/alba)
 [![Maintainability](https://api.codeclimate.com/v1/badges/fdab4cc0de0b9addcfe8/maintainability)](https://codeclimate.com/github/okuramasafumi/alba/maintainability)
 ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/okuramasafumi/alba)
 ![GitHub](https://img.shields.io/github/license/okuramasafumi/alba)
 
 # Alba
 
-`Alba` is the fastest JSON serializer for Ruby.
+`Alba` is the fastest JSON serializer for Ruby, JRuby an TruffleRuby.
 
-## Why yet another JSON serializer?
+## Discussions
 
-We know that there are several other JSON serializers for Ruby around, but none of them made us satisfied.
+Alba uses [GitHub Discussions](https://github.com/okuramasafumi/alba/discussions) to openly discuss the project.
 
-Alba has some advantages over other JSON serializers which we've wanted to have.
+If you've already used Alba, please consider posting your thoughts and feelings on [Feedback](https://github.com/okuramasafumi/alba/discussions/categories/feedback). The fact that you enjoy using Alba gives me energy to keep developing Alba!
 
-### Easy to understand
+If you have feature requests or interesting ideas, join us with [Ideas](https://github.com/okuramasafumi/alba/discussions/categories/ideas). Let's make Alba even better, together!
 
-DSL is great. It makes the coding experience natural and intuitive. However, remembering lots of DSL requires us a lot of effort. Unfortunately, most of the existing libraries have implemented their features via DSL and it's not easy to understand how they behave entirely. Alba's core DSL are only four (`attributes`, `attribute`, `one` and `many`) so it's easy to understand how to use.
+## Why Alba?
 
-### Performance
+Because it's fast, flexible and well-maintained!
+
+### Fast
 
 Alba is faster than most of the alternatives. We have a [benchmark](https://github.com/okuramasafumi/alba/tree/master/benchmark).
 
+### Flexible
+
+Alba provides a small set of DSL to define your serialization logic. It also provides methods you can override to alter and filter serialized hash so that you have full control over the result.
+
+### Maintained
+
+Alba is well-maintained and adds features quickly. [Coverage Status](https://coveralls.io/github/okuramasafumi/alba?branch=master) and [CodeClimate Maintainability](https://codeclimate.com/github/okuramasafumi/alba/maintainability) show the code base is quite healthy.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -41,7 +51,7 @@ Or install it yourself as:
 
 ## Supported Ruby versions
 
-Alba supports CRuby 2.5.7 and higher and latest TruffleRuby.
+Alba supports CRuby 2.5 and higher and latest JRuby and TruffleRuby.
 
 ## Documentation
 
@@ -440,6 +450,10 @@ Alba.on_error do |error, object, key, attribute, resource_class|
 end
 ```
 
+### Caching
+
+Currently, Alba doesn't support caching, primarily due to the behavior of `ActiveRecord::Relation`'s cache. See [the issue](https://github.com/rails/rails/issues/41784).
+
 ## Comparison
 
 Alba is faster than alternatives.
@@ -457,6 +471,13 @@ Alba.backend = :active_support
 
 The name "Alba" comes from "albatross", a kind of birds. In Japanese, this bird is called "Aho-dori", which means "stupid bird". I find it funny because in fact albatrosses fly really fast. I hope Alba looks stupid but in fact it does its job quick.
 
+## Pioneers
+
+There are great pioneers in Ruby's ecosystem which does basically the same thing as Alba does. To name a few:
+
+* [ActiveModelSerializers](https://github.com/rails-api/active_model_serializers) a.k.a AMS, the most famous implementation of JSON serializer for Ruby
+* [Blueprinter](https://github.com/procore/blueprinter) shares some concepts with Alba
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,10 +1,13 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+ENV["BUNDLE_GEMFILE"] = File.expand_path("gemfiles/all.gemfile") if ENV["BUNDLE_GEMFILE"] == File.expand_path("Gemfile") || ENV["BUNDLE_GEMFILE"].empty? || ENV["BUNDLE_GEMFILE"].nil?
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  file_list = ENV["BUNDLE_GEMFILE"] == File.expand_path("gemfiles/all.gemfile") ? FileList["test/**/*_test.rb"] : FileList["test/dependencies/test_dependencies.rb"]
+  t.test_files = file_list
 end
 
 task :default => :test

data/alba.gemspec

@@ -10,11 +10,11 @@ Gem::Specification.new do |spec|
   spec.description   = "Alba is designed to be a simple, easy to use and fast alternative to existing JSON serializers. Its performance is better than almost all gems which do similar things. The internal is so simple that it's easy to hack and maintain."
   spec.homepage      = 'https://github.com/okuramasafumi/alba'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.7')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/okuramasafumi/alba'
-  spec.metadata['changelog_uri'] = 'https://github.com/okuramasafumi/alba/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/okuramasafumi/alba/blob/master/CHANGELOG.md'
 
   # 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.

data/gemfiles/all.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'activesupport', require: false # For backend
+gem 'minitest', '~> 5.14' # For test
+gem 'rake', '~> 13.0' # For test and automation
+gem 'rubocop', '>= 0.79.0', require: false # For lint
+gem 'rubocop-minitest', '~> 0.11.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.10.1', require: false # For lint
+gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
+gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint
+gem 'simplecov', '~> 0.21.0', require: false # For test coverage
+gem 'simplecov-cobertura', require: false # For test coverage
+gem 'yard', require: false
+
+platforms :ruby do
+  gem 'oj', '~> 3.11', require: false # For backend
+  gem 'ruby-prof', require: false # For performance profiling
+end

data/gemfiles/without_active_support.gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gem 'minitest', '~> 5.14' # For test
+gem 'rake', '~> 13.0' # For test and automation
+gem 'rubocop', '>= 0.79.0', require: false # For lint
+gem 'rubocop-minitest', '~> 0.11.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.10.1', require: false # For lint
+gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
+gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint
+gem 'simplecov', '~> 0.21.0', require: false # For test coverage
+gem 'simplecov-cobertura', require: false # For test coverage
+gem 'yard', require: false
+
+platforms :ruby do
+  gem 'oj', '~> 3.11', require: false # For backend
+  gem 'ruby-prof', require: false # For performance profiling
+end

data/gemfiles/without_oj.gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gem 'activesupport', require: false # For backend
+gem 'minitest', '~> 5.14' # For test
+gem 'rake', '~> 13.0' # For test and automation
+gem 'rubocop', '>= 0.79.0', require: false # For lint
+gem 'rubocop-minitest', '~> 0.11.0', require: false # For lint
+gem 'rubocop-performance', '~> 1.10.1', require: false # For lint
+gem 'rubocop-rake', '>= 0.5.1', require: false # For lint
+gem 'rubocop-sensible', '~> 0.3.0', require: false # For lint
+gem 'simplecov', '~> 0.21.0', require: false # For test coverage
+gem 'simplecov-cobertura', require: false # For test coverage
+gem 'yard', require: false
+
+platforms :ruby do
+  gem 'ruby-prof', require: false # For performance profiling
+end

data/lib/alba.rb

@@ -33,8 +33,10 @@ module Alba
     def serialize(object, key: nil, &block)
       raise ArgumentError, 'Block required' unless block
 
-      resource_class.class_eval(&block)
-      resource = resource_class.new(object)
+      klass = Class.new
+      klass.include(Alba::Resource)
+      klass.class_eval(&block)
+      resource = klass.new(object)
       resource.serialize(key: key)
     end
 
@@ -61,7 +63,6 @@ module Alba
       raise ArgumentError, 'You cannot specify error handler with both Symbol and block' if handler && block
       raise ArgumentError, 'You must specify error handler with either Symbol or block' unless handler || block
 
-      p block if block
       @_on_error = handler || block
     end
 
@@ -84,6 +85,7 @@ module Alba
       require 'oj'
       ->(hash) { Oj.dump(hash, mode: :strict) }
     rescue LoadError
+      Kernel.warn '`Oj` is not installed, falling back to default JSON encoder.'
       default_encoder
     end
 
@@ -91,6 +93,7 @@ module Alba
       require 'active_support/json'
       ->(hash) { ActiveSupport::JSON.encode(hash) }
     rescue LoadError
+      Kernel.warn '`ActiveSupport` is not installed, falling back to default JSON encoder.'
       default_encoder
     end
 
@@ -100,13 +103,6 @@ module Alba
         JSON.dump(hash)
       end
     end
-
-    def resource_class
-      @resource_class ||= begin
-        klass = Class.new
-        klass.include(Alba::Resource)
-      end
-    end
   end
 
   @encoder = default_encoder

data/lib/alba/association.rb

@@ -25,11 +25,6 @@ module Alba
       end
     end
 
-    # @abstract
-    def to_hash
-      :not_implemented
-    end
-
     private
 
     def constantize(resource)

data/lib/alba/key_transformer.rb

@@ -16,6 +16,7 @@ module Alba
     # @return [String] transformed key
     # @raise [Alba::Error] when transform_type is not supported
     def transform(key, transform_type)
+      key = key.to_s
       case transform_type
       when :camel
         ActiveSupport::Inflector.camelize(key)

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies: []
 description: Alba is designed to be a simple, easy to use and fast alternative to
   existing JSON serializers. Its performance is better than almost all gems which
@@ -33,6 +33,9 @@ files:
 - benchmark/local.rb
 - bin/console
 - bin/setup
+- gemfiles/all.gemfile
+- gemfiles/without_active_support.gemfile
+- gemfiles/without_oj.gemfile
 - lib/alba.rb
 - lib/alba/association.rb
 - lib/alba/key_transformer.rb
@@ -47,7 +50,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/okuramasafumi/alba
   source_code_uri: https://github.com/okuramasafumi/alba
-  changelog_uri: https://github.com/okuramasafumi/alba/CHANGELOG.md
+  changelog_uri: https://github.com/okuramasafumi/alba/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -56,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.7
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="