surrealist 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e161583b21b67122b16fc80818d02a053076fb85
+  data.tar.gz: fb10c25384a75bbf3b8c68454086dd9d6e145093
+SHA512:
+  metadata.gz: 79f775182748e9f4b22b6d88bf05f4fb53f35afa177a85c3290097ab2923df74538e869d7d2b15494e24415da8d08f64de3d21b45b05821148cef8fa9bdeefd1
+  data.tar.gz: 0eaa71f001668e89373fc347caa8d1ff70a43a5f780bdedafbc62d39bf344c1e2c9b3c67bf106b0ba6e052bdf988597b59f9f4da7b4f688f63058a8ec50a13fb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+TODO.md

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+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/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+sudo: false
+cache: bundler
+before_install: gem install bundler
+script: bundle exec rspec
+rvm:
+  - 2.2.5
+  - 2.3.1
+  - 2.4.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'coveralls', require: false
+gem 'rubocop-config-umbrellio', require: false
+gem 'yard', require: false unless ENV['TRAVIS']

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nikita Esaulov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# Surrealist
+[![Build Status](https://travis-ci.com/nesaulov/surrealist.svg?token=UM7SJoXQ7Y56NHBpib7v&branch=master)](https://travis-ci.com/nesaulov/surrealist)
+[![Coverage Status](https://coveralls.io/repos/github/nesaulov/surrealist/badge.svg?branch=master)](https://coveralls.io/github/nesaulov/surrealist?branch=master)
+
+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)
+
+## Motivation
+A typical use case for this gem could be, for example, serializing a decorated object outside of the view context.
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'surrealist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install surrealist
+
+
+## Usage
+Schema should be defined with a block that contains a hash. Every key of the schema should be
+either a name of a method of the surrealizable object (or it's parents/mixins),
+or - in case value is a hash - a symbol: to build nested JSON structures.
+Every value of the hash should be a constant that represents a Ruby class,
+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,
+      name: String,
+      nested: {
+        at: {
+          any: Integer,
+          level: Boolean,
+        },
+      },
+    }
+  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
+
+CreditCard.new.surrealize
+# => Surrealist::InvalidTypeError: Wrong type for key `number`. Expected Integer, got String.
+```
+
+### 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
+end
+
+Car.new.surrealize
+# => Surrealist::UndefinedMethodError: undefined method `weight' for #<Car:0x007f9bc1dc7fa8>. You have probably defined a key in the schema that doesn't have a corresponding method.
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nesaulov/surrealist.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'surrealist'
+require 'pry'
+
+Pry.start

data/lib/surrealist/builder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+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)
+        else
+          val = instance.send(key)
+
+          if val.is_a? value
+            schema[key] = val
+          else
+            raise Surrealist::InvalidTypeError,
+                  "Wrong type for key `#{key}`. Expected #{value}, got #{val.class}."
+          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."
+    end
+  end
+end

data/lib/surrealist/class_methods.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'builder'
+require_relative 'schema_definer'
+
+module Surrealist
+  # Class methods that are extended by the object.
+  module ClassMethods
+    # A DSL method to define schema in a declarative style. Schema should be defined with a block
+    # that contains a hash.
+    # Every key of the schema should be either a name of a method of the
+    # surrealizable object (or it's parents/mixins), or - in case value is a hash - a symbol:
+    # to build nested JSON structures. Every value of the hash should be a constant that represents
+    # a Ruby class, that will be used for type-checks.
+    #
+    # @param [Proc] _block that contains hash defining the schema
+    #
+    # @example DSL usage example
+    #   class User
+    #     include Surrealist
+    #
+    #     schema do
+    #       {
+    #         foo: String,
+    #         bar: Integer,
+    #       }
+    #     end
+    #
+    #     def foo; 'A string'; end
+    #     def bar; 42; end
+    #   end
+    #
+    #   User.new.surrealize
+    #   # => "{\"foo\":\"A string\",\"bar\":42}"
+    #   # For more examples see README
+    #
+    # @example Schema with nested structure
+    #   class Person
+    #     include Surrealist
+    #
+    #     schema do
+    #       {
+    #         foo: String,
+    #         nested: {
+    #           bar: Integer,
+    #         }
+    #       }
+    #     end
+    #
+    #     def foo; 'A string'; end
+    #     def bar; 42; end
+    #   end
+    #
+    #   Person.new.surrealize
+    #   # => "{\"foo\":\"A string\",\"nested\":{\"bar\":42}}"
+    #   # For more examples see README
+    def schema(&_block)
+      SchemaDefiner.call(self, yield)
+    end
+  end
+end

data/lib/surrealist/extensions/boolean.rb

@@ -0,0 +1,8 @@
+# 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

data/lib/surrealist/instance_methods.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Surrealist
+  # Instance methods that are included to the object's class
+  module InstanceMethods
+    # Invokes +Surrealist+'s class method +surrealize+
+    def surrealize
+      Surrealist.surrealize(self)
+    end
+  end
+end

data/lib/surrealist/schema_definer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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.
+    #
+    # @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.
+    #
+    # @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
+    end
+  end
+end

data/lib/surrealist/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Surrealist
+  # Defines the version of Surrealist
+  VERSION = '0.0.4'
+end

data/lib/surrealist.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'surrealist/class_methods'
+require_relative 'surrealist/instance_methods'
+require_relative 'surrealist/extensions/boolean'
+require 'multi_json'
+
+# Main module that provides the +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.
+  class InvalidSchemaError < RuntimeError; end
+
+  # Error class for +NoMethodError+.
+  class UndefinedMethodError < RuntimeError; end
+
+  # Error class for failed type-checks.
+  class InvalidTypeError < TypeError; end
+
+  # @param [Class] base class to include/extend +Surrealist+.
+  def self.included(base)
+    base.extend(Surrealist::ClassMethods)
+    base.include(Surrealist::InstanceMethods)
+  end
+
+  # Dumps the object's methods corresponding to the schema
+  # provided in the object's class and type-checks the values.
+  #
+  # @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.
+  #
+  # @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
+  #       {
+  #         foo: String,
+  #         bar: Integer,
+  #       }
+  #     end
+  #
+  #     def foo; 'A string'; end
+  #     def bar; 42; end
+  #   end
+  #
+  #   User.new.surrealize
+  #   # => "{\"foo\":\"A string\",\"bar\":42}"
+  #   # For more examples see README
+  def self.surrealize(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))
+  end
+end

data/surrealist.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'surrealist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'surrealist'
+  spec.version       = Surrealist::VERSION
+  spec.authors       = ['Nikita Esaulov']
+  spec.email         = ['billikota@gmail.com']
+
+  spec.summary       = 'A gem that provides DSL for serialization of plain old Ruby objects to JSON ' \
+                       'in a declarative style.'
+  spec.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.'
+  spec.homepage      = 'https://github.com/nesaulov/surrealist'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  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'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: surrealist
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Nikita Esaulov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+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.
+email:
+- billikota@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/console
+- lib/surrealist.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
+- surrealist.gemspec
+homepage: https://github.com/nesaulov/surrealist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A gem that provides DSL for serialization of plain old Ruby objects to JSON
+  in a declarative style.
+test_files: []