sidekick 0.2.1 → 0.3.0

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+test/output
 
 ## PROJECT::SPECIFIC

data/.sidekick

@@ -1,13 +1,17 @@
-
 # This is an example sidekick file that i use for testing
 # by doing. Proper tests are welcome.
 
-watch '**/*.rb' do |paths|
-  log 'files updated'
-end
 
-every(20) do
-  notify sh('fortune')
-end
+
+
+# watch '**/*.rb' {|paths| log 'made edits' }
+
+# every(20) { notify sh 'fortune' }
+
+auto_compile 'test/fixtures/*.haml', 'test/output/:name.html'
+
+auto_compile 'test/fixtures/*.sass', 'test/output/:name.css'
+
+auto_compile 'test/fixtures/*.coffee', 'test/output/:name.js'
 
 # vim:ft=ruby

data/README.textile

@@ -1,47 +1,48 @@
 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.
+Sidekick is a command line tool to automatically trigger running tasks on certain events, such as when you make updates. This is defined per project, in a local @.sidekick@ file in your project folder.
 
+h3. Features
 
-h2. Basic usage
+* Simple, powerful dsl. "Examples here.":http://github.com/jbe/sidekick/blob/master/lib/template
+* Pre-defined triggers.
+* Pre-defined helpers for common tasks.
+* Easy to write new triggers and helpers.
+* Esily compiles most languages thanks to "Tilt":http://github.com/rtomayko/tilt.
+    
+h3. Use cases
 
-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:
+* Triggering server restart when code is changed
+* Automatically compiling sass, CoffeeScript, etc.
+* Continuous testing with notifications or hooks
+* Periodically running commands
 
-<pre>
-<code lang='ruby'>
 
-# restarts passenger on file changes and
-# notifies via growl or libnotify
-watch '**/*.rb' do |paths|
-  restart_passenger
-  notify 'Are you tired of being notified yet?'
-end
+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.
 
-# keeps the developers mind agile
-every(10) do
-  notify sh('fortune')
-end
 
-</code>
-</pre>
+h2. Basic usage
 
-The @watch@ and @every@ commands above are are triggers, while @notify@, @sh@, and @restart_passenger@ are helper methods.
+Install with @gem install sidekick@ and invoke it using the @sidekick@ shell command in your project folder. If you do not have a @.sidekick@ file, you will be offered a template.
+
+I recommend "reading the template":http://github.com/jbe/sidekick/blob/master/lib/template.
+
+The @watch@ and @every@ commands you see in it are triggers, while @notify@, @sh@, and @restart_passenger@ are helper methods. Some helpers, like @auto_compile@ set up both triggers and actions for you.
 
 h3. Currently available triggers:
 
-|@watch(glob)@|run on file changes matching @glob@. Globs like Dir[]. |
+|@watch(glob)@|run on file changes matching @glob@. Globs like @Dir[]@. |
 |@every(duration)@|run every @duration@ seconds|
 
 h3. Currently available helpers:
 
-|@sh@|run shell command, showing output, like in rake|
-|@log@|log events to screen. cleaner than puts.|
+|@sh(cmd)@|run shell command, showing output, like in rake|
+|@log(str)@|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 if they make it available|
+|@auto_compile(source_glob, target_path)@|compile using tilt on file changes (language automatically detected -- see template examples and tilt documentation)|
 |@restart_passenger@|restart passenger based environments by touching tmp/restart.txt|
+|@load_gem?(name)@|tries to load gem, true if success. otherwise false. informs user that more functions are available if they install it|
 
 h2. Writing extensions
 
@@ -59,12 +60,12 @@ To add more helpers, simply add methods to @Sidekick::Helpers@, like this:
 </code>
 </pre>
 
-When adding a group of methods it may be 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 including it.
 
 
 h3. Writing new triggers
 
-To add new triggers, you have two options: block or class interface. Blocks are best for simple stuff, while classes are good for more complex code. This is how you set up a new trigger using a block:
+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. This is how you set up a new trigger using a block:
 
 <pre>
 <code lang='ruby'>
@@ -78,9 +79,9 @@ end
 </code>
 </pre>
 
-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.
+This is the internal implementation of the @every@ function seen earlier. The @timeshare@ method is provided by Sidekick to all extensions, and will call the supplied block every @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:
+Next, here is an example of the above written as a class:
 
 <pre>
 <code lang='ruby'>
@@ -106,15 +107,17 @@ 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@. Finally, notice the last statement, which registers the class.
+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@ in seconds. Only integers are accepted. Finally, notice the last statement, which registers the class.
 
 h2. Final lines...
 
-The main code chunk is just under 100 lines including documentation, excluding the default triggers and helpers. Why not read it..?
+The main code chunk of Sidekick 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 them in gems, or ask me to merge them into the main repository.
 
-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.
+Similar projects:
 
-I got a bit of inspiration from the somewhat similar project "Guard":http://github.com/guard/guard
+* "Guard":http://github.com/guard/guard (too enterprisey for me)
 
 
 h3. Copyright

data/Rakefile

@@ -5,13 +5,12 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "sidekick"
-    gem.summary = %Q{Automatically run common project tasks according to triggers defined in .sidekick}
-    gem.description = %Q{Automatically run common project tasks according to triggers defined in a .sidekick file. Easy, powerful configuration per project. Provides pre-defined sidekicks for things like watching for file changes, and allows easy definition of new ones. Contains helpers for common tasks such as compiling assets or triggering development server restarts.}
+    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.email = "post@jostein.be"
     gem.homepage = "http://github.com/jbe/sidekick"
     gem.authors = ["Jostein Berre Eliassen,"]
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency "tilt", ">= 1"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/bin/sidekick

@@ -7,4 +7,7 @@ rescue LoadError
   require 'sidekick'
 end
 
+puts '                       ^  ^  ^  ^    '
+puts ' == SIDEKICK ==    ^ ctrl-c to exit ^'
+puts '                                     '
 Sidekick.run!

data/lib/sidekick.rb

@@ -1,4 +1,4 @@
-
+require 'fileutils'
 
 module Sidekick
 
@@ -6,7 +6,14 @@ module Sidekick
   # evaluates the .sidekick config file within
   # its own scope
   def self.run!(conf_path='.sidekick')
-    abort('No .sidekick file!') unless File.exists?(conf_path)
+    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
@@ -93,4 +100,3 @@ end
 
 require 'sidekick/helpers'
 require 'sidekick/triggers'
-

data/lib/sidekick/helpers.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'rbconfig'
+require 'tilt'
 
 
 # default helpers
@@ -68,4 +69,29 @@ module Sidekick::Helpers
     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
+          target.gsub! ':name', File.basename(file, '.*')
+          File.open(target, 'w') do |f|
+            f.write(Tilt.new(file).render)
+          end
+          log "rendered #{file} => #{target}"
+        rescue Exception => e
+          notify "Error in #{file}:\n#{e}"
+        end
+      end
+    end
+  end
+
+
+
+
 end

data/lib/template

@@ -0,0 +1,26 @@
+
+
+
+
+abort "A new .sidekick file was generated -- now you just have to edit it."
+
+
+# now delete the above, and tell me what to do.
+# 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*15) { notify sh fortune }
+
+
+
+
+
+
+# vim:ft=ruby

data/sidekick.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sidekick}
-  s.version = "0.2.1"
+  s.version = "0.3.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-24}
+  s.date = %q{2010-10-25}
   s.default_executable = %q{sidekick}
-  s.description = %q{Automatically run common project tasks according to triggers defined in a .sidekick file. Easy, powerful configuration per project. Provides pre-defined sidekicks for things like watching for file changes, and allows easy definition of new ones. Contains helpers for common tasks such as compiling assets or triggering development server restarts.}
+  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.email = %q{post@jostein.be}
   s.executables = ["sidekick"]
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/sidekick/helpers.rb",
      "lib/sidekick/triggers.rb",
      "lib/sidekick/triggers/watch.rb",
+     "lib/template",
      "sidekick.gemspec",
      "test/helper.rb",
      "test/test_sidekick.rb"
@@ -39,7 +40,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Automatically run common project tasks according to triggers defined in .sidekick}
+  s.summary = %q{Automatically run common development tasks on events, as defined by a local .sidekick file.}
   s.test_files = [
     "test/helper.rb",
      "test/test_sidekick.rb"
@@ -50,12 +51,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<tilt>, [">= 1"])
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<tilt>, [">= 1"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<tilt>, [">= 1"])
   end
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jostein Berre Eliassen,
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-24 00:00:00 +02:00
+date: 2010-10-25 00:00:00 +02:00
 default_executable: sidekick
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: tilt
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -26,11 +26,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
-  type: :development
+        - 1
+        version: "1"
+  type: :runtime
   version_requirements: *id001
-description: Automatically run common project tasks according to triggers defined in a .sidekick file. Easy, powerful configuration per project. Provides pre-defined sidekicks for things like watching for file changes, and allows easy definition of new ones. Contains helpers for common tasks such as compiling assets or triggering development server restarts.
+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.
 email: post@jostein.be
 executables: 
 - sidekick
@@ -52,6 +52,7 @@ files:
 - lib/sidekick/helpers.rb
 - lib/sidekick/triggers.rb
 - lib/sidekick/triggers/watch.rb
+- lib/template
 - sidekick.gemspec
 - test/helper.rb
 - test/test_sidekick.rb
@@ -86,7 +87,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Automatically run common project tasks according to triggers defined in .sidekick
+summary: Automatically run common development tasks on events, as defined by a local .sidekick file.
 test_files: 
 - test/helper.rb
 - test/test_sidekick.rb