surrealist 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d601273dc48757785a2356db0353254bf692deb46ed7df9e128aa329eef928
-  data.tar.gz: 20bdde30e93d282483c88beb6de145fb198e332a3cf73379fa0f96d176a99895
+  metadata.gz: 2b3537308a609571f4a82a0f35792244135fd0fe249b85b408d444dc46c4ecf4
+  data.tar.gz: 8c50d83dbbe452bb55f70eadccc69ad024a6055e2ee1e60aa29f768c3281bfbc
 SHA512:
-  metadata.gz: bec9aaebea9985002b24625c3d99316137344794cbab43a2e04d8fa685eda6c46a10f7dc072b37cbfef2428e6a3a0abbb5a7223823feb0ca546fd31128aab7a2
-  data.tar.gz: 9c47eb33373325982ab09eeba0aae2dacf963bdf27f0291d79301ea3f5cf1495369d9c7d9f808288cc6dcf596e4dcab409481255909e6dcc266acdf4e43b6c2b
+  metadata.gz: 3b5a167801a3393667d0fae41727f3512be479bfcdfb26426615a422173ff417b186ea59d067550db2f2f44af49a789450c5056bad07de500849e8b21ae46e0e
+  data.tar.gz: 9c3923e37180abfaa4159dbc5f55b393f6ab88927803bf639ffa1825cbf5aa16e8a61199a7dc19e65f8586e26666b6208f4e995826d6a8ecaa03b9868ce01f57

data/.rubocop.yml

@@ -33,9 +33,6 @@ Layout/MultilineOperationIndentation:
 Layout/SpaceInLambdaLiteral:
   EnforcedStyle: require_space
 
-Layout/SpaceInsideBrackets:
-  Enabled: false
-
 # Lint
 Lint/AmbiguousBlockAssociation:
   Enabled: false
@@ -97,6 +94,10 @@ Performance/UnfreezeString:
 
 # Style
 
+# ¯\_(ツ)_/¯
+Style/AsciiComments:
+  Enabled: false
+
 Style/MixinUsage:
   Exclude:
     - spec/**/*rb
@@ -152,3 +153,7 @@ Style/TrailingCommaInLiteral:
 
 Style/MethodMissing:
   Enabled: false
+
+Style/EvalWithLocation:
+  Exclude:
+    - spec/**/*.rb

data/.travis.yml

@@ -10,15 +10,10 @@ matrix:
       gemfile: Gemfile
     - rvm: 2.5.0
       gemfile: Gemfile
-    - rvm: 2.4.2
+    - rvm: 2.4.3
       gemfile: Gemfile
-    - rvm: 2.4.0
+    - rvm: 2.3.6
       gemfile: Gemfile
-    - rvm: 2.3.5
-      gemfile: Gemfile
-    - rvm: 2.3.1
-      gemfile: Gemfile
-    - rvm: 2.2.5
-      gemfile: gemfiles/activerecord42.gemfile
-    - rvm: 2.2.0
+    - rvm: 2.2.9
       gemfile: gemfiles/activerecord42.gemfile
+

data/CHANGELOG.md

