madman 0.2.13 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e903e1b104d4ba3116f70598163bee37ee0b505b0379fc05ce7576bfa0cff08a
-  data.tar.gz: 0b78baff59ac6402d4f927ff1035e7477058c49fb52f25c80de9c189d3b895e7
+  metadata.gz: '039309eaa86e5f877b526211a472e1633d159880d76f6671e10defe0174b0282'
+  data.tar.gz: feb72279e624edb0bd5eb8a843068146d91104dbd9b3d9875521573574a2332b
 SHA512:
-  metadata.gz: c6f8e62beb90d8c27c7d133a40bcee0aa77efe73ffac5355f114633ca6998cd6f2e00ff2c53e755f0d0039228fdb706bcfe5b36c34c1434fbdddde89e45bfa18
-  data.tar.gz: 8f065cfda51843ff01c036e8958d5953a6b6c69b9773dc0d18cb0c3abf29690a658c1755a10e8ee994365faf25a8541b19dd593fbfe86729a5699f25f79bee1e
+  metadata.gz: 97c8e85dfa09c26cb4688cb0a90fbb14a572c7bd5487b7d1eaf4c2e87adc7a5f35590fe9f5b6a0261190f2d4b591a56da20c31aad018560345f540471707bcf6
+  data.tar.gz: ed9d05c52593d1e9c1286d2997cc531a9b935d32a0efc299e7835f04fedd182293f22d7407152d13a5a288df3564d1873ab4848710d552fc0d2a30d4c219b034

data/README.md

@@ -36,8 +36,7 @@ Features
 - [ ] Ad-hoc server to allow editing of a local markdown file.
 - [x] Markdown generation with GitHub API (optional).
 - [x] Table of Contents generation for a folder of markdown files.
-- [x] Web server for an entire folder (like [Madness][1]) with GitHub Pages 
-      compatibility.
+- [x] Web server for an entire folder (like [Madness][1]) with GitHub Pages compatibility.
 - [x] Automatic detection of Right-to-Left markdown files for HTML rendering.
 - [x] Generate navigation README in folders without one.
 - [x] Convert YAML file to an interactive HTML with collapsible sections.

data/bin/madman

@@ -12,4 +12,4 @@ rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "!txtred!#{e.class}: #{e.message}"
   exit 1
-end
+end

data/lib/madman/cli.rb

@@ -14,5 +14,4 @@ module Madman
       runner
     end
   end
-
 end

data/lib/madman/commands/nav.rb

@@ -5,26 +5,29 @@ module Madman
     class Nav < MisterBin::Command
       include Colsole
 
-      summary "Add site-wide navigation links to README files"
+      summary 'Add site-wide navigation links to README files'
 
-      help "This command generates a Table of Contents for a directory, and injects it to a file. In addition, it supports recursive execution, which will add a Table of Contents to all README files (or a filename of your choice) in all the subfolders, creating nagigation pages for an entire Markdown site."
+      help 'This command generates a Table of Contents for a directory, and injects it to a ' \
+        'file. In addition, it supports recursive execution, which will add a Table of Contents ' \
+        'to all README files (or a filename of your choice) in all the subfolders, creating ' \
+        'nagigation pages for an entire Markdown site.'
 
-      usage "madman nav DIR [options]"
-      usage "madman nav (-h|--help)"
+      usage 'madman nav DIR [options]'
+      usage 'madman nav (-h|--help)'
 
-      option "-f --force", "Inject TOC to all README files, even if they do not have a marker"
-      option "-m --marker TEXT", "Look for an HTML comment with <!-- TEXT --> [default: nav]"
-      option "-d --depth N", "The depth of the table of contents [default: 1]"
-      option "-v --verbose", "Show the updated README content"
-      option "-t --target NAME", "Set the target filename to look for. [default: README.md]"
-      option "-r --recursive", "Inject to all target files"
-      option "-y --dry", "Do not save the updated files, just show what will happen"
+      option '-f --force', 'Inject TOC to all README files, even if they do not have a marker'
+      option '-m --marker TEXT', 'Look for an HTML comment with <!-- TEXT --> [default: nav]'
+      option '-d --depth N', 'The depth of the table of contents [default: 1]'
+      option '-v --verbose', 'Show the updated README content'
+      option '-t --target NAME', 'Set the target filename to look for. [default: README.md]'
+      option '-r --recursive', 'Inject to all target files'
+      option '-y --dry', 'Do not save the updated files, just show what will happen'
 
