middleman-core 4.0.0.beta.2 → 4.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e102996c549a19735369428a6ca1fb6d2d9a735b
-  data.tar.gz: bd3b7074ef91dbef4d80491e1b67c41117ff0699
+  metadata.gz: 71268bae4249190ca97e9b59b2f57fcbabe51640
+  data.tar.gz: 0d27c4d829aff2c5d2a9683d92e41a36c7dfbfd6
 SHA512:
-  metadata.gz: 52f6338f6da3da3c1f113826597376f95f0bf7948f6f01a512a924949eb9f8efc7784f4a082f6f32b3892e9f88d3ad6258e662ac297f14bf0b98547faaea2909
-  data.tar.gz: 44a55d6fcff77e9136d7701b15cfe4104eae02de1dc1f8d73698f02eddb5a5a089f2c201a7c2d36e680df845f2550edc9c6aa171258c61271856732fdb9fad32
+  metadata.gz: 7f09e7350b658d6734deaa92725ad54604fedb9e85ebc0d8d8b993b521625063fadca6fdc0a2053b29280cb5a328b7cd1f3cf3c8ddd84a208214891accc771c5
+  data.tar.gz: 63db8645b7888f204e71a0a19ca8d9a9dc2f1dee8d315100e4756969f58965a9362ee4e26562940d63d78e9bea0e7b234dbd5c60c4eac19b354ad0cf6a1e66ab

data/features/builder.feature

@@ -46,4 +46,12 @@ Feature: Builder
   Scenario: Build alias (b)
     Given a fixture app "large-build-app"
     When I run `middleman b`
-    Then was successfully built
+    Then was successfully built
+
+  Scenario: Builded text file(ex: html, css, xml, txt)'s permission is 0644
+    Given a successfully built app at "large-build-app"
+    When I cd to "build"
+    Then the mode of filesystem object "index.html" should match "0644"
+    And the mode of filesystem object "stylesheets/static.css" should match "0644"
+    And the mode of filesystem object "feed.xml" should match "0644"
+    And the mode of filesystem object ".htaccess" should match "0644"

data/features/collections.feature

@@ -98,7 +98,7 @@ Feature: Collections
     And a file named "source/index.html.erb" with:
       """
       <% collection(:articles).each do |article| %>
-        Article: <%= article.data.title || article.source_file[:relative_path] %>
+        Article: <%= article.data.title || article.file_descriptor[:relative_path] %>
       <% end %>
       """
     Given the Server is running at "collections-app"
@@ -192,4 +192,45 @@ Feature: Collections
     Then I should see 'Newer Article Content'
     When I go to "2.html"
     Then I should see 'Again'
-    
+
+  Scenario: Arbitrary live datasets
+    Given a fixture app "collections-app"
+    And a file named "config.rb" with:
+      """
+      live {
+        Dir["descriptions/*.txt"]
+      }.each do |description_name|
+        base = File.basename(description_name, '.txt')
+        proxy "#{base}.html", "/description_template.html", locals: {
+          contents: File.read(description_name)
+        }, ignore: true
+      end
+      """
+    And a file named "source/description_template.html.erb" with:
+      """
+      <%= contents %>
+      """
+    And a file named "descriptions/test1.txt" with:
+      """
+      Test1
+      """
+    Given the Server is running at "collections-app"
+    When I go to "test1.html"
+    Then I should see 'Test1'
+    When I go to "test2.html"
+    Then I should see 'Not Found'
+
+    When the file "descriptions/test2.txt" has the contents
+      """
+      Test2
+      """
+    When I go to "test1.html"
+    Then I should see 'Test1'
+    When I go to "test2.html"
+    Then I should see 'Test2'
+
+    When the file "descriptions/test1.txt" is removed
+    When I go to "test1.html"
+    Then I should see 'Not Found'
+    When I go to "test2.html"
+    Then I should see 'Test2'

data/features/data.feature

@@ -51,3 +51,10 @@ Feature: Local Data API
     Then I should see "title1:Hello"
     Then I should see "title2:More"
     Then I should see "title3:Stuff"
