surrealist 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e161583b21b67122b16fc80818d02a053076fb85
-  data.tar.gz: fb10c25384a75bbf3b8c68454086dd9d6e145093
+  metadata.gz: 7b1db1906a694049f0d30a384b863248a565fa98
+  data.tar.gz: 249561f2fe8bb08ca93fd04c9a48fbc111b4d5f3
 SHA512:
-  metadata.gz: 79f775182748e9f4b22b6d88bf05f4fb53f35afa177a85c3290097ab2923df74538e869d7d2b15494e24415da8d08f64de3d21b45b05821148cef8fa9bdeefd1
-  data.tar.gz: 0eaa71f001668e89373fc347caa8d1ff70a43a5f780bdedafbc62d39bf344c1e2c9b3c67bf106b0ba6e052bdf988597b59f9f4da7b4f688f63058a8ec50a13fb
+  metadata.gz: a89eaf9e476152176d26c25f9475606a7372abb07a1295cb9eb51192934973673800ff116af6e6a3591ca2d7785c60b8a635cb2062c7a339e503c253da96c732
+  data.tar.gz: 2bed8315135646784faf8b3dc60c186654e136cc6c1416f65a00aed3753c0943094cef7eff0168f5c6feeeb5833a931689189a76d18a031605301cf27d926e9b

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .ruby-version
 TODO.md
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.0.6
+* Add `build_schema` instance method that builds hash from the schema without serializing it to json.
+* Allow nil values by default
+* Allow nested objects 

data/Gemfile

@@ -4,5 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
-gem 'rubocop-config-umbrellio', require: false
 gem 'yard', require: false unless ENV['TRAVIS']

data/README.md

@@ -1,14 +1,21 @@
 # Surrealist
-[![Build Status](https://travis-ci.com/nesaulov/surrealist.svg?token=UM7SJoXQ7Y56NHBpib7v&branch=master)](https://travis-ci.com/nesaulov/surrealist)
+[![Build Status](https://travis-ci.org/nesaulov/surrealist.svg?branch=master)](https://travis-ci.org/nesaulov/surrealist)
 [![Coverage Status](https://coveralls.io/repos/github/nesaulov/surrealist/badge.svg?branch=master)](https://coveralls.io/github/nesaulov/surrealist?branch=master)
+[![Inline docs](http://inch-ci.org/github/nesaulov/surrealist.svg?branch=master)](http://inch-ci.org/github/nesaulov/surrealist)
+[![Gem Version](https://badge.fury.io/rb/surrealist.svg)](https://rubygems.org/gems/surrealist)
 
 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.
 [Yard documentation](http://www.rubydoc.info/github/nesaulov/surrealist/master)
 
+## Current status
+In development, not yet ready for real projects.
+
 ## Motivation
-A typical use case for this gem could be, for example, serializing a decorated object outside of the view context.
- 
+A typical use case for this gem could be, for example, serializing a (decorated) object outside
+of the view context. The schema is described through a hash, so you can build the structure
+of serialized object independently of its methods and attributes.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -36,37 +43,41 @@ that will be used for type-checks.
 ### Simple example
 * Include Surrealist in your class.
 * Define a schema with methods that need to be serialized.
+
 ``` ruby
 class Person
   include Surrealist
-  
+ 
   schema do
     {
       foo: String,
       bar: Integer,
-    } 
+    }
   end
-  
+ 
   def foo
     'This is a string'
   end
-  
+ 
   def bar
     42
   end
 end
 ```
+
 * Surrealize it.
+
 ``` ruby
 Person.new.surrealize
 # => "{\"foo\":\"This is a string\",\"bar\":42}"
 ```
 
 ### Nested structures
+
 ``` ruby
 class Person
   include Surrealist
-
+ 
   schema do
     {
       foo: String,
@@ -81,22 +92,23 @@ 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}}}"
 ```
 
 ### Type Errors
+
 `Surrealist::InvalidTypeError` is thrown if types mismatch.
 
 ``` ruby
 class CreditCard
   include Surrealist
-
+ 
   schema do
     { number: Integer }
   end
-
+ 
   def number; 'string'; end
 end
 
@@ -105,12 +117,14 @@ CreditCard.new.surrealize
 ```
 
 ### Undefined methods in schema
+
 `Surrealist::UndefinedMethodError` is thrown if a key defined in the schema does not have
 a corresponding method defined in the object.
+
 ``` ruby
 class Car
   include Surrealist
-
+ 
   schema do
     { weight: Integer }
   end

data/lib/surrealist/boolean.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# A module for boolean type-checks.
+module Boolean; end

data/lib/surrealist/builder.rb

@@ -3,37 +3,125 @@
 module Surrealist
   # A class that builds a hash from the schema and type-checks the values.
   class Builder
-    # A method that goes recursively through the schema hash, defines the values and type-checks them.
-    #
-    # @param [Hash] schema the schema defined in the object's class.
-    #
-    # @param [Object] instance the instance of the object which methods from the schema are called on.
-    #
-    # @raise +Surrealist::InvalidTypeError+ if type-check failed at some point.
-    #
-    # @raise +Surrealist::UndefinedMethodError+ if a key defined in the schema
-    #   does not have a corresponding method on the object.
-    #
-    # @return [Hash] a hash that will be dumped into JSON.
-    def self.call(schema, instance)
-      schema.each do |key, value|
-        if value.is_a? Hash
-          call(value, instance)
+    class << self
+      # A method that goes recursively through the schema hash, defines the values and type-checks them.
+      #
+      # @param [Hash] schema the schema defined in the object's class.
+      # @param [Object] instance the instance of the object which methods from the schema are called on.
+      #
+      # @raise +Surrealist::UndefinedMethodError+ if a key defined in the schema
+      #   does not have a corresponding method on the object.
+      #
+      # @return [Hash] a hash that will be dumped into JSON.
+      def call(schema:, instance:)
+        schema.each do |key, value|
+          if value.is_a?(Hash)
+            parse_hash(hash: value, schema: schema, instance: instance, key: key)
+          else
+            type  = value
+            value = instance.is_a?(Hash) ? instance[key] : instance.send(key)
+            assign_value(method: key, value: value, type: type) { schema[key] = value }
+          end
+        end
+      rescue NoMethodError => e
+        raise Surrealist::UndefinedMethodError,
+              "#{e.message}. You have probably defined a key " \
+              "in the schema that doesn't have a corresponding method."
+      end
+
+      private
+
+      # Checks if hash represents methods on the instance.
+      #
+      # @param [Hash] hash a value from the schema hash.
+      # @param [Hash] schema the schema defined in the object's class.
+      # @param [Object] instance the instance of the object which methods from the schema are called on.
+      # @param [Symbol] key a key from the schema hash.
+      #
+      # @return [Hash] schema
+      def parse_hash(hash:, schema:, instance:, key:)
+        if instance.respond_to?(key)
+          maybe_take_values_from_instance(instance: instance, method: key, hash: hash, schema: schema)
         else
-          val = instance.send(key)
+          call(schema: hash, instance: instance)
+        end
+      end
+
+      # Checks if object's method include schema keys.
+      #
+      # @param [Object] instance the instance of the object which methods from the schema are called on.
+      # @param [Symbol] method a key from the schema hash representing a method on the instance.
+      # @param [Hash] hash a value from the schema hash.
+      # @param [Hash] schema the schema defined in the object's class.
+      #
+      # @return [Hash] schema
+      def maybe_take_values_from_instance(instance:, method:, hash:, schema:)
+        object = instance.send(method)
 
-          if val.is_a? value
-            schema[key] = val
+        hash.each do |key, value|
+          if object.methods.include?(key)
+            take_values_from_instance(instance: object, value: value, hash: hash, key: key,
+                                      schema: schema, method: method)
           else
-            raise Surrealist::InvalidTypeError,
-                  "Wrong type for key `#{key}`. Expected #{value}, got #{val.class}."
+            call(schema: hash, instance: object)
           end
         end
       end
-    rescue NoMethodError => e
-      raise Surrealist::UndefinedMethodError,
-            "#{e.message}. You have probably defined a key " \
-            "in the schema that doesn't have a corresponding method."
+
+      # Invokes methods on the instance and puts return values into the schema hash.
+      #
+      # @param [Object] instance the instance of the object which methods from the schema are called on.
+      # @param [Class | Hash] value either type of value or a hash.
+      # @param [Hash] hash a value from the schema hash.
+      # @param [Hash] schema the schema defined in the object's class.
+      # @param [Symbol] method a key from the schema hash representing a method on the instance.
+      #
+      # @return [Hash] schema
+      def take_values_from_instance(instance:, value:, hash:, key:, schema:, method:)
+        result = instance.send(key)
+
+        if value.is_a?(Hash)
+          parse_hash(hash: value, schema: hash, instance: result, key: key)
+        else
+          type = value
+          assign_value(method: key, value: result, type: type) do
+            schema[method] = schema[method].merge(key => result)
+          end
+        end
+      end
+
+      # Assigns value returned from a method to a corresponding key in the schema hash.
+      #
+      # @param [Symbol] method a key from the schema hash representing a method on the instance.
+      # @param [Object] value a value that has to be type-checked.
+      # @param [Class] type class representing data type.
+      #
+      # @raise +Surrealist::InvalidTypeError+ if type-check failed at some point.
+      #
+      # @return [Hash] schema
+      def assign_value(method:, value:, type:, &_block)
+        if type_check_passed?(value: value, type: type)
+          yield if block_given?
+        else
+          raise Surrealist::InvalidTypeError,
+                "Wrong type for key `#{method}`. Expected #{type}, got #{value.class}."
+        end
+      end
+
+      # Checks if value returned from a method is an instance of type class specified
+      # in schema or NilClass.
+      #
+      # @param [any] value value returned from a method.
+      # @param [Class] type class representing data type.
+      #
+      # @return [boolean]
+      def type_check_passed?(value:, type:)
+        if type == Boolean
+          [true, false].include?(value)
+        else
+          value.nil? || value.is_a?(type)
+        end
+      end
     end
   end
 end

data/lib/surrealist/instance_methods.rb

@@ -7,5 +7,10 @@ module Surrealist
     def surrealize
       Surrealist.surrealize(self)
     end
+
+    # Invokes +Surrealist+'s class method +build_schema+
+    def build_schema
+      Surrealist.build_schema(self)
+    end
   end
 end

data/lib/surrealist/version.rb

@@ -2,5 +2,5 @@
 
 module Surrealist
   # Defines the version of Surrealist
-  VERSION = '0.0.4'
+  VERSION = '0.0.7'
 end

data/lib/surrealist.rb

@@ -2,7 +2,7 @@
 
 require_relative 'surrealist/class_methods'
 require_relative 'surrealist/instance_methods'
-require_relative 'surrealist/extensions/boolean'
+require_relative 'surrealist/boolean'
 require 'multi_json'
 
 # Main module that provides the +schema+ class method and +surrealize+ instance method.
@@ -30,7 +30,6 @@ module Surrealist
   #
   # @param [Object] instance of a class that has +Surrealist+ included.
   #
-  #
   # @return [String] a json-formatted string corresponding to the schema
   #   provided in the object's class. Values will be taken from the return values
   #   of appropriate methods from the object.
@@ -48,25 +47,72 @@ module Surrealist
   #
   #     schema do
   #       {
-  #         foo: String,
-  #         bar: Integer,
+  #         name: String,
+  #         age: Integer,
   #       }
   #     end
   #
-  #     def foo; 'A string'; end
-  #     def bar; 42; end
+  #     def name
+  #       'Nikita'
+  #     end
+  #
+  #     def age
+  #       23
+  #     end
   #   end
   #
   #   User.new.surrealize
-  #   # => "{\"foo\":\"A string\",\"bar\":42}"
+  #   # => "{\"name\":\"Nikita\",\"age\":23}"
   #   # For more examples see README
   def self.surrealize(instance)
+    ::MultiJson.dump(build_schema(instance))
+  end
+
+  # 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.
+  #
+  # @return [Hash] a hash corresponding to the schema
+  #   provided in the object's class. Values will be taken from the return values
+  #   of appropriate methods from the object.
+  #
+  # @raise +Surrealist::UnknownSchemaError+ if no schema was provided in the object's class.
+  #
+  # @raise +Surrealist::InvalidTypeError+ if type-check failed at some point.
+  #
+  # @raise +Surrealist::UndefinedMethodError+ if a key defined in the schema
+  #   does not have a corresponding method on the object.
+  #
+  # @example Define a schema and surrealize the object
+  #   class User
+  #     include Surrealist
+  #
+  #     schema do
+  #       {
+  #         name: String,
+  #         age: Integer,
+  #       }
+  #     end
+  #
+  #     def name
+  #       'Nikita'
+  #     end
+  #
+  #     def age
+  #       23
+  #     end
+  #   end
+  #
+  #   User.new.build_schema
+  #   # => { name: 'Nikita', age: 23 }
+  #   # For more examples see README
+  def self.build_schema(instance)
     schema = instance.__surrealist_schema rescue nil
 
     if schema.nil?
       raise Surrealist::UnknownSchemaError, "Can't serialize #{instance.class} - no schema was provided."
     end
 
-    ::MultiJson.dump(Builder.call(schema, instance))
+    Builder.call(schema: schema, instance: instance)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surrealist
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Nikita Esaulov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,16 +91,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - bin/console
 - lib/surrealist.rb
+- lib/surrealist/boolean.rb
 - lib/surrealist/builder.rb
 - lib/surrealist/class_methods.rb
-- lib/surrealist/extensions/boolean.rb
 - lib/surrealist/instance_methods.rb
 - lib/surrealist/schema_definer.rb
 - lib/surrealist/version.rb

data/.rubocop.yml

@@ -1,13 +0,0 @@
-inherit_gem:
-  rubocop-config-umbrellio: lib/rubocop.yml
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-  ConsistentQuotesInMultiline: true
-Metrics/LineLength:
-  Max: 106
-Style/SingleLineMethods:
-  Enabled: false

data/lib/surrealist/extensions/boolean.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# A module that is included in +TrueClass+ and +FalseClass+ for boolean type-checks.
-module Boolean; end
-# TrueClass monkey-patch.
-class TrueClass; include Boolean; end
-# FalseClass monkey-patch.
-class FalseClass; include Boolean; end