sidekick 0.6.2 → 0.6.3

data/.sidekick

@@ -1,6 +1,9 @@
 
+on_start { notify 'started..' }
 
-# every(5) { notify sh 'fortune' }
+on_stop { notify 'stopped..' }
+
+after(5) { notify sh 'fortune' }
 
 watch('lib/**.rb') { rake 'docs' }
 
@@ -10,4 +13,6 @@ auto_compile 'test/fixtures/*.sass', 'test/output/:name.css'
 
 auto_compile 'test/fixtures/*.coffee', 'test/output/:name.js'
 
+passenger_server 3002
+
 # vim:ft=ruby

data/README.textile

@@ -3,7 +3,7 @@ h1. Sidekick
 "Sidekick":http://ibuildlegobricks.tumblr.com/post/1398895151/automate-common-tasks-with-sidekick is a command line tool to automatically trigger actions on certain events, as defined per project, in a local @.sidekick@ file in your project folder:
 
 <pre><code>
-watch('**/*.rb') { restart_passenger; rake docs }
+watch('**/*.rb') { restart_passenger; rake 'docs' }
 
 auto_compile 'assets/*.sass', 'public/:name.css'
 
@@ -23,7 +23,7 @@ h3. Features
 * Easy to extend
 * Compiles many formats, thanks to "Tilt":http://github.com/rtomayko/tilt.
 * Powered by "EventMachine":http://github.com/eventmachine/eventmachine
-* Short and sweet codebase - core < 100 loc
+* Very brief and concise codebase.
 
 You can "read the annotated source code":http://jbe.github.com/sidekick/sidekick.html.
 
@@ -31,16 +31,11 @@ h2. Basic usage
 
 Install with @gem install sidekick@ and invoke the @sidekick@ command in your project folder. If you do not have a @.sidekick@ file, you will be offered a "template":http://github.com/jbe/sidekick/blob/master/lib/template with plenty of examples.
 
-View source:
-
-* "triggers":http://jbe.github.com/sidekick/triggers.html
-* "helpers":http://github.com/jbe/sidekick/tree/master/lib/sidekick/helpers/
-
 h2. Defining new triggers
 
-Have a look at the "existing triggers":http://jbe.github.com/sidekick/triggers.html, 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 { .. }@ from there.
+Have a look at the "existing triggers":http://jbe.github.com/sidekick/triggers.html, and you will get the idea. Basically, you define new triggers by writing methods that hook into "EventMachine":http://github.com/eventmachine/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.
+If you write some useful extensions, please ask me to merge them into the main repository.
 
 h3. Copyright
 

data/Rakefile

@@ -6,8 +6,8 @@ begin
   require 'jeweler'
   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. Powered by EventMachine. Easy to extend.}
+    gem.summary = %Q{Automatically run common development tasks on events.}
+    gem.description = %Q{Automatically run common development tasks on events, as prescribed in a local .sidekick file. Easy, powerful DSL. Powered by EventMachine.}
     gem.email = "post@jostein.be"
     gem.homepage = "http://github.com/jbe/sidekick"
     gem.authors = ["Jostein Berre Eliassen,"]

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.3

data/bin/sidekick

@@ -10,4 +10,4 @@ end
 puts '                       ^  ^  ^  ^    '
 puts ' == SIDEKICK ==    ^ ctrl-c to exit ^'
 puts '                                     '
-Sidekick.run!
+Sidekick.run!( ARGV.first || '.sidekick' )

data/lib/sidekick.rb

@@ -4,50 +4,16 @@
 #
 # ***
 #
-# Sidekick basically helps you do two things:
-#
-# -- *Define* named triggers, such as saying that `watch(glob)` means doing something when a file matching `glob` changes, or that `every(duration)` means doing something every `duration` seconds.
-#
-# -- *Use* the defined triggers with callbacks, such as `watch(**.rb) { notify 'Code change' }`
+# The default trigger definitions and helper methods -- commonly referred to as actions -- are automagically required and included from `lib/sidekick/actions/**.rb`.
 
 require 'fileutils'
 require 'eventmachine'
 
 module Sidekick
 
-  # This core functionality is provided by `Sidekick::Triggers`.
-  #
-  # New triggers can be defined by calling `Sidekick::Triggers.register(:trigger_name) { ... }`.
-  #
-  #Basically, the job of a trigger definition is to take the parameters and the block from a directive in the `.sidekick` file, and then hook into EventMachine in some way to set up the trigger. -- Just have a look at the [default trigger library](http://jbe.github.com/sidekick/triggers.html).
-  #
-  # By using Ruby's `method_missing`, we can forward method calls to the registered trigger definitions. Any module can thereby extend the `Sidekick::Triggers` module in order to expose the defined triggers as if they were methods.
-  module Triggers
-    @@triggers = {}
-
-    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)
-      @@triggers[name] ?
-        @@triggers[name].call(blk, *args) : super
-    end
-
-    def respond_to?(method)
-      super || !!@@triggers[method]
-    end
-
-  end
-
-  # This part includes the default trigger definitions and helper methods. `Sidekick::Helpers` automagically loads the code in `sidekick/helpers` and then includes its sub-modules.
-
-  module Sidekick::Helpers
-    Dir[File.dirname(__FILE__) + '/sidekick/helpers/**.rb'
+  module Sidekick::Actions
+    Dir[
+      File.join File.dirname(__FILE__), *%w{sidekick actions **.rb}
       ].each {|path| load path }
 
     constants.each do |name|
@@ -55,15 +21,10 @@ module Sidekick
     end
   end
 
-  require 'sidekick/triggers'
-
-  # The `.sidekick` file is evaluated in the `Sidekick::Context` module, which exposes DSL style methods by extending `Sidekick::Triggers` and `Sidekick::Helpers`.
-  Context = Module.new
-  Context.extend Triggers
-  Context.extend Helpers
+  STOP_CALLBACKS = [] # called on shutdown
 
+  Context = Module.new.extend(Actions)
 
-  # `Sidekick.run!` reads and applies the `.sidekick` file, wrapping the setup phase inside `EM.run { .. }`, thus starting the event loop.
   def self.run!(path='.sidekick')
     ensure_config_exists(path)
 
@@ -71,20 +32,23 @@ module Sidekick
 
     EventMachine.run do
       Context.module_eval(
-        open(path) {|f| f.read }, path )
+        open(path) {|f| f.read },
+        path
+        )
     end
   end
 
   def self.ensure_config_exists(path)
     unless File.exists?(path)
-      puts 'Generate new sidekick file? (Y/n)'
-      gets =~ /^N|n/ ? exit :
+      puts "Generate #{path}? (Y/n)"
+      STDIN.gets =~ /^N|n/ ? exit :
         FileUtils.cp(File.expand_path('../template',
           __FILE__), path)
     end
   end
 
   def self.stop(msg=nil)
+    STOP_CALLBACKS.each {|c| c.call }
     EventMachine.stop
     puts "\n#{msg}" if msg
   end

data/lib/sidekick/{helpers → actions}/compile.rb

@@ -1,6 +1,6 @@
 
 
-module Sidekick::Helpers::Compile
+module Sidekick::Actions::Compile
 
   # Compiles one template using the `tilt` gem.
 

data/lib/sidekick/actions/passenger.rb

@@ -0,0 +1,18 @@
+
+
+
+
+
+module Sidekick::Actions::Passenger
+
+  def restart_passenger
+    FileUtils.touch './tmp/restart.txt'
+    log 'restarted passenger'
+  end
+
+  def passenger_server(port=3000)
+    sh "passenger start -d -p #{port.to_s}"
+    on_stop { sh "passenger stop -p #{port.to_s}" }
+  end
+
+end

data/lib/sidekick/{helpers → actions}/rake.rb

@@ -1,5 +1,5 @@
 
-module Sidekick::Helpers::Compile
+module Sidekick::Actions::Rake
 
   def rake(task_name)
     needs 'rake', 'to invoke rake tasks'

data/lib/sidekick/{helpers → actions}/shell.rb

@@ -1,5 +1,5 @@
 
-module Sidekick::Helpers::Shell
+module Sidekick::Actions::Shell
 
   def sh(cmd)
     log cmd; `#{cmd}`

data/lib/sidekick/{helpers → actions}/sidekick_itself.rb

@@ -1,10 +1,14 @@
 
-module Sidekick::Helpers::SidekickItself
+module Sidekick::Actions::SidekickItself
 
   def log(str)
     puts ' -> ' + str
   end
 
+  def log_trigger(str)
+    puts str
+  end
+
   def stop(*prms)
     ::Sidekick.stop(*prms)
   end

data/lib/sidekick/{helpers → actions}/system.rb

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 
 
-module Sidekick::Helpers::System
+module Sidekick::Actions::System
   def platform
     {
       :linux => /linux/,

data/lib/sidekick/actions/triggers.rb

@@ -0,0 +1,43 @@
+
+ # Basically, the job of a trigger definition is to take the parameters and the block from a directive in the `.sidekick` file, and then hook into EventMachine in some way to set up the trigger.
+module Sidekick::Actions::Triggers
+
+
+  def watch(glob)
+    needs 'em-dir-watcher', 'to watch file changes'
+
+    EMDirWatcher.watch(
+      File.expand_path('.'),
+      :include_only => [glob],
+      :grace_period => 0.2
+      ) do |paths|
+      log_trigger "watch #{paths.inspect}"
+      yield(paths)
+    end
+  end
+
+  def every(duration)
+    EventMachine::PeriodicTimer.new(duration) do
+      log_trigger "every #{duration} seconds"
+      yield
+    end
+  end
+
+  def after(duration)
+    EventMachine::Timer.new(duration) do
+      log_trigger "after #{duration} seconds"
+      yield
+    end
+  end
+
+  def on_start(&blk)
+    after(0, &blk)
+  end
+
+  def on_stop(&blk)
+    ::Sidekick::STOP_CALLBACKS << blk
+  end
+
+end
+
+

data/lib/sidekick/{helpers → actions}/user_interaction.rb

@@ -1,5 +1,5 @@
 
-module Sidekick::Helpers::UserInteraction
+module Sidekick::Actions::UserInteraction
   def notify(message, title='Sidekick')
 
     log "NOTIFY #{title}: #{message}"

data/lib/template

@@ -1,31 +1,34 @@
 
-stop "A new .sidekick file was generated -- now you just have to edit it."
+stop "File generated. Now please fill it in."
 
 # Now delete the line above, and set up some actions.
 # Here are some samples:
 
 
-# auto_compile 'assets/css/*.sass', 'public/css/:name.css'
+# watch('**.rb') do |paths|
+#   log 'code change'
+#   restart_passenger
+#   rake 'docs'
+# end
 
-# auto_compile 'assets/js/*.coffee', 'public/js/:name.js'
+# after(5) { notify sh 'fortune' }
 
 # every(60*60) { notify 'You are now one hour older.' }
 
-# every(60*15) { notify sh 'fortune' }
+# on_stop { notify 'Goodbye' }
 
-# watch('**.rb') do |paths|
-#   log 'code change'
-#   restart_passenger
-#   rake 'doc'
-# end
+# auto_compile 'assets/css/*.sass', 'public/css/:name.css'
+# auto_compile 'assets/js/*.coffee', 'public/js/:name.js'
 
+# passenger_server 3002
 
-# more sample actions:
 
-# needs 'httparty', 'to look up your location'
-# loc = HTTParty.get('http://ipinfodb.com/ip_query.php')
-# notify "You are in #{loc['Response']['City']}"
 
+# def report_location
+#   needs 'httparty', 'to look up your location'
+#   loc = HTTParty.get('http://ipinfodb.com/ip_query.php')
+#   notify "You are in #{loc['Response']['City']}"
+# end
 
 
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Jostein Berre Eliassen,
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-02 00:00:00 +01:00
+date: 2010-11-12 00:00:00 +01:00
 default_executable: sidekick
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,7 +56,7 @@ dependencies:
         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. Powered by EventMachine. Easy to extend.
+description: Automatically run common development tasks on events, as prescribed in a local .sidekick file. Easy, powerful DSL. Powered by EventMachine.
 email: post@jostein.be
 executables: 
 - sidekick
@@ -76,14 +76,14 @@ files:
 - VERSION
 - bin/sidekick
 - lib/sidekick.rb
-- lib/sidekick/helpers/compile.rb
-- lib/sidekick/helpers/passenger.rb
-- lib/sidekick/helpers/rake.rb
-- lib/sidekick/helpers/shell.rb
-- lib/sidekick/helpers/sidekick_itself.rb
-- lib/sidekick/helpers/system.rb
-- lib/sidekick/helpers/user_interaction.rb
-- lib/sidekick/triggers.rb
+- lib/sidekick/actions/compile.rb
+- lib/sidekick/actions/passenger.rb
+- lib/sidekick/actions/rake.rb
+- lib/sidekick/actions/shell.rb
+- lib/sidekick/actions/sidekick_itself.rb
+- lib/sidekick/actions/system.rb
+- lib/sidekick/actions/triggers.rb
+- lib/sidekick/actions/user_interaction.rb
 - lib/template
 - test/fixtures/page.haml
 - test/fixtures/site.coffee
@@ -121,7 +121,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Automatically run common development tasks on events, as defined by a local .sidekick file.
+summary: Automatically run common development tasks on events.
 test_files: 
 - test/helper.rb
 - test/test_sidekick.rb

data/lib/sidekick/helpers/passenger.rb

@@ -1,14 +0,0 @@
-
-
-
-
-
-module Sidekick::Helpers::Passenger
-
-  def restart_passenger
-    FileUtils.touch './tmp/restart.txt'
-    log 'restarted passenger'
-  end
-
-
-end

data/lib/sidekick/triggers.rb

@@ -1,30 +0,0 @@
-
-
-module Sidekick::Triggers
-
-  extend ::Sidekick::Helpers
-
-  register :watch do |callback, glob|
-    needs 'em-dir-watcher', 'to watch file changes'
-
-    EMDirWatcher.watch(
-      File.expand_path('.'),
-      :include_only => [glob],
-      :grace_period => 0.2
-      ) do |paths|
-      log "watch #{paths.inspect}"
-      callback.call(paths)
-    end
-  end
-
-  register :every do |callback, duration|
-    EventMachine::PeriodicTimer.new(duration) do
-      log "every #{duration} seconds"
-      callback.call
-    end
-  end
-
-end
-
-
-