sidekick 0.4.2 → 0.5.0

data/.sidekick

@@ -6,7 +6,7 @@
 
 # watch '**/*.rb' {|paths| log 'made edits' }
 
-# every(20) { notify sh 'fortune' }
+every(5) { notify sh 'fortune' }
 
 auto_compile 'test/fixtures/*.haml', 'test/output/:name.html'
 

data/README.textile

@@ -7,39 +7,24 @@ h3. Use cases
 
 * Restart server when code is changed
 * Compile Sass and CoffeeScript templates when they are updated
+* Periodically run commands
 * Continuous testing, with notifications and flexible hooks
-* Periodically running commands
 
-You typically run Sidekick in the background while coding, to automate all this.
+You typically run Sidekick in the background to automate this while coding.
 
 h3. Features
 
-* Simple and powerful DSL. "Examples here.":http://github.com/jbe/sidekick/blob/master/lib/template
-* Use triggers to watch files etc.
-* Use helpers to compile templates etc.
-* Easy to write new triggers and helpers.
-* Already compiles many languages, thanks to "Tilt":http://github.com/rtomayko/tilt.
-
-
+* Simple and powerful DSL ("examples":http://github.com/jbe/sidekick/blob/master/lib/template).
+* Easy to extend
+* Compiles many languages, thanks to "Tilt":http://github.com/rtomayko/tilt.
+* Powered by "EventMachine":http://github.com/eventmachine/eventmachine
+* Short "core library":http://github.com/jbe/sidekick/blob/master/lib/sidekick.rb -- about 70 lines of code.
 
 h2. Basic usage
 
 Install with @gem install sidekick@ and invoke using the @sidekick@ command in your project folder. If you do not have a @.sidekick@ file, you will be offered a template.
 
-h3. Currently available triggers:
-
-|@watch(glob) { ... }@|run on file changes matching @glob@. Globs like "Dir[]":http://ruby-doc.org/core/classes/Dir.html#M002323. |
-|@every(duration) { ... }@|run every @duration@ seconds|
-
-h3. Currently available helpers:
-
-|@sh(cmd)@|run shell command, printing and returning output|
-|@log(str)@|log events to @STDOUT@.|
-|@notify(message, title='sidekick')@|notify user via growl, libnotify etc.|
-|@auto_compile(source_glob, target_path)@|compile on file changes using tilt (language automatically detected -- see example usage in template, and tilt documentation)|
-|@restart_passenger@|restart passenger based environments by touching tmp/restart.txt|
-
-Note how some helpers, like @auto_compile@ set up both triggers and actions for you.
+Read the source to see all available "triggers":http://github.com/jbe/sidekick/blob/master/lib/sidekick/triggers.rb and "helpers":http://github.com/jbe/sidekick/blob/master/lib/sidekick/helpers.rb.
 
 h2. Writing extensions
 
@@ -57,72 +42,18 @@ To add more helpers, simply add methods to @Sidekick::Helpers@, like this:
 </code>
 </pre>
 
-They will be available to other helpers and to @.sidekick@ files. Also, if adding a group of methods it may be cleaner to use a separate module under @Sidekick::Helpers@, and then including it.
+They will be available to other helpers and to @.sidekick@ files. When adding a group of methods it may be cleaner to write a module under @Sidekick::Helpers@, and then including it.
 
 
 h3. Writing new triggers
 
-To add new triggers, you have two options: blocks, and classes. Blocks are best for simple stuff, while classes are good for more complex code. Here are some examples of how you set up a new trigger using a block:
-
-<pre>
-<code lang='ruby'>
-
-Sidekick::Triggers.register(:never) {|callback| }
-# available in .sidekick like:
-# never { puts 'nobody listens to me' }
-
-Sidekick::Triggers.register(:on_startup) {|callback| callback.call }
-# available like:
-# on_startup { puts 'better to do this in the main scope than here' }
-
-Sidekick::Triggers.register(:every) do |callback, duration|
-  timeshare(duration) do
-    callback.call
-  end
-end
-
-</code>
-</pre>
-
-The last example is the internal implementation of the @every@ trigger seen earlier, which calls the block periodically. @callback@ is the block given to the trigger in the @.sidekick@ file. @timeshare@ is a special method provided by Sidekick to all extensions, to register the supplied block to be called every @duration@ seconds. This is useful for polling something without blocking or doing something out of this world.
-
-Now, here is the last example written as a class:
-
-<pre>
-<code lang='ruby'>
-
-class Sidekick::Triggers::Every
-
-  def initialize(callback, duration)
-    @callback = callback
-    @duration = duration
-  end
-
-  def poll
-    @callback.call
-  end
-
-  def poll_freq
-    @duration
-  end
-end
-
-Sidekick::Triggers.register_class(:watch, Watch)
-
-</code>
-</pre>
-
-The @poll@ and @poll_freq@ methods are optional. @poll@ functions like the callback block in the previous example, while @poll_freq@ functions like the @duration@ argument, specifying how often to call @poll@. Only integers (whole seconds) are accepted. Finally, notice the last statement, which registers the class.
-
-h2. Fun facts
-
-The main code chunk of Sidekick is just under 100 lines, including documentation, excluding the default triggers and helpers.
+Have a look at the "existing triggers":http://github.com/jbe/sidekick/blob/master/lib/sidekick/triggers.rb, and you will get the idea. Basically, you define new triggers by calling @Sidekick::Triggers.register(:trigger_name) { .. }@, and hooking into EventMachine the same way as in @EM.run { .. }@.
 
 You can keep your extensions in the @.sidekick@ file itself, or package them in gems, or (better) ask me to merge them into the main repository.
 
-Similar projects:
+h3. Similar projects:
 
-* "Guard":http://github.com/guard/guard (too enterprisey imho)
+* "Guard":http://github.com/guard/guard
 
 
 h3. Copyright

data/Rakefile

@@ -6,11 +6,13 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "sidekick"
     gem.summary = %Q{Automatically run common development tasks on events, as defined by a local .sidekick file.}
-    gem.description = %Q{Automatically run common development tasks on events, as defined by a local .sidekick file. Easy, powerful dsl. Several pre-defined triggers. Helper methods for common tasks. Easy to extend with new triggers and helpers.}
+    gem.description = %Q{Automatically run common development tasks on events, as defined by a local .sidekick file. Easy, powerful dsl including useful pre-defined triggers and helper methods for common tasks. Powered by EventMachine and easy to extend.}
     gem.email = "post@jostein.be"
     gem.homepage = "http://github.com/jbe/sidekick"
     gem.authors = ["Jostein Berre Eliassen,"]
     gem.add_dependency "tilt", ">= 1"
+    gem.add_dependency "eventmachine", ">= 0"
+    gem.add_dependency "em-dir-watcher", ">= 0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/lib/sidekick.rb

@@ -1,102 +1,68 @@
 require 'fileutils'
+require 'eventmachine'
 
 module Sidekick
 
-  # creates a module wrapper, which in turn
-  # evaluates the .sidekick config file within
-  # its own scope
-  def self.run!(conf_path='.sidekick')
-    unless File.exists?(conf_path)
-      puts 'Generate new sidekick file? (Y/n)'
-      unless gets =~ /^N|n/ # 1.8 and 1.9 compatibility
-        FileUtils.cp(File.expand_path('../template', __FILE__), conf_path)
-      else
-        exit
-      end
-    end
-    Context.new(conf_path)
-    Triggers.enter_loop
-  end
-
-
-  # A new Context is used to run the .sidekick
-  # config file. It simply extends Module.
-  class Context < ::Module
-    def initialize(conf_path)
-      super()
-      extend MethodProxy
-      extend Helpers
-      code = open(conf_path) { |f| f.read }
-      module_eval(code, conf_path)
-    end
-  end
-
-  # New contexts also extend MethodProxy, so that they
-  # can forward method calls to the registered sidekicks.
-  module MethodProxy
+  module Triggers
     @@triggers = {}
 
-    # registers a trigger
-    def self.register(name, block)
+    def self.register(name, &block)
       @@triggers[name] = block
     end
 
+    def self.log(str) # used by triggers
+      puts str
+    end
+
     def method_missing(name, *args, &blk)
-      if @@triggers[name]
-        @@triggers[name].call(blk, *args)
-      else
-        super
-      end
+      @@triggers[name] ?
+        @@triggers[name].call(blk, *args) : super
     end
 
     def respond_to?(method)
       super || !!@@triggers[method]
     end
+
   end
 
-  # contains trigger helpers and logic to register
-  # triggers, making them available in sidekick
-  module Triggers
-    @@timeshare_callbacks = []
-    @@timeshare_frequencies = []
-
-    class << self
-
-      # registers a sidekick available to .sidekick files
-      def register(name, &block)
-        MethodProxy.register(name, block)
-      end
-
-      # registers a callback for timesharing between
-      # active sidekicks
-      def timeshare(freq=1, &callback)
-        @@timeshare_callbacks << callback
-        @@timeshare_frequencies << freq
-      end
-
-      # begins the timesharing loop
-      def enter_loop
-        Signal.trap :INT do
-          exit
-        end
-
-        0.upto(1.0/0) do |n|
-          0.upto(@@timeshare_callbacks.size - 1) do |i|
-            if n % @@timeshare_frequencies[i] == 0
-              @@timeshare_callbacks[i].call(n)
-            end
-          end
-          sleep 1
-        end
-      end
-
-      def log(str)
-        puts str
-      end
+  # default library
+  require 'sidekick/triggers'
+  require 'sidekick/helpers'
 
+  # context in which to evaluate .sidekick file
+  Context = Module.new
+  Context.extend Triggers
+  Context.extend Helpers
+
+
+  def self.ensure_config_exists(path)
+    unless File.exists?(path)
+      puts 'Generate new sidekick file? (Y/n)'
+      gets =~ /^N|n/ ?
+        FileUtils.cp(File.expand_path('../template',
+          __FILE__), path) : exit
     end
   end
-end
 
-require 'sidekick/helpers'
-require 'sidekick/triggers'
+  # reads and applies the .sidekick file, and begins
+  # the event loop.
+  def self.run!(path='.sidekick')
+
+    ensure_config_exists(path)
+
+    Signal.trap(:INT) { ::Sidekick.stop }
+
+    EventMachine.run do
+      Context.module_eval(
+        open(path) {|f| f.read }, path )
+    end
+  end
+
+  # stops Sidekick gracefully
+  def self.stop(msg=false)
+    EventMachine.stop
+    puts
+    puts msg if msg
+  end
+
+end

data/lib/sidekick/helpers.rb

@@ -7,53 +7,33 @@ require 'tilt'
 
 module Sidekick::Helpers
 
-  module Util
-    # :linux, :darwin, :other
-    def platform
-      [:linux, :darwin].each do |plf|
-        return plf if Config::CONFIG['target_os'] =~ /#{plf}/i
-      end; :other
-    end
-
-    def running?(plf)
-      plf == platform
-    end
-
-    def gem_load?(gemname)
-      @installed ||= begin
-        require gemname
-        true
-      rescue LoadError
-        puts "Please install the #{gemname} gem to enable all functions."
-        false
-      end
-    end
-  end
+  # system
 
+  require 'sidekick/helpers/util'
   include Util
-  extend Util
 
-  module Notification
-    extend ::Sidekick::Helpers::Util
-    def self.show(message, title='Sidekick')
-      if running?(:linux) and gem_load?('libnotify')
-        Libnotify.show :body => message, :summary => title
-      elsif running?(:darwin) and gem_load?('growl')
-        Growl.notify message, :title => title, :name => 'Sidekick'
-      else
-        puts "Notification: #{title} #{message}"
-      end
-    end
+  def log(str)
+    puts ' -> ' + str
   end
 
+  def stop(*prms)
+    Sidekick.stop(*prms)
+  end
 
+  # notifications
 
-  def log(str)
-    puts ' -> ' + str
-  end
+  def notify(message, title='Sidekick')
+    
+    gems = {:linux => 'libnotify', :darwin => 'growl'}
 
-  def notify(*args)
-    Notification.show(*args)
+    stop('Notifications not supported.') unless platform_load?(
+                                          gems, 'notifications')
+    case platform
+      when :linux
+        Libnotify.show :body => message, :summary => title
+      when :darwin
+        Growl.notify message, :title => title, :name => 'Sidekick'
+    end
   end
 
   def sh(cmd)
@@ -62,36 +42,30 @@ module Sidekick::Helpers
     result
   end
 
-
-
   def restart_passenger
     FileUtils.touch './tmp/restart.txt'
     log 'restarted passenger'
   end
 
-
-
-
   # watches for changes matching the source glob,
   # compiles using the tilt gem, and saves to
   # target. Target is interpolated for :name
   def auto_compile(source, target)
     watch(source) do |files|
       files.each do |file|
-        begin
-          t = target.gsub ':name', File.basename(file, '.*')
-          File.open(t, 'w') do |f|
-            f.write(Tilt.new(file).render)
+        if File.exists?(file)
+          begin
+            t = target.gsub(':name', File.basename(file, '.*'))
+            File.open(t, 'w') do |f|
+              f.write(Tilt.new(file).render)
+            end
+            log "render #{file} => #{t}"
+          rescue Exception => e
+            notify "Error in #{file}:\n#{e}"
           end
-          log "rendered #{file} => #{target}"
-        rescue Exception => e
-          notify "Error in #{file}:\n#{e}"
         end
       end
     end
   end
 
-
-
-
 end

data/lib/sidekick/helpers/util.rb

@@ -0,0 +1,26 @@
+
+
+
+
+module Util
+  # :linux, :darwin, :other
+  def platform
+    [:linux, :darwin].each do |plf|
+      return plf if Config::CONFIG['target_os'] =~ /#{plf}/i
+    end; :other
+  end
+
+  def gem_load?(gemname, function='full')
+    @installed ||= begin
+      require gemname
+      true
+    rescue LoadError
+      "Please gem install #{gemname} for #{function} support."
+      ::Sidekick.stop
+    end
+  end
+
+  def platform_load?(gems, function='full')
+    gem_load?(gems[platform], function)
+  end
+end

data/lib/sidekick/triggers.rb

@@ -1,25 +1,26 @@
 
 
-module Sidekick::Triggers
+require 'em-dir-watcher'
 
-  # registers a class conforming to the sidekick
-  # trigger class api
-  def self.register_class(keyword, kls)
-    register(keyword) do |*prms|
-      o = kls.new(*prms)
-      freq = o.respond_to?(:poll_freq) ? o.poll_freq : 1
-      timeshare(freq) { o.poll } if o.respond_to? :poll
-    end
-  end
+
+module Sidekick::Triggers
 
   # default triggers
 
-  require 'sidekick/triggers/watch'
+  register :watch do |callback, glob|
+    EMDirWatcher.watch(
+      File.expand_path('.'),
+      :include_only => [glob],
+      :grace_period => 0.2
+      ) do |paths|
+      log "watch #{paths.inspect}"
+      callback.call(paths)
+    end
+  end
 
-  register_class(:watch, Watch)
-  
   register :every do |callback, duration|
-    timeshare(duration) do
+    EventMachine::PeriodicTimer.new(duration) do
+      log "every #{duration} seconds"
       callback.call
     end
   end

data/lib/template

@@ -2,7 +2,7 @@
 
 
 
-abort "A new .sidekick file was generated -- now you just have to edit it."
+stop "A new .sidekick file was generated -- now you just have to edit it."
 
 
 # now delete the above, and set up some actions.

data/sidekick.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sidekick}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jostein Berre Eliassen,"]
   s.date = %q{2010-10-26}
   s.default_executable = %q{sidekick}
-  s.description = %q{Automatically run common development tasks on events, as defined by a local .sidekick file. Easy, powerful dsl. Several pre-defined triggers. Helper methods for common tasks. Easy to extend with new triggers and helpers.}
+  s.description = %q{Automatically run common development tasks on events, as defined by a local .sidekick file. Easy, powerful dsl including useful pre-defined triggers and helper methods for common tasks. Powered by EventMachine and easy to extend.}
   s.email = %q{post@jostein.be}
   s.executables = ["sidekick"]
   s.extra_rdoc_files = [
@@ -29,8 +29,8 @@ Gem::Specification.new do |s|
      "bin/sidekick",
      "lib/sidekick.rb",
      "lib/sidekick/helpers.rb",
+     "lib/sidekick/helpers/util.rb",
      "lib/sidekick/triggers.rb",
-     "lib/sidekick/triggers/watch.rb",
      "lib/template",
      "sidekick.gemspec",
      "test/fixtures/page.haml",
@@ -55,11 +55,17 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<tilt>, [">= 1"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_runtime_dependency(%q<em-dir-watcher>, [">= 0"])
     else
       s.add_dependency(%q<tilt>, [">= 1"])
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<em-dir-watcher>, [">= 0"])
     end
   else
     s.add_dependency(%q<tilt>, [">= 1"])
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<em-dir-watcher>, [">= 0"])
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Jostein Berre Eliassen,
@@ -30,7 +30,33 @@ dependencies:
         version: "1"
   type: :runtime
   version_requirements: *id001
-description: Automatically run common development tasks on events, as defined by a local .sidekick file. Easy, powerful dsl. Several pre-defined triggers. Helper methods for common tasks. Easy to extend with new triggers and helpers.
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: em-dir-watcher
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Automatically run common development tasks on events, as defined by a local .sidekick file. Easy, powerful dsl including useful pre-defined triggers and helper methods for common tasks. Powered by EventMachine and easy to extend.
 email: post@jostein.be
 executables: 
 - sidekick
@@ -50,8 +76,8 @@ files:
 - bin/sidekick
 - lib/sidekick.rb
 - lib/sidekick/helpers.rb
+- lib/sidekick/helpers/util.rb
 - lib/sidekick/triggers.rb
-- lib/sidekick/triggers/watch.rb
 - lib/template
 - sidekick.gemspec
 - test/fixtures/page.haml

data/lib/sidekick/triggers/watch.rb

@@ -1,55 +0,0 @@
-
-
-module Sidekick::Triggers::Watch
-
-  def self.new(*args)
-
-    name, adapter_class = {
-      :linux    => [nil,  Polling], # Ready to implement fs-event
-      :darwin   => [nil,  Polling], # and libnotify. Polling seems
-      :other    => [nil,  Polling]  # to work perfectly though.
-      }[::Sidekick::Helpers.platform]
-
-    unless name.nil?
-      adapter_class = Polling unless Sidekick::Helpers.load_gem?(name)
-    end
-    adapter_class.new(*args)
-  end
-
-  class Polling # todo: check for deletion
-
-    def initialize(callback, glob, ignore_first=false)
-      ::Sidekick::Triggers.log "polling #{glob} for file changes.."
-      @path = glob
-      @file_timestamps = {}
-      @callback = callback
-      read_changes if ignore_first # prebuild cache
-    end
-
-    def poll
-      if changed?
-        ::Sidekick::Triggers.log "modified #{@changes.inspect}"
-        @callback.call(@changes)
-      end
-    end
-
-    private
-
-      def changed?
-        read_changes
-        !@changes.empty?
-      end
-
-      def read_changes
-        @changes = []
-        Dir[@path].each do |path|
-          mtime = File.new('./' + path).mtime
-          unless @file_timestamps[path] == mtime
-            @changes << path
-            @file_timestamps[path] = mtime
-          end
-        end
-      end
-  end
-
-end