sidekick 0.6.1 → 0.6.2

data/.sidekick

@@ -1,12 +1,8 @@
-# This is an example sidekick file that i use for testing
-# by doing. Proper tests are welcome.
 
 
+# every(5) { notify sh 'fortune' }
 
-
-# watch '**/*.rb' {|paths| log 'made edits' }
-
-every(5) { notify sh 'fortune' }
+watch('lib/**.rb') { rake 'docs' }
 
 auto_compile 'test/fixtures/*.haml', 'test/output/:name.html'
 

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 }
+watch('**/*.rb') { restart_passenger; rake docs }
 
 auto_compile 'assets/*.sass', 'public/:name.css'
 
@@ -14,7 +14,7 @@ h3. Sample use cases
 
 * Restart server when code is changed
 * Auto-compile Sass or CoffeeScript templates (and many other languages)
-* Periodically run commands
+* Periodically run tasks
 * Continuous testing, notifications, hooks, you name it
 
 h3. Features
@@ -23,40 +23,20 @@ h3. Features
 * Easy to extend
 * Compiles many formats, thanks to "Tilt":http://github.com/rtomayko/tilt.
 * Powered by "EventMachine":http://github.com/eventmachine/eventmachine
-* The core is about 60 lines of code
+* Short and sweet codebase - core < 100 loc
 
-You should "read the annotated source code":http://jbe.github.com/sidekick/.
+You can "read the annotated source code":http://jbe.github.com/sidekick/sidekick.html.
 
 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.
+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.
 
-For now, look to the source code to see all available
+View source:
 
 * "triggers":http://jbe.github.com/sidekick/triggers.html
+* "helpers":http://github.com/jbe/sidekick/tree/master/lib/sidekick/helpers/
 
-* "helpers":http://jbe.github.com/sidekick/helpers.html
-
-h2. Writing extensions
-
-h3. Writing new helpers
-
-To add more helpers, simply add methods to @Sidekick::Helpers@, like this:
-
-<pre>
-<code lang='ruby'>
-  module Sidekick::Helpers
-    def make_pickle
-      PickeFactory.manufacture!
-    end
-  end
-</code>
-</pre>
-
-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
+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.
 

data/Rakefile

@@ -37,15 +37,11 @@ require 'rocco/tasks'
 Rocco::make 'website/'
 
 desc 'Build docco'
-task :docs => [:rocco, 'website/index.html']
+task :docs => [:clear_docs, :rocco]
 directory 'website/'
 
-# Make index.html a copy of rocco.html
-file 'website/index.html' => 'website/sidekick.html' do |f|
-  cp 'website/sidekick.html', 'website/index.html', :preserve => true
+task :clear_docs do
+  sh 'rm website/*.html'
 end
 
-CLEAN.include 'website/index.html'
-task :doc => :docs
-
 

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.6.2

data/lib/sidekick/helpers/compile.rb

@@ -6,13 +6,10 @@ module Sidekick::Helpers::Compile
 
   def compile(source, target)
     needs 'tilt', 'to compile templates'
-
-    begin
+    handling Exception, source do
       File.open(target, 'w') do |f|
         f.write(Tilt.new(source).render)
       end
-    rescue Exception => e
-      notify "Error compiling #{file}:\n#{e}"
     end
   end
 

data/lib/sidekick/helpers/rake.rb

@@ -0,0 +1,12 @@
+
+module Sidekick::Helpers::Compile
+
+  def rake(task_name)
+    needs 'rake', 'to invoke rake tasks'
+    handling Exception, "rake #{task_name}" do
+      load 'Rakefile'
+      Rake::application[task_name].invoke
+    end
+  end
+
+end

data/lib/sidekick/helpers/shell.rb

@@ -2,9 +2,7 @@
 module Sidekick::Helpers::Shell
 
   def sh(cmd)
-    log cmd
-    puts result = `#{cmd}`
-    result
+    log cmd; `#{cmd}`
   end
 
 end

data/lib/sidekick/helpers/system.rb

@@ -32,5 +32,17 @@ module Sidekick::Helpers::System
       log "Please install the #{gem_name} gem #{reason}."
     end
   end
+
+  def handling(err_kls=Exception, context=nil)
+    begin
+      yield
+    rescue err_kls => e
+      if context
+        notify "#{context}:\n#{e}", e.class.name
+      else
+        notify "#{e}\n#{e.backtrace[0..2]}", e.class.name
+      end
+    end
+  end
 end
 

data/lib/sidekick/helpers/user_interaction.rb

@@ -1,8 +1,8 @@
 
-module Sidekick::Helpers::Shell
+module Sidekick::Helpers::UserInteraction
   def notify(message, title='Sidekick')
 
-    log "### #{title}: #{message}"
+    log "NOTIFY #{title}: #{message}"
     case platform
       when :linux
         needs 'libnotify', 'to display status messages on linux'

data/lib/template

@@ -1,21 +1,32 @@
 
-
 stop "A new .sidekick file was generated -- now you just have to edit it."
 
+# Now delete the line above, and set up some actions.
+# Here are some samples:
 
-# now delete the above, and set up some actions.
-# here are some samples:
 
-# watch('**.rb') { restart_passenger }
-#
 # auto_compile 'assets/css/*.sass', 'public/css/:name.css'
-#
+
 # auto_compile 'assets/js/*.coffee', 'public/js/:name.js'
-#
-# every(60) { notify 'You are now one minute older.' }
-#
+
+# every(60*60) { notify 'You are now one hour older.' }
+
 # every(60*15) { notify sh 'fortune' }
 
+# watch('**.rb') do |paths|
+#   log 'code change'
+#   restart_passenger
+#   rake 'doc'
+# end
+
+
+# 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']}"
+
+
 
 
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 1
-  version: 0.6.1
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - Jostein Berre Eliassen,
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-31 00:00:00 +02:00
+date: 2010-11-02 00:00:00 +01:00
 default_executable: sidekick
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,8 +78,9 @@ files:
 - 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.rb
+- lib/sidekick/helpers/sidekick_itself.rb
 - lib/sidekick/helpers/system.rb
 - lib/sidekick/helpers/user_interaction.rb
 - lib/sidekick/triggers.rb