kanpachi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e5b6e4840bc2626d0f535c41b4b1616c68ed104
-  data.tar.gz: 6a8a37c95c72696c02a1d16584f86a2e7a52da83
+  metadata.gz: 8b55c01d01b90779258c2e170be5a0125a1cbb55
+  data.tar.gz: 02a41a98655be74d77874f77a0f43fb970dc9d54
 SHA512:
-  metadata.gz: a3b3203cf7f46001360c790ebe6737221121a43e9be71d4ea9df159c2090c60c7e22bb776f25eb497128a6dc72836a16c1684d54ab4711b044f311441114367c
-  data.tar.gz: a23863a0ce77e9774db497c11c683dc350d91adc7db3011d0c490f15313c941ce545bc46befd62a6987110467f22b0249c08f9b6a6e10763d745c001add80099
+  metadata.gz: 5483acf81a19d4f96fa179aee97539250a0054638442e2ddfe9397f642c6d77948e781ddb752521aeefe27dd05fcb825cbbc7f4dfc5b3d963a91fe0fa3d6f558
+  data.tar.gz: 246d9f2479ca917f92ae46d1dae90a0603b3a0f0e450d819c6781652255d3f0a2550b4c42152020fa995319272f4e9da772a015cc526cd6990a16521643525fd

data/.gitignore

@@ -8,7 +8,7 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
+/doc
 lib/bundler/man
 pkg
 rdoc

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Kanpachi Changelog
 
+## 0.0.4
+* Add support for middleman-deploy extension, just add middleman-deploy to your
+Gemfile and then activate it in your doc/config.rb
+* Move documentation directory to doc and move doc template into doc/template
+* Default render_nils to true in all roar representers
+
 ## 0.0.3
 * Wrap documentation footer in a container class to pad copyright
 * Switch response roar representer to decorator. Prefer decorating objects

data/kanpachi.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Kanpachi::VERSION
   spec.authors       = ["Jack Chu"]
   spec.email         = ["kamuigt@gmail.com"]
-  spec.description   = %q{Web API DSL}
-  spec.summary       = %q{DSL for describing Web APIs}
+  spec.summary       = %q{DSL for describing Web APIs and generating documentation}
+  spec.description   = %q{Kanpachi is a ruby gem that provides a DSL to describe your web API, generate documentation, and will even eventually help you implement it.}
   spec.homepage      = "https://github.com/kamui/kanpachi"
   spec.license       = "MIT"
 
@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'roar'
   spec.add_dependency 'representable'
   spec.add_dependency 'mutations'
-  spec.add_dependency 'virtus', '~> 1.0.0rc2'
+  spec.add_dependency 'virtus', '~> 1.0.0'
   spec.add_dependency 'coercible'
   spec.add_dependency 'kramdown'
   spec.add_dependency 'inflecto'
-  spec.add_dependency 'middleman', '~> 3.1.5'
-  spec.add_dependency 'slim', '~> 1.3.9'
+  spec.add_dependency 'middleman', '~> 3.1.6'
+  spec.add_dependency 'slim', '~> 2.0.1'
 
   # Live-reloading plugin
   spec.add_dependency 'middleman-livereload', '~> 3.1.0'

data/lib/kanpachi/cli.rb

@@ -1,13 +1,15 @@
 require 'thor'
-require 'inflecto'
-require 'json'
 require 'middleman-core'
 require 'middleman-core/cli'
 require 'middleman-core/profiling'
-require_relative '../kanpachi'
-require_relative 'commands/new'
+require 'kanpachi'
+require 'kanpachi/commands/new'
+
+# doc template requires these gems
+require 'inflecto'
+require 'json'
 
-ENV['MM_ROOT'] = File.join(File.expand_path(File.dirname(__FILE__)), 'documentation')
+ENV['MM_ROOT'] = File.join(File.expand_path(File.dirname(__FILE__)), 'doc', 'template')
 
 class Middleman::Cli::Server
   default_task :server
@@ -30,3 +32,5 @@ module Kanpachi
     register ::Middleman::Cli::Build, 'build', task.usage, task.description, task.options
   end
 end
+
+require 'kanpachi/doc/middleman-ext/middleman-deploy'

data/lib/kanpachi/doc/middleman-ext/middleman-deploy.rb

@@ -0,0 +1,22 @@
+require 'thor'
+require 'middleman-core'
+require 'middleman-core/cli'
+require 'kanpachi'
+
+begin
+  require 'middleman-deploy'
+rescue LoadError
+end
+
+if defined? Middleman::Cli::Deploy
+  class Middleman::Cli::Deploy
+    default_task :deploy
+  end
+
+  module Kanpachi
+    class CLI < Thor
+      task = ::Middleman::Cli::Deploy.tasks['deploy']
+      register ::Middleman::Cli::Deploy, 'deploy', task.usage, task.description, task.options
+    end
+  end
+end

data/lib/kanpachi/{documentation → doc/template}/config.rb

@@ -65,12 +65,12 @@ set :js_dir, 'javascripts'
 
 set :images_dir, 'images'
 
-project_config_file = File.join(Dir.pwd, 'documentation', 'config.rb')
+project_config_file = File.join(Dir.pwd, 'doc', 'config.rb')
 if File.exist?(project_config_file)
   self.instance_eval File.read(project_config_file)
-  puts 'Loaded documentation/config.rb'
+  puts 'Loaded doc/config.rb'
 else
-  puts 'No documentation/config.rb file found'
+  puts 'No doc/config.rb file found'
 
   # Reload the browser automatically whenever files change
   activate :livereload

data/lib/kanpachi/response.rb

@@ -23,6 +23,10 @@ module Kanpachi
           include Roar::Representer::JSON
           include Roar::Decorator::HypermediaConsumer
 
+          def self.property(name, options={})
+            super(name, options.merge!(render_nil: true))
+          end
+
           def self.example
             example = Hash.new
             self.properties.each do |key, value|

data/lib/kanpachi/version.rb

@@ -1,3 +1,3 @@
 module Kanpachi
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanpachi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0rc2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0rc2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: coercible
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: 3.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: 3.1.6
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.9
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.9
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: middleman-livereload
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +234,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Web API DSL
+description: Kanpachi is a ruby gem that provides a DSL to describe your web API,
+  generate documentation, and will even eventually help you implement it.
 email:
 - kamuigt@gmail.com
 executables:
@@ -259,28 +260,29 @@ files:
 - lib/kanpachi/api_list.rb
 - lib/kanpachi/cli.rb
 - lib/kanpachi/commands/new.rb
-- lib/kanpachi/documentation/config.rb
-- lib/kanpachi/documentation/source/errors/index.html.slim
-- lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.eot
-- lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.svg
-- lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.ttf
-- lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.woff
-- lib/kanpachi/documentation/source/images/background.png
-- lib/kanpachi/documentation/source/images/middleman.png
-- lib/kanpachi/documentation/source/index.html.slim
-- lib/kanpachi/documentation/source/javascripts/all.js
-- lib/kanpachi/documentation/source/javascripts/bootstrap.js
-- lib/kanpachi/documentation/source/javascripts/bootstrap.min.js
-- lib/kanpachi/documentation/source/javascripts/html5shiv.js
-- lib/kanpachi/documentation/source/javascripts/jquery-1.10.2.min.js
-- lib/kanpachi/documentation/source/javascripts/respond.min.js
-- lib/kanpachi/documentation/source/layouts/layout.slim
-- lib/kanpachi/documentation/source/resource.html.slim
-- lib/kanpachi/documentation/source/stylesheets/bootstrap-theme.css
-- lib/kanpachi/documentation/source/stylesheets/bootstrap-theme.min.css
-- lib/kanpachi/documentation/source/stylesheets/bootstrap.css
-- lib/kanpachi/documentation/source/stylesheets/bootstrap.min.css
-- lib/kanpachi/documentation/source/stylesheets/jumbotron.css
+- lib/kanpachi/doc/middleman-ext/middleman-deploy.rb
+- lib/kanpachi/doc/template/config.rb
+- lib/kanpachi/doc/template/source/errors/index.html.slim
+- lib/kanpachi/doc/template/source/fonts/glyphicons-halflings-regular.eot
+- lib/kanpachi/doc/template/source/fonts/glyphicons-halflings-regular.svg
+- lib/kanpachi/doc/template/source/fonts/glyphicons-halflings-regular.ttf
+- lib/kanpachi/doc/template/source/fonts/glyphicons-halflings-regular.woff
+- lib/kanpachi/doc/template/source/images/background.png
+- lib/kanpachi/doc/template/source/images/middleman.png
+- lib/kanpachi/doc/template/source/index.html.slim
+- lib/kanpachi/doc/template/source/javascripts/all.js
+- lib/kanpachi/doc/template/source/javascripts/bootstrap.js
+- lib/kanpachi/doc/template/source/javascripts/bootstrap.min.js
+- lib/kanpachi/doc/template/source/javascripts/html5shiv.js
+- lib/kanpachi/doc/template/source/javascripts/jquery-1.10.2.min.js
+- lib/kanpachi/doc/template/source/javascripts/respond.min.js
+- lib/kanpachi/doc/template/source/layouts/layout.slim
+- lib/kanpachi/doc/template/source/resource.html.slim
+- lib/kanpachi/doc/template/source/stylesheets/bootstrap-theme.css
+- lib/kanpachi/doc/template/source/stylesheets/bootstrap-theme.min.css
+- lib/kanpachi/doc/template/source/stylesheets/bootstrap.css
+- lib/kanpachi/doc/template/source/stylesheets/bootstrap.min.css
+- lib/kanpachi/doc/template/source/stylesheets/jumbotron.css
 - lib/kanpachi/dsl.rb
 - lib/kanpachi/dsl/api.rb
 - lib/kanpachi/dsl/error.rb
@@ -347,7 +349,7 @@ rubyforge_project:
 rubygems_version: 2.1.7
 signing_key: 
 specification_version: 4
-summary: DSL for describing Web APIs
+summary: DSL for describing Web APIs and generating documentation
 test_files:
 - spec/api_list_spec.rb
 - spec/api_spec.rb