middleman-core 3.3.2 → 3.3.3

data/lib/middleman-core/cli/server.rb

@@ -1,6 +1,5 @@
 # CLI Module
 module Middleman::Cli
-
   # Server thor task
   class Server < Thor
     check_unknown_options!
@@ -9,54 +8,54 @@ module Middleman::Cli
 
     desc 'server [options]', 'Start the preview server'
     method_option :environment,
-      :aliases => '-e',
-      :default => ENV['MM_ENV'] || ENV['RACK_ENV'] || 'development',
-      :desc    => 'The environment Middleman will run under'
+                  aliases: '-e',
+                  default: ENV['MM_ENV'] || ENV['RACK_ENV'] || 'development',
+                  desc: 'The environment Middleman will run under'
     method_option :host,
-      :type    => :string,
-      :aliases => '-h',
-      :default => '0.0.0.0',
-      :desc    => 'Bind to HOST address'
+                  type: :string,
+                  aliases: '-h',
+                  default: '0.0.0.0',
+                  desc: 'Bind to HOST address'
     method_option :port,
-      :aliases => '-p',
-      :default => '4567',
-      :desc    => 'The port Middleman will listen on'
+                  aliases: '-p',
+                  default: '4567',
+                  desc: 'The port Middleman will listen on'
     method_option :verbose,
-      :type    => :boolean,
-      :default => false,
-      :desc    => 'Print debug messages'
+                  type: :boolean,
+                  default: false,
+                  desc: 'Print debug messages'
     method_option :instrument,
-      :type    => :string,
-      :default => false,
-      :desc    => 'Print instrument messages'
+                  type: :string,
+                  default: false,
+                  desc: 'Print instrument messages'
     method_option :disable_watcher,
-      :type    => :boolean,
-      :default => false,
-      :desc    => 'Disable the file change and delete watcher process'
+                  type: :boolean,
+                  default: false,
+                  desc: 'Disable the file change and delete watcher process'
     method_option :profile,
-      :type    => :boolean,
-      :default => false,
-      :desc    => 'Generate profiling report for server startup'
+                  type: :boolean,
+                  default: false,
+                  desc: 'Generate profiling report for server startup'
     method_option :reload_paths,
-      :type    => :string,
-      :default => false,
-      :desc    => 'Additional paths to auto-reload when files change'
+                  type: :string,
+                  default: false,
+                  desc: 'Additional paths to auto-reload when files change'
     method_option :force_polling,
-      :type    => :boolean,
-      :default => false,
-      :desc    => 'Force file watcher into polling mode'
+                  type: :boolean,
+                  default: false,
+                  desc: 'Force file watcher into polling mode'
     method_option :latency,
-      :type    => :numeric,
-      :aliases => '-l',
-      :default => 0.25,
-      :desc    => 'Set file watcher latency, in seconds'
+                  type: :numeric,
+                  aliases: '-l',
+                  default: 0.25,
+                  desc: 'Set file watcher latency, in seconds'
 
     # Start the server
     def server
       require 'middleman-core'
       require 'middleman-core/preview_server'
 
-      if !ENV['MM_ROOT']
+      unless ENV['MM_ROOT']
         puts '== Could not find a Middleman project config.rb'
         puts '== Treating directory as a static site to be served'
         ENV['MM_ROOT'] = Dir.pwd
@@ -64,15 +63,15 @@ module Middleman::Cli
       end
 
       params = {
-        :port              => options['port'],
-        :host              => options['host'],
-        :environment       => options['environment'],
-        :debug             => options['verbose'],
-        :instrumenting     => options['instrument'],
-        :disable_watcher   => options['disable_watcher'],
-        :reload_paths      => options['reload_paths'],
-        :force_polling     => options['force_polling'],
-        :latency           => options['latency']
+        port: options['port'],
+        host: options['host'],
+        environment: options['environment'],
+        debug: options['verbose'],
+        instrumenting: options['instrument'],
+        disable_watcher: options['disable_watcher'],
+        reload_paths: options['reload_paths'],
+        force_polling: options['force_polling'],
+        latency: options['latency']
       }
 
       puts '== The Middleman is loading'
@@ -85,5 +84,5 @@ module Middleman::Cli
   end
 
   # Map "s" to "server"
-  Base.map({ 's' => 'server' })
+  Base.map('s' => 'server')
 end

data/lib/middleman-core/configuration.rb

@@ -39,7 +39,7 @@ module Middleman
         end
 
         # Needed so that method_missing makes sense
-        def respond_to?(method, include_private = false)
+        def respond_to?(method, include_private=false)
           super || config.defines_setting?(method)
         end
       end
@@ -53,7 +53,7 @@ module Middleman
       # @deprecated Prefer accessing settings through "config".
       #
       # @return [ConfigurationManager]
-      alias :settings :config
+      alias_method :settings, :config
 
       # Set attributes (global variables)
       #
@@ -80,7 +80,7 @@ module Middleman
       end
 
       # Needed so that method_missing makes sense
-      def respond_to?(method, include_private = false)
+      def respond_to?(method, include_private=false)
         super || config.defines_setting?(method)
       end
     end
@@ -111,16 +111,17 @@ module Middleman
       # Get the value of a setting by key. Returns nil if there is no such setting.
       # @return [Object]
       def [](key)
-        setting = @settings[key]
-        setting ? setting.value : nil
+        setting_obj = setting(key)
+        setting_obj ? setting_obj.value : nil
       end
 
       # 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 = @settings[key] || define_setting(key)
-        setting.value = val
+        setting_obj = setting(key) || define_setting(key)
+        setting_obj.value = val
       end
 
       # Allow configuration settings to be read and written via methods
@@ -135,7 +136,7 @@ module Middleman
       end
 
       # Needed so that method_missing makes sense
-      def respond_to?(method, include_private = false)
+      def respond_to?(method, include_private=false)
         super || defines_setting?(method) || (method =~ /^(\w+)=$/ && defines_setting?($1))
       end
 
@@ -143,7 +144,7 @@ module Middleman
       # @param [Symbol] key
       # @return [Boolean]
       def defines_setting?(key)
-        @settings.has_key?(key)
+        @settings.key?(key)
       end
 
       # Define a new setting, with optional default and user-friendly description.
@@ -155,7 +156,7 @@ module Middleman
       # @return [ConfigSetting]
       def define_setting(key, default=nil, description=nil)
         raise "Setting #{key} doesn't exist" if @finalized
-        raise "Setting #{key} already defined" if @settings.has_key?(key)
+        raise "Setting #{key} already defined" if @settings.key?(key)
         raise 'Setting key must be a Symbol' unless key.is_a? Symbol
 
         @settings[key] = ConfigSetting.new(key, default, description)
@@ -170,7 +171,7 @@ module Middleman
 
       # Deep duplicate of the configuration manager
       def dup
-        ConfigurationManager.new.tap {|c| c.load_settings(self.all_settings) }
+        ConfigurationManager.new.tap { |c| c.load_settings(all_settings) }
       end
 
       # Load in a list of settings
@@ -227,6 +228,7 @@ module Middleman
       end
 
       # Whether or not there has been a value set beyond the default
+      # rubocop:disable TrivialAccessors
       def value_set?
         @value_set
       end

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

@@ -1,10 +1,8 @@
 module Middleman
   module CoreExtensions
-
     # The data extension parses YAML and JSON files in the data/ directory
     # and makes them available to config.rb, templates and extensions
     module Data
-
       # Extension registered
       class << self
         # @private
@@ -16,7 +14,7 @@ module Middleman
           app.config.define_setting :data_dir, 'data', 'The directory data files are stored in'
           app.send :include, InstanceMethods
         end
-        alias :included :registered
+        alias_method :included, :registered
       end
 
       # Instance methods
@@ -24,12 +22,12 @@ module Middleman
         # Setup data files before anything else so they are available when
         # parsing config.rb
         def initialize
-          self.files.changed DataStore.matcher do |file|
-            self.data.touch_file(file) if file.start_with?("#{config[:data_dir]}/")
+          files.changed DataStore.matcher do |file|
+            data.touch_file(file) if file.start_with?("#{config[:data_dir]}/")
           end
 
-          self.files.deleted DataStore.matcher do |file|
-            self.data.remove_file(file) if file.start_with?("#{config[:data_dir]}/")
+          files.deleted DataStore.matcher do |file|
+            data.remove_file(file) if file.start_with?("#{config[:data_dir]}/")
           end
 
           super
@@ -45,10 +43,8 @@ module Middleman
 
       # The core logic behind the data extension.
       class DataStore
-
         # Static methods
         class << self
-
           # The regex which tells Middleman which files are for data
           #
           # @return [Regexp]
@@ -137,7 +133,7 @@ module Middleman
             data_branch = data_branch[dir]
           end
 
-          data_branch.delete(basename) if data_branch.has_key?(basename)
+          data_branch.delete(basename) if data_branch.key?(basename)
         end
 
         # Get a hash from either internal static data or a callback
@@ -147,13 +143,10 @@ module Middleman
         def data_for_path(path)
           response = nil
 
-          @@local_sources ||= {}
-          @@callback_sources ||= {}
-
-          if self.store.has_key?(path.to_s)
-            response = self.store[path.to_s]
-          elsif self.callbacks.has_key?(path.to_s)
-            response = self.callbacks[path.to_s].call()
+          if store.key?(path.to_s)
+            response = store[path.to_s]
+          elsif callbacks.key?(path.to_s)
+            response = callbacks[path.to_s].call
           end
 
           response
@@ -164,22 +157,19 @@ module Middleman
         # @param [String] path The namespace to search for
         # @return [Hash, nil]
         def method_missing(path)
-          if @local_data.has_key?(path.to_s)
+          if @local_data.key?(path.to_s)
             return @local_data[path.to_s]
           else
             result = data_for_path(path)
-
-            if result
-              return ::Middleman::Util.recursively_enhance(result)
-            end
+            return ::Middleman::Util.recursively_enhance(result) if result
           end
 
           super
         end
 
         # Needed so that method_missing makes sense
-        def respond_to?(method, include_private = false)
-          super || has_key?(method)
+        def respond_to?(method, include_private=false)
+          super || key?(method)
         end
 
         # Make DataStore act like a hash. Return requested data, or
@@ -188,24 +178,26 @@ module Middleman
         # @param [String, Symbol] key The name of the data namespace
         # @return [Hash, nil]
         def [](key)
-          __send__(key) if has_key?(key)
+          __send__(key) if key?(key)
         end
 
-        def has_key?(key)
-          @local_data.has_key?(key.to_s) || !!(data_for_path(key))
+        def key?(key)
+          @local_data.key?(key.to_s) || data_for_path(key)
         end
 
+        alias_method :has_key?, :key?
+
         # Convert all the data into a static hash
         #
         # @return [Hash]
         def to_h
           data = {}
 
-          self.store.each do |k, v|
+          store.each do |k, _|
             data[k] = data_for_path(k)
           end
 
-          self.callbacks.each do |k, v|
+          callbacks.each do |k, _|
             data[k] = data_for_path(k)
           end
 

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

@@ -32,7 +32,6 @@
 module Middleman
   module CoreExtensions
     module Extensions
-
       # Register extension
       class << self
         # @private
@@ -49,9 +48,9 @@ module Middleman
 
           app.extend ClassMethods
           app.send :include, InstanceMethods
-          app.delegate :configure, :to => :"self.class"
+          app.delegate :configure, to: :"self.class"
         end
-        alias :included :registered
+        alias_method :included, :registered
       end
 
       # Class methods
@@ -75,7 +74,7 @@ module Middleman
           else
             extend extension
             if extension.respond_to?(:registered)
-              if extension.method(:registered).arity === 1
+              if extension.method(:registered).arity == 1
                 extension.registered(self, &block)
               else
                 extension.registered(self, options, &block)
@@ -96,6 +95,7 @@ module Middleman
         #
         # @param [Symbol, Module] ext Which extension to activate
         # @return [void]
+        # rubocop:disable BlockNesting
         def activate(ext, options={}, &block)
           ext_module = if ext.is_a?(Module)
             ext
@@ -157,7 +157,7 @@ module Middleman
 
           # Check for and evaluate local configuration
           local_config = File.join(root, 'config.rb')
-          if File.exists? local_config
+          if File.exist? local_config
             logger.debug '== Reading:  Local config'
             instance_eval File.read(local_config), local_config, 1
           end
@@ -172,16 +172,16 @@ module Middleman
           # polluted with paths from other test app directories that don't
           # exist anymore.
           if ENV['TEST']
