dictum 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 217d2599c6e42803dae17c91e5f912b62c9c1c69
-  data.tar.gz: 67ea4dea1683a6d22bfcb6a83ad6bc39b981a235
+  metadata.gz: 1abfdfd254c6440dd20d29a1f76339d413512ee5
+  data.tar.gz: 01f93d8ee750b724a6c93e4a9beabab729cadfbe
 SHA512:
-  metadata.gz: d0d2f490887e718e421ead994f06fb3dd5603465aceb15773ed673ed63a49997ba77d18a52eda092cef8dbed17efb884508b179e78ae7a6508d90ecd66c9508c
-  data.tar.gz: 749835247251aa4c2e79d273d50ae6e47f1de9b79ee8e78d18febdfa46477a79868465d219bc91001b2011ef65806d5ef2ed4c326c97b62a453abbe6cb232b06
+  metadata.gz: 43e9db9a4c534ffb44e4a648fff63f44a5c38565e716708dc2beff30d8cd6b31046f487f8769ccf1ebd89d74aff15145e4b51b861f5ad9847a001955c784b621
+  data.tar.gz: 96012528a2372d4bc8879367c4f64462e2209b6e9138f6ee7f5d40969910a1706e269a3e39a1d6973cdee088b6c2b4ab9c8d9c206473cb7066b6ae9af21fe591

data/.rubocop.yml

@@ -11,3 +11,6 @@ LineLength:
 
 FrozenStringLiteralComment:
   Enabled: false
+
+Metrics/AbcSize:
+  Max: 15.3

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2

data/README.md

@@ -25,7 +25,11 @@ Or install it yourself as:
 
 ## Basic usage
 
-First you need to set a configuration file inside /config/initializers/dictum.rb
+First run:
+
+    $ bundle exec rake dictum:configure [PATH_TO_HELPER_FILE]
+
+This will create a basic Rspec configuration in 'spec/support/spec_helper.rb' or in PATH_TO_HELPER_FILE. Also it will create a configuration file inside /config/initializers/dictum.rb
 
 ```ruby
 # /config/initializers/dictum.rb
@@ -34,6 +38,7 @@ Dictum.configure do |config|
   config.root_path = Rails.root
   config.output_filename = 'Documentation'
   config.output_format = :markdown
+  config.index_title = 'My Documentation Title'
 end
 ```
 
@@ -78,9 +83,9 @@ Then execute:
 
     $ bundle exec rake dictum:document
 
-And voilà, Dictum will create a document like this in '/docs/Documentation':
+And voilà, Dictum will create a document like this in '/docs/Documentation' (see [example.md](https://github.com/Wolox/dictum/blob/master/example.md)):
 
-    # Index
+    # My Documentation Title
     - MyResource
 
     # MyResource
@@ -125,20 +130,14 @@ And voilà, Dictum will create a document like this in '/docs/Documentation':
 
 # Advanced usage
 
-If you pay attention to the basic usage, you will notice that much code is needed if your API has a lot of endpoints, this is not DRY and adds unnecesary boilerplate. Luckily you can work around it using some Rspec tricks:
+If you pay attention to the basic usage, you will notice that it is a lot of boilerplate if your API has a lot of endpoints, this is not DRY. Luckily you can work around it using some Rspec tricks:
 
 ```ruby
-# spec/controllers/my_resource_controller_spec.rb
-require 'rails_helper'
-
-describe V1::MyResourceController do
-  Dictum.resource(
-    name: 'MyResource',
-    description: 'This is MyResource description.'
-  )
-
-  after(:each) do |test|
+# spec/rails_helper.rb
+RSpec.configure do |config|
+  config.after(:each) do |test|
     if test.metadata[:dictum]
+      Dictum.endpoint(
       Dictum.endpoint(
         resource: test.metadata[:described_class].to_s.gsub('V1::', '').gsub('Controller', ''),
         endpoint: request.fullpath,
@@ -152,35 +151,14 @@ describe V1::MyResourceController do
         response_headers: response.headers,
         response_status: response.status,
         response_body: response_body
-    end
-  end
-
-  describe '#some_method' do
-    context 'some context for my resource' do
-      it 'returns status ok', dictum: true, dictum_description: 'Some description of the endpoint.' do
-        get :index
-        expect(response_status).to eq(200)
-      end
-    end
-  end
-end
-```
-
-This is much better, but it is not DRYed enough because you would have to repeat the after(:each) declaration on every controller spec you have, so you can still improve it a bit more:
-
-```ruby
-# spec/rails_helper.rb
-RSpec.configure do |config|
-  config.after(:each) do |test|
-    if test.metadata[:dictum]
-      Dictum.endpoint(
-        # All the parameters that you want
       )
     end
   end
 end
 ```
 
+A file similar (and more complete) to that one is created when you run the rake dictum:configure task.
+
 ```ruby
 # spec/controllers/my_resource_controller_spec.rb
 require 'rails_helper'
@@ -202,6 +180,8 @@ describe V1::MyResourceController do
 end
 ```
 
+This is how your controller test should look now, much better.
+
 # Dynamic HTML documentation
 
 So far so good, but your team needs to read the documentation everytime you update it, and sending the documentation file to them doesn't seem too practical. Instead you can use the HTML version of Dictum and generate static views with the content. Here is a very basic example of what you can do to generate the views and routes dynamycally:
@@ -213,6 +193,9 @@ Dictum.configure do |config|
   config.root_path = Rails.root
   config.output_filename = 'docs'
   config.output_format = :html
+  config.index_title = 'My documentation title'
+  config.header_title = 'API doc'
+  config.inline_css = File.read(Rails.root.join('app', 'assets', 'stylesheets', 'documentation.css'))
 end
 ```
 
@@ -234,6 +217,14 @@ end
 
 Of course you will need to have a controller for this, in this case one named 'docs_controller.rb'. And finally go to 'http://localhost:3000/docs/index.html'
 
+This is an HTML example:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Wolox/dictum/master/example.gif">
+</p>
+
+You can customize the HTML using css like this [example](https://raw.githubusercontent.com/Wolox/dictum/master/example.css).
+
 ## Contributing
 
 1. Fork it

data/dictum.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   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_dependency 'nokogiri', '~> 1.6'
 
   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'
-  spec.add_development_dependency 'rubocop', '~> 0.38', '>= 0.38.2'
+  spec.add_development_dependency 'rubocop', '~> 0.40', '>= 0.40.0'
 end

data/example.css

@@ -0,0 +1,84 @@
+body {
+  background-color: white;
+}
+
+ul {
+    list-style-type: disc;
+}
+
+a {
+  color: blue;
+  font-family: sans-serif;
+  font-weight: bold;
+}
+
+.jumbotron {
+  background-color: grey;
+}
+
+pre {
+  background-color: grey;
+}
+
+.jumbotron > h1{
+  color: black;
+  font-family: sans-serif;
+  font-weight: bold;
+  text-transform: uppercase;
+  font-size: 50px;
+}
+
+h1 {
+  color: black;
+  font-family: sans-serif;
+  font-weight: bold;
+  text-transform: uppercase;
+  font-size: 40px;
+}
+
+p {
+  color: black;
+  font-family: sans-serif;
+}
+
+h3 {
+  color: black;
+  font-family: sans-serif;
+  font-weight: bold;
+  font-size: 30px;
+}
+
+h4 {
+  color: grey;
+  font-family: sans-serif;
+  font-weight: bold;
+  text-transform: uppercase;
+  font-size: 20px;
+}
+
+.dictum-button {
+  background-color: white;
+  border-color: black;
+  color: black;
+  margin-right: 10px;
+}
+
+.dictum-button > p {
+  font-family: sans-serif;
+  text-transform: uppercase;
+  display: inline;
+}
+
+.dictum-button:hover {
+  background-color: transparent;
+  border-color: blue;
+  color: blue;
+}
+
+span.lit, span.kwd {
+  color: green;
+}
+
+span.pun, span.str {
+  color: black;
+}

data/example.md

@@ -0,0 +1,42 @@
+# Index
+- MyResource
+
+# MyResource
+This is MyResource description.
+
+## POST /api/v1/my_resource
+
+### Description:
+Some description of the endpoint.
+
+### Request headers:
+```json
+{
+  "AUTHORIZATION" : "user_token",
+  "Content-Type" : "application/json",
+  "Accept" : "application/json"
+}
+```
+
+### Path parameters:
+```json
+{ "id": 1, "page": 1 }
+```
+
+### Body parameters:
+```json
+{ "some": "parameter" }
+```
+
+### Response headers:
+```json
+{ "some_header": "some_header_value" }
+```
+
+### Response status:
+200
+
+### Response body:
+```json
+"no_content"
+```

data/lib/dictum.rb

@@ -13,7 +13,10 @@ module Dictum
     output_path: "#{Dir.tmpdir}/docs",
     root_path: Dir.tmpdir,
     test_suite: :rspec,
-    output_filename: 'Documentation'
+    output_filename: 'Documentation',
+    index_title: 'Index',
+    header_title: 'Dictum',
+    inline_css: nil
   }
 
   def self.configure
@@ -40,6 +43,18 @@ module Dictum
     @config[:output_filename] = file
   end
 
+  def self.index_title=(title)
+    @config[:index_title] = title
+  end
+
+  def self.header_title=(title)
+    @config[:header_title] = title
+  end
+
+  def self.inline_css=(style)
+    @config[:inline_css] = style
+  end
+
   def self.config
     @config
   end
@@ -63,7 +78,7 @@ module Dictum
   #
   def self.document
     Dir.mkdir(@config[:output_path]) unless Dir.exist?(@config[:output_path])
-    Documenter.instance.reset_resources
+    Documenter.instance.reset_data
 
     system "bundle exec rspec #{@config[:root_path]}" if @config[:test_suite] == :rspec
 
@@ -77,9 +92,9 @@ module Dictum
 
     case @config[:output_format]
     when :markdown
-      writer = MarkdownWriter.new(output_filename, tempfile_path)
+      writer = MarkdownWriter.new(output_filename, tempfile_path, @config)
     when :html
-      writer = HtmlWriter.new(output_filename, tempfile_path, 'Dictum')
+      writer = HtmlWriter.new(output_filename, tempfile_path, @config)
     end
 
     writer.write

data/lib/dictum/documenter.rb

@@ -8,21 +8,22 @@ module Dictum
   class Documenter
     include Singleton
 
-    attr_reader :resources, :tempfile_path
+    attr_reader :data, :tempfile_path
     TEMPFILE_NAME = 'dictum_temp.json'.freeze
 
     def initialize
-      @resources = {}
+      reset_data
       @tempfile_path = "#{Dir.tmpdir}/#{TEMPFILE_NAME}"
     end
 
     def resource(arguments = {})
       return if arguments.nil?
       name = arguments[:name]
+      description = arguments[:description]
       return if name.nil?
-      @resources[name] ||= {}
-      @resources[name][:description] = arguments[:description] if arguments[:description]
-      @resources[name][:endpoints] ||= []
+      resources[name] ||= {}
+      resources[name][:description] = description if description
+      resources[name][:endpoints] ||= []
       update_temp
     end
 
@@ -30,21 +31,27 @@ module Dictum
       resource = arguments[:resource]
       endpoint = arguments[:endpoint]
       return if resource.nil? || endpoint.nil?
-      resource(name: arguments[:resource]) unless @resources.key? arguments[:resource]
-      @resources[resource][:endpoints] << arguments_hash(arguments)
+      resource(name: resource) unless resources.key? resource
+      resources[resource][:endpoints] << arguments_hash(arguments)
       update_temp
     end
 
-    def reset_resources
-      @resources = {}
+    def reset_data
+      @data = {
+        resources: {}
+      }
     end
 
     private
 
+    def resources
+      @data[:resources]
+    end
+
     def update_temp
       File.delete(tempfile_path) if File.exist?(tempfile_path)
       file = File.open(tempfile_path, 'w+')
-      file.write(JSON.generate(@resources))
+      file.write(JSON.generate(@data))
       file.close
     end
 

data/lib/dictum/html_helpers.rb

@@ -10,23 +10,19 @@ module Dictum
         yield self
       end
 
-      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>"
+      def html_header(title, body_content, inline_css = nil)
+        "<!DOCTYPE html><html><head><title>#{title}</title>#{external_css(BOOTSTRAP_CSS)}"\
+        "#{inline_css(inline_css)}</head><body>#{body_content}" \
+        "#{script(JQUERY)}#{script(BOOTSTRAP_JS)}#{script(PRETTIFY)}</body></html>"
       end
 
       def container(content)
-        tag('div', "\n#{content}\n", class: 'container-fluid')
+        tag('div', content.to_s, class: 'container-fluid')
       end
 
       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 page_css
-        ''
+        internal_div = tag('div', content.to_s, class: 'col-md-8 col-md-offset-2')
+        tag('div', internal_div.to_s, class: 'row')
       end
 
       def script(script_path)
@@ -36,48 +32,59 @@ module Dictum
 
       def external_css(css_path)
         return '' unless css_path
-        "<link rel='stylesheet' href='#{css_path}' />\n"
+        "<link rel='stylesheet' href='#{css_path}' />"
+      end
+
+      def inline_css(style)
+        return '' unless style
+        "<style>#{style}</style>"
       end
 
       def unordered_list(elements)
-        return "<ul>\n</ul>\n" unless elements
-        answer = "<ul>\n"
+        return '<ul></ul>' unless elements
+        answer = '<ul>'
         elements.each do |element|
-          answer += "<li><a href='#{element.downcase}.html'>#{element}</a></li>\n"
+          answer += list_item(link("#{element.downcase}.html", element))
         end
-        answer += "</ul>\n"
+        answer += '</ul>'
+      end
+
+      def list_item(content)
+        tag('li', content)
       end
 
       def link(href, content)
-        tag('a', content, href: href)
+        tag('a', content, href: './' + href)
       end
 
       def title(text, html_class = nil)
-        return "<h1>#{text}</h1>\n" unless html_class
+        return "<h1>#{text}</h1>" unless html_class
         tag('h1', text, class: html_class)
       end
 
       def subtitle(text, html_class = nil)
-        return "<h3>#{text}</h3>\n" unless html_class
+        return "<h3>#{text}</h3>" 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
+        return "<h4>#{text}</h4>" unless html_class
         tag('h4', text, class: html_class)
       end
 
       def paragraph(text, html_class = nil)
-        return "<p>#{text}</p>\n" unless html_class
+        return "<p>#{text}</p>" unless html_class
         tag('p', text, class: html_class)
       end
 
-      def button(text, glyphicon = nil)
-        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')
+      def button(text, glyphicon = 'glyphicon-menu-left')
+        span = tag('span', nil, class: "glyphicon #{glyphicon}", 'aria-hidden' => 'true')
+        paragraph = paragraph(text)
+        button_content = span.to_s + paragraph.to_s
+        button = tag('button', button_content, 'type' => 'button',
+                                               'class' => 'btn btn-primary back dictum-button',
+                                               'aria-label' => 'Left Align')
+        tag('a', button.to_s, href: 'index.html')
       end
 
       def code_block(title, json)
@@ -91,14 +98,18 @@ module Dictum
         tag('pre', json, class: 'prettyprint')
       end
 
+      def jumbotron(content)
+        return '' unless content
+        tag('div', content, class: 'jumbotron')
+      end
+
       def tag(name, content, attributes = {})
         return '' unless name
         answer = "<#{name}"
         attributes.each do |key, value|
           answer += " #{key}='#{value}'"
         end
-        answer += ">#{content}"
-        answer += "</#{name}>\n"
+        answer += ">#{content}</#{name}>"
       end
     end
   end

data/lib/dictum/html_writer.rb

@@ -1,16 +1,17 @@
 require_relative 'html_helpers'
 require 'json'
-require 'htmlbeautifier'
+require 'nokogiri'
 
 module Dictum
   class HtmlWriter
-    attr_reader :temp_path, :temp_json, :output_dir, :output_file, :output_title
+    attr_reader :temp_path, :temp_json, :output_dir, :output_file, :header_title
 
-    def initialize(output_dir, temp_path, output_title)
+    def initialize(output_dir, temp_path, config)
       @output_dir = output_dir
       @temp_path = temp_path
       @temp_json = JSON.parse(File.read(temp_path))
-      @output_title = output_title
+      @config = config
+      @header_title = config[:header_title]
     end
 
     def write
@@ -23,33 +24,37 @@ module Dictum
 
     def write_to_file(file_path, content)
       index = File.open(file_path, 'w+')
-      index.puts(HtmlBeautifier.beautify(content))
+      index.puts(Nokogiri::HTML(content).to_html)
       index.close
     end
 
     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)
+        content = b.jumbotron(b.title(@config[:index_title], 'title'))
+        content += b.unordered_list(resources.keys)
         container = b.container(b.row(content))
-        b.html_header(output_title, container)
+        b.html_header(header_title, container, @config[:inline_css])
       end
       write_to_file("#{output_dir}/index.html", html)
     end
 
     def write_pages
-      temp_json.each do |resource_name, information|
+      resources.each do |resource_name, information|
         write_page(resource_name, information)
       end
     end
 
+    def resources
+      temp_json['resources']
+    end
+
     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)
+        container = b.container(b.row(content) + b.row(b.button('Back')))
+        b.html_header(header_title, container, @config[:inline_css])
       end
       write_to_file("#{output_dir}/#{resource_name.downcase}.html", html)
     end
@@ -83,7 +88,7 @@ module Dictum
       ) if endpoint['response_headers']
 
       if endpoint['response_body']
-        param = (endpoint['response_body'] == 'no_content') ? {} : endpoint['response_body']
+        param = endpoint['response_body'] == 'no_content' ? {} : endpoint['response_body']
         answer += write_codeblock('Response body', param, builder)
       end
       answer
@@ -91,7 +96,8 @@ module Dictum
 
     def write_codeblock(text, json, builder)
       return unless text && json && builder
-      builder.code_block(text, JSON.pretty_generate(json))
+      sanitized_json = json.empty? ? {} : json
+      builder.code_block(text, JSON.pretty_generate(sanitized_json))
     end
   end
 end

data/lib/dictum/markdown_writer.rb

@@ -4,11 +4,12 @@ module Dictum
   class MarkdownWriter
     attr_reader :temp_path, :temp_json, :output_path, :output_file
 
-    def initialize(output_path, temp_path)
+    def initialize(output_path, temp_path, config)
       @output_path = "#{output_path}.md"
       File.delete(output_path) if File.exist?(output_path)
       @temp_path = temp_path
       @temp_json = JSON.parse(File.read(temp_path))
+      @config = config
     end
 
     def write
@@ -21,15 +22,15 @@ module Dictum
     private
 
     def write_index
-      output_file.puts '# Index'
-      @temp_json.each do |resource_name, _information|
+      output_file.puts "# #{@config[:index_title]}"
+      @temp_json['resources'].each do |resource_name, _information|
         output_file.puts "- #{resource_name}"
       end
       output_file.puts "\n"
     end
 
     def write_temp_path
-      @temp_json.each do |resource_name, information|
+      @temp_json['resources'].each do |resource_name, information|
         output_file.puts "# #{resource_name}"
         output_file.puts "#{information['description']}\n\n"
         write_endpoints(information['endpoints'])
@@ -65,8 +66,9 @@ module Dictum
 
     def print_subsubtitle_json(subtitle, contents)
       return unless subtitle && contents
+      sanitized_contents = contents.empty? ? {} : contents
       output_file.puts "\#\#\# #{subtitle}:"
-      output_file.puts "```json\n#{JSON.pretty_generate(contents)}\n```\n\n"
+      output_file.puts "```json\n#{JSON.pretty_generate(sanitized_contents)}\n```\n\n"
     end
   end
 end

data/lib/dictum/version.rb

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

data/lib/tasks/default_configuration

@@ -0,0 +1,19 @@
+
+RSpec.configure do |config|
+  config.after(:each) do |test|
+    if test.metadata[:dictum]
+    Dictum.endpoint(
+      resource: test.metadata[:described_class].to_s.gsub('V1::', '').gsub('Controller', ''),
+      endpoint: request.fullpath,
+      http_verb: request.env['REQUEST_METHOD'],
+      description: test.metadata[:dictum_description],
+      request_headers: test.metadata[:dictum_no_auth] ? DEFAULT_REQUEST_HEADERS.except('AUTHORIZATION') : DEFAULT_REQUEST_HEADERS,
+      request_path_parameters: request.env['action_dispatch.request.path_parameters'].except(:controller, :action),
+      request_body_parameters: request.env['action_dispatch.request.parameters'].except('controller', 'action'),
+      response_headers: response.headers['Location'] ? { 'Location' => response.headers['Location'] } : nil,
+      response_status: response.status,
+      response_body: response_body
+    )
+    end
+  end
+end

data/lib/tasks/default_initializer

@@ -0,0 +1,6 @@
+Dictum.configure do |config|
+  config.output_path = Rails.root.join('docs')
+  config.root_path = Rails.root
+  config.output_filename = 'Documentation'
+  config.output_format = :markdown
+end

data/lib/tasks/dictum.rake

@@ -1,8 +1,29 @@
 require 'rake'
 
 namespace :dictum do
+  GEM_DIR = Gem::Specification.find_by_name('dictum').gem_dir
+  DEFAULT_CONFIG_PATH = GEM_DIR + '/lib/tasks/default_configuration'
+  DEFAULT_INITIALIZER = GEM_DIR + '/lib/tasks/default_initializer'
+
   desc 'Starts the documenting process'
   task document: :environment do
     system 'bundle exec rails runner -e test Dictum.document'
   end
+
+  desc 'Installs the basic configuration in the file specified or in spec/support/spec_helper.rb'
+  task configure: :environment do
+    configuration_file_path = ARGV[1] || 'spec/support/spec_helper.rb'
+    initializer_file_path = Rails.root.join('config', 'initializers', 'dictum.rb')
+
+    default_config = File.read(DEFAULT_CONFIG_PATH)
+    default_initializer = File.read(DEFAULT_INITIALIZER)
+
+    File.open(configuration_file_path, 'a+') do |file|
+      file.puts(default_config)
+    end
+
+    File.open(initializer_file_path, 'a+') do |file|
+      file.puts(default_initializer)
+    end
+  end
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dictum
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alejandro Bezdjian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: htmlbeautifier
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: '1.6'
   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
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,20 +90,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: '0.40'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.38.2
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.38'
+        version: '0.40'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.38.2
+        version: 0.40.0
 description: Create automatic documentation of your API endpoints through your tests.
 email: alebezdjian@gmail.com
 executables: []
@@ -126,12 +120,17 @@ files:
 - Rakefile
 - TODO.md
 - dictum.gemspec
+- example.css
+- example.gif
+- example.md
 - lib/dictum.rb
 - lib/dictum/documenter.rb
 - lib/dictum/html_helpers.rb
 - lib/dictum/html_writer.rb
 - lib/dictum/markdown_writer.rb
 - lib/dictum/version.rb
+- lib/tasks/default_configuration
+- lib/tasks/default_initializer
 - lib/tasks/dictum.rake
 homepage: https://github.com/Wolox/dictum
 licenses:
@@ -158,4 +157,3 @@ signing_key:
 specification_version: 4
 summary: Document your APIs.
 test_files: []
-has_rdoc: