banana_docs 0.0.1 → 0.0.2

data/README.md

@@ -16,8 +16,105 @@ Or install it yourself as:
 
     $ gem install banana_docs
 
-## Usage
+## Usage()
 
 After install the gem in your project, by terminal execute:
 
-    $ banana
+    $ banana doc/main.slim public/documentation
+
+Open the file: doc/index.html and write your documentation, using gem helpers, and then run the command:
+
+    $ banana doc/main.slim
+
+This will generate documentation.
+
+
+## Helpers
+
+To create a new section in documentation:
+
+> section(name)
+```ruby
+= section 'Publishing new books'
+```
+
+To inform what this action do, your URL and METHOD:
+
+> action(title, options)
+```ruby
+= action 'Publish new book', method: 'GET', url: '/some/url/path'
+```
+
+To add a table with params to send to API:
+
+> params(&block)
+```ruby
+  = params
+    = [...]
+```
+
+Inside the ``params`` method, you need to add some ``param`` helpers to build the table:
+
+> param(name, description, type, format, options = {})
+```ruby
+  = params
+    = param :name, 'Name of Book', :string, 'Just String', { required: false/true, obs: 'Here goes the description' }
+```
+
+Showing response:
+
+> response(&block)
+```ruby
+  = response
+    = [...]
+```
+
+To use a blockquote to inform some observation about an action:
+
+> note(text)
+```ruby
+  = response
+    = note 'Here some observarion about an action :P'
+```
+
+To informe the status code for response:
+
+> status_code(status) (200, 400 or 404)
+```ruby
+  = response
+    = status_code '200'
+```
+
+To show up how the code will be returned:
+> code(&block)
+```ruby
+  = response
+    = code
+      = [...]
+```
+
+To Build and Hash for response:
+> key_with_block(name, &block)
+```ruby
+  = response
+    = code
+      = key_with_block 'errors'
+```
+
+To add keys and values to hash returned for response:
+> key_value(key, value, show_keys = true) 
+```ruby
+  = response
+    = code
+      = key_with_block 'errors'
+        = key_value 'attribute', '["error_type"]', false/true
+
+When some empty Array is returned from response:
+> empty
+```ruby
+  = response
+    = status_code '200'
+    = code
+      = key_with_block 'addresses'
+        = empty
+```

data/banana_docs.gemspec

@@ -9,8 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Luiz Cezer", "Carlos Fonseca"]
   spec.email         = ["lccezinha@gmail.com", "carlos.fonseca@a2c.com.br"]
   spec.description   = %q{Simple gem to build documentation for CDA-API}
-  spec.summary       = %q{Gem used to provide a simple and nice way to write documentations for API applications}
-  spec.homepage      = ""
+  spec.summary       = %q{
+    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 :(.
+  }
+  spec.homepage      = "https://github.com/lccezinha/banana_docs"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/banana_docs/helpers.rb

@@ -105,6 +105,10 @@ class BananaDocs::Helpers
     "{ \"#{key}\": { #{yield} } }".html_safe
   end
 
+  def empty
+    "[]" 
+  end
+
   def more
     "..."
   end

data/lib/banana_docs/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banana_docs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -139,7 +139,7 @@ files:
 - lib/banana_docs/version.rb
 - spec/helpers_spec.rb
 - views/assets.slim
-homepage: ''
+homepage: https://github.com/lccezinha/banana_docs
 licenses:
 - MIT
 post_install_message: 
@@ -164,6 +164,7 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Gem used to provide a simple and nice way to write documentations for API
-  applications
+  applications. This gem is not a generic gem, for while, it's specific for CDA-API
+  project :(.
 test_files:
 - spec/helpers_spec.rb