jsonschema_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 395b1b884c0ae4cb6a7482c829874658d73b4263
+  data.tar.gz: d336c0f04228e6e9d9eed216587186f15c26b677
+SHA512:
+  metadata.gz: a3c34d1b59ba6ff2b94f266627bb78273a41fcab30f4f7e3f391f0ef51abcda8c8a74087de5fce94dc1830ccd396feabc8c0786b2fd2ed067d0e2c1e8e4fd775
+  data.tar.gz: 7b05406b0c4ff3ee5d73c1dcb64935c750e80b3bd8563fface0a5ce3d762cf542d39f66c31f302a2de97e9eb966b7dfd5448c7ba05e28e24ff84d49a888d328d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+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/SymbolArray:
+  EnforcedStyle: brackets

data/.travis.yml

@@ -0,0 +1,40 @@
+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
+      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/Gemfile

@@ -0,0 +1,8 @@
+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/Gemfile-pre-2

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

data/README.md

@@ -0,0 +1,87 @@
+# JsonschemaSerializer
+
+[![Build Status](https://travis-ci.org/mberlanda/jsonschema_serializer.svg?branch=master)](https://travis-ci.org/mberlanda/jsonschema_serializer)
+
+This purpose of this gem is to generate [JsonSchema](http://json-schema.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonschema_serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonschema_serializer
+
+## Usage
+
+You can generate a schema as follows:
+
+```ruby
+schema = JsonSchema::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
+
+  b.title "a title"
+  b.description "a description"
+  b.required :a, :b, :c
+  b.properties.tap do |p|
+    p.merge! b.string :a, description: "abc"
+    p.merge! b.array :subscribers, description: "subscribers", items: subscriber
+  end
+end
+
+schema.to_json
+```
+
+Allowed parameters for data types:
+
+- `array`  : `:default, :description, items: {}||[{}], :minItems, :maxItems, :title`
+- `boolean`: `:default, :description, :title`
+- `integer`: `:default, :description, enum: [], :minimum, :maximum, :multipleOf, :title`
+- `number` : `:default, :description, enum: [], :minimum, :maximum, :multipleOf, :title`
+- `string` : `:default, :description, :format, :minLength, :title`
+
+You can alternatively use an experimental builder for `ActiveRecord`
+
+
+```ruby
+class Serializer
+  include JsonschemaSerializer::ActiveRecord
+end
+
+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
+
+schema.tap do |s|
+  s.title "a title"
+  s.description "a description"
+end
+
+schema.to_json
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mberlanda/jsonschema_serializer.
+ygy

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

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

data/jsonschema_serializer.gemspec

@@ -0,0 +1,48 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jsonschema_serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonschema_serializer"
+  spec.version       = JsonschemaSerializer::VERSION
+  spec.authors       = ["Mauro Berlanda"]
+  spec.email         = ["mauro.berlanda@gmail.com"]
+
+  spec.summary       = %q{The purpose of this gem is to generate JsonSchema}
+  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.
+  EOT
+  spec.homepage      = "https://github.com/mberlanda/jsonschema_serializer"
+  spec.licenses      = ['MIT']
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  spec.metadata  = { "source_code_uri" => "https://github.com/mberlanda/jsonschema_serialize" }
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.extra_rdoc_files = ['README.md']
+  spec.rdoc_options << '--title' << 'Jsonschema Serializer' <<
+                       '--main' << 'README.md' <<
+                       '--line-numbers'
+
+  spec.required_ruby_version = '>= 2.1.0'
+end

data/lib/jsonschema_serializer.rb

@@ -0,0 +1,7 @@
+require 'jsonschema_serializer/version'
+require 'jsonschema_serializer/builder'
+require 'jsonschema_serializer/active_record'
+
+# :no-rdoc:
+module JsonschemaSerializer
+end

data/lib/jsonschema_serializer/active_record.rb

@@ -0,0 +1,74 @@
+require_relative 'builder'
+
+# The +JsonschemaSerializer::Activerecord+ module provides
+# a +from_activerecord+ class method  to serialize some
+# ActiveRecord classes with the minimum effort
+
+module JsonschemaSerializer
+  # :no-rdoc:
+  module ActiveRecord
+    # :no-rdoc:
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    # :no-rdoc:
+    module ClassMethods
+      # Serialize an ActiveRecord class into a
+      # JsonschemaSerializer::Builder object
+      #
+      # params:
+      # +klass+ [ActiveRecord::Base]
+      # +only+ [Array[String]]
+      # +except+ [Array[String]]
+      def from_active_record(klass, only: nil, except: nil)
+        validate_arguments(only, except)
+        JsonschemaSerializer::Builder.build do |b|
+          selected_columns(klass, only, except).each do |col|
+            b.properties.tap do |prop|
+              el = format_column_element(col)
+              # Handle basic case of attribute type and attribute name
+              prop.merge! b.send(el[:type], el[:name])
+            end
+          end
+        end
+      end
+
+      private
+
+      # Raise if +only+ and +except+ are both provided
+      def validate_arguments(only, except)
+        raise ArgumentError, 'only and except options both provided' if only && except
+      end
+
+      # Retrieves the columns and keep/discard some elements if needed
+      def selected_columns(klass, only, except)
+        klass.columns.tap do |cols|
+          cols.select! { |col| only.include?(col.name) } if only
+          cols.reject! { |col| except.include?(col.name) } if except
+        end
+      end
+
+      # Mapping Ruby types on Jsonschema types.
+      # This could be moved to a separate module later
+
+      TYPE_CONVERSIONS = {
+        boolean: :boolean,
+        datetime: :string,
+        decimal: :number,
+        float: :number,
+        integer: :integer,
+        text: :string
+      }.freeze
+
+      # Format a ActiveRecord::ConnectionAdapters::<Adapter>::Column as an Hash
+      def format_column_element(col)
+        {}.tap do |h|
+          h[:name] = col.name
+          h[:type] = TYPE_CONVERSIONS[col.type] || :string
+          # col.default.tap { |d| h[:default] = d if d}
+        end
+      end
+    end
+  end
+end

data/lib/jsonschema_serializer/builder.rb

@@ -0,0 +1,67 @@
+require 'json'
+
+module JsonschemaSerializer
+  # :no-rdoc:
+  class Builder
+    class << self
+      def build
+        new.tap do |builder|
+          yield(builder) if block_given?
+        end
+      end
+    end
+
+    attr_reader :schema
+
+    def initialize
+      @schema ||= {
+        type: :object,
+        properties: {}
+      }
+    end
+
+    def to_json
+      @schema.to_json
+    end
+
+    def title(title)
+      @schema[:title] = title
+    end
+
+    def description(description)
+      @schema[:description] = description
+    end
+
+    def required(*required)
+      @schema[:required] = required
+    end
+
+    def properties
+      @schema[:properties] ||= {}
+    end
+
+    def _object(**opts)
+      { type: :object, properties: {} }.merge(opts).tap do |h|
+        yield(h[:properties]) if block_given?
+      end
+    end
+
+    [:boolean, :integer, :number, :string].each do |attr_type|
+      define_method("_#{attr_type}") do |**opts|
+        { type: attr_type }.merge(opts)
+      end
+
+      define_method(attr_type) do |name, **opts|
+        {
+          name => send("_#{attr_type}", **opts)
+        }
+      end
+    end
+
+    def array(name, items:, **opts)
+      {
+        name => { type: :array, items: items }.merge(opts)
+      }
+    end
+  end
+end

data/lib/jsonschema_serializer/version.rb

@@ -0,0 +1,4 @@
+# :no-rdoc:
+module JsonschemaSerializer
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: jsonschema_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mauro Berlanda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+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.
+email:
+- mauro.berlanda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile-pre-2
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonschema_serializer.gemspec
+- lib/jsonschema_serializer.rb
+- lib/jsonschema_serializer/active_record.rb
+- lib/jsonschema_serializer/builder.rb
+- lib/jsonschema_serializer/version.rb
+homepage: https://github.com/mberlanda/jsonschema_serializer
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/mberlanda/jsonschema_serialize
+post_install_message: 
+rdoc_options:
+- "--title"
+- Jsonschema Serializer
+- "--main"
+- README.md
+- "--line-numbers"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: The purpose of this gem is to generate JsonSchema
+test_files: []