banana_docs 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2717932252f4322d63198f1f2f9efc29aeff517
+  data.tar.gz: 5f870a37343468a76c5696843a11572b89ce8043
+SHA512:
+  metadata.gz: 17d6607340a19989a424a5888c9ebbfdf43556767cafa8da084ab773275b27bfd4f20d05a29fed49565eba22513c62589c2fbec6a42a238effa8b1de9bc625ea
+  data.tar.gz: 86d3d773482f659e66d9911724a5df32bf9fdd0c1e0823fb24d0610ce1d3a452a0d4360b292793ca48453ced4ce51b7e854baf19e457a4e208aef0900abe4b34

data/README.md

@@ -2,6 +2,8 @@
 
 This gem will provide a simple way to build documentation for API project
 
+*This gem is not a generic gem yet.For while, it's specific for CDA-API project :(, sorry.*
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,19 +18,16 @@ Or install it yourself as:
 
     $ gem install banana_docs
 
-## Usage()
-
-After install the gem in your project, by terminal execute:
-
-    $ banana doc/main.slim public/documentation
+## Usage
 
-Open the file: doc/index.html and write your documentation, using gem helpers, and then run the command:
+After install the gem in your project, you need to create a file where you will write you documentation.
+For example, in folder ``doc`` create a file called ``index.slim``. Write your documentation using the gem's helpers.
+And then, execute this in your terminal:
 
-    $ banana doc/main.slim
+    $ banana doc/index.slim public/documentation
 
 This will generate documentation.
 
-
 ## Helpers
 
 To create a new section in documentation:
@@ -117,4 +116,18 @@ When some empty Array is returned from response:
     = code
       = key_with_block 'addresses'
         = empty
+```
+
+To build your navigation menu (menu is based in all section itens):
+
+> show_nav_menu
+```ruby
+  = show_nav_menu
+```
+
+To include assets in header:
+
+> include_assets
+```ruby
+  = include_assets
 ```

data/bin/banana

@@ -22,17 +22,16 @@ input_file = ARGV[0] || 'doc/index.slim'
 output_dir = ARGV[1] || 'public/documentation'
 
 unless Dir.exists?(output_dir)
-  puts "Cê é burro cara... esse diretório #{output_dir} não existe! Como você é burro!"
-  exit 1
+  puts "Creating folder: #{output_dir}"
+  Dir.mkdir output_dir
 end
 
 unless File.exists?(input_file)
-  puts "Cê é burro cara... esse arquivo #{input_file} não existe! Como você é burro!"
-  exit 2
+  puts "Are you stupid? This file doesn't exists you newbie. Check the right file name and then run the command again."
+  exit 1
 end
 
 FileUtils.cp_r(File.join(banana_dir, 'assets'), output_dir)
-
 helpers = BananaDocs::Helpers.new
 output_file = File.join(output_dir, 'index.html')
 File.write(output_file, Slim::Template.new(input_file).render(helpers))

data/lib/banana_docs/helpers.rb

@@ -113,6 +113,10 @@ class BananaDocs::Helpers
     "..."
   end
 
+  def include_assets
+    render 'assets' 
+  end
+
   def encode(string)
     @coder ||= HTMLEntities.new
     @coder.encode(string, :named).html_safe

data/lib/banana_docs/version.rb

@@ -1,3 +1,3 @@
 module BananaDocs
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banana_docs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Luiz Cezer
@@ -10,76 +9,67 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -87,7 +77,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -95,17 +84,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple gem to build documentation for CDA-API
@@ -142,27 +129,26 @@ files:
 homepage: https://github.com/lccezinha/banana_docs
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem used to provide a simple and nice way to write documentations for API
   applications. This gem is not a generic gem, for while, it's specific for CDA-API
   project :(.