madness 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d1899b2ed090d1ff053077a195f6e5a8c80a24ba66ebbe6e9ed1f50ad167a5c
-  data.tar.gz: d13d70143ba4f3ac510e83d738df2d5a1cb15f03db33f2ac2e9c255fabb8ff19
+  metadata.gz: 9954342312c1b0fcceffa8753071f6da48f619b7c25b5a007d5c62f50188e88d
+  data.tar.gz: 8687f6f8a42ee63e3c25c14193c82e5ec7de611dd066f326814218c7ae16b498
 SHA512:
-  metadata.gz: 61e495e8e475069111ba693451bbde77876e5ddf784a035250aaca3321defe30409a011bcb3264519812d992b7bd050625cf3d719eb286b90eecc73e6a40050a
-  data.tar.gz: 796aa6f34076dffdb370233f21f7df5973142839f8fc4cdfbc1666c426d518498a83daf604e999c61fcd72045876dd966f5c50cca4249b4a3b06153bc4b679da
+  metadata.gz: 3cdad49579a55393e76fd8e4ffc7ddd8eb68621a4a0d07e5876d4b5ce396e274dd5b7f3d02b631ac1287b474c81250de92882a291fa404d617cd37a4ec880c1c
+  data.tar.gz: 56e641741fcba7b549337cfd9659548b930ab25291a3fa363f8f084429fb0ba3a8127f288f76412276807debb3cdc7562ca5c6c172a5a2151b27265b72b66323

data/README.md

@@ -30,7 +30,7 @@
 * [Hidden Directories](#hidden-directories)
 * [Controlling Sort Order](#controlling-sort-order)
 * [Displaying Additional File Types](#displaying-additional-file-types)
-* [Basic Authntication](#basic-authentication)
+* [Basic Authentication](#basic-authentication)
 * [Customizing Theme](#customizing-theme)
 * [Forcing HTTPS Connection](#forcing-https-connection)
 * [Docker Image](#docker-image)
@@ -117,22 +117,62 @@ documentation directory, and modify any of the settings below.
 
 ```yaml
 # .madness.yml
-path: '.'
-port: '3000'
-bind: '0.0.0.0'
+
+# path to the documentation root
+path: .
+
+# server port
+port: 3000
+
+# server listen address
+bind: 0.0.0.0
+
+# enable sidebar
 sidebar: true
+
+# add H1 title to files that do not have one
 auto_h1: true
+
+# append navigation to directory READMEs
 auto_nav: true
+
+# enable syntax highlighter for code snippets
 highlighter: true
+
+# enable line numbers for code snippets
 line_numbers: true
+
+# enable the copy to clipboard icon for code snippets
 copy_code: true
-toc: Table of Contents
-theme: _theme
+
+# generate a table of contents file with this name, for example:
+# toc: Table of Contents
+toc: ~
+
+# path to theme folder, for example:
+# theme: _theme
+theme: ~
+
+# open the server URL in the browser
 open: false
+
+# provide user:password for basic authentication, for example:
+# auth: admin:s3cr3t
+auth: false
+
+# if auth is enabled, specify auth realm name
+auth_zone: Madness
+
+# show files with these extensions in the navigation and search, for example:
+# expose_extensions: pdf,docx,xlsx,txt
 expose_extensions: ~
+
+# exclude directories that match these regular expressions
+# note that this is an array
+exclude: ['^[a-z_\-0-9]+$']
 ```
 
-For convenience, you can get a template config file by running:
+For convenience, you can generate a template config file by running:
 
 ```shell
 $ madness create config
@@ -191,10 +231,23 @@ numbers (`/^[a-z_\-0-9]+$/`) will not be displayed in the navigation. In
 other words, directories must have at least one uppercase letter or a space
 to be recognized as a documentation directory.
 
+This can be configured by using the `exclude` configuration option:
+
+```yaml
+# do not ignore any directory
+exclude: ~
+
+# ignore only specific directories
+exclude: [assets, public]
+
+# ignore using regular expressions
+exclude: ['^public$', 'assets']
+```
+
 ## Controlling Sort Order
 
 To control the sort order of the automatically generated navigation elements,
-simply perfix your files and directories with digits followed by a dot and a 
+simply prefix your files and directories with digits followed by a dot and a 
 space, just like you would create an ordered list in Markdown. The numbers
 will be omitted when they are displayed.
 

data/lib/madness/directory.rb

@@ -27,13 +27,19 @@ module Madness
 
     def dirs
       result = Dir["#{dir}/*"].select { |f| File.directory? f }
-      result.reject! do |f| 
-        basename = File.basename(f)
-        basename =~ /^[a-z_\-0-9]+$/
-      end
+      result.reject! { |f| exclude? f }
       result.nat_sort.map { |path| Item.new path, :dir }
     end
 
+    def exclude?(path)
+      return false unless config.exclude.is_a? Array
+      basename = File.basename path
+      config.exclude.each do |pattern|
+        return true if basename =~ Regexp.new(pattern)
+      end
+      false
+    end
+
     def config
       @config ||= Settings.instance
     end

data/lib/madness/settings.rb

@@ -48,20 +48,22 @@ module Madness
 
     def defaults
       {
+        path: '.',
         port: 3000,
         bind: '0.0.0.0',
-        path: '.',
+        sidebar: true,
         auto_h1: true,
+        auto_nav: true,
         highlighter: true,
         line_numbers: true,
         copy_code: true,
+        toc: nil,
         theme: nil,
         open: false,
-        auto_nav: true,
-        sidebar: true,
         auth: false,
         auth_realm: 'Madness',
-        expose_extensions: nil
+        expose_extensions: nil,
+        exclude: [/^[a-z_\-0-9]+$/]
       }
     end
 
@@ -70,7 +72,13 @@ module Madness
     end
 
     def file_data
-      file_exist? ? ExtendedYAML.load(filename).symbolize_keys : {}
+      result = if file_exist?
+        ExtendedYAML.load(filename)&.symbolize_keys
+      else
+        {}
+      end
+      
+      result || {}
     end
 
   end

data/lib/madness/templates/madness.yml

@@ -1,18 +1,56 @@
 # Madness configuration file
-# Uncomment any of the options below
-
-# path: .
-# port: 3000
-# bind: 0.0.0.0
-# sidebar: true
-# auto_h1: true
-# auto_nav: true
-# highlighter: true
-# line_numbers: true
-# copy_code: true
+# These are the default configuration values
+# You can delete any option you do not need
+
+# path to the documentation root
+path: .
+
+# server port
+port: 3000
+
+# server listen address
+bind: 0.0.0.0
+
+# enable sidebar
+sidebar: true
+
+# add H1 title to files that do not have one
+auto_h1: true
+
+# append navigation to directory READMEs
+auto_nav: true
+
+# enable syntax highlighter for code snippets
+highlighter: true
+
+# enable line numbers for code snippets
+line_numbers: true
+
+# enable the copy to clipboard icon for code snippets
+copy_code: true
+
+# generate a table of contents file with this name, for example:
 # toc: Table of Contents
+toc: ~
+
+# path to theme folder, for example:
 # theme: _theme
-# open: false
-# auth: false
-# auth_zone: 'Madness'
-# expose_extensions: ~
+theme: ~
+
+# open the server URL in the browser
+open: false
+
+# provide user:password for basic authentication, for example:
+# auth: admin:s3cr3t
+auth: false
+
+# if auth is enabled, specify auth realm name
+auth_zone: Madness
+
+# show files with these extensions in the navigation and search, for example:
+# expose_extensions: pdf,docx,xlsx,txt
+expose_extensions: ~
+
+# exclude directories that match these regular expressions
+# note that this is an array
+exclude: ['^[a-z_\-0-9]+$']

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -282,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Instant Markdown Server