nanoc 4.0.0b3 → 4.0.0b4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1916118f3f4affe429105d6b7cd243cef3ad7f79
-  data.tar.gz: 6cb2a58542bc45f676a50b9dca5f681fb524752a
+  metadata.gz: c6a2272e514cd909fa601f4fea595a3827b82ae4
+  data.tar.gz: d2817ebcf5353f903262f858b7ce2b7dbcd995e6
 SHA512:
-  metadata.gz: 199276b80c83ae39093ba9169360b2ae345e80fb1aa1891d8b7fc5569261c4fc2c05b60f2e553c003a72448649bf16f75029f6520d82bde27048a49015330345
-  data.tar.gz: 46748f7f40700073a17e76fd2f47ad5dbc287c7156220736d2bc6438248c88f2dd4b5047f7ac839073cc110fff189607345369e3c2fdf4e230286a7ed7d1735a
+  metadata.gz: bbaeae81947c39944044cb73ac30d7347c5a204ccfe70843f7796e7aa17d5def67be3fc1a77f65abca4f64ce704cf81dff123ced4c08e98f1b7e124841d96d63
+  data.tar.gz: e58c103c1bbf728768f349d286b1c299524513b20bff9a0621548b861eeba906b9cb4582a01f688ef6b8bc6318aefa7958166b58ba7db4187a8e8d61f9223745

data/Gemfile

@@ -12,6 +12,7 @@ gem 'compass'
 gem 'coffee-script'
 gem 'coveralls', require: false
 gem 'erubis'
+gem 'fakefs'
 gem 'fog'
 gem 'haml'
 gem 'handlebars', platforms: :ruby

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc (4.0.0b3)
+    nanoc (4.0.0b4)
       cri (~> 2.3)
 
 GEM
@@ -48,6 +48,7 @@ GEM
     erubis (2.7.0)
     excon (0.45.3)
     execjs (2.5.2)
+    fakefs (0.6.7)
     ffi (1.9.8)
     fission (0.5.0)
       CFPropertyList (~> 2.2)
@@ -289,6 +290,7 @@ DEPENDENCIES
   compass
   coveralls
   erubis
+  fakefs
   fog
   haml
   handlebars
@@ -327,4 +329,4 @@ DEPENDENCIES
   yuicompressor
 
 BUNDLED WITH
-   1.10.2
+   1.10.3

data/NEWS.md

@@ -1,5 +1,15 @@
 # nanoc news
 
+## 4.0.0b4 (2015-06-10)
+
+Fixes:
+
+* Added missing `#ext` method to identifiers (#612)
+* Fixed issue where identifiers would have the wrong extension (#611)
+* Fixed rule context exposing entities rather than views (#614, #615)
+* Fixed `#key?` and `#fetch` not being available on layout views (#618)
+* Fixed `#update_attributes` not being available on mutable layout views (#619)
+
 ## 4.0.0b3 (2015-05-31)
 
 Changes:

data/TODO.md

@@ -0,0 +1,15 @@
+# To do
+
+## Ideas
+
+* snapshots [name, array] is weird
+* binary snapshots could be possible
+* binary layotus could be possible
+
+## Removing `forget_progress`
+
+This means not storing compiled content inside item reps anymore.
+
+Compiler could store it, and `snapshot` could move temporary compiled content (like `:last`) and crystallize it in a more permanent store (even in-memory).
+
+CompiledContent class, which is basically snapshot -> Content.

data/lib/nanoc/base.rb

@@ -2,51 +2,26 @@ module Nanoc
   require 'nanoc/base/core_ext'
 
   autoload 'Error',                'nanoc/base/error'
-
   autoload 'DataSource',           'nanoc/base/source_data/data_source'
-  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 'ItemRepCollectionView', 'nanoc/base/views/item_rep_collection'
-  autoload 'ItemRepView',          'nanoc/base/views/item_rep'
-  autoload 'ItemCollectionView',   'nanoc/base/views/item_collection'
-  autoload 'LayoutView',           'nanoc/base/views/layout'
-  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'
-  autoload 'MutableLayoutView',           'nanoc/base/views/mutable_layout'
-  autoload 'MutableLayoutCollectionView', 'nanoc/base/views/mutable_layout_collection'
-
   autoload 'Filter',               'nanoc/base/compilation/filter'
 end
 
 # @api private
 module Nanoc::Int
-  require_relative 'base/pattern'
-
   # Load helper classes
   autoload 'Context',              'nanoc/base/context'
   autoload 'Checksummer',          'nanoc/base/checksummer'
   autoload 'DirectedGraph',        'nanoc/base/directed_graph'
   autoload 'Errors',               'nanoc/base/errors'
   autoload 'Memoization',          'nanoc/base/memoization'
-  autoload 'NotificationCenter',   'nanoc/base/notification_center'
   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 'Layout',               'nanoc/base/source_data/layout'
   autoload 'Site',                 'nanoc/base/source_data/site'
 
   # Load result data classes
@@ -58,8 +33,6 @@ module Nanoc::Int
   autoload 'Compiler',             'nanoc/base/compilation/compiler'
   autoload 'CompilerDSL',          'nanoc/base/compilation/compiler_dsl'
   autoload 'DependencyTracker',    'nanoc/base/compilation/dependency_tracker'
-  autoload 'ItemRepProxy',         'nanoc/base/compilation/item_rep_proxy'
-  autoload 'ItemRepRecorderProxy', 'nanoc/base/compilation/item_rep_recorder_proxy'
   autoload 'OutdatednessChecker',  'nanoc/base/compilation/outdatedness_checker'
   autoload 'OutdatednessReasons',  'nanoc/base/compilation/outdatedness_reasons'
   autoload 'Rule',                 'nanoc/base/compilation/rule'
@@ -68,3 +41,7 @@ module Nanoc::Int
   autoload 'RuleMemoryStore',      'nanoc/base/compilation/rule_memory_store'
   autoload 'RulesCollection',      'nanoc/base/compilation/rules_collection'
 end
+
+require_relative 'base/entities'
+require_relative 'base/services'
+require_relative 'base/views'

data/lib/nanoc/base/checksummer.rb

@@ -6,63 +6,111 @@ module Nanoc::Int
   #
   # @api private
   class Checksummer
+    class VerboseDigest
+      def initialize
+        @str = ''
+      end
+
+      def update(str)
+        @str << str
+      end
+
+      def to_s
+        @str
+      end
+    end
+
+    class CompactDigest
+      def initialize
+        @digest = Digest::SHA1.new
+      end
+
+      def update(str)
+        @digest.update(str)
+      end
+
+      def to_s
+        @digest.base64digest
+      end
+    end
+
     class << self
       # @param obj The object to create a checksum for
       #
       # @return [String] The digest
-      def calc(obj)
-        digest = Digest::SHA1.new
+      def calc(obj, digest_class = CompactDigest)
+        digest = digest_class.new
         update(obj, digest)
-        digest.base64digest
+        digest.to_s
       end
 
       private
 
       def update(obj, digest, visited = Set.new)
         digest.update(obj.class.to_s)
+        digest.update('<')
 
         if visited.include?(obj)
-          digest.update('recur')
+          digest.update('recur>')
           return
         end
 
         case obj
-        when String
+        when ::String
           digest.update(obj)
-        when Array
+        when ::Symbol
+          digest.update(obj.to_s)
+        when nil, true, false
+        when ::Array
           obj.each do |el|
-            digest.update('elem')
             update(el, digest, visited + [obj])
+            digest.update(',')
           end
-        when Hash
+        when ::Hash
           obj.each do |key, value|
-            digest.update('key')
             update(key, digest, visited + [obj])
-            digest.update('value')
+            digest.update('=')
             update(value, digest, visited + [obj])
+            digest.update(',')
           end
-        when Pathname
+        when ::Pathname
           filename = obj.to_s
           if File.exist?(filename)
             stat = File.stat(filename)
-            digest.update(stat.size.to_s + '-' + stat.mtime.utc.to_s)
+            digest.update(stat.size.to_s + '-' + stat.mtime.to_i.to_s)
           else
             digest.update('???')
           end
+        when Time
+          digest.update(obj.to_i.to_s)
+        when Numeric
+          digest.update(obj.to_s)
+        when Nanoc::Identifier
+          update(obj.to_s, digest)
         when Nanoc::Int::RulesCollection
           update(obj.data, digest)
         when Nanoc::Int::CodeSnippet
           update(obj.data, digest)
+        when Nanoc::Int::TextualContent
+          update(obj.string, digest)
+        when Nanoc::Int::BinaryContent
+          update(Pathname.new(obj.filename), digest)
         when Nanoc::Int::Item, Nanoc::Int::Layout
-          digest.update('content')
-          if obj.respond_to?(:binary?) && obj.binary?
-            update(Pathname.new(obj.raw_filename), digest)
-          else
-            update(obj.raw_content, digest)
-          end
+          digest.update('content=')
+          update(obj.content, digest)
 
-          digest.update('attributes')
+          digest.update(',attributes=')
           update(obj.attributes, digest, visited + [obj])
+
+          digest.update(',identifier=')
+          update(obj.identifier, digest)
+        when Nanoc::ItemView, Nanoc::LayoutView, Nanoc::ConfigView, Nanoc::IdentifiableCollectionView
+          update(obj.unwrap, digest)
+        when Nanoc::Int::IdentifiableCollection
+          obj.each do |el|
+            update(el, digest, visited + [obj])
+            digest.update(',')
+          end
         else
           data = begin
             Marshal.dump(obj)
@@ -72,6 +120,8 @@ module Nanoc::Int
 
           digest.update(data)
         end
+
+        digest.update('>')
       end
     end
   end

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

@@ -91,7 +91,7 @@ module Nanoc::Int
       Nanoc::Int::TempFilenameFactory.instance.cleanup(
         Nanoc::Filter::TMP_BINARY_ITEMS_DIR)
       Nanoc::Int::TempFilenameFactory.instance.cleanup(
-        Nanoc::Int::ItemRep::TMP_TEXT_ITEMS_DIR)
+        Nanoc::Int::ItemRepWriter::TMP_TEXT_ITEMS_DIR)
     end
 
     # @group Private instance methods
@@ -163,7 +163,7 @@ module Nanoc::Int
 
       # Calculate checksums
       objects.each do |obj|
-        checksum_store[obj] = obj.__nanoc_checksum
+        checksum_store[obj] = Nanoc::Int::Checksummer.calc(obj)
       end
 
       # Store
@@ -228,7 +228,7 @@ module Nanoc::Int
 
         rules.each_pair do |snapshot, rule|
           # Get basic path by applying matching rule
-          basic_path = rule.apply_to(rep, compiler: self)
+          basic_path = rule.apply_to(rep, executor: nil, compiler: self)
           next if basic_path.nil?
           if basic_path !~ %r{^/}
             raise "The path returned for the #{rep.inspect} item representation, “#{basic_path}”, does not start with a slash. Please ensure that all routing rules return a path that starts with a slash."
@@ -260,9 +260,9 @@ module Nanoc::Int
     # @api private
     def assigns_for(rep)
       if rep.binary?
-        content_or_filename_assigns = { filename: rep.temporary_filenames[:last] }
+        content_or_filename_assigns = { filename: rep.content_snapshots[:last].filename }
       else
-        content_or_filename_assigns = { content: rep.content[:last] }
+        content_or_filename_assigns = { content: rep.content_snapshots[:last].string }
       end
 
       # TODO: Do not expose @site (necessary for captures store though…)
@@ -361,6 +361,8 @@ module Nanoc::Int
     #
     # @return [void]
     def compile_rep(rep)
+      executor = Nanoc::Int::Executor.new(self)
+
       Nanoc::Int::NotificationCenter.post(:compilation_started, rep)
       Nanoc::Int::NotificationCenter.post(:processing_started,  rep)
       Nanoc::Int::NotificationCenter.post(:visit_started,       rep.item)
@@ -371,18 +373,18 @@ module Nanoc::Int
       if !rep.item.forced_outdated? && !outdatedness_checker.outdated?(rep) && compiled_content_cache[rep]
         # Reuse content
         Nanoc::Int::NotificationCenter.post(:cached_content_used, rep)
-        rep.content = compiled_content_cache[rep]
+        rep.content_snapshots = compiled_content_cache[rep]
       else
         # Recalculate content
-        rep.snapshot(:raw)
-        rep.snapshot(:pre, final: false)
-        rules_collection.compilation_rule_for(rep).apply_to(rep, compiler: self)
-        rep.snapshot(:post) if rep.has_snapshot?(:post)
-        rep.snapshot(:last)
+        executor.snapshot(rep, :raw)
+        executor.snapshot(rep, :pre, final: false)
+        rules_collection.compilation_rule_for(rep).apply_to(rep, executor: executor, compiler: self)
+        executor.snapshot(rep, :post) if rep.has_snapshot?(:post)
+        executor.snapshot(rep, :last)
       end
 
       rep.compiled = true
-      compiled_content_cache[rep] = rep.content
+      compiled_content_cache[rep] = rep.content_snapshots
 
       Nanoc::Int::NotificationCenter.post(:processing_ended,  rep)
       Nanoc::Int::NotificationCenter.post(:compilation_ended, rep)

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

@@ -1,5 +1,7 @@
 module Nanoc::Int
   # Contains methods that will be executed by the site’s `Rules` file.
+  #
+  # @api private
   class CompilerDSL
     # The current rules filename.
     #

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

@@ -56,9 +56,11 @@ module Nanoc
       # @return [void]
       def type(arg)
         if arg.is_a?(Hash)
-          @from, @to = arg.keys[0], arg.values[0]
+          @from = arg.keys[0]
+          @to = arg.values[0]
         else
-          @from, @to = arg, arg
+          @from = arg
+          @to = arg
         end
       end
 

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

@@ -81,8 +81,8 @@ module Nanoc::Int
     # @return [Nanoc::Int::OutdatednessReasons::Generic, nil] The reason why the
     #   given object is outdated, or nil if the object is not outdated.
     def basic_outdatedness_reason_for(obj)
-      case obj.type
-      when :item_rep
+      case obj
+      when Nanoc::Int::ItemRep
         # Outdated if rules outdated
         return Nanoc::Int::OutdatednessReasons::RulesModified if
           rule_memory_differs_for(obj)
@@ -104,9 +104,9 @@ module Nanoc::Int
 
         # Not outdated
         return nil
-      when :item
+      when Nanoc::Int::Item
         obj.reps.find { |rep| basic_outdatedness_reason_for(rep) }
-      when :layout
+      when Nanoc::Int::Layout
         # Outdated if rules outdated
         return Nanoc::Int::OutdatednessReasons::RulesModified if
           rule_memory_differs_for(obj)
@@ -136,7 +136,7 @@ module Nanoc::Int
     # @return [Boolean] true if the object is outdated, false otherwise
     def outdated_due_to_dependencies?(obj, processed = Set.new)
       # Convert from rep to item if necessary
-      obj = obj.item if obj.type == :item_rep
+      obj = obj.item if obj.is_a?(Nanoc::Int::ItemRep)
 
       # Get from cache
       if @objects_outdated_due_to_dependencies.key?(obj)
@@ -175,7 +175,7 @@ module Nanoc::Int
     # @return [Boolean] false if either the new or the old checksum for the
     #   given object is not available, true if both checksums are available
     def checksums_available?(obj)
-      checksum_store[obj] && obj.__nanoc_checksum
+      checksum_store[obj] && Nanoc::Int::Checksummer.calc(obj)
     end
     memoize :checksums_available?
 
@@ -184,7 +184,7 @@ module Nanoc::Int
     # @return [Boolean] false if the old and new checksums for the given
     #   object differ, true if they are identical
     def checksums_identical?(obj)
-      checksum_store[obj] == obj.__nanoc_checksum
+      checksum_store[obj] == Nanoc::Int::Checksummer.calc(obj)
     end
     memoize :checksums_identical?
 

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

@@ -31,7 +31,7 @@ module Nanoc::Int
     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"
+        raise 'Can only create rules with patterns'
       end
 
       @pattern          = pattern
@@ -60,11 +60,10 @@ module Nanoc::Int
     #
     # @return [void]
     def apply_to(rep, params = {})
-      compiler = params.fetch(:compiler) do
-        raise ArgumentError, 'Required :compiler option is missing'
-      end
-      rep = Nanoc::Int::ItemRepProxy.new(rep, compiler) unless rep.proxy?
-      context = Nanoc::Int::RuleContext.new(rep: rep, compiler: compiler)
+      compiler = params.fetch(:compiler)
+      executor = params.fetch(:executor)
+
+      context = Nanoc::Int::RuleContext.new(rep: rep, executor: executor, compiler: compiler)
       context.instance_exec(matches(rep.item.identifier), &@block)
     end