dictum 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e544707e273d694375827f0032d4ee924dff02d9
-  data.tar.gz: df5bea103157a87699791ff558464f3bf4693f4d
+  metadata.gz: 217d2599c6e42803dae17c91e5f912b62c9c1c69
+  data.tar.gz: 67ea4dea1683a6d22bfcb6a83ad6bc39b981a235
 SHA512:
-  metadata.gz: fdfbb27c664eb351c72eab2617c6bc5cca57be8e8cb9aa72cc17c42bbecc0738fb187a7830ecf9d513520a408cd544b8e3ecfcb35ca694effb22ec237dc49556
-  data.tar.gz: 50187a697fd04d757580bb00ecbfe4cafc60fe8a6f6559b1ab9c22e2b52816a9097126e86e0607d2ee4f1f1968f6e203799ac123af5aacb3ccf4dd40cc200ee0
+  metadata.gz: d0d2f490887e718e421ead994f06fb3dd5603465aceb15773ed673ed63a49997ba77d18a52eda092cef8dbed17efb884508b179e78ae7a6508d90ecd66c9508c
+  data.tar.gz: 749835247251aa4c2e79d273d50ae6e47f1de9b79ee8e78d18febdfa46477a79868465d219bc91001b2011ef65806d5ef2ed4c326c97b62a453abbe6cb232b06

data/.gitignore

@@ -1,5 +1,7 @@
 # Created by https://www.gitignore.io/api/ruby,osx
 
+/spec/temp/**/*
+
 *.log
 .byebug_history
 /spec/test_files

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - dictum.gemspec
+    - spec/spec_helper.rb
 
 Documentation:
   Enabled: false

data/.travis.yml

@@ -17,7 +17,7 @@ script:
 
 addons:
     code_climate:
-        repo_token: 18ae4433a073ee0e00127ab95c826ac5552d3b14d712aa70a231e9e3903f84d5
+        repo_token: b228ad9d03e7d830d589aed174b9fe0ab3057dc045a2b3360666e7a7891634ff
 
 os:
   - linux

data/README.md

@@ -1,11 +1,11 @@
 # Dictum - Document your Rails APIs
 [![Gem Version](https://badge.fury.io/rb/dictum.svg)](https://badge.fury.io/rb/dictum)
-[![Dependency Status](https://gemnasium.com/badges/github.com/alebian/dictum.svg)](https://gemnasium.com/github.com/alebian/dictum)
-[![Build Status](https://travis-ci.org/alebian/dictum.svg)](https://travis-ci.org/alebian/dictum)
-[![Code Climate](https://codeclimate.com/github/alebian/dictum/badges/gpa.svg)](https://codeclimate.com/github/alebian/dictum)
-[![Test Coverage](https://codeclimate.com/github/alebian/dictum/badges/coverage.svg)](https://codeclimate.com/github/alebian/dictum/coverage)
-[![Issue Count](https://codeclimate.com/github/alebian/dictum/badges/issue_count.svg)](https://codeclimate.com/github/alebian/dictum)
-[![Inline docs](http://inch-ci.org/github/alebian/dictum.svg)](http://inch-ci.org/github/alebian/dictum)
+[![Dependency Status](https://gemnasium.com/badges/github.com/Wolox/dictum.svg)](https://gemnasium.com/github.com/Wolox/dictum)
+[![Build Status](https://travis-ci.org/Wolox/dictum.svg)](https://travis-ci.org/Wolox/dictum)
+[![Code Climate](https://codeclimate.com/github/Wolox/dictum/badges/gpa.svg)](https://codeclimate.com/github/Wolox/dictum)
+[![Test Coverage](https://codeclimate.com/github/Wolox/dictum/badges/coverage.svg)](https://codeclimate.com/github/Wolox/dictum/coverage)
+[![Issue Count](https://codeclimate.com/github/Wolox/dictum/badges/issue_count.svg)](https://codeclimate.com/github/Wolox/dictum)
+[![Inline docs](http://inch-ci.org/github/Wolox/dictum.svg)](http://inch-ci.org/github/Wolox/dictum)
 
 ## Installation
 
@@ -179,7 +179,6 @@ RSpec.configure do |config|
     end
   end
 end
-end
 ```
 
 ```ruby
@@ -225,7 +224,7 @@ YourApp::Application.routes.draw do
   #
   # Other routes defined
   #
-  
+
   doc_paths = Dir["#{Rails.root.join('app', 'views', 'docs')}/*"].each do |path|
     resource = path.split('/').last.gsub('.html', '')
     get "/docs/#{resource}", to: "docs##{resource}"
@@ -245,9 +244,15 @@ Of course you will need to have a controller for this, in this case one named 'd
 6. Push your branch (`git push origin my-new-feature`)
 7. Create a new Pull Request
 
+## About ##
+
+This project is maintained by [Alejandro Bezdjian](https://github.com/alebian) and it was written by [Wolox](http://www.wolox.com.ar).
+
+![Wolox](https://raw.githubusercontent.com/Wolox/press-kit/master/logos/logo_banner.png)
+
 ## License
 
-**Dictum** is available under the MIT [license](https://raw.githubusercontent.com/alebian/dictum/master/LICENSE.md).
+**Dictum** is available under the MIT [license](https://raw.githubusercontent.com/Wolox/dictum/master/LICENSE.md).
 
     Copyright (c) 2016 Alejandro Bezdjian, aka alebian
 

data/TODO.md

@@ -1,7 +1,5 @@
 # List of TODOs
-- Add some tests
 - Don't generate documentation while running normal tests
-- HTML ducumentation option
-- Dir.tempdir problems outside Rails
+- Improve HTML style and generator
 - Try it for Unit Test
 - Make it more general, not only for REST APIs

data/dictum.gemspec

@@ -14,11 +14,13 @@ Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }
   spec.require_paths = ['lib']
-  spec.homepage      = 'https://github.com/alebian/dictum'
+  spec.homepage      = 'https://github.com/Wolox/dictum'
   spec.license       = 'MIT'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec)/})
 
+  spec.add_dependency 'htmlbeautifier', '~> 1.1', '>= 1.1.1'
+
   spec.add_development_dependency 'bundler', '>= 1.3.0', '< 2.0'
   spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
   spec.add_development_dependency 'byebug', '~> 8.0', '>= 8.0.0' if RUBY_VERSION >= '2.0.0'

data/lib/dictum.rb

@@ -3,14 +3,15 @@ require 'dictum/documenter'
 require 'dictum/markdown_writer'
 require 'dictum/html_writer'
 require 'dictum/html_helpers'
+require 'tmpdir'
 
 module Dictum
   load 'tasks/dictum.rake' if defined?(Rails)
 
   @config = {
     output_format: :markdown,
-    output_path: '/tmp/docs',
-    root_path: '/tmp',
+    output_path: "#{Dir.tmpdir}/docs",
+    root_path: Dir.tmpdir,
     test_suite: :rspec,
     output_filename: 'Documentation'
   }
@@ -39,6 +40,10 @@ module Dictum
     @config[:output_filename] = file
   end
 
+  def self.config
+    @config
+  end
+
   ##
   # Method used to create a new resource
   #

data/lib/dictum/documenter.rb

@@ -1,4 +1,5 @@
 require 'singleton'
+require 'tmpdir'
 
 module Dictum
   ##
@@ -6,14 +7,17 @@ module Dictum
   #
   class Documenter
     include Singleton
+
     attr_reader :resources, :tempfile_path
+    TEMPFILE_NAME = 'dictum_temp.json'.freeze
 
     def initialize
       @resources = {}
-      @tempfile_path = '/tmp/dictum_temp.json'
+      @tempfile_path = "#{Dir.tmpdir}/#{TEMPFILE_NAME}"
     end
 
     def resource(arguments = {})
+      return if arguments.nil?
       name = arguments[:name]
       return if name.nil?
       @resources[name] ||= {}

data/lib/dictum/html_helpers.rb

@@ -6,79 +6,99 @@ module Dictum
     PRETTIFY = 'https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js'.freeze
 
     class << self
-      def html_header(title)
-        "<!DOCTYPE html>\n<html>\n<head>\n<title>#{title}</title>\n#{external_css(BOOTSTRAP_CSS)}"\
-        "\n<style>\n#{page_css}\n</style>\n</head>\n<body>\n"
+      def build
+        yield self
       end
 
-      def html_footer
+      def html_header(title, body_content)
+        "<!DOCTYPE html>\n<html>\n<head>\n<title>#{title}</title>\n#{external_css(BOOTSTRAP_CSS)}"\
+        "\n<style>\n#{page_css}\n</style>\n</head>\n<body>\n#{body_content}" \
         "#{script(JQUERY)}\n#{script(BOOTSTRAP_JS)}\n#{script(PRETTIFY)}\n</body>\n</html>"
       end
 
-      def page_css
-        ''
-      end
-
-      def container
-        "<div class='container-fluid'>\n"
-      end
-
-      def container_end
-        '</div>'
+      def container(content)
+        tag('div', "\n#{content}\n", class: 'container-fluid')
       end
 
-      def row
-        "<div class='row'>\n<div class='col-md-8 col-md-offset-2'>\n"
+      def row(content)
+        internal_div = tag('div', "\n#{content}\n", class: 'col-md-8 col-md-offset-2')
+        tag('div', "\n#{internal_div}", class: 'row')
       end
 
-      def row_end
-        "</div>\n</div>"
+      def page_css
+        ''
       end
 
-      def script(text)
-        "<script src='#{text}'></script>"
+      def script(script_path)
+        return '' unless script_path
+        tag('script', nil, src: script_path)
       end
 
-      def external_css(text)
-        "<link rel='stylesheet' href='#{text}'>"
+      def external_css(css_path)
+        return '' unless css_path
+        "<link rel='stylesheet' href='#{css_path}' />\n"
       end
 
       def unordered_list(elements)
+        return "<ul>\n</ul>\n" unless elements
         answer = "<ul>\n"
         elements.each do |element|
           answer += "<li><a href='#{element.downcase}.html'>#{element}</a></li>\n"
         end
-        answer += '</ul>'
+        answer += "</ul>\n"
+      end
+
+      def link(href, content)
+        tag('a', content, href: href)
       end
 
       def title(text, html_class = nil)
-        "<h1 class='#{html_class}'>#{text}</h1>"
+        return "<h1>#{text}</h1>\n" unless html_class
+        tag('h1', text, class: html_class)
       end
 
       def subtitle(text, html_class = nil)
-        "<h3 class='#{html_class}'>#{text}</h3>"
+        return "<h3>#{text}</h3>\n" unless html_class
+        tag('h3', text, class: html_class)
+      end
+
+      def sub_subtitle(text, html_class = nil)
+        return "<h4>#{text}</h4>\n" unless html_class
+        tag('h4', text, class: html_class)
       end
 
       def paragraph(text, html_class = nil)
-        "<p class='#{html_class}'>#{text}</p>"
+        return "<p>#{text}</p>\n" unless html_class
+        tag('p', text, class: html_class)
       end
 
       def button(text, glyphicon = nil)
-        "<a href='index.html'><button type='button' class='btn btn-primary back'" \
-        "aria-label='Left Align'><span class='glyphicon #{glyphicon}' aria-hidden='true'>" \
-        "</span>#{text}</button></a>"
+        span = tag('span', text, class: "glyphicon #{glyphicon}", 'aria-hidden' => 'true')
+        button = tag('button', "\n#{span}", 'type' => 'button',
+                                            'class' => 'btn btn-primary back',
+                                            'aria-label' => 'Left Align')
+        tag('a', "\n#{button}", href: 'index.html')
       end
 
       def code_block(title, json)
-        "#{sub_subtitle(title)}\n#{code(json)}"
+        return '' unless json
+        return code(json) unless title
+        "#{sub_subtitle(title)}#{code(json)}"
       end
 
-      def sub_subtitle(text, html_class = nil)
-        "<h4 class='#{html_class}'>#{text}</h4>"
+      def code(json)
+        return '' unless json
+        tag('pre', json, class: 'prettyprint')
       end
 
-      def code(json)
-        "<pre class='prettyprint'>#{json}</pre>"
+      def tag(name, content, attributes = {})
+        return '' unless name
+        answer = "<#{name}"
+        attributes.each do |key, value|
+          answer += " #{key}='#{value}'"
+        end
+        answer += ">#{content}"
+        answer += "</#{name}>\n"
       end
     end
   end

data/lib/dictum/html_writer.rb

@@ -1,5 +1,6 @@
 require_relative 'html_helpers'
 require 'json'
+require 'htmlbeautifier'
 
 module Dictum
   class HtmlWriter
@@ -20,89 +21,77 @@ module Dictum
 
     private
 
-    def write_index_header(file)
-      return unless file
-      file.puts(HtmlHelpers.html_header(output_title))
-      file.puts(HtmlHelpers.container)
-      file.puts(HtmlHelpers.row)
-    end
-
-    def write_index_footer(file)
-      return unless file
-      file.puts(HtmlHelpers.row_end)
-      file.puts(HtmlHelpers.container_end)
-      file.puts(HtmlHelpers.html_footer)
-    end
-
-    def write_index
-      index = File.open("#{output_dir}/index.html", 'w+')
-      write_index_header(index)
-      index.puts("<div class='jumbotron'>\n#{HtmlHelpers.title('Index', 'title')}\n</div>")
-      index.puts(HtmlHelpers.unordered_list(temp_json.keys))
-      write_index_footer(index)
+    def write_to_file(file_path, content)
+      index = File.open(file_path, 'w+')
+      index.puts(HtmlBeautifier.beautify(content))
       index.close
     end
 
-    def write_pages_header(resource_name, text, file)
-      write_index_header(file)
-      file.puts(HtmlHelpers.title(resource_name, 'title'))
-      file.puts(HtmlHelpers.paragraph(text))
-    end
-
-    def write_pages_footer(file)
-      return unless file
-      file.puts(HtmlHelpers.row_end)
-      file.puts(HtmlHelpers.row)
-      file.puts(HtmlHelpers.button('Back', 'glyphicon-menu-left'))
-      write_index_footer(file)
+    def write_index
+      html = HtmlHelpers.build do |b|
+        content = "<div class='jumbotron'>\n#{HtmlHelpers.title('Index', 'title')}\n</div>\n"
+        content += b.unordered_list(temp_json.keys)
+        container = b.container(b.row(content))
+        b.html_header(output_title, container)
+      end
+      write_to_file("#{output_dir}/index.html", html)
     end
 
     def write_pages
       temp_json.each do |resource_name, information|
-        file = File.open("#{output_dir}/#{resource_name.downcase}.html", 'w+')
-        write_pages_header(resource_name, information['description'], file)
-
-        write_endpoints(information['endpoints'], file)
+        write_page(resource_name, information)
+      end
+    end
 
-        write_pages_footer(file)
-        file.close
+    def write_page(resource_name, information)
+      html = HtmlHelpers.build do |b|
+        content = resource_header_and_endpoints(
+          resource_name, information['description'], information['endpoints'], b
+        )
+        container = b.container(b.row(content) + b.row(b.button('Back', 'glyphicon-menu-left')))
+        b.html_header(output_title, container)
       end
+      write_to_file("#{output_dir}/#{resource_name.downcase}.html", html)
+    end
+
+    def resource_header_and_endpoints(resource_name, description, endpoints, builder)
+      builder.title(resource_name, 'title') + builder.paragraph(description) +
+        write_endpoints(endpoints, builder)
     end
 
-    def write_endpoints(endpoints, file)
+    def write_endpoints(endpoints, builder)
+      answer = ''
       endpoints.each do |endpoint|
-        file.puts HtmlHelpers.subtitle("#{endpoint['http_verb']} #{endpoint['endpoint']}")
-        file.puts HtmlHelpers.paragraph(endpoint['description'])
-        write_request_parameters(endpoint, file)
-        write_response(endpoint, file)
+        answer += builder.subtitle("#{endpoint['http_verb']} #{endpoint['endpoint']}")
+        answer += builder.paragraph(endpoint['description'])
+        answer += write_request_parameters(endpoint, builder)
+        answer += write_response(endpoint, builder)
       end
+      answer
     end
 
-    def write_request_parameters(endpoint, file)
-      write_codeblock('Request headers', JSON.pretty_generate(endpoint['request_headers']), file)
-      write_codeblock('Request path parameters',
-                      JSON.pretty_generate(endpoint['request_path_parameters']), file)
-      write_codeblock('Request body parameters',
-                      JSON.pretty_generate(endpoint['request_body_parameters']), file)
+    def write_request_parameters(endpoint, builder)
+      write_codeblock('Request headers', endpoint['request_headers'], builder) +
+        write_codeblock('Request path parameters', endpoint['request_path_parameters'], builder) +
+        write_codeblock('Request body parameters', endpoint['request_body_parameters'], builder)
     end
 
-    def write_response(endpoint, file)
-      write_codeblock('Status', endpoint['response_status'], file)
-      write_codeblock(
-        'Response headers',
-        JSON.pretty_generate(endpoint['response_headers']),
-        file
+    def write_response(endpoint, builder)
+      answer = builder.code_block('Status', endpoint['response_status'])
+      answer += write_codeblock(
+        'Response headers', endpoint['response_headers'], builder
       ) if endpoint['response_headers']
 
       if endpoint['response_body']
         param = (endpoint['response_body'] == 'no_content') ? {} : endpoint['response_body']
-        write_codeblock('Response body', JSON.pretty_generate(param), file)
+        answer += write_codeblock('Response body', param, builder)
       end
+      answer
     end
 
-    def write_codeblock(text, json, file)
-      return unless text && json && file
-      file.puts HtmlHelpers.code_block(text, json)
+    def write_codeblock(text, json, builder)
+      return unless text && json && builder
+      builder.code_block(text, JSON.pretty_generate(json))
     end
   end
 end

data/lib/dictum/markdown_writer.rb

@@ -16,7 +16,6 @@ module Dictum
       write_index
       write_temp_path
       output_file.close
-      File.delete(temp_path) if File.exist?(temp_path)
     end
 
     private
@@ -59,13 +58,13 @@ module Dictum
     end
 
     def print_subsubtitle(subtitle, contents)
-      return if !subtitle.present? || !contents.present?
+      return if !subtitle || !contents
       output_file.puts "\#\#\# #{subtitle}:"
       output_file.puts "#{contents}\n\n"
     end
 
     def print_subsubtitle_json(subtitle, contents)
-      return if !subtitle.present? || !contents.present?
+      return unless subtitle && contents
       output_file.puts "\#\#\# #{subtitle}:"
       output_file.puts "```json\n#{JSON.pretty_generate(contents)}\n```\n\n"
     end

data/lib/dictum/version.rb

@@ -1,3 +1,3 @@
 module Dictum
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: dictum
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alejandro Bezdjian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-04-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +133,7 @@ files:
 - lib/dictum/markdown_writer.rb
 - lib/dictum/version.rb
 - lib/tasks/dictum.rake
-homepage: https://github.com/alebian/dictum
+homepage: https://github.com/Wolox/dictum
 licenses:
 - MIT
 metadata: {}
@@ -133,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Document your APIs.