resque_jobs_tree 0.4.3 → 0.5.0

data/README.md

@@ -52,7 +52,7 @@ Organise each sequences of jobs into a single file
 This code is defining the tree, then when it launches the sequence of jobs, it:
 * stocks in Redis all the Resque jobs which needs to be done including the needed parameters to run them.
 * stocks in Redis the childhood relationsips between them.
-* enqueues in Resque the jobs which are the leaves of the tree
+* enqueues in Resque the jobs which are the nodes of the tree
 
 Limitations:
 
@@ -64,7 +64,7 @@ you can't enqueue 2 times `[:mail, User.first]`
 
 Node options:
 
-* `{ async: true }` if you need your process to wait for an outsider to continue.
+* `{ triggerable: true }` if you need your process to wait for an outsider to start.
 * `{ continue_on_fail: true}` if your process can continue even after a fail during a job.
 
 ## Contributing

data/lib/resque_jobs_tree/definitions/node.rb

@@ -14,7 +14,11 @@ class ResqueJobsTree::Definitions::Node < ResqueJobsTree::Definitions
     ResqueJobsTree::Definitions::Node.new(name, tree, self).tap do |node|
       node.options = options
       @node_childs << node
-      node.instance_eval(&block) if block_given?
+      if block_given?
+        node.instance_eval &block
+      elsif options.has_key? :triggerable
+        node.perform {}
+      end
     end
   end
 
@@ -49,18 +53,38 @@ class ResqueJobsTree::Definitions::Node < ResqueJobsTree::Definitions
   end
 
   def validate!
+    # Should have a child's naming [:job1, ...] and node childs Proc implementation associated
+    # node :job1 do
+    #  perform {}
+    # end
+    # ...
     if (childs.kind_of?(Proc) && node_childs.empty?) || (childs.nil? && !node_childs.empty?)
       raise ResqueJobsTree::NodeDefinitionInvalid,
         "node `#{name}` from tree `#{tree.name}` should defines childs and child nodes"
     end
-    unless perform.kind_of? Proc
+
+    # Should have an implementation
+    # node :job1 do
+    #  perform {}
+    # end
+    if !perform.kind_of? Proc and !options.has_key? :triggerable
       raise ResqueJobsTree::NodeDefinitionInvalid,
         "node `#{name}` from tree `#{tree.name}` has no perform block"
     end
+
+    # Naming Should be uniq
     if (tree.nodes - [self]).map(&:name).include? name
       raise ResqueJobsTree::NodeDefinitionInvalid,
         "node name `#{name}` is already taken in tree `#{tree.name}`"
     end
+
+    # Only one job can be trigger tree
+    if node_childs.select { |entry| entry.options.has_key?(:triggerable) }.size > 1
+      raise ResqueJobsTree::NodeDefinitionInvalid,
+        "Only one job must be declared to be triggerable into an definition, tree `#{tree.name}`"
+    end
+
+    # Recursive call for validate all of tree
     node_childs.each &:validate!
   end
 

data/lib/resque_jobs_tree/definitions/tree.rb

@@ -12,7 +12,7 @@ class ResqueJobsTree::Definitions::Tree < ResqueJobsTree::Definitions
 
   def root name=nil, &block
     @root ||= Node.new(name, self).tap do |root|
-      root.instance_eval &block
+      root.instance_eval &block if block_given?
     end
   end
 

data/lib/resque_jobs_tree/factory.rb

@@ -1,5 +1,4 @@
 module ResqueJobsTree::Factory
-
   extend self
 
   def create name, &block

data/lib/resque_jobs_tree/node.rb

@@ -70,14 +70,14 @@ class ResqueJobsTree::Node
     @childs = definition.leaf? ?  [] : definition.childs.call(*resources)
   end
 
-  def launch
+  def register
     store unless root?
     if leaf?
-      tree.register_a_leaf self
+      tree.register_node self
     else
       childs.each do |node_name, *resources|
         node = definition.find(node_name).spawn resources, self
-        node.launch
+        node.register
       end
     end
   end
@@ -96,7 +96,7 @@ class ResqueJobsTree::Node
       puts "[ResqueJobsTree::Tree] after_perform callback of node #{definition.tree.name}##{name} has failed."\
            " Continuing for cleanup."
     else
-      raise 
+      raise
     end
   end
 

data/lib/resque_jobs_tree/tree.rb

@@ -2,12 +2,12 @@ class ResqueJobsTree::Tree
 
   include ResqueJobsTree::Storage::Tree
 
-  attr_reader :definition, :resources, :leaves
+  attr_reader :definition, :resources, :nodes
 
   def initialize definition, resources
     @definition = definition
     @resources = resources
-    @leaves = []
+    @nodes = []
   end
 
   def name
@@ -18,8 +18,11 @@ class ResqueJobsTree::Tree
     if uniq?
       before_perform
       store
-      root.launch
-      enqueue_leaves_jobs
+      root.register
+      enqueue_jobs
+    else
+      raise ResqueJobsTree::JobNotUniq,
+        "Tree Definition must be uniq"
     end
   end
 
@@ -37,8 +40,8 @@ class ResqueJobsTree::Tree
     @root ||= ResqueJobsTree::Node.new(definition.root, resources, nil, self)
   end
 
-  def register_a_leaf node
-    @leaves << node
+  def register_node node
+    @nodes << node
   end
 
   def inspect
@@ -52,9 +55,9 @@ class ResqueJobsTree::Tree
 
   private
 
-  def enqueue_leaves_jobs
-    @leaves.each do |leaf|
-      leaf.enqueue unless leaf.definition.options[:async]
+  def enqueue_jobs
+    @nodes.each do |leaf|
+      leaf.enqueue unless leaf.definition.options[:triggerable]
     end
   end
 

data/lib/resque_jobs_tree/version.rb

@@ -1,3 +1,3 @@
 module ResqueJobsTree
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/resque_jobs_tree.gemspec

@@ -4,23 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'resque_jobs_tree/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "resque_jobs_tree"
+  spec.name          = 'resque_jobs_tree'
   spec.version       = ResqueJobsTree::VERSION
-  spec.authors       = ["Antoine Qu'hen"]
-  spec.email         = ["antoinequhen@gmail.com"]
+  spec.authors       = ['Antoine Qu\'hen']
+  spec.email         = ['antoinequhen@gmail.com']
   spec.description   = %q{To manage complexe background job processes, this gem simplify the task of creating sequences of Resque jobs by putting them into a tree.}
   spec.summary       = %q{Organise Resque jobs as a tree.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'mock_redis'
+  spec.add_development_dependency 'mocha'
   spec.add_dependency 'resque', '~> 1.24'
 end

data/test/definitions_test.rb

@@ -91,7 +91,7 @@ class DefinitionsTest < MiniTest::Unit::TestCase
   end
 
   def test_options
-    options = { async: true }
+    options = { triggerable: true }
     @leaf.options = options
     assert_equal options, @tree.find(:node2).options
   end

data/test/factory_test.rb

@@ -14,4 +14,34 @@ class FactoryTest < MiniTest::Unit::TestCase
     assert_equal ResqueJobsTree::Factory.find(@tree_definition.name).name, @tree_definition.name
   end
 
+  def test_without_perform_whitout_flag
+    assert_raises ResqueJobsTree::NodeDefinitionInvalid do
+      ResqueJobsTree::Factory.create :tree_with_job_without_perform do
+        root :job_without_perform
+      end
+    end
+  end
+
+  def test_without_perform
+    assert_not_raises do
+      ResqueJobsTree::Factory.create :tree_with_job_without_perform do
+        # root :job_without_perform, triggerable: true
+        root :job_without_perform do
+          perform { puts 'job1' }
+          childs { [:job1] }
+          node :job1 , triggerable: true
+        end
+      end
+    end.must_equal 'ok'
+  end
+
+  def assert_not_raises
+    begin
+      yield
+      'ok'
+    rescue
+      raise
+    end
+  end
+
 end

data/test/process_test.rb

@@ -2,10 +2,23 @@ require 'test_helper'
 
 class ProcessTest < MiniTest::Unit::TestCase
 
+  def test_launch_without_uniq
+    create_tree
+    assert_raises ResqueJobsTree::JobNotUniq do
+      resque_jobs_tree = @tree_definition.spawn [1, 2, 3]
+      resque_jobs_tree.stub :uniq?, false do
+        resque_jobs_tree.launch
+      end
+    end
+  end
+
   def test_launch
     create_tree
     resources = [1, 2, 3]
-    @tree_definition.spawn(resources).launch
+    resque_jobs_tree = @tree_definition.spawn(resources)
+    resque_jobs_tree.stub :uniq?, true do
+      resque_jobs_tree.launch
+    end
     history = ['tree1 job2']*3+['tree1 job1']
     assert_equal history, redis.lrange('history', 0, -1)
   end
@@ -31,12 +44,29 @@ class ProcessTest < MiniTest::Unit::TestCase
     assert_redis_empty
   end
 
-  def test_launch_async
+  def test_just_one_triggerable_job
+    assert_raises ResqueJobsTree::NodeDefinitionInvalid do
+      tree_definition = ResqueJobsTree::Factory.create :tree1 do
+        root :job1 do
+          perform { puts 'job1' }
+          childs { [:job2, :job3] }
+          node :job2, triggerable: true do
+            perform {}
+          end
+          node :job3, triggerable: true
+        end
+      end
+      tree = tree_definition.spawn [1, 2, 3]
+      tree.launch
+    end
+  end
+
+  def test_launch_triggerable
     tree_definition = ResqueJobsTree::Factory.create :tree1 do
       root :job1 do
         perform { raise 'should not arrive here' }
         childs { [:job2] }
-        node :job2, async: true do
+        node :job2, triggerable: true do
           perform {}
         end
       end
@@ -140,9 +170,9 @@ class ProcessTest < MiniTest::Unit::TestCase
     ResqueJobsTree.launch tree_definition.name, Model.new(1), 1
   end
 
-  def test_nested_tree
+  def test_nested_tree_with_job_failure
     Resque.inline = false
-    create_nested_tree
+    create_nested_tree_with_job_failure
     @tree_definition.spawn([1,2,3]).launch
     assert_raises RuntimeError do # job4 error
       run_resque_workers @tree_definition.name
@@ -157,12 +187,12 @@ class ProcessTest < MiniTest::Unit::TestCase
     end
   end
 
-  def test_async_tree
+  def test_triggerable_tree
     tree_definition = ResqueJobsTree::Factory.create :tree1 do
       root :job1 do
         perform { raise 'should not arrive here' }
         childs { [ [:job2], [:job3] ] }
-        node :job2, async: true do
+        node :job2, triggerable: true do
           perform {}
         end
         node :job3 do
@@ -177,13 +207,13 @@ class ProcessTest < MiniTest::Unit::TestCase
     assert_equal parents_hash, Resque.redis.hgetall(ResqueJobsTree::Storage::PARENTS_KEY)
   end
 
-  def test_async_tree_with_fail
+  def test_triggerable_tree_with_fail
     Resque.inline = false
     tree_definition = ResqueJobsTree::Factory.create :tree1 do
       root :job1 do
         perform { raise 'should not arrive here' }
         childs { [ [:job2], [:job3] ] }
-        node :job2, async: true do
+        node :job2, triggerable: true do
           perform {}
         end
         node :job3, continue_on_failure: true do

data/test/test_helper.rb

@@ -70,7 +70,7 @@ class MiniTest::Unit::TestCase
     end
   end
 
-  def create_nested_tree
+  def create_nested_tree_with_job_failure 
     @tree_definition = ResqueJobsTree::Factory.create :tree1 do
       root :job1 do
         perform { raise ExpectedException, 'job1' }
@@ -78,7 +78,7 @@ class MiniTest::Unit::TestCase
         node :job2, continue_on_failure: true do
           perform { raise 'job2' }
           childs { [ [:job3], [:job4] ] }
-          node :job3, async: true do
+          node :job3, triggerable: true do
             perform {}
           end
           node :job4, continue_on_failure: true do

data/test/tree_test.rb

@@ -10,24 +10,24 @@ class TreeTest < MiniTest::Unit::TestCase
     assert_equal @tree_definition.name, 'tree1'
   end
 
-  def test_leaves
-    assert_equal @tree_definition.spawn([]).leaves, []
+  def test_nodes
+    assert_equal @tree_definition.spawn([]).nodes, []
   end
 
   def test_root
     assert @tree_definition.root.kind_of? ResqueJobsTree::Definitions::Node
   end
 
-  def test_register_a_leaf
+  def test_register_node
     leaf = 'leaf'
     tree = @tree_definition.spawn []
-    tree.register_a_leaf leaf
-    assert_equal tree.leaves, [leaf]
+    tree.register_node leaf
+    assert_equal tree.nodes, [leaf]
   end
 
   def test_find
     assert_equal 'job2', @tree_definition.find(:job2).name
-    tree_definition = create_nested_tree
+    tree_definition = create_nested_tree_with_job_failure 
     assert_equal 'job4', tree_definition.find(:job4).name
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque_jobs_tree
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-25 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement