betterdocs 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54160f33d0d7395972aa7235c457d10e3dedc53e
-  data.tar.gz: 5560f62d8d2a19b87e8b7eaabddfc4e5b47b544c
+  metadata.gz: 3db95985948a6ea7f7ef6fedb7057c9403c51629
+  data.tar.gz: 6a6bb0a36b82481e1e7451e533423ab00d765d95
 SHA512:
-  metadata.gz: 18f0b84802e4c773e12ce31055090b64f468d71564b4e32723f58ccab79477f22ff25cbd94860fa840d2dcde2cf7459edee1848eaa7bbee1bac71125a24c74d1
-  data.tar.gz: 79890844e6373cb8dba6d74caed86c311b69feef4c7b0dd9944a2dc232e94f2c9971f1fcef8afa035cf80b25af3a350706fe81b4d9187c7371fd63ef7bd9ed4a
+  metadata.gz: 6515adc1cf8a4faeb58e15acc26dc7129f5658b990cd2bf42506f1fb6508df219dbf87645772cbbd7cb2373c0272d35ba1ba05830a8246f7f9b9ac050f3c7243
+  data.tar.gz: 7914bad33f84a4a36aff48cb2173ab89d47b8d1c64dcb72143ee68bc4c776d200590eb9635265232dfc249b566a2930227760bd1b0c7a8b8f60b36d75b56ee59

data/.gitignore

@@ -2,10 +2,12 @@
 .AppleDouble
 .DS_Store
 .bundle
+.byebug_history
 .ruby-version
 .rvmrc
 .utilsrc
 Gemfile.lock
 coverage
+errors.lst
 pkg
 tags

data/.travis.yml

@@ -3,7 +3,7 @@ bundler_args: --binstubs
 
 # Specify which ruby versions you wish to run your tests on, each version will be used
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.3.1
 script: "bundle exec rake"
+before_install:
+  - gem update bundler

data/Rakefile

@@ -11,13 +11,15 @@ GemHadar do
   description "This library provides tools to generate API documention for a web site's REST-ful JSON API."
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', 'coverage', '.rvmrc',
-    '.ruby-version', '.AppleDouble', 'tags', '.DS_Store', '.utilsrc', '.bundle'
+    '.ruby-version', '.AppleDouble', 'tags', '.DS_Store', '.utilsrc',
+    '.bundle', '.byebug_history', 'errors.lst'
   readme      'README.md'
   title       "#{name.camelize} -- "
 
   dependency 'tins',           '~>1.3', '>=1.3.5'
   dependency 'rails',          '>=3', '<5'
   dependency 'term-ansicolor', '~>1.3'
+  dependency 'complex_config', '~>0.5'
   development_dependency 'simplecov'
   development_dependency 'rspec'
 end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/betterdocs.gemspec

@@ -1,48 +1,51 @@
 # -*- encoding: utf-8 -*-
-# stub: betterdocs 0.2.0 ruby lib
+# stub: betterdocs 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "betterdocs"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["betterplace Developers"]
-  s.date = "2016-03-30"
+  s.date = "2016-06-13"
   s.description = "This library provides tools to generate API documention for a web site's REST-ful JSON API."
   s.email = "developers@betterplace.org"
-  s.extra_rdoc_files = ["README.md", "lib/betterdocs.rb", "lib/betterdocs/controller_collector.rb", "lib/betterdocs/dsl.rb", "lib/betterdocs/dsl/common.rb", "lib/betterdocs/dsl/controller.rb", "lib/betterdocs/dsl/controller/action.rb", "lib/betterdocs/dsl/controller/action/param.rb", "lib/betterdocs/dsl/controller/action/response.rb", "lib/betterdocs/dsl/controller/controller.rb", "lib/betterdocs/dsl/controller/controller_base.rb", "lib/betterdocs/dsl/json_params.rb", "lib/betterdocs/dsl/json_params/param.rb", "lib/betterdocs/dsl/json_type_mapper.rb", "lib/betterdocs/dsl/naming.rb", "lib/betterdocs/dsl/representer.rb", "lib/betterdocs/dsl/result.rb", "lib/betterdocs/dsl/result/collection_property.rb", "lib/betterdocs/dsl/result/link.rb", "lib/betterdocs/dsl/result/property.rb", "lib/betterdocs/generator/config_shortcuts.rb", "lib/betterdocs/generator/markdown.rb", "lib/betterdocs/global.rb", "lib/betterdocs/json_params_representer.rb", "lib/betterdocs/json_params_representer_collector.rb", "lib/betterdocs/mix_into_controller.rb", "lib/betterdocs/rake_tasks.rb", "lib/betterdocs/representer.rb", "lib/betterdocs/result_representer.rb", "lib/betterdocs/result_representer_collector.rb", "lib/betterdocs/section.rb", "lib/betterdocs/version.rb"]
-  s.files = [".codeclimate.yml", ".gitignore", ".rspec", ".travis.yml", "COPYING", "Gemfile", "LICENSE", "README.md", "Rakefile", "VERSION", "betterdocs.gemspec", "lib/betterdocs.rb", "lib/betterdocs/controller_collector.rb", "lib/betterdocs/dsl.rb", "lib/betterdocs/dsl/common.rb", "lib/betterdocs/dsl/controller.rb", "lib/betterdocs/dsl/controller/action.rb", "lib/betterdocs/dsl/controller/action/param.rb", "lib/betterdocs/dsl/controller/action/response.rb", "lib/betterdocs/dsl/controller/controller.rb", "lib/betterdocs/dsl/controller/controller_base.rb", "lib/betterdocs/dsl/json_params.rb", "lib/betterdocs/dsl/json_params/param.rb", "lib/betterdocs/dsl/json_type_mapper.rb", "lib/betterdocs/dsl/naming.rb", "lib/betterdocs/dsl/representer.rb", "lib/betterdocs/dsl/result.rb", "lib/betterdocs/dsl/result/collection_property.rb", "lib/betterdocs/dsl/result/link.rb", "lib/betterdocs/dsl/result/property.rb", "lib/betterdocs/generator/config_shortcuts.rb", "lib/betterdocs/generator/markdown.rb", "lib/betterdocs/generator/markdown/templates/README.md.erb", "lib/betterdocs/generator/markdown/templates/section.md.erb", "lib/betterdocs/global.rb", "lib/betterdocs/json_params_representer.rb", "lib/betterdocs/json_params_representer_collector.rb", "lib/betterdocs/mix_into_controller.rb", "lib/betterdocs/rake_tasks.rb", "lib/betterdocs/representer.rb", "lib/betterdocs/result_representer.rb", "lib/betterdocs/result_representer_collector.rb", "lib/betterdocs/section.rb", "lib/betterdocs/tasks/doc.rake", "lib/betterdocs/version.rb", "spec/controller_dsl_spec.rb", "spec/generator/markdown_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"]
+  s.extra_rdoc_files = ["README.md", "lib/betterdocs.rb", "lib/betterdocs/controller_collector.rb", "lib/betterdocs/dsl.rb", "lib/betterdocs/dsl/common.rb", "lib/betterdocs/dsl/controller.rb", "lib/betterdocs/dsl/controller/action.rb", "lib/betterdocs/dsl/controller/action/param.rb", "lib/betterdocs/dsl/controller/action/response.rb", "lib/betterdocs/dsl/controller/controller.rb", "lib/betterdocs/dsl/controller/controller_base.rb", "lib/betterdocs/dsl/json_params.rb", "lib/betterdocs/dsl/json_params/param.rb", "lib/betterdocs/dsl/json_type_mapper.rb", "lib/betterdocs/dsl/naming.rb", "lib/betterdocs/dsl/representer.rb", "lib/betterdocs/dsl/result.rb", "lib/betterdocs/dsl/result/collection_property.rb", "lib/betterdocs/dsl/result/link.rb", "lib/betterdocs/dsl/result/property.rb", "lib/betterdocs/generator/config_shortcuts.rb", "lib/betterdocs/generator/markdown.rb", "lib/betterdocs/global.rb", "lib/betterdocs/json_params_representer.rb", "lib/betterdocs/json_params_representer_collector.rb", "lib/betterdocs/json_time_with_zone.rb", "lib/betterdocs/mix_into_controller.rb", "lib/betterdocs/railtie.rb", "lib/betterdocs/rake_tasks.rb", "lib/betterdocs/representer.rb", "lib/betterdocs/result_representer.rb", "lib/betterdocs/result_representer_collector.rb", "lib/betterdocs/section.rb", "lib/betterdocs/version.rb"]
+  s.files = [".codeclimate.yml", ".gitignore", ".rspec", ".travis.yml", "COPYING", "Gemfile", "LICENSE", "README.md", "Rakefile", "VERSION", "betterdocs.gemspec", "lib/betterdocs.rb", "lib/betterdocs/controller_collector.rb", "lib/betterdocs/dsl.rb", "lib/betterdocs/dsl/common.rb", "lib/betterdocs/dsl/controller.rb", "lib/betterdocs/dsl/controller/action.rb", "lib/betterdocs/dsl/controller/action/param.rb", "lib/betterdocs/dsl/controller/action/response.rb", "lib/betterdocs/dsl/controller/controller.rb", "lib/betterdocs/dsl/controller/controller_base.rb", "lib/betterdocs/dsl/json_params.rb", "lib/betterdocs/dsl/json_params/param.rb", "lib/betterdocs/dsl/json_type_mapper.rb", "lib/betterdocs/dsl/naming.rb", "lib/betterdocs/dsl/representer.rb", "lib/betterdocs/dsl/result.rb", "lib/betterdocs/dsl/result/collection_property.rb", "lib/betterdocs/dsl/result/link.rb", "lib/betterdocs/dsl/result/property.rb", "lib/betterdocs/generator/config_shortcuts.rb", "lib/betterdocs/generator/markdown.rb", "lib/betterdocs/generator/markdown/templates/README.md.erb", "lib/betterdocs/generator/markdown/templates/section.md.erb", "lib/betterdocs/global.rb", "lib/betterdocs/json_params_representer.rb", "lib/betterdocs/json_params_representer_collector.rb", "lib/betterdocs/json_time_with_zone.rb", "lib/betterdocs/mix_into_controller.rb", "lib/betterdocs/railtie.rb", "lib/betterdocs/rake_tasks.rb", "lib/betterdocs/representer.rb", "lib/betterdocs/result_representer.rb", "lib/betterdocs/result_representer_collector.rb", "lib/betterdocs/section.rb", "lib/betterdocs/tasks/doc.rake", "lib/betterdocs/version.rb", "spec/assets/app/controllers/api/foos_controller.rb", "spec/assets/config/betterdocs.yml", "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"]
   s.homepage = "http://github.com/betterplace/betterdocs"
   s.rdoc_options = ["--title", "Betterdocs -- ", "--main", "README.md"]
   s.rubygems_version = "2.5.1"
   s.summary = "Betterplace API documentation library"
-  s.test_files = ["spec/controller_dsl_spec.rb", "spec/generator/markdown_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"]
+  s.test_files = ["spec/assets/app/controllers/api/foos_controller.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"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<gem_hadar>, ["~> 1.6.1"])
+      s.add_development_dependency(%q<gem_hadar>, ["~> 1.7.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_runtime_dependency(%q<tins>, [">= 1.3.5", "~> 1.3"])
       s.add_runtime_dependency(%q<rails>, ["< 5", ">= 3"])
       s.add_runtime_dependency(%q<term-ansicolor>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<complex_config>, ["~> 0.5"])
     else
-      s.add_dependency(%q<gem_hadar>, ["~> 1.6.1"])
+      s.add_dependency(%q<gem_hadar>, ["~> 1.7.1"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<tins>, [">= 1.3.5", "~> 1.3"])
       s.add_dependency(%q<rails>, ["< 5", ">= 3"])
       s.add_dependency(%q<term-ansicolor>, ["~> 1.3"])
+      s.add_dependency(%q<complex_config>, ["~> 0.5"])
     end
   else
-    s.add_dependency(%q<gem_hadar>, ["~> 1.6.1"])
+    s.add_dependency(%q<gem_hadar>, ["~> 1.7.1"])
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<tins>, [">= 1.3.5", "~> 1.3"])
     s.add_dependency(%q<rails>, ["< 5", ">= 3"])
     s.add_dependency(%q<term-ansicolor>, ["~> 1.3"])
+    s.add_dependency(%q<complex_config>, ["~> 0.5"])
   end
 end

data/lib/betterdocs.rb

@@ -25,3 +25,5 @@ require 'betterdocs/mix_into_controller'
 require 'betterdocs/generator/config_shortcuts'
 require 'betterdocs/generator/markdown'
 require 'betterdocs/rake_tasks'
+require 'betterdocs/json_time_with_zone'
+defined? Rails and require 'betterdocs/railtie'

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

@@ -94,12 +94,13 @@ class Betterdocs::Dsl::Controller::Action < Betterdocs::Dsl::Controller::Control
 
   def url
     url_params = params.select { |_, param| param.use_in_url? }
-    Betterdocs.rails.application.routes.url_for(
-      {
-        controller: controller.name.underscore.sub(/_controller\z/, ''),
-        action:     action,
-      } | url_params | Betterdocs::Global.config.api_url_options
-    )
+    url_params = {
+      controller: controller.name.underscore.sub(/_controller\z/, ''),
+      action:     action,
+    } | url_params | Betterdocs::Global.config.api_url_options
+    Betterdocs.rails.application.routes.url_for(url_params)
+  rescue ActionController::UrlGenerationError => e
+    raise e, "Could not generate URL for parameters #{url_params}. Check your param definitions!"
   end
 
   def request

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

@@ -22,7 +22,11 @@ class Betterdocs::Dsl::JsonParams::Param < Betterdocs::Dsl::Representer
   end
 
   def compute_value(object)
-    object.__send__(name)
+    value = object.__send__(name)
+    if ActiveSupport::TimeWithZone === value
+      value.extend Betterdocs::JsonTimeWithZone
+    end
+    value
   end
 
   def add_to_collector(collector)

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

@@ -40,8 +40,11 @@ class Betterdocs::Dsl::Result::Property < Betterdocs::Dsl::Representer
 
   def compute_value(object)
     value = object.__send__(name)
-    if !value.nil? && represent_with
+    value.nil? and return
+    if represent_with
       represent_with.hashify(value)
+    elsif ActiveSupport::TimeWithZone === value
+      value.extend Betterdocs::JsonTimeWithZone
     else
       value
     end

data/lib/betterdocs/global.rb

@@ -1,3 +1,5 @@
+require 'complex_config/rude'
+
 module Betterdocs
   module Global
     class << self
@@ -7,8 +9,29 @@ module Betterdocs
 
       dsl_accessor :api_prefix,          'api'             # Prefix that denotes the api namespace in URLs
 
+      dsl_accessor :controllers_dir do
+        Betterdocs.rails.root.join('app/controllers')
+      end
+
       dsl_accessor :api_controllers do
-        Dir[Rails.root.join("app/controllers/#{api_prefix}/**/*_controller.rb")]
+        Dir[controllers_dir + "#{api_prefix}/**/*_controller.rb"]
+      end
+
+      private def handle_url(prefix, url)
+        if url
+          uri = URI.parse(url)
+          __send__("#{prefix}_protocol", uri.scheme || 'http')
+          host = uri.host || 'localhost'
+          port = uri.port and host = "#{host}:#{port}"
+          platform_host host
+          __send__("#{prefix}_host", host)
+        else
+          [ __send__("#{prefix}_protocol"), __send__("#{prefix}_host") ] * '://'
+        end
+      end
+
+      def platform_url(url = nil)
+        handle_url(:platform, url)
       end
 
       dsl_accessor :platform_protocol,   'http'               # Not used atm
@@ -19,17 +42,25 @@ module Betterdocs
 
       dsl_accessor :api_host   do platform_host end           # Hostname of the API (eventuallly with port number)
 
+      def api_url(url = nil)
+        handle_url(:api, url)
+      end
+
       dsl_accessor :asset_protocol do platform_protocol end   # Reserved
 
       dsl_accessor :asset_host do platform_host end           # Rails asset host
 
+      def asset_url(url = nil)
+        handle_url(:asset, url)
+      end
+
       dsl_accessor :api_default_format,  'json'
 
       def api_base_url
         "#{api_protocol}://#{api_host}/#{api_prefix}"
       end
 
-      dsl_accessor :api_url_options do
+      def api_url_options
         { protocol: api_protocol, host: api_host, format: api_default_format }
       end
 
@@ -41,20 +72,31 @@ module Betterdocs
 
       dsl_accessor :ignore do [] end                        # All lines of the .gitignore file as an array
 
-      def assets
+      def assets=(hash)
+        @assets&.clear
+        assets(hash)
+      end
+
+      def assets(hash = nil)
         @assets ||= {}
+        if hash
+          hash.each do |path, to|
+            asset path, to: to
+          end
+        end
+        @assets
       end
-      private :assets
 
       # Defines an asset for the file at +path+. If +to+ was given it will be
       # copied to this path (it includes the basename) below
       # +templates_directory+ in the output, otherwise it will be copied
       # directly to +templates_directory+.
       def asset(path, to: :root)
+        @assets ||= {}
         if destination = to.ask_and_send(:to_str)
-          assets[path.to_s] = destination
+          @assets[path.to_s] = destination
         elsif to == :root
-          assets[path.to_s] = to
+          @assets[path.to_s] = to
         else
           raise ArgumentError, "keyword argument to needs to be a string or :root"
         end
@@ -63,20 +105,31 @@ module Betterdocs
       # Maps the assets original source path to its destination path in the
       # output by yielding to every asset's source/destination pair.
       def each_asset
-        for path in assets.keys
+        for (path, destination) in assets
           path = path.to_s
-          if destination = assets[path]
-            if destination == :root && output_directory
-              yield path, File.join(output_directory.to_s, File.basename(path))
-            else
-              yield path, File.join(output_directory.to_s, destination.to_str)
-            end
+          if destination == :root
+            yield path, File.join(output_directory.to_s, File.basename(path))
+          else
+            yield path, File.join(output_directory.to_s, destination.to_str)
           end
         end
       end
 
-      def configure(&block)
-        instance_eval(&block)
+      def configuration_file
+        complex_config.betterdocs
+      rescue ComplexConfig::ConfigurationFileMissing
+      end
+
+      def configure_via_yaml(config)
+        config.each do |name, value|
+          __send__(name, value.dup)
+        end
+      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
       end
 
@@ -89,19 +142,21 @@ module Betterdocs
       end
 
       def all_docs
-        Dir[api_prefix.to_s + '/**/*_controller.rb'].each_with_object([]) do |cf, all|
-          controller_name = cf.sub(/\.rb$/, '').camelcase
-          controller =
-            begin
-              controller_name.constantize
-            rescue NameError => e
-              STDERR.puts "Skipping #{cf.inspect}, #{e.class}: #{e}"
-              next
+        Dir.chdir controllers_dir do
+          Dir["#{api_prefix}/**/*_controller.rb"].each_with_object([]) do |cf, all|
+            controller_name = cf.sub(/\.rb$/, '').camelcase
+            controller =
+              begin
+                controller_name.constantize
+              rescue NameError => e
+                STDERR.puts "Skipping #{cf.inspect}, #{e.class}: #{e}"
+                next
+              end
+            if docs = controller.ask_and_send(:docs)
+              all << docs
+            else
+              STDERR.puts "Skipping #{cf.inspect}, #{controller_name.inspect} doesn't respond to :docs method"
             end
-          if docs = controller.ask_and_send(:docs)
-            all << docs
-          else
-            STDERR.puts "Skipping #{cf.inspect}, #{controller_name.inspect} doesn't respond to :docs method"
           end
         end
       end
@@ -112,7 +167,7 @@ module Betterdocs
 
       def sections
         @sections and return @sections
-        Dir.chdir Rails.root.join('app/controllers') do
+        Dir.chdir controllers_dir do
           actions.each_with_object(@sections = {}) do |action, sections|
             sections[action.section] ||= Section.new(action.section)
             sections[action.section] << action

data/lib/betterdocs/json_time_with_zone.rb

@@ -0,0 +1,7 @@
+module Betterdocs
+  module JsonTimeWithZone
+    def to_json(*)
+      iso8601.inspect
+    end
+  end
+end

data/lib/betterdocs/railtie.rb

@@ -0,0 +1,7 @@
+module Betterdocs
+  class Railtie < Rails::Railtie
+    initializer 'betterdocs.configure_rails_initialization' do
+      Betterdocs::Global.configure
+    end
+  end
+end

data/lib/betterdocs/version.rb

@@ -1,6 +1,6 @@
 module Betterdocs
   # Betterdocs version
-  VERSION         = '0.2.0'
+  VERSION         = '0.3.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/controllers/api/foos_controller.rb

@@ -0,0 +1,4 @@
+module Api
+  class FoosController
+  end
+end

data/spec/assets/config/betterdocs.yml

@@ -0,0 +1,16 @@
+---
+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'

data/spec/global_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+require 'pathname'
+
+RSpec.describe Betterdocs::Global do
+  let :rails do
+    double(
+      root: Pathname.pwd + 'spec/assets',
+      env: double(development?: true)
+    )
+  end
+
+  before do
+    allow(Betterdocs).to receive(:rails).and_return rails
+    ComplexConfig::Provider.config_dir = 'spec/assets/config'
+    Betterdocs::Global.configure
+  end
+
+  it 'has a project name' do
+    expect(Betterdocs::Global.project_name).to eq 'My Example Project'
+  end
+
+  it 'uses an api prefix' do
+    expect(Betterdocs::Global.api_prefix).to eq 'api'
+  end
+
+  it 'returns all api controllers via wild matching' do
+    expect(Betterdocs::Global.api_controllers.size).to eq 1
+    expect(Betterdocs::Global.api_controllers.last).to end_with\
+      'spec/assets/app/controllers/api/foos_controller.rb'
+  end
+
+  context 'platform url' do
+    before do
+      Betterdocs::Global.platform_protocol 'http'
+      Betterdocs::Global.platform_host 'localhost:3000'
+    end
+
+    it 'has default platform_url' do
+      expect(Betterdocs::Global.platform_url).to eq 'http://localhost:3000'
+    end
+
+    it 'can parse platform_url' do
+      Betterdocs::Global.platform_url 'https://foo.bar:1234'
+      expect(Betterdocs::Global.platform_url).to eq 'https://foo.bar:1234'
+      Betterdocs::Global.platform_url 'https://foo.bar'
+      expect(Betterdocs::Global.platform_url).to eq 'https://foo.bar:443'
+      Betterdocs::Global.platform_url 'http://foo.bar'
+      expect(Betterdocs::Global.platform_url).to eq 'http://foo.bar:80'
+    end
+
+    it 'has platform_protocol' do
+      expect(Betterdocs::Global.platform_protocol).to eq 'http'
+    end
+
+    it 'has platform_host' do
+      expect(Betterdocs::Global.platform_host).to eq 'localhost:3000'
+    end
+  end
+
+  context 'api url' do
+    before do
+      Betterdocs::Global.api_protocol 'http'
+      Betterdocs::Global.api_host 'localhost:3000'
+    end
+
+    it 'has default api_url' do
+      expect(Betterdocs::Global.api_url).to eq 'http://localhost:3000'
+    end
+
+    it 'can parse api_url' do
+      Betterdocs::Global.api_url 'https://foo.bar:1234'
+      expect(Betterdocs::Global.api_url).to eq 'https://foo.bar:1234'
+      Betterdocs::Global.api_url 'https://foo.bar'
+      expect(Betterdocs::Global.api_url).to eq 'https://foo.bar:443'
+      Betterdocs::Global.api_url 'http://foo.bar'
+      expect(Betterdocs::Global.api_url).to eq 'http://foo.bar:80'
+    end
+
+    it 'has api_protocol' do
+      expect(Betterdocs::Global.api_protocol).to eq 'http'
+    end
+
+    it 'has api_host' do
+      expect(Betterdocs::Global.api_host).to eq 'localhost:3000'
+    end
+
+    it 'can return api_base_url' do
+      Betterdocs::Global.api_url 'https://foo.bar:1234'
+      expect(Betterdocs::Global.api_base_url).to eq 'https://foo.bar:1234/api'
+    end
+
+  end
+
+  context 'asset url' do
+    before do
+      Betterdocs::Global.asset_protocol 'http'
+      Betterdocs::Global.asset_host 'localhost:3000'
+    end
+
+    it 'has default asset_url' do
+      expect(Betterdocs::Global.asset_url).to eq 'http://localhost:3000'
+    end
+
+    it 'can parse asset_url' do
+      Betterdocs::Global.asset_url 'https://foo.bar:1234'
+      expect(Betterdocs::Global.asset_url).to eq 'https://foo.bar:1234'
+      Betterdocs::Global.asset_url 'https://foo.bar'
+      expect(Betterdocs::Global.asset_url).to eq 'https://foo.bar:443'
+      Betterdocs::Global.asset_url 'http://foo.bar'
+      expect(Betterdocs::Global.asset_url).to eq 'http://foo.bar:80'
+    end
+
+    it 'has asset_protocol' do
+      expect(Betterdocs::Global.asset_protocol).to eq 'http'
+    end
+
+    it 'has asset_host' do
+      expect(Betterdocs::Global.asset_host).to eq 'localhost:3000'
+    end
+  end
+
+  it 'has api_default_format' do
+    expect(Betterdocs::Global.api_default_format).to eq 'json'
+  end
+
+  it 'can return api_url_options' do
+    expect(Betterdocs::Global.api_url_options).to eq(
+      protocol: "https",
+      host:     "api.example.com:3000",
+      format:   "json"
+    )
+  end
+
+  it 'has templates_directory' do
+    expect(Betterdocs::Global.templates_directory).to\
+      eq 'documentation/templates'
+  end
+
+  it 'has output_directory' do
+    expect(Betterdocs::Global.output_directory).to eq 'api_docs'
+  end
+
+  it 'has publish_git' do
+    expect(Betterdocs::Global.publish_git).to eq 'git@github.com:foo/bar.git'
+  end
+
+  it 'can ignore in the git repo' do
+    expect(Betterdocs::Global.ignore).to eq %w[ .DS_Store ]
+  end
+
+  context 'assets' do
+    it 'can have assets' do
+      expect(Betterdocs::Global.assets).to be_a Hash
+      expect(Betterdocs::Global.assets).not_to be_empty
+    end
+
+    it 'can set assets' do
+      begin
+        Betterdocs::Global.assets = { foo: 'bar' }
+        expect(Betterdocs::Global.assets).to eq({ 'foo' => 'bar' })
+        Betterdocs::Global.asset :bar, to: 'baz'
+        expect(Betterdocs::Global.assets).to eq({ 'foo' => 'bar', 'bar' => 'baz' })
+        Betterdocs::Global.asset 'quux'
+        expect(Betterdocs::Global.assets).to eq({ 'foo' => 'bar', 'bar' => 'baz', 'quux' => :root })
+      ensure
+        Betterdocs::Global.assets.clear
+      end
+    end
+
+    it 'can iterate over assets' do
+      expect { |b| Betterdocs::Global.each_asset(&b) }.to\
+        yield_successive_args(
+          ["app/views/api_v4/documentation/assets/CHANGELOG.md", "api_docs/CHANGELOG.md"],
+          ["app/assets/images/logos/logo.png", "api_docs/images/logo.png"]
+        )
+    end
+  end
+
+  it 'has a default configuration_file' do
+    expect(Betterdocs::Global.configuration_file).to\
+      be_a ComplexConfig::Settings
+  end
+
+  it 'all_docs' do
+    load 'spec/assets/app/controllers/api/foos_controller.rb'
+    expect(Api::FoosController).to receive(:docs).and_return :foo
+    expect(Betterdocs::Global.all_docs).to eq [ :foo ]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: betterdocs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - betterplace Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: complex_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: This library provides tools to generate API documention for a web site's
   REST-ful JSON API.
 email: developers@betterplace.org
@@ -137,7 +151,9 @@ extra_rdoc_files:
 - lib/betterdocs/global.rb
 - lib/betterdocs/json_params_representer.rb
 - lib/betterdocs/json_params_representer_collector.rb
+- lib/betterdocs/json_time_with_zone.rb
 - lib/betterdocs/mix_into_controller.rb
+- lib/betterdocs/railtie.rb
 - lib/betterdocs/rake_tasks.rb
 - lib/betterdocs/representer.rb
 - lib/betterdocs/result_representer.rb
@@ -182,7 +198,9 @@ files:
 - lib/betterdocs/global.rb
 - lib/betterdocs/json_params_representer.rb
 - lib/betterdocs/json_params_representer_collector.rb
+- lib/betterdocs/json_time_with_zone.rb
 - lib/betterdocs/mix_into_controller.rb
+- lib/betterdocs/railtie.rb
 - lib/betterdocs/rake_tasks.rb
 - lib/betterdocs/representer.rb
 - lib/betterdocs/result_representer.rb
@@ -190,8 +208,11 @@ files:
 - lib/betterdocs/section.rb
 - lib/betterdocs/tasks/doc.rake
 - lib/betterdocs/version.rb
+- spec/assets/app/controllers/api/foos_controller.rb
+- spec/assets/config/betterdocs.yml
 - 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
@@ -225,8 +246,10 @@ signing_key:
 specification_version: 4
 summary: Betterplace API documentation library
 test_files:
+- spec/assets/app/controllers/api/foos_controller.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