betterdocs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2dce2da10a7aa53142585ae1bcd71e01647ac0a
-  data.tar.gz: 39cc4830e670c791553e3b2fc6682dac1f9f0d35
+  metadata.gz: f8f9176bd1f4dd32527fa0dc6377812681cbf904
+  data.tar.gz: 71e72348605a0c5bd5d33a2e4802c9d919cf39ab
 SHA512:
-  metadata.gz: 14435b08ce425e42850d60294b562626fcbd0a74b9ac3df8f8a468b43cfb204607cb73a8590d74223cbd35acd38c3438a362cc531db4017450a70288abcf1456
-  data.tar.gz: 76eb043df9dc0017a110e3d4f416d67f6f4f40eaeaea2447825b034e36a134fccdfa50e6f64b06db1e2892a8ba59e40e10844bd5730451b7c37171a1c4d95077
+  metadata.gz: be4a0a50a88523b6a6d5a25fd7d22902136dbe214e73c7952b3b4f4775ec028e3e19501ea587bb7bcd9158888ae3b93cca86e7a2e20bf270a8a43592a83237a9
+  data.tar.gz: 56704465cadef588fb6cbf1746974a199d571756098774b63e620d3eddf4d15ca167f09372262f98b3d31e2285e7e064d5dc19768501ab380c3fe15816a7f4b9

data/.gitignore

@@ -6,6 +6,7 @@
 .ruby-version
 .rvmrc
 .utilsrc
+.yardoc
 Gemfile.lock
 coverage
 errors.lst

data/.travis.yml

@@ -1,9 +1,3 @@
-# Passes arguments to bundle install (http://gembundler.com/man/bundle-install.1.html)
-bundler_args: --binstubs
-
-# Specify which ruby versions you wish to run your tests on, each version will be used
 rvm:
-  - 2.3.1
-script: "bundle exec rake"
-before_install:
-  - gem update bundler
+  - 2.4.0
+sudo: false

data/Gemfile

@@ -4,5 +4,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem "codeclimate-test-reporter", group: :test, require: false
-gem 'byebug'
+gem 'byebug', platform: 'mri'

data/Rakefile

@@ -12,14 +12,16 @@ GemHadar do
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
     '.ruby-version', '.AppleDouble', 'tags', '.DS_Store', '.utilsrc',
-    '.bundle', '.byebug_history', 'errors.lst'
+    '.bundle', '.byebug_history', 'errors.lst', '.yardoc'
   readme      'README.md'
-  title       "#{name.camelize} -- "
+  title       "#{name.camelize}"
 
   dependency 'tins',           '~>1.3', '>=1.3.5'
   dependency 'rails',          '>=3', '<6'
   dependency 'term-ansicolor', '~>1.3'
   dependency 'complex_config', '~>0.5'
+  dependency 'infobar'
+  dependency 'mize'
   development_dependency 'simplecov'
   development_dependency 'rspec'
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/betterdocs.gemspec

@@ -1,23 +1,23 @@
 # -*- encoding: utf-8 -*-
-# stub: betterdocs 0.4.0 ruby lib
+# stub: betterdocs 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterdocs".freeze
-  s.version = "0.4.0"
+  s.version = "0.5.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 = "2016-12-07"
+  s.date = "2017-03-20"
   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/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/section.rb".freeze, "lib/betterdocs/tasks/doc.rake".freeze, "lib/betterdocs/version.rb".freeze, "spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/assets/config/betterdocs.yml".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/generator/markdown_spec.rb".freeze, "spec/global_spec.rb".freeze, "spec/json_params_representer_spec.rb".freeze, "spec/json_type_mapper_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/result_representer_spec.rb".freeze, "spec/spec_helper.rb".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.8".freeze
+  s.rdoc_options = ["--title".freeze, "Betterdocs".freeze, "--main".freeze, "README.md".freeze]
+  s.rubygems_version = "2.6.10".freeze
   s.summary = "Betterplace API documentation library".freeze
-  s.test_files = ["spec/assets/app/controllers/api/foos_controller.rb".freeze, "spec/controller_dsl_spec.rb".freeze, "spec/generator/markdown_spec.rb".freeze, "spec/global_spec.rb".freeze, "spec/json_params_representer_spec.rb".freeze, "spec/json_type_mapper_spec.rb".freeze, "spec/result_representer_dsl_spec.rb".freeze, "spec/result_representer_spec.rb".freeze, "spec/spec_helper.rb".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]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
@@ -30,6 +30,8 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
       s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
       s.add_runtime_dependency(%q<complex_config>.freeze, ["~> 0.5"])
+      s.add_runtime_dependency(%q<infobar>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<mize>.freeze, [">= 0"])
     else
       s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
       s.add_dependency(%q<simplecov>.freeze, [">= 0"])
@@ -38,6 +40,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
       s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
       s.add_dependency(%q<complex_config>.freeze, ["~> 0.5"])
+      s.add_dependency(%q<infobar>.freeze, [">= 0"])
+      s.add_dependency(%q<mize>.freeze, [">= 0"])
     end
   else
     s.add_dependency(%q<gem_hadar>.freeze, ["~> 1.9.1"])
@@ -47,5 +51,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rails>.freeze, ["< 6", ">= 3"])
     s.add_dependency(%q<term-ansicolor>.freeze, ["~> 1.3"])
     s.add_dependency(%q<complex_config>.freeze, ["~> 0.5"])
+    s.add_dependency(%q<infobar>.freeze, [">= 0"])
+    s.add_dependency(%q<mize>.freeze, [">= 0"])
   end
 end

data/lib/betterdocs.rb

@@ -1,4 +1,5 @@
 require 'tins/xt'
+require 'mize'
 require 'rails'
 
 module Betterdocs
@@ -14,6 +15,7 @@ end
 
 require 'betterdocs/version'
 require 'betterdocs/dsl'
+require 'betterdocs/sanitizer'
 require 'betterdocs/result_representer'
 require 'betterdocs/result_representer_collector'
 require 'betterdocs/controller_collector'

data/lib/betterdocs/dsl.rb

@@ -3,7 +3,6 @@ module Betterdocs
   end
 end
 
-require 'betterdocs/dsl/naming'
 require 'betterdocs/dsl/controller'
 require 'betterdocs/dsl/result'
 require 'betterdocs/dsl/json_params'

data/lib/betterdocs/dsl/controller/action/param.rb

@@ -15,11 +15,12 @@ class Betterdocs::Dsl::Controller::Action::Param
 
   dsl_accessor :description, 'TODO'
 
+  # This value should be used to construct an example URL.
   dsl_accessor :use_in_url, true
 
   alias use_in_url? use_in_url
 
   def to_s
-    value
+    value.to_s
   end
 end

data/lib/betterdocs/dsl/controller/action/response.rb

@@ -26,18 +26,15 @@ class Betterdocs::Dsl::Controller::Action::Response
   end
 
   def representer
-    if data
-      data.ask_and_send(:representer) ||
-        data.singleton_class.ancestors.find { |c|
-        Betterdocs::ResultRepresenter >= c && c.respond_to?(:docs)
-        # Actually it's more like
-        #   Betterdocs::ResultRepresenter >= c && !c.singleton_class?
-        # in newer rubies.
-        # But singleton_class? is broken and private in ruby 2.1.x not
-        # existant in <= ruby 2.0.x and finally works in ruby 2.2.x.
-        # What a mess!
-      }
-    end
+    data or return
+    data.ask_and_send(:representer) || inherited_representer(data)
+  end
+
+  private\
+  def inherited_representer(data)
+    data.singleton_class.ancestors.find { |c|
+      Betterdocs::ResultRepresenter >= c && c.respond_to?(:docs)
+    }
   end
 
   def to_json(*a)

data/lib/betterdocs/dsl/json_params/param.rb

@@ -1,3 +1,5 @@
+require 'betterdocs/dsl/naming'
+
 class Betterdocs::Dsl::JsonParams::Param < Betterdocs::Dsl::Representer
   extend Tins::DSLAccessor
   include Betterdocs::Dsl::Common

data/lib/betterdocs/dsl/json_type_mapper.rb

@@ -3,7 +3,7 @@ module Betterdocs::Dsl::JsonTypeMapper
 
   def derive_json_type_from(klass)
     Class === klass or klass = klass.class
-    result = {
+    {
       TrueClass  => 'boolean',
       FalseClass => 'boolean',
       NilClass   => 'null',

data/lib/betterdocs/dsl/result/link.rb

@@ -29,6 +29,7 @@ class Betterdocs::Dsl::Result::Link < Betterdocs::Dsl::Representer
     }
     templated and link['templated'] = true
     result['links'].push(link)
+    self
   end
 
   def add_to_collector(collector)

data/lib/betterdocs/dsl/result/property.rb

@@ -14,7 +14,9 @@ class Betterdocs::Dsl::Result::Property < Betterdocs::Dsl::Representer
 
   dsl_accessor :example, 'TODO'
 
-  dsl_accessor :types do [] end
+  dsl_accessor :types
+
+  dsl_accessor :sanitize do Betterdocs::Global.default_sanitize end
 
   def initialize(representer, name, options, &block)
     super
@@ -36,6 +38,7 @@ class Betterdocs::Dsl::Result::Property < Betterdocs::Dsl::Representer
   def assign(result, object)
     assign?(object) or return
     result[actual_property_name] = compute_value(object)
+    self
   end
 
   def compute_value(object)
@@ -46,10 +49,14 @@ class Betterdocs::Dsl::Result::Property < Betterdocs::Dsl::Representer
     elsif ActiveSupport::TimeWithZone === value
       value.extend Betterdocs::JsonTimeWithZone
     else
-      value
+      sanitizer.sanitize(value)
     end
   end
 
+  def sanitizer
+    Betterdocs::Sanitizer.new(&sanitize)
+  end
+
   def add_to_collector(collector)
     collector.properties[name] = self
   end

data/lib/betterdocs/generator/markdown.rb

@@ -1,11 +1,13 @@
+require 'infobar'
+require 'fileutils'
+require 'term/ansicolor'
+
 module Betterdocs
   module Generator
     class Markdown
       include ::Betterdocs::Generator::ConfigShortcuts
-      require 'fileutils'
-      include FileUtils::Verbose
-      require 'term/ansicolor'
       include Term::ANSIColor
+      include FileUtils
 
       def initialize(only: nil)
         only and @only = Regexp.new(only)
@@ -29,45 +31,58 @@ module Betterdocs
       end
 
       def configure_for_creation
-        STDERR.puts "Setting asset_host to #{Betterdocs::Global.asset_host.inspect}."
+        infobar.puts color(40, "Setting asset_host to #{Betterdocs::Global.asset_host.inspect}.")
         Betterdocs.rails.configuration.action_controller.asset_host = Betterdocs::Global.asset_host
         options = {
           host:     Betterdocs::Global.api_host,
           protocol: Betterdocs::Global.api_protocol
         }
-        STDERR.puts "Setting default_url_options to #{options.inspect}."
+        infobar.puts color(40, "Setting default_url_options to #{options.inspect}.")
         Betterdocs.rails.application.routes.default_url_options = options
         self
       end
 
       def create_sections(dirname)
+        Infobar(total: sections.size)
         cd dirname do
           for section in sections.values
+            infobar.progress(
+              message: "Section #{section.name.to_s.inspect} %c/%t in %te ETA %e @%E",
+              force:   true
+            )
             if @only
               @only =~ section.name or next
             end
-            STDERR.puts on_color(33, "Creating section #{section.name.inspect}.")
             render_to "sections/#{section.name}.md", section_template, section.instance_eval('binding')
           end
         end
+        infobar.finish
+        infobar.newline
         self
       end
 
       def create_readme(dirname)
         name = 'README.md'
         cd dirname do
-          STDERR.puts on_color(33, "Creating readme.")
+          infobar.puts color(40, "Creating readme.")
           render_to name, readme_template, binding
         end
         self
       end
 
       def create_assets
+        Infobar(total: config.assets.size)
         config.each_asset do |src, dst|
-          STDERR.puts on_color(33, "Creating asset #{dst.inspect} from #{src.inspect}.")
+          infobar.progress(
+            message: "Asset #{File.basename(src).inspect} %c/%t in %te ETA %e @%E",
+            force:   true
+          )
           mkdir_p File.dirname(dst)
-          cp src, dst
+          cp Betterdocs.rails.root.join(src), dst
         end
+        infobar.finish
+        infobar.newline
+        self
       end
 
       private
@@ -75,18 +90,10 @@ module Betterdocs
       def fail_while_rendering(template, exception)
         message = blink(color(231, on_color(
           124, " *** ERROR #{exception.class}: #{exception.message.inspect} in template ***")))
-        STDERR.puts message
-        Timeout.timeout(5, Timeout::Error) do
-          STDERR.print "Output long error message? (yes/NO) "
-          if STDIN.gets =~ /\Ay/i
-            STDERR.puts color(88, on_color(136, template)), message,
-              color(136, (%w[Backtrace:] + exception.backtrace) * "\n"),
-              message
-          end
-        end
-      rescue Timeout::Error
-        STDERR.puts "Nope…"
-      ensure
+        infobar.puts message
+        infobar.puts color(88, on_color(136, template)), message,
+          color(136, (%w[Backtrace:] + exception.backtrace) * "\n"),
+          message
         exit 1
       end
 
@@ -105,7 +112,7 @@ module Betterdocs
       end
 
       def read_template(filename)
-        STDERR.puts "Now reading #{filename.inspect}."
+        infobar.puts color(40, "Now reading #{filename.inspect}.")
         File.read(filename)
       end
 
@@ -117,19 +124,19 @@ module Betterdocs
         path = File.expand_path(template_subpath, default_templates_directory)
         File.file?(path) and return read_template(path)
           message = "#{template_subpath.inspect} missing"
-        STDERR.puts " *** #{message}"
+        infobar.puts " *** #{message}"
         "[#{message}]"
       end
 
+      memoize method:
       def readme_template
         provide_template 'README.md.erb'
       end
-      memoize_method :readme_template
 
+      memoize method:
       def section_template
         provide_template 'section.md.erb'
       end
-      memoize_method :section_template
 
       def prepare_dir(dirname)
         dirname.present? or raise ArgumentError,

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

@@ -4,6 +4,6 @@ The <%= project_name %> API
 API ready for use
 -----------------
 
-<%- for secion in sections >
-- [<%=section.name.to_s.camelcase](<%= section(section.name) %>.md)
-
+<%- for section in sections -%>
+- [<%= section.name.to_s.camelcase %>](<%= section(section.name) %>.md)
+<%- end -%>

data/lib/betterdocs/global.rb

@@ -4,6 +4,7 @@ module Betterdocs
   module Global
     class << self
       extend Tins::DSLAccessor
+      extend ComplexConfig::Provider::Shortcuts
 
       dsl_accessor :project_name,        'Project'         # Name of the project
 
@@ -72,6 +73,11 @@ module Betterdocs
 
       dsl_accessor :ignore do [] end                        # All lines of the .gitignore file as an array
 
+      def default_sanitize(code = nil)
+        code and @default_sanitize = eval(code)
+        @default_sanitize
+      end
+
       def assets=(hash)
         @assets&.clear
         assets(hash)
@@ -79,11 +85,7 @@ module Betterdocs
 
       def assets(hash = nil)
         @assets ||= {}
-        if hash
-          hash.each do |path, to|
-            asset path, to: to
-          end
-        end
+        hash&.each { |path, to| asset path, to: to }
         @assets
       end
 
@@ -116,7 +118,7 @@ module Betterdocs
       end
 
       def configuration_file
-        complex_config.betterdocs
+        cc.betterdocs
       rescue ComplexConfig::ConfigurationFileMissing
       end
 
@@ -127,7 +129,6 @@ module Betterdocs
       end
 
       def configure(config = configuration_file, &block)
-        Betterdocs.rails.env.development? or return
         config and configure_via_yaml(config)
         block  and instance_eval(&block)
         self

data/lib/betterdocs/result_representer.rb

@@ -13,6 +13,7 @@ module Betterdocs::ResultRepresenter
         assign_links      result, object
       end
     end
+
     def doc(type, name, **options, &block)
       docs.add_element(self, type, name, options, &block)
     end
@@ -60,9 +61,5 @@ module Betterdocs::ResultRepresenter
       d = doc(:link, name, **options, &block) and links << d
       self
     end
-
-    def api_url_for(options = {})
-      Betterdocs::Global.url_for(options)
-    end
   end
 end

data/lib/betterdocs/sanitizer.rb

@@ -0,0 +1,23 @@
+class Betterdocs::Sanitizer
+  JSON_NONSTRING_TYPES = Tins::ModuleGroup[
+    TrueClass,
+    FalseClass,
+    NilClass,
+    Numeric,
+    Array,
+    Hash,
+  ]
+
+  def initialize(&sanitize)
+    @sanitize = sanitize
+  end
+
+  def sanitize(value)
+    @sanitize or return value
+    if JSON_NONSTRING_TYPES === value
+      value
+    else
+      @sanitize.(value.to_s)
+    end
+  end
+end

data/lib/betterdocs/version.rb

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

data/spec/assets/app/views/api_v4/documentation/assets/CHANGELOG.md

@@ -0,0 +1 @@
+EMPTY

data/spec/assets/config/betterdocs.yml

@@ -1,16 +1,19 @@
 ---
-project_name:        My Example Project
-api_host:            api.example.com:3000
-api_protocol:        https
-platform_host:       site.example.com
-platform_protocol:   http
-asset_host:          "https://assets.example.com"
-api_prefix:          api
-templates_directory: documentation/templates
-output_directory:    api_docs
-assets:
-  'app/views/api_v4/documentation/assets/CHANGELOG.md': :root
-  'app/assets/images/logos/logo.png':                   images/logo.png
-ignore:
-  - .DS_Store
-publish_git: 'git@github.com:foo/bar.git'
+development: &development
+  project_name:        My Example Project
+  api_host:            api.example.com:3000
+  api_protocol:        https
+  platform_host:       site.example.com
+  platform_protocol:   http
+  asset_host:          "https://assets.example.com"
+  api_prefix:          api
+  templates_directory: documentation/templates
+  output_directory:    api_docs
+  assets:
+    'app/views/api_v4/documentation/assets/CHANGELOG.md': :root
+    'app/assets/images/logos/logo.png':                   images/logo.png
+  ignore:
+    - .DS_Store
+  publish_git: 'git@github.com:foo/bar.git'
+  default_sanitize: -> text { ActionController::Base.helpers.sanitize text }
+test: *development

data/spec/betterdocs/dsl/controller/action/param_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Betterdocs::Dsl::Controller::Action::Param do
+  let :param do
+    described_class.new('test') do
+      value 666
+    end
+  end
+
+  it 'has a name' do
+    expect(param.name).to eq 'test'
+  end
+
+  it 'has a value' do
+    expect(param.value).to eq 666
+  end
+
+  it 'has a required setting' do
+    expect(param.required).to eq true
+  end
+
+  it 'has a description' do
+    expect(param.description).to eq 'TODO'
+  end
+
+  it 'has a use_in_url setting' do
+    expect(param.use_in_url).to eq true
+  end
+
+  it 'can be displayed as a string' do
+    expect(param.to_s).to eq '666'
+  end
+end
+

data/spec/betterdocs/dsl/controller/action/response_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Betterdocs::Dsl::Controller::Action::Response do
+  let :docs do
+    double(
+      'Betterdocs::ResultRepresenterCollector',
+      nested_links: :links,
+      nested_properties: :properties
+    )
+  end
+
+  let :representer do
+    double('Representer', docs: docs)
+  end
+
+  let :result_data do
+    double(
+      'Result',
+      representer: representer,
+      to_json: '{ "the": "result" }'
+    )
+  end
+
+  let :response do
+    data = result_data
+    described_class.new do
+      data
+    end
+  end
+
+  let :param_value do
+    double('Betterdocs::Dsl::Controller::Action::Param', value: 'foo')
+  end
+
+  it 'has params' do
+    allow(response).to receive(:param).with(:test).and_return param_value
+    expect(response.params[:test]).to eq 'foo'
+  end
+
+  it 'has data' do
+    expect(response.data).to eq result_data
+  end
+
+  it 'has properties' do
+    expect(response.properties).to eq :properties
+  end
+
+  it 'has links' do
+    expect(response.links).to eq :links
+  end
+
+  it 'has representer' do
+    expect(response.representer).to eq representer
+  end
+
+  it 'can be converted into a JSON document' do
+    expect(response.to_json).to eq '{ "the": "result" }'
+  end
+end

data/spec/{json_type_mapper_spec.rb → betterdocs/dsl/json_type_mapper_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe Betterdocs::Dsl::JsonTypeMapper do
+describe Betterdocs::Dsl::JsonTypeMapper do
   let :jtm do Betterdocs::Dsl::JsonTypeMapper end
 
   it "derives json types" do
@@ -11,9 +11,9 @@ RSpec.describe Betterdocs::Dsl::JsonTypeMapper do
     expect(jtm.derive_json_type_from(nil)).to eq 'null'
     expect(jtm.derive_json_type_from(NilClass)).to eq 'null'
     expect(jtm.derive_json_type_from(42)).to eq 'number'
-    expect(jtm.derive_json_type_from(Fixnum)).to eq 'number'
+    expect(jtm.derive_json_type_from(Integer)).to eq 'number'
     expect(jtm.derive_json_type_from(42)).to eq 'number'
-    expect(jtm.derive_json_type_from(Fixnum)).to eq 'number'
+    expect(jtm.derive_json_type_from(Integer)).to eq 'number'
     expect(jtm.derive_json_type_from(Math::PI)).to eq 'number'
     expect(jtm.derive_json_type_from(Float)).to eq 'number'
     expect(jtm.derive_json_type_from([])).to eq 'array'

data/spec/betterdocs/dsl/result/collection_property_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Betterdocs::Dsl::Result::CollectionProperty do
+  let :result do
+    {}
+  end
+
+  let :representer do
+    double('Betterdocs::ResultRepresenter')
+  end
+
+  let :sub_representer do
+    double(
+      'Betterdocs::ResultRepresenter',
+      hashify: { 'a' => 'hash' },
+      '<': true
+    )
+  end
+
+  let :property do
+    sr = sub_representer
+    described_class.new(representer, 'test', {}) do
+      represent_with sr
+    end
+  end
+
+  let :members do
+    [ double('Member'), double('Member') ]
+  end
+
+  it 'calls representer for every member' do
+    property.assign(result, double(test: members))
+    expect(result['test']).to eq [
+      { 'a' => 'hash' },
+      { 'a' => 'hash' },
+    ]
+  end
+end

data/spec/betterdocs/dsl/result/link_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Betterdocs::Dsl::Result::Link do
+  let :result do
+    {
+      'links' => []
+    }
+  end
+
+  let :representer do
+    double('Betterdocs::ResultRepresenter')
+  end
+
+  context 'mostly default values' do
+    let :link do
+      described_class.new(representer, 'test', {}) do
+        url { :url }
+      end
+    end
+
+    it 'has a name' do
+      expect(link.name).to eq :test
+    end
+
+    it 'has a description' do
+      expect(link.description).to eq 'TODO'
+    end
+
+    it 'has an templated predicate' do
+      expect(link.templated).to eq false
+    end
+
+    it 'has an url block' do
+      expect(link.url).to be_a Proc
+      expect(link.url.()).to eq :url
+    end
+
+    it 'can be assigned' do
+      link.assign(result, double(test: '<foo><evil><bar>'))
+      expect(result['links']).to eq [ { 'rel' => 'test', 'href' => 'url' } ]
+    end
+  end
+end

data/spec/betterdocs/dsl/result/property_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Betterdocs::Dsl::Result::Property do
+  let :result do
+    {}
+  end
+
+  let :representer do
+    double('Betterdocs::ResultRepresenter')
+  end
+
+  context 'mostly default values' do
+    let :property do
+      described_class.new(representer, 'test', {})
+    end
+
+    it 'has a name' do
+      expect(property.name).to eq :test
+    end
+
+    it 'has a description' do
+      expect(property.description).to eq 'TODO'
+    end
+
+    it 'has an example' do
+      expect(property.example).to eq 'TODO'
+    end
+
+    it 'has a types array' do
+      expect(property.types).to eq []
+    end
+
+    it 'has a sanitize proc' do
+      expect(property.sanitize).to be_a Proc
+    end
+
+    it 'can be assigned' do
+      property.assign(result, double(test: '<p><evil></p>'))
+      expect(result['test']).to eq '<p></p>'
+    end
+  end
+
+  context 'configured values' do
+    let :sanitize_proc do
+      -> text { text.gsub('<evil>', '') }
+    end
+
+    let :property do
+      sp = sanitize_proc
+      described_class.new(representer, 'test', {}) do
+        description 'description'
+        example 'example'
+        types ''
+        sanitize sp
+      end
+    end
+
+    it 'has a name' do
+      expect(property.name).to eq :test
+    end
+
+    it 'has a description' do
+      expect(property.description).to eq 'description'
+    end
+
+    it 'has an example' do
+      expect(property.example).to eq 'example'
+    end
+
+    it 'has a types array' do
+      expect(property.types).to eq %w[ string ]
+    end
+
+    it 'has a sanitize proc' do
+      expect(property.sanitize).to eq sanitize_proc
+    end
+
+    it 'can be assigned' do
+      property.assign(result, double(test: '<foo><evil><bar>'))
+      expect(result['test']).to eq '<foo><bar>'
+    end
+  end
+end

data/spec/betterdocs/generator/markdown_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Betterdocs::Generator::Markdown do
+  let :rails do
+    double(
+      root: Pathname.pwd + 'spec/assets',
+      env: double(development?: true),
+      configuration: double.as_null_object,
+      application:   double.as_null_object
+    )
+  end
+
+  before do
+    allow(Betterdocs).to receive(:rails).and_return rails
+    ComplexConfig::Provider.config_dir = 'spec/assets/config'
+    Betterdocs::Global.configure
+  end
+
+  let :generator do
+    described_class.new
+  end
+
+  let :output_directory do
+    Dir.mktmpdir('api_docs')
+  end
+
+  before do
+    allow(generator.config).to receive(:output_directory).and_return output_directory
+  end
+
+  it 'can be instantiated' do
+    expect(generator).to be_a described_class
+  end
+
+  it 'can generate' do
+    dirname = generator.config.output_directory
+    expect(generator).to receive(:generate_to).with(dirname).and_call_original
+    expect(generator).to receive(:configure_for_creation).and_call_original
+    expect(generator).to receive(:prepare_dir).with(dirname).and_call_original
+    expect(generator).to receive(:create_sections).with(dirname).and_call_original
+    expect(generator).to receive(:create_readme).with(dirname).and_call_original
+    expect(generator).to receive(:create_assets).and_call_original
+    expect(generator.generate).to eq generator
+  end
+end

data/spec/{global_spec.rb → betterdocs/global_spec.rb}

@@ -1,11 +1,11 @@
 require 'spec_helper'
 require 'pathname'
 
-RSpec.describe Betterdocs::Global do
+describe Betterdocs::Global do
   let :rails do
     double(
       root: Pathname.pwd + 'spec/assets',
-      env: double(development?: true)
+      env:  double(development?: true)
     )
   end
 

data/spec/{json_params_representer_spec.rb → betterdocs/json_params_representer_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe Betterdocs::JsonParamsRepresenter do
+describe Betterdocs::JsonParamsRepresenter do
   module MyJsonParams
     include Betterdocs::JsonParamsRepresenter
 

data/spec/{result_representer_spec.rb → betterdocs/result_representer_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe Betterdocs::ResultRepresenter do
+describe Betterdocs::ResultRepresenter do
   module MySubRepresenter
     include Betterdocs::ResultRepresenter
 

data/spec/betterdocs/sanitizer_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Betterdocs::Sanitizer do
+  let :sanitizer do
+    described_class.new do |text|
+      text.gsub('<evil>', '')
+    end
+  end
+
+  let :text do
+    '<foo><evil><bar>'
+  end
+
+  it 'removes evil tags from strings' do
+    expect(sanitizer.sanitize(text)).to eq '<foo><bar>'
+  end
+
+  it 'ignores other JSON data types' do
+    expect(sanitizer.sanitize(nil)).to eq nil
+  end
+
+  it 'calls #to_s on the remaining types and sanitizes' do
+    expect(sanitizer.sanitize(double(to_s: text))).to eq '<foo><bar>'
+  end
+end

data/spec/controller_dsl_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe 'controller dsl' do
+describe 'controller dsl' do
   let :docs do
     Betterdocs::ControllerCollector.new
   end

data/spec/result_representer_dsl_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-RSpec.describe 'representer dsl' do
+describe 'representer dsl' do
   let :docs do
     Betterdocs::ResultRepresenterCollector.new
   end
@@ -152,7 +152,6 @@ EOT
       end
     end
 
-
     module Person
       include Betterdocs::ResultRepresenter
 

data/spec/spec_helper.rb

@@ -1,19 +1,17 @@
 require 'simplecov'
-require "codeclimate-test-reporter"
 if ENV['START_SIMPLECOV'].to_i == 1
   SimpleCov.start do
     add_filter "#{File.basename(File.dirname(__FILE__))}/"
   end
 end
-if ENV['CODECLIMATE_REPO_TOKEN']
-  if ENV['START_SIMPLECOV']
-    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-      SimpleCov::Formatter::HTMLFormatter,
-      CodeClimate::TestReporter::Formatter
-    ]
-  end
-  CodeClimate::TestReporter.start
-end
 require 'rspec'
 require 'byebug'
 require 'betterdocs'
+
+RSpec.configure do |c|
+  c.before do
+    ComplexConfig::Provider.config_dir = 'spec/assets/config'
+    Betterdocs::Global.configure
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterdocs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -120,6 +120,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: infobar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This library provides tools to generate API documention for a web site's
   REST-ful JSON API.
 email: developers@betterplace.org
@@ -158,6 +186,7 @@ extra_rdoc_files:
 - lib/betterdocs/representer.rb
 - lib/betterdocs/result_representer.rb
 - lib/betterdocs/result_representer_collector.rb
+- lib/betterdocs/sanitizer.rb
 - lib/betterdocs/section.rb
 - lib/betterdocs/version.rb
 files:
@@ -205,18 +234,27 @@ files:
 - lib/betterdocs/representer.rb
 - lib/betterdocs/result_representer.rb
 - lib/betterdocs/result_representer_collector.rb
+- lib/betterdocs/sanitizer.rb
 - lib/betterdocs/section.rb
 - lib/betterdocs/tasks/doc.rake
 - lib/betterdocs/version.rb
+- spec/assets/app/assets/images/logos/logo.png
 - spec/assets/app/controllers/api/foos_controller.rb
+- spec/assets/app/views/api_v4/documentation/assets/CHANGELOG.md
 - spec/assets/config/betterdocs.yml
+- spec/betterdocs/dsl/controller/action/param_spec.rb
+- spec/betterdocs/dsl/controller/action/response_spec.rb
+- spec/betterdocs/dsl/json_type_mapper_spec.rb
+- spec/betterdocs/dsl/result/collection_property_spec.rb
+- spec/betterdocs/dsl/result/link_spec.rb
+- spec/betterdocs/dsl/result/property_spec.rb
+- spec/betterdocs/generator/markdown_spec.rb
+- spec/betterdocs/global_spec.rb
+- spec/betterdocs/json_params_representer_spec.rb
+- spec/betterdocs/result_representer_spec.rb
+- spec/betterdocs/sanitizer_spec.rb
 - spec/controller_dsl_spec.rb
-- spec/generator/markdown_spec.rb
-- spec/global_spec.rb
-- spec/json_params_representer_spec.rb
-- spec/json_type_mapper_spec.rb
 - spec/result_representer_dsl_spec.rb
-- spec/result_representer_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/betterplace/betterdocs
 licenses: []
@@ -224,7 +262,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - "--title"
-- 'Betterdocs -- '
+- Betterdocs
 - "--main"
 - README.md
 require_paths:
@@ -241,17 +279,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Betterplace API documentation library
 test_files:
 - spec/assets/app/controllers/api/foos_controller.rb
+- spec/betterdocs/dsl/controller/action/param_spec.rb
+- spec/betterdocs/dsl/controller/action/response_spec.rb
+- spec/betterdocs/dsl/json_type_mapper_spec.rb
+- spec/betterdocs/dsl/result/collection_property_spec.rb
+- spec/betterdocs/dsl/result/link_spec.rb
+- spec/betterdocs/dsl/result/property_spec.rb
+- spec/betterdocs/generator/markdown_spec.rb
+- spec/betterdocs/global_spec.rb
+- spec/betterdocs/json_params_representer_spec.rb
+- spec/betterdocs/result_representer_spec.rb
+- spec/betterdocs/sanitizer_spec.rb
 - spec/controller_dsl_spec.rb
-- spec/generator/markdown_spec.rb
-- spec/global_spec.rb
-- spec/json_params_representer_spec.rb
-- spec/json_type_mapper_spec.rb
 - spec/result_representer_dsl_spec.rb
-- spec/result_representer_spec.rb
 - spec/spec_helper.rb

data/spec/generator/markdown_spec.rb

@@ -1,5 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Betterdocs::Generator::Markdown do
-  it "does all kinds of stuff correctly"
-end