webapidoc 0.0.4 → 0.0.5

data/README.md

@@ -1,4 +1,4 @@
-# WebApiDoc
+# Webapidoc
 
 ## Installation
 
@@ -11,7 +11,7 @@
     namespace :webapidoc do
 
       task :build do
-        WebApiDoc.build({:title => "WebApiDoc"})
+        Webapidoc.build({:title => "Webapidoc"})
       end
 
     end

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'webapidoc'
+
+namespace :webapidoc do
+  task :build do
+    Webapidoc.build({:title => "Webapidoc"})
+  end
+end

data/lib/generators/webapidoc/install_generator.rb

@@ -0,0 +1,25 @@
+#lib/generators/gemname/install_generator.rb
+require 'rails/generators'
+require "webapidoc"
+
+module Webapidoc
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "generate api documentation sample"
+
+      def copy_files
+        source_root ||= File.join(File.dirname(__FILE__), 'templates')
+
+        # create paths
+        FileUtils.mkdir_p "app/documentation"
+
+        # copy files
+        FileUtils.copy(source_root + "/index.md.erb", "app/documentation")
+        FileUtils.copy(source_root + "/sample.md.erb", "app/documentation")
+        FileUtils.copy(source_root + "/webapidoc.yml", "config")
+
+        puts "done"
+      end
+    end
+  end
+end

data/lib/{webapidoc → generators/webapidoc/templates}/index.md.erb

@@ -11,5 +11,5 @@ the aid of their country.
 ### Table of contents
 
 <% @chapters.each_with_index do |chapter, idx| %>
-<%= idx %>. [<%= chapter[:name] %>](<%= chapter[:out] %>)
+<%= idx %>. [<%= chapter[:name] %>](/documentation/<%= chapter[:out] %>)
 <% end %>

data/{app/documentation → lib/generators/webapidoc/templates}/sample.md.erb

@@ -39,7 +39,7 @@ Support for ERB
 Table of contents generated via ERB:
 
 <% @chapters.each_with_index do |chapter, idx| %>
-<%= idx %>. [<%= chapter[:name] %>](<%= chapter[:out] %>)
+<%= idx %>. [<%= chapter[:name] %>](/documentation/<%= chapter[:out] %>)
 <% end %>
 
 Some code

data/{config → lib/generators/webapidoc/templates}/webapidoc.yml

@@ -2,6 +2,9 @@ title: "WebAPIDoc"
 description: "Static HTML Documentation for JSON APIs"
 
 chapters:
+  -
+    file: "index"
+    name: "Index Page"
   -
     file: "sample"
     name: "Sample Page"

data/lib/webapidoc/base.rb

@@ -0,0 +1,98 @@
+
+module Webapidoc
+
+  def self.gem_libdir
+    t = ["#{File.dirname(File.expand_path($0))}/../lib/#{Webapidoc::NAME}",
+         "#{Gem.dir}/gems/#{Webapidoc::NAME}-#{Webapidoc::VERSION}/lib/#{Webapidoc::NAME}"]
+    t.each {|i| return i if File.readable?(i) }
+    raise "both paths are invalid: #{t}"
+  end
+
+  def self.build(data=nil)
+
+    @data = data
+
+    publicDir = "public/documentation"
+    docDir = "app/documentation"
+    libDir = gem_libdir
+
+    # get config hash
+    configFile = 'config/webapidoc.yml'
+    config = YAML.load_file(configFile).freeze
+
+    puts "building webapidoc for " + config["title"]
+
+    # clean up
+    FileUtils.remove_dir publicDir if File.exists?(publicDir)
+
+    # create paths
+    FileUtils.mkdir_p publicDir
+    FileUtils.mkdir publicDir + "/css"
+    FileUtils.mkdir publicDir + "/js"
+
+    # copy jquery
+    FileUtils.copy(libDir + "/js/jquery.js", publicDir + "/js/jquery.js")
+
+    # copy highlighter
+    FileUtils.copy(libDir + "/js/highlight.js", publicDir + "/js/highlight.js")
+
+    # compile webapidoc style
+    sass_filename = libDir + "/css/webapidoc.scss"
+    css = Sass::Engine.for_file(sass_filename, {:style => :compressed}).render
+    File.open(publicDir + "/css/webapidoc.css", "wb") {|f| f.write(css) }
+
+    # parse chapters and create html from md
+    @chapters = []
+
+    # get chapter info
+    config["chapters"].each_with_index do | chapter, idx|
+
+      inFile = "#{docDir}/#{chapter["file"]}.md"
+      outFile = chapter["file"] + ".html"
+
+      if File.exists?(inFile + ".erb" )
+        inFile = inFile + ".erb"
+      end
+
+      if File.exists?(inFile)
+        contents = File.open(inFile, 'r').read
+      else
+        puts "file not found: #{inFile}"
+        next
+      end
+
+      @chapters << { :name => chapter["name"],  :out => outFile, :in => inFile}
+    end
+
+    @chapters.each_with_index do | chapter, idx|
+
+      contents = ERB.new(File.open(chapter[:in], 'r').read).result(binding)
+      maruku = Maruku.new(contents)
+
+      # get content info for subsections ( side pane navigation )
+      sections = []
+      maruku.each_element(:header) do | el |
+        next unless el.meta_priv[:level] == 2
+        sections << el.children[0]
+      end
+
+      chapter[:html] = maruku.to_html
+      chapter[:sections] = sections
+
+    end
+
+    # open template
+    template = "#{libDir}/template.html.erb"
+
+    # build chapter files
+    @chapters.each do | chapter |
+
+      # bindings
+      @html = chapter[:html]
+      @current = chapter
+      puts "building #{chapter[:name]}"
+      # write it
+      File.open("#{publicDir}/#{chapter[:out]}", 'w') { |file| file.write(ERB.new(File.open(template, 'r').read).result(binding)) }
+    end
+  end
+end

data/lib/webapidoc/css/webapidoc.scss

@@ -550,7 +550,7 @@ pre {
 code {
   font-family: monospace;
   background: $color-code;
-  color: #141414;
+  color: #718c00;
   border-radius: 4px;
   box-shadow: 1px 1px 10px #fff;
   text-shadow: none;

data/lib/webapidoc/template.html.erb

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="utf-8">
-  <title>WebApiDoc for <%= @data[:title] %></title>
+  <title>Webapidoc for <%= @data[:title] %></title>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta name="description" content="in-depth WebAPI documentation for <%= @data[:title] %>">
   <meta name="author" content="the nice guys from <%= @data[:title] %>">
@@ -21,16 +21,16 @@
   <link href='http://fonts.googleapis.com/css?family=Lato:300,400,700' rel='stylesheet' type='text/css'>
 
   <!-- Le styles -->
-  <link href="css/webapidoc.css" rel="stylesheet">
+  <link href="/documentation/css/webapidoc.css" rel="stylesheet">
 
   <!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
   <!--[if lt IE 9]>
-  <script src="js/html5.js"></script>
+  <script src="/documentation/js/html5.js"></script>
   <![endif]-->
 
   <!-- Les javascripts -->
-  <script src="js/jquery.js"></script>
-  <script src="js/highlight.js"></script>
+  <script src="/documentation/js/jquery.js"></script>
+  <script src="/documentation/js/highlight.js"></script>
 
   <!-- enable script highlighting -->
   <script>
@@ -50,12 +50,10 @@
     <div class="four columns offset-by-one" id="nav">
       <ul class="nav-list">
 
-        <li class="nav-header <%= "active" if !@current[:name] %>"><a href="index.html">Home</a></li>
-
         <% @chapters.each do |chapter| %>
 
           <li class="nav-header <%= "active" if chapter[:name] == @current[:name] %>">
-            <a href="<%= chapter[:out] %>"><%= chapter[:name] %></a></li>
+            <a href="/documentation/<%= chapter[:out] %>"><%= chapter[:name] %></a></li>
 
           <% chapter[:sections].each do |section| %>
             <li class="nav-item" >

data/lib/webapidoc/version.rb

@@ -0,0 +1,4 @@
+module Webapidoc
+  NAME = "webapidoc"
+  VERSION = "0.0.5"
+end

data/lib/webapidoc.rb

@@ -1,117 +1,9 @@
-# WebApiDoc
-# Static HTML Documentation for JSON APIs
-
-#
-# Example:
-#   >> WebApiDoc.build({:title => "WebApiDoc"})
-#
-# Arguments:
-#   - data object accessible via @data in templates
-#
-# Info
-#   - chapter info is accessible via @chapters in templates
-#
-
 require 'maruku'
 require 'yaml'
 require 'fileutils'
 require 'erb'
 require 'sass'
 
-module WebApiDoc
-
-  def self.build(data=nil)
-
-    @data = data
-
-    publicDir = "public/documentation"
-    docDir = "app/documentation"
-    libDir = "lib/webapidoc"
-
-    # get config hash
-    config = YAML.load_file('config/webapidoc.yml').freeze
-
-    puts "building webapidoc for " + config["title"]
-
-    # clean up
-    FileUtils.remove_dir publicDir if File.exists?(publicDir)
-
-    # create paths
-    FileUtils.mkdir_p publicDir
-    FileUtils.mkdir publicDir + "/css"
-    FileUtils.mkdir publicDir + "/js"
-
-    # copy jquery
-    FileUtils.copy(libDir + "/js/jquery.js", publicDir + "/js/jquery.js")
-
-    # copy highlighter
-    FileUtils.copy(libDir + "/js/highlight.js", publicDir + "/js/highlight.js")
-
-    # compile webapidoc style
-    sass_filename = libDir + "/css/webapidoc.scss"
-    css = Sass::Engine.for_file(sass_filename, {:style => :compressed}).render
-    File.open(publicDir + "/css/webapidoc.css", "wb") {|f| f.write(css) }
-
-    # parse chapters and create html from md
-    @chapters = []
-
-    # get chapter info
-    config["chapters"].each_with_index do | chapter, idx|
-
-      inFile = "#{docDir}/#{chapter["file"]}.md"
-      outFile = "%02d_%s.html" % [idx.to_s, chapter["file"]]
-
-      if File.exists?(inFile + ".erb" )
-        inFile = inFile + ".erb"
-      end
-
-      if File.exists?(inFile)
-        contents = File.open(inFile, 'r').read
-      else
-        puts "file not found: #{inFile}"
-        next
-      end
-
-      @chapters << { :name => chapter["name"],  :out => outFile, :in => inFile}
-    end
-
-    @chapters.each_with_index do | chapter, idx|
-
-      contents = ERB.new(File.open(chapter[:in], 'r').read).result(binding)
-      maruku = Maruku.new(contents)
-
-      # get content info for subsections ( side pane navigation )
-      sections = []
-      maruku.each_element(:header) do | el |
-        next unless el.meta_priv.to_s == "level2"
-        sections << el.children[0]
-      end
-
-      chapter[:html] = maruku.to_html
-      chapter[:sections] = sections
-    end
-
-    # open template
-    template = "#{libDir}/template.html.erb"
-
-    # build chapter files
-    @chapters.each do | chapter |
-
-      # bindings
-      @html = chapter[:html]
-      @current = chapter
-      puts "building #{chapter[:name]}"
-      # write it
-      File.open("#{publicDir}/#{chapter[:out]}", 'w') { |file| file.write(ERB.new(File.open(template, 'r').read).result(binding)) }
-    end
-
-    # build index file, reset bindings
-    contents = ERB.new(File.open("#{libDir}/index.md.erb", 'r').read).result(binding)
-
-    @html = Maruku.new(contents).to_html
-    @current = {}
-    File.open("#{publicDir}/index.html", 'w') { |file| file.write(ERB.new(File.open(template, 'r').read).result(binding)) }
-
-  end
+require 'webapidoc/version'
+require 'webapidoc/base'
 
-end

data/webapidoc.gemspec

@@ -1,8 +1,11 @@
+# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+require "webapidoc/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'webapidoc'
-  s.version     = '0.0.4'
+  s.name        = Webapidoc::NAME
+  s.version     = Webapidoc::VERSION
+  s.platform    = Gem::Platform::RUBY
   s.date        = '2012-12-03'
 
   s.summary     = "Static HTML Documentation for JSON Web APIs."
@@ -11,11 +14,14 @@ Gem::Specification.new do |s|
   s.email       = 'aliasng@gmail.com'
 
   s.files         = `git ls-files`.split("\n")
-
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_dependency('maruku', '>= 0.6.1')
   s.add_dependency('sass', '>= 3.1.19')
 
-  s.homepage = 'http://rubygems.org/gems/webapidoc'
+  s.add_development_dependency 'rake'
+
+  s.homepage = 'https://github.com/otty/webapidoc'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: webapidoc
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Adrian Fuhrmann
@@ -49,6 +49,20 @@ dependencies:
         version: 3.1.19
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Create a static HTML Documentation for your JSON Web API.
 email: aliasng@gmail.com
 executables: []
@@ -60,17 +74,21 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - README.md
-- app/documentation/sample.md.erb
-- config/webapidoc.yml
+- Rakefile
+- lib/generators/webapidoc/install_generator.rb
+- lib/generators/webapidoc/templates/index.md.erb
+- lib/generators/webapidoc/templates/sample.md.erb
+- lib/generators/webapidoc/templates/webapidoc.yml
 - lib/webapidoc.rb
+- lib/webapidoc/base.rb
 - lib/webapidoc/css/webapidoc.scss
-- lib/webapidoc/index.md.erb
 - lib/webapidoc/js/highlight.js
 - lib/webapidoc/js/html5.js
 - lib/webapidoc/js/jquery.js
 - lib/webapidoc/template.html.erb
+- lib/webapidoc/version.rb
 - webapidoc.gemspec
-homepage: http://rubygems.org/gems/webapidoc
+homepage: https://github.com/otty/webapidoc
 licenses: []
 
 post_install_message: