nutils 0.6.4 → 0.7.0

data/README.md

@@ -13,5 +13,8 @@ A set of utilities for Nanoc3.
 ## Data Sources
 * **filesystem_customizable** Allows an array for source directories and for layout directories.
 
+## Helpers
+* **load_rules** Allows to use multiple files with Nanoc rules.
+
 ## Contact
 You can reach me at <arnau.siches@gmail.com>.

data/lib/nutils/base/errors.rb

@@ -0,0 +1,16 @@
+module Nutils
+  module Errors
+    
+    # Error that is raised when no partial rules file can be found in any
+    # directory provided.
+    class NoRulesFileFound < ::Nanoc3::Errors::NoRulesFileFound
+
+      # @param [String] filename The file name not found.
+      def initialize(filename)
+        super("No file found in any directory provided for “#{filename}”".make_compatible_with_env)
+      end
+
+    end
+    
+  end
+end

data/lib/nutils/base.rb

@@ -0,0 +1,5 @@
+module Nutils
+  
+  autoload "Errors", "nutils/base/errors"
+  
+end

data/lib/nutils/data_sources/filesystem_customizable.rb

@@ -8,7 +8,7 @@ module Nutils
     # The +filesystem_customizable+ data source allows an array for source 
     # directories and for layout directories.
     #
-    # @example config.yaml excerpt
+    # @example Config.yaml excerpt
     #   data_sources:
     #     -
     #       type: filesystem_customizable

data/lib/nutils/helpers/rules.rb

@@ -0,0 +1,48 @@
+module Nutils
+  module Helpers
+
+    # @author Arnau Siches
+    #
+    # @version 0.1.0
+    # 
+    # Provides some helper functions to process Rules.
+    module Rules
+      
+      # Compiles the content as a set of Nanoc rules. Tries to use the 
+      # +rules_dir+ attribute from the Config.yaml.
+      # If +rules_dir+ is not defined, it uses +"."+ as a base path.
+      # 
+      # @example Config.yaml excerpt
+      # 
+      #   rules_dir: ['lib/rules/**', 'lib/other_rules']
+      #
+      # @example Rules excerpt
+      # 
+      #   # Finds any foo.rule in all directories defined in the Config.yaml
+      #   load_rules('foo.rule')
+      # 
+      # @param [String] filepath The file path to load.
+      # 
+      # @return [Proc]
+      def load_rules(filepath)
+        rules_dir = @site.config[:rules_dir] || ['.']
+
+        path = rules_dir.map do |dir|
+          Dir[File.join(dir, filepath)].each { |filename| filename }
+        end.flatten
+
+        if path.length > 1
+          puts "\e[1mwarning\e[0m Multiple matches for #{filepath}:",
+               "  #{path.join("\n  ")}",
+               "  \e[1mused\e[0m #{path[0]}"
+        elsif path.length == 0
+          raise Nutils::Errors::NoRulesFileFound.new(filepath)
+        end
+
+        instance_eval(File.read(path[0]), path[0])
+      end
+
+    end
+
+  end
+end

data/lib/nutils/helpers.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Nutils
+  module Helpers
+    autoload "Rules", "nutils/helpers/rules"
+  end
+end

data/lib/nutils.rb

@@ -3,7 +3,7 @@
 module Nutils
 
   # The current nutils version.
-  VERSION = "0.6.4"
+  VERSION = "0.7.0"
 
 end
 
@@ -11,5 +11,7 @@ end
 require "nanoc3"
 
 # Load nutils
+require "nutils/base"
 require "nutils/data_sources"
 require "nutils/filters"
+require "nutils/helpers"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nutils
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
-  - 4
-  version: 0.6.4
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Arnau Siches
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-12 00:00:00 -05:00
+date: 2011-02-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,8 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files: 
+- lib/nutils/base/errors.rb
+- lib/nutils/base.rb
 - lib/nutils/data_sources/filesystem_customizable.rb
 - lib/nutils/data_sources.rb
 - lib/nutils/filters/beautify.rb
@@ -53,6 +55,8 @@ files:
 - lib/nutils/filters/svg2png.rb
 - lib/nutils/filters/yuicompressor.rb
 - lib/nutils/filters.rb
+- lib/nutils/helpers/rules.rb
+- lib/nutils/helpers.rb
 - lib/nutils.rb
 - README.md
 - LICENSE