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

data/lib/middleman-core/sitemap/store.rb

@@ -1,6 +1,7 @@
 # Used for merging results of metadata callbacks
 require 'active_support/core_ext/hash/deep_merge'
 require 'monitor'
+require 'hamster'
 
 # Ignores
 Middleman::Extensions.register :sitemap_ignore, auto_activate: :before_configuration do
@@ -37,6 +38,8 @@ require 'middleman-core/contracts'
 module Middleman
   # Sitemap namespace
   module Sitemap
+    ManipulatorDescriptor = Struct.new :name, :manipulator, :priority, :custom_name
+
     # The Store class
     #
     # The Store manages a collection of Resource objects, which represent
@@ -46,20 +49,21 @@ module Middleman
     class Store
       include Contracts
 
-      # @return [Middleman::Application]
+      Contract IsA['Middleman::Application']
       attr_reader :app
 
+      Contract Num
       attr_reader :update_count
 
       # Initialize with parent app
       # @param [Middleman::Application] app
+      Contract IsA['Middleman::Application'] => Any
       def initialize(app)
         @app = app
         @resources = []
         @update_count = 0
 
-        # TODO: Should this be a set or hash?
-        @resource_list_manipulators = []
+        @resource_list_manipulators = ::Hamster.vector
         @needs_sitemap_rebuild = true
 
         @lock = Monitor.new
@@ -76,24 +80,29 @@ module Middleman
       # @param [Numeric] priority Sets the order of this resource list manipulator relative to the rest. By default this is 50, and manipulators run in the order they are registered, but if a priority is provided then this will run ahead of or behind other manipulators.
       # @param [Symbol] custom_name The method name to execute.
       # @return [void]
-      Contract Symbol, RespondTo['manipulate_resource_list'], Maybe[Num], Maybe[Symbol] => Any
+      Contract Symbol, RespondTo[:manipulate_resource_list], Maybe[Num], Maybe[Symbol] => Any
       def register_resource_list_manipulator(name, manipulator, priority=50, custom_name=nil)
         # The third argument used to be a boolean - handle those who still pass one
         priority = 50 unless priority.is_a? Numeric
-        @resource_list_manipulators << [name, manipulator, priority, custom_name]
+        @resource_list_manipulators = @resource_list_manipulators.push(
+          ManipulatorDescriptor.new(name, manipulator, priority, custom_name)
+        )
+
         # The index trick is used so that the sort is stable - manipulators with the same priority
         # will always be ordered in the same order as they were registered.
         n = 0
         @resource_list_manipulators = @resource_list_manipulators.sort_by do |m|
           n += 1
-          [m[2], n]
+          [m[:priority], n]
         end
+
         rebuild_resource_list!(:registered_new)
       end
 
       # Rebuild the list of resources from scratch, using registed manipulators
       # @return [void]
-      def rebuild_resource_list!(_=nil)
+      Contract Maybe[Symbol] => Any
+      def rebuild_resource_list!(_name=nil)
         @lock.synchronize do
           @needs_sitemap_rebuild = true
         end
@@ -178,11 +187,13 @@ module Middleman
 
           @app.logger.debug '== Rebuilding resource list'
 
-          @resources = @resource_list_manipulators.reduce([]) do |result, (_, manipulator, _, custom_name)|
-            newres = manipulator.send(custom_name || :manipulate_resource_list, result)
+          @resources = @resource_list_manipulators.reduce([]) do |result, m|
+            newres = m[:manipulator].send(m[:custom_name] || :manipulate_resource_list, result)
 
             # Reset lookup cache
             reset_lookup_cache!
+
+            # Rebuild cache
             newres.each do |resource|
               @_lookup_by_path[resource.path] = resource
               @_lookup_by_destination_path[resource.destination_path] = resource

data/lib/middleman-core/sources.rb

@@ -1,3 +1,4 @@
+require 'hamster'
 require 'middleman-core/contracts'
 require 'backports/2.0.0/enumerable/lazy'
 
@@ -47,10 +48,10 @@ module Middleman
       @options = options
 
       # Set of procs wanting to be notified of changes
-      @on_change_callbacks = []
+      @on_change_callbacks = ::Hamster.vector
 
       # Global ignores
-      @ignores = {}
+      @ignores = ::Hamster.hash
 
       # Whether we're "running", which means we're in a stable
       # watch state after all initialization and config.
@@ -72,7 +73,8 @@ module Middleman
     # @return [void]
     Contract Symbol, Symbol, Or[Regexp, Proc] => Any
     def ignore(name, type, regex=nil, &block)
-      @ignores[name] = { type: type, validator: (block_given? ? block : regex) }
+      @ignores = @ignores.put(name, type: type,
+                                    validator: (block_given? ? block : regex))
 
       bump_count
       find_new_files! if @running
@@ -238,11 +240,10 @@ module Middleman
     # Add callback to be run on file change or deletion
     #
     # @param [Symbol] type The change type.
-    # @return [Set<CallbackDescriptor>]
-    Contract Symbol, Proc => ArrayOf[CallbackDescriptor]
+    # @return [void]
+    Contract Symbol, Proc => Any
     def on_change(type, &block)
-      @on_change_callbacks << CallbackDescriptor.new(type, block)
-      @on_change_callbacks
+      @on_change_callbacks = @on_change_callbacks.push(CallbackDescriptor.new(type, block))
     end
 
     # Backwards compatible change handler.
@@ -328,7 +329,7 @@ module Middleman
     # @param [Set] callback_descriptors The registered callbacks.
     # @param [Array<Middleman::SourceFile>] files The files that were changed.
     # @return [void]
-    Contract ArrayOf[CallbackDescriptor], ArrayOf[SourceFile], ArrayOf[SourceFile] => Any
+    Contract VectorOf[CallbackDescriptor], ArrayOf[SourceFile], ArrayOf[SourceFile] => Any
     def run_callbacks(callback_descriptors, updated_files, removed_files)
       callback_descriptors.each do |callback|
         if callback[:type] == :all
@@ -345,4 +346,4 @@ module Middleman
 end
 
 # And, require the actual default implementation for a watcher.
-require 'middleman-core/sources/source_watcher.rb'
+require 'middleman-core/sources/source_watcher'

data/lib/middleman-core/sources/source_watcher.rb

@@ -1,6 +1,7 @@
 # Watcher Library
 require 'listen'
 require 'middleman-core/contracts'
+require 'middleman-core/contracts'
 require 'backports/2.0.0/enumerable/lazy'
 
 module Middleman
@@ -55,7 +56,8 @@ module Middleman
 
       @listener = nil
 
-      @on_change_callbacks = Set.new
+      @callbacks = ::Middleman::CallbackManager.new
+      @callbacks.install_methods!(self, [:on_change])
 
       @waiting_for_existence = !@directory.exist?
     end
@@ -174,16 +176,6 @@ module Middleman
       listen!
     end
 
-    # Add callback to be run on file change
-    #
-    # @param [Proc] matcher A Regexp to match the change path against
-    # @return [Set<Proc>]
-    Contract Proc => SetOf[Proc]
-    def on_change(&block)
-      @on_change_callbacks << block
-      @on_change_callbacks
-    end
-
     # Work around this bug: http://bugs.ruby-lang.org/issues/4521
     # where Ruby will call to_s/inspect while printing exception
     # messages, which can take a long time (minutes at full CPU)
@@ -237,11 +229,11 @@ module Middleman
                         logger.debug "== Deletion (#{f[:types].inspect}): #{f[:relative_path]}"
                       end
 
-      run_callbacks(
-        @on_change_callbacks,
+      execute_callbacks(:on_change, [
         valid_updates,
-        valid_removes
-      ) unless valid_updates.empty? && valid_removes.empty?
+        valid_removes,
+        self
+      ]) unless valid_updates.empty? && valid_removes.empty?
     end
 
     def add_file_to_cache(f)
@@ -289,17 +281,5 @@ module Middleman
 
       ::Middleman::SourceFile.new(Pathname(relative_path), path, @directory, types)
     end
-
-    # Notify callbacks for a file given an array of callbacks
-    #
-    # @param [Pathname] path The file that was changed
-    # @param [Symbol] callbacks_name The name of the callbacks method
-    # @return [void]
-    Contract Set, ArrayOf[IsA['Middleman::SourceFile']], ArrayOf[IsA['Middleman::SourceFile']] => Any
-    def run_callbacks(callbacks, updated_files, removed_files)
-      callbacks.each do |callback|
-        callback.call(updated_files, removed_files, self)
-      end
-    end
   end
 end

data/lib/middleman-core/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   # Current Version
   # @return [String]
-  VERSION = '4.0.0.beta.1' unless const_defined?(:VERSION)
+  VERSION = '4.0.0.beta.2' unless const_defined?(:VERSION)
 end

data/middleman-core.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |s|
   s.add_dependency('rack', ['>= 1.4.5', '< 2.0'])
   s.add_dependency('tilt', ['~> 1.4.1'])
   s.add_dependency('erubis')
-  s.add_dependency('hooks', ['~> 0.3'])
 
   # Helpers
   s.add_dependency('activesupport', ['~> 4.2.0'])

data/spec/middleman-core/callbacks_spec.rb

@@ -0,0 +1,132 @@
+# require 'spec_helper'
+require 'middleman-core/callback_manager'
+
+describe ::Middleman::CallbackManager do
+  it "adds a simple key" do
+    counters = {
+      test1: 0,
+      test2: 0,
+      test3: 0
+    }
+
+    m = ::Middleman::CallbackManager.new
+    m.add(:test3) { counters[:test3] += 1 }
+    m.add(:test1) { counters[:test1] += 1 }
+    m.add(:test2) { counters[:test2] += 1 }
+    m.add(:test1) { counters[:test1] += 1 }
+    m.add(:test2) { counters[:test2] += 1 }
+    m.add(:test1) { counters[:test1] += 1 }
+    m.add(:test3) { counters[:test3] += 1 }
+
+    m.execute(:test1)
+    m.execute(:test2)
+
+    expect(counters[:test1]).to eq 3
+    expect(counters[:test2]).to eq 2
+    expect(counters[:test3]).to eq 0
+  end
+
+  it "callbacks run in order" do
+    result = []
+
+    m = ::Middleman::CallbackManager.new
+    m.add(:test) { result.push(1) }
+    m.add(:test) { result.push(2) }
+    m.add(:test) { result.push(3) }
+
+    m.execute(:test)
+
+    expect(result.join('')).to eq '123'
+  end
+
+  it "adds a nested key" do
+    counters = {
+      test1: 0,
+      test1a: 0
+    }
+
+    m = ::Middleman::CallbackManager.new
+    m.add([:test1, :a]) { |n| counters[:test1a] += n }
+    m.add(:test1) { counters[:test1] += 1 }
+
+    m.execute([:test1, :a], [2])
+    m.execute([:test1, :b], [5])
+
+    expect(counters[:test1]).to eq 0
+    expect(counters[:test1a]).to eq 2
+  end
+
+  it "works in isolation" do
+    m1 = ::Middleman::CallbackManager.new
+    m2 = ::Middleman::CallbackManager.new
+
+    counters = {
+      test1: 0,
+      test2: 0
+    }
+
+    m1.add(:test1) { |n| counters[:test1] += n }
+    m2.add(:test1) { |n| counters[:test2] += n }
+
+    m1.execute(:test1, [2])
+    m2.execute(:test1, [5])
+    m1.execute(:test2, [20])
+    m2.execute(:test2, [50])
+
+    expect(counters[:test1]).to eq 2
+    expect(counters[:test2]).to eq 5
+  end
+
+  it "installs to arbitrary instances" do
+    instance = Class.new(Object).new
+
+    m = ::Middleman::CallbackManager.new
+    m.install_methods!(instance, [:ready])
+
+    counter = 0
+    instance.ready { |n| counter += n }
+    instance.execute_callbacks(:ready, [2])
+    instance.execute_callbacks(:ready2, [10])
+    instance.execute_callbacks([:ready], [20])
+    instance.execute_callbacks([:ready, :two], [20])
+    expect(counter).to eq 2
+  end
+
+  it "executes in default scope" do
+    instance = Class.new(Object).new
+    m = ::Middleman::CallbackManager.new
+    m.install_methods!(instance, [:ready])
+
+    internal_self = nil
+    instance.ready do
+      internal_self = self
+    end
+
+    instance.execute_callbacks(:ready)
+
+    expect(internal_self) === instance
+  end
+
+  it "executes in custom scope" do
+    instance = Class.new(Object).new
+    m = ::Middleman::CallbackManager.new
+    m.install_methods!(instance, [:ready])
+
+    external_class = Struct.new(:counter, :scope) do
+      def when_ready(n)
+        self[:scope] = self
+        self[:counter] += n
+      end
+    end
+
+    external_instance = external_class.new(0, nil)
+
+    instance.ready(&external_instance.method(:when_ready))
+
+    instance.execute_callbacks(:ready, [5])
+    
+    expect(external_instance[:scope]).to eq external_instance
+    expect(external_instance[:counter]).to eq 5
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-core
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta.1
+  version: 4.0.0.beta.2
 platform: ruby
 authors:
 - Thomas Reynolds
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-02 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,20 +88,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: hooks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -1129,6 +1115,7 @@ files:
 - lib/middleman-core.rb
 - lib/middleman-core/application.rb
 - lib/middleman-core/builder.rb
+- lib/middleman-core/callback_manager.rb
 - lib/middleman-core/cli/server.rb
 - lib/middleman-core/config_context.rb
 - lib/middleman-core/configuration.rb
@@ -1222,6 +1209,7 @@ files:
 - spec/middleman-core/binary_spec/stars.svgz
 - spec/middleman-core/binary_spec/unicode
 - spec/middleman-core/binary_spec/unicode.txt
+- spec/middleman-core/callbacks_spec.rb
 - spec/middleman-core/core_extensions/data_spec.rb
 - spec/middleman-core/util_spec.rb
 - spec/spec_helper.rb