json_schema-artesano 0.0.1.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f64ae69feb786b7aebba6d914cfabe466ab8951d
+  data.tar.gz: 6664232be5861daf3e8884420c3b3afdcf1631a8
+SHA512:
+  metadata.gz: 5edbf1326b78a52761bbdac3e61500c6f37faa605f08b21188fa93dd4f850b9aa4d6653c04cb3d2d58066dbe037879214b2659639dfa51fc08e768b0c0988e7c
+  data.tar.gz: fd2b26a4e91e2ef3f3f5b11139d9d6dc25438ca7e00509eaa441d2ae1e785d635efb12790e46f552bc1dab61142eecb8b330f55e99c0b8354e7aa44accd1e197

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+## [0.0.1.beta.1] - 2017-10-09 (Alfonso Mancilla)
+### Changed
+- Process oneOf, anyOf and allOf first, then primivites, object and array.
+### Fixed
+- Minor speel / grammar improvements to README.
+
+## [0.0.1] - 2017-09-17 (Alfonso Mancilla)
+### Added
+ - Proof of concept strategies: Null, DataType and Static.

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alfonso Mancilla
+
+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,90 @@
+# JsonSchema::Artesano
+
+If you give a **sketch, materials and tools** to an artesano (artisan), they will use the tools to transform the materials into a product that (hopefully) matches the sketch.
+
+Similary, if you give a **JSON Schema (sketch) and a strategy (tool)** to `JsonSchema::Artesano`, it will give you data (or objects, or whatever else you ask for) conformed to the schema.
+
+**Mmm I don't believe you. You didn't give it materials!?**
+> Because it has it owns materials! (thanks to the `json_schema` gem).
+
+### **AND HOW COULD THIS BE USEFUL?**
+I came up with this after looking for a ruby 'JSON Schema faker' (give it a JSON Schema, get fake data according to the schema) and not finding any that fullfilled my needs. I know this gem is not what I was looking for, but now I can just create a simple faker strategy, pass it to `JsonSchema::Artesano` and get what I originally wanted. Someone could also create an strategy to generate ruby objects instead or similar.
+
+## Usage
+
+```ruby
+# the sketch
+schema = {
+    "title": "Person",
+    "type": "object",
+    "properties": {
+        "firstName": { "type": "string" },
+        "lastName": { "type": "string" },
+        "age": {
+            "description": "Age in years",
+            "type": "integer",
+            "minimum": 0
+        },
+        "genre": {
+            "type": "string",
+            "enum": ["male", "female"]
+        },
+        "married": { "type": "boolean" }
+    },
+    "required": ["firstName", "lastName"]
+}
+
+# the tool
+require 'json_schema-artesano/json_schema/artesano/tools/static'
+
+# the product
+product = JsonSchema::Artesano.mold(sketch: sketch, tool: JsonSchema::Artesano::Tools::Static)
+
+JSON.pretty_generate(product)
+
+# =>
+#
+# {
+#   "firstName": "Lorem ipsum dolor sit amet",
+#   "lastName": "Lorem ipsum dolor sit amet",
+#   "age": 22,
+#   "genre": "male",
+#   "married": false
+# }
+#
+
+```
+
+## Artesano Tools (Strategies)
+
+TODO: Describe how to create strategies and the provided ones.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_schema-artesano'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_schema-artesano
+
+## 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/ammancilla/json_schema-artesano.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'json_schema/artesano'
+
+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/json_schema-artesano.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'json_schema/artesano/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json_schema-artesano'
+  spec.version       = JsonSchema::Artesano::VERSION
+  spec.authors       = ["Alfonso Mancilla"]
+  spec.email         = ["almancill@gmail.com"]
+
+  spec.summary       = %q{Json Schema data generator}
+  spec.description   = %q{Generate data (objects, or anything else you like) from a given JSON Schema}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'json_schema', '~> 0.17'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/json_schema/artesano/hand.rb

