surrealist 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b1db1906a694049f0d30a384b863248a565fa98
-  data.tar.gz: 249561f2fe8bb08ca93fd04c9a48fbc111b4d5f3
+  metadata.gz: '091867794245edb01f2db4525118b6bd26ca2282'
+  data.tar.gz: 00e8caac256b36ecb436c83adec4337381ffafdf
 SHA512:
-  metadata.gz: a89eaf9e476152176d26c25f9475606a7372abb07a1295cb9eb51192934973673800ff116af6e6a3591ca2d7785c60b8a635cb2062c7a339e503c253da96c732
-  data.tar.gz: 2bed8315135646784faf8b3dc60c186654e136cc6c1416f65a00aed3753c0943094cef7eff0168f5c6feeeb5833a931689189a76d18a031605301cf27d926e9b
+  metadata.gz: 6f58c5d69d760da83b2e87c480d679791d908944abcbc5c027187e473b45bf1124d6a50c416501fb547a38f0e9c1c1585f03ed0157e1b6d2044a455579b4a135
+  data.tar.gz: 6f47c88860840afa21276c62d17bf56dd8845f1867d598fdbbe2594d12dfe39b24ee05d8b9ffe32a3c30c75c2fb4739ae39850867e720f6db6d898ffbfe1b152

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # 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 
+* Allow nil values by default.
+* Allow nested objects.
+
+# 0.1.0
+* Change `schema` class method to `json_schema` due to compatibility issues with other gems.
+* Fix schema mutability issue

data/README.md

@@ -5,7 +5,7 @@
 [![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.
+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)
 
 ## Current status
@@ -48,7 +48,7 @@ that will be used for type-checks.
 class Person
   include Surrealist
  
-  schema do
+  json_schema do
     {
       foo: String,
       bar: Integer,
@@ -78,7 +78,7 @@ Person.new.surrealize
 class Person
   include Surrealist
  
-  schema do
+  json_schema do
     {
       foo: String,
       name: String,
@@ -105,7 +105,7 @@ Person.find_by(email: 'example@email.com').surrealize
 class CreditCard
   include Surrealist
  
-  schema do
+  json_schema do
     { number: Integer }
   end
  
@@ -125,7 +125,7 @@ a corresponding method defined in the object.
 class Car
   include Surrealist
  
-  schema do
+  json_schema do
     { weight: Integer }
   end
 end

data/lib/surrealist/builder.rb

@@ -3,6 +3,7 @@
 module Surrealist
   # A class that builds a hash from the schema and type-checks the values.
   class Builder
+    # TODO: refactor methods so they don't take so much arguments
     class << self
       # A method that goes recursively through the schema hash, defines the values and type-checks them.
       #

data/lib/surrealist/class_methods.rb

@@ -19,7 +19,7 @@ module Surrealist
     #   class User
     #     include Surrealist
     #
-    #     schema do
+    #     json_schema do
     #       {
     #         foo: String,
     #         bar: Integer,
@@ -38,7 +38,7 @@ module Surrealist
     #   class Person
     #     include Surrealist
     #
-    #     schema do
+    #     json_schema do
     #       {
     #         foo: String,
     #         nested: {
@@ -54,7 +54,7 @@ module Surrealist
     #   Person.new.surrealize
     #   # => "{\"foo\":\"A string\",\"nested\":{\"bar\":42}}"
     #   # For more examples see README
-    def schema(&_block)
+    def json_schema(&_block)
       SchemaDefiner.call(self, yield)
     end
   end

data/lib/surrealist/schema_definer.rb

@@ -3,23 +3,19 @@
 module Surrealist
   # A class that defines a method on the object that stores the schema.
   class SchemaDefiner
-    # Defines a method on the object that stores the schema.
+    # Defines an instance variable on the object that stores the schema.
     #
     # @param [Object] klass class of the object that needs to be surrealized.
     #
     # @param [Hash] hash the schema defined in the object's class.
     #
-    # @return [Method] +__surrealist_schema+ method that stores the schema of the object.
+    # @return [Hash] +@__surrealist_schema+ variable that stores the schema of the object.
     #
     # @raise +Surrealist::InvalidSchemaError+ if schema was defined not through a hash.
     def self.call(klass, hash)
       raise Surrealist::InvalidSchemaError, 'Schema should be defined as a hash' unless hash.is_a?(Hash)
 
-      klass.instance_eval do
-        define_method '__surrealist_schema' do
-          hash
-        end
-      end
+      klass.instance_variable_set('@__surrealist_schema', hash)
     end
   end
 end

data/lib/surrealist/version.rb

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

data/lib/surrealist.rb

@@ -3,14 +3,14 @@
 require_relative 'surrealist/class_methods'
 require_relative 'surrealist/instance_methods'
 require_relative 'surrealist/boolean'
-require 'multi_json'
+require 'json'
 
-# Main module that provides the +schema+ class method and +surrealize+ instance method.
+# Main module that provides the +json_schema+ class method and +surrealize+ instance method.
 module Surrealist
   # Error class for classes without defined +schema+.
   class UnknownSchemaError < RuntimeError; end
 
-  # Error class for classes with +schema+ defined not as a hash.
+  # Error class for classes with +json_schema+ defined not as a hash.
   class InvalidSchemaError < RuntimeError; end
 
   # Error class for +NoMethodError+.
@@ -45,7 +45,7 @@ module Surrealist
   #   class User
   #     include Surrealist
   #
-  #     schema do
+  #     json_schema do
   #       {
   #         name: String,
   #         age: Integer,
@@ -65,7 +65,7 @@ module Surrealist
   #   # => "{\"name\":\"Nikita\",\"age\":23}"
   #   # For more examples see README
   def self.surrealize(instance)
-    ::MultiJson.dump(build_schema(instance))
+    ::JSON.dump(build_schema(instance))
   end
 
   # Builds hash from schema provided in the object's class and type-checks the values.
@@ -87,7 +87,7 @@ module Surrealist
   #   class User
   #     include Surrealist
   #
-  #     schema do
+  #     json_schema do
   #       {
   #         name: String,
   #         age: Integer,
@@ -107,12 +107,22 @@ module Surrealist
   #   # => { name: 'Nikita', age: 23 }
   #   # For more examples see README
   def self.build_schema(instance)
-    schema = instance.__surrealist_schema rescue nil
+    schema = instance.class.instance_variable_get('@__surrealist_schema')
 
     if schema.nil?
       raise Surrealist::UnknownSchemaError, "Can't serialize #{instance.class} - no schema was provided."
     end
 
-    Builder.call(schema: schema, instance: instance)
+
+    Builder.call(schema: deep_copy(schema), instance: instance)
+  end
+
+  # Deep copies the schema hash.
+  #
+  # @param [Object] obj object to be coopied
+  #
+  # @return [Object] a copied object
+  def self.deep_copy(obj)
+    Marshal.load(Marshal.dump(obj))
   end
 end

data/surrealist.gemspec

@@ -23,10 +23,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rspec', '~> 3.6.0'
-
-  spec.add_runtime_dependency 'multi_json', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rspec', '~> 3.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surrealist
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Nikita Esaulov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-10 00:00:00.000000000 Z
+date: 2017-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '3.6'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.6'
 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.