betterdocs 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8f9176bd1f4dd32527fa0dc6377812681cbf904
-  data.tar.gz: 71e72348605a0c5bd5d33a2e4802c9d919cf39ab
+  metadata.gz: 371f8478bd3ccf3696faf4e8e007b366445a9f30
+  data.tar.gz: 4c434b65deaff692f847bee4eea707eb4432fb5f
 SHA512:
-  metadata.gz: be4a0a50a88523b6a6d5a25fd7d22902136dbe214e73c7952b3b4f4775ec028e3e19501ea587bb7bcd9158888ae3b93cca86e7a2e20bf270a8a43592a83237a9
-  data.tar.gz: 56704465cadef588fb6cbf1746974a199d571756098774b63e620d3eddf4d15ca167f09372262f98b3d31e2285e7e064d5dc19768501ab380c3fe15816a7f4b9
+  metadata.gz: af218fd27a8f5c5ef48f4475c54a7d17dba919dc90fa86758ed0f7557b3c5ddae433a5295acc30f9dd5fe37e17f0d9e7a976a544a34d91a3147ac2730d35fbfb
+  data.tar.gz: 4c360c686097a3bb66157171d2937e9c46b8a82b72340709d6eb1db3df9051d25b73077ab8df9fa27d96ed573fc816a9f480cbf7671d4c1eb376b7e689563736

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/betterdocs.gemspec

@@ -1,21 +1,21 @@
 # -*- encoding: utf-8 -*-
-# stub: betterdocs 0.5.0 ruby lib
+# stub: betterdocs 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterdocs".freeze
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["betterplace Developers".freeze]
-  s.date = "2017-03-20"
+  s.date = "2017-03-30"
   s.description = "This library provides tools to generate API documention for a web site's REST-ful JSON API.".freeze
   s.email = "developers@betterplace.org".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/betterdocs.rb".freeze, "lib/betterdocs/controller_collector.rb".freeze, "lib/betterdocs/dsl.rb".freeze, "lib/betterdocs/dsl/common.rb".freeze, "lib/betterdocs/dsl/controller.rb".freeze, "lib/betterdocs/dsl/controller/action.rb".freeze, "lib/betterdocs/dsl/controller/action/param.rb".freeze, "lib/betterdocs/dsl/controller/action/response.rb".freeze, "lib/betterdocs/dsl/controller/controller.rb".freeze, "lib/betterdocs/dsl/controller/controller_base.rb".freeze, "lib/betterdocs/dsl/json_params.rb".freeze, "lib/betterdocs/dsl/json_params/param.rb".freeze, "lib/betterdocs/dsl/json_type_mapper.rb".freeze, "lib/betterdocs/dsl/naming.rb".freeze, "lib/betterdocs/dsl/representer.rb".freeze, "lib/betterdocs/dsl/result.rb".freeze, "lib/betterdocs/dsl/result/collection_property.rb".freeze, "lib/betterdocs/dsl/result/link.rb".freeze, "lib/betterdocs/dsl/result/property.rb".freeze, "lib/betterdocs/generator/config_shortcuts.rb".freeze, "lib/betterdocs/generator/markdown.rb".freeze, "lib/betterdocs/global.rb".freeze, "lib/betterdocs/json_params_representer.rb".freeze, "lib/betterdocs/json_params_representer_collector.rb".freeze, "lib/betterdocs/json_time_with_zone.rb".freeze, "lib/betterdocs/mix_into_controller.rb".freeze, "lib/betterdocs/railtie.rb".freeze, "lib/betterdocs/rake_tasks.rb".freeze, "lib/betterdocs/representer.rb".freeze, "lib/betterdocs/result_representer.rb".freeze, "lib/betterdocs/result_representer_collector.rb".freeze, "lib/betterdocs/sanitizer.rb".freeze, "lib/betterdocs/section.rb".freeze, "lib/betterdocs/version.rb".freeze]
   s.files = [".codeclimate.yml".freeze, ".gitignore".freeze, ".rspec".freeze, ".travis.yml".freeze, "COPYING".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "betterdocs.gemspec".freeze, "lib/betterdocs.rb".freeze, "lib/betterdocs/controller_collector.rb".freeze, "lib/betterdocs/dsl.rb".freeze, "lib/betterdocs/dsl/common.rb".freeze, "lib/betterdocs/dsl/controller.rb".freeze, "lib/betterdocs/dsl/controller/action.rb".freeze, "lib/betterdocs/dsl/controller/action/param.rb".freeze, "lib/betterdocs/dsl/controller/action/response.rb".freeze, "lib/betterdocs/dsl/controller/controller.rb".freeze, "lib/betterdocs/dsl/controller/controller_base.rb".freeze, "lib/betterdocs/dsl/json_params.rb".freeze, "lib/betterdocs/dsl/json_params/param.rb".freeze, "lib/betterdocs/dsl/json_type_mapper.rb".freeze, "lib/betterdocs/dsl/naming.rb".freeze, "lib/betterdocs/dsl/representer.rb".freeze, "lib/betterdocs/dsl/result.rb".freeze, "lib/betterdocs/dsl/result/collection_property.rb".freeze, "lib/betterdocs/dsl/result/link.rb".freeze, "lib/betterdocs/dsl/result/property.rb".freeze, "lib/betterdocs/generator/config_shortcuts.rb".freeze, "lib/betterdocs/generator/markdown.rb".freeze, "lib/betterdocs/generator/markdown/templates/README.md.erb".freeze, "lib/betterdocs/generator/markdown/templates/section.md.erb".freeze, "lib/betterdocs/global.rb".freeze, "lib/betterdocs/json_params_representer.rb".freeze, "lib/betterdocs/json_params_representer_collector.rb".freeze, "lib/betterdocs/json_time_with_zone.rb".freeze, "lib/betterdocs/mix_into_controller.rb".freeze, "lib/betterdocs/railtie.rb".freeze, "lib/betterdocs/rake_tasks.rb".freeze, "lib/betterdocs/representer.rb".freeze, "lib/betterdocs/result_representer.rb".freeze, "lib/betterdocs/result_representer_collector.rb".freeze, "lib/betterdocs/sanitizer.rb".freeze, "lib/betterdocs/section.rb".freeze, "lib/betterdocs/tasks/doc.rake".freeze, "lib/betterdocs/version.rb".freeze, "spec/assets/app/assets/images/logos/logo.png".freeze, "spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/assets/app/views/api_v4/documentation/assets/CHANGELOG.md".freeze, "spec/assets/config/betterdocs.yml".freeze, "spec/betterdocs/dsl/controller/action/param_spec.rb".freeze, "spec/betterdocs/dsl/controller/action/response_spec.rb".freeze, "spec/betterdocs/dsl/json_type_mapper_spec.rb".freeze, "spec/betterdocs/dsl/result/collection_property_spec.rb".freeze, "spec/betterdocs/dsl/result/link_spec.rb".freeze, "spec/betterdocs/dsl/result/property_spec.rb".freeze, "spec/betterdocs/generator/markdown_spec.rb".freeze, "spec/betterdocs/global_spec.rb".freeze, "spec/betterdocs/json_params_representer_spec.rb".freeze, "spec/betterdocs/result_representer_spec.rb".freeze, "spec/betterdocs/sanitizer_spec.rb".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "http://github.com/betterplace/betterdocs".freeze
   s.rdoc_options = ["--title".freeze, "Betterdocs".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "2.6.10".freeze
+  s.rubygems_version = "2.6.11".freeze
   s.summary = "Betterplace API documentation library".freeze
   s.test_files = ["spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/betterdocs/dsl/controller/action/param_spec.rb".freeze, "spec/betterdocs/dsl/controller/action/response_spec.rb".freeze, "spec/betterdocs/dsl/json_type_mapper_spec.rb".freeze, "spec/betterdocs/dsl/result/collection_property_spec.rb".freeze, "spec/betterdocs/dsl/result/link_spec.rb".freeze, "spec/betterdocs/dsl/result/property_spec.rb".freeze, "spec/betterdocs/generator/markdown_spec.rb".freeze, "spec/betterdocs/global_spec.rb".freeze, "spec/betterdocs/json_params_representer_spec.rb".freeze, "spec/betterdocs/result_representer_spec.rb".freeze, "spec/betterdocs/sanitizer_spec.rb".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 

data/lib/betterdocs/generator/markdown.rb

@@ -47,7 +47,7 @@ module Betterdocs
         cd dirname do
           for section in sections.values
             infobar.progress(
-              message: "Section #{section.name.to_s.inspect} %c/%t in %te ETA %e @%E",
+              message: " Section #{section.name.to_s.inspect} %c/%t in %te ETA %e @%E ",
               force:   true
             )
             if @only
@@ -56,7 +56,7 @@ module Betterdocs
             render_to "sections/#{section.name}.md", section_template, section.instance_eval('binding')
           end
         end
-        infobar.finish
+        infobar.finish message: ' %t sections created in %te, completed @%E '
         infobar.newline
         self
       end
@@ -74,13 +74,13 @@ module Betterdocs
         Infobar(total: config.assets.size)
         config.each_asset do |src, dst|
           infobar.progress(
-            message: "Asset #{File.basename(src).inspect} %c/%t in %te ETA %e @%E",
+            message: " Asset #{File.basename(src).inspect} %c/%t in %te ETA %e @%E ",
             force:   true
           )
           mkdir_p File.dirname(dst)
           cp Betterdocs.rails.root.join(src), dst
         end
-        infobar.finish
+        infobar.finish message: ' %t assets created in %te, completed @%E '
         infobar.newline
         self
       end

data/lib/betterdocs/generator/markdown/templates/section.md.erb

@@ -22,7 +22,11 @@
     <th align="left"><%= param.name %></th>
     <td><code><%= param.value %></code></td>
     <td><%= param.required ? 'yes' : 'no' %></td>
-    <td><%= param.description %></td>
+<td>
+
+<%= param.description %>
+
+</td>
   </tr>
 <%- end -%>
 </table>
@@ -55,9 +59,13 @@ are optional.
   <tr>
     <th align="left"><%= param.name %></th>
     <td><code><%= param.value %></code></td>
-    <td><%= param.types * ?| -%></td>
+    <td><code><%= param.types * ?| -%></code></td>
     <td><%= param.required ? 'yes' : 'no' %></td>
-    <td><%= param.description %></td>
+<td>
+
+<%= param.description %>
+
+</td>
   </tr>
   <%- end -%>
 </table>
@@ -91,9 +99,13 @@ are optional.
       <%- else -%>
       <th align="left"><%= property.full_name %></th>
       <%- end -%>
-      <td><%= property.types * ' &#124; ' %></td>
-      <td><%= property.example %></td>
-      <td><%= property.description %></td>
+      <td><code><%= property.types * ' &#124; ' %></code></td>
+      <td><code><%= property.example %></code></td>
+<td>
+
+<%= property.description %>
+
+</td>
     </tr>
     <%- end -%>
   </table>
@@ -115,7 +127,11 @@ are optional.
   <%- for link in links.group_by(&:nesting_name).values.reduce(&:concat) -%>
     <tr>
       <th align="left"><%= link.full_name %></th>
-      <td><%= link.description %></td>
+<td>
+
+<%= link.description %>
+
+</td>
     </tr>
   <%- end -%>
 <%- else -%>

data/lib/betterdocs/version.rb

@@ -1,6 +1,6 @@
 module Betterdocs
   # Betterdocs version
-  VERSION         = '0.5.0'
+  VERSION         = '0.6.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterdocs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -279,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Betterplace API documentation library