Release 1.3.0 (#113)

* Add docs for hash serialization

* Bump version to 1.3.0

Author: nesaulov

CHANGELOG.md

@@ -1,3 +1,14 @@
+# 1.3.0
+
+## Added
+
+* Hash serialization ([@stefkin][]) [#106](https://github.com/nesaulov/surrealist/pull/106)
+
+## Fixed
+
+* Conflict when root and object property share the same name ([@akxcv][]) [#99](https://github.com/nesaulov/surrealist/pull/99)
+* Precedence was given to object method instead of serializer one ([@gjhenrique][] & [@nesaulov][]) [#110](https://github.com/nesaulov/surrealist/pull/110) & [#111](https://github.com/nesaulov/surrealist/pull/111)
+
 # 1.2.0
 
 ## Added
@@ -102,4 +113,5 @@
 [@azhi]: https://github.com/azhi
 [@chrisatanasian]: https://github.com/chrisatanasian
 [@past-one]: https://github.com/past-one
-
+[@stefkin]: https://github.com/stefkin
+[@gjhenrique]: https://github.com/gjhenrique

README.md

@@ -40,6 +40,7 @@ to serialize nested objects and structures. [Introductory blogpost.](https://med
     * [Root](#root)
     * [Include namespaces](#include-namespaces)
   * [Configuration](#configuration)
+  * [Hash serialization](#hash-serialization)
   * [Bool and Any](#bool-and-any)
   * [Type errors](#type-errors)
   * [Undefined methods in schema](#undefined-methods-in-schema)
@@ -687,7 +688,7 @@ withdraws.surrealize(include_namespaces: true, namespaces_nesting_level: 2)
 
 There are two ways of setting default arguments for serialization,
 by passing a block to `Surrealist.configure`:
-```ruby
+``` ruby
 Surrealist.configure do |config|
   config.camelize = true
   config.namespaces_nesting_level = 2
@@ -700,13 +701,28 @@ And by passing a hash:
 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
+``` ruby
 Surrealist.configure(camelize: true, include_root: true)
 
 Something.new.surrealize(camelize: false)
 # will result in Something.new.surrealize(camelize: false, include_root: true)
 ```
 
+### Hash serialization
+
+You can pass a hash to serializer and it will use the keys instead of methods.
+
+``` ruby
+class HashSerializer < Surrealist::Serializer
+  json_schema { { string: String, int: Integer } }
+end
+
+HashSerializer.new(string: 'string', int: 4).surrealize
+# => '{ "string": "string", "int": 4}'
+
+HashSerializer.new(string: 'string', int: 'not int').surrealize
+# => Surrealist::InvalidTypeError: Wrong type for key `int`. Expected Integer, got String.
+```
 
 ### Bool and Any
 If you have a parameter that is of boolean type, or if you don't care about the type, you
@@ -769,7 +785,8 @@ 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):
-* Memoization/caching
+* Automatic endpoint documentation
+* API for validating (contracts) without actually serializing to JSON (maybe with deserialization from JSON)
 
 ## Contributing
 Bug reports and pull requests are welcome on GitHub at https://github.com/nesaulov/surrealist.

lib/surrealist/version.rb

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