-      param "DIR", "The directory containing markdown files"
+      param 'DIR', 'The directory containing markdown files'
 
-      example "madman nav"
-      example "madman nav path/to/docs --force --marker toc"
-      example "madman nav path/to/docs --dry -v -d2"
+      example 'madman nav'
+      example 'madman nav path/to/docs --force --marker toc'
+      example 'madman nav path/to/docs --dry -v -d2'
 
       def run
         if recursive?
@@ -33,7 +36,7 @@ module Madman
           update_file "#{dir}/#{target}"
         end
 
-        say dry? ? "Done (dry mode, no changes were made)" : "Done"
+        say dry? ? 'Done (dry mode, no changes were made)' : 'Done'
       end
 
       def update_file(file)
@@ -45,7 +48,7 @@ module Madman
 
         if verbose?
           say word_wrap "  !txtblu!#{doc.text}"
-          say ""
+          say ''
         end
 
         doc.save unless dry?
@@ -53,15 +56,14 @@ module Madman
 
       # CLI Arguments
 
-      def dir;        args['DIR'] || '.'; end
-      def depth;      args['--depth'].to_i; end
-      def marker;     args['--marker']; end
-      def target;     args['--target']; end
-      def force?;     args['--force']; end
-      def dry?;       args['--dry']; end
-      def verbose?;   args['--verbose']; end
-      def recursive?; args['--recursive']; end
-      
+      def dir = args['DIR'] || '.'
+      def depth = args['--depth'].to_i
+      def marker = args.[]('--marker')
+      def target = args.[]('--target')
+      def force? = args.[]('--force')
+      def dry? = args.[]('--dry')
+      def verbose? = args.[]('--verbose')
+      def recursive? = args.[]('--recursive')
     end
   end
 end

data/lib/madman/commands/preview.rb

@@ -3,23 +3,28 @@ module Madman
     class Preview < MisterBin::Command
       include Colsole
 
-      summary "Serve a markdown or YAML file using a local server"
+      summary 'Serve a markdown or YAML file using a local server'
 
-      help "This command will start a local server with two endpoints:\n  /         will render the markdown with the default renderer\n  /github   will render with the GitHub API"
+      help <<~USAGE
+        This command will start a local server with two endpoints:
+          /         will render the markdown with the default renderer
+          /github   will render with the GitHub API
+      USAGE
 
-      usage "madman preview FILE [--port N --bind ADDRESS]"
-      usage "madman preview (-h|--help)"
+      usage 'madman preview FILE [--port N --bind ADDRESS]'
+      usage 'madman preview (-h|--help)'
 
-      option "-p --port N", "Set server port [default: 3000]"
-      option "-b --bind ADDRESS", "Set server listen address [default: 0.0.0.0]"
+      option '-p --port N', 'Set server port [default: 3000]'
+      option '-b --bind ADDRESS', 'Set server listen address [default: 0.0.0.0]'
 
-      param "FILE", "The input markdown or YAML file"
+      param 'FILE', 'The input markdown or YAML file'
 
-      environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nRequired only if you wish to use the '/github' endpoint\nGenerate one here: https://github.com/settings/tokens"
+      environment 'GITHUB_ACCESS_TOKEN',
+        "Your GitHub API access token\nRequired only if you wish to use the '/github' endpoint\nGenerate one here: https://github.com/settings/tokens"
 
-      example "madman preview README.md"
-      example "madman preview README.md -p4000"
-      example "madman preview file.yml"
+      example 'madman preview README.md'
+      example 'madman preview README.md -p4000'
+      example 'madman preview file.yml'
 
       def run
         file = args['FILE']
