madness 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62a496bd766978ec0095976786632c03a6c26e72df950fcee0578512cff80147
-  data.tar.gz: 7e24ebe336bfbac972df7eeb728d7341d1c1a6d955ee22a13913e39f3f13811b
+  metadata.gz: ec22db6e78f2280f7764aeb8a6d9651a4c1143c690a48e545418e3fe270de67a
+  data.tar.gz: d620d042133e056447287acc8de81c2f42998f146a694f448c4cc90da8377a25
 SHA512:
-  metadata.gz: 372838e5d0345b941968b00579c795529e19216f1e5ccb6f2dcb152727dfe9b71591d3b74dc790ee841f01b32d96da0c2c33e7e925eef95c17c2388ddddb55c0
-  data.tar.gz: bc57c2a3bb37886ad14b914e01f6affc4ebb8458f9679648b7fd227d1977e133f9b87634b71d956bc6c956439f32815701c9e31b73047064f2278464f5dba3ba
+  metadata.gz: a49197240d3b3ff61431a5a903cd4d3528e0185076a8c4084f27e00d973ad5a2be2e5e470d987d829ab9f5edf53fe331f78f734b14dfd5e469b8c6bc0275e3f9
+  data.tar.gz: bed7e069ba8d69cd657503c5394cd1c0b653a2ddde9ca8615e6807654622fc1586df4745643942f005fd029a846b243aa32383384a6b1d40cf77cedd0a057a76

data/README.md

@@ -75,11 +75,12 @@ Go to any directory that contains markdown files and run:
 
     $ madness
 
+And open <http://localhost:3000> in your browser.
+
 For more options, run:
 
     $ madness --help
 
-
 If you do not have Ruby installed, you can also 
 [run madness with docker](#docker-image).
 
@@ -136,6 +137,7 @@ line_numbers: true
 index: false
 toc: Table of Contents
 theme: _theme
+open: false
 ```
 
 For convenience, you can get a template config file by running:
@@ -164,7 +166,7 @@ documents change or new documents are added.
 Images and Static Files
 --------------------------------------------------
 
-You can put images and any other asset file anywhere in your documentation 
+You can put images and other asset files anywhere in your documentation
 folder.
 
 When linking to other pages or images in your documentation folder, simply
@@ -206,8 +208,10 @@ markdown file.
 Hidden Directories
 --------------------------------------------------
 
-Diretories that are made only of lowercase letters, underscoes, dash and/or 
-numbers (`/^[a-z_\-0-9]+$/`) will not be displayed in the navigation.
+Directories that are made only of lowercase letters, underscoes, dash and/or
+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.
 
 
 
@@ -216,7 +220,8 @@ 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 
-space, just like you would create an ordered list in Markdown
+space, just like you would create an ordered list in Markdown. The numbers
+will be omitted when they are displayed.
 
 ```
 ./
@@ -257,7 +262,7 @@ $ madness --theme my_theme
 
 ### Option 2: Change CSS only
 
-If you are looking to implement a more minor CSS change, follow these steps:
+If you are looking to implement a smaller CSS change, follow these steps:
 
 - Create a directory named `css` in your root documentation directory.
 - Copy the [main.css][css] file to it.

data/lib/madness/browser.rb

@@ -0,0 +1,63 @@
+require 'socket'
+require 'os'
+
+module Madness
+  # Handles browser launching
+  class Browser
+    attr_reader :host, :port
+
+    def initialize(host, port)
+      @host, @port = host, port
+    end
+
+    # Returns a URL based on host, port and MADNESS_FORCE_SSL.
+    def server_url
+      scheme = ENV['MADNESS_FORCE_SSL'] ? 'https' : 'http'
+      url_host = ['0.0.0.0', '127.0.0.1'].include?(host) ? 'localhost' : host
+      "#{scheme}://#{url_host}:#{port}"
+    end
+
+    # Returns true if the server is running. Will attempt to connect
+    # multiple times. This is designed to assist in running some code after
+    # the server has launched.
+    def server_running?(retries: 5, delay: 1)
+      connected = false
+      attempts = 0
+
+      begin
+        connected = Socket.tcp(host, port)
+      rescue
+        sleep delay
+        retry if (attempts += 1) < retries
+      ensure
+        connected.close if connected
+      end
+
+      !!connected
+    end
+
+    # Open a web browser if the server is running. This is done in a
+    # non-blocking manner, so it can be executed before starting the server.
+    # It will yield an error message if it fails, or nil on success.
+    def open
+      fork do
+        if server_running?
+          success = open!
+          yield success ? nil : "Failed opening browser (#{open_command.join ' '})"
+        else
+          yield "Failed connecting to #{server_url}. Is the server running?"
+        end
+      end
+    end
+
+    # 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
+    end
+
+    # Returns the appropriate command (based on OS) to open a browser.
+    def open_command
+      @open_command ||= [OS.open_file_command, server_url]
+    end
+  end
+end

data/lib/madness/command_line.rb

@@ -35,11 +35,12 @@ module Madness
       end
     end
 
-    # Execute some pre-server-launch operations if needed, and execute
-    # the server.
+    # Execute some pre-server-launch operations if needed, execute the
+    # server, and launch the browser if requested.
     def launch_server_with_options(args)
       set_config args
       generate_stuff
+      open_browser if config.open
       launch_server unless args['--and-quit']
     end
 
@@ -70,6 +71,7 @@ module Madness
       config.highlighter  = false   if args['--no-syntax']
       config.line_numbers = false   if args['--no-line-numbers']
       config.index        = true    if args['--index']
+      config.open         = true    if args['--open']
       config.theme = File.expand_path(args['--theme'], config.path) if args['--theme']
     end
 
@@ -119,6 +121,7 @@ module Madness
       search.build_index
     end
 
+    # Generate the table of contents file
     def build_toc
       say_status :toc, "generating #{config.toc}"
       TableOfContents.new.build(config.toc)
@@ -127,5 +130,14 @@ module Madness
     def config
       @config ||= Settings.instance
     end
+
+    # Open a web browser if the server is running. This is done in a
+    # non-blocking manner, so it can be executed before starting the server.
+    def open_browser
+      browser = Browser.new config.bind, config.port
+      browser.open do |error|
+        say "!txtred!#{error}" if error
+      end
+    end
   end
 end

data/lib/madness/docopt.txt

@@ -64,6 +64,10 @@ Options:
     Generate a table of contents file. 
     (Config option: toc)
 
+  --open
+    Open the browser pointing at the madness webserver.
+    (Config option: open)
+
   --and-quit
     Quit instead of running the server. Useful with --index or --toc.
 
@@ -71,6 +75,7 @@ Examples:
   madness
   madness docs
   madness docs --no-auto-h1 -p 4567
+  madness docs --open
   madness --no-sidebar --no-auto-nav
   madness --index --and-quit
   madness --toc "Table of Contents.md" --index --and-quit

data/lib/madness/settings.rb

@@ -51,7 +51,7 @@ module Madness
         line_numbers: true,
         index: false,
         theme: nil,
-
+        open: false,
         auto_nav: true,
         sidebar: true
       }

data/lib/madness/templates/madness.yml

@@ -12,3 +12,4 @@
 # index: false
 # toc: Table of Contents
 # theme: _theme
+# open: false

data/lib/madness/version.rb

@@ -1,3 +1,3 @@
 module Madness
-  VERSION = "0.7.3"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madness
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-26 00:00:00.000000000 Z
+date: 2019-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -278,6 +292,7 @@ files:
 - bin/madness
 - lib/madness.rb
 - lib/madness/breadcrumbs.rb
+- lib/madness/browser.rb
 - lib/madness/command_line.rb
 - lib/madness/directory.rb
 - lib/madness/docopt.txt