sidekick 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.sidekick

@@ -0,0 +1,17 @@
+
+# This is an example sidekick file that i use for testing
+# by doing. Proper tests are welcome.
+
+watch '**/*.rb' do |paths|
+  sh 'echo files updated'
+end
+
+every(5) do
+  log 'Five seconds passed!'
+end
+
+every(20) do
+  notify 'Are you tired of being notified yet?'
+end
+
+# vim:ft=ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jostein Berre Eliassen,
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,126 @@
+h1. Sidekick [Draft]
+
+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:
+
+<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
+
+# shows a new fortune every 10 seconds
+every(10) do    
+  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:
+
+Triggers:
+
+|@watch@|run on file changes|
+|@every(duration)@|run every @duration@ of seconds|
+
+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|
+|@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:
+
+<pre>
+<code lang='ruby'>
+  module Sidekick::Helpers
+    def make_pickle
+      PickeFactory.manufacture!
+    end
+  end
+</code>
+</pre>
+
+When adding a group it is cleaner to use a separate module under @Sidekick::Helpers@, and then include 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:
+
+<pre>
+<code lang='ruby'>
+
+register :every do |callback, duration|
+  timeshare(duration) do
+    callback.call
+  end
+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.
+
+Triggers can also be written as a class interface. Here is an example of the above, translated 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
+
+</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
+
+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. One more feature
+
+Fascinatingly, the main code chunk is just under 100 lines including documentation, excluding the default triggers and helpers. Why not read it..?
+
+I got a bit of inspiration from the somewhat similar project "Guard":http://github.com/guard/guard
+
+
+h3. Copyright
+
+Copyright (c) 2010 Jostein Berre Eliassen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+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.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
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sidekick #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/sidekick

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'sidekick'
+rescue LoadError
+  require 'rubygems'
+  require 'sidekick'
+end
+
+Sidekick.run!

data/lib/sidekick.rb

@@ -0,0 +1,96 @@
+
+
+module Sidekick
+
+  # creates a module wrapper, which in turn
+  # evaluates the .sidekick config file within
+  # its own scope
+  def self.run!(conf_path='.sidekick')
+    abort('No .sidekick file!') unless File.exists?(conf_path)
+    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
+    @@triggers = {}
+
+    # registers a trigger
+    def self.register(name, block)
+      @@triggers[name] = block
+    end
+
+    def method_missing(name, *args, &blk)
+      if @@triggers[name]
+        @@triggers[name].call(blk, *args)
+      else
+        super
+      end
+    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
+
+    end
+  end
+end
+
+require 'sidekick/helpers'
+require 'sidekick/triggers'
+

data/lib/sidekick/helpers.rb

@@ -0,0 +1,70 @@
+require 'fileutils'
+require 'rbconfig'
+
+
+# default helpers
+
+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
+
+  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
+  end
+
+
+
+  def log(str)
+    puts ' -> ' + str
+  end
+
+  def notify(*args)
+    Notification.show(*args)
+  end
+
+  def sh(cmd)
+    log cmd
+    puts `#{cmd}`
+  end
+  
+
+
+  def restart_passenger
+    FileUtils.touch './tmp/restart.txt'
+    log 'restarted passenger'
+  end
+
+end

data/lib/sidekick/triggers.rb

@@ -0,0 +1,30 @@
+
+
+module Sidekick::Triggers
+
+  # 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
+
+  # default triggers
+
+  require 'sidekick/triggers/watch'
+
+  register_class(:watch, Watch)
+  
+  register :every do |callback, duration|
+    timeshare(duration) do
+      callback.call
+    end
+  end
+
+end
+
+
+

data/lib/sidekick/triggers/watch.rb

@@ -0,0 +1,53 @@
+
+
+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)
+  end
+
+  class Polling
+
+    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
+
+# TODO inotify and mac support
+
+
+
+end

data/sidekick.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sidekick}
+  s.version = "0.2.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.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.email = %q{post@jostein.be}
+  s.executables = ["sidekick"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".sidekick",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "bin/sidekick",
+     "lib/sidekick.rb",
+     "lib/sidekick/helpers.rb",
+     "lib/sidekick/triggers.rb",
+     "lib/sidekick/triggers/watch.rb",
+     "sidekick.gemspec",
+     "test/helper.rb",
+     "test/test_sidekick.rb"
+  ]
+  s.homepage = %q{http://github.com/jbe/sidekick}
+  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.test_files = [
+    "test/helper.rb",
+     "test/test_sidekick.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sidekick'
+
+class Test::Unit::TestCase
+end

data/test/test_sidekick.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSidekick < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: sidekick
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jostein Berre Eliassen,
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-24 00:00:00 +02:00
+default_executable: sidekick
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  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.
+email: post@jostein.be
+executables: 
+- sidekick
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- .sidekick
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- bin/sidekick
+- lib/sidekick.rb
+- lib/sidekick/helpers.rb
+- lib/sidekick/triggers.rb
+- lib/sidekick/triggers/watch.rb
+- sidekick.gemspec
+- test/helper.rb
+- test/test_sidekick.rb
+has_rdoc: true
+homepage: http://github.com/jbe/sidekick
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Automatically run common project tasks according to triggers defined in .sidekick
+test_files: 
+- test/helper.rb
+- test/test_sidekick.rb