-            ::I18n.load_path.delete_if {|path| path =~ %r{tmp/aruba}}
+            ::I18n.load_path.delete_if { |path| path =~ %r{tmp/aruba} }
             ::I18n.reload!
           end
 
           run_hook :after_configuration
 
           logger.debug 'Loaded extensions:'
-          self.extensions.each do |ext, klass|
+          extensions.each do |ext, klass|
             if ext.is_a?(Hash)
-              ext.each do |k,_|
+              ext.each do |k, _|
                 logger.debug "== Extension: #{k}"
               end
             else

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

@@ -2,16 +2,14 @@
 module Middleman
   module CoreExtensions
     module ExternalHelpers
-
       # Setup extension
       class << self
-
         # once registered
         def registered(app)
           # Setup a default helpers paths
           app.config.define_setting :helpers_dir, 'helpers', 'Directory to autoload helper modules from'
           app.config.define_setting :helpers_filename_glob, '**.rb', 'Glob pattern for matching helper ruby files'
-          app.config.define_setting :helpers_filename_to_module_name_proc, Proc.new { |filename|
+          app.config.define_setting :helpers_filename_to_module_name_proc, proc { |filename|
             basename = File.basename(filename, File.extname(filename))
             basename.camelcase
           }, 'Proc implementing the conversion from helper filename to module name'
@@ -19,7 +17,7 @@ module Middleman
           # After config
           app.after_configuration do
             helpers_path = File.join(root, config[:helpers_dir])
-            next unless File.exists?(helpers_path)
+            next unless File.exist?(helpers_path)
 
             Dir[File.join(helpers_path, config[:helpers_filename_glob])].each do |filename|
               module_name = config[:helpers_filename_to_module_name_proc].call(filename)
@@ -32,7 +30,7 @@ module Middleman
             end
           end
         end
-        alias :included :registered
+        alias_method :included, :registered
       end
     end
   end

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

@@ -5,7 +5,6 @@ require 'set'
 module Middleman
   module CoreExtensions
     module FileWatcher
-
       IGNORE_LIST = [
         /^bin(\/|$)/,
         /^\.bundle(\/|$)/,
@@ -26,7 +25,6 @@ module Middleman
 
       # Setup extension
       class << self
-
         # Once registered
         def registered(app)
           app.send :include, InstanceMethods
@@ -47,12 +45,11 @@ module Middleman
             files.reload_path('.')
           end
         end
-        alias :included :registered
+        alias_method :included, :registered
       end
 
       # Instance methods
       module InstanceMethods
-
         # Access the file api
         # @return [Middleman::CoreExtensions::FileWatcher::API]
         def files
@@ -62,10 +59,9 @@ module Middleman
 
       # Core File Change API class
       class API
-
         attr_reader :app
         attr_reader :known_paths
-        delegate :logger, :to => :app
+        delegate :logger, to: :app
 
         # Initialize api and internal path cache
         def initialize(app)
@@ -102,7 +98,7 @@ module Middleman
           path = Pathname(path)
           logger.debug "== File Change: #{path}"
           @known_paths << path
-          self.run_callbacks(path, :changed)
+          run_callbacks(path, :changed)
         end
 
         # Notify callbacks that a file was deleted
@@ -113,7 +109,7 @@ module Middleman
           path = Pathname(path)
           logger.debug "== File Deletion: #{path}"
           @known_paths.delete(path)
-          self.run_callbacks(path, :deleted)
+          run_callbacks(path, :deleted)
         end
 
         # Manually trigger update events
@@ -151,7 +147,7 @@ module Middleman
 
         def exists?(path)
           p = Pathname(path)
-          p = p.relative_path_from(Pathname(@app.root)) if !p.relative?
+          p = p.relative_path_from(Pathname(@app.root)) unless p.relative?
           @known_paths.include?(p)
         end
 
@@ -163,7 +159,7 @@ module Middleman
           app.config[:file_watcher_ignore].any? { |r| path =~ r }
         end
 
-      protected
+        protected
 
         # Notify callbacks for a file given an array of callbacks
         #
@@ -172,7 +168,7 @@ module Middleman
         # @return [void]
         def run_callbacks(path, callbacks_name)
           path = path.to_s
-          self.send(callbacks_name).each do |callback, matcher|
+          send(callbacks_name).each do |callback, matcher|
             next unless matcher.nil? || path.match(matcher)
             @app.instance_exec(path, &callback)
           end