jekyll-testtasks 0.0.1 → 0.0.2

data/README

@@ -2,18 +2,26 @@
 
 == VERSION
 
-This documentation refers to jekyll-testtasks version 0.0.1
+This documentation refers to jekyll-testtasks version 0.0.2
 
 
 == DESCRIPTION
 
 Simplifies testing your Jekyll plugins. Just add this to your Rakefile:
 
-  require 'jekyll/testtasks'
+  require 'jekyll/testtasks/rake'
 
 Currently only allows to run Jekyll's original test tasks with your plugin
 loaded to make sure you didn't break anything. More to come?
 
+Note that your Jekyll installation needs to be patched in order to run with
+your plugin loaded. The necessary patch will be displayed when you try to
+run a task against an unpatched installation.
+
+You can point at the Jekyll installation to use by either setting the
+environment variable +JEKYLL+ or by creating a file <tt>.jekyll</tt> in
+your plugin's project directory with the path in it.
+
 
 == LINKS
 

data/lib/jekyll/testtasks.rb

@@ -4,12 +4,15 @@ module Jekyll
 
     extend self
 
+    # Jekyll's test tasks to install for the plugin
+    TASKS = %w[test features].freeze
+
     caller.find { |f| f =~ %r{(.*)/Rakefile:\d+(?::|\z)} }
 
     # Where we're called from (the plugin location)
     CALLER = $1 || File.expand_path('../../..', __FILE__)
 
-    # Patch to apply to Jekyll installation
+    # Patch to apply to the Jekyll installation
     JEKYLL_PATCH = <<-JEKYLL_PATCH
 diff --git a/lib/jekyll/site.rb b/lib/jekyll/site.rb
 index 7570cb0..9fbe738 100644
@@ -30,45 +33,88 @@ index 7570cb0..9fbe738 100644
     # call-seq:
     #   setup_env
     #
-    # Set environment variables for patched Jekyll to pick up.
+    # Sets environment variables for the patched Jekyll to pick up.
     def setup_env
       ENV['PLUGIN_PATH'] = Dir[File.expand_path('../jekyll-*/lib', CALLER)].join(':')
       ENV['PLUGIN'] = File.basename(CALLER).sub('-', '/')
     end
 
+    # call-seq:
+    #   ensure_jekyll_patch
+    #
+    # Ensures that the specified Jekyll installation seems
+    # to be patched appropriately.
+    def ensure_jekyll_patch
+      file = File.read('lib/jekyll/site.rb')
+      raise UnpatchedError.new(Dir.pwd) unless %w[PLUGIN_PATH PLUGIN].all? { |k| file =~ /'#{k}'/  }
+    end
+
+    # call-seq:
+    #   jekyll_dir => aString
+    #
+    # Returns the Jekyll installation directory as specified through
+    # the +JEKYLL+ environment variable or the <tt>.jekyll</tt> file
+    # in your plugin's project directory.
+    def jekyll_dir
+      jekyll = ENV['JEKYLL'] || begin
+        dot_jekyll = File.join(CALLER, '.jekyll')
+        File.read(dot_jekyll).strip if File.readable?(dot_jekyll)
+      end
+
+      raise NotSetError unless jekyll
+      raise NotFoundError.new(jekyll) unless File.directory?(jekyll)
+
+      jekyll
+    end
+
+    # call-seq:
+    #   in_jekyll_dir { ... }
+    #
+    # Runs the block inside the Jekyll installation directory.
+    def in_jekyll_dir
+      Dir.chdir(jekyll_dir) { ensure_jekyll_patch; yield }
+    end
+
     # call-seq:
     #   run_jekyll_task(task)
     #
-    # Run Jekyll's original Rake task +task+ with this plugin loaded.
+    # Runs Jekyll's original Rake task +task+.
     def run_jekyll_task(task)
-      abort 'Must set JEKYLL to point at patched Jekyll installation' unless ENV['JEKYLL']
-
-      Dir.chdir(ENV['JEKYLL']) {
-        unless %w[PLUGIN_PATH PLUGIN].all? { |k| system('grep', '-q', "'#{k}'", 'lib/jekyll/site.rb') }
-          warn 'Jekyll must be patched in order to run with this plugin loaded'
-          puts
-          puts JEKYLL_PATCH
+      in_jekyll_dir { system('rake', task) }
+    rescue TestTasksError => err
+      warn err.to_s
+      puts err.payload if err.payload
 
-          abort
-        end
+      exit 1
+    end
 
-        system('rake', task)
-      }
+    # call-seq:
+    #   install_tasks
+    #
+    # Installs the relevant tasks.
+    def install_tasks
+      require 'jekyll/testtasks/rake'
     end
 
-  end
+    class TestTasksError < RuntimeError
+      attr_reader :dir, :payload
 
-end
+      def initialize(dir = nil); @dir = dir; end
+    end
+
+    class NotSetError < TestTasksError
+      def to_s; 'Must set JEKYLL to point at patched Jekyll installation'; end
+    end
 
-# Install test tasks.
-namespace :jekyll do
+    class NotFoundError < TestTasksError
+      def to_s; "Jekyll installation not found at `#{dir}'"; end
+    end
 
-  %w[test features].each { |t|
-    desc "Run Jekyll's original #{t} task with this plugin loaded"
-    task t do
-      Jekyll::TestTasks.setup_env
-      Jekyll::TestTasks.run_jekyll_task t
+    class UnpatchedError < TestTasksError
+      def payload; "\n" + JEKYLL_PATCH; end
+      def to_s; "Jekyll must be patched in order to run with this plugin loaded\n[Found Jekyll at `#{dir}']"; end
     end
-  }
+
+  end
 
 end

data/lib/jekyll/testtasks/helper.rb

@@ -0,0 +1,2 @@
+require 'jekyll/testtasks'
+require File.expand_path('test/helper', Jekyll::TestTasks.jekyll_dir)

data/lib/jekyll/testtasks/rake.rb

@@ -0,0 +1,19 @@
+require 'jekyll/testtasks'
+
+# Install test tasks for Rake.
+namespace :jekyll do
+
+  task :setup_env do
+    Jekyll::TestTasks.setup_env
+  end
+
+  Jekyll::TestTasks::TASKS.each { |t|
+    desc "Run Jekyll's original #{t} task with this plugin loaded"
+    task t => :setup_env do
+      Jekyll::TestTasks.run_jekyll_task(t)
+    end
+  }
+end
+
+desc "Run Jekyll's test tasks (#{Jekyll::TestTasks::TASKS.join(', ')})"
+task :jekyll => Jekyll::TestTasks::TASKS.map { |t| "jekyll:#{t}" }

data/lib/jekyll/testtasks/version.rb

@@ -6,7 +6,7 @@ module Jekyll
 
       MAJOR = 0
       MINOR = 0
-      TINY  = 1
+      TINY  = 2
 
       class << self
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jekyll-testtasks
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jens Wille
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-01 00:00:00 +02:00
+date: 2010-07-02 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -30,7 +30,9 @@ extra_rdoc_files:
 - ChangeLog
 - README
 files: 
+- lib/jekyll/testtasks/helper.rb
 - lib/jekyll/testtasks/version.rb
+- lib/jekyll/testtasks/rake.rb
 - lib/jekyll/testtasks.rb
 - README
 - ChangeLog