jdoc 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d15231d47a686a9226e686f608bed11b376f3368
-  data.tar.gz: 05a43e5ce89ec70fc444f7861fb9eec825f3990f
+  metadata.gz: bbc21692c07ab9fe470cc9bb20a30396e5305765
+  data.tar.gz: 3c48d113af68dd3e9b4157f005c16619edc7b1ab
 SHA512:
-  metadata.gz: 23cce94dbe1d36ae3524d3fe06e7626a7ce79fffc87ac089041cac4521197ee301407226aa01de4dc6bc28da93a22e0eb6a18978a7092e41c39296377335f4a5
-  data.tar.gz: 10c0212757b32120bef86909438ae78f15e198733bd49c4ab9ecffbb1cce1a876b476e603a04927911d12c68822888e5a8f9eafb165b2e78839fd6a995fff50f
+  metadata.gz: 5a8eae9246f34f5cf66827f490ab48a99abf017597280f39269007c981a54b4dd9e062c513cda93ed098a140e03099e09ef880276a132350accabe4b41b5dbe3
+  data.tar.gz: 5e4cd2d1ef3dd61fb3e4d7617806b0c9c0fcf2eddd9f8e45025721690f59aa41366bbbf09f0efa8fc50835ca0c435d4d7c309e6c13301123279531da00825436

data/CHANGELOG.md

@@ -1,90 +1,123 @@
+## 0.4.3
+
+- Add some CLI options (Thx @k1LoW)
+
 ## 0.4.2
+
 - Show reason phrase in response example (Thx @minodisk)
 
 ## 0.4.1
+
 - Use 204 for `mediaType: "null"`
 
 ## 0.4.0
+
 - Recognize `mediaType: 'null'` as "No response body"
 
 ## 0.3.4
+
 - Treat empty request parameters as no request body
 
 ## 0.3.3
+
 - Improve pattern format in properties section
 
 ## 0.3.2
+
 - Add generator options to change template
 - Add request parameters for each endpoint
 
 ## 0.3.1
+
 - Add error handling for ExampleNotFound
 
 ## 0.3.0
+
 - Change example response status and body to PUT & DELETE requests
 - Improve request path example by resolving variable in path
 
 ## 0.2.1
+
 - Support multipart/form-data
 
 ## 0.2.0
+
 - Show schema description on docs if exists
 
 ## 0.1.9
+
 - Support property that has no type
 
 ## 0.1.8
+
 - Support property that is an array of primitive values
 
 ## 0.1.7
+
 - Support query string example in GET request
 - Improve the description property visibility
 
 ## 0.1.6
+
 - Disable `<em>` feature of Redcarpet
 
 ## 0.1.5
+
 - Fix ToC link on HTML docs
 
 ## 0.1.4
+
 - Provide :html option to render docs in HTML
 
 ## 0.1.3
+
 - Use its pointer name if a resource has no title property
 
 ## 0.1.2
+
 - Use .schema property for request body if exists
 - Improve array resource handling
 
 ## 0.1.1
+
 - Support has-one relation
 
 ## 0.1.0
+
 - Show resources which have no links
 
 ## 0.0.9
+
 - Support array property
 
 ## 0.0.8
+
 - Fix resource equality
 
 ## 0.0.7
+
 - Support `false` & `null` example value
 
 ## 0.0.6
+
 - Use root API endpoint at example response
 
 ## 0.0.5
+
 - Remove dependency on multi_json
 
 ## 0.0.4
+
 - Support whitespace and multiple templates in href
 
 ## 0.0.3
+
 - Fix missing gem dependencies
 
 ## 0.0.2
+
 - Remove dependency on rack-spec
 
 ## 0.0.1
+
 - 1st Release

data/README.md

@@ -10,5 +10,5 @@ $ gem install jdoc
 See [example-api-documentation.md](example-api-documentation.md) generated by the following command.
 
 ```sh
-$ jdoc spec/fixtures/schema.json > example-api-documentation.md
+$ jdoc spec/fixtures/schema.yml > example-api-documentation.md
 ```

data/bin/jdoc

@@ -2,9 +2,26 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require "jdoc"
 require "yaml"
+require "optparse"
+
+opt = OptionParser.new
+banner = 'Usage: jdoc <schema.json or schema.yml> [options]'
+opt.banner = banner
+Version = Jdoc::VERSION
+options = {
+  html: false,
+  html_template_path: nil,
+  markdown_template_path: nil
+}
+
+opt.on("--html") { |_| options[:html] = true }
+opt.on("--html-template-path ERB_FILE") { |v| options[:html_template_path] = v }
+opt.on("--markdown-template-path ERB_FILE") { |v| options[:markdown_template_path] = v }
+
+opt.parse!(ARGV)
 
 unless path = ARGV[0]
-  puts "usage: #{$0} <schema.json or schema.yml>"
+  puts banner
   exit
 end
 
@@ -16,4 +33,9 @@ else
   schema = JSON.parse(str)
 end
 
-puts Jdoc::Generator.call(schema)
+puts Jdoc::Generator.call(
+  schema,
+  html: options[:html],
+  html_template_path: options[:html_template_path],
+  markdown_template_path: options[:markdown_template_path],
+)

data/lib/jdoc/link.rb

@@ -55,7 +55,7 @@ module Jdoc
     # @return [String] Request path name, defined at href property
     # @note URI Template is replaced with placeholder
     # @example
-    #   link.path #=> "GET /apps/:id"
+    #   link.path #=> "/apps/:id"
     def path
       @path ||= @raw_link.href.gsub(/{(.+?)}/) do
         ":" + CGI.unescape($1).gsub(/[()\s]/, "").split("/").last
@@ -65,7 +65,7 @@ module Jdoc
     # @returns [String] Path with embedded example variable
     # @raise [Rack::Spec::Mock::ExampleNotFound]
     # @example
-    #   link.example_path #=> "GET /apps/1"
+    #   link.example_path #=> "/apps/1"
     def example_path
       @example_path ||= @raw_link.href.gsub(/{\((.+?)\)}/) do
         pointer = CGI.unescape($1)

data/lib/jdoc/version.rb

@@ -1,3 +1,3 @@
 module Jdoc
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jdoc
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Generate API documentation from JSON Schema.
@@ -194,4 +194,3 @@ test_files:
 - spec/fixtures/schema.yml
 - spec/jdoc/generator_spec.rb
 - spec/spec_helper.rb
-has_rdoc: