sidekick 0.2.0 → 0.2.1

data/.sidekick

@@ -3,15 +3,11 @@
 # by doing. Proper tests are welcome.
 
 watch '**/*.rb' do |paths|
-  sh 'echo files updated'
-end
-
-every(5) do
-  log 'Five seconds passed!'
+  log 'files updated'
 end
 
 every(20) do
-  notify 'Are you tired of being notified yet?'
+  notify sh('fortune')
 end
 
 # vim:ft=ruby

data/README.textile

@@ -1,15 +1,13 @@
-h1. Sidekick [Draft]
+h1. Sidekick
 
 Sidekick is a command line tool to automatically trigger certain tasks following certain events, as defined in a @.sidekick@ file in your project folder.
 
 You would typically run it in the background while coding, to automatize things like restarting development servers on file changes, recompiling assets, continously running tests or periodically running commands.
 
-It is very easy to set up and extend.
-
 
 h2. Basic usage
 
-Install with @gem install sidekick@ and invoke it using the @sidekick@ shell command in your project folder. You should have a @.sidekick@ file in the active directory. Here is a sample:
+Install with @gem install sidekick@ and invoke it using the @sidekick@ shell command in your project folder. You should have a @.sidekick@ file in it. Here is a sample:
 
 <pre>
 <code lang='ruby'>
@@ -21,34 +19,32 @@ watch '**/*.rb' do |paths|
   notify 'Are you tired of being notified yet?'
 end
 
-# shows a new fortune every 10 seconds
-every(10) do    
-  sh 'fortune'
+# keeps the developers mind agile
+every(10) do
+  notify sh('fortune')
 end
 
 </code>
 </pre>
 
-The @watch@ and @every@ commands are are triggers, while @notify@, @sh@, and @restart_passenger@ are helper methods. The currently available triggers and helpers are:
+The @watch@ and @every@ commands above are are triggers, while @notify@, @sh@, and @restart_passenger@ are helper methods.
 
-Triggers:
+h3. Currently available triggers:
 
-|@watch@|run on file changes|
-|@every(duration)@|run every @duration@ of seconds|
+|@watch(glob)@|run on file changes matching @glob@. Globs like Dir[]. |
+|@every(duration)@|run every @duration@ seconds|
 
-Helpers:
+h3. Currently available helpers:
 
 |@sh@|run shell command, showing output, like in rake|
 |@log@|log events to screen. cleaner than puts.|
 |@notify@|notify user via growl, libnotify etc|
 |@running?(platform)@|os can be one of @[:linux, :darwin, :other]@|
-|@load_gem?(name)@|tries to load gem, true if success. otherwise false. informs user that more functions are available when it is installed|
+|@load_gem?(name)@|tries to load gem, true if success. otherwise false. informs user that more functions are available if they make it available|
 |@restart_passenger@|restart passenger based environments by touching tmp/restart.txt|
 
 h2. Writing extensions
 
-Sidekick is very easy to extend.
-
 h3. Writing new helpers
 
 To add more helpers, simply add methods to @Sidekick::Helpers@, like this:
@@ -63,7 +59,7 @@ To add more helpers, simply add methods to @Sidekick::Helpers@, like this:
 </code>
 </pre>
 
-When adding a group it is cleaner to use a separate module under @Sidekick::Helpers@, and then include it.
+When adding a group of methods it may be cleaner to use a separate module under @Sidekick::Helpers@, and then include it.
 
 
 h3. Writing new triggers
@@ -82,7 +78,7 @@ end
 </code>
 </pre>
 
-This is the implementation of the @every@ function mentioned earlier. The @timeshare@ method is provided by Sidekick, and will call the supplied block with the specified duration in seconds. This is also useful for polling something without blocking other triggers.
+This is the internal implementation of the @every@ function mentioned earlier. The @timeshare@ method is provided by Sidekick to all extensions, and will call the supplied block each @duration@ seconds. This is also useful for polling something without blocking or forking.
 
 Triggers can also be written as a class interface. Here is an example of the above, translated as a class:
 
@@ -105,18 +101,18 @@ class Sidekick::Triggers::Every
   end
 end
 
+Sidekick::Triggers.register_class(:watch, Watch)
+
 </code>
 </pre>
 
-Here, the optional @poll@ method functions like the callback block in the previous example. The @poll_freq@ method is also optional, and determines the frequency in seconds with which to call @poll@.
-
-h3. When writing your own extensions
+Here, the optional @poll@ method functions like the callback block in the previous example. The @poll_freq@ method is also optional, and determines the frequency in seconds with which to call @poll@. Finally, notice the last statement, which registers the class.
 
-You can keep your extensions in the @.sidekick@ file, or in a separate gem, or (better yet) ask me to merge them into the main repository.
+h2. Final lines...
 
-h2. One more feature
+The main code chunk is just under 100 lines including documentation, excluding the default triggers and helpers. Why not read it..?
 
-Fascinatingly, the main code chunk is just under 100 lines including documentation, excluding the default triggers and helpers. Why not read it..?
+You can keep your extensions in the @.sidekick@ file itself, or package in a separate gem, or ask me to merge them into the main repository.
 
 I got a bit of inspiration from the somewhat similar project "Guard":http://github.com/guard/guard
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/sidekick/helpers.rb

@@ -57,9 +57,10 @@ module Sidekick::Helpers
 
   def sh(cmd)
     log cmd
-    puts `#{cmd}`
+    puts result = `#{cmd}`
+    result
   end
-  
+
 
 
   def restart_passenger

data/lib/sidekick/triggers/watch.rb

@@ -3,14 +3,20 @@
 module Sidekick::Triggers::Watch
 
   def self.new(*args)
-    case ::Sidekick::Helpers.platform
-      when :linux then Polling
-      when :darwin then Polling
-      else Polling
-    end.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
+  class Polling # todo: check for deletion
 
     def initialize(callback, glob, ignore_first=false)
       ::Sidekick::Triggers.log "polling #{glob} for file changes.."
@@ -46,8 +52,4 @@ module Sidekick::Triggers::Watch
       end
   end
 
-# TODO inotify and mac support
-
-
-
 end

data/sidekick.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sidekick}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jostein Berre Eliassen,"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jostein Berre Eliassen,