@@ -35,8 +40,6 @@ module Madman
         Madman::PreviewServer.set bind: bind, port: port, file: file
         Madman::PreviewServer.run!
       end
-
     end
   end
 end
-

data/lib/madman/commands/readme.rb

@@ -3,28 +3,29 @@ module Madman
     class Readme < MisterBin::Command
       include Colsole
 
-      summary "Create README in all qualified sub directories"
+      summary 'Create README in all qualified sub directories'
 
-      help "This command generates README.md files in all subdirectories. Each file will receive an H1 caption with the name of the folder it resides in. This command is designed to assist in preparing a folder for table of contents injection."
+      help 'This command generates README.md files in all subdirectories. Each file will receive ' \
+        'an H1 caption with the name of the folder it resides in. This command is designed to ' \
+        'assist in preparing a folder for table of contents injection.'
 
-      usage "madman readme DIR [--dry]"
-      usage "madman readme (-h|--help)"
+      usage 'madman readme DIR [--dry]'
+      usage 'madman readme (-h|--help)'
 
-      option "-y --dry", "Only show what will be created, don't make any changes"
+      option '-y --dry', "Only show what will be created, don't make any changes"
 
-      param "DIR", "The directory containing markdown files"
+      param 'DIR', 'The directory containing markdown files'
 
-      example "madman readme ."
-      example "madman readme path/to/docs --dry"
+      example 'madman readme .'
+      example 'madman readme path/to/docs --dry'
 
       def run
-        dir = args['DIR']
-        basedir = Madman::Directory.new dir
+        basedir = Madman::Directory.new args['DIR']
 
-        dirs = basedir.deep_list.select { |i| i.dir? }.map { |i| i.path }
+        dirs = basedir.deep_list.select(&:dir?).map(&:path)
         dirs.each do |dir|
           file = "#{dir}/README.md"
-          
+
           if File.exist? file
             say "Skipping #{file}"
           else
@@ -34,10 +35,8 @@ module Madman
           end
         end
 
-        say args['--dry'] ? "Done (dry mode, no changes were made)" : "Done"
+        say args['--dry'] ? 'Done (dry mode, no changes were made)' : 'Done'
       end
-
     end
   end
 end
-

data/lib/madman/commands/render.rb

@@ -3,22 +3,22 @@ module Madman
     class Render < MisterBin::Command
       include Colsole
 
-      help "Render markdown or YAML to HTML"
+      help 'Render markdown or YAML to HTML'
 
-      usage "madman render FILE [--github --save OUTFILE]"
-      usage "madman render (-h|--help)"
+      usage 'madman render FILE [--github --save OUTFILE]'
+      usage 'madman render (-h|--help)'
 
-      option "--github", "Render using the GitHub API\nRequires setting the GITHUB_ACCESS_TOKEN environment variable"
-      option "--save OUTFILE", "Save the output to a file"
+      option '--github', "Render using the GitHub API\nRequires setting the GITHUB_ACCESS_TOKEN environment variable"
+      option '--save OUTFILE', 'Save the output to a file'
 
-      param "FILE", "The input markdown or YAML file"
+      param 'FILE', 'The input markdown or YAML file'
 
-      environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nGenerate one here: https://github.com/settings/tokens"
+      environment 'GITHUB_ACCESS_TOKEN', "Your GitHub API access token\nGenerate one here: https://github.com/settings/tokens"
 
-      example "madman render README.md"
-      example "madman render README.md --github"
-      example "madman render README.md --save out.html"
-      example "madman render file.yml --save out.html"
+      example 'madman render README.md'
+      example 'madman render README.md --github'
+      example 'madman render README.md --save out.html'
+      example 'madman render file.yml --save out.html'
 
       def run
         infile = args['FILE']
@@ -26,18 +26,16 @@ module Madman
         renderer = args['--github'] ? :github : :default
 
         doc = Madman::Document.from_file infile
-        
+
         output = doc.render renderer
 
         if outfile
-          File.write outfile, output    
+          File.write outfile, output
           say "Saved !txtgrn!#{outfile}"
         else
           puts output
         end
       end
-
     end
   end
 end
-

data/lib/madman/commands/serve.rb

@@ -3,21 +3,22 @@ module Madman
     class Serve < MisterBin::Command
       include Colsole
 
-      summary "Serve a markdown directory using a local server"
+      summary 'Serve a markdown directory using a local server'
 
-      usage "madman serve DIR [--port N --bind ADDRESS --github]"
-      usage "madman serve (-h|--help)"
+      usage 'madman serve DIR [--port N --bind ADDRESS --github]'
+      usage 'madman serve (-h|--help)'
 
-      option "--github", "Use the GitHub API renderer instead of the default one"
-      option "-p --port N", "Set server port [default: 3000]"
-      option "-b --bind ADDRESS", "Set server listen address [default: 0.0.0.0]"
+      option '--github', 'Use the GitHub API renderer instead of the default one'
+      option '-p --port N', 'Set server port [default: 3000]'
+      option '-b --bind ADDRESS', 'Set server listen address [default: 0.0.0.0]'
 
-      param "DIR", "The directory containing markdown files"
+      param 'DIR', 'The directory containing markdown files'
 
-      environment "GITHUB_ACCESS_TOKEN", "Your GitHub API access token\nRequired only if you wish to use the '/github' endpoint\nGenerate one here: https://github.com/settings/tokens"
+      environment 'GITHUB_ACCESS_TOKEN',
+        "Your GitHub API access token\nRequired only if you wish to use the '/github' endpoint\nGenerate one here: https://github.com/settings/tokens"
 
-      example "madman serve"
-      example "madman serve path/to/docs -p4000 --github"
+      example 'madman serve'
+      example 'madman serve path/to/docs -p4000 --github'
 
       def run
         dir = args['DIR']
@@ -27,13 +28,11 @@ module Madman
 
         say "Starting server at !undblu!localhost:#{port}!txtrst! using the !txtgrn!#{renderer}!txtrst! renderer\n"
 
-        Madman::DirServer.set bind: bind, port: port, 
+        Madman::DirServer.set bind: bind, port: port,
           dir: dir, renderer: renderer
-          
+
         Madman::DirServer.run!
       end
-
     end
   end
 end
-

data/lib/madman/commands.rb

@@ -2,4 +2,4 @@ require 'madman/commands/nav'
 require 'madman/commands/preview'
 require 'madman/commands/readme'
 require 'madman/commands/render'
-require 'madman/commands/serve'
+require 'madman/commands/serve'

data/lib/madman/dir_server.rb

@@ -10,19 +10,19 @@ module Madman
 
     not_found do
       content_type :text
-      "4O4 Not Found"
+      '4O4 Not Found'
     end
 
     get '/favicon.ico' do
       content_type :text
       '(oOo)'
     end
-    
+
     get '/*' do
       path = params[:splat].first
 
       type, file = find_file(path)
-      redirect "#{path}/" if type == :dir and path[-1] != '/'
+      redirect "#{path}/" if (type == :dir) && (path[-1] != '/')
 
       if File.exist? file
         @doc = Document.from_file file
@@ -40,13 +40,12 @@ module Madman
 
       if File.directory? file
         type = path.empty? ? :root : :dir
-        file ="#{file}/README.md"
+        file = "#{file}/README.md"
       else
-        file ="#{file}.md"
+        file = "#{file}.md"
       end
 
       [type, file]
     end
-
   end
-end
+end

data/lib/madman/directory.rb

@@ -7,7 +7,7 @@ module Madman
       @dir = dir
       @basedir = basedir || dir
     end
-    
+
     def list
       @list ||= (dirs + files)
     end
@@ -30,7 +30,7 @@ module Madman
 
     def dirs
       result = Dir["#{dir}/*"].select { |f| File.directory? f }
-      result.reject! do |f| 
+      result.reject! do |f|
         basename = File.basename(f)
         basename =~ /^[a-z_\-0-9]+$/
       end

data/lib/madman/document.rb

@@ -10,7 +10,7 @@ module Madman
 
     def self.from_file(file)
       if File.extname(file) == '.yml'
-        result = new YAML.load_file(file), file
+        result = new YAML.unsafe_load_file(file), file
         result.yaml_mode = true
         result
       else
@@ -18,12 +18,12 @@ module Madman
       end
     end
 
-    def initialize(text, filename=nil)
+    def initialize(text, filename = nil)
       @text = text
       @filename = filename
     end
 
-    def render(renderer=:default)
+    def render(renderer = :default)
       if yaml_mode
         renderers[:yaml].render text, title: File.basename(filename, '.yml')
       else
@@ -35,9 +35,10 @@ module Madman
       detector.direction(text[0..200]) == 'rtl'
     end
 
-    def save(save_as=nil)
+    def save(save_as = nil)
       save_as ||= filename
-      raise ArgumentError, "No filename provided" unless save_as
+      raise ArgumentError, 'No filename provided' unless save_as
+
       File.write save_as, text
     end
 
@@ -51,4 +52,4 @@ module Madman
       Renderers.available_renderers
     end
   end
-end
+end

data/lib/madman/injector.rb

@@ -6,13 +6,13 @@ module Madman
 
       content = [marker, content, marker].join "\n"
 
-      if found_markers == 0 and force
+      if found_markers.zero? && force
         self.text += "\n\n#{content}"
       elsif found_markers == 1
-        text.gsub! /#{marker}/im, content
+        text.gsub!(/#{marker}/im, content)
       elsif found_markers == 2
-        text.gsub! /#{marker}.*#{marker}/im, content
+        text.gsub!(/#{marker}.*#{marker}/im, content)
       end
     end
   end
-end
+end

data/lib/madman/item.rb

@@ -5,7 +5,9 @@ module Madman
     attr_reader :path, :type, :basedir
 
     def initialize(path, type, basedir)
-      @path, @type, @basedir = path, type, basedir
+      @path = path
+      @type = type
+      @basedir = basedir
     end
 
     def label
@@ -13,7 +15,7 @@ module Madman
     end
 
     def href
-      Addressable::URI.escape(path_without_extension.sub(/^#{basedir}\//, ''))
+      Addressable::URI.escape(path_without_extension.sub(%r{^#{basedir}/}, ''))
     end
 
     def dir?
@@ -31,4 +33,3 @@ module Madman
     end
   end
 end
-

data/lib/madman/navigation.rb

@@ -5,8 +5,9 @@ module Madman
   class Navigation
     attr_reader :dir, :depth
 
-    def initialize(dir='.', depth: 10)
-      @dir, @depth = dir, depth
+    def initialize(dir = '.', depth: 10)
+      @dir = dir
+      @depth = depth
     end
 
     def toc
@@ -28,16 +29,18 @@ module Madman
       result.join "\n"
     end
 
-    def toc!(path=dir, level=0)
+    def toc!(path = dir, level = 0)
       return [] unless level < depth
+
       list = Directory.new(path, dir).list
 
       result = []
       list.each do |item|
-        if item.type == :dir
+        case item.type
+        when :dir
           result.push level: level, item: item
-          result += toc! item.path, level+1
-        elsif item.type == :file
+          result += toc! item.path, level + 1
+        when :file
           result.push level: level, item: item
         end
       end

data/lib/madman/preview_server.rb

@@ -10,7 +10,7 @@ module Madman
       @renderer = :default
     end
 
-    get '/' do      
+    get '/' do
       slim :template
     end
 
@@ -19,4 +19,4 @@ module Madman
       slim :template
     end
   end
-end
+end

data/lib/madman/refinements/array.rb

@@ -1,11 +1,11 @@
 module ArrayRefinements
   refine Array do
     def to_markdown
-      map { |item| "- #{item}"}.join "\n"
+      map { |item| "- #{item}" }.join "\n"
     end
 
     def to_html
       CommonMarker.render_html to_markdown, :DEFAULT, [:table]
     end
   end
-end
+end

data/lib/madman/refinements/string.rb

@@ -1,11 +1,11 @@
 module StringRefinements
   refine String do
     def slug
-      downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+      downcase.strip.tr(' ', '-').gsub(/[^\w-]/, '')
     end
 
     def to_html
       CommonMarker.render_html self, :DEFAULT, [:table]
     end
   end
-end
+end

data/lib/madman/renderers/default.rb

@@ -1,9 +1,9 @@
 module Madman
   module Renderers
     class Default
-      def self.render(text, opts={})
-        CommonMarker.render_html text, [:DEFAULT, :UNSAFE], [:table]
+      def self.render(text, _opts = {})
+        CommonMarker.render_html text, %i[DEFAULT UNSAFE], [:table]
       end
     end
   end
-end
+end

data/lib/madman/renderers/github.rb

@@ -1,19 +1,17 @@
 module Madman
   module Renderers
-    class GitHub
-      def self.render(text, opts={})
+    class Github
+      def self.render(text, _opts = {})
         client.markdown text
       end
 
-    private
-
       def self.client
         Octokit::Client.new access_token: access_token
       end
 
       def self.access_token
-        ENV['GITHUB_ACCESS_TOKEN'] or raise ArgumentError, "Please set GITHUB_ACCESS_TOKEN"
+        ENV['GITHUB_ACCESS_TOKEN'] or raise ArgumentError, 'Please set GITHUB_ACCESS_TOKEN'
       end
     end
   end
-end
+end

data/lib/madman/renderers/yaml.rb

@@ -1,12 +1,10 @@
 module Madman
   module Renderers
     class YAML
-      def self.render(yaml, opts={})
+      def self.render(yaml, opts = {})
         doc = YAMLDoc.new yaml, title: opts[:title]
         doc.render
       end
     end
   end
 end
-
-

data/lib/madman/renderers.rb

@@ -7,8 +7,8 @@ module Madman
     def self.available_renderers
       {
         default: Renderers::Default,
-        yaml: Renderers::YAML,
-        github: Renderers::GitHub,
+        yaml:    Renderers::YAML,
+        github:  Renderers::Github,
       }
     end
   end

data/lib/madman/server_base.rb

@@ -1,10 +1,10 @@
 module Madman
   class ServerBase < Sinatra::Base
     set :views, File.expand_path('../views', __dir__)
-    
+
     Slim::Engine.set_options pretty: true
-    
-    # Reloader temporarily removed due to 
+
+    # Reloader temporarily removed due to
     # https://github.com/sinatra/sinatra/issues/1587
     #
     # configure :development do
@@ -13,7 +13,7 @@ module Madman
     # end
 
     get '/favicon.ico' do
+      ''
     end
-
   end
-end
+end

data/lib/madman/version.rb

@@ -1,3 +1,3 @@
 module Madman
-  VERSION = "0.2.13"
-end
+  VERSION = '0.3.0'
+end

data/lib/madman/yamldoc.rb

@@ -40,7 +40,7 @@ module Madman
       @counter += 1
     end
 
-    def tree!(data=nil, indent=0, caption=2)
+    def tree!(data = nil, indent = 0, caption = 2)
       data ||= yaml
       result = []
       caption = 6 if caption > 6
@@ -65,14 +65,13 @@ module Madman
       end
 
       if value.is_a? Hash
-        result.push tree!(value, indent+1, caption+1)
+        result.push tree!(value, indent + 1, caption + 1)
       elsif value
-        result.push "#{space * (indent+1)}#{value.to_html}"
+        result.push "#{space * (indent + 1)}#{value.to_html}"
       end
 
       result.push "#{space * indent}</div>"
       result
     end
-
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madman
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.3.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -228,7 +228,8 @@ files:
 homepage: https://github.com/dannyben/madman
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -237,7 +238,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="