json_world 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eae4719f06114b2907a119beee5c4b9ec7b04d15
+  data.tar.gz: c5685b9c6d82161d9ec95efad514d87b655062d6
+SHA512:
+  metadata.gz: 76eabf0ae91aacb188238c878843c57c6c85b765ede90c26dc6d57372382f1cf87c9292a0fedff7f4b851dcb374b97f432c50d65f4ca8943e2fb96d3ed8e96f1
+  data.tar.gz: a31d598b74b08ef2785c732685c9f140d85de5dfb4edb730a5098e97ceea4f7d08f4a69724582427bca86b2764f0f94b3b26171b2a571b953c6a460cef38695c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_world.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ryo Nakamura
+
+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,78 @@
+# JsonWorld
+Provides DSL to define JSON Schema representation of your class.
+
+## Usage
+### `.property` and `.link`
+```rb
+class User
+  include JsonWorld::PropertyDefinable
+
+  property(
+    :id,
+    example: 1,
+    type: Integer,
+  )
+
+  property(
+    :name,
+    example: "alice",
+    pattern: /^\w{5}$/,
+    type: String,
+  )
+
+  link(
+    :get_user,
+    path: "/users/:user_id",
+  )
+
+  attr_reader :id, :name
+
+  # @param [Integer] id
+  # @param [String] name
+  def initialize(id: nil, name: nil)
+    @id = id
+    @name = name
+  end
+end
+```
+
+### `#to_json` and `.to_json_schema`
+```rb
+User.new(id: 1, name: "alice").to_json
+# '{"id":1,"name":"alice"}'
+
+User.to_json_schema
+# '{
+#   "links": [
+#     {
+#       "href": "/users/:user_id",
+#       "title": "get_user"
+#     }
+#   ],
+#   "properties": {
+#     "id": {
+#       "example": 1,
+#       "type": "integer"
+#     },
+#     "name": {
+#       "example": "alice",
+#       "pattern": "^\\w{5}$",
+#       "type": "string"
+#     }
+#   },
+#   "required": [
+#     "id",
+#     "name"
+#   ]
+# }'
+```
+
+See [our tests](https://github.com/r7kamura/json_world/blob/master/spec/json_world/property_definable_spec.rb)
+for more examples.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "json_world"
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/json_world.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_world/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_world"
+  spec.version       = JsonWorld::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Provides DSL to define JSON Schema representation of your class."
+  spec.homepage      = "https://github.com/r7kamura/json_world"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "json"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.2.0"
+end

data/lib/json_world/json_encodable.rb

@@ -0,0 +1,26 @@
+module JsonWorld
+  module JsonEncodable
+    # @param [Hash{Symbol => Object}] options :except / :only
+    # @return [Hash]
+    def as_json(options = {})
+      properties(options).as_json(options)
+    end
+
+    private
+
+    # @note receiver.class.property_names must be implemented
+    # @param [Hash{Symbol => Object}] options :except / :only
+    # @return [Hash]
+    def properties(options = {})
+      names = self.class.property_names
+      names = names - Array(options[:except]) if options[:except]
+      names = names & Array(options[:only]) if options[:only]
+      names.inject({}) do |hash, property_name|
+        key = property_name
+        value = send(property_name)
+        value = value.iso8601 if value.is_a?(Time)
+        hash.merge(key => value)
+      end
+    end
+  end
+end

data/lib/json_world/link_definition.rb

@@ -0,0 +1,62 @@
+module JsonWorld
+  class LinkDefinition
+    DEFAULT_HTTP_METHOD = "GET"
+
+    # @return [Symbol]
+    attr_reader :link_name
+
+    # @param [Symbol] link_name
+    # @param [Hash{Symbol => Object}] options
+    def initialize(link_name: nil, **options)
+      @options = options
+      @link_name = link_name
+    end
+
+    # @todo
+    # @return [Hash]
+    def as_json_schema
+      {
+        description: description,
+        href: path,
+        method: http_method,
+        schema: schema,
+        title: title,
+      }.reject do |_key, value|
+        value.nil? || value.empty?
+      end
+    end
+
+    private
+
+    # @return [String, nil]
+    def description
+      @options[:description]
+    end
+
+    # @note #method is reserved by Kernel.#method ;(
+    # @return [String]
+    def http_method
+      @options[:method] || DEFAULT_HTTP_METHOD
+    end
+
+    # @return [String]
+    def path
+      @options[:path]
+    end
+
+    # @return [Hash{Symbol => Object}, nil]
+    def schema
+      if @options[:parameters]
+        JsonWorld::PropertyDefinition.new(
+          properties: @options[:parameters],
+          property_name: :schema,
+        ).as_json_schema
+      end
+    end
+
+    # @return [String]
+    def title
+      @options[:title] || @link_name.to_s
+    end
+  end
+end

data/lib/json_world/property_definable.rb

@@ -0,0 +1,118 @@
+require "active_support/concern"
+require "active_support/core_ext/object/json"
+require "active_support/json"
+require "json"
+require "json_world/json_encodable"
+require "json_world/link_definition"
+require "json_world/property_definition"
+
+module JsonWorld
+  module PropertyDefinable
+    extend ActiveSupport::Concern
+
+    included do
+      include JsonWorld::JsonEncodable
+    end
+
+    private
+
+    module ClassMethods
+      attr_writer :link_definitions
+      attr_writer :property_definitions
+
+      # @return [Hash]
+      def as_json_schema
+        {
+          description: description,
+          links: links_as_json_schema,
+          properties: properties_as_json_schema,
+          required: required_property_names,
+          title: title,
+        }.reject do |_key, value|
+          value.nil? || value.empty?
+        end
+      end
+
+      # @note Override
+      def inherited(child)
+        super
+        child.link_definitions = link_definitions
+        child.property_definitions = property_definitions.clone
+      end
+
+      # @param [Symbol] link_name
+      # @param [Hash{Symbol => Object}] options
+      def link(link_name, options = {})
+        link_definitions << JsonWorld::LinkDefinition.new(
+          options.merge(
+            parent: self,
+            link_name: link_name,
+          ),
+        )
+      end
+
+      # @return [Array<JsonWorld::LinkDefinition>]
+      def link_definitions
+        @link_definitions ||= []
+      end
+
+      # @param [Symbol] property_name
+      # @param [Hash{Symbol => Object}] options
+      def property(property_name, options = {})
+        property_definitions << JsonWorld::PropertyDefinition.new(
+          options.merge(
+            parent: self,
+            property_name: property_name,
+          )
+        )
+      end
+
+      # @return [Array<JsonWorld::PropertyDefinition>]
+      def property_definitions
+        @property_definitions ||= []
+      end
+
+      # @return [Array<Symbol>]
+      def property_names
+        property_definitions.map(&:property_name)
+      end
+
+      # @return [Array<Symbol>]
+      def required_property_names
+        property_definitions.reject(&:optional?).map(&:property_name)
+      end
+
+      # @note .as_json_schema wrappter
+      # @return [String]
+      def to_json_schema
+        JSON.pretty_generate(as_json_schema)
+      end
+
+      private
+
+      # @return [String, nil]
+      def description(value = nil)
+        @description ||= value
+      end
+
+      # @return [Array<Hash>]
+      def links_as_json_schema
+        link_definitions.map(&:as_json_schema)
+      end
+
+      # @return [Hash]
+      def properties_as_json_schema
+        property_definitions.inject({}) do |result, property_definition|
+          result.merge(
+            property_definition.property_name => property_definition.as_json_schema,
+          )
+        end
+      end
+
+      # @return [String, nil]
+      def title(value = nil)
+        @title ||= value
+      end
+    end
+  end
+end

data/lib/json_world/property_definition.rb

@@ -0,0 +1,142 @@
+module JsonWorld
+  class PropertyDefinition
+    # @return [Symbol]
+    attr_reader :property_name
+
+    # @param [Symbol, nil] property_name Note that unnamed property can be passed
+    # @param [Hash{Symbol => Object}] options
+    def initialize(property_name: nil, **options)
+      @options = options
+      @property_name = property_name
+    end
+
+    # @return [Hash{Symbol => Object}]
+    def as_nested_json_schema
+      { property_name => as_json_schema }
+    end
+
+    # @return [Hash{Symbol => Object}]
+    def as_json_schema
+      {
+        description: description,
+        example: example,
+        format: format_type,
+        items: items_as_json_schema,
+        pattern: pattern_in_string,
+        properties: properties_as_json_schema,
+        required: required_property_names,
+        type: type,
+        uniqueItems: unique_flag,
+      }.reject do |_key, value|
+        value.nil? || value.respond_to?(:empty?) && value.empty?
+      end
+    end
+
+    # @return [false, true] True if explicitly this property is defined as optional
+    def optional?
+      !!@options[:optional]
+    end
+
+    private
+
+    # @return [String, nil]
+    def description
+      @options[:description]
+    end
+
+    # @return [Object]
+    def example
+      @options[:example]
+    end
+
+    # @note format is preserved by Kernel.#format ;(
+    # @return [String, nil]
+    def format_type
+      if types.include?(Time)
+        "date-time"
+      end
+    end
+
+    # @note Tuple validation is not supported yet
+    # @return [Array<Hash>, nil]
+    def items_as_json_schema
+      if @options[:items]
+        JsonWorld::PropertyDefinition.new(@options[:items]).as_json_schema
+      end
+    end
+
+    # @note pattern can be used only when type is String or not specified
+    # @return [Regexp, nil]
+    def pattern
+      @options[:pattern]
+    end
+
+    # @return [String, nil]
+    def pattern_in_string
+      if pattern
+        pattern.inspect[1..-2]
+      end
+    end
+
+    # @return [Hash, nil]
+    def properties_as_json_schema
+      if @options[:properties]
+        property_definitions.map(&:as_nested_json_schema).inject({}, :merge)
+      end
+    end
+
+    # @return [Array, nil]
+    def property_definitions
+      if @options[:properties]
+        @options[:properties].map do |property_name, options|
+          JsonWorld::PropertyDefinition.new(
+            options.merge(
+              property_name: property_name,
+            )
+          )
+        end
+      end
+    end
+
+    # @return [Array<Symbol>, nil]
+    def required_property_names
+      if @options[:properties]
+        property_definitions.reject(&:optional?).map(&:property_name)
+      end
+    end
+
+    # @return [Array<String>, String, nil]
+    def type
+      strings = types.map do |this_type|
+        case
+        when this_type == Array
+          "array"
+        when this_type == Float
+          "float"
+        when this_type == Hash
+          "object"
+        when this_type == Integer
+          "integer"
+        when this_type == NilClass
+          "null"
+        when this_type == String || this_type == Time
+          "string"
+        end
+      end.compact
+      strings.length >= 2 ? strings : strings.first
+    end
+
+    # @note type can be an Array
+    # @return [Array<String>]
+    def types
+      Array(@options[:type])
+    end
+
+    # @return [false, nil, true]
+    def unique_flag
+      if @options.key?(:unique)
+        !!@options[:unique]
+      end
+    end
+  end
+end

data/lib/json_world/version.rb

@@ -0,0 +1,3 @@
+module JsonWorld
+  VERSION = "0.0.1"
+end

data/lib/json_world.rb

@@ -0,0 +1,2 @@
+require "json_world/property_definable"
+require "json_world/version"

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: json_world
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_world.gemspec
+- lib/json_world.rb
+- lib/json_world/json_encodable.rb
+- lib/json_world/link_definition.rb
+- lib/json_world/property_definable.rb
+- lib/json_world/property_definition.rb
+- lib/json_world/version.rb
+homepage: https://github.com/r7kamura/json_world
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Provides DSL to define JSON Schema representation of your class.
+test_files: []
+has_rdoc: