madness 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1cc2a8db22704b1f4ae073aecf9ddab5fcac0017a460c9cf4067b401c5ebb8
-  data.tar.gz: 108a05cbd93d9f00d66631c2a588ebc5fafb2f78fafbf1cc70fd24564204746e
+  metadata.gz: fc75908a99d4e9dc14baa5d46be80ec7e67aef852d37b506ddd3f608cc82a806
+  data.tar.gz: 5020b3f14501f90770dc45593bd102163c9cc125da90cc60598cf39dc2ec6c00
 SHA512:
-  metadata.gz: 805ff26ca56c882bbd33e702de81ed7044cad502ba8d6f585311b0450902b7c20de4380a5bc04bf8d6c6efa6f0f9f1ae0c4a44af7460e122c48bd6b7d610f97e
-  data.tar.gz: 25dc3ce86523b299ff3d9e9506bccc102dbda15544020ca2e3e7fcbfb1e4f87c3e1499d382566f6f43c2e40dfe144c2f84915f07113178547db686814a68a0ff
+  metadata.gz: 13112e89bef2880f89389b8af54ea59d9e2f22fc495a4136d9b5c832c4bed1457c7b025553c0a0cda9bb30b64bd1205843ec0b6f8ed3d9dae5fadb4509ef801c
+  data.tar.gz: 85a454ac3dd48ba797cd71eb5734334e87ac6a952af4ffafdc67b05c6fe4b6d140d7d0de4bfb4bccc032c0ea45a90b748e21d276f613ca742372d8251eda0dac

data/README.md

@@ -81,6 +81,9 @@ For more options, run:
     $ madness --help
 
 
+If you do not have Ruby installed, you can also 
+[run madness with docker](#docker-image).
+
 
 Directory Conventions
 --------------------------------------------------
@@ -239,10 +242,10 @@ Madness comes with a command that copies the default theme to a folder of
 your choice, where you can customize it to your taste. Run:
 
 ```shell
-$ madness create config my_theme
+$ madness create theme my_theme
 ```
 
-Where `_theme` is the folder that will be created.
+Where `my_theme` is the folder that will be created.
 
 To use the created theme, simply run Madness with the `--theme my_theme`
 option.
@@ -277,10 +280,10 @@ directory as the markdown documentation folder
 $ docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness
 ```
 
-For more information see:
+For more information about the docker image, see:
 
 - [Madness image on Docker Hub][dockerhub]
-- [Madness Dockerfile][dockerfile]
+- [Madness Dockerfile and Docker Compose][dockerfile]
 
 
 

data/lib/madness.rb

@@ -1,38 +1,6 @@
-require 'fileutils'
-require 'singleton'
-require 'yaml'
-
-require 'coderay'
-require 'colsole'
-require 'commonmarker'
-require 'docopt'
-require 'ferret'
-require 'rack/contrib/try_static'
-require 'sass'
-require 'sass/plugin/rack'
-require 'sinatra/base'
-require 'sinatra/reloader'
-require 'slim'
-require 'naturally'
-
 require 'byebug' if ENV['BYEBUG']
 
-require 'madness/refinements/string_refinements'
-require 'madness/refinements/array_refinements'
-
-require 'madness/server_helper'
+require 'requires'
 
-require 'madness/breadcrumbs'
-require 'madness/command_line'
-require 'madness/directory'
-require 'madness/document'
-require 'madness/item'
-require 'madness/navigation'
-require 'madness/search'
-require 'madness/server'
-require 'madness/server_base'
-require 'madness/settings'
-require 'madness/table_of_contents'
-require 'madness/theme'
-require 'madness/version'
+requires 'madness/refinements', 'madness/server_helper', 'madness'
 

data/lib/madness/command_line.rb

@@ -1,4 +1,7 @@
 require 'fileutils'
+require 'singleton'
+require 'colsole'
+require 'docopt'
 
 module Madness
 

data/lib/madness/document.rb

@@ -1,3 +1,6 @@
+require 'commonmarker'
+require 'coderay'
+
 module Madness
 
   # Handle a single markdown document.
@@ -63,9 +66,9 @@ module Madness
       if File.directory? base
         @title = File.basename(path).to_label unless path.empty?
         set_base_attributes_for_directory
-      elsif File.exist? "#{base}.md"
+      elsif md_file?
+        @file = md_filename
         @title = File.basename(base).to_label
-        @file = "#{base}.md"
         @dir  = File.dirname file
         @type = :file
       end
@@ -135,6 +138,14 @@ module Madness
         CodeRay.scan(code, lang).html opts
       end
     end
+
+    def md_file?
+      File.exist?("#{base}.md") || (File.exist?(base) && File.extname(base) == '.md')
+    end
+
+    def md_filename
+      File.extname(base) == '.md' ? base : "#{base}.md"
+    end
   end
 end
 

data/lib/madness/refinements/array_refinements.rb

@@ -1,3 +1,5 @@
+require 'naturally'
+
 module Madness
   module ArrayRefinements
     refine Array do

data/lib/madness/refinements/string_refinements.rb

@@ -12,7 +12,7 @@ module Madness
       # just removes any numbers followed by a dot at the beginning of the 
       # string, in order to allow "The Invisible Sorting Hand".
       def to_label
-        gsub(/^\d+\.\s+/, '')
+        gsub(/^\d+\.\s+/, '').gsub(/\.md$/, '')
       end
     end
   end

data/lib/madness/search.rb

@@ -1,5 +1,6 @@
-module Madness
+require 'ferret'
 
+module Madness
   class Search
     include ServerHelper
     include Ferret

data/lib/madness/server_base.rb

@@ -1,3 +1,10 @@
+require 'rack/contrib/try_static'
+require 'sass'
+require 'sass/plugin/rack'
+require 'sinatra/base'
+require 'sinatra/reloader'
+require 'slim'
+
 module Madness
 
   # The base class for the sinatra server.
@@ -22,7 +29,7 @@ module Madness
     # The CommandLine class and the test suite should both call
     # `Server.prepare` before calling Server.run!
     def self.prepare
-      use Rack::TryStatic, root: "#{config.path}/", :urls => %w[/]
+      use Madness::Static, root: "#{config.path}/", :urls => %w[/]
       set :bind, config.bind
       set :port, config.port
 

data/lib/madness/settings.rb

@@ -1,6 +1,8 @@
+require 'singleton'
+
 module Madness
   
-  # Handle teh configuration options
+  # Handle the configuration options
   # Each configuration option has three sources
   # 1. The default value
   # 2. The setting as provided in the ./.madness.yml

data/lib/madness/static.rb

@@ -0,0 +1,19 @@
+module Madness
+
+  # The Madness::Static middleware delegates requests to 
+  # Rack::TryStatic middleware unless the request URI ends with .md
+  class Static
+    def initialize(app, options)
+      @app = app
+      @static = ::Rack::TryStatic.new(app, options)
+    end
+
+    def call(env)
+      if env['PATH_INFO'].end_with? ".md"
+        @app.call env
+      else
+        @static.call env
+      end
+    end
+  end
+end

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,197 +1,211 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-02 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: coderay
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: sinatra-contrib
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
-  name: rack-contrib
+  name: docopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: slim
+  name: ferret
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: commonmarker
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: naturally
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: docopt
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: colsole
+  name: rack-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: ferret
+  name: requires
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: naturally
+  name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -401,6 +415,7 @@ files:
 - lib/madness/server_base.rb
 - lib/madness/server_helper.rb
 - lib/madness/settings.rb
+- lib/madness/static.rb
 - lib/madness/table_of_contents.rb
 - lib/madness/templates/madness.yml
 - lib/madness/theme.rb