@@ -0,0 +1,88 @@
+#
+# Give it a sketch (JSON Schema), a Tool (strategy), and it
+# will *mold* a product (hopefully) conformmatches the sketch.
+#
+
+require 'json'
+require 'json_schema'
+
+require_relative 'tools/static'
+
+module JsonSchema
+  module Artesano
+    class Hand
+      PRIMITIVE_MATERIALS = %w{null boolean number string integer}.freeze
+
+      attr_reader :tool
+
+      def initialize(tool: Tools::Static)
+        self.use_tool(tool)
+      end
+
+      def use_tool(tool)
+        @tool = tool.new
+      end
+
+      def mold(sketch)
+        transform( material(sketch) )
+      end
+
+      private
+
+      def transform(material)
+        # Enum
+        if !material.enum.nil?
+          return tool.shape_enum(material)
+        end
+
+        # OneOf
+        if material.one_of.any?
+          item = tool.select_oneof( material.one_of )
+          return transform(item)
+        end
+
+        # AnyOf
+        if material.any_of.any?
+          items = tool.select_anyof( material.any_of )
+          items = [items] unless items.is_a?(Array)
+
+          return tool.shape_array( transform_array(items) )
+        end
+
+        # AllOf
+        if material.all_of.any?
+          array = material.all_of
+          return tool.shape_array( transform_array(array) )
+        end
+
+        case material.type[0]
+        when *PRIMITIVE_MATERIALS
+          tool.shape_primitive(material)
+        when 'object'
+          tool.shape_object( transform_object(material) )
+        when 'array'
+          tool.shape_array( transform_array(material) )
+        else
+          # Null
+        end
+      end
+
+      def transform_object(object)
+        object.properties.inject(Hash.new) do |result, property|
+          result.merge(
+            { property[0] => transform( property[1] ) }
+          )
+        end
+      end
+
+      def transform_array(array)
+        items = array.respond_to?(:items) ? [array.items] : array
+        items.flatten.map { |item| transform(item) }
+      end
+
+      def material(sketch)
+        JsonSchema.parse!(sketch).tap { |schema| schema.expand_references! }
+      end
+    end
+  end
+end

data/lib/json_schema/artesano/tools/data_type.rb

@@ -0,0 +1,42 @@
+#
+# The DataType strategy uses the data type of any primitive or enum property as the generated data.
+#
+# IMPORTANT:
+# Generates valid data agains a given schema? NO!
+#
+
+module JsonSchema
+  module Artesano
+    module Tools
+      class DataType
+        def initialize
+        end
+
+        def shape_object(material)
+          material
+        end
+
+        def shape_array(material)
+          material
+        end
+
+        def shape_primitive(material)
+          material.type[0]
+        end
+
+        def shape_enum(material)
+          enum_type = material.type[0]
+          enum_type.nil? ? 'enum' : "enum[#{enum_type}]"
+        end
+
+        def select_oneof(materials)
+          materials.sample
+        end
+
+        def select_anyof(materials)
+          materials.sample
+        end
+      end
+    end
+  end
+end

data/lib/json_schema/artesano/tools/null.rb

@@ -0,0 +1,41 @@
+#
+# The Null strategy uses 'nil' as the generated data for any primitive or enum property.
+#
+# IMPORTANT:
+# Generates valid data agains a given schema? NO!
+#
+
+module JsonSchema
+  module Artesano
+    module Tools
+      class Null
+        def initialize
+        end
+
+        def shape_object(material)
+          material
+        end
+
+        def shape_array(materials)
+          materials
+        end
+
+        def shape_primitive(material)
+          nil
+        end
+
+        def shape_enum(material)
+          nil
+        end
+
+        def select_oneof(materials)
+          materials.sample
+        end
+
+        def select_anyof(materials)
+          materials.sample
+        end
+      end
+    end
+  end
+end

data/lib/json_schema/artesano/tools/static.rb

@@ -0,0 +1,50 @@
+#
+# The Static strategy generates static values according to the data type of any primitive or enum property.
+#
+# IMPORTANT:
+# Generates valid data agains a given schema? NO!
+#
+
+module JsonSchema
+  module Artesano
+    module Tools
+      class Static
+        def initialize
+        end
+
+        def shape_object(material)
+          material
+        end
+
+        def shape_array(material)
+          material
+        end
+
+        def shape_primitive(material)
+          case material.type[0]
+          when 'boolean'
+            false
+          when 'integer'
+            22
+          when 'number'
+            22.15
+          when 'string'
+            'Lorem ipsum dolor sit amet'
+          end
+        end
+
+        def shape_enum(material)
+          material.enum[0]
+        end
+
+        def select_oneof(materials)
+          materials[0]
+        end
+
+        def select_anyof(materials)
+          materials[0]
+        end
+      end
+    end
+  end
+end

data/lib/json_schema/artesano/version.rb

@@ -0,0 +1,5 @@
+module JsonSchema
+  module Artesano
+    VERSION = '0.0.1.beta.1'.freeze
+  end
+end

data/lib/json_schema/artesano.rb

@@ -0,0 +1,10 @@
+require_relative 'artesano/hand'
+require_relative 'artesano/tools/static'
+
+module JsonSchema
+  module Artesano
+    def self.mold(sketch:, tool: Tools::Static)
+      Hand.new(tool: tool).mold(sketch)
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: json_schema-artesano
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta.1
+platform: ruby
+authors:
+- Alfonso Mancilla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: Generate data (objects, or anything else you like) from a given JSON
+  Schema
+email:
+- almancill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_schema-artesano.gemspec
+- lib/json_schema/artesano.rb
+- lib/json_schema/artesano/hand.rb
+- lib/json_schema/artesano/tools/data_type.rb
+- lib/json_schema/artesano/tools/null.rb
+- lib/json_schema/artesano/tools/static.rb
+- lib/json_schema/artesano/version.rb
+homepage: ''
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Json Schema data generator
+test_files: []