cavalcade 0.1.0 → 0.2.0

data/Gemfile

@@ -1,9 +1,7 @@
 source "http://rubygems.org"
 
-gem "activesupport", ">= 2.3.2"
-gem "i18n" # ActiveSupport screws up its dependencies, so adding this manually (version-agnostic) so that bad versions of activesupport will still work.
-gem "rake", ">= 0.9"
 gem "resque", "~> 1.19"
+gem "trollop", "~> 1.16"
 
 group :development do
   gem "rspec", "~> 2.6"

data/Gemfile.lock

@@ -1,11 +1,8 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.1.1)
-      multi_json (~> 1.0)
     diff-lcs (1.1.3)
     git (1.2.5)
-    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -36,6 +33,7 @@ GEM
       rack-protection (~> 1.1, >= 1.1.2)
       tilt (~> 1.3, >= 1.3.3)
     tilt (1.3.3)
+    trollop (1.16.2)
     vegas (0.1.8)
       rack (>= 1.0.0)
 
@@ -43,10 +41,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (>= 2.3.2)
   bundler (~> 1.0.0)
-  i18n
   jeweler (~> 1.6.4)
-  rake (>= 0.9)
   resque (~> 1.19)
   rspec (~> 2.6)
+  trollop (~> 1.16)

data/README.md

@@ -8,7 +8,11 @@ Github built Resque to perform background jobs for the github web app. It has ga
 
 But Resque can be very useful outside of a web app, too. What if you want to write jobs in Ruby and just enqueue them from your console? Or from a Java application? Or in cron jobs? Cavalcade to the Resque!
 
-Cavalcade creates a Resque-based, stand-alone job queue, and provides rake tasks to enqueue all of your jobs.
+Cavalcade creates a Resque-based, stand-alone job queue, and provides an executable to manage and enqueue all of your jobs.
+
+## Philosophy
+
+Cavalcade is *not* a wrapper around Resque. In fact, it makes a point of *not* obfuscating or overriing any of Resque's native functionality. Any job that you write for Cavalcade can be used interchangeably with any app that uses Resque. Think of Cavalcade as minimalist piping that lets you get started writing jobs quickly.
 
 ## Contributing to Cavalcade
  

data/Rakefile

@@ -21,6 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Resque can be very useful outside of a web app, too. What if you want to write jobs in Ruby and just enqueue them from your console? Or from a Java application? Or in cron jobs? Cavalcade to the resque! Cavalcade creates a resque-based, stand-alone job queue, and provides rake tasks to enqueue all of your jobs.}
   gem.email = "robby@freerobby.com"
   gem.authors = ["Robby Grossman"]
