smartgen 0.2.0 → 0.3.0

data/ChangeLog.md

@@ -1,3 +1,8 @@
+0.3.0
+-----
+
+* Added a rake task that regenerates files as they are added, changed or deleted
+
 0.2.0
 -----
 

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    smartgen (0.1.2)
+    smartgen (0.3.0)
       RedCloth (>= 4.2.3)
       activesupport (>= 2.3.5)
       bluecloth (>= 2.0.9)
+      directory_watcher (>= 1.3.2)
       i18n (>= 0.5.0)
       nokogiri (>= 1.4.4)
       thor (>= 0.14.6)
@@ -18,6 +19,7 @@ GEM
     bluecloth (2.0.9)
     columnize (0.3.2)
     diff-lcs (1.1.2)
+    directory_watcher (1.3.2)
     i18n (0.5.0)
     linecache (0.43)
     linecache19 (0.5.11)
@@ -56,6 +58,7 @@ DEPENDENCIES
   RedCloth (>= 4.2.3)
   activesupport (>= 2.3.5)
   bluecloth (>= 2.0.9)
+  directory_watcher (>= 1.3.2)
   i18n (>= 0.5.0)
   nokogiri (>= 1.4.4)
   rake (= 0.8.7)

data/README.md

@@ -131,9 +131,39 @@ You may also use a rake task:
 
 The yielded config is exactly the same config yielded by Smartgen::Resource#configure method, so you can use any of the above configs.
 
+## Watching for changes
+
+When you are writing documentation it can be boring to always have to regenerate files manually every time you make some changes. Smartgen provides you with a way of regenerate files once they are saved. Just use `Smartgen::WatcherRakeTask`:
+
+    require 'smartgen/watcher_rake_task'
+    
+    Smartgen::WatcherRakeTask.new :my_doc do |config|
+      config.src_files = ['doc/**/*']
+      config.output_folder = 'public/docs'
+    end
+
+When you run this rake task it will generate files based on this configuration and start watching for changes. Whenever you create, modify or delete a file, it will regenerate all files for you, just reload your browser!
+
+If you want to have the ability to generate files instantly and also have a watcher you can do this:
+
+    require 'smartgen/rake_task'
+    require 'smartgen/watcher_rake_task'
+    
+    Smartgen::RakeTask.new :my_doc do |config|
+      config.src_files = ['doc/**/*']
+      config.output_folder = 'public/docs'
+    end
+    
+    Smartgen::WatcherRakeTask.new :watch_my_doc, :my_doc
+
+Then you can call both `my_doc` and `watch_my_doc`:
+
+    rake my_doc          # generates files right away
+    rake watch_my_doc    # generates files and watch for changes
+
 ## Contributors
 
-* [Vicente Mundim](http://github.com/vicentemundim) _author_
+* [Vicente Mundim](http://github.com/vicentemundim) _(author)_
 * [Emerson Leite](http://github.com/emerleite)
 * [Rodrigo Lopes](http://github.com/rodvlopes)
 * [Marcos Silva Pereira](http://github.com/marcospereira)

data/lib/smartgen.rb

@@ -2,6 +2,7 @@
 require File.expand_path(File.join('smartgen', 'object_hash'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'resource'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'configuration'), File.dirname(__FILE__))
+require File.expand_path(File.join('smartgen', 'watcher'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'indexer'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'markup_file'), File.dirname(__FILE__))
 require File.expand_path(File.join('smartgen', 'renderers'), File.dirname(__FILE__))

data/lib/smartgen/resource.rb

@@ -16,7 +16,7 @@ module Smartgen
     
     # Yields a Configuration, so that you can configure the generation of files.
     def configure
-      yield config
+      yield config if block_given?
     end
   
     # Returns the Configuration for this resource.

data/lib/smartgen/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 module Smartgen
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/smartgen/watcher.rb

@@ -0,0 +1,75 @@
+require 'directory_watcher'
+
+module Smartgen
+  # Watches for changes in configured files and regenerated them as they are changed.
+  #
+  # Just pass the name of the resource to it and call #start. It will generate
+  # the files right away and it will keep watching for changes in those files.
+  # Every time a file is added, changed or removed, it will regenerate all
+  # files.
+  #
+  # You can also pass a block when initializing to create and configure the
+  # resource.
+  #
+  # For example:
+  #
+  #   watcher = Smartgen::Watcher.new :my_resource do |config|
+  #     config.src_files = ['docs/**/*']
+  #     config.output_folder = 'public_docs'
+  #   end
+  #
+  #   watcher.start
+  class Watcher
+    attr_accessor :name
+    
+    def initialize(name, &block)
+      @name = name
+      configure(&block)
+    end
+    
+    # Starts watching files for changes.
+    def start
+      puts "Watching these files for changes #{glob}..."
+      configure_directory_watcher
+      setup_graceful_exit
+      
+      directory_watcher.start.join
+    end
+    
+    # Generate files.
+    def generate(*args)
+      puts "Regenerating files, #{args.size} files have been added/changed/removed."
+      Smartgen[@name].generate!
+      puts "Files generated."
+    end
+    
+    private
+      def resource
+        Smartgen[name]
+      end
+    
+      def configure(&block)
+        resource.configure(&block)
+      end
+      
+      def directory_watcher
+        @directory_watcher ||= DirectoryWatcher.new '.', :glob => glob
+      end
+      
+      def glob
+        resource.config.src_files
+      end
+      
+      def configure_directory_watcher
+        directory_watcher.interval = 2
+        directory_watcher.add_observer self, :generate
+      end
+    
+      def setup_graceful_exit
+        Kernel.trap 'INT' do
+          puts "Stopping watcher..."
+          directory_watcher.stop
+        end
+      end
+  end
+end

data/lib/smartgen/watcher_rake_task.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'rake/tasklib'
+require 'smartgen'
+
+module Smartgen
+  # A rake task that starts a watcher for file changes and generate them on
+  # demand, using smartgen.
+  #
+  # To use it, require this file instead of +smartgen+:
+  #
+  #   require 'smartgen/watcher_rake_task'
+  #
+  # Then create the task and configuration:
+  #
+  #   Smartgen::WatcherRakeTask.new :generate_doc do |config|
+  #     config.src_files = ['doc/**/*']
+  #     config.output_folder = 'public/doc'
+  #   end
+  #
+  # It yields a Configuration, in fact it calls Resource#configure, so you
+  # can use any of the configurations here.
+  #
+  # When you run this task it will start the watcher and wait for file changes,
+  # just go editing your files, and it will regenerate them as you change files.
+  #
+  # You may also use an existing configuration, while still having a different
+  # task name:
+  #
+  #   Smartgen::WatcherRakeTask.new :watcher, :generate_doc do |config|
+  #     config.src_files = ['doc/**/*']
+  #     config.output_folder = 'public/doc'
+  #   end
+  #
+  # This will use Smartgen[:generate_doc] config, but you will call it with:
+  #
+  #   rake watcher
+  class WatcherRakeTask < ::Rake::TaskLib
+    def initialize(resource_or_task_name=nil, resource_name=nil, &block)
+      task_name = resource_or_task_name || 'smartgen:watcher'
+      resource_name = resource_name || task_name
+      
+      watcher = Smartgen::Watcher.new resource_name, &block
+      
+      desc("Watches for changes in files and generate them using smartgen") unless ::Rake.application.last_comment
+      task task_name do
+        watcher.start
+      end
+    end
+  end
+end

data/spec/lib/smartgen/watcher_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Smartgen::Watcher do
+  it "should create a resource and yield its configuration" do
+    expected_config = nil
+    Smartgen::Watcher.new(:my_resource) { |config| expected_config = config }
+    expected_config.should == Smartgen[:my_resource].config
+  end
+  
+  context "when it will start watching" do
+    def src_files
+      ['doc/**/*']
+    end
+    
+    def directory_watcher
+      return @directory_watcher if @directory_watcher
+      
+      @directory_watcher = mock(DirectoryWatcher, :add_observer => 'observer', :interval= => '2')
+      @directory_watcher.stub!(:start).and_return(@directory_watcher)
+      @directory_watcher.stub!(:join).and_return(@directory_watcher)
+      @directory_watcher
+    end
+    
+    before do
+      DirectoryWatcher.stub!(:new).and_return(directory_watcher)
+    end
+    
+    subject do
+      Smartgen::Watcher.new(:my_resource) do |config|
+        config.src_files = src_files
+        config.output_folder = 'public/docs'
+      end
+    end
+    
+    it "should create a directory watcher, pre loading src_files" do
+      DirectoryWatcher.should_receive(:new).with('.', :glob => src_files).and_return(directory_watcher)
+      capture(:stdout) { subject.start }
+    end
+    
+    it "should add itself as an observer, with :generate method as the callback" do
+      directory_watcher.should_receive(:add_observer).with(subject, :generate)
+      capture(:stdout) { subject.start }
+    end
+    
+    it "should start watching" do
+      directory_watcher.should_receive(:start)
+      directory_watcher.should_receive(:join)
+      capture(:stdout) { subject.start }
+    end
+    
+    it "should set interval to 2 seconds" do
+      directory_watcher.should_receive(:interval=).with(2)
+      capture(:stdout) { subject.start }
+    end
+
+    context "when generating" do
+      it "should generate files" do
+        Smartgen[:my_resource].should_receive(:generate!)
+        capture(:stdout) { subject.generate }
+      end
+    end
+    
+    context "when user hits ctrl+c" do
+      it "should exit gracefully" do
+        directory_watcher.should_receive(:stop)
+        Kernel.should_receive(:trap).with('INT').and_yield
+        capture(:stdout) { subject.start }
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smartgen
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Vicente Mundim
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-27 00:00:00 -02:00
+date: 2011-01-28 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -115,9 +115,25 @@ dependencies:
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: directory_watcher
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -129,7 +145,7 @@ dependencies:
         - 0
         version: 2.3.0
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 description: Smartgen generates static HTML files from markup files, using textile or markdown, and ERB to create layout templates
 email: 
 - vicente.mundim@gmail.com
@@ -154,6 +170,8 @@ files:
 - lib/smartgen/renderers.rb
 - lib/smartgen/resource.rb
 - lib/smartgen/version.rb
+- lib/smartgen/watcher.rb
+- lib/smartgen/watcher_rake_task.rb
 - lib/smartgen.rb
 - Gemfile
 - Gemfile.lock
@@ -193,6 +211,7 @@ files:
 - spec/lib/smartgen/object_hash_spec.rb
 - spec/lib/smartgen/renderers/erb_spec.rb
 - spec/lib/smartgen/resource_spec.rb
+- spec/lib/smartgen/watcher_spec.rb
 - spec/lib/smartgen_spec.rb
 - spec/sandbox/.gitkeep
 - spec/spec_helper.rb
@@ -264,6 +283,7 @@ test_files:
 - spec/lib/smartgen/object_hash_spec.rb
 - spec/lib/smartgen/renderers/erb_spec.rb
 - spec/lib/smartgen/resource_spec.rb
+- spec/lib/smartgen/watcher_spec.rb
 - spec/lib/smartgen_spec.rb
 - spec/sandbox/.gitkeep
 - spec/spec_helper.rb