tennis-jobs 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ee6ec8dbc807f4cb3ade4eac1651624555239b1
-  data.tar.gz: 73978213184591abc3a807957a31b76e81a23817
+  metadata.gz: 41fd5c9ff7ba286a975e7f6fd69b422564884783
+  data.tar.gz: 02f1abfb9d8045033ab9bc8203b0d05473d4736e
 SHA512:
-  metadata.gz: 550aad703fa200b1f002ae8cfc84a9d22c55c39b0867885e4ee8a74d776d9241b65f5389fbe2133f31b601a3d49e53b0274d0391c2720d291d58e421931b7818
-  data.tar.gz: aa3f869f0a540088090b4a574d88288bd554931c84a9d0c15e8cf0088e46db21474da52d800c1a8ce7552f16063072efd4681348c59da47be85f63b1dcba01d6
+  metadata.gz: 37dda9596db258dea9c2eb3787bf1b674cca4faa3b4467cca957bd646f7d6ab6e8e76ef3382d8ac9b29f3afa0d73524224094b9b32cd493106061f4e021672cc
+  data.tar.gz: 67dddffbe9393ca3051eea299dcb95974f3a147ba31403070663fe534fce849a68752d33adf28be4a73ffe8dc2ab59478e5a2b42aec383089dea056317b0dc21

data/README.markdown

@@ -1,9 +1,10 @@
 This small library is intended to help creating asynchronous jobs
 using Ruby and RabbitMQ via the Sneakers gem.
 
-<a href="https://travis-ci.org/nicoolas25/tennis"><img src="https://travis-ci.org/nicoolas25/tennis.svg?branch=master" /></a>
-<a href="https://codeclimate.com/github/nicoolas25/tennis"><img src="https://codeclimate.com/github/nicoolas25/tennis/badges/gpa.svg" /></a>
-<a href="https://codeclimate.com/github/nicoolas25/tennis/coverage"><img src="https://codeclimate.com/github/nicoolas25/tennis/badges/coverage.svg" /></a>
+<a target="_blank" href="https://travis-ci.org/nicoolas25/tennis"><img src="https://travis-ci.org/nicoolas25/tennis.svg?branch=master" /></a>
+<a target="_blank" href="https://codeclimate.com/github/nicoolas25/tennis"><img src="https://codeclimate.com/github/nicoolas25/tennis/badges/gpa.svg" /></a>
+<a target="_blank" href="https://codeclimate.com/github/nicoolas25/tennis/coverage"><img src="https://codeclimate.com/github/nicoolas25/tennis/badges/coverage.svg" /></a>
+<a target="_blank" href="https://rubygems.org/gems/tennis-jobs"><img src="https://badge.fury.io/rb/tennis-jobs.svg" /></a>
 
 ## Features
 
@@ -15,12 +16,70 @@ using Ruby and RabbitMQ via the Sneakers gem.
 
 - A `GenericSerializer` handling classes and ActiveRecord objects
 
+## Configuration
+
+The background job require a group of processes to handle the tasks you want to
+do asynchronously. Tennis uses YAML configuration file in order to launch thoses
+processes.
+
+``` yaml
+# tennis.conf.yml
+group1:
+  exchange: "default"
+  workers: 1
+  classes:
+    - "Scope::MyClass"
+    - "Scope::Model"
+group2:
+  exchange: "important"
+  workers: 10
+  classes:
+    - "Only::ImportantWorker"
+```
+
+Here we see two groups of worker. Each group can be launch with the `tennis`
+command:
+
+    $ bundle exec tennis group1
+
+The `workers` options is directly given to sneakers, it will determine the
+number of subprocesses that will handle the messages, the level of parallelism.
+
+The classes are the classes that will receive your `execute` or `defer` calls
+but we'll see that later...
+
+Also it is possible to add options directly in your workers:
+
+``` ruby
+module WorkerHelpers
+  BeforeFork = -> { ActiveRecord::Base.connection_pool.disconnect! rescue nil }
+  AfterFork = -> { ActiveRecord::Base.establish_connection }
+end
+
+class MyClass
+  include GenericWorker
+
+  set_option :before_fork, WorkerHelpers::BeforeFork
+  set_option :after_fork, WorkerHelpers::AfterFork
+  set_option :handler, Sneakers::Handlers::MaxretryWithoutErrors
+
+  work do |message|
+    MyActiveRecordModel.create(message: message)
+  end
+end
+```
+
+In this example I use constants to store the Proc options. This is because
+having different options for the workers of a same group isn't possible. By
+using this constant, I can have another worker with those same options and put
+it in the same group.
+
 ## Examples
 
 Those examples are what we wish to achieve.
 
 The name of the queue is the name of the class by default and can be reset
-using sneakers' `.from_queue` method of the `YourClass::Worker`'s class.
+using sneakers' `YourClass.worker.from_queue` method.
 
 ### Hooks
 

data/bin/tennis

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "tennis"
+require "tennis/cli"
+
+Tennis::CLI.start

data/lib/tennis/cli.rb

@@ -0,0 +1,102 @@
+require "yaml"
+require "optparse"
+require "sneakers"
+require "sneakers/runner"
+
+module Tennis
+  class CLI
+
+    DEFAULT_OPTIONS = {
+      config: "./tennis.yml",
+    }.freeze
+
+    def self.start
+      options = DEFAULT_OPTIONS.dup
+      OptionParser.new do |opts|
+        opts.banner = "Usage: tennis [options] group"
+        opts.on("-c", "--config FILE", "Set the config file") do |file|
+          options[:config] = file
+        end
+        opts.on("-r", "--require PATH", "Require files before starting") do |path|
+          options[:require] ||= []
+          options[:require] << path
+        end
+        opts.on("-x", "--execute CODE", "Execute code before starting") do |code|
+          options[:execute] ||= []
+          options[:execute] << code
+        end
+      end.parse!
+      options[:group] = ARGV.first
+      new(options).start
+    end
+
+    def initialize(options)
+      @options = options
+    end
+
+    def start
+      do_require
+      execute_code
+      configure_tennis
+      start_group
+    end
+
+    private
+
+    def do_require
+      return unless requires = @options[:require]
+      requires.each { |path| require path } if @options[:require]
+    end
+
+    def execute_code
+      return unless codes = @options[:execute]
+      codes.each { |code| eval code }
+    end
+
+    def configure_tennis
+      Tennis.configure do |config|
+        config.async = true
+        config.exchange = group["exchange"]
+        config.workers = group["workers"].to_i
+        config.logger = Logger.new(STDOUT)
+        config.logger.level = Logger::WARN
+        config.sneakers_options = sneakers_options
+      end
+    end
+
+    def sneakers_options
+      classes.map(&:options).each_with_object({}) do |options, all_options|
+        merge_options(all_options, options)
+      end
+    end
+
+    def merge_options(target, options)
+      options.each do |name, value|
+        if target[name].nil?
+          target[name] = value
+        elsif target[name] != value
+          fail "Workers shouldn't have different '#{name}' options"
+        end
+      end
+    end
+
+    def start_group
+      Sneakers::Runner.new(classes.map(&:worker)).run
+    end
+
+    def classes
+      @classes ||= group["classes"].map do |name|
+        Object.const_get(name)
+      end
+    end
+
+    def group
+      @group ||= config[@options[:group]]
+    end
+
+    def config
+      YAML.load_file(@options[:config])
+    end
+
+  end
+end

data/lib/tennis/worker/generic.rb

@@ -4,10 +4,12 @@ module Tennis
 
       autoload :BeforeHook, "tennis/worker/generic/before_hook"
       autoload :Serialize,  "tennis/worker/generic/serialize"
+      autoload :Options,    "tennis/worker/generic/options"
 
       def self.included(base)
         base.extend BeforeHook
         base.extend Serialize
+        base.extend Options
         base.extend DSL
         base.worker = Class.new do
           @@parent = base

data/lib/tennis/worker/generic/options.rb

@@ -0,0 +1,10 @@
+module Tennis::Worker::Generic::Options
+  def set_option(symbol, value)
+    options[symbol] = value
+  end
+
+  def options
+    @_options ||= {}
+  end
+end
+

data/tennis-jobs.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "tennis-jobs"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Nicolas ZERMATI"]
   spec.email         = ["nicoolas25@gmail.com"]
 
@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "sneakers"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tennis-jobs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicolas ZERMATI
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sneakers
@@ -125,7 +125,8 @@ dependencies:
 description: A small background job library on top of sneakers.
 email:
 - nicoolas25@gmail.com
-executables: []
+executables:
+- tennis
 extensions: []
 extra_rdoc_files: []
 files:
@@ -137,16 +138,19 @@ files:
 - LICENSE.txt
 - README.markdown
 - Rakefile
+- bin/tennis
 - examples/deferable.rb
 - examples/example.rb
 - examples/serializer.rb
 - lib/tennis.rb
+- lib/tennis/cli.rb
 - lib/tennis/configuration.rb
 - lib/tennis/serializer/generic.rb
 - lib/tennis/worker/deferable.rb
 - lib/tennis/worker/deferable/action.rb
 - lib/tennis/worker/generic.rb
 - lib/tennis/worker/generic/before_hook.rb
+- lib/tennis/worker/generic/options.rb
 - lib/tennis/worker/generic/serialize.rb
 - tennis-jobs.gemspec
 homepage: https://github.com/nicoolas25/tennis