nidyx 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8433c258d171e3151329b3623a8fb03ee27cd9a6
-  data.tar.gz: 69d7d5702a72d1123c2bf0659e82c6d517714598
+  metadata.gz: dfb9be5f10368cc90ad4e6692306e0b1f525f657
+  data.tar.gz: 5381d4cc120acdc4a4f020d73218951fe4bc54e4
 SHA512:
-  metadata.gz: 7c5d42a4d48c2b1a4b2a45b6e5b99eb27f4a04bed8a25de6b97ca2c102651cf3e11d037260ac105471d46eb5a4a78973685e837d97d2b5107ee412fc6c613275
-  data.tar.gz: 8fed850402a9f1480479aef191a0e45c66bd95515c1606ea5d4adef2a1e2f8a5ef95eb55d848692ca7dd2ea6023efd4646e21d9819e5d4343f3327448eb48f7e
+  metadata.gz: 0743f7437b9476c4fe6330fdb54284c8265b3745e1afb9e8f6a5e56e2cb6c43c61b1b16a4e0cd9dc37a103889e0924d99dfdb00631f88a39e56d3d18e536cb30
+  data.tar.gz: 8eca92e4a710fa7d1903db3a3cf5415beb0c1f8f728d6b94b38620004fb3c456a7695b94304b9da82b40d0a7437df559a6e70ca45a79525cff9432bdb812c978

data/README.md

@@ -1,4 +1,4 @@
-# Nidyx [![Gem Version](https://img.shields.io/gem/v/nidyx.svg)](https://rubygems.org/gems/nidyx) [![Build Status](https://travis-ci.org/cknadler/nidyx.svg?branch=master)](https://travis-ci.org/cknadler/nidyx) [![Code Climate](https://codeclimate.com/github/cknadler/nidyx/badges/gpa.svg)](https://codeclimate.com/github/cknadler/nidyx)
+# Nidyx [![Gem Version](https://badge.fury.io/rb/nidyx.svg)](http://badge.fury.io/rb/nidyx) [![Build Status](https://travis-ci.org/cknadler/nidyx.svg?branch=master)](https://travis-ci.org/cknadler/nidyx) [![Code Climate](https://codeclimate.com/github/cknadler/nidyx/badges/gpa.svg)](https://codeclimate.com/github/cknadler/nidyx) [![Documentation](https://inch-ci.org/github/cknadler/nidyx.svg?branch=master)](https://inch-ci.org/github/cknadler/nidyx)
 
 [JSON Schema][JSONSchema] ⇒ Model.
 
@@ -15,14 +15,15 @@ $ gem install nidyx
 
 ```
 usage: nidyx [-h] [--version]
-       nidyx <schema> <class-prefix>
-             [-n] [-a author] [-c company] [-p project] [-o directory]
+       nidyx <schema> [-n] [-a author] [-c company] [-p project]
+             [-o directory] [-x prefix]
              [--json-model] # objc specific
 
     -a, --author AUTHOR              Author's name
     -c, --company COMPANY            Company's name
     -p, --project PROJECT            Project's name
     -o, --output DIRECTORY           Output models to a specific directory
+    -x, --class-prefix PREFIX        Add a prefix to generated model names
     -n, --no-comments                Generate without header comments
         --json-model                 Generate with JSONModel support
     -h, --help                       Print usage information
@@ -34,19 +35,17 @@ models with JSONModel support.
 Examples
 ========
 
-Bare minimum. Given a schema and a class prefix, generate models in the
-current directory:
+Generate models for a given schema.
 
-  $ nidyx example.json.schema ClassPrefix
+  $ nidyx example.json.schema
 
-Specify an ouput directory:
+Specify an ouput directory and a class prefix:
 
-  $ nidyx example.json.schema ClassPrefix -o /path/to/output/directory
+  $ nidyx example.json.schema -x ClassPrefix -o /path/to/output/directory
 
-Generate models with JSONModel support and optional documentation:
+Generate with JSONModel support and optional documentation:
 
-  $ nidyx example.json.schema ClassPrefix -o /path/to/output/directory \
-    --json-model -a "Your Name" -c "Company Name" -p "Project Name"
+  $ nidyx example.json.schema --json-model -a "Your Name" -p "Project Name"
 ```
 
 ## Features

data/lib/nidyx/parse_constants.rb

@@ -13,6 +13,7 @@ module Nidyx
     NAME_OVERRIDE_KEY    = "nameOverride"
     ITEMS_KEY            = "items"
     MINIMUM_KEY          = "minimum"
+    ANY_OF_KEY           = "anyOf"
 
     ###
     # Internal schema key definitions

data/lib/nidyx/parser.rb

@@ -129,28 +129,40 @@ module Nidyx
       obj
     end
 
-    # Resolves any references burried in the `items` property of an array
+    # Resolves any references buied in the `items` property of an array
     # definition. Returns a list of collection types in the array.
     # @param obj [Hash] the array property schema
-    # @return [Array] list of types in the array
+    # @return [Array] types contained in the array
     def resolve_array_refs(obj)
       items = obj[ITEMS_KEY]
-      types = []
-
       case items
       when Array
-        items.each do |i|
-          resolve_reference_string(i[REF_KEY])
-          types << class_name_from_ref(i[REF_KEY])
-        end
+        return resolve_items_array(items)
       when Hash
+        # handle a nested any of key
+        any_of = items[ANY_OF_KEY]
+        return resolve_items_array(any_of) if any_of.is_a?(Array)
+
         resolve_reference_string(items[REF_KEY])
-        types << class_name_from_ref(items[REF_KEY])
+        return [class_name_from_ref(items[REF_KEY])].compact
+      else
+        return []
       end
+    end
 
+    # @param items [Array] an array of items
+    # @return [Array] types contained in the array
+    def resolve_items_array(items)
+      types = []
+      items.each do |item|
+        resolve_reference_string(item[REF_KEY])
+        types << class_name_from_ref(item[REF_KEY])
+      end
       types.compact
     end
 
+    # @param ref [String] reference in json pointer format
+    # @return [String] the class name of the object at the location of the ref
     def class_name_from_ref(ref)
       class_name_from_path(@class_prefix, Nidyx::Pointer.new(ref).path, @schema) if ref
     end

data/lib/nidyx/version.rb

@@ -1,3 +1,3 @@
 module Nidyx
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/nidyx/test_parser.rb

@@ -329,7 +329,7 @@ class TestParser < Minitest::Test
           "type" => "object",
           "nameOverride" => "somethingElse",
           "properties" => {
-            "recObject" => { 
+            "recObject" => {
               "type" => "object",
               "nameOverride" => "rec",
               "properties" => {
@@ -353,8 +353,8 @@ class TestParser < Minitest::Test
     # something model
     model = models["TSSomethingModel"]
     props = model.properties
-    name = props.shift
-    assert_equal("TSSomethingElseModel", name.class_name)
+    value = props.shift
+    assert_equal("TSSomethingElseModel", value.class_name)
 
     # something else model
     model = models["TSSomethingElseModel"]
@@ -444,6 +444,66 @@ class TestParser < Minitest::Test
     assert_equal(:boolean, bool.type)
   end
 
+  def test_any_of_array
+    schema = {
+      "type" => "object",
+      "properties" => {
+        "widgets" => {
+          "type" => "array",
+          "items" => {
+            "anyOf" => [
+              { "$ref" => "#/definitions/object" },
+              { "$ref" => "#/definitions/otherObject" }
+            ]
+          }
+        }
+      },
+      "definitions" => {
+        "object" => {
+          "type" => "object",
+          "properties" => {
+            "count" => { "type" => "integer" }
+          }
+        },
+        "otherObject" => {
+          "type" => "object",
+          "properties" => {
+            "lastObject" => { "$ref" => "#/definitions/lastObject" }
+          }
+        },
+        "lastObject" => {
+          "type" => "object",
+          "properties" => {
+            "limit" => { "type" => "integer" }
+          }
+        }
+      }
+    }
+
+    models = parse(schema)
+    assert_equal(4, models.size)
+
+    # root model
+    props = models["TSModel"].properties
+    value = props.shift
+    assert_equal(:array, value.type)
+
+    # object model
+    props = models["TSObjectModel"].properties
+    value = props.shift
+    assert_equal(:integer, value.type)
+
+    # other object model
+    props = models["TSOtherObjectModel"].properties
+    value = props.shift
+    assert_equal("TSLastObjectModel", value.class_name)
+
+    # last object model
+    props = models["TSLastObjectModel"].properties
+    value = props.shift
+    assert_equal(:integer, value.type)
+  end
+
   private
 
   OPTIONS = {

metadata

@@ -1,72 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: nidyx
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Chris Knadler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.99.5
+        version: 0.99.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.99.5
+        version: 0.99.6
 - !ruby/object:Gem::Dependency
   name: rake
   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: ruby_gntp
+  name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: JSON Schema -> Objective-C model generator
+description: Nidyx generates Objective-C models from JSONSchema files. Use your API's
+  spec to make your client's models in a snap.
 email: takeshi91k@gmail.com
 executables:
 - nidyx
@@ -75,6 +76,10 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- LICENSE
+- README.md
+- bin/nidyx
+- lib/nidyx.rb
 - lib/nidyx/common.rb
 - lib/nidyx/core_ext/string.rb
 - lib/nidyx/generator.rb
@@ -93,13 +98,10 @@ files:
 - lib/nidyx/property.rb
 - lib/nidyx/reader.rb
 - lib/nidyx/version.rb
-- lib/nidyx.rb
 - templates/objc/implementation.mustache
 - templates/objc/imports.mustache
 - templates/objc/interface.mustache
 - templates/objc/top_info.mustache
-- README.md
-- LICENSE
 - test/nidyx/core_ext/test_string.rb
 - test/nidyx/objc/test_model_base.rb
 - test/nidyx/objc/test_property.rb
@@ -108,7 +110,6 @@ files:
 - test/nidyx/test_parser.rb
 - test/nidyx/test_pointer.rb
 - test/nidyx/test_property.rb
-- bin/nidyx
 homepage: https://github.com/cknadler/nidyx
 licenses:
 - MIT
@@ -119,20 +120,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Nidyx
+summary: JSON Schema -> Objective-C models
 test_files:
 - test/nidyx/core_ext/test_string.rb
 - test/nidyx/objc/test_model_base.rb