nanoc 4.0.0b1 → 4.0.0b2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90ed92857b63ba5cdfc7ea40b6f8a47d028a9dd4
-  data.tar.gz: 634df8e12745fe703ff012cea92e430a90dc5880
+  metadata.gz: 399486061f80fd3acaf7058ec221d0b401fb6590
+  data.tar.gz: 1f1969bd69c51571a7a66bfd6451b6528f1923ae
 SHA512:
-  metadata.gz: 0fcd435c5cfd92929ce88041689e8ad9cfe370194335a40d70ead941acdb22579a4741d53a3331bf75ff1cf248496233289140d207c0a734893859398b34306c
-  data.tar.gz: 3e19e77f09ae7a5afbc52cfadf2a53f10e267e2c4dba4c436b75b749181ec1972adcf07f4795015074ec799fec2bd7afeaf1b7fbe2afd90b8983c6c0fca0ca8d
+  metadata.gz: f0c41f17f9fc07ad11b41b1ce6541c9be206a737d99d663f19eae58f68de91cfdce4f392848ac54d8835055784415bd33916003f3463cd14581fecd6005a8036
+  data.tar.gz: 13d7891f10c7014e22b731f2b4efc8982cc8dce52c47eb8ec037183cca0637cfb7661580a24dead39cf05085a668a1448257754f0fbce8f29271fe71eb5b3c1e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc (4.0.0b1)
+    nanoc (4.0.0b2)
       cri (~> 2.3)
 
 GEM

data/NEWS.md

@@ -1,6 +1,30 @@
 # nanoc news
 
-## 4.0.0b1 (2015-05-??)
+## 4.0.0b2 (2015-05-23)
+
+Changes:
+
+* Removed `ItemCollectionView#at` (#582)
+* Removed support for calling `ItemCollectionView#[]` with an integer (#582)
+* Renamed `identifier_style` to `identifier_type`, and made its values be `"full"` or `"legacy"` (#593)
+* Renamed `pattern_syntax` to `string_pattern_type`, and made its values be `"glob"` or `"legacy"` (#593)
+* Made `"full"` the default for `identifier_type` (#592, #594)
+* Made `"glob"` the default for `string_pattern_type` (#592)
+* Enabled auto-pruning by default for new sites (#590)
+
+Enhancements:
+
+* Added `--force` to `create-site` command (#580) [David Alexander]
+* Made default Rules file more future-proof (#591)
+
+Fixes:
+
+* Fixed `LayoutCollectionView#[]` documentation (it mentioned items)
+* Fixed `ItemCollectionView#[]` returning an array when passed a regex
+* Fixed an issue with mutable collection views’ `#delete_if` not yielding mutable views
+* Fixed an issue with collection views’ `#find_all` returning entities instead of views
+
+## 4.0.0b1 (2015-05-14)
 
 Changes:
 
@@ -14,7 +38,7 @@ Enhancements:
 * Added `Nanoc::Identifier#without_ext`
 * Made `Nanoc::Identifier#=~` work with a glob
 * Added `Nanoc::LayoutCollectionView#[]`
-* Added `--force` to `create-site` command (#549) [David Alexander]
+* Allowed creation of site in current directory (#549) [David Alexander]
 
 Fixes:
 

data/README.md

@@ -20,4 +20,4 @@ Contributions are greatly appreciated! Consult the [Development guidelines](http
 
 Many thanks to everyone who has contributed to nanoc in one way or another:
 
-Ale Muñoz, Alexander Mankuta, Arnau Siches, Ben Armston, Bil Bas, Brian Candler, Bruno Dufour, Chris Eppstein, Christian Plessl, Colin Barrett, Damien Pollet, Dan Callahan, Daniel Hofstetter, Daniel Mendler, Daniel Wollschlaeger, David Everitt, Dennis Sutch, Devon Luke Buchanan, Dmitry Bilunov, Eric Sunshine, Erik Hollensbe, Fabian Buch, Felix Hanley, Go Maeda, Gregory Pakosz, Grégory Karékinian, Guilherme Garnier, Jack Chu, Jake Benilov, Jasper Van der Jeugt, Jeff Forcier, John Nishinaga, Justin Clift, Justin Hileman, Kevin Lynagh, Louis T., Mathias Bynens, Matt Keveney, Matthew Frazier, Matthias Beyer, Matthias Reitinger, Matthias Vallentin, Michal Cichra, Nelson Chen, Nicky Peeters, Nikhil Marathe, Oliver Byford, Peter Aronoff, Raphael von der Grün, Remko Tronçon, Riley Goodside, Ruben Verborgh, Scott Vokes, Simon South, Spencer Whitt, Stanley Rost, Starr Horne, Stefan Bühler, Stuart Montgomery, Takashi Uchibe, Toon Willems, Tuomas Kareinen, Ursula Kallio, Vincent Driessen, Xavier Shay, Zaiste de Grengolada, Šime Ramov
+Ale Muñoz, Alexander Mankuta, Arnau Siches, Ben Armston, Bil Bas, Brian Candler, Bruno Dufour, Chris Eppstein, Christian Plessl, Colin Barrett, Damien Pollet, Dan Callahan, Daniel Hofstetter, Daniel Mendler, Daniel Wollschlaeger, David Alexander, David Everitt, Dennis Sutch, Devon Luke Buchanan, Dmitry Bilunov, Eric Sunshine, Erik Hollensbe, Fabian Buch, Felix Hanley, Go Maeda, Gregory Pakosz, Grégory Karékinian, Guilherme Garnier, Jack Chu, Jake Benilov, Jasper Van der Jeugt, Jeff Forcier, John Nishinaga, Justin Clift, Justin Hileman, Kevin Lynagh, Louis T., Mathias Bynens, Matt Keveney, Matthew Frazier, Matthias Beyer, Matthias Reitinger, Matthias Vallentin, Michal Cichra, Nelson Chen, Nicky Peeters, Nikhil Marathe, Oliver Byford, Peter Aronoff, Raphael von der Grün, Remko Tronçon, Riley Goodside, Ruben Verborgh, Scott Vokes, Simon South, Spencer Whitt, Stanley Rost, Starr Horne, Stefan Bühler, Stuart Montgomery, Takashi Uchibe, Toon Willems, Tuomas Kareinen, Ursula Kallio, Vincent Driessen, Xavier Shay, Zaiste de Grengolada, Šime Ramov

data/lib/nanoc/base.rb

@@ -9,6 +9,7 @@ module Nanoc
   autoload 'Identifier',           'nanoc/base/source_data/identifier'
 
   autoload 'ConfigView',           'nanoc/base/views/config'
+  autoload 'IdentifiableCollectionView', 'nanoc/base/views/identifiable_collection'
   autoload 'ItemView',             'nanoc/base/views/item'
   autoload 'ItemRepView',          'nanoc/base/views/item_rep'
   autoload 'ItemCollectionView',   'nanoc/base/views/item_collection'
@@ -16,6 +17,7 @@ module Nanoc
   autoload 'LayoutCollectionView', 'nanoc/base/views/layout_collection'
   autoload 'SiteView',             'nanoc/base/views/site'
 
+  autoload 'MutableIdentifiableCollectionView', 'nanoc/base/views/mutable_identifiable_collection'
   autoload 'MutableConfigView',           'nanoc/base/views/mutable_config'
   autoload 'MutableItemView',             'nanoc/base/views/mutable_item'
   autoload 'MutableItemCollectionView',   'nanoc/base/views/mutable_item_collection'
@@ -39,12 +41,12 @@ module Nanoc::Int
   autoload 'PluginRegistry',       'nanoc/base/plugin_registry'
   autoload 'Store',                'nanoc/base/store'
   autoload 'TempFilenameFactory',  'nanoc/base/temp_filename_factory'
+  autoload 'IdentifiableCollection', 'nanoc/base/identifiable_collection'
 
   # Load source data classes
   autoload 'CodeSnippet',          'nanoc/base/source_data/code_snippet'
   autoload 'Configuration',        'nanoc/base/source_data/configuration'
   autoload 'Item',                 'nanoc/base/source_data/item'
-  autoload 'ItemArray',            'nanoc/base/source_data/item_array'
   autoload 'Layout',               'nanoc/base/source_data/layout'
   autoload 'Site',                 'nanoc/base/source_data/site'
 

data/lib/nanoc/base/checksummer.rb

@@ -64,9 +64,7 @@ module Nanoc::Int
           end
 
           digest.update('attributes')
-          attributes = obj.attributes.dup
-          attributes.delete(:file)
-          update(attributes, digest, visited + [obj])
+          update(obj.attributes, digest, visited + [obj])
         else
           data = begin
             Marshal.dump(obj)

data/lib/nanoc/base/compilation/compiler.rb

@@ -159,7 +159,7 @@ module Nanoc::Int
     # @return [void]
     def store
       # Calculate rule memory
-      (reps + layouts).each do |obj|
+      (reps + layouts.to_a).each do |obj|
         rule_memory_store[obj] = rule_memory_calculator[obj]
       end
 
@@ -177,7 +177,7 @@ module Nanoc::Int
     #
     # @return [Nanoc::Int::DependencyTracker] The dependency tracker for this site
     def dependency_tracker
-      dt = Nanoc::Int::DependencyTracker.new(@site.items + @site.layouts)
+      dt = Nanoc::Int::DependencyTracker.new(@site.items.to_a + @site.layouts.to_a)
       dt.compiler = self
       dt
     end
@@ -197,7 +197,7 @@ module Nanoc::Int
     #
     # @api private
     def objects
-      site.items + site.layouts + site.code_snippets +
+      site.items.to_a + site.layouts.to_a + site.code_snippets +
         [site.config, rules_collection]
     end
 

data/lib/nanoc/base/compilation/compiler_dsl.rb

@@ -260,14 +260,14 @@ module Nanoc::Int
 
     # @api private
     def create_pattern(arg)
-      case @config[:pattern_syntax]
+      case @config[:string_pattern_type]
       when 'glob'
         Nanoc::Int::Pattern.from(arg)
-      when nil
+      when 'legacy'
         Nanoc::Int::Pattern.from(identifier_to_regex(arg))
       else
         raise Nanoc::Int::Errors::GenericTrivial,
-          "Invalid pattern_syntax: #{@config[:pattern_syntax]}"
+          "Invalid string_pattern_type: #{@config[:string_pattern_type]}"
       end
     end
 

data/lib/nanoc/base/compilation/item_rep_proxy.rb

@@ -105,7 +105,7 @@ module Nanoc::Int
     end
 
     def use_globs?
-      @compiler.site.config[:pattern_syntax] == 'glob'
+      @compiler.site.config[:string_pattern_type] == 'glob'
     end
   end
 end

data/lib/nanoc/base/core_ext/array.rb

@@ -15,17 +15,6 @@ module Nanoc::ArrayExtensions
     array
   end
 
-  # Returns a new array where all items' keys are recursively converted to
-  # strings by calling {Nanoc::ArrayExtensions#__nanoc_stringify_keys_recursively} or
-  # {Nanoc::HashExtensions#__nanoc_stringify_keys_recursively}.
-  #
-  # @return [Array] The converted array
-  def __nanoc_stringify_keys_recursively
-    reduce([]) do |array, element|
-      array + [element.respond_to?(:__nanoc_stringify_keys_recursively) ? element.__nanoc_stringify_keys_recursively : element]
-    end
-  end
-
   # Freezes the contents of the array, as well as all array elements. The
   # array elements will be frozen using {#__nanoc_freeze_recursively} if they respond
   # to that message, or #freeze if they do not.

data/lib/nanoc/base/core_ext/hash.rb

@@ -17,17 +17,6 @@ module Nanoc::HashExtensions
     hash
   end
 
-  # Returns a new hash where all keys are recursively converted to strings by
-  # calling {Nanoc::ArrayExtensions#__nanoc_stringify_keys_recursively} or
-  # {Nanoc::HashExtensions#__nanoc_stringify_keys_recursively}.
-  #
-  # @return [Hash] The converted hash
-  def __nanoc_stringify_keys_recursively
-    reduce({}) do |hash, (key, value)|
-      hash.merge(key.to_s => value.respond_to?(:__nanoc_stringify_keys_recursively) ? value.__nanoc_stringify_keys_recursively : value)
-    end
-  end
-
   # Freezes the contents of the hash, as well as all hash values. The hash
   # values will be frozen using {#__nanoc_freeze_recursively} if they respond to
   # that message, or #freeze if they do not.

data/lib/nanoc/base/identifiable_collection.rb

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+module Nanoc::Int
+  # @api private
+  class IdentifiableCollection
+    include Enumerable
+
+    extend Forwardable
+
+    def_delegator :@objects, :each
+    def_delegator :@objects, :size
+    def_delegator :@objects, :<<
+    def_delegator :@objects, :concat
+
+    def initialize(config)
+      @config = config
+
+      @objects = []
+    end
+
+    def freeze
+      @objects.freeze
+      build_mapping
+      super
+    end
+
+    def [](arg)
+      case arg
+      when String
+        object_with_identifier(arg) || object_matching_glob(arg)
+      when Regexp
+        @objects.find { |i| i.identifier.to_s =~ arg }
+      else
+        raise ArgumentError, "don’t know how to fetch objects by #{arg.inspect}"
+      end
+    end
+
+    def to_a
+      @objects
+    end
+
+    def empty?
+      @objects.empty?
+    end
+
+    def delete_if(&block)
+      @objects.delete_if(&block)
+    end
+
+    protected
+
+    def object_with_identifier(identifier)
+      if self.frozen?
+        @mapping[identifier.to_s]
+      else
+        @objects.find { |i| i.identifier == identifier }
+      end
+    end
+
+    def object_matching_glob(glob)
+      if use_globs?
+        pat = Nanoc::Int::Pattern.from(glob)
+        @objects.find { |i| pat.match?(i.identifier) }
+      else
+        nil
+      end
+    end
+
+    def build_mapping
+      @mapping = {}
+      @objects.each do |object|
+        @mapping[object.identifier.to_s] = object
+      end
+      @mapping.freeze
+    end
+
+    def use_globs?
+      @config[:string_pattern_type] == 'glob'
+    end
+  end
+end

data/lib/nanoc/base/source_data/identifier.rb

@@ -16,10 +16,10 @@ module Nanoc
     end
 
     def initialize(string, params = {})
-      @style = params.fetch(:style, :stripped)
+      @type = params.fetch(:type, :full)
 
-      case @style
-      when :stripped
+      case @type
+      when :legacy
         @string = "/#{string}/".gsub(/^\/+|\/+$/, '/').freeze
       when :full
         if string !~ /\A\//
@@ -29,7 +29,7 @@ module Nanoc
         @string = string.dup.freeze
       else
         raise Nanoc::Int::Errors::Generic,
-          "Invalid :style param for identifier: #{@style.inspect}"
+          "Invalid :type param for identifier: #{@type.inspect}"
       end
     end
 
@@ -50,10 +50,10 @@ module Nanoc
       to_s <=> other.to_s
     end
 
-    # @return [Boolean] True if this is a full-style identifier (i.e. includes
+    # @return [Boolean] True if this is a full-type identifier (i.e. includes
     #   the extension), false otherwise
     def full?
-      @style == :full
+      @type == :full
     end
 
     # @return [String]
@@ -72,12 +72,12 @@ module Nanoc
         raise Nanoc::Int::Errors::Generic,
           "Invalid prefix (does not start with a slash): #{@string.inspect}"
       end
-      Nanoc::Identifier.new(string.sub(/\/+\z/, '') + @string, style: @style)
+      Nanoc::Identifier.new(string.sub(/\/+\z/, '') + @string, type: @type)
     end
 
     # @return [String]
     def with_ext(ext)
-      if @style == :stripped
+      unless full?
         raise Nanoc::Int::Errors::Generic,
           'Cannot use #with_ext on identifier that does not include the file extension'
       end
@@ -117,7 +117,7 @@ module Nanoc
     end
 
     def inspect
-      "<Nanoc::Identifier style=#{@style} #{to_s.inspect}>"
+      "<Nanoc::Identifier type=#{@type} #{to_s.inspect}>"
     end
   end
 end

data/lib/nanoc/base/source_data/site.rb

@@ -24,7 +24,8 @@ module Nanoc::Int
       type: 'filesystem_unified',
       items_root: '/',
       layouts_root: '/',
-      config: {}
+      config: {},
+      identifier_type: 'full',
     }
 
     # The default configuration for a site. A site's configuration overrides
@@ -32,14 +33,15 @@ module Nanoc::Int
     # that lacks some options, the default value will be taken from
     # `DEFAULT_CONFIG`.
     DEFAULT_CONFIG = {
-      text_extensions: %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim ).sort,
+      text_extensions: %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim rdoc ).sort,
       lib_dirs: %w( lib ),
       commands_dirs: %w( commands ),
       output_dir: 'output',
       data_sources: [{}],
       index_filenames: ['index.html'],
       enable_output_diff: false,
-      prune: { auto_prune: false, exclude: ['.git', '.hg', '.svn', 'CVS'] }
+      prune: { auto_prune: false, exclude: ['.git', '.hg', '.svn', 'CVS'] },
+      string_pattern_type: 'glob',
     }
 
     # Creates a site object for the site specified by the given
@@ -325,7 +327,7 @@ module Nanoc::Int
       @items_loaded = true
 
       # Get items
-      @items = Nanoc::Int::ItemArray.new(@config)
+      @items = Nanoc::Int::IdentifiableCollection.new(@config)
       data_sources.each do |ds|
         items_in_ds = ds.items
         items_in_ds.each do |i|
@@ -343,7 +345,7 @@ module Nanoc::Int
       @layouts_loaded = true
 
       # Get layouts
-      @layouts = []
+      @layouts = Nanoc::Int::IdentifiableCollection.new(@config)
       data_sources.each do |ds|
         layouts_in_ds = ds.layouts
         layouts_in_ds.each do |l|

data/lib/nanoc/base/views/identifiable_collection.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+module Nanoc
+  class IdentifiableCollectionView
+    include Enumerable
+
+    # @api private
+    def initialize(objects)
+      @objects = objects
+    end
+
+    # @api private
+    def unwrap
+      @objects
+    end
+
+    # @abstract
+    #
+    # @api private
+    def view_class
+      raise NotImplementedError
+    end
+
+    # Calls the given block once for each object, passing that object as a parameter.
+    #
+    # @yieldparam [#identifier] object
+    #
+    # @yieldreturn [void]
+    #
+    # @return [self]
+    def each
+      @objects.each { |i| yield view_class.new(i) }
+      self
+    end
+
+    # @return [Integer]
+    def size
+      @objects.size
+    end
+
+    # Finds all objects whose identifier matches the given argument.
+    #
+    # @param [String, Regex] arg
+    #
+    # @return [Enumerable]
+    def find_all(arg)
+      pat = Nanoc::Int::Pattern.from(arg)
+      select { |i| pat.match?(i.identifier) }
+    end
+
+    # @overload [](string)
+    #
+    #   Finds the object whose identifier matches the given string.
+    #
+    #   If the glob syntax is enabled, the string can be a glob, in which case
+    #   this method finds the first object that matches the given glob.
+    #
+    #   @param [String] string
+    #
+    #   @return [nil] if no object matches the string
+    #
+    #   @return [#identifier] if an object was found
+    #
+    # @overload [](regex)
+    #
+    #   Finds the object whose identifier matches the given regular expression.
+    #
+    #   @param [Regex] regex
+    #
+    #   @return [nil] if no object matches the regex
+    #
+    #   @return [#identifier] if an object was found
+    def [](arg)
+      res = @objects[arg]
+      res && view_class.new(res)
+    end
+  end
+end