jsonschema_serializer 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21bc2f5a22f0f4da198b981fd6be8aade090d4fa
-  data.tar.gz: 9d08bc5bf5c24b2bd5cec7ac1f7dfb8914374708
+  metadata.gz: 0bf44f052005e55102e26a83b65f8dd7652551e5
+  data.tar.gz: 36455d91f261bc831b86247866d44ff3a22927aa
 SHA512:
-  metadata.gz: 55d072167b46b7999861a0d6c152753ca46a490b3f3e0386867dfc6d084c9cfc287af7acf4248f6e6039d74ab84133c59f11e19ee79b2fe52caa0c259875f62f
-  data.tar.gz: 21b742e2afb0e3598667b4f3e9c75017cdf0096dc7a51808d99a1b4b669b256be42c9ebec4e7df479f47e92c3dcf552010ec3d0fa36dd3256428258e8026f0fc
+  metadata.gz: c76364ae191a25e98d85b4c7961230f2f916f94341dd5c6d871e8bc1e67ba313452ee4c95ca8b591faf9ff9f88359ff6f943f55243f3b94caf6353cabb39abad
+  data.tar.gz: 486c1a061008be82fd861369d28a607c3bec312a6403d4fff32e66245a09e02bf7242740378ef67a7a5adfd21d34482194878953b7df5b4fd4433227600284ac

data/README.md

