madness 0.2.0 → 0.2.1

data/lib/madness/navigation.rb

@@ -1,61 +1,61 @@
-module Madness
-  # Handle the navigation links for a given directory
-  class Navigation
-    include ServerHelper
-
-    attr_reader :links, :caption
-
-    def initialize(dir)
-      @links = make_links dir
-      # @caption = File.basename(dir) unless dir == docroot
-      @caption = dir == docroot ? "Index" : File.basename(dir)
-    end
-
-    def with_search?
-      @with_search ||= Search.new.has_index?
-    end
-
-    private
-
-    # Prepare a list of links from all the accepted items in the directory
-    def make_links(dir)
-      files = get_files dir
-      dirs  = get_dirs dir
-
-      links = []
-
-      dirs.sort.each do |item|
-        links.push link(item, :dir)
-      end
-
-      files.each do |item|
-        links.push link(item, :file)
-      end
-
-      links
-    end
-
-    def get_files(dir)
-      files = Dir["#{dir}/*.md"].map { |f| f.sub(/\.md$/, '') }
-      files.reject! { |f| File.basename(f) == 'README' }
-      files.sort
-    end
-
-    def get_dirs(dir)
-      dirs  = Dir["#{dir}/*"].select { |f| File.directory? f }
-      dirs.reject! do |f| 
-        basename = File.basename(f)
-        basename[0] == '_' || basename == 'public'
-      end
-      dirs
-    end
-
-    def link(item, type)
-      OpenStruct.new({ 
-        label: File.basename(item).tr('-', ' '), 
-        href: URI.escape(item.sub(/^#{docroot}/, '')), 
-        type: type 
-      })
-    end
-  end
+module Madness
+  # Handle the navigation links for a given directory
+  class Navigation
+    include ServerHelper
+
+    attr_reader :links, :caption
+
+    def initialize(dir)
+      @links = make_links dir
+      # @caption = File.basename(dir) unless dir == docroot
+      @caption = dir == docroot ? "Index" : File.basename(dir)
+    end
+
+    def with_search?
+      @with_search ||= Search.new.has_index?
+    end
+
+    private
+
+    # Prepare a list of links from all the accepted items in the directory
+    def make_links(dir)
+      files = get_files dir
+      dirs  = get_dirs dir
+
+      links = []
+
+      dirs.sort.each do |item|
+        links.push link(item, :dir)
+      end
+
+      files.each do |item|
+        links.push link(item, :file)
+      end
+
+      links
+    end
+
+    def get_files(dir)
+      files = Dir["#{dir}/*.md"].map { |f| f.sub(/\.md$/, '') }
+      files.reject! { |f| File.basename(f) == 'README' }
+      files.sort
+    end
+
+    def get_dirs(dir)
+      dirs  = Dir["#{dir}/*"].select { |f| File.directory? f }
+      dirs.reject! do |f| 
+        basename = File.basename(f)
+        basename[0] == '_' || basename == 'public'
+      end
+      dirs
+    end
+
+    def link(item, type)
+      OpenStruct.new({ 
+        label: File.basename(item).tr('-', ' '), 
+        href: URI.escape(item.sub(/^#{docroot}/, '')), 
+        type: type 
+      })
+    end
+  end
 end

data/lib/madness/search.rb

@@ -1,63 +1,63 @@
-module Madness
-
-  class Search
-    include ServerHelper
-    include Ferret
-    include Ferret::Index
-
-    def initialize(path=nil)
-      @path = path || docroot
-    end
-
-    def has_index?
-      Dir.exist? index_dir
-    end
-
-    def build_index
-      Dir.mkdir index_dir unless Dir.exist? index_dir
-
-      index = Index.new path: index_dir, create: true
-
-      Dir["#{@path}/**/*.md"].each do |file|
-        index << { file: file, content: File.read(file) }
-      end
-
-      index.optimize()                                
-      index.close()
-    end
-
-    def search(query)
-      index = Index.new path: index_dir
-
-      results = []
-      index.search_each(query, limit: 20) do |doc_id, score| 
-        filename = index[doc_id][:file].sub("#{@path}/", '')[0...-3]
-        highlights = index.highlight "content:(#{query.tr(' ',' OR ')}) ", doc_id, field: :content,
-          pre_tag: "", post_tag: "",
-          excerpt_length: 100
-        
-        highlights.map! { |excerpt| CGI.escapeHTML excerpt } if highlights
-
-        results << { 
-          score: score, 
-          file: filename,
-          label: filename.gsub("/", " / "),
-          highlights: highlights
-        }
-      end
-
-      index.close()
-      results
-    end
-
-    def remove_index_dir
-      return unless Dir.exist? index_dir
-      FileUtils.rm_r index_dir
-    end
-
-    def index_dir
-      "#{@path}/_index"
-    end  
-
-  end
-end
+module Madness
+
+  class Search
+    include ServerHelper
+    include Ferret
+    include Ferret::Index
+
+    def initialize(path=nil)
+      @path = path || docroot
+    end
+
+    def has_index?
+      Dir.exist? index_dir
+    end
+
+    def build_index
+      Dir.mkdir index_dir unless Dir.exist? index_dir
+
+      index = Index.new path: index_dir, create: true
+
+      Dir["#{@path}/**/*.md"].each do |file|
+        index << { file: file, content: File.read(file) }
+      end
+
+      index.optimize()                                
+      index.close()
+    end
+
+    def search(query)
+      index = Index.new path: index_dir
+
+      results = []
+      index.search_each(query, limit: 20) do |doc_id, score| 
+        filename = index[doc_id][:file].sub("#{@path}/", '')[0...-3]
+        highlights = index.highlight "content:(#{query.tr(' ',' OR ')}) ", doc_id, field: :content,
+          pre_tag: "", post_tag: "",
+          excerpt_length: 100
+        
+        highlights.map! { |excerpt| CGI.escapeHTML excerpt } if highlights
+
+        results << { 
+          score: score, 
+          file: filename,
+          label: filename.gsub("/", " / "),
+          highlights: highlights
+        }
+      end
+
+      index.close()
+      results
+    end
+
+    def remove_index_dir
+      return unless Dir.exist? index_dir
+      FileUtils.rm_r index_dir
+    end
+
+    def index_dir
+      "#{@path}/_index"
+    end  
+
+  end
+end

data/lib/madness/server.rb

@@ -1,40 +1,40 @@
-require 'madness/server_base'
-
-module Madness
-
-  # The Sinatra server
-  class Server < ServerBase
-    get '/_search' do
-      query = params[:q]
-      results = query ? Search.new.search(query) : false
-      nav = Navigation.new docroot
-      slim :search, locals: {
-        nav: nav,
-        results: results
-      }
-    end
-
-    get '/*' do
-      path = params[:splat].first
-
-      doc = Document.new path
-      dir     = doc.dir
-      content = doc.content
-
-      nav = Navigation.new(dir)
-      breadcrumbs = Breadcrumbs.new(path).links
-
-      if nav.links.count == 1 and doc.type == :empty
-        redirect to(nav.links.first.href)
-      end
-
-      slim :document, locals: { 
-        content: content, 
-        type: doc.type,
-        title: doc.title,
-        nav: nav, 
-        breadcrumbs: breadcrumbs
-      }
-    end
-  end
+require 'madness/server_base'
+
+module Madness
+
+  # The Sinatra server
+  class Server < ServerBase
+    get '/_search' do
+      query = params[:q]
+      results = query ? Search.new.search(query) : false
+      nav = Navigation.new docroot
+      slim :search, locals: {
+        nav: nav,
+        results: results
+      }
+    end
+
+    get '/*' do
+      path = params[:splat].first
+
+      doc = Document.new path
+      dir     = doc.dir
+      content = doc.content
+
+      nav = Navigation.new(dir)
+      breadcrumbs = Breadcrumbs.new(path).links
+
+      if nav.links.count == 1 and doc.type == :empty
+        redirect to(nav.links.first.href)
+      end
+
+      slim :document, locals: { 
+        content: content, 
+        type: doc.type,
+        title: doc.title,
+        nav: nav, 
+        breadcrumbs: breadcrumbs
+      }
+    end
+  end
 end

data/lib/madness/server_base.rb

@@ -1,36 +1,36 @@
-
-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.
-  class ServerBase < Sinatra::Application
-    helpers ServerHelper
-
-    Sass::Plugin.options[:template_location] = 'app/styles'
-    Sass::Plugin.options[:css_location] = 'app/public/css'
-    Slim::Engine.set_options pretty: true
-
-    use Sass::Plugin::Rack
-    
-    set :root, File.expand_path('../../', __dir__)
-    set :views, File.expand_path('../../app/views', __dir__)
-    set :public_folder, File.expand_path('../../app/public', __dir__)
-
-    # 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 Rack::TryStatic, :root => "#{config.path}/public/", :urls => %w[/]
-      set :bind, config.bind
-      set :port, config.port
-    end
-
-    def self.config
-      Settings.instance
-    end
-  end
-
-end
+
+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.
+  class ServerBase < Sinatra::Application
+    helpers ServerHelper
+
+    Sass::Plugin.options[:template_location] = 'app/styles'
+    Sass::Plugin.options[:css_location] = 'app/public/css'
+    Slim::Engine.set_options pretty: true
+
+    use Sass::Plugin::Rack
+
+    set :root, File.expand_path('../../', __dir__)
+    set :views, File.expand_path('../../app/views', __dir__)
+    set :public_folder, File.expand_path('../../app/public', __dir__)
+
+    # 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 Rack::TryStatic, :root => "#{config.path}/public/", :urls => %w[/]
+      set :bind, config.bind
+      set :port, config.port
+    end
+
+    def self.config
+      Settings.instance
+    end
+  end
+
+end

data/lib/madness/server_helper.rb

@@ -1,22 +1,22 @@
-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 
-      @config ||= Settings.instance
-    end
-
-    def docroot
-      @docroot ||= File.expand_path(config.path, Dir.pwd)
-    end
-
-    def log(obj)
-      #:nocov:
-      open('madness.log', 'a') { |f|
-        f.puts obj.inspect
-      }
-      #:nocov:
-    end
-  end
+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 
+      @config ||= Settings.instance
+    end
+
+    def docroot
+      @docroot ||= File.expand_path(config.path, Dir.pwd)
+    end
+
+    def log(obj)
+      #:nocov:
+      open('madness.log', 'a') { |f|
+        f.puts obj.inspect
+      }
+      #:nocov:
+    end
+  end
 end

data/lib/madness/settings.rb

@@ -1,66 +1,66 @@
-module Madness
-  
-  # Handle teh configuration options
-  # Each configuration option has three sources
-  # 1. The default value
-  # 2. The setting as provided in the ./.madness.yml
-  # 3. Any override provided later (for example, by the CommandLine 
-  #    class)
-  class Settings
-    include Singleton
-
-    attr_accessor :port, :bind, :path, :autoh1, 
-      :highlighter, :line_numbers, :index
-
-    def initialize
-      reset
-    end
-
-    # Force reload of the config file, set defaults, and then read from 
-    # file.
-    def reset
-      @config_file = nil
-      set_defaults
-      load_from_file if config_file
-    end
-
-    def file_exist?
-      File.exist? filename
-    end
-
-    def filename
-      '.madness.yml'
-    end
-
-    private
-
-    def set_defaults
-      self.port   = '3000'
-      self.bind   = '0.0.0.0'
-      self.path   = '.'
-      self.autoh1 = true
-      self.highlighter = true
-      self.line_numbers = true
-      self.index = false
-    end
-
-    def load_from_file
-      config_file.each do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-    end
-
-    def config_file
-      @config_file ||= config_file!
-    end
-
-    def config_file!
-      if file_exist?
-        YAML.load_file filename 
-      else
-        {}
-      end
-    end
-
-  end
+module Madness
+  
+  # Handle teh configuration options
+  # Each configuration option has three sources
+  # 1. The default value
+  # 2. The setting as provided in the ./.madness.yml
+  # 3. Any override provided later (for example, by the CommandLine 
+  #    class)
+  class Settings
+    include Singleton
+
+    attr_accessor :port, :bind, :path, :autoh1, 
+      :highlighter, :line_numbers, :index
+
+    def initialize
+      reset
+    end
+
+    # Force reload of the config file, set defaults, and then read from 
+    # file.
+    def reset
+      @config_file = nil
+      set_defaults
+      load_from_file if config_file
+    end
+
+    def file_exist?
+      File.exist? filename
+    end
+
+    def filename
+      '.madness.yml'
+    end
+
+    private
+
+    def set_defaults
+      self.port   = '3000'
+      self.bind   = '0.0.0.0'
+      self.path   = '.'
+      self.autoh1 = true
+      self.highlighter = true
+      self.line_numbers = true
+      self.index = false
+    end
+
+    def load_from_file
+      config_file.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def config_file
+      @config_file ||= config_file!
+    end
+
+    def config_file!
+      if file_exist?
+        YAML.load_file filename 
+      else
+        {}
+      end
+    end
+
+  end
 end