nanoc 4.0.0a1 → 4.0.0a2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a0053b307bb6f25cce2645c58960d5f3be1060e
-  data.tar.gz: 27db68426f384c4e3af20088852300637fa545af
+  metadata.gz: e1055bcfad80c114e2f54b3e67d89468c828ce18
+  data.tar.gz: 121523a9ee6c375e4a4dc4fc56c680f7501b97ad
 SHA512:
-  metadata.gz: 96b78eb40b40e8b19f5c7f208f6266823c60f01fd9d4490a24f8fc4e2e843229d37ce36a42e4b2d91034d63782518c0f8debab9f5635a21b6f27b94b9ab71e57
-  data.tar.gz: af28723ee5ea196858ffd429fd84aa215515a9248fb912167df8efaeae32522b0628910b4565904ccb0b4610dbf4b71125cdb5319bcc838b02fd8fbf812b185a
+  metadata.gz: 0da18d11db64365759e7be6dd9c6fd72334baa823813d39c7286d34f8ebf406cf73bb1059c2dc35d1955c0697495af986bb657a2003ac1ef7f88b8e1c19be249
+  data.tar.gz: 609b1ec27cad20f169346917dd688d08dbb4e8a12b4497d4884a1bb3f2dcf1492b36e34a9a4c6d27c77d58f6d346d98c4c6ee37933dc884932acb8dfebeefb3f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc (4.0.0a1)
+    nanoc (4.0.0a2)
       cri (~> 2.3)
 
 GEM
@@ -51,12 +51,13 @@ GEM
     ffi (1.9.8)
     fission (0.5.0)
       CFPropertyList (~> 2.2)
-    fog (1.29.0)
+    fog (1.30.0)
       fog-atmos
       fog-aws (~> 0.0)
       fog-brightbox (~> 0.4)
       fog-core (~> 1.27, >= 1.27.4)
       fog-ecloud
+      fog-google (>= 0.0.2)
       fog-json
       fog-local
       fog-powerdns (>= 0.1.1)
@@ -95,6 +96,10 @@ GEM
     fog-ecloud (0.1.1)
       fog-core
       fog-xml
+    fog-google (0.0.5)
+      fog-core
+      fog-json
+      fog-xml
     fog-json (1.0.1)
       fog-core (~> 1.0)
       multi_json (~> 1.0)
@@ -184,7 +189,7 @@ GEM
     parser (2.2.2.2)
       ast (>= 1.1, < 3.0)
     posix-spawn (0.3.11)
-    powerpack (0.1.0)
+    powerpack (0.1.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -221,7 +226,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.2)
-    rubocop (0.30.1)
+    rubocop (0.31.0)
       astrolabe (~> 1.3)
       parser (>= 2.2.2.1, < 3.0)
       powerpack (~> 0.1)

data/NEWS.md

@@ -1,5 +1,18 @@
 # nanoc news
 
+## 4.0.0a2 (2015-05-??)
+
+Features:
+
+* Glob patterns (opt-in by setting `pattern_syntax` to `"glob"` in the site configuration)
+* Identifiers with extensions (opt-in by setting `identifier_style` to `"full"` in the data source configuration)
+
+Enhancements:
+
+* Added several convenience methods to view classes (#570, #572)
+
+See the [nanoc 4 upgrade guide](http://nanoc.ws/docs/nanoc-4-upgrade-guide/) for details.
+
 ## 4.0.0a1 (2015-05-09)
 
 This is a major upgrade. For details on upgrading, see the [nanoc 4 upgrade guide](http://nanoc.ws/docs/nanoc-4-upgrade-guide/).

data/lib/nanoc/base.rb

@@ -27,6 +27,8 @@ end
 
 # @api private
 module Nanoc::Int
+  require_relative 'base/pattern'
+
   # Load helper classes
   autoload 'Context',              'nanoc/base/context'
   autoload 'Checksummer',          'nanoc/base/checksummer'

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

@@ -412,7 +412,6 @@ module Nanoc::Int
     # Returns a preprocessor context, creating one if none exists yet.
     def preprocessor_context
       Nanoc::Int::Context.new({
-        site: Nanoc::SiteView.new(@site), # TODO: remove me
         config: Nanoc::MutableConfigView.new(@site.config),
         items: Nanoc::MutableItemCollectionView.new(@site.items),
         layouts: Nanoc::MutableLayoutCollectionView.new(@site.layouts),

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

@@ -77,7 +77,7 @@ module Nanoc::Int
       rep_name = params[:rep] || :default
 
       # Create rule
-      rule = Nanoc::Int::Rule.new(identifier_to_regex(identifier), rep_name, block)
+      rule = Nanoc::Int::Rule.new(create_pattern(identifier), rep_name, block)
       @rules_collection.add_item_compilation_rule(rule)
     end
 
@@ -122,7 +122,7 @@ module Nanoc::Int
       snapshot_name = params[:snapshot] || :last
 
       # Create rule
-      rule = Nanoc::Int::Rule.new(identifier_to_regex(identifier), rep_name, block, snapshot_name: snapshot_name)
+      rule = Nanoc::Int::Rule.new(create_pattern(identifier), rep_name, block, snapshot_name: snapshot_name)
       @rules_collection.add_item_routing_rule(rule)
     end
 
@@ -151,7 +151,8 @@ module Nanoc::Int
     #
     #     layout '/custom/',  :haml, :format => :html5
     def layout(identifier, filter_name, params = {})
-      @rules_collection.layout_filter_mapping[identifier_to_regex(identifier)] = [filter_name, params]
+      pattern = Nanoc::Int::Pattern.from(create_pattern(identifier))
+      @rules_collection.layout_filter_mapping[pattern] = [filter_name, params]
     end
 
     # Creates a pair of compilation and routing rules that indicate that the
@@ -188,7 +189,7 @@ module Nanoc::Int
 
       # Create compilation rule
       compilation_block = proc {}
-      compilation_rule = Nanoc::Int::Rule.new(identifier_to_regex(identifier), rep_name, compilation_block)
+      compilation_rule = Nanoc::Int::Rule.new(create_pattern(identifier), rep_name, compilation_block)
       @rules_collection.add_item_compilation_rule(compilation_rule)
 
       # Create routing rule
@@ -199,7 +200,7 @@ module Nanoc::Int
         # data source.
         item[:extension].nil? || (item[:content_filename].nil? && item.identifier =~ %r{#{item[:extension]}/$}) ? item.identifier.chop : item.identifier.chop + '.' + item[:extension]
       end
-      routing_rule = Nanoc::Int::Rule.new(identifier_to_regex(identifier), rep_name, routing_block, snapshot_name: :last)
+      routing_rule = Nanoc::Int::Rule.new(create_pattern(identifier), rep_name, routing_block, snapshot_name: :last)
       @rules_collection.add_item_routing_rule(routing_rule)
     end
 
@@ -227,10 +228,10 @@ module Nanoc::Int
 
       rep_name = params[:rep] || :default
 
-      compilation_rule = Nanoc::Int::Rule.new(identifier_to_regex(identifier), rep_name, proc {})
+      compilation_rule = Nanoc::Int::Rule.new(create_pattern(identifier), rep_name, proc {})
       @rules_collection.add_item_compilation_rule(compilation_rule)
 
-      routing_rule = Nanoc::Int::Rule.new(identifier_to_regex(identifier), rep_name, proc {}, snapshot_name: :last)
+      routing_rule = Nanoc::Int::Rule.new(create_pattern(identifier), rep_name, proc {}, snapshot_name: :last)
       @rules_collection.add_item_routing_rule(routing_rule)
     end
 
@@ -253,6 +254,19 @@ module Nanoc::Int
       @rules_collection.parse(filename)
     end
 
+    # @api private
+    def create_pattern(arg)
+      case @config[:pattern_syntax]
+      when 'glob'
+        Nanoc::Int::Pattern.from(arg)
+      when nil
+        Nanoc::Int::Pattern.from(identifier_to_regex(arg))
+      else
+        raise Nanoc::Int::Errors::GenericTrivial,
+          "Invalid pattern_syntax: #{@config[:pattern_syntax]}"
+      end
+    end
+
     private
 
     # Converts the given identifier, which can contain the '*' or '+'

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

@@ -94,9 +94,18 @@ module Nanoc::Int
     end
 
     def layout_with_identifier(layout_identifier)
-      layout ||= layouts.find { |l| l.identifier == layout_identifier.__nanoc_cleaned_identifier }
+      req_id = layout_identifier.__nanoc_cleaned_identifier
+      layout = layouts.find { |l| l.identifier == req_id }
+      if layout.nil? && use_globs?
+        pat = Nanoc::Int::Pattern.from(layout_identifier)
+        layout = layouts.find { |l| pat.match?(l.identifier) }
+      end
       raise Nanoc::Int::Errors::UnknownLayout.new(layout_identifier) if layout.nil?
       layout
     end
+
+    def use_globs?
+      @compiler.site.config[:pattern_syntax] == 'glob'
+    end
   end
 end

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

@@ -5,11 +5,6 @@ module Nanoc::Int
   #
   # @api private
   class Rule
-    # @return [Regexp] The regex that determines which items this rule can be
-    #   applied to. This rule can be applied to items with a identifier
-    #   matching this regex.
-    attr_reader :identifier_regex
-
     # @return [Symbol] The name of the representation that will be compiled
     #   using this rule
     attr_reader :rep_name
@@ -24,8 +19,7 @@ module Nanoc::Int
     # compiler and block. The block will be called during compilation with the
     # item rep as its argument.
     #
-    # @param [Regexp] identifier_regex A regular expression that will be used
-    #   to determine whether this rule is applicable to certain items.
+    # @param [Nanoc::Int::Pattern] pattern
     #
     # @param [String, Symbol] rep_name The name of the item representation
     #   where this rule can be applied to
@@ -36,8 +30,13 @@ module Nanoc::Int
     # @option params [Symbol, nil] :snapshot (nil) The name of the snapshot
     #   this rule will apply to. Ignored for compilation rules, but used for
     #   routing rules.
-    def initialize(identifier_regex, rep_name, block, params = {})
-      @identifier_regex = identifier_regex
+    def initialize(pattern, rep_name, block, params = {})
+      # TODO: remove me
+      unless pattern.is_a?(Nanoc::Int::StringPattern) || pattern.is_a?(Nanoc::Int::RegexpPattern)
+        raise "Can only create rules with patterns"
+      end
+
+      @pattern          = pattern
       @rep_name         = rep_name.to_sym
       @snapshot_name    = params[:snapshot_name]
 
@@ -49,7 +48,7 @@ module Nanoc::Int
     # @return [Boolean] true if this rule can be applied to the given item
     #   rep, false otherwise
     def applicable_to?(item)
-      item.identifier =~ @identifier_regex
+      @pattern.match?(item.identifier)
     end
 
     # Applies this rule to the given item rep.
@@ -80,8 +79,7 @@ module Nanoc::Int
     #
     # @return [nil, Array] Captured groups, if any
     def matches(identifier)
-      matches = @identifier_regex.match(identifier.to_s)
-      matches && matches.captures
+      @pattern.captures(identifier)
     end
   end
 end

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

@@ -153,8 +153,8 @@ module Nanoc::Int
     # @return [Array, nil] A tuple containing the filter name and the filter
     #   arguments for the given layout.
     def filter_for_layout(layout)
-      @layout_filter_mapping.each_pair do |layout_identifier, filter_name_and_args|
-        return filter_name_and_args if layout.identifier =~ layout_identifier
+      @layout_filter_mapping.each_pair do |pattern, filter_name_and_args|
+        return filter_name_and_args if pattern.match?(layout.identifier)
       end
       nil
     end

data/lib/nanoc/base/pattern.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Nanoc::Int
+  # @api private
+  class Pattern
+    def self.from(obj)
+      case obj
+      when Nanoc::Int::StringPattern, Nanoc::Int::RegexpPattern
+        obj
+      when String
+        Nanoc::Int::StringPattern.new(obj)
+      when Regexp
+        Nanoc::Int::RegexpPattern.new(obj)
+      else
+        raise ArgumentError, "Do not know how to convert #{obj} into a Nanoc::Pattern"
+      end
+    end
+
+    def initialize(_obj)
+      raise NotImplementedError
+    end
+
+    def match?(_identifier)
+      raise NotImplementedError
+    end
+
+    def captures(_identifier)
+      raise NotImplementedError
+    end
+  end
+
+  # @api private
+  class StringPattern
+    def initialize(string)
+      @string = string
+    end
+
+    def match?(identifier)
+      opts = File::FNM_PATHNAME | File::FNM_EXTGLOB
+      File.fnmatch(@string, identifier.to_s, opts)
+    end
+
+    def captures(_identifier)
+      nil
+    end
+  end
+
+  # @api private
+  class RegexpPattern
+    def initialize(regexp)
+      @regexp = regexp
+    end
+
+    def match?(identifier)
+      (identifier.to_s =~ @regexp) != nil
+    end
+
+    def captures(identifier)
+      matches = @regexp.match(identifier.to_s)
+      matches && matches.captures
+    end
+  end
+end

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

@@ -114,8 +114,8 @@ module Nanoc
     def down
     end
 
-    # Returns the list of items (represented by {Nanoc::Int::Item}) in this site.
-    # The default implementation simply returns an empty array.
+    # Returns the collection of items (represented by {Nanoc::Int::Item}) in
+    # this site. The default implementation simply returns an empty array.
     #
     # Subclasses should not prepend `items_root` to the item's identifiers, as
     # this will be done automatically.
@@ -123,13 +123,13 @@ module Nanoc
     # Subclasses may override this method, but are not required to do so; the
     # default implementation simply does nothing.
     #
-    # @return [Array<Nanoc::Int::Item>] A list of items
+    # @return [Enumerable] The collection of items
     def items
       []
     end
 
-    # Returns the list of layouts (represented by {Nanoc::Int::Layout}) in this
-    # site. The default implementation simply returns an empty array.
+    # Returns the collection of layouts (represented by {Nanoc::Int::Layout}) in
+    # this site. The default implementation simply returns an empty array.
     #
     # Subclasses should prepend `layout_root` to the layout's identifiers,
     # since this is not done automatically.
@@ -137,25 +137,40 @@ module Nanoc
     # Subclasses may override this method, but are not required to do so; the
     # default implementation simply does nothing.
     #
-    # @return [Array<Nanoc::Int::Layout>] A list of layouts
+    # @return [Enumerable] The collection of layouts
     def layouts
       []
     end
 
-    def new_item(content, attributes, identifier, params = {})
-      Nanoc::Int::Item.new(content, attributes, identifier, params)
-    end
-
-    def new_layout(content, attributes, identifier)
-      Nanoc::Int::Layout.new(content, attributes, identifier)
+    # Creates a new in-memory item instance. This is intended for use within
+    # the {#items} method.
+    #
+    # @param [String] raw_content_or_raw_filename The uncompiled item content
+    #   (if it is a textual item) or the path to the filename containing the
+    #   content (if it is a binary item).
+    #
+    # @param [Hash] attributes A hash containing this item's attributes.
+    #
+    # @param [String] identifier This item's identifier.
+    #
+    # @param [Hash] params Extra parameters.
+    #
+    # @option params [Symbol, nil] :binary (true) Whether or not this item is
+    #   binary
+    def new_item(raw_content_or_raw_filename, attributes, identifier, params = {})
+      Nanoc::Int::Item.new(raw_content_or_raw_filename, attributes, identifier, params)
     end
 
-    private
-
-    def not_implemented(name)
-      raise NotImplementedError.new(
-        "#{self.class} does not implement ##{name}"
-      )
+    # Creates a new in-memory layout instance. This is intended for use within
+    # the {#layouts} method.
+    #
+    # @param [String] raw_content The raw content of this layout.
+    #
+    # @param [Hash] attributes A hash containing this layout's attributes.
+    #
+    # @param [String] identifier This layout's identifier.
+    def new_layout(raw_content, attributes, identifier)
+      Nanoc::Int::Layout.new(raw_content, attributes, identifier)
     end
   end
 end

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

@@ -4,8 +4,33 @@ module Nanoc
   class Identifier
     include Comparable
 
-    def initialize(string)
-      @string = "/#{string}/".gsub(/^\/+|\/+$/, '/').freeze
+    def self.from(obj)
+      case obj
+      when Nanoc::Identifier
+        obj
+      when String
+        Nanoc::Identifier.new(obj)
+      else
+        raise ArgumentError, "Do not know how to convert #{obj} into a Nanoc::Identifier"
+      end
+    end
+
+    def initialize(string, params = {})
+      @style = params.fetch(:style, :stripped)
+
+      case @style
+      when :stripped
+        @string = "/#{string}/".gsub(/^\/+|\/+$/, '/').freeze
+      when :full
+        if string !~ /\A\//
+          raise Nanoc::Int::Errors::Generic,
+            "Invalid identifier (does not start with a slash): #{string.inspect}"
+        end
+        @string = string.dup.freeze
+      else
+        raise Nanoc::Int::Errors::Generic,
+          "Invalid :style param for identifier: #{@style.inspect}"
+      end
     end
 
     def ==(other)
@@ -35,6 +60,43 @@ module Nanoc
       to_s + string
     end
 
+    # @return [Nanoc::Identifier]
+    def prefix(string)
+      if string !~ /\A\//
+        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)
+    end
+
+    # @return [String]
+    def with_ext(ext)
+      if @style == :stripped
+        raise Nanoc::Int::Errors::Generic,
+          'Cannot use #with_ext on identifier that does not include the file extension'
+      end
+
+      # Strip extension, if any
+      extname = File.extname(@string)
+      string =
+        if extname.size > 0
+          @string[0..-extname.size-1]
+        else
+          @string
+        end
+
+      # Add extension
+      if ext.size > 0
+        if ext.start_with?('.')
+          string + ext
+        else
+          string + '.' + ext
+        end
+      else
+        string
+      end
+    end
+
     def to_s
       @string
     end
@@ -44,7 +106,7 @@ module Nanoc
     end
 
     def inspect
-      "<Nanoc::Identifier #{to_s.inspect}>"
+      "<Nanoc::Identifier style=#{@style} #{to_s.inspect}>"
     end
   end
 end