+  gem.executables = ["cavalcade"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/cavalcade

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "cavalcade"
+require "resque"
+require "trollop"
+
+SUBCOMMANDS = %w(enqueue list-jobs)
+
+global_opts = Trollop::options do
+  banner "Usage: cavalcade SUBCOMMAND [options]"
+  banner "Available subcommands: #{SUBCOMMANDS.join(", ")}"
+  stop_on SUBCOMMANDS
+end
+
+subcommand = ARGV.shift
+subcommand_opts = case subcommand
+when nil
+  Trollop::die "No subcommand specified."
+when "enqueue"
+  Trollop::options do
+    banner "Usage: cavalcade enqueue [options]"
+    opt :environment, "Ruby file that loads your environment", :type => String, :default => "environment.rb"
+    opt :job, "Class name of the job to enqueue", :type => String
+    opt :params, "Ruby parameters to pass to job", :type => String
+  end
+when "list-jobs"
+  Trollop::options do
+    banner "Usage: cavalcade list-jobs [options]"
+    opt :environment, "Ruby file that loads your environment", :type => String, :default => "environment.rb"
+  end
+else
+  Trollop::die "Unknown subcommand: #{subcommand.inspect}"
+end
+
+class Helpers
+  def self.load_environment(file_path)
+    begin
+      require file_path
+    rescue LoadError => e
+      if e.message.include?(file_path)
+        Trollop::die "Unable to load #{file_path}"
+      else
+        raise e
+      end
+    end
+  end
+end
+
+case subcommand
+when "enqueue"
+  Helpers.load_environment(subcommand_opts[:environment])
+  # Use string comparison instead of class comparison so we don't have to handle exceptions if a bad class is supplied
+  if Cavalcade::JobsFinder.defined_jobs.map{|j| j.to_s}.include?(subcommand_opts[:job])
+    eval("Resque.enqueue(#{subcommand_opts[:job]}, #{subcommand_opts[:params]})")
+    $stderr.puts "Enqueued job: #{subcommand_opts[:job]}.perform(#{subcommand_opts[:params]})"
+  else
+    Trollop::die "Job not found: #{subcommand_opts[:job]}. Verify you are using the correct environment file, and use list-jobs to verify your job is available."
+  end
+when "list-jobs"
+  Helpers.load_environment(subcommand_opts[:environment])
+  $stderr.puts "Available jobs: #{Cavalcade::JobsFinder.defined_jobs.sort.join(", ")}"
+  $stderr.puts "Missing jobs? Be sure they are in your environment.rb."
+end

data/cavalcade.gemspec

@@ -5,13 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "cavalcade"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robby Grossman"]
   s.date = "2011-11-15"
   s.description = "Resque can be very useful outside of a web app, too. What if you want to write jobs in Ruby and just enqueue them from your console? Or from a Java application? Or in cron jobs? Cavalcade to the resque! Cavalcade creates a resque-based, stand-alone job queue, and provides rake tasks to enqueue all of your jobs."
   s.email = "robby@freerobby.com"
+  s.executables = ["cavalcade"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -26,15 +27,14 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "bin/cavalcade",
     "cavalcade.gemspec",
     "lib/cavalcade.rb",
     "lib/cavalcade/job.rb",
     "lib/cavalcade/jobs_finder.rb",
-    "lib/cavalcade/tasks.rb",
-    "lib/cavalcade/tasks/jobs.rake",
+    "spec/bin/cavalcade_spec.rb",
     "spec/lib/cavalcade/job_spec.rb",
     "spec/lib/cavalcade/jobs_finder_spec.rb",
-    "spec/lib/cavalcade/tasks/jobs_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/freerobby/cavalcade"
@@ -47,27 +47,21 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
-      s.add_runtime_dependency(%q<i18n>, [">= 0"])
-      s.add_runtime_dependency(%q<rake>, [">= 0.9"])
       s.add_runtime_dependency(%q<resque>, ["~> 1.19"])
+      s.add_runtime_dependency(%q<trollop>, ["~> 1.16"])
       s.add_development_dependency(%q<rspec>, ["~> 2.6"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
     else
-      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
-      s.add_dependency(%q<i18n>, [">= 0"])
-      s.add_dependency(%q<rake>, [">= 0.9"])
       s.add_dependency(%q<resque>, ["~> 1.19"])
+      s.add_dependency(%q<trollop>, ["~> 1.16"])
       s.add_dependency(%q<rspec>, ["~> 2.6"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
-    s.add_dependency(%q<i18n>, [">= 0"])
-    s.add_dependency(%q<rake>, [">= 0.9"])
     s.add_dependency(%q<resque>, ["~> 1.19"])
+    s.add_dependency(%q<trollop>, ["~> 1.16"])
     s.add_dependency(%q<rspec>, ["~> 2.6"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])

data/spec/bin/cavalcade_spec.rb

@@ -0,0 +1,36 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe "bin/cavalcade" do
+  def execute_with_args(args_str = "")
+    return `#{File.dirname(__FILE__)}/../../bin/cavalcade #{args_str} 2>&1`
+  end
+  
+  describe "without subcommand" do
+    it "reports error" do
+      execute_with_args().should =~ /no subcommand/i
+    end
+  end
+  describe "with bad subcommand" do
+    it "reports error" do
+      execute_with_args("asdf").should =~ /unknown/i
+    end
+  end
+  
+  describe "bad environment" do
+    %w(enqueue list-jobs).each do |subcommand|
+      describe "passed to #{subcommand}" do
+        it "reports error" do
+          execute_with_args("#{subcommand} -e /bad/path/to/env.rb").should =~ /unable to load/i
+        end
+      end
+    end
+  end
+  
+  describe "bad job" do
+    describe "passed to enqueue" do
+      it "reports error" do
+        execute_with_args("enqueue -e #{File.dirname(__FILE__)}/../../lib/cavalcade.rb -j FakeJob").should =~ /not found/i
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cavalcade
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,52 +12,30 @@ cert_chain: []
 date: 2011-11-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70124168375860 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.3.2
-  type: :runtime
-  prerelease: false
-  version_requirements: *70124168375860
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: &70124168375360 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70124168375360
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70124168374860 !ruby/object:Gem::Requirement
+  name: resque
+  requirement: &70306831114740 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.19'
   type: :runtime
   prerelease: false
-  version_requirements: *70124168374860
+  version_requirements: *70306831114740
 - !ruby/object:Gem::Dependency
-  name: resque
-  requirement: &70124168374340 !ruby/object:Gem::Requirement
+  name: trollop
+  requirement: &70306831114220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '1.16'
   type: :runtime
   prerelease: false
-  version_requirements: *70124168374340
+  version_requirements: *70306831114220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70124168373840 !ruby/object:Gem::Requirement
+  requirement: &70306831113680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +43,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70124168373840
+  version_requirements: *70306831113680
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70124168373320 !ruby/object:Gem::Requirement
+  requirement: &70306831113180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70124168373320
+  version_requirements: *70306831113180
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70124168372820 !ruby/object:Gem::Requirement
+  requirement: &70306831112700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,13 +65,14 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70124168372820
+  version_requirements: *70306831112700
 description: Resque can be very useful outside of a web app, too. What if you want
   to write jobs in Ruby and just enqueue them from your console? Or from a Java application?
   Or in cron jobs? Cavalcade to the resque! Cavalcade creates a resque-based, stand-alone
   job queue, and provides rake tasks to enqueue all of your jobs.
 email: robby@freerobby.com
-executables: []
+executables:
+- cavalcade
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -108,15 +87,14 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/cavalcade
 - cavalcade.gemspec
 - lib/cavalcade.rb
 - lib/cavalcade/job.rb
 - lib/cavalcade/jobs_finder.rb
-- lib/cavalcade/tasks.rb
-- lib/cavalcade/tasks/jobs.rake
+- spec/bin/cavalcade_spec.rb
 - spec/lib/cavalcade/job_spec.rb
 - spec/lib/cavalcade/jobs_finder_spec.rb
-- spec/lib/cavalcade/tasks/jobs_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/freerobby/cavalcade
 licenses:
@@ -133,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -590044956478310162
+      hash: -1807534318334742658
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/cavalcade/tasks/jobs.rake

@@ -1,19 +0,0 @@
-require "resque/tasks"
-require "active_support/inflector" # #underscore used to convert ClassName to class_name
-
-require "cavalcade"
-
-namespace :cavalcade do
-  namespace :jobs do
-    Cavalcade::JobsFinder.defined_jobs.each do |klass|
-      classname = klass.to_s
-      namespace classname.underscore do
-        desc "Create new #{classname} job; set params with RUBY_PARAMS_STR= (default is nil)."
-        task :enqueue do
-          PARAMS = ENV["RUBY_PARAMS_STR"] || nil
-          eval("Resque.enqueue(#{classname}, #{PARAMS})")
-        end
-      end
-    end
-  end
-end

data/lib/cavalcade/tasks.rb

@@ -1 +0,0 @@
-load File.join(File.dirname(__FILE__), 'tasks', 'jobs.rake')

data/spec/lib/cavalcade/tasks/jobs_spec.rb

@@ -1,18 +0,0 @@
-require "#{File.dirname(__FILE__)}/../../../spec_helper"
-
-require "rake"
-
-describe "jobs.rake" do
-  it "creates an enqueue task in own namespace for each Job" do
-    class File1 < Cavalcade::Job; end
-    class SomeClass < Cavalcade::Job; end
-    class SomeLongClassName < Cavalcade::Job; end
-    Cavalcade::JobsFinder.stub!(:defined_jobs).and_return([File1, SomeClass, SomeLongClassName])
-    Rake.application = Rake::Application.new
-    require "cavalcade/tasks"
-    tasks = Rake.application.tasks.map{|t| t.name}
-    tasks.should include("cavalcade:jobs:file1:enqueue")
-    tasks.should include("cavalcade:jobs:some_class:enqueue")
-    tasks.should include("cavalcade:jobs:some_long_class_name:enqueue")
-  end
-end