@@ -3,8 +3,13 @@
 [![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)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7312071a0865c70f5d60/test_coverage)](https://codeclimate.com/github/mberlanda/jsonschema_serializer/test_coverage)
 
 This purpose of this gem is to generate [JsonSchema](http://json-schema.org/).
+This can be achieved with a builder class or an `ActiveRecord` wrapper.
+The gem is available for both Rails 4, 5 or in Ruby standalone projects.
+
+Since the project is still at an early stage, please do not hesitate to [open issues / feature requests](https://github.com/mberlanda/jsonschema_serializer/issues) or fork this repo for pull requests.
 
 ## Installation
 
@@ -79,7 +84,7 @@ schema.to_json
 
 At this stage, a first usage within a Rails application could be a rake task dumping the schemas inside the public folder.
 
-```rb
+```ruby
 # lib/tasks/jsonschemas.rake
 require 'fileutils'
 
@@ -116,3 +121,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mberlanda/jsonschema_serializer.
+Please ensure to keep the test coverage at 100% and follow the angularjs [commit message conv.entions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#subject-line).

data/jsonschema_serializer.gemspec

@@ -9,13 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Mauro Berlanda"]
   spec.email         = ["mauro.berlanda@gmail.com"]
 
-  spec.summary       = %q{The purpose of this gem is to generate JsonSchema}
+  spec.summary       = %q{Generate JsonSchema in Rails or standalone Ruby}
   spec.description   = <<-EOT
-    The goal behind this gem is to generate JsonSchema.
-    This can be done using thanks to a Builder class or
-    an ActiveRecord serialization module.
-    The project is still at an early stage so all PR or feature request will
-    be welcome on the Github repo
+    This gem allows to generate JsonSchema thanks to a Builder class or
+    an ActiveRecord serialization class. It can be used in Rails 4, 5 or
+    Ruby standalone projects.
+    The output validation is done agains json-schema.
   EOT
   spec.homepage      = "https://github.com/mberlanda/jsonschema_serializer"
   spec.licenses      = ['MIT']
@@ -30,9 +29,7 @@ Gem::Specification.new do |spec|
   #    "public gem pushes."
   # end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files = Dir.glob("lib/**/*") + %w(jsonschema_serializer.gemspec README.md)
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -40,6 +37,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "json-schema", "~> 2.8"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "appraisal", "~> 2.2"
 
   spec.extra_rdoc_files = ['README.md']
   spec.rdoc_options << '--title' << 'Jsonschema Serializer' <<

data/lib/jsonschema_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jsonschema_serializer/version'
 require 'jsonschema_serializer/builder'
 require 'jsonschema_serializer/active_record'

data/lib/jsonschema_serializer/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'builder'
 
 module JsonschemaSerializer
@@ -43,7 +45,7 @@ module JsonschemaSerializer
       def format_schema_attributes(klass, builder)
         builder.title schema_title(klass)
         required(klass).tap do |required|
-          builder.required required unless required.empty?
+          builder.required(*required) unless required.empty?
         end
       end
 
@@ -78,11 +80,12 @@ module JsonschemaSerializer
       # Params:
       # +columns+:: +Array+ column names as +Symbol+
 
-      # Extract required attributes from ActiveRecord class implementation
+      # Filter required class attributes with only/filters attributes
       # This method can be overridden when inheriting from this class
       #
       # Params:
       # +klass+:: +ActiveRecord::Base+ class name
+
       def required(klass)
         required_from_class(klass).tap do |req|
           return req & @only if @only
@@ -90,6 +93,12 @@ module JsonschemaSerializer
         end
       end
 
+      # Extract required attributes from ActiveRecord class implementation
+      # This method can be overridden when inheriting from this class
+      #
+      # Params:
+      # +klass+:: +ActiveRecord::Base+ class name
+
       def required_from_class(klass)
         klass.validators.select do |validator|
           validator.class.to_s == 'ActiveRecord::Validations::PresenceValidator'
@@ -119,7 +128,8 @@ module JsonschemaSerializer
         decimal: :number,
         float: :number,
         integer: :integer,
-        text: :string
+        text: :string,
+        varchar: :string
       }.freeze
 
       # Format a ActiveRecord::ConnectionAdapters::<Adapter>::Column as an Hash
@@ -141,7 +151,9 @@ module JsonschemaSerializer
       # +col+:: +ActiveRecord::ConnectionAdapters::<Adapter>::Column+ column
 
       def sql_type(col)
-        col.sql_type_metadata.type
+        return col.sql_type_metadata.type if col.respond_to?(:sql_type_metadata)
+        # Rails 4 backward compatibility
+        col.sql_type.downcase.to_sym
       end
     end
   end

data/lib/jsonschema_serializer/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module JsonschemaSerializer

data/lib/jsonschema_serializer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JsonschemaSerializer
-  VERSION = '0.0.5'.freeze # :nodoc:
+  VERSION = '0.1.0'.freeze # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonschema_serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Mauro Berlanda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,12 +52,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: |2
-      The goal behind this gem is to generate JsonSchema.
-      This can be done using thanks to a Builder class or
-      an ActiveRecord serialization module.
-      The project is still at an early stage so all PR or feature request will
-      be welcome on the Github repo
+      This gem allows to generate JsonSchema thanks to a Builder class or
+      an ActiveRecord serialization class. It can be used in Rails 4, 5 or
+      Ruby standalone projects.
+      The output validation is done agains json-schema.
 email:
 - mauro.berlanda@gmail.com
 executables: []
@@ -65,16 +106,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - jsonschema_serializer.gemspec
 - lib/jsonschema_serializer.rb
 - lib/jsonschema_serializer/active_record.rb
@@ -106,8 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: The purpose of this gem is to generate JsonSchema
+summary: Generate JsonSchema in Rails or standalone Ruby
 test_files: []

data/.gitignore

@@ -1,16 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.byebug_history
-.ruby-version
-.gem
-
-Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -1,27 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.4
-  Exclude:
-    - bin/*
-    - "*.gemspec"
-    - Gemfile
-    - Rakefile
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Metrics/LineLength:
-  Max: 90
-
-Style/Documentation:
-  Enabled: true
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/ModuleFunction:
-  Exclude:
-    - lib/jsonschema_serializer/active_record.rb
-
-Style/SymbolArray:
-  EnforcedStyle: brackets

data/.travis.yml

@@ -1,22 +0,0 @@
-sudo: false
-
-language: ruby
-
-jobs:
-  include:
-    - rvm: 2.1.5
-      gemfile: Gemfile
-    - rvm: 2.2.7
-      gemfile: Gemfile
-    - rvm: 2.3.4
-      gemfile: Gemfile
-    - rvm: 2.4.1
-      gemfile: Gemfile
-    - rvm: 2.5.0
-      gemfile: Gemfile
-    - rvm: ruby-head
-      gemfile: Gemfile
-    - rvm: jruby-9.0.5.0
-      gemfile: Gemfile
-
-before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -1,27 +0,0 @@
-# Changelog
-
-## v 0.0.5 (2018-05-23)
-
-- json pretty generation by default
-- added a Rails rake task example in the README.md
-- added schema `title` and `required` attributes
-- refactored `from_active_record` method in `from_model`
-- manipulate a dup of table columns
-
-## v 0.0.4 (2018-05-22)
-
-- corrected `ActiveRecord::ConnectionAdapters::SqlTypeMetadata` reference in `JsonschemaSerializer::ActiveRecord`
-
-## 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/Gemfile

@@ -1,8 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in jsonschema_serializer.gemspec
-gemspec
-
-gem 'rubocop', '~> 0.55.0'

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "jsonschema_serializer"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here