+
+  Scenario: Using data postscript
+    Given the Server is running at "nested-data-app"
+    When I go to "/extracontent.html"
+    Then I should see "<h1>With Content</h1>"
+    Then I should see '<h2 id="header-2">Header 2</h2>'
+    Then I should see "<p>Paragraph 1</p>"

data/features/extension_hooks.feature

@@ -0,0 +1,13 @@
+Feature: Extension author could use some hooks
+
+  Scenario: When build
+    Given a fixture app "extension-hooks-app"
+    When I run `middleman build`
+    Then the exit status should be 0
+    And the output should contain "/// after_configuration ///"
+    And the output should contain "/// ready ///"
+    And the output should contain "/// before_build ///"
+    And the output should contain "/// before ///"
+    And the output should contain "/// before_render ///"
+    And the output should contain "/// after_render ///"
+    And the output should contain "/// after_build ///"

data/features/front-matter-neighbor.feature

@@ -30,17 +30,6 @@ Feature: Neighboring YAML Front Matter
     Then I should not see "---"
     When I go to "/front-matter-encoding.html.erb.frontmatter"
     Then I should see "File Not Found"
-    
-  Scenario: Rendering html (json)
-    Given the Server is running at "frontmatter-neighbor-app"
-    When I go to "/json-front-matter.html.erb.frontmatter"
-    Then I should see "File Not Found"
-    When I go to "/json-front-matter-2.php"
-    Then I should see "<h1>This is the title</h1>"
-    Then I should see "<?php"
-    Then I should not see ";;;"
-    When I go to "/json-front-matter-2.php.erb.frontmatter"
-    Then I should see "File Not Found"
 
   Scenario: A template changes frontmatter during preview
     Given the Server is running at "frontmatter-neighbor-app"

data/features/front-matter.feature

@@ -40,28 +40,6 @@ Feature: YAML Front Matter
     When I go to "/front-matter-encoding.html"
     Then I should see "<h1>This is the title</h1>"
     Then I should not see "---"
-    
-  Scenario: Rendering html (json)
-    Given the Server is running at "frontmatter-app"
-    When I go to "/json-front-matter.html"
-    Then I should see "<h1>This is the title</h1>"
-    Then I should not see ";;;"
-    When I go to "/json-front-matter-2.php"
-    Then I should see "<h1>This is the title</h1>"
-    Then I should see "<?php"
-    Then I should not see ";;;"
-
-  Scenario: JSON not on first line, no encoding
-    Given the Server is running at "frontmatter-app"
-    When I go to "/json-front-matter-line-2.html"
-    Then I should see "<h1></h1>"
-    Then I should see ";;;"
-    
-  Scenario: JSON not on first line, with encoding
-    Given the Server is running at "frontmatter-app"
-    When I go to "/json-front-matter-encoding.html"
-    Then I should see "<h1>This is the title</h1>"
-    Then I should not see ";;;"
 
   Scenario: A template changes frontmatter during preview
     Given the Server is running at "frontmatter-app"

data/features/markdown_kramdown_in_slim.feature

@@ -0,0 +1,42 @@
+Feature: Markdown support in Slim (Kramdown)
+  In order to test support of the Slim markdown filter
+
+  Scenario: Markdown filter in Slim works (with Kramdown)
+    Given a fixture app "markdown-in-slim-app"
+    And a file named "config.rb" with:
+      """
+      set :markdown_engine, :kramdown
+      activate :directory_indexes
+      """
+    And a file named "source/markdown_filter.html.slim" with:
+      """
+      markdown:
+        # H1
+
+        paragraph
+      """
+    Given the Server is running at "markdown-in-slim-app"
+    When I go to "/markdown_filter/"
+    Then I should see ">H1</h1>"
+    Then I should see "<p>paragraph</p>"
+
+
+  Scenario: Markdown filter in Slim uses our link_to and image_tag helpers (with Kramdown)
+    Given a fixture app "markdown-in-slim-app"
+    And a file named "config.rb" with:
+      """
+      set :markdown_engine, :kramdown
+      activate :directory_indexes
+      """
+    And a file named "source/link_and_image.html.slim" with:
+      """
+      markdown:
+        [A link](/link_target.html)
+
+        ![image](blank.gif){: srcset="image_2x.jpg 2x"}
+      """
+    Given the Server is running at "markdown-in-slim-app"
+    When I go to "/link_and_image/"
+    Then I should see "/link_target/"
+    Then I should see "/images/image_2x.jpg 2x"
+    Then I should see 'src="/images/blank.gif"'

data/fixtures/extension-hooks-app/config.rb

@@ -0,0 +1,39 @@
+set :layout, false
+
+class MyFeature < Middleman::Extension
+  def initialize(app, options_hash = {}, &block)
+    super
+
+    app.before do
+      puts '/// before ///'
+    end
+
+    app.ready do
+      puts '/// ready ///'
+    end
+
+    app.before_render do |body, path, locs, template_class|
+      puts "/// before_render ///"
+    end
+
+    app.after_render do |content, path, locs, template_class|
+      puts "/// after_render ///"
+    end
+
+    app.before_build do |builder|
+      puts "/// before_build ///"
+    end
+
+    app.after_build do |builder|
+      puts "/// after_build ///"
+    end
+  end
+
+  def after_configuration
+    puts '/// after_configuration ///'
+  end
+end
+
+::Middleman::Extensions.register(:my_feature, MyFeature)
+
+activate :my_feature

data/fixtures/extension-hooks-app/source/index.html.erb

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>extension-hooks-app</title>
+  </head>
+  <body>
+    <h1>extension-hooks-app</h1>
+  </body>
+</html>

data/fixtures/frontmatter-app/source/front-matter-line-2.html.erb

@@ -1,7 +1,10 @@
 <h2> Test</h2>
+
+<h1><%= current_page.data.title %></h1>
+
 ---
 layout: false
 title: This is the title
 ---
 
-<h1><%= current_page.data.title %></h1>
+<div>Stuff</div>

data/fixtures/frontmatter-neighbor-app/config.rb

@@ -7,15 +7,15 @@ class NeighborFrontmatter < ::Middleman::Extension
 
   def manipulate_resource_list(resources)
     resources.each do |resource|
-      next unless resource.source_file
+      next unless resource.file_descriptor
 
-      neighbor = "#{resource.source_file[:relative_path]}.frontmatter"
+      neighbor = "#{resource.file_descriptor[:relative_path]}.frontmatter"
 
       file = app.files.find(:source, neighbor)
 
       next unless file
 
-      fmdata = app.extensions[:front_matter].frontmatter_and_content(file[:full_path]).first
+      fmdata = ::Middleman::Util::Data.parse(file[:full_path], :yaml).first
       opts = fmdata.extract!(:layout, :layout_engine, :renderer_options, :directory_index, :content_type)
       opts[:renderer_options].symbolize_keys! if opts.key?(:renderer_options)
       ignored = fmdata.delete(:ignored)

data/fixtures/frontmatter-settings-neighbor-app/config.rb

@@ -12,12 +12,12 @@ class NeighborFrontmatter < ::Middleman::Extension
 
   def manipulate_resource_list(resources)
     resources.each do |resource|
-      next unless resource.source_file
-      next if resource.source_file[:relative_path].extname == '.frontmatter'
+      next unless resource.file_descriptor
+      next if resource.file_descriptor[:relative_path].extname == '.frontmatter'
 
       [
         "#{resource.url.sub(/^\//, '')}.frontmatter",
-        "#{resource.source_file[:relative_path]}.frontmatter"
+        "#{resource.file_descriptor[:relative_path]}.frontmatter"
       ].each do |n|
         file = app.files.find(:source, n)
         apply_neighbor_data(resource, file) if file
@@ -26,7 +26,7 @@ class NeighborFrontmatter < ::Middleman::Extension
   end
 
   def apply_neighbor_data(resource, file)
-    fmdata = app.extensions[:front_matter].frontmatter_and_content(file[:full_path]).first
+    fmdata = ::Middleman::Util::Data.parse(file[:full_path], :yaml).first
     opts = fmdata.extract!(:layout, :layout_engine, :renderer_options, :directory_index, :content_type)
     opts[:renderer_options].symbolize_keys! if opts.key?(:renderer_options)
     ignored = fmdata.delete(:ignored)

data/fixtures/markdown-in-slim-app/source/link_target.html.markdown

@@ -0,0 +1,4 @@
+---
+layout: false
+---
+Hello World

data/fixtures/more-traversal-app/source/layout.erb

@@ -1,6 +1,6 @@
 Path: <%= current_page.path %>
 
-Source: <%= current_page.source_file[:full_path].sub(root + "/", "") %>
+Source: <%= current_page.file_descriptor[:full_path].sub(root + "/", "") %>
 
 <% if current_page.parent %>
   Parent: <%= current_page.parent.path %>

data/fixtures/nested-data-app/data/examples/withcontent.yaml

@@ -0,0 +1,11 @@
+---
+name: "With Content"
+---
+
+## Header 2
+
+Paragraph 1
+
+Paragraph 2
+
+### Header 3

data/fixtures/nested-data-app/source/extracontent.html.haml.erb

@@ -0,0 +1,4 @@
+%h1= data.examples.withcontent.name
+
+:markdown
+  <%= data.examples.withcontent.postscript.gsub("\n", "\n\s\s") %>

data/fixtures/traversal-app/source/layout.erb

@@ -1,6 +1,6 @@
 Path: <%= current_page.path %>
 
-Source: <%= current_page.source_file[:full_path].sub(root + "/", "") %>
+Source: <%= current_page.file_descriptor[:full_path].sub(root + "/", "") %>
 
 <% if current_page.parent %>
   Parent: <%= current_page.parent.path %>

data/lib/middleman-core/application.rb

@@ -92,13 +92,17 @@ module Middleman
     # @return [String]
     define_setting :source, 'source', 'Name of the source directory'
 
+    # If we should exit before ready event.
+    # @return [Boolean]
+    define_setting :exit_before_ready, false, 'If we should exit before ready event.'
+
     # Middleman mode. Defaults to :server, set to :build by the build process
     # @return [String]
-    define_setting :mode, ((ENV['MM_ENV'] && ENV['MM_ENV'].to_sym) || :server), 'Middleman mode. Defaults to :server'
+    define_setting :mode, :server, 'Middleman mode. Defaults to :server'
 
     # Middleman environment. Defaults to :development
     # @return [String]
-    define_setting :environment, :development, 'Middleman environment. Defaults to :development'
+    define_setting :environment, ((ENV['MM_ENV'] && ENV['MM_ENV'].to_sym) || :development), 'Middleman environment. Defaults to :development'
 
     # Which file should be used for directory indexes
     # @return [String]
@@ -274,7 +278,7 @@ module Middleman
       execute_callbacks(:after_configuration)
 
       # Everything is stable
-      execute_callbacks(:ready)
+      execute_callbacks(:ready) unless config[:exit_before_ready]
     end
 
     # Eval config

data/lib/middleman-core/builder.rb

@@ -130,6 +130,7 @@ module Middleman
       file.binmode
       file.write(contents)
       file.close
+      File.chmod(0644, file)
       file
     end
 
@@ -168,7 +169,7 @@ module Middleman
 
       begin
         if resource.binary?
-          export_file!(output_file, resource.source_file[:full_path])
+          export_file!(output_file, resource.file_descriptor[:full_path])
         else
           response = @rack.get(URI.escape(resource.request_path))
 

data/lib/middleman-core/configuration.rb

@@ -33,7 +33,6 @@ module Middleman
       # Set the value of a setting by key. Creates the setting if it doesn't exist.
       # @param [Symbol] key
       # @param [Object] val
-      # rubocop:disable UselessSetterCall
       def []=(key, val)
         setting_obj = setting(key) || define_setting(key)
         setting_obj.value = val

data/lib/middleman-core/contracts.rb

@@ -18,16 +18,6 @@ if ENV['TEST'] || ENV['CONTRACTS'] == 'true'
       end
     end
 
-    class Frozen < CallableClass
-      def initialize(contract)
-        @contract = contract
-      end
-
-      def valid?(val)
-        (val.frozen? || val.nil? || [::TrueClass, ::FalseClass, ::Fixnum].include?(val.class)) && Contract.valid?(val, @contract)
-      end
-    end
-
     VectorOf = Contracts::CollectionOf::Factory.new(::Hamster::Vector)
     ResourceList = Contracts::ArrayOf[IsA['Middleman::Sitemap::Resource']]
   end

data/lib/middleman-core/core_extensions/collections.rb

@@ -16,12 +16,13 @@ module Middleman
         # gets a chance to modify any new resources that get added.
         self.resource_list_manipulator_priority = 110
 
-        attr_accessor :sitemap_collector, :data_collector, :leaves
+        attr_accessor :leaves
 
         # Expose `resources`, `data`, and `collection` to config.
         expose_to_config resources: :sitemap_collector,
                          data: :data_collector,
-                         collection: :register_collector
+                         collection: :register_collector,
+                         live: :live_collector
 
         # Exposes `collection` to templates
         expose_to_template collection: :collector_value
@@ -39,8 +40,7 @@ module Middleman
           @collectors_by_name = {}
           @values_by_name = {}
 
-          @sitemap_collector = LazyCollectorRoot.new(self)
-          @data_collector = LazyCollectorRoot.new(self)
+          @collector_roots = []
         end
 
         def before_configuration
@@ -52,6 +52,28 @@ module Middleman
           @collectors_by_name[label] = endpoint
         end
 
+        Contract LazyCollectorRoot
+        def sitemap_collector
+          live_collector { |_, resources| resources }
+        end
+
+        Contract LazyCollectorRoot
+        def data_collector
+          live_collector { |app, _| app.data }
+        end
+
+        Contract Proc => LazyCollectorRoot
+        def live_collector(&block)
+          root = LazyCollectorRoot.new(self)
+
+          @collector_roots << {
+            root: root,
+            block: block
+          }
+
+          root
+        end
+
         Contract Symbol => Any
         def collector_value(label)
           @values_by_name[label]
@@ -59,8 +81,10 @@ module Middleman
 
         Contract ResourceList => ResourceList
         def manipulate_resource_list(resources)
-          @sitemap_collector.realize!(resources)
-          @data_collector.realize!(app.data)
+          @collector_roots.each do |pair|
+            dataset = pair[:block].call(app, resources)
+            pair[:root].realize!(dataset)
+          end
 
           ctx = StepContext.new
           leaves = @leaves.dup

data/lib/middleman-core/core_extensions/data.rb

@@ -1,6 +1,5 @@
-require 'yaml'
-require 'active_support/json'
 require 'middleman-core/contracts'
+require 'middleman-core/util/data'
 
 module Middleman
   module CoreExtensions
@@ -100,9 +99,10 @@ module Middleman
           basename  = File.basename(data_path, extension)
 
           if %w(.yaml .yml).include?(extension)
-            data = ::YAML.load_file(file[:full_path])
+            data, postscript = ::Middleman::Util::Data.parse(file[:full_path], :yaml)
+            data[:postscript] = postscript if !postscript.nil? && data.is_a?(Hash)
           elsif extension == '.json'
-            data = ::ActiveSupport::JSON.decode(file[:full_path].read)
+            data, _postscript = ::Middleman::Util::Data.parse(file[:full_path], :json)
           else
             return
           end

data/lib/middleman-core/core_extensions/file_watcher.rb

@@ -30,7 +30,7 @@ module Middleman
         # Setup source collection.
         @sources = ::Middleman::Sources.new(app,
                                             disable_watcher: app.config[:watcher_disable],
-                                            force_polling: app.config[:force_polling],
+                                            force_polling: app.config[:watcher_force_polling],
                                             latency: app.config[:watcher_latency])
 
         # Add default ignores.