jsonschema_serializer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5ff79bf4ed3d32004617cd27553db4d78259564
-  data.tar.gz: af09ee9cb24e9d22ab131be621fb6eced08c72dd
+  metadata.gz: d65039713e6c37e41ca9c190655625b3d1ab9fc8
+  data.tar.gz: 204bea0aacdc61d33dedb8894f4f779ef5a63680
 SHA512:
-  metadata.gz: 2042a3ee18d60c3f8a88279d2013099a0f12e15935882fb91ebb01d5633b2a624ba9d6c1a0653489f1e3dab5cfd41c2b217be16ec98e7a1b366f444dbd84a261
-  data.tar.gz: c8e60dd65ddecfafe0195cb5bf05d2d7605f4d6d5aaf775b967942fc5f59de7a224068c6f4b5346a93dacd419fe5bf801a2a4ec1145148fec97df56ce78ad775
+  metadata.gz: 494f948e0b3b29bcaef14142952fc580a8de4bf68271a139af6eecf8dcbae99b3d925892734b7199bc8dcc10435600cc81418eb4bebcbcaac4b67d2ef9a322a3
+  data.tar.gz: 380403b40d52d4e7352a8258f997073900c728391d40f0f536405adbb4214fa9a6920dad3c256d7100f007659cf74456f4ab6577fa992d746094e852bbb51105

data/.gitignore

@@ -9,3 +9,7 @@
 
 # rspec failure tracking
 .rspec_status
+.byebug_history
+.ruby-version
+
+Gemfile.lock

data/.rubocop.yml

@@ -14,10 +14,14 @@ Metrics/LineLength:
   Max: 90
 
 Style/Documentation:
-  Enabled: false
+  Enabled: true
 
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/ModuleFunction:
+  Exclude:
+    - lib/jsonschema_serializer/active_record.rb
+
 Style/SymbolArray:
   EnforcedStyle: brackets

data/.travis.yml

@@ -3,25 +3,7 @@ sudo: false
 language: ruby
 
 jobs:
-  allow_failures:
-    - rvm: 1.8.7
-      gemfile: Gemfile-pre-2
-    - rvm: 1.9.3
-      gemfile: Gemfile-pre-2
-    - rvm: 2.0.0
-      gemfile: Gemfile-pre-2
-    - rvm: jruby-1.7.21
-      gemfile: Gemfile-pre-2
-
   include:
-    - rvm: 1.8.7
-      gemfile: Gemfile-pre-2
-    - rvm: 1.9.3
-      gemfile: Gemfile-pre-2
-    - rvm: 2.0.0
-      gemfile: Gemfile-pre-2
-    - rvm: jruby-1.7.21
-      gemfile: Gemfile-pre-2
     - rvm: 2.1.5
       gemfile: Gemfile
     - rvm: 2.2.7

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+# v 0.0.3 (2018-05-21)
+
+- improved documentation on existing code base
+- refactored `JsonschemaSerializer::ActiveRecord` as a `class`
+
+# v 0.0.2 (2018-05-20)
+
+- basic rDoc comments for documentation
+
+# v 0.0.1 (2018-05-20)
+
+- basic implementation of `JsonschemaSerializer::Builder`
+- POC implementation of a `JsonschemaSerializer::ActiveRecord` module

data/README.md

@@ -1,6 +1,8 @@
 # JsonschemaSerializer
 
 [![Build Status](https://travis-ci.org/mberlanda/jsonschema_serializer.svg?branch=master)](https://travis-ci.org/mberlanda/jsonschema_serializer)
+[![Gem Version](https://badge.fury.io/rb/jsonschema_serializer.svg)](https://badge.fury.io/rb/jsonschema_serializer)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7312071a0865c70f5d60/maintainability)](https://codeclimate.com/github/mberlanda/jsonschema_serializer/maintainability)
 
 This purpose of this gem is to generate [JsonSchema](http://json-schema.org/).
 
@@ -25,7 +27,7 @@ Or install it yourself as:
 You can generate a schema as follows:
 
 ```ruby
-schema = JsonSchema::Builder.build do |b|
+schema = JsonschemaSerializer::Builder.build do |b|
 
   subscriber = b._object title: :subscriber, required: [:age] do |prop|
     prop.merge! b.string :first_name, title: 'First Name'
@@ -57,13 +59,11 @@ You can alternatively use an experimental builder for `ActiveRecord`
 
 
 ```ruby
-class Serializer
-  include JsonschemaSerializer::ActiveRecord
-end
+serializer = JsonschemaSerializer::ActiveRecord
 
-schema = Serializer.from_active_record(MyActiveRecordClass)
-schema = Serializer.from_active_record(MyActiveRecordClass, only: %[desired1 desired2])
-schema = Serializer.from_active_record(MyActiveRecordClass, except: %[ignored1 ignored2])
+schema = serializer.from_active_record(MyActiveRecordClass)
+schema = serializer.from_active_record(MyActiveRecordClass, only: %[desired1 desired2])
+schema = serializer.from_active_record(MyActiveRecordClass, except: %[ignored1 ignored2])
 
 # You can manipulate the resulting schema
 

data/lib/jsonschema_serializer/active_record.rb

@@ -1,22 +1,19 @@
 require_relative 'builder'
 
-# The +JsonschemaSerializer::Activerecord+ module provides
-# a +from_activerecord+ class method  to serialize some
-# ActiveRecord classes with the minimum effort
-
 module JsonschemaSerializer
-  module ActiveRecord
-    def self.included(klass)
-      klass.extend(ClassMethods)
-    end
-    module ClassMethods
+  # The +JsonschemaSerializer::Activerecord+ class provides
+  # a +from_active_record+ class method to serialize some
+  # ActiveRecord classes with the minimum effort
+  class ActiveRecord
+    class << self
       # Serialize an ActiveRecord class into a
       # JsonschemaSerializer::Builder object
       #
-      # params:
-      # +klass+ [ActiveRecord::Base]
-      # +only+ [Array[String]]
-      # +except+ [Array[String]]
+      # Params:
+      # +klass+:: +ActiveRecord::Base+ class name
+      # +only+:: +Array+ columns as +String+
+      # +except+:: +Array+ columns as +String+
+
       def from_active_record(klass, only: nil, except: nil)
         validate_arguments(only, except)
         JsonschemaSerializer::Builder.build do |b|

data/lib/jsonschema_serializer/builder.rb

@@ -1,8 +1,11 @@
 require 'json'
 
 module JsonschemaSerializer
+  # The +JsonschemaSerializer::Builder+ class provides
+  # an effective DSL to generate a valid json schema.
   class Builder
     class << self
+      # The +build+ class method create a new instance and applies the block
       def build
         new.tap do |builder|
           yield(builder) if block_given?
@@ -10,53 +13,187 @@ module JsonschemaSerializer
       end
     end
 
+    # An hash representation of the +schema+
     attr_reader :schema
 
+    # The +new+ method creates assigns an empty object
+    # to a +schema+ instance variable
     def initialize
-      @schema ||= {
-        type: :object,
-        properties: {}
-      }
+      @schema ||= _object
     end
 
+    # The +to_json+ method exports the schema as a json string
     def to_json
       @schema.to_json
     end
 
+    # Assigns the +title+ to the root schema object
+    #
+    # Params:
+    # +title+:: +String+ or +Symbol+ title field of the schema object
+
     def title(title)
       @schema[:title] = title
     end
 
+    # Assigns the +description+ to the root schema object
+    #
+    # params:
+    # +description+:: +String+ description field of the schema object
+
     def description(description)
       @schema[:description] = description
     end
 
+    # The +required+ method allows to provide a list of required properties
+    #
+    # params:
+    # +required+ [Array[String, Symbol]]
+
     def required(*required)
       @schema[:required] = required
     end
 
+    # The +properties+ method allows to access object properties
+    #
+    # e.g.:
+    #   JsonschemaSerializer::Builder.build do |b|
+    #     b.properties.tap do |p|
+    #       p.merge! {}
+    #     end
+    #   end
+
     def properties
       @schema[:properties] ||= {}
     end
 
-    def _object(**opts)
-      { type: :object, properties: {} }.merge(opts).tap do |h|
-        yield(h[:properties]) if block_given?
-      end
+    # A base representation of the +boolean+ type.
+    def _boolean(**opts)
+      { type: :boolean }.merge(opts)
     end
 
-    [:boolean, :integer, :number, :string].each do |attr_type|
-      define_method("_#{attr_type}") do |**opts|
-        { type: attr_type }.merge(opts)
-      end
+    # A property representation of the +boolean+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +Boolean+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+
+    def boolean(name, **opts)
+      { name => _boolean(opts) }
+    end
 
-      define_method(attr_type) do |name, **opts|
-        {
-          name => send("_#{attr_type}", **opts)
-        }
+    # A base representation of the +integer+ type.
+    def _integer(**opts)
+      { type: :integer }.merge(opts)
+    end
+
+    # A property representation of the +integer+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +Integer+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +enum+:: +Array+ property allowed values
+    # +minimum+:: +Integer+ property minimum value
+    # +maximum+:: +Integer+ property maximum value
+    # +multipleOf+:: +Integer+ property conditional constraint
+
+    def integer(name, **opts)
+      { name => _integer(opts) }
+    end
+
+    # A base representation of the +number+ type.
+    def _number(**opts)
+      { type: :number }.merge(opts)
+    end
+
+    # A property representation of the +number+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +Numeric+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +enum+:: +Array+ property allowed values
+    # +minimum+:: +Numeric+ property minimum value
+    # +maximum+:: +Numeric+ property maximum value
+    # +multipleOf+:: +Numeric+ property conditional constraint
+
+    def number(name, **opts)
+      { name => _number(opts) }
+    end
+
+    # A base representation of the +string+ type.
+    def _string(**opts)
+      { type: :string }.merge(opts)
+    end
+
+    # A property representation of the +string+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    #
+    # Optional Params:
+    # +default+:: +String+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +format+:: +String+ property format for validation
+    # +minLength+:: +Int+ property minimum length
+
+    def string(name, **opts)
+      { name => _string(opts) }
+    end
+
+    # A base representation of the +object+ type.
+    #
+    #   JsonschemaSerializer::Builder.build do |b|
+    #     subscriber = b._object title: :subscriber, required: [:age] do |prop|
+    #       prop.merge! b.string :first_name, title: 'First Name'
+    #       prop.merge! b.string :last_name, title: 'Last Name'
+    #       prop.merge! b.integer :age, title: 'Age'
+    #     end
+    #   end
+
+    def _object(**opts)
+      { type: :object, properties: {} }.merge(opts).tap do |h|
+        yield(h[:properties]) if block_given?
       end
     end
 
+    # A property representation of the +array+ type.
+    #
+    # Params:
+    # +name+:: +String+ or +Symbol+
+    # +items+:: an object representation or an array of objects
+    #
+    # Optional Params:
+    # +default+:: +Array+ default value
+    # +description+:: +String+ property description
+    # +title+:: +String+ property title
+    # +minItems+:: +Int+ property minimum length
+    # +maxItems+:: +Int+ property maximum length
+    #
+    #   JsonschemaSerializer::Builder.build do |b|
+    #     b.array :integers, items: {type: :integer}, minItems:5
+    #     b.array :strings, items: b._string, default: []
+    #
+    #     subscriber = b._object title: :subscriber, required: [:age] do |prop|
+    #       prop.merge! b.string :first_name, title: 'First Name'
+    #       prop.merge! b.string :last_name, title: 'Last Name'
+    #       prop.merge! b.integer :age, title: 'Age'
+    #     end
+    #     b.array :subscribers, items: subscriber
+    #   end
+    #
     def array(name, items:, **opts)
       {
         name => { type: :array, items: items }.merge(opts)

data/lib/jsonschema_serializer/version.rb

@@ -1,3 +1,3 @@
 module JsonschemaSerializer
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze # :nodoc:
 end

data/lib/jsonschema_serializer.rb

@@ -2,6 +2,5 @@ require 'jsonschema_serializer/version'
 require 'jsonschema_serializer/builder'
 require 'jsonschema_serializer/active_record'
 
-# :no-rdoc:
-module JsonschemaSerializer
+module JsonschemaSerializer # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonschema_serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mauro Berlanda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,8 +69,8 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile-pre-2
 - README.md
 - Rakefile
 - bin/console
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: The purpose of this gem is to generate JsonSchema

data/Gemfile-pre-2

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# The purpose of this Gemfile is to test old ruby versions
-gemspec