yard-api 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c77fccf77dd3bf2e3ae4a741c7370a085c582e8d
-  data.tar.gz: e6144b444cb6bab24354dfe02adedf784ea20356
+  metadata.gz: d00eca05fb8b95040018871a831a81f6386b966d
+  data.tar.gz: 6b63e8bb9ec6a9d2ae60b9f69c09bf353a2c381d
 SHA512:
-  metadata.gz: 08a91d47dc3fe282f1b6e5c8c2e54fc3b598df1ce89161dd4db4b6699b2f7549536c52dc2cef62ecf344961c3feb8fb36a95fc7aa5433c37b88066a4847e01da
-  data.tar.gz: 7b0a32dc7c2634e84e3af563ddb7c28d7247e4fd87e06e925515caf2a7f6a8d172057c591a3e5bab4fb6119883058e7acef4cd2ab463c2531ad0930479e8cecb
+  metadata.gz: f5a622aa5b1b3ccd2f5f8b1109c9c52849a216c3635754ead6678fbd4d8f6d8b29bb95396f44c1783fc330b856636765d69032a9df4d92a38ee11e7f7cbacb5b
+  data.tar.gz: 2a64c4471f631d75f3c6e87e84c6fb8b512be4da427a5df0c0b2cd16ae998414cac7a2f97e3ebe05f8c2cd9a1cfcbab510f84497f99e3a85ca41f595d9d14d2a

data/README.md

@@ -40,6 +40,15 @@ Read that file to view all the available options.
 
 ## Changelog
 
+**23/8/2015 [0.3.4]**
+
+- Fixed an issue that prevented overriding the Rake task's options at runtime.
+- Updated `config/yard_api.yml` to reflect the recently added options.
+
+**17/8/2015 [0.3.3]**
+
+- Improved the JSON format's output to be more concise and consistent.
+
 **30/7/2015 [0.3.1]**
 
 - Fixed a bug that was listing all the endpoints of a certain controller even if they do not have a route defined. Now, YARD-API will warn about endpoints that have an `@API` tag but could not be routed.

data/config/yard_api.yml

@@ -3,33 +3,15 @@
 output: public/doc/api
 readme: doc/api/README.md
 
-# Title of the project. This will be displayed in the browser title bar as well
-# as in the layout as the primary heading.
-title: Rails API Project
-
 url_title: my_app
 url_prefix: /api
 
-# The resource index is a mega-index page that contains all the API resources.
-resource_index: true
-
 # Generate a single page that contains all the static pages and API resources.
 # The output will be a single file.
 #
 # Implies "resource_index" is true.
 one_file: false
 
-# YARD options passed as-is.
-#
-# If you want to use github-flavored markdown, use "redcparet" as a markup
-# provider, and "markdown" as a markup and add the following gems to your
-# Gemfile *before* yard-api:
-#
-#   - "github-markup"
-#   - "redcarpet"
-markup:
-markup_provider:
-
 # The API files to extract the docs from.
 files:
   - app/controllers/**/*.rb
@@ -56,19 +38,6 @@ debug: false
 # Don't tolerate any errors such as bad asset paths, invalid tag properties, etc.
 strict: false
 
-# Each API endpoint details can provide a link to the source code of the
-# controller method if it's available on GitHub.
-#
-# Just specify the url to your repository and the branch the documentation has
-# been generated for and things "should work".
-#
-# Example: https://github.com/amireh/yard-api
-github_url:
-github_branch: master
-
-# Set to true if you want @argument tags to show up in a table instead of a list.
-tabular_arguments: false
-
 # When this option is set, all @argument tags that do not explicitly specify
 # whether they are required or optional will be marked as required. Examples:
 #
@@ -80,17 +49,6 @@ tabular_arguments: false
 # optional.
 strict_arguments: true
 
-# Width of the sidebar, in pixels.
-sidebar_width: 240
-
-# Width of the content box in pixels, or "fluid" for maximum screen space.
-#
-# Content will never overlap with the sidebar.
-content_width: "fluid"
-
-# Whitespace between the Sidebar and the content, in pixels.
-spacer: 20
-
 # Compatibility option.
 #
 # If your project (mis)uses the @argument tag to specify the name before the
@@ -105,8 +63,82 @@ spacer: 20
 # But that may not be viable in very large, existing projects.
 leading_argument_name_fix: false
 
+# ------------------------------------------------------------------------------
+# HTML-only options.
+# ------------------------------------------------------------------------------
+
+# Title of the project. This will be displayed in the browser title bar as well
+# as in the layout's sidebar as the primary heading.
+title: Rails API Project
+
+# If this is set, it will override @title in the browser's page title, but not
+# the link in the sidebar.
+window_title:
+
+# The resource index is a mega-index page that contains all the API resources.
+resource_index: true
+
+# YARD options passed as-is.
+#
+# If you want to use github-flavored markdown, use "redcparet" as a markup
+# provider, and "markdown" as a markup and add the following gems to your
+# Gemfile *before* yard-api:
+#
+#   - "github-markup"
+#   - "redcarpet"
+markup:
+markup_provider:
+
+# Each API endpoint details can provide a link to the source code of the
+# controller method if it's available on GitHub.
+#
+# Just specify the url to your repository and the branch the documentation has
+# been generated for and things "should work".
+#
+# Example: https://github.com/amireh/yard-api
+github_url:
+github_branch: master
+
+# Set to true if you want @argument tags to show up in a table instead of a list.
+tabular_arguments: false
+
+# Width of the content box in pixels, or "fluid" for maximum screen space.
+#
+# Content will never overlap with the sidebar.
+content_width: "fluid"
+
+# Width of the sidebar, in pixels.
+sidebar_width: 240
+
+# Whether the content box should be centered. This has no effect if
+# `content_width` is set to `"fluid"`.
+centered: true
+
+# Whitespace between the Sidebar and the content, in pixels.
+spacer: 20
+
+# A small "BETA" label that will show up next to a beta endpoint's title.
 use_beta_flag: true
+
+# A blocky "BETA" banner that will be displayed before a beta endpoint's
+# description body. This may attract more attention than the beta "flag"
+# setting.
 use_beta_banner: false
 
+# Whether the footer should be displayed.
 show_footer: true
-readme_page_title: Home
+
+# A copyright message to display in the top part of the footer.
+footer_copyright:
+
+# A footer message. This will be displayed below the copyright notice and the
+# generation timestamp.
+footer_note:
+
+# The text to use for the link to the docs home page in the sidebar.
+readme_page_title: Home
+
+# The UI theme to use. The stock gem provides only a "Default" theme, but other
+# plugins may provide more themes in which case you can tune this variable to
+# activate them.
+theme: Default

data/lib/yard-api/options.rb

@@ -7,9 +7,9 @@ module YARD::APIPlugin
     default_attr :output, 'compiled/doc/api'
 
     default_attr :title, 'Rails API Project'
+    default_attr :window_title, 'Rails API Project'
     default_attr :url_title, 'my_app'
     default_attr :url_prefix, '/api'
-    default_attr :window_title, 'Rails API Project Documentation'
     default_attr :version, ''
     default_attr :static, []
     default_attr :files, []

data/lib/yard-api/version.rb

@@ -1,5 +1,5 @@
 module YARD
   module APIPlugin
-    VERSION = "0.3.3"
+    VERSION = "0.3.4"
   end
 end

data/lib/yard-api/yardoc_task.rb

@@ -5,20 +5,22 @@ module YARD::APIPlugin
     attr_reader :config
 
     def initialize(name=:yard_api)
-      super(name, &:run)
+      super(name) do |t|
+        yield t if block_given?
+        t.run
+      end
     end
 
     def run
       YARD::APIPlugin.options.reset_defaults
 
-      @config = load_config
-      t = self
+      @config = api_options = YARD::APIPlugin.options.update(load_config)
 
-      api_options = YARD::APIPlugin.options.update(@config)
+      puts "Config: #{api_options.to_json}"
 
-      t.verifier = YARD::APIPlugin::Verifier.new(config['verbose'])
-      t.before = proc { FileUtils.rm_rf(config['output']) }
-      t.files = config['files']
+      self.verifier = YARD::APIPlugin::Verifier.new(config['verbose'])
+      self.before = proc { FileUtils.rm_rf(config['output']) }
+      self.files = config['files']
 
       config['debug'] ||= ENV['DEBUG']
       config['verbose'] ||= ENV['VERBOSE']
@@ -64,6 +66,10 @@ module YARD::APIPlugin
       end
     end
 
+    def configure(runtime_config)
+      @runtime_config = runtime_config
+    end
+
     private
 
     def load_config
@@ -72,6 +78,8 @@ module YARD::APIPlugin
       # load defaults
       config = YAML.load_file(File.join(YARD::APIPlugin::CONFIG_PATH, 'yard_api.yml'))
       config.merge!(YAML.load_file(path)) if File.exists?(path)
+      config.merge! @runtime_config if @runtime_config
+
       config
     end
 

data/tasks/yard_api.rake

@@ -1,14 +1,21 @@
-require 'fileutils'
-require 'yard-api/yardoc_task'
-
-runner = YARD::APIPlugin::YardocTask.new
-
 desc 'generate YARD API docs'
 task :yard_api => :environment do |t|
+  require 'fileutils'
+  require 'yard-api/yardoc_task'
+
+  runner = YARD::APIPlugin::YardocTask.new
   output = runner.config['output']
-  # TODO: make this compatible with json output format
-  puts <<-Message
-    API Documentation successfully generated in #{output}
-    See #{output}/index.html
-  Message
+
+  puts case runner.config['format']
+  when 'html'
+    <<-Message
+      API documentation (in HTML format) was successfully generated.
+      Open #{output}/index.html in a browser.
+    Message
+  when 'json'
+    <<-Message
+      API documentation (in JSON format) was successfully generated.
+      You will find the documents in #{output}/*.json
+    Message
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-api
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Ahmad Amireh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard