surrealist 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a430c1d28309d9ef1c1626e64fa3e0f482abef0215307a8ac8ea19083a44eb8b
-  data.tar.gz: dc45cc49c8b1af7676a9ad6738c42c83e10397587d7d21908d5345ee74248ff4
+  metadata.gz: 6470fa2a8f31edfdb08c858e7f74bb92add85aa887bf5a3e968521b88585adec
+  data.tar.gz: 703ce5280e32c246d5c51bd6be1d4a0e0688d01dcaaeb195aa1a5867e762e86e
 SHA512:
-  metadata.gz: f2ae0819199d9c5ef9d0e221f3a743612fb18c1b392922788c9741eb6ed0172c2ba9aeef566d408b30bfd4a19df2a468edf98cef025923c70e0e2a30fb17d39c
-  data.tar.gz: e958a7d97360166bf852d8cb69b294b452176b0f981537df80478e1c5daaa817964a3d877746307d86d0018dc808ec89d58635eee594a7180c5af7a8b6070ba2
+  metadata.gz: 3f95d432d163188e66ae51cea051db55cf9fbfb05ae43b0e8096c0275a3d78f317a1a716fb2dc6900b3dc2deae82216ef2b9f09d062db0c00301c0cd2f2459a6
+  data.tar.gz: 71575656f64a1d6110f56623ecaa04d186478702c46f777967a17478fc180c4b6a326e4221a1c48f0def25036d68f307fd6eba2c62881120444b042808c32514

data/.rubocop.yml

@@ -9,7 +9,7 @@ Documentation:
     - benchmarks/*rb
     - spec/**/*rb
 
-# Layout
+#  Layout
 
 Layout/AlignParameters:
   Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.2.0
+
+## Added
+* `.defined_schema` to return the schema that has been defined with `json_schema` ([@glaucocustodio][]) [#98](https://github.com/nesaulov/surrealist/pull/98)
+
+## Fixed
+* Incorrect method delegation ([@nesaulov][]) [#103](https://github.com/nesaulov/surrealist/pull/103)
+
 # 1.1.2
 
 ## Fixed
@@ -87,6 +95,7 @@
 * Allow nil values by default.
 * Allow nested objects.
 
+[@glaucocustodio]: https://github.com/glaucocustodio
 [@nesaulov]: https://github.com/nesaulov
 [@AlessandroMinali]: https://github.com/AlessandroMinali
 [@nulldef]: https://github.com/nulldef

data/Gemfile

@@ -10,7 +10,7 @@ group :development, :test do
   gem 'blueprinter'
   gem 'coveralls', require: false
   gem 'dry-struct'
-  gem 'dry-types'
+  gem 'dry-types', '= 0.12.2'
   gem 'rom', '~> 4.0'
   gem 'rom-repository'
   gem 'rom-sql'

data/README.md

@@ -27,6 +27,7 @@ to serialize nested objects and structures. [Introductory blogpost.](https://med
   * [Defining custom serializers](#defining-custom-serializers)
   * [Multiple serializers](#multiple-serializers)
   * [Build schema](#build-schema)
+  * [Defined schema](#defined-schema)
   * [Working with ORMs](#working-with-orms)
     * [ActiveRecord](#activerecord)
     * [ROM](#rom)
@@ -260,19 +261,19 @@ you have to define yourself. DSL looks as follows
 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
 
@@ -321,6 +322,14 @@ Car.new.build_schema
 # => { age: 7, brand: "Toyota", doors: nil, horsepower: 140, fuel_system: "Direct injection", previous_owner: "John Doe" }
 ```
 
+### Defined schema
+Use the `.defined_schema` method to get the schema that has been defined with `json_schema`:
+
+``` ruby
+User.defined_schema
+# => { name: String, age: Integer }
+```
+
 ### Working with ORMs
 
 There are two kinds of return values of ORM methods: some return collections of objects, while others return instances.

data/lib/surrealist/class_methods.rb

@@ -55,6 +55,28 @@ module Surrealist
       SchemaDefiner.call(self, yield)
     end
 
+    # A DSL method to return the defined schema.
+    # @example DSL usage example
+    #   class Person
+    #     include Surrealist
+    #
+    #     json_schema do
+    #       { name: String }
+    #     end
+    #
+    #     def name
+    #       'Parent'
+    #     end
+    #   end
+    #
+    #   Person.defined_schema
+    #   # => { name: String }
+    def defined_schema
+      read_schema.tap do |schema|
+        raise UnknownSchemaError if schema.nil?
+      end
+    end
+
     # A DSL method to delegate schema in a declarative style. Must reference a valid
     # class that includes Surrealist
     #
@@ -101,9 +123,17 @@ module Surrealist
     def surrealize_with(klass, tag: Surrealist::VarsHelper::DEFAULT_TAG)
       if klass < Surrealist::Serializer
         Surrealist::VarsHelper.add_serializer(self, klass, tag: tag)
+        instance_variable_set(VarsHelper::PARENT_VARIABLE, klass.defined_schema)
       else
         raise ArgumentError, "#{klass} should be inherited from Surrealist::Serializer"
       end
     end
+
+    private
+
+    def read_schema
+      instance_variable_get(VarsHelper::INSTANCE_VARIABLE) ||
+        instance_variable_get(VarsHelper::PARENT_VARIABLE)
+    end
   end
 end

data/lib/surrealist/value_assigner.rb

@@ -34,10 +34,23 @@ module Surrealist
       #
       # @return [Object] value to be further processed
       def raw_value(instance, schema)
-        value = instance.is_a?(Hash) ? instance[schema.key] : instance.send(schema.key)
+        value = instance.is_a?(Hash) ? instance[schema.key] : invoke_method(instance, schema.key)
         coerce_value(value, schema)
       end
 
+      # Checks if there is a custom serializer defined for the object and invokes the method
+      #   on it first.
+      #
+      # @param [Object] instance an instance of a model or a serializer
+      # @param [Symbol] method the schema key that represents the method to be invoked
+      #
+      # @return [Object] the return value of the method
+      def invoke_method(instance, method)
+        object = instance.instance_variable_get(:@object)
+
+        object && object.respond_to?(method) ? object.send(method) : instance.send(method)
+      end
+
       # Coerces value if type check is passed
       #
       # @param [Object] value the value to be checked and coerced

data/lib/surrealist/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surrealist
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Nikita Esaulov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj