nidyx 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 620ad52c2e4a4fa44264672fd8f656300941d026
-  data.tar.gz: fe194858912221641ccb664743053e8e774648a7
+  metadata.gz: 8433c258d171e3151329b3623a8fb03ee27cd9a6
+  data.tar.gz: 69d7d5702a72d1123c2bf0659e82c6d517714598
 SHA512:
-  metadata.gz: 07ec069cc6aeedd67d0f69531d08685c01506c75692271e4e8571ab560f74e95f387969975f8e1022e51856e64052a825d32857974af7eb0cf27d169fa7dc420
-  data.tar.gz: c9d5a548dec4b6fdf44102fe64fb6c640f1fdcfc04e01b31a12fd50c6a115caf0588346e32879dd16089c9d968895875af68b618669d2a1245aa3654261bacaf
+  metadata.gz: 7c5d42a4d48c2b1a4b2a45b6e5b99eb27f4a04bed8a25de6b97ca2c102651cf3e11d037260ac105471d46eb5a4a78973685e837d97d2b5107ee412fc6c613275
+  data.tar.gz: 8fed850402a9f1480479aef191a0e45c66bd95515c1606ea5d4adef2a1e2f8a5ef95eb55d848692ca7dd2ea6023efd4646e21d9819e5d4343f3327448eb48f7e

data/README.md

@@ -15,14 +15,16 @@ $ gem install nidyx
 
 ```
 usage: nidyx [-h] [--version]
-       nidyx <schema> <class-prefix> [output-directory]
-             [-j] [-n] [-a author] [-c company] [-p project]
+       nidyx <schema> <class-prefix>
+             [-n] [-a author] [-c company] [-p project] [-o directory]
+             [--json-model] # objc specific
 
     -a, --author AUTHOR              Author's name
     -c, --company COMPANY            Company's name
     -p, --project PROJECT            Project's name
-    -j, --json-model                 Generate with JSONModel support
+    -o, --output DIRECTORY           Output models to a specific directory
     -n, --no-comments                Generate without header comments
+        --json-model                 Generate with JSONModel support
     -h, --help                       Print usage information
         --version                    Print version
 
@@ -39,13 +41,12 @@ current directory:
 
 Specify an ouput directory:
 
-  $ nidyx example.json.schema ClassPrefix /path/to/output/directory
+  $ nidyx example.json.schema ClassPrefix -o /path/to/output/directory
 
-Generate models with JSONModel support and all optional documentation:
-
-  $ nidyx example.json.schema ClassPrefix /path/to/output/directory \
-    -j -a "Your Name" -c "Company Name" -p "Project Name"
+Generate models 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"
 ```
 
 ## Features

data/bin/nidyx

@@ -11,8 +11,8 @@ require "nidyx/generator"
 
 BANNER = <<END
 usage: nidyx [-h] [--version]
-       nidyx <schema> <class-prefix> [output-directory]
-             [-n] [-a author] [-c company] [-p project]
+       nidyx <schema> [-n] [-a author] [-c company] [-p project]
+             [-o directory] [-x prefix]
              [--json-model] # objc specific
 
 END
@@ -25,19 +25,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 /path/to/output/directory
+  $ nidyx example.json.schema -x ClassPrefix -o /path/to/output/directory
 
-Generate models with JSONModel support and all optional documentation:
+Generate with JSONModel support and optional documentation:
 
-  $ nidyx example.json.schema ClassPrefix /path/to/output/directory \\
-    -j -a "Your Name" -c "Company Name" -p "Project Name"
+  $ nidyx example.json.schema --json-model -a "Your Name" -p "Project Name"
 
 END
 
@@ -58,24 +56,27 @@ opts = OptionParser.new do |o|
   o.banner = BANNER
 
   # general generation options
-  o.on("-a", "--author AUTHOR", "Author's name") do |a|
-    options[:author] = a
+  o.on("-a", "--author AUTHOR", "Author's name") do |author|
+    options[:author] = author
   end
-
-  o.on("-c", "--company COMPANY", "Company's name") do |c|
-    options[:company] = c
+  o.on("-c", "--company COMPANY", "Company's name") do |company|
+    options[:company] = company
   end
-
-  o.on("-p", "--project PROJECT", "Project's name") do |p|
-    options[:project] = p
+  o.on("-p", "--project PROJECT", "Project's name") do |project|
+    options[:project] = project
   end
-
-  o.on("-n", "--no-comments", "Generate without header comments") do |n|
+  o.on("-o", "--output DIRECTORY", "Output models to a specific directory") do |output_directory|
+    options[:output_directory] = output_directory
+  end
+  o.on("-x", "--class-prefix PREFIX", "Add a prefix to generated model names") do |prefix|
+    options[:class_prefix] = prefix
+  end
+  o.on("-n", "--no-comments", "Generate without header comments") do
     options[:comments] = false
   end
 
   # objc generation options
-  o.on("--json-model", "Generate with JSONModel support") do |j|
+  o.on("--json-model", "Generate with JSONModel support") do
     options[:objc][:json_model] = true
   end
 
@@ -84,7 +85,6 @@ opts = OptionParser.new do |o|
     puts o
     exit
   end
-
   o.on("--version", "Print version") do
     puts Nidyx::VERSION
     exit
@@ -101,16 +101,14 @@ rescue OptionParser::InvalidOption => e
   exit 1
 end
 
-if ARGV.size < 2
+if ARGV.size < 1
   puts "Too few arguments." unless ARGV.empty?
   puts opts
   exit 1
 end
 
-options[:output_path] = ARGV[2]
-
 ###
 # run
 ###
 
-Nidyx::Generator.run(ARGV[0], ARGV[1], options)
+Nidyx::Generator.run(ARGV[0], options)

data/lib/nidyx/common.rb

@@ -1,3 +1,7 @@
+require "nidyx/parse_constants"
+
+include Nidyx::ParseConstants
+
 module Nidyx
   module Common
     class NoObjectAtPathError < StandardError; end
@@ -6,10 +10,12 @@ module Nidyx
     IGNORED_KEYS = "properties", "definitions"
 
     def class_name(prefix, key)
-      if key
+      if key && prefix
         prefix + key.camelize + CLASS_SUFFIX
-      else
+      elsif prefix
         prefix + CLASS_SUFFIX
+      else
+        CLASS_SUFFIX
       end
     end
 

data/lib/nidyx/generator.rb

@@ -7,11 +7,15 @@ module Nidyx
   module Generator
     extend self
 
-    def run(schema_path, model_prefix, options)
+    # The Nidyx model generator. Called by the Nidyx CLI. Parses the input
+    # schema, creates models and writes them to the output directory.
+    # @param schema_path [String] Path to the schema to generate models with.
+    # @param options [Hash] Model generation options hash.
+    def run(schema_path, options)
       schema = Nidyx::Reader.read(schema_path)
-      raw_models = Nidyx::Parser.parse(model_prefix, schema, options)
+      raw_models = Nidyx::Parser.parse(schema, options)
       models = Nidyx::Mapper.map(raw_models, options)
-      Nidyx::Output.write(models, options[:output_path])
+      Nidyx::Output.write(models, options[:output_directory])
     end
   end
 end

data/lib/nidyx/parser.rb

@@ -13,13 +13,12 @@ module Nidyx
 
     class UnsupportedSchemaError < StandardError; end
 
-    # @param model_prefix [String] the prefix for model names
     # @param schema [Hash] JSON Schema
     # @param options [Hash] global application options
     # @return [Hash] a Hash of ModelData objects
-    def parse(model_prefix, schema, options)
+    def parse(schema, options)
       # setup parser
-      @class_prefix = model_prefix
+      @class_prefix = options[:class_prefix]
       @options = options
       @schema = schema
       @models = {}

data/lib/nidyx/version.rb

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

data/templates/objc/interface.mustache

@@ -6,12 +6,10 @@
 
 {{/json_model?}}
 @interface {{name}}{{#json_model?}} : JSONModel{{/json_model?}}
-
 {{#properties}}
 {{#desc}}
 // {{{desc}}}
 {{/desc}}
 @property ({{attributes}}{{getter_override}}) {{type_name}}{{#json_model?}}{{#has_protocols?}}<{{protocols_string}}>{{/has_protocols?}}{{/json_model?}} {{#is_obj?}}*{{/is_obj?}}{{name}};
 {{/properties}}
-
 @end

data/test/nidyx/test_common.rb

@@ -9,6 +9,7 @@ class TestCommon < Minitest::Test
     assert_equal("DKResponseModel", class_name("DK", "response"))
     assert_equal("DKModel", class_name("DK", nil))
     assert_equal("DKLargeButtonModel", class_name("DK", "large_button"))
+    assert_equal("Model", class_name(nil, nil))
   end
 
   def test_class_name_from_path

data/test/nidyx/test_comparison.rb

@@ -40,7 +40,7 @@ class TestComparison < Minitest::Test
   def run_generate(example_name)
     cmd = "bundle exec nidyx " <<
           example_schema_path(example_name) <<
-          " #{PREFIX} #{TMP_PATH} -n --json-model"
+          " -x #{PREFIX} -o #{TMP_PATH} -n --json-model"
 
     assert(false) unless system(cmd)
   end

data/test/nidyx/test_parser.rb

@@ -446,8 +446,9 @@ class TestParser < Minitest::Test
 
   private
 
-  PREFIX = "TS"
-  OPTIONS = {}
+  OPTIONS = {
+    :class_prefix => "TS"
+  }
 
   def assert_deps(expected, model)
     actual = model.dependencies
@@ -455,6 +456,6 @@ class TestParser < Minitest::Test
   end
 
   def parse(schema)
-    Nidyx::Parser.parse(PREFIX, schema, OPTIONS)
+    Nidyx::Parser.parse(schema, OPTIONS)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nidyx
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Knadler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache