middleman-core 3.0.14 → 3.1.0.beta.1

data/lib/middleman-core/meta_pages/config_setting.rb

@@ -0,0 +1,39 @@
+module Middleman
+  module MetaPages
+    # View class for a config entry
+    class ConfigSetting
+      include Padrino::Helpers::OutputHelpers
+      include Padrino::Helpers::TagHelpers
+
+      def initialize(setting)
+        @setting = setting
+      end
+
+      def render
+        content = ""
+        key_classes = ['key']
+        key_classes << 'modified' if @setting.value_set?
+        content << content_tag(:span, @setting.key.inspect, :class => key_classes.join(' '))
+        content << " = "
+        content << content_tag(:span, CGI::escapeHTML(@setting.value.inspect), :class => 'value')
+        if @setting.default
+          content << content_tag(:span, :class => 'default') do
+            if @setting.value_set?
+              "Default: #{CGI::escapeHTML(@setting.default.inspect)}"
+            else
+              "(Default)"
+            end
+          end
+        end
+
+        if @setting.description
+          content << content_tag(:p, :class => 'description') do
+            CGI::escapeHTML(@setting.description)
+          end
+        end
+
+        content
+      end
+    end
+  end
+end

data/lib/middleman-core/meta_pages/sitemap_resource.rb

@@ -0,0 +1,52 @@
+module Middleman
+  module MetaPages
+    # View class for a sitemap resource
+    class SitemapResource
+      include Padrino::Helpers::OutputHelpers
+      include Padrino::Helpers::TagHelpers
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def render
+        content_tag :div, :class => 'resource-details' do
+          content_tag :table do
+            content = ""
+            resource_properties.each do |label, value|
+              content << content_tag(:tr) do
+                row_content = ""
+                row_content << content_tag(:th, label)
+                row_content << content_tag(:td, value)
+                row_content
+              end
+            end
+            content
+          end
+        end
+      end
+
+      # A hash of label to value for all the properties we want to display
+      def resource_properties
+        props = {
+          'Path' => @resource.path,
+          'Build Path' => @resource.destination_path,
+          'URL' => content_tag(:a, @resource.url, :href => @resource.url),
+          'Template' => @resource.source_file,
+        }
+
+        data = @resource.data
+        props['Data'] = data unless data.empty?
+
+        options = @resource.metadata[:options]
+        props['Options'] = options unless options.empty?
+
+        props
+      end
+
+      def css_classes
+        ['resource']
+      end
+    end
+  end
+end

data/lib/middleman-core/meta_pages/sitemap_tree.rb

@@ -0,0 +1,73 @@
+require 'middleman-core/meta_pages/sitemap_resource'
+
+module Middleman
+  module MetaPages
+    # View class for a sitemap tree
+    class SitemapTree
+      def initialize
+        @children = {}
+      end
+
+      def add_resource(resource)
+        add_path(resource.path.split('/'), resource)
+      end
+
+      def render
+        content = ""
+        @children.keys.sort do |a,b|
+          a_subtree = @children[a]
+          b_subtree = @children[b]
+          if a_subtree.is_a? SitemapResource
+            if b_subtree.is_a? SitemapResource
+              a.downcase <=> b.downcase
+            else
+              1
+            end
+          elsif b_subtree.is_a? SitemapResource
+            if a_subtree.is_a? SitemapResource
+              b.downcase <=> a.downcase
+            else
+              -1
+            end
+          else
+            a.downcase <=> b.downcase
+          end
+        end.each do |path_part|
+          subtree = @children[path_part]
+          content << "<details class='#{subtree.css_classes.join(' ')}'>"
+          content << "<summary>"
+          content << "<i class='icon-folder-open'></i>" unless subtree.is_a? SitemapResource
+          content << "#{path_part}</summary>"
+          content << subtree.render
+          content << "</details>"
+        end
+        content
+      end
+
+      def css_classes
+        ['tree']
+      end
+
+      protected
+
+      def add_path(path_parts, resource)
+        first_part = path_parts.first
+
+        if path_parts.size == 1
+          sitemap_class = SitemapResource
+          # Allow special sitemap resources to use custom metadata view calsses
+          sitemap_class = resource.meta_pages_class if resource.respond_to? :meta_pages_class
+
+          @children[first_part] = sitemap_class.new(resource)
+        else
+          @children[first_part] ||= SitemapTree.new
+          @children[first_part].add_path(path_parts[1..-1], resource)
+        end
+      end
+
+      def to_s
+        "Sitemap Tree"
+      end
+    end
+  end
+end

data/lib/middleman-core/meta_pages/templates/config.html.erb

@@ -0,0 +1,59 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Middleman Configuration</title>
+    <link type="text/css" rel="stylesheet" href="../assets/meta.css">
+    <link type="text/css" rel="stylesheet" href="../assets/config.css">
+  </head>
+
+  <body>
+    <div class="container">
+      <article id="main">
+    <a href="../">&laquo; back</a>
+    <h1>Middleman Configuration</h1>
+
+    <p>This page shows the current configuration of your Middleman application.</p>
+    
+    <p>
+      <a href="#core">Core configuration</a>
+      | <a href="#extensions">Extensions</a>
+    </p>
+
+    <h2 id="core">Core Configuration</h2>
+    <ul class="settings">
+    <% global_config.each do |setting| %>
+      <li class="setting"><%= setting.render %></li>
+    <% end %>
+    </ul>
+
+    <h2 id="extensions">Extensions</h2>
+    <ul class="extensions">
+      <% extension_config.each do |ext_name, configs| %>
+      <li>
+        <% registered_extensions.delete(ext_name) %>
+        
+        <span class="extension active"><%= ext_name.inspect %></span>
+
+        
+        <% if configs && !configs.empty? %>
+        <ul class="settings">
+          <% configs.each do |setting| %>
+          <li class="setting"><%= setting.render %></li>
+          <% end %>
+        </ul>
+        <% end %>
+      </li>
+
+      <% end %>
+
+      <% registered_extensions.keys.each do |ext_name| %>
+      <li><span class="extension"><%= ext_name.inspect %></span> (Inactive)</li>
+      <% end %>
+    </ul>
+    </article>
+    </div>
+  </body>
+</html>
+
+

data/lib/middleman-core/meta_pages/templates/index.html.erb

@@ -0,0 +1,21 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Middleman Info</title>
+    <link type="text/css" rel="stylesheet" href="assets/meta.css">
+  </head>
+  
+  <body>
+    <div class="container">
+      <h1>Middleman Information</h1>
+
+      <ul>
+        <li><a href="sitemap/">Sitemap</a></li>
+        <li><a href="config/">Configuration</a></li>
+        <li><a href="http://middlemanapp.com">Middleman Guides</a></li>
+      </ul>
+    </div>
+  </body>
+</html>
+    

data/lib/middleman-core/meta_pages/templates/sitemap.html.erb

@@ -0,0 +1,31 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+        
+    <title>Middleman Sitemap</title>
+
+    
+    <link type="text/css" rel="stylesheet" href="../assets/meta.css">
+    <link type="text/css" rel="stylesheet" href="../assets/sitemap.css">
+    <script src="../assets/jquery-1.8.2.min.js"></script>
+    <script src="../assets/jquery.details-1.6.min.js"></script>
+    <script src="../assets/sitemap.js"></script>
+  </head>
+  
+  <body>
+    <div class="container">
+      <article id="main">
+        <a href="../">&laquo; back</a>
+        <h1>Middleman Sitemap</h1>
+
+        <p>This page shows all of the pages in
+        the <a href="http://middlemanapp.com/advanced/sitemap/">sitemap</a>,
+        Middleman's view of your site.</p>
+
+        <%= sitemap_tree.render %>
+      </article>
+    </div>
+  </body>
+</html>
+

data/lib/middleman-core/preview_server.rb

@@ -1,4 +1,5 @@
 require "webrick"
+require 'middleman-core/meta_pages'
 
 module Middleman
   module PreviewServer
@@ -18,6 +19,7 @@ module Middleman
 
         mount_instance
         logger.info "== The Middleman is standing watch at http://#{host}:#{port}"
+        logger.info "== Inspect your site configuration at http://#{host}:#{port}/__middleman/"
 
         @initialized ||= false
         unless @initialized
@@ -76,9 +78,17 @@ module Middleman
     private
       def new_app
         opts = @options
-        @app =::Middleman::Application.server.inst do
+        server = ::Middleman::Application.server
+
+        # Add in the meta pages application
+        meta_app = Middleman::MetaPages::Application.new(server)
+        server.map '/__middleman' do
+          run meta_app
+        end
+
+        @app = server.inst do
           if opts[:environment]
-            set :environment, opts[:environment].to_sym
+            config[:environment] = opts[:environment].to_sym
           end
 
           logger(opts[:debug] ? 0 : 1, opts[:instrumenting] || false)
@@ -100,7 +110,7 @@ module Middleman
           added_and_modified = (modified + added)
 
           # See if the changed file is config.rb or lib/*.rb
-          if needs_to_reload?(added_and_modified) || needs_to_reload?(removed)
+          if needs_to_reload?(added_and_modified + removed)
             reload
           else
             added_and_modified.each do |path|
@@ -148,7 +158,7 @@ module Middleman
 
         begin
           ::WEBrick::HTTPServer.new(http_opts)
-        rescue Errno::EADDRINUSE => e
+        rescue Errno::EADDRINUSE
           logger.error "== Port #{port} is unavailable. Either close the instance of Middleman already running on #{port} or start this Middleman on a new port with: --port=#{port.to_i+1}"
           exit(1)
         end
@@ -164,7 +174,8 @@ module Middleman
 
         start_file_watcher
 
-        @webrick.mount "/", ::Rack::Handler::WEBrick, app.class.to_rack_app
+        rack_app = app.class.to_rack_app
+        @webrick.mount "/", ::Rack::Handler::WEBrick, rack_app
       end
 
       # Detach the current Middleman::Application instance
@@ -180,8 +191,8 @@ module Middleman
       def needs_to_reload?(paths)
         match_against = [
           %r{^config\.rb},
-          %r{^lib/^[^\.](.*)\.rb$},
-          %r{^helpers/^[^\.](.*)_helper\.rb$}
+          %r{^lib/[^\.](.*)\.rb$},
+          %r{^helpers/[^\.](.*)\.rb$}
         ]
 
         if @options[:reload_paths]

data/lib/middleman-core/profiling.rb

@@ -34,7 +34,7 @@ module Middleman
         begin
           require 'ruby-prof'
         rescue LoadError
-          raise "To use the --profile option, you must 'gem install ruby-prof' (and include it in your Gemfile if running under bundle exec)"
+          raise "To use the --profile option, you must add the 'ruby-prof' gem to your Gemfile"
         end
       end
 

data/lib/middleman-core/renderers/erb.rb

@@ -8,8 +8,8 @@ module Middleman
         # once registered
         def registered(app)
           # Setup a default ERb engine
-          app.set :erb_engine, :erb
-          app.set :erb_engine_prefix, ::Tilt
+          app.config.define_setting :erb_engine, :erb, 'The engine to use for rendering ERb templates'
+          app.config.define_setting :erb_engine_prefix, ::Tilt, 'The parent module for ERb template engines'
 
           app.before_configuration do
             template_extensions :erb => :html
@@ -19,14 +19,14 @@ module Middleman
           app.after_configuration do
             # Find the user's prefered engine
             # Convert symbols to classes
-            if erb_engine.is_a? Symbol
+            if config[:erb_engine].is_a? Symbol
               engine = engine.to_s
               engine = engine == "erb" ? "ERB" : engine.camelize
-              erb_engine = erb_engine_prefix.const_get("#{engine}Template")
+              config[:erb_engine] = config[:erb_engine_prefix].const_get("#{engine}Template")
             end
 
             # Tell Tilt to use the preferred engine
-            ::Tilt.prefer(erb_engine)
+            ::Tilt.prefer(config[:erb_engine])
           end
         end
         alias :included :registered

data/lib/middleman-core/renderers/less.rb

@@ -11,15 +11,15 @@ module Middleman
 
         # Once registered
         def registered(app)
-          # Default sass options
-          app.set :less, {}
+          # Default less options
+          app.config.define_setting :less, {}, 'LESS compiler options'
 
           app.before_configuration do
             template_extensions :less => :css
           end
 
           app.after_configuration do
-            ::Less.paths << File.expand_path(css_dir, source_dir)
+            ::Less.paths << File.join(source_dir, config[:css_dir])
           end
 
           # Tell Tilt to use it as well (for inline sass blocks)

data/lib/middleman-core/renderers/markdown.rb

@@ -10,8 +10,8 @@ module Middleman
         # Once registered
         def registered(app)
           # Set our preference for a markdown engine
-          app.set :markdown_engine, :maruku
-          app.set :markdown_engine_prefix, ::Tilt
+          app.config.define_setting :markdown_engine, :kramdown, 'Preferred markdown engine'
+          app.config.define_setting :markdown_engine_prefix, ::Tilt, 'The parent module for markdown template engines'
 
           app.before_configuration do
             template_extensions :markdown => :html,
@@ -26,24 +26,25 @@ module Middleman
 
             begin
               # Look for the user's preferred engine
-              if markdown_engine == :redcarpet
+              if config[:markdown_engine] == :redcarpet
                 require "middleman-core/renderers/redcarpet"
                 ::Tilt.prefer(::Middleman::Renderers::RedcarpetTemplate)
-              elsif !markdown_engine.nil?
+                MiddlemanRedcarpetHTML.middleman_app = self
+              elsif !config[:markdown_engine].nil?
                 # Map symbols to classes
-                markdown_engine_klass = if markdown_engine.is_a? Symbol
-                  engine = markdown_engine.to_s
+                markdown_engine_klass = if config[:markdown_engine].is_a? Symbol
+                  engine = config[:markdown_engine].to_s
                   engine = engine == "rdiscount" ? "RDiscount" : engine.camelize
-                  markdown_engine_prefix.const_get("#{engine}Template")
+                  config[:markdown_engine_prefix].const_get("#{engine}Template")
                 else
-                  markdown_engine_prefix
+                  config[:markdown_engine_prefix]
                 end
 
                 # Tell tilt to use that engine
                 ::Tilt.prefer(markdown_engine_klass)
               end
             rescue LoadError
-              logger.warn "Requested Markdown engine (#{markdown_engine}) not found. Maybe the gem needs to be installed and required?"
+              logger.warn "Requested Markdown engine (#{config[:markdown_engine]}) not found. Maybe the gem needs to be installed and required?"
             end
           end
         end