madness 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69195aff3d6fef7ddc0a794ee72312d62c34ae6b16a8a4b68a87f58034ed87c3
-  data.tar.gz: a09db9c0a28611c2a5d10d7d5f92f608843eb008e36f86a1695c675edace8e1b
+  metadata.gz: 68505dca2eb6baa5db15f96986700a20e61b8f9df6eb67e53cfe457c8710dd65
+  data.tar.gz: 0e2619328fc2eb24607f13458ea858d9c99aef4d505200b9025326ffada6b9f6
 SHA512:
-  metadata.gz: 50cd43992dc42d0753888454efda36bbb85be1c4dabfb77891ab86e881408989c7f1710522ed24c266098d58e8ed71ac53298e3168f76944727cb5b23f646c66
-  data.tar.gz: 0c6233bb17ba8b5cc1e783ed508189b3fa928bca5ac56ab06935f27ca7ad8a99f9a34316c03d21e3aa20f99bfdc2de600344efc36599e2bdbbfa906c116b19c3
+  metadata.gz: d932ebc6aa366dc2c714f880a43bd2f2116db6e853cb0409b29c629aa36ee28740c0de25b88da9912e27142fa6f8d8e2cb4137331d007c7526f204482e77946c
+  data.tar.gz: 8b136b49572d6f1aeab9436baa9a675974bb345afe5232d32bb3c8a3c25c4c5af1e66139e8e1a0120562df7a564639ba4d3c118bd4244ec4ab7b0b77da6407f5

data/bin/madness

@@ -10,4 +10,4 @@ rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!undred!#{e.class}!txtrst!\n#{e.message}"
   exit 1
-end
+end

data/lib/madness/breadcrumbs.rb

@@ -1,10 +1,9 @@
 module Madness
-
   # Handle breadcumbs generation by converting a path to an array
   # of links
   class Breadcrumbs
     using StringRefinements
-    
+
     attr_reader :path
 
     def initialize(path)
@@ -12,13 +11,13 @@ module Madness
     end
 
     def links
-      path == "" ? [] : get_breadcrumbs
+      path == '' ? [] : breadcrumbs
     end
 
   private
 
-    def get_breadcrumbs
-      home = OpenStruct.new({ label: "Home", href: '/' })
+    def breadcrumbs
+      home = OpenStruct.new({ label: 'Home', href: '/' })
       result = breadcrumbs_maker(path).reverse.unshift home
       result.last.last = true
       result
@@ -26,9 +25,11 @@ module Madness
 
     def breadcrumbs_maker(partial_path)
       parent, basename = File.split partial_path
-      item = OpenStruct.new({
-        label: basename.to_label,
-        href: "/#{partial_path}" }
+      item = OpenStruct.new(
+        {
+          label: basename.to_label,
+          href:  "/#{partial_path}",
+        }
       )
       result = [item]
       result += breadcrumbs_maker parent unless parent == '.'

data/lib/madness/browser.rb

@@ -7,7 +7,8 @@ module Madness
     attr_reader :host, :port
 
     def initialize(host, port)
-      @host, @port = host, port
+      @host = host
+      @port = port
     end
 
     # Returns a URL based on host, port and MADNESS_FORCE_SSL.
@@ -51,7 +52,7 @@ module Madness
 
     # Runs the appropriate command (based on OS) to open a browser.
     def open!
-      system *open_command, err: File::NULL, in: File::NULL, out: File::NULL
+      system(*open_command, err: File::NULL, in: File::NULL, out: File::NULL)
     end
 
     # Returns the appropriate command (based on OS) to open a browser.

data/lib/madness/command_line.rb

@@ -4,16 +4,15 @@ require 'colsole'
 require 'docopt'
 
 module Madness
-
   # Handle command line execution. Used by bin/madness.
   class CommandLine
     include Singleton
     include Colsole
 
     # Process ARGV by putting it through docopt
-    def execute(argv=[])
+    def execute(argv = [])
       doc = File.read File.expand_path('docopt.txt', __dir__)
-      
+
       begin
         args = Docopt.docopt(doc, argv: argv, version: VERSION)
         handle args
@@ -49,7 +48,7 @@ module Madness
     # and static files folder.
     def launch_server
       unless File.directory? config.path
-        STDERR.puts "Invalid path (#{config.path})" 
+        $stderr.puts "Invalid path (#{config.path})"
         return
       end
 
@@ -61,7 +60,7 @@ module Madness
     # Get the arguments as provided by docopt, and set them to our own
     # config object.
     def set_config(args)
-      config.path         = args['PATH']   if args['PATH']
+      config.path         = args['PATH'] if args['PATH']
       config.port         = args['--port'].to_i if args['--port']
       config.bind         = args['--bind'] if args['--bind']
       config.toc          = args['--toc']  if args['--toc']
@@ -76,7 +75,7 @@ module Madness
       config.copy_code    = false   if args['--no-copy-code']
       config.shortlinks   = true    if args['--shortlinks']
       config.open         = true    if args['--open']
-      
+
       config.theme = File.expand_path(args['--theme'], config.path) if args['--theme']
     end
 
@@ -105,7 +104,7 @@ module Madness
       end
     end
 
-    # Say hello to everybody when the server starts, showing the known 
+    # Say hello to everybody when the server starts, showing the known
     # config.
     def show_status
       say_status :start, 'the madness'
@@ -115,7 +114,7 @@ module Madness
       say_status :use, config.filename if config.file_exist?
       say_status :theme, config.theme, :txtblu if config.theme
 
-      say "-" * 60
+      say '-' * 60
     end
 
     # Generate the table of contents file

data/lib/madness/directory.rb

@@ -9,7 +9,7 @@ module Madness
     def initialize(dir)
       @dir = dir
     end
-    
+
     def list
       @list ||= (dirs + files)
     end
@@ -18,9 +18,8 @@ module Madness
 
     def files
       result = Dir["#{dir}/#{config.dir_glob}"]
-      result.reject! do |f| 
-        basename = File.basename(f)
-        basename == 'README.md' or basename == 'index.md'
+      result.reject! do |f|
+        ['README.md', 'index.md'].include? File.basename(f)
       end
       result.nat_sort.map { |path| Item.new path, :file }
     end
@@ -33,9 +32,10 @@ module Madness
 
     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)
+        return true if basename&.match?(Regexp.new(pattern))
       end
       false
     end
@@ -43,6 +43,5 @@ module Madness
     def config
       @config ||= Settings.instance
     end
-
   end
 end

data/lib/madness/document.rb

@@ -2,7 +2,6 @@ require 'commonmarker'
 require 'coderay'
 
 module Madness
-
   # Handle a single markdown document.
   class Document
     include ServerHelper
@@ -24,7 +23,7 @@ module Madness
 
     # Return the HTML for that document, force re-read.
     def content!
-      [:empty, :missing].include?(type) ? "<h1>#{title}</h1>" : markdown_to_html
+      %i[empty missing].include?(type) ? "<h1>#{title}</h1>" : markdown_to_html
     end
 
   private
@@ -99,7 +98,7 @@ module Madness
           anchor = CommonMarker::Node.new(:inline_html)
 
           next unless node.first_child.type == :text
-          
+
           anchor_id = node.first_child.string_content.to_slug
           anchor.string_content = "<a id='#{anchor_id}'></a>"
           node.prepend_child anchor
@@ -110,13 +109,13 @@ module Madness
     # Replace <!-- TOC --> with a Table of Contents for the page
     def replace_toc_marker
       toc_marker = doc.find do |node|
-        node.type == :html and node.string_content.include? "<!-- TOC -->"
+        node.type == :html and node.string_content.include? '<!-- TOC -->'
       end
 
       return unless toc_marker
 
       toc_marker.insert_after document_toc
-      toc_marker.insert_after CommonMarker.render_doc("## Table of Contents").first_child
+      toc_marker.insert_after CommonMarker.render_doc('## Table of Contents').first_child
     end
 
     # Replace [[link]] with [link](link)
@@ -129,10 +128,12 @@ module Madness
       toc = []
       doc.walk do |node|
         next unless node.type == :header
+
         level = node.header_level
         next unless level.between? 2, 3
+
         text = node.first_child.string_content
-        spacer = "  " * (level - 1)
+        spacer = '  ' * (level - 1)
         toc << "#{spacer}- [#{text}](##{text.to_slug})"
       end
 
@@ -143,7 +144,8 @@ module Madness
     # If the document does not start with an H1 tag, add it.
     def prepend_h1
       return unless doc.first_child
-      return if doc.first_child.type == :header and doc.first_child.header_level == 1
+      return if (doc.first_child.type == :header) && (doc.first_child.header_level == 1)
+
       h1 = CommonMarker.render_doc("# #{title}").first_child
       doc.first_child.insert_before h1
     end
@@ -159,8 +161,9 @@ module Madness
     def syntax_highlight(html)
       line_numbers = config.line_numbers ? :table : nil
       opts = { css: :style, wrap: nil, line_numbers: line_numbers }
-      html.gsub(/\<code class="language-(.+?)"\>(.+?)\<\/code\>/m) do
-        lang, code = $1, $2
+      html.gsub(%r{<code class="language-(.+?)">(.+?)</code>}m) do
+        lang = $1
+        code = $2
         code = CGI.unescapeHTML code
         CodeRay.scan(code, lang).html opts
       end
@@ -175,4 +178,3 @@ module Madness
     end
   end
 end
-

data/lib/madness/item.rb

@@ -6,7 +6,8 @@ module Madness
     attr_reader :path, :type
 
     def initialize(path, type)
-      @path, @type = path, type
+      @path = path
+      @type = type
     end
 
     def label
@@ -36,4 +37,3 @@ module Madness
     end
   end
 end
-

data/lib/madness/navigation.rb

@@ -15,7 +15,7 @@ module Madness
     end
 
     def caption
-      @caption ||= (dir == docroot ? "Index" : File.basename(dir).to_label)
+      @caption ||= (dir == docroot ? 'Index' : File.basename(dir).to_label)
     end
 
     def with_search?
@@ -28,4 +28,4 @@ module Madness
       @directory ||= Directory.new(dir)
     end
   end
-end
+end

data/lib/madness/refinements/hash_refinements.rb

@@ -11,4 +11,4 @@ module Madness
       end
     end
   end
-end
+end

data/lib/madness/refinements/string_refinements.rb

@@ -12,14 +12,14 @@ module Madness
       end
 
       def to_slug
-        downcase.strip.gsub(' ', '-').remove(/[^\w-]/)
+        downcase.strip.tr(' ', '-').remove(/[^\w-]/)
       end
 
       # This is here so we can have one place that defines how to convert
       # a string (usually a filename without .md extension, or a folder name)
       # to a label.
       # It is used by different navigation elements in madness, and ucrrently
-      # just removes any numbers followed by a dot at the beginning of the 
+      # 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
         remove(/^\d+\.\s+/).remove(/\.md$/)

data/lib/madness/search.rb

@@ -5,7 +5,7 @@ module Madness
     include ServerHelper
     using StringRefinements
 
-    def initialize(path=nil)
+    def initialize(path = nil)
       @path = path || docroot
     end
 
@@ -27,7 +27,8 @@ module Madness
         found = 0
         words.each { |word| found += 1 if content.include? word }
         next unless found == word_count
-        result[label] = url 
+
+        result[label] = url
       end
 
       result
@@ -40,6 +41,7 @@ module Madness
 
       Dir["#{@path}/**/#{config.dir_glob}"].sort.each do |file|
         next if skip_index? file
+
         filename = file_url(file.sub("#{@path}/", '')).downcase
         index_content = File.extname(file) == '.md'
         content = index_content ? File.read(file).downcase : ''
@@ -49,7 +51,7 @@ module Madness
     end
 
     # We are going to avoid indexing of README.md when there is also an
-    # index.md in the same directory, to keep behavior consistent with the 
+    # index.md in the same directory, to keep behavior consistent with the
     # display logic
     def skip_index?(file)
       if file.end_with? 'README.md'
@@ -62,9 +64,9 @@ module Madness
 
     def file_label(filename)
       filename
-        .remove(/\/(index|README)$/)
+        .remove(%r{/(index|README)$})
         .split('/')
-        .map { |i| i.to_label }
+        .map(&:to_label)
         .join(' / ')
     end
 
@@ -73,7 +75,7 @@ module Madness
     end
 
     def file_url(filename)
-      filename.remove(/\/(index|README)$/)
+      filename.remove(%r{/(index|README)$})
     end
   end
 end

data/lib/madness/server.rb

@@ -1,7 +1,6 @@
 require 'madness/server_base'
 
 module Madness
-
   # The Sinatra server
   class Server < ServerBase
     using StringRefinements
@@ -11,8 +10,8 @@ module Madness
       results = query ? Search.new.search(query) : false
       nav = Navigation.new docroot
       slim :search, locals: {
-        nav: nav,
-        results: results
+        nav:     nav,
+        results: results,
       }
     end
 
@@ -23,27 +22,27 @@ module Madness
       dir     = doc.dir
       content = doc.content
 
-      if doc.type == :readme and !path.empty? and path[-1] != '/'
+      if (doc.type == :readme) && !path.empty? && (path[-1] != '/')
         redirect "#{path.to_href}/"
       end
 
       nav = Navigation.new dir
       breadcrumbs = Breadcrumbs.new(path).links
 
-      if nav.links.count == 1 and doc.type == :empty
+      if (nav.links.count == 1) && (doc.type == :empty)
         redirect to(nav.links.first.href)
       end
 
       status 404 if doc.type == :missing
 
-      slim :document, locals: { 
-        content: content, 
-        type: doc.type,
-        title: doc.title,
-        file: doc.file,
-        nav: nav, 
-        breadcrumbs: breadcrumbs
+      slim :document, locals: {
+        content:     content,
+        type:        doc.type,
+        title:       doc.title,
+        file:        doc.file,
+        nav:         nav,
+        breadcrumbs: breadcrumbs,
       }
     end
   end
-end
+end

data/lib/madness/server_base.rb

@@ -3,7 +3,6 @@ require 'sinatra/base'
 require 'slim'
 
 module Madness
-
   # The base class for the sinatra server.
   # Initialize what we can here, but since there are values that will
   # become known only later, the #prepare method is provided.
@@ -31,7 +30,7 @@ module Madness
 
     def self.set_tempalate_locations
       theme = Theme.new config.theme
-      
+
       set :views, theme.views_path
       set :public_folder, theme.public_path
     end
@@ -46,5 +45,4 @@ module Madness
       Settings.instance
     end
   end
-
 end

data/lib/madness/server_helper.rb

@@ -1,9 +1,8 @@
 module Madness
-
   # All the methods that we may need inside of any server route.
   # The module can also be included manually anywhere else.
   module ServerHelper
-    def config 
+    def config
       @config ||= Settings.instance
     end
 
@@ -12,11 +11,11 @@ module Madness
     end
 
     def log(obj)
-      #:nocov:
-      open('madness.log', 'a') { |f|
+      # :nocov:
+      open('madness.log', 'a') do |f|
         f.puts obj.inspect
-      }
-      #:nocov:
+      end
+      # :nocov:
     end
   end
-end
+end

data/lib/madness/settings.rb

@@ -2,7 +2,6 @@ require 'singleton'
 require 'extended_yaml'
 
 module Madness
-  
   # Handle the configuration options
   # Each configuration option has three sources
   # 1. The default value
@@ -18,7 +17,7 @@ module Madness
 
     def method_missing(name, *args, &_blk)
       name_string = name.to_s
-      
+
       if name_string.end_with? '='
         data[name_string.chop.to_sym] = args.first
       else
@@ -26,7 +25,11 @@ module Madness
       end
     end
 
-    # Force reload of the config file, set defaults, and then read from 
+    def respond_to_missing?(*_args)
+      true
+    end
+
+    # Force reload of the config file, set defaults, and then read from
     # file.
     def reset
       @data = nil
@@ -41,30 +44,30 @@ module Madness
     end
 
     def dir_glob
-      data[:expose_extensions] ? "*.{md,#{data[:expose_extensions].delete(' ')}}" : "*.md"
+      data[:expose_extensions] ? "*.{md,#{data[:expose_extensions].delete(' ')}}" : '*.md'
     end
 
   private
 
     def defaults
       {
-        path: '.',
-        port: 3000,
-        bind: '0.0.0.0',
-        sidebar: true,
-        auto_h1: true,
-        auto_nav: true,
-        highlighter: true,
-        line_numbers: true,
-        copy_code: true,
-        shortlinks: false,
-        toc: nil,
-        theme: nil,
-        open: false,
-        auth: false,
-        auth_realm: 'Madness',
+        path:              '.',
+        port:              3000,
+        bind:              '0.0.0.0',
+        sidebar:           true,
+        auto_h1:           true,
+        auto_nav:          true,
+        highlighter:       true,
+        line_numbers:      true,
+        copy_code:         true,
+        shortlinks:        false,
+        toc:               nil,
+        theme:             nil,
+        open:              false,
+        auth:              false,
+        auth_realm:        'Madness',
         expose_extensions: nil,
-        exclude: [/^[a-z_\-0-9]+$/],
+        exclude:           [/^[a-z_\-0-9]+$/],
       }
     end
 
@@ -81,6 +84,5 @@ module Madness
 
       result || {}
     end
-
   end
 end

data/lib/madness/static.rb

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

data/lib/madness/table_of_contents.rb

@@ -10,7 +10,7 @@ module Madness
     end
 
     def build(file)
-      file += ".md" unless file.end_with? '.md'
+      file += '.md' unless file.end_with? '.md'
       File.write "#{dir}/#{file}", toc
     end
 
@@ -25,10 +25,11 @@ module Madness
 
       result = []
       list.each do |item|
-        if item.type == :dir
+        case item.type
+        when :dir
           result.push "#{' ' * indent}1. #{make_link item}"
-          result += toc! item.path, indent+4
-        elsif item.type == :file
+          result += toc! item.path, indent + 4
+        when :file
           result.push "#{' ' * indent}1. #{make_link item}"
         end
       end
@@ -39,4 +40,4 @@ module Madness
       "[#{item.label}](#{item.href})"
     end
   end
-end
+end

data/lib/madness/theme.rb

@@ -2,7 +2,7 @@ module Madness
   class Theme
     attr_reader :path
 
-    def initialize(path=nil)
+    def initialize(path = nil)
       @path = path
     end
 
@@ -19,4 +19,3 @@ module Madness
     end
   end
 end
-

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.9.7"
+  VERSION = '0.9.8'
 end

data/lib/madness.rb

@@ -6,4 +6,3 @@ end
 require 'requires'
 
 requires 'madness/refinements', 'madness/server_helper', 'madness'
-

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: coderay
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: extended_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: naturally
   requirement: !ruby/object:Gem::Requirement
@@ -104,14 +132,14 @@ dependencies:
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
 - !ruby/object:Gem::Dependency
@@ -134,20 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
@@ -162,34 +184,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: extended_yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: addressable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
 description: Start a markdown server in any directory
 email: db@dannyben.com
 executables:
@@ -264,6 +258,7 @@ metadata:
   changelog_uri: https://github.com/DannyBen/madness/blob/master/CHANGELOG.md
   homepage_uri: https://madness.dannyb.co/
   source_code_uri: https://github.com/DannyBen/madness
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -279,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Instant Markdown Server