@@ -1,36 +1,48 @@
+# 1.1.0
+
+## Added
+* Configuration of default serialization params ([@nesaulov][]) [#77](https://github.com/nesaulov/surrealist/pull/77)
+* DSL for custom serializers context ([@nesaulov][]) [#80](https://github.com/nesaulov/surrealist/pull/80)
+
+## Fixed
+* Fix failing serialization with sequel & custom serializers ([@azhi][]) [#84](https://github.com/nesaulov/surrealist/pull/84)
+
+## Miscellaneous
+* Pin Oj version to 3.4.0 [#79](https://github.com/nesaulov/surrealist/pull/79)
+
 # 1.0.0
 
 ## Added
-* `#build_schema` for collections from `Surrealist::Serializer` (@nesaulov) #74
+* `#build_schema` for collections from `Surrealist::Serializer` ([@nesaulov][]) [#74](https://github.com/nesaulov/surrealist/pull/74)
 * Oj dependency
-* Multiple serializers API (@nulldef) #66
+* Multiple serializers API ([@nulldef][]) [#66](https://github.com/nesaulov/surrealist/pull/66)
 
 ## Miscellaneous
 * Benchmarks for Surrealist vs AMS
-* A lot of memory & performance optimizations (@nesaulov) #64
+* A lot of memory & performance optimizations ([@nesaulov][]) [#64](https://github.com/nesaulov/surrealist/pull/64)
 
 # 0.4.0
 
 ## Added
-* Introduce an abstract serializer class (@nesaulov) #61
-* Full integration for Sequel (@nesaulov) #47
-* Integration for ROM 4.x (@nesaulov) #56
-* Ruby 2.5 support (@nesaulov) #57
+* Introduce an abstract serializer class ([@nesaulov][]) [#61](https://github.com/nesaulov/surrealist/pull/61)
+* Full integration for Sequel ([@nesaulov][]) [#47](https://github.com/nesaulov/surrealist/pull/47)
+* Integration for ROM 4.x ([@nesaulov][]) [#56](https://github.com/nesaulov/surrealist/pull/56)
+* Ruby 2.5 support ([@nesaulov][]) [#57](https://github.com/nesaulov/surrealist/pull/57)
 
 ## Miscellaneous
-* Memory & performance optimizations (@nesaulov) #51
-* Refactorings (@nulldef) #55
+* Memory & performance optimizations ([@nesaulov][]) [#51](https://github.com/nesaulov/surrealist/pull/51)
+* Refactorings ([@nulldef][]) [#55](https://github.com/nesaulov/surrealist/pull/55)
 
 # 0.3.0
 
 ## Added
-* Full integration for ActiveRecord (@nesaulov, @AlessandroMinali) #37
-* Full integration for ROM <= 3 (@nesaulov, @AlessandroMinali) #37
-* `root` optional argument (@chrisatanasian) #32
-* Nested records surrealization (@AlessandroMinali) #34
+* Full integration for ActiveRecord ([@nesaulov][], [@AlessandroMinali][]) [#37](https://github.com/nesaulov/surrealist/pull/37)
+* Full integration for ROM <= 3 ([@nesaulov][], [@AlessandroMinali][]) [#37](https://github.com/nesaulov/surrealist/pull/37)
+* `root` optional argument ([@chrisatanasian][]) [#32](https://github.com/nesaulov/surrealist/pull/32)
+* Nested records surrealization ([@AlessandroMinali][]) [#34](https://github.com/nesaulov/surrealist/pull/34)
 
 ## Fixed
-* Dependencies update (@nesaulov) #48
+* Dependencies update ([@nesaulov][]) [#48](https://github.com/nesaulov/surrealist/pull/48)
 
 # 0.2.0
 ## Added
@@ -65,5 +77,10 @@
 * Allow nil values by default.
 * Allow nested objects.
 
+[@nesaulov]: https://github.com/nesaulov
+[@AlessandroMinali]: https://github.com/AlessandroMinali
+[@nulldef]: https://github.com/nulldef
+[@azhi]: https://github.com/azhi
+[@chrisatanasian]: https://github.com/chrisatanasian
 
 

data/README.md

@@ -6,7 +6,7 @@
 [![Open Source Helpers](https://www.codetriage.com/nesaulov/surrealist/badges/users.svg)](https://www.codetriage.com/nesaulov/surrealist)
 
 ![Surrealist](surrealist-icon.png)
- 
+
 A gem that provides DSL for serialization of plain old Ruby objects to JSON in a declarative style
 by defining a `json_schema`. It also provides a trivial type checking in the runtime before serialization.
 [Yard documentation](http://www.rubydoc.info/github/nesaulov/surrealist/master)
@@ -31,18 +31,19 @@ to serialize nested objects and structures. [Introductory blogpost.](https://med
     * [ActiveRecord](#activerecord)
     * [ROM](#rom)
     * [Sequel](#sequel)
-  * [Usage with Dry::Types](#usage-with-drytypes)  
+  * [Usage with Dry::Types](#usage-with-drytypes)
   * [Delegating Surrealization](#delegating-surrealization)
   * [Optional arguments](#optional-arguments)
     * [Camelization](#camelization)
     * [Include root](#include-root)
     * [Root](#root)
     * [Include namespaces](#include-namespaces)
+  * [Configuration](#configuration)
   * [Bool and Any](#bool-and-any)
   * [Type errors](#type-errors)
   * [Undefined methods in schema](#undefined-methods-in-schema)
   * [Other notes](#other-notes)
-* [Roadmap](#roadmap)  
+* [Roadmap](#roadmap)
 * [Contributing](#contributing)
 * [Credits](#credits)
 * [Authors](#authors)
@@ -79,15 +80,15 @@ that will be used for type-checks.
 ``` ruby
 class Person
   include Surrealist
- 
+
   json_schema do
     { name: String, age: Integer }
   end
- 
+
   def name
     'John Doe'
   end
- 
+
   def age
     42
   end
@@ -106,7 +107,7 @@ Person.new.surrealize
 ``` ruby
 class Person
   include Surrealist
- 
+
   json_schema do
     {
       foo: String,
@@ -121,7 +122,7 @@ class Person
   end
   # ... method definitions
 end
- 
+
 Person.find_by(email: 'example@email.com').surrealize
 # => '{ "foo": "Some string", "name": "John Doe", "nested": { "at": { "any": 42, "level": true } } }'
 ```
@@ -133,7 +134,7 @@ define a method that calls nested object:
 ``` ruby
 class User
   include Surrealist
-  
+
   json_schema do
     {
       name: String,
@@ -143,11 +144,11 @@ class User
       },
     }
   end
- 
+
   def name
     'John Doe'
   end
- 
+
   def credit_card
     # Assuming that instance of a CreditCard has methods #number and #cvv defined
     CreditCard.find_by(holder: name)
@@ -164,20 +165,20 @@ Since 0.2.0 Surrealist has API for collection serialization. Example for ActiveR
 ``` ruby
 class User < ActiveRecord::Base
   include Surrealist
- 
+
   json_schema do
     { name: String, age: Integer }
   end
 end
- 
+
 users = User.all
 # => [#<User:0x007fa1485de878 id: 1, name: "Nikita", age: 23>, #<User:0x007fa1485de5f8 id: 2, name: "Alessandro", age: 24>]
- 
+
 Surrealist.surrealize_collection(users)
 # => '[{ "name": "Nikita", "age": 23 }, { "name": "Alessandro", "age": 24 }]'
 ```
-You can find motivation behind introducing new API versus monkey-patching [here](https://alessandrominali.github.io/monkey_patching_real_example).  
-`#surrealize_collection` works for all data structures that respond to `#each`. All ActiveRecord
+You can find motivation behind introducing new API versus monkey-patching [here](https://alessandrominali.github.io/monkey_patching_real_example).
+`#surrealize_collection` works for all data structures that behave like `Enumerable`. All ActiveRecord
 features (like associations, inheritance etc) are supported and covered. Further reading: [working with ORMs](#working-with-orms).
 All optional arguments (`camelize`, `include_root` etc) are also supported.
 
@@ -195,65 +196,84 @@ will inherit from `Surrealist::Serializer`. To point to that class from the mode
 ``` ruby
 class CatSerializer < Surrealist::Serializer
   json_schema { { age: Integer, age_group: String } }
- 
+
   def age_group
     age <= 5 ? 'kitten' : 'cat'
   end
 end
- 
+
 class Cat
   include Surrealist
   attr_reader :age
- 
+
   surrealize_with CatSerializer
- 
+
   def initialize(age)
     @age = age
   end
 end
- 
+
 Cat.new(12).surrealize # Implicit usage through .surrealize_with
 # => '{ "age": 12, "age_group": "cat" }'
- 
+
 CatSerializer.new(Cat.new(3)).surrealize # explicit usage of CatSerializer
 # => '{ "age": 3, "age_group": "kitten" }'
 ```
-The constructor of `Surrealist::Serializer` takes two arguments: serializable model (or collection) and 
+The constructor of `Surrealist::Serializer` takes two arguments: serializable model (or collection) and
 a context hash. So if there is an object that is not coupled to serializable model
-but it is still necessary for constructing JSON, you can pass it to constructor as a hash. It will 
-be available in the serializer in the `context` hash. 
+but it is still necessary for constructing JSON, you can pass it to constructor as a hash. It will
+be available in the serializer in the `context` hash.
 ``` ruby
 class IncomeSerializer < Surrealist::Serializer
   json_schema { { amount: Integer } }
-  
+
   def amount
     current_user.guest? ? 100000000 : object.amount
   end
-  
+
   def current_user
     context[:current_user]
   end
 end
- 
+
 class Income
   include Surrealist
   surrealize_with IncomeSerializer
-   
+
   attr_reader :amount
-   
+
   def initialize(amount)
     @amount = amount
-  end  
+  end
 end
- 
+
 income = Income.new(200)
 IncomeSerializer.new(income, current_user: GuestUser.new).surrealize
 # => '{ "amount": 100000000 }'
- 
+
 IncomeSerializer.new(income, current_user: User.find(3)).surrealize
 # => '{ "amount": 200 }'
 ```
-
+If you happen to pass a context to a serializer, there is a handy DSL to reduce the number of methods
+you have to define yourself. DSL looks as follows
+``` ruby
+class IncomeSerializer < Surrealist::Serializer
+  serializer_context :current_user
+  json_schema { { amount: Integer } }
+  
+  def amount
+    current_user.guest? ? 100000000 : object.amount
+  end
+end
+``` 
+`.serializer_context` takes an array of symbols and dynamically defines instance methods
+that read values from the context hash. So `.serializer_context :current_user` will become
+``` ruby
+def current_user
+  context[:current_user]
+end
+``` 
+There is also an alias in the plural form: `.serializer_contexts`.
 ### Multiple serializers
 
 You can define several custom serializers for one object and use it in different cases. Just mark it with a tag:
@@ -269,10 +289,10 @@ end
 
 class Post
   include Surrealist
- 
+
   surrealize_with PostSerializer
   surrealize_with PreviewSerializer, tag: :preview
- 
+
   attr_reader :id, :title, :author
 end
 ```
@@ -282,7 +302,7 @@ And then specify serializer's tag with `for` argument:
 author = Struct.new(:name).new("John")
 post = Post.new(1, "Ruby is awesome", author)
 post.surrealize # => '{ "id": 1, "title": "Ruby is awesome", author: { name: "John" } }'
- 
+
 post.surrealize(for: :preview) # => '{ "id": 1, "title": "Ruby is awesome" }'
 ```
 Or specify serializer explicitly with `serializer` argument:
@@ -318,45 +338,45 @@ Methods that return instances:
 .find_by
 .find_by!
 .take!
-.first 
+.first
 .first!
-.second 
+.second
 .second!
-.third 
+.third
 .third!
-.fourth 
+.fourth
 .fourth!
-.fifth 
+.fifth
 .fifth!
-.forty_two 
+.forty_two
 .forty_two!
-.last 
+.last
 .last!
-.third_to_last 
+.third_to_last
 .third_to_last!
-.second_to_last 
+.second_to_last
 .second_to_last!
 ```
 Methods that return collections:
 ``` ruby
 .all
-.where  
-.where_not 
-.order  
-.take  
-.limit  
-.offset  
-.lock  
-.readonly 
-.reorder  
-.distinct 
-.find_each 
-.select  
-.group  
-.order  
-.except  
-.extending 
-.having  
+.where
+.where_not
+.order
+.take
+.limit
+.offset
+.lock
+.readonly
+.reorder
+.distinct
+.find_each
+.select
+.group
+.order
+.except
+.extending
+.having
 .references
 .includes
 .joins
@@ -376,7 +396,7 @@ container = ROM.container(:sql, ['sqlite::memory']) do |conf|
   end
   # ...
 end
- 
+
 users = UserRepo.new(container).users
 # => #<ROM::Relation[Users] name=ROM::Relation::Name(users) dataset=#<Sequel::SQLite::Dataset: "SELECT `users`.`id`, `users`.`name`, `users`.`email` FROM `users` ORDER BY `users`.`id`">>
 ```
@@ -385,67 +405,67 @@ Basically, there are several ways to fetch/represent data in ROM:
 # With json_schema defined in ROM::Struct::User
 class ROM::Struct::User < ROM::Struct
   include Surrealist
- 
+
   json_schema { { name: String } }
-end 
- 
+end
+
 users.to_a.first # => #<ROM::Struct::User id=1 name="Jane Struct" email="jane@struct.rom">
 users.to_a.first.surrealize # => "{\"name\":\"Jane Struct\"}"
- 
+
 users.where(id: 1).first # => #<ROM::Struct::User id=1 name="Jane Struct" email="jane@struct.rom">
 users.where(id: 1).first.surrealize # => "{\"name\":\"Jane Struct\"}"
- 
+
 Surrealist.surrealize_collection(users.to_a) # => "[{\"name\":\"Jane Struct\"},{\"name\":\"Dane As\"},{\"name\":\"Jack Mapper\"}]"
- 
+
 # using ROM::Struct::Model#as(Representative) with json_schema defined in representative
 class RomUser < Dry::Struct
   include Surrealist
- 
+
   attribute :name, String
   attribute :email, String
- 
+
   json_schema { { email: String } }
 end
- 
+
 # ROM 3.x
 rom_users = users.as(RomUser).to_a
- 
+
 # ROM 4.x
 rom_users = users.map_to(RomUser).to_a
- 
+
 rom_users[1].surrealize # => "{\"email\":\"dane@as.rom\"}"
 Surrealist.surrealize_collection(rom_users) # => "[{\"email\":\"jane@struct.rom\"},{\"email\":\"dane@as.rom\"},{\"email\":\"jack@mapper.rom\"}]"
-   
+
 # using Mappers
 class UserModel
   include Surrealist
- 
+
   json_schema { { id: Integer, email: String } }
- 
+
   attr_reader :id, :name, :email
- 
+
   def initialize(attributes)
     @id, @name, @email = attributes.values_at(:id, :name, :email)
   end
 end
- 
+
 class UsersMapper < ROM::Mapper
   register_as :user_obj
   relation :users
   model UserModel
 end
-  
+
 # ROM 3.x
 mapped = users.as(:user_obj)
 # ROM 4.x
 mapped = users.map_with(:user_obj)
-  
+
 mapped.to_a[2] # => #<UserModel:0x00007f8ec19fb3c8 @email="jack@mapper.rom", @id=3, @name="Jack Mapper">
 mapped.where(id: 3).first # => #<UserModel:0x00007f8ec19fb3c8 @email="jack@mapper.rom", @id=3, @name="Jack Mapper">
 mapped.to_a[2].surrealize # => "{\"id\":3,\"email\":\"jack@mapper.rom\"}"
-Surrealist.surrealize_collection(mapped.to_a) # => "[{\"email\":\"jane@struct.rom\"},{\"email\":\"dane@as.rom\"},{\"email\":\"jack@mapper.rom\"}]"  
-Surrealist.surrealize_collection(mapped.where { id < 4 }.to_a) # => "[{\"email\":\"jane@struct.rom\"},{\"email\":\"dane@as.rom\"},{\"email\":\"jack@mapper.rom\"}]" 
-``` 
+Surrealist.surrealize_collection(mapped.to_a) # => "[{\"email\":\"jane@struct.rom\"},{\"email\":\"dane@as.rom\"},{\"email\":\"jack@mapper.rom\"}]"
+Surrealist.surrealize_collection(mapped.where { id < 4 }.to_a) # => "[{\"email\":\"jane@struct.rom\"},{\"email\":\"dane@as.rom\"},{\"email\":\"jack@mapper.rom\"}]"
+```
 
 #### Sequel
 Basically, Sequel returns instances only on `.first`, `.last`, `.[]` and `.with_pk!`. Collections are returned for all other methods.
@@ -464,7 +484,7 @@ require 'dry-types'
 
 class Car
   include Surrealist
- 
+
   json_schema do
     {
       age:            Types::Coercible::Int,
@@ -475,25 +495,25 @@ class Car
       previous_owner: Types::String,
     }
   end
- 
+
   def age;
     '7'
   end
- 
+
   def previous_owner;
     'John Doe'
   end
- 
+
   def horsepower;
     140
   end
- 
+
   def brand;
     'Toyota'
   end
- 
+
   def doors; end
- 
+
   def fuel_system;
     'Direct injection'
   end
@@ -508,11 +528,11 @@ You can share the `json_schema` between classes:
 ``` ruby
 class Host
   include Surrealist
- 
+
   json_schema do
     { name: String }
   end
- 
+
   def name
     'Host'
   end
@@ -520,7 +540,7 @@ end
 
 class Guest
   delegate_surrealization_to Host
- 
+
   def name
     'Guest'
   end
@@ -538,7 +558,7 @@ in this case you have to `include Surrealist` in class that delegates schema as
 class Potato
   include Surrealist
   delegate_surrealization_to Host
- 
+
   def name
     'Potato'
   end
@@ -566,16 +586,16 @@ surrealizable object.
 ``` ruby
 class Cat
   include Surrealist
- 
+
   json_schema do
     { weight: String }
   end
- 
+
   def weight
     '3 kilos'
   end
 end
- 
+
 Cat.new.surrealize(include_root: true)
 # => '{ "cat": { "weight": "3 kilos" } }'
 ```
@@ -584,11 +604,11 @@ With nested classes the last namespace will be taken as root key:
 class Animal
   class Dog
     include Surrealist
- 
+
     json_schema do
       { breed: String }
     end
- 
+
     def breed
       'Collie'
     end
@@ -605,11 +625,11 @@ to `#surrealize` or `#build_schema`. The `root` argument will be stripped of whi
 ``` ruby
 class Cat
   include Surrealist
- 
+
   json_schema do
     { weight: String }
   end
- 
+
   def weight
     '3 kilos'
   end
@@ -633,20 +653,20 @@ You can build wrap schema into a nested hash from namespaces of the object's cla
 ``` ruby
 class BusinessSystem::Cashout::ReportSystem::Withdraws
   include Surrealist
- 
+
   json_schema do
     { withdraws_amount: Integer }
   end
- 
+
   def withdraws_amount
     34
   end
 end
- 
+
 withdraws = BusinessSystem::Cashout::ReportSystem::Withdraws.new
- 
+
 withdraws.surrealize(include_namespaces: true)
-# => '{ "business_system": { "cashout": { "report_system": { "withdraws": { "withdraws_amount": 34 } } } } }' 
+# => '{ "business_system": { "cashout": { "report_system": { "withdraws": { "withdraws_amount": 34 } } } } }'
 ```
 By default all namespaces will be taken. If you want you can explicitly specify the level of nesting:
 ``` ruby
@@ -654,6 +674,31 @@ withdraws.surrealize(include_namespaces: true, namespaces_nesting_level: 2)
 # => '{ "report_system": { "withdraws": { "withdraws_amount": 34 } } }'
 ```
 
+### Configuration
+
+There are two ways of setting default arguments for serialization,
+by passing a block to `Surrealist.configure`:
+```ruby
+Surrealist.configure do |config|
+  config.camelize = true
+  config.namespaces_nesting_level = 2
+end
+```
+And by passing a hash:
+
+`Surrealist.configure(camelize: true, include_root: true)`
+
+These arguments will be applied to all calls of `#build_schema` and `#surrealize`.
+If these methods will be called with arguments, they will be merged with respect to explicitly passed ones:
+
+```ruby
+Surrealist.configure(camelize: true, include_root: true)
+
+Something.new.surrealize(camelize: false)
+# will result in Something.new.surrealize(camelize: false, include_root: true)
+```
+
+
 ### Bool and Any
 If you have a parameter that is of boolean type, or if you don't care about the type, you
 can use `Bool` and `Any` respectively.
@@ -661,7 +706,7 @@ can use `Bool` and `Any` respectively.
 ``` ruby
 class User
   include Surrealist
- 
+
   json_schema do
     {
       age: Any,
@@ -677,13 +722,13 @@ end
 ``` ruby
 class CreditCard
   include Surrealist
- 
+
   json_schema do
     { number: Integer }
   end
- 
+
   def number
-    'string'  
+    'string'
   end
 end
 
@@ -698,7 +743,7 @@ a corresponding method defined in the object.
 ``` ruby
 class Car
   include Surrealist
- 
+
   json_schema do
     { weight: Integer }
   end
@@ -716,7 +761,7 @@ type check will be passed. If you want to be strict about `nil`s consider using
 ## Roadmap
 Here is a list of features that are not implemented yet (contributions are welcome):
 * [Having a config that would keep serialization parameters](https://github.com/nesaulov/surrealist/issues/76)
-* [DSL for serializer contexts](https://github.com/nesaulov/surrealist/issues/67) 
+* [DSL for serializer contexts](https://github.com/nesaulov/surrealist/issues/67)
 * Memoization/caching
 
 ## Contributing

data/lib/surrealist/carrier.rb

@@ -2,10 +2,11 @@
 
 module Surrealist
   # A data structure to carry arguments across methods.
+  # @api private
   class Carrier
     BOOLEANS = [true, false].freeze
 
-    attr_reader :camelize, :include_root, :include_namespaces, :root, :namespaces_nesting_level
+    attr_accessor :camelize, :include_root, :include_namespaces, :root, :namespaces_nesting_level
 
     # Public wrapper for Carrier.
     #
@@ -43,10 +44,19 @@ module Surrealist
       self
     end
 
+    # Checks if all arguments are set to default
     def no_args_provided?
       @no_args ||= no_args
     end
 
+    # Returns all arguments
+    #
+    # @return [Hash]
+    def parameters
+      { camelize: camelize, include_root: include_root, include_namespaces: include_namespaces,
+        root: root, namespaces_nesting_level: namespaces_nesting_level }
+    end
+
     private
 
     # Checks all boolean arguments
@@ -85,6 +95,7 @@ module Surrealist
       root.is_a?(String) && @root = root.strip
     end
 
+    # Checks if all arguments are set to default
     def no_args
       !camelize && !include_root && !include_namespaces && root.nil? &&
         namespaces_nesting_level == DEFAULT_NESTING_LEVEL

data/lib/surrealist/exception_raiser.rb

@@ -31,7 +31,7 @@ module Surrealist
   # A class that raises all Surrealist exceptions
   module ExceptionRaiser
     CLASS_NAME_NOT_PASSED           = "Can't wrap schema in root key - class name was not passed".freeze
-    MUST_RESPOND_TO_EACH            = "Can't serialize collection - must respond to :each".freeze
+    MUST_BEHAVE_LIKE_ENUMERABLE     = "Can't serialize collection - must behave like enumerable".freeze
     CLASS_DOESNT_INCLUDE_SURREALIST = 'Class does not include Surrealist'.freeze
 
     class << self
@@ -64,7 +64,7 @@ module Surrealist
       #
       # @raise Surrealist::InvalidCollectionError
       def raise_invalid_collection!
-        raise Surrealist::InvalidCollectionError, MUST_RESPOND_TO_EACH
+        raise Surrealist::InvalidCollectionError, MUST_BEHAVE_LIKE_ENUMERABLE
       end
 
       # Raises ArgumentError if namespaces_nesting_level is not an integer.

data/lib/surrealist/helper.rb

@@ -11,5 +11,17 @@ module Surrealist
     def self.surrealist?(klass)
       klass < Surrealist || klass < Surrealist::Serializer
     end
+
+    def self.collection?(object)
+      # 4.2 AR relation object did not include Enumerable (it defined
+      # all necessary method through ActiveRecord::Delegation module),
+      # so we need to explicitly check for this
+      object.is_a?(Enumerable) || ar_relation?(object)
+    end
+
+    def self.ar_relation?(object)
+      defined?(ActiveRecord) && object.is_a?(ActiveRecord::Relation)
+    end
+    private_class_method :ar_relation?
   end
 end

data/lib/surrealist/serializer.rb

@@ -31,6 +31,25 @@ module Surrealist
   class Serializer
     extend Surrealist::ClassMethods
 
+    class << self
+      # Defines instance methods that read values from the context hash.
+      #
+      # @param [Array<Symbol>] array
+      #   an array of symbols which represent method names
+      #
+      # @raise ArgumentError if type of argument is not an array of symbols
+      def serializer_context(*array)
+        unless array.all? { |i| i.is_a? Symbol }
+          raise ArgumentError, 'Please provide an array of symbols to `.serializer_context`'
+        end
+
+        array.each { |method| define_method(method) { context[method] } }
+      end
+
+      # Plural form ¯\_(ツ)_/¯
+      alias serializer_contexts serializer_context
+    end
+
     # NOTE: #context will work only when using serializer explicitly,
     #   e.g `CatSerializer.new(Cat.new(3), food: CatFood.new)`
     #   And then food will be available inside serializer via `context[:food]`
@@ -41,7 +60,7 @@ module Surrealist
 
     # Checks whether object is a collection or an instance and serializes it
     def surrealize(**args)
-      if object.respond_to?(:each)
+      if Helper.collection?(object)
         Surrealist.surrealize_collection(object, args.merge(context: context))
       else
         Surrealist.surrealize(instance: self, **args)
@@ -50,7 +69,7 @@ module Surrealist
 
     # Passes build_schema to Surrealist
     def build_schema(**args)
-      if object.respond_to?(:each)
+      if Helper.collection?(object)
         build_collection_schema(args)
       else
         Surrealist.build_schema(instance: self, **args)

data/lib/surrealist/value_assigner.rb

@@ -18,7 +18,7 @@ module Surrealist
 
         if value.respond_to?(:build_schema)
           yield assign_nested_record(instance, value)
-        elsif value.respond_to?(:each) && !value.empty? && value.all? { |v| Helper.surrealist?(v.class) }
+        elsif Helper.collection?(value) && !value.empty? && value.all? { |v| Helper.surrealist?(v.class) }
           yield assign_nested_collection(instance, value)
         else
           yield value

data/lib/surrealist/version.rb

@@ -2,5 +2,5 @@
 
 module Surrealist
   # Defines the version of Surrealist
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/surrealist.rb

@@ -54,7 +54,7 @@ module Surrealist
     #   # => "[{\"name\":\"Nikita\",\"age\":23}, {\"name\":\"Alessandro\",\"age\":24}]"
     #   # For more examples see README
     def surrealize_collection(collection, **args)
-      Surrealist::ExceptionRaiser.raise_invalid_collection! unless collection.respond_to?(:each)
+      Surrealist::ExceptionRaiser.raise_invalid_collection! unless Helper.collection?(collection)
 
       result = collection.map do |object|
         Helper.surrealist?(object.class) ? __build_schema(object, args) : object
@@ -81,6 +81,8 @@ module Surrealist
       Oj.dump(build_schema(instance: instance, **args), mode: :compat)
     end
 
+    # rubocop:disable Metrics/AbcSize
+
     # Builds hash from schema provided in the object's class and type-checks the values.
     #
     # @param [Object] instance of a class that has +Surrealist+ included.
@@ -121,15 +123,43 @@ module Surrealist
     #   # => { name: 'Nikita', age: 23 }
     #   # For more examples see README
     def build_schema(instance:, **args)
-      carrier = Surrealist::Carrier.call(args)
       schema = Surrealist::VarsHelper.find_schema(instance.class)
-
       Surrealist::ExceptionRaiser.raise_unknown_schema!(instance) if schema.nil?
 
+      parameters = config ? config.merge(args) : args
+      carrier = Surrealist::Carrier.call(parameters)
       normalized_schema = Surrealist::Copier.deep_copy(schema, carrier, instance.class.name)
       hash = Builder.new(carrier, normalized_schema, instance).call
       carrier.camelize ? Surrealist::HashUtils.camelize_hash(hash) : hash
     end
+    # rubocop:enable Metrics/AbcSize
+
+    # Reads current default serialization arguments.
+    #
+    # @return [Hash] default arguments (@see Surrealist::Carrier)
+    def config
+      @default_args || Surrealist::Copier::EMPTY_HASH
+    end
+
+    # Sets default serialization arguments with a block
+    #
+    # @param [Hash] hash arguments to be set (@see Surrealist::Carrier)
+    # @param [Proc] _block a block which will be yielded to Surrealist::Carrier instance
+    #
+    # @example set config
+    #   Surrealist.configure do |config|
+    #     config.camelize = true
+    #     config.include_root = true
+    #   end
+    def configure(hash = nil, &_block)
+      if block_given?
+        carrier = Surrealist::Carrier.new
+        yield(carrier)
+        @default_args = carrier.parameters
+      else
+        @default_args = hash.nil? ? Surrealist::Copier::EMPTY_HASH : hash
+      end
+    end
 
     private
 

data/surrealist.gemspec

@@ -24,11 +24,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.2.0'
 
-  spec.add_runtime_dependency 'oj', '~> 3'
+  spec.add_runtime_dependency 'oj', '3.4.0'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '0.51.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: surrealist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nikita Esaulov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-11 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.51.0
+        version: '0.52'
 description: A gem that provides DSL for serialization of plain old Ruby objects to
   JSON in a declarative style by defining a `schema`. It also provides a trivial type
   checking in the runtime before serialization.
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A gem that provides DSL for serialization of plain old Ruby objects to JSON