madness 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b47f7237b641f302211469708ee02f3742eb21064be7064363760a2c2aaafaa
-  data.tar.gz: a632677ece77828952ab2297de025b72d05f22474d05bb897505318b195633d3
+  metadata.gz: cced29facd3dba093bbc3b25729fce834ade95ebaeb4086fdb8ad0ee179165d5
+  data.tar.gz: 615502287bd4ec1da6b75beddf1d57e2fcd76d71a23b728dc6921d577de7b71d
 SHA512:
-  metadata.gz: 25c49d9d314ade07110b7d66d0f2ee3484b2815753477b1f068a14ae95aca13f22bdaffecaea85a8231c0cf9e192b4490e021f8015d6ccd1ccb9046c00518da7
-  data.tar.gz: cb5f19654df81aa4ea1f15f05289ff4d2aff8a66f3ede34061eba108c02989b62229c52b7cfee17166f7e63bfd679168815d0c497c2263c2bcf66072bbc0ebf7
+  metadata.gz: b2d0b4dbf8bae41e71ec0ff9181dac4a0d4254a0219561d50161cb21b93f6abcf0acb6098d430f60c4d2874b05648c91865cf822d251b3bdbeb9894714f48c16
+  data.tar.gz: 78462e7922c4ea8164cab394fe9bb1e0fbb14700947c716f40ab7a7c797094cbb9c7317599c33bf1fb786a45f2a4e8c7a88614d4396a1a9aea067ee5f42eea1d

data/README.md

@@ -125,6 +125,10 @@ port: 3000
 # server listen address
 bind: 0.0.0.0
 
+# set a server root path
+# base_uri: /docs
+base_uri: ~
+
 # enable sidebar
 sidebar: true
 

data/app/views/_mobile_search.slim

@@ -1,2 +1,2 @@
-a#mobile-search href="/_search"
+a#mobile-search href="#{config.base_uri}/_search"
   i.icon-search 

data/app/views/_nav.slim

@@ -1,10 +1,10 @@
 nav
   .icon-bar
-    a.icon href="/" accesskey='h' class=('wide' unless nav.with_search?)
+    a.icon href="#{config.base_uri}/" accesskey='h' class=('wide' unless nav.with_search?)
       i.icon-home
 
     - if nav.with_search?
-      a.icon href="/_search" accesskey='s' style='text-align:right'
+      a.icon href="#{config.base_uri}/_search" accesskey='s' style='text-align:right'
         i.icon-search 
 
   - if nav.caption

data/app/views/layout.slim

@@ -8,14 +8,14 @@ html
     title = locals[:title]
     meta name="HandheldFriendly" content="true"
     meta name="viewport" content="width=device-width, initial-scale=1"
-    link href='/css/main.css' rel='stylesheet' type='text/css'
+    link href='#{config.base_uri}/css/main.css' rel='stylesheet' type='text/css'
     - custom_css.each do |file|
-      link href="/#{file}" rel='stylesheet' type='text/css'
+      link href="#{config.base_uri}/#{file}" rel='stylesheet' type='text/css'
 
     - if config.copy_code
-      script src="/js/vendor/jquery.min.js"
-      script src="/js/vendor/clipboard.min.js"
-      script src="/js/clipboard.js"
+      script src="#{config.base_uri}/js/vendor/jquery.min.js"
+      script src="#{config.base_uri}/js/vendor/clipboard.min.js"
+      script src="#{config.base_uri}/js/clipboard.js"
 
   body
     == yield

data/app/views/search.slim

@@ -1,7 +1,7 @@
 == slim :_nav, locals: { nav: nav } if config.sidebar
 
 .main class=(config.sidebar ? 'with-sidebar' : 'without-sidebar')
-  form.search-form action="/_search" method="get"
+  form.search-form action="#{config.base_uri}/_search" method="get"
     input.search-field type="text" name="q" value="#{params[:q]}" placeholder="Search (use quotes for exact match)" autofocus=true
     input type="submit" value="Search" style='display:none'
 

data/lib/madness/breadcrumbs.rb

@@ -17,7 +17,7 @@ module Madness
   private
 
     def breadcrumbs
-      home = OpenStruct.new({ label: 'Home', href: '/' })
+      home = OpenStruct.new({ label: 'Home', href: "#{config.base_uri}/" })
       result = breadcrumbs_maker(path).reverse.unshift home
       result.last.last = true
       result
@@ -28,12 +28,16 @@ module Madness
       item = OpenStruct.new(
         {
           label: basename.to_label,
-          href:  "/#{partial_path}",
+          href:  "#{config.base_uri}/#{partial_path}",
         }
       )
       result = [item]
       result += breadcrumbs_maker parent unless parent == '.'
       result
     end
+
+    def config
+      Settings.instance
+    end
   end
 end

data/lib/madness/item.rb

@@ -15,7 +15,10 @@ module Madness
     end
 
     def href
-      path_without_extension.sub(/^#{docroot}/, '').to_href
+      @href ||= begin
+        result = path_without_extension.sub(/^#{docroot}/, '').to_href
+        "#{config.base_uri}#{result}"
+      end
     end
 
     def dir?

data/lib/madness/server.rb

@@ -5,7 +5,17 @@ module Madness
   class Server < ServerBase
     using StringRefinements
 
-    get '/_search' do
+    if config.base_uri
+      not_found do
+        redirect "#{config.base_uri}/"
+      end
+
+      get config.base_uri do
+        redirect "#{config.base_uri}/"
+      end
+    end
+
+    get "#{config.base_uri}/_search" do
       query = params[:q]
       results = query ? Search.new.search(query) : false
       nav = Navigation.new docroot
@@ -15,15 +25,18 @@ module Madness
       }
     end
 
-    get '/*' do
+    get "#{config.base_uri}/*" do
       path = params[:splat].first
+      static_file = find_static_file path
+
+      next send_file static_file if static_file
 
       doc     = Document.new path
       dir     = doc.dir
       content = doc.content
 
       if (doc.type == :readme) && !path.empty? && (path[-1] != '/')
-        redirect "#{path.to_href}/"
+        redirect "#{request.path_info}/"
       end
 
       nav = Navigation.new dir

data/lib/madness/server_base.rb

@@ -13,36 +13,29 @@ module Madness
     set :root, File.expand_path('../../', __dir__)
     set :environment, ENV['MADNESS_ENV'] || :production
     set :server, :puma
+    set :static, false
 
     # Since we cannot use any config values in the main body of the class,
     # since they will be updated later, we need to set anything that relys
     # on the config values just before running the server.
     # The CommandLine class and the test suite should both call
     # `Server.prepare` before calling Server.run!
-    def self.prepare
-      use Madness::Static, root: "#{config.path}/", urls: %w[/], cascade: true
-      set :bind, config.bind
-      set :port, config.port
+    class << self
+      include ServerHelper
 
-      set_basic_auth if config.auth
-      set_tempalate_locations
-    end
-
-    def self.set_tempalate_locations
-      theme = Theme.new config.theme
-
-      set :views, theme.views_path
-      set :public_folder, theme.public_path
-    end
+      def prepare
+        set :bind, config.bind
+        set :port, config.port
+        set :views, theme.views_path
 
-    def self.set_basic_auth
-      use Rack::Auth::Basic, config.auth_zone do |username, password|
-        config.auth.split(':') == [username, password]
+        set_basic_auth if config.auth
       end
-    end
 
-    def self.config
-      Settings.instance
+      def set_basic_auth
+        use Rack::Auth::Basic, config.auth_zone do |username, password|
+          config.auth.split(':') == [username, password]
+        end
+      end
     end
   end
 end

data/lib/madness/server_helper.rb

@@ -10,6 +10,10 @@ module Madness
       @docroot ||= File.expand_path(config.path, Dir.pwd)
     end
 
+    def theme
+      @theme ||= Theme.new config.theme
+    end
+
     def log(obj)
       # :nocov:
       open('madness.log', 'a') do |f|
@@ -17,5 +21,26 @@ module Madness
       end
       # :nocov:
     end
+
+    # Search for static file, first in the users docroot, then in the template
+    # directory.
+    def find_static_file(path)
+      return nil if disallowed_static?(path)
+
+      candidates = [
+        "#{config.path}/#{path}",
+        "#{theme.public_path}/#{path}",
+      ]
+
+      candidates.each do |candidate|
+        return candidate if File.file? candidate
+      end
+
+      nil
+    end
+
+    def disallowed_static?(path)
+      path.end_with?('.md') || path.empty? || File.basename(path).start_with?('.')
+    end
   end
 end

data/lib/madness/settings.rb

@@ -56,6 +56,7 @@ module Madness
         path:              '.',
         port:              3000,
         bind:              '0.0.0.0',
+        base_uri:          nil,
         sidebar:           true,
         auto_h1:           true,
         auto_nav:          true,

data/lib/madness/templates/madness.yml

@@ -11,6 +11,10 @@ port: 3000
 # server listen address
 bind: 0.0.0.0
 
+# set a server root path
+# base_uri: /docs
+base_uri: ~
+
 # enable sidebar
 sidebar: true
 

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/madness.rb

@@ -6,5 +6,6 @@ end
 require 'requires'
 
 requires 'madness/refinements'
+requires 'madness/settings'
 requires 'madness/server_helper'
 requires 'madness'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -266,7 +266,6 @@ 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

data/lib/madness/static.rb

@@ -1,18 +0,0 @@
-module Madness
-  # The Madness::Static middleware delegates requests to
-  # Rack::Static middleware unless the request URI ends with .md
-  class Static
-    def initialize(app, options)
-      @app = app
-      @static = Rack::Static.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