batsir 0.1.0 → 0.3.7

data/spec/batsir/chain_spec.rb

@@ -1,24 +1,24 @@
 require File.join( File.dirname(__FILE__), "..", "spec_helper" )
 
 describe Batsir::Chain do
-  it "should have a list of stages" do
+  it "has a list of stages" do
     chain = Batsir::Chain.new
     chain.stages.should_not be_nil
   end
 
-  it "should initially have an empty list of stages" do
+  it "initially has an empty list of stages" do
     chain = Batsir::Chain.new
     chain.stages.should be_empty
   end
 
-  it "should be possible to add a stage" do
+  it "can add a stage" do
     chain = Batsir::Chain.new
     stage = Batsir::Stage.new(:name => "Stage")
     chain.add_stage(stage)
     chain.stages.should include stage
   end
 
-  it "should be possible to compile a chain" do
+  it "can compile a chain" do
     chain = Batsir::Chain.new
     stage = Batsir::Stage.new(:name => "Stage")
     chain.add_stage(stage)

data/spec/batsir/config_spec.rb

@@ -0,0 +1,97 @@
+require File.join( File.dirname(__FILE__), "..", "spec_helper" )
+
+describe Batsir::Config do
+  context "with respect to retrieving variables" do
+    it "can check if a key exists" do
+      Batsir::Config.key?(:sidekiq_queue).should be_true
+      Batsir::Config.key?(:non_existent).should be_false
+    end
+
+    it "can use brackets" do
+      Batsir::Config[:sidekiq_queue].should == 'batsir'
+    end
+
+    it "can use fetch method" do
+      Batsir::Config.fetch(:sidekiq_queue, nil).should == 'batsir'
+    end
+
+    it "returns the default value when variable does not exist" do
+      Batsir::Config.fetch(:dbase, 'default').should == 'default'
+    end
+
+    it "can use a method with the variable's name" do
+      Batsir::Config.sidekiq_queue.should == 'batsir'
+    end
+
+    it "can use return the settings in a hash" do
+      Batsir::Config[:dbase] = :test
+      hash = Batsir::Config.to_hash
+      hash.keys.include?(:sidekiq_queue).should be_true
+      hash.keys.include?(:dbase).should be_true
+      hash.values.include?(:test).should be_true
+      hash.values.include?('batsir').should be_true
+    end
+  end
+
+  context "with respect to setting variables" do
+    it "can set a variable using brackets" do
+      Batsir::Config[:testtest] = "testtest"
+      Batsir::Config.testtest.should == "testtest"
+    end
+
+    it "can set a variable using a method with the variable's name" do
+      Batsir::Config.testtest = "test1"
+      Batsir::Config[:testtest].should == "test1"
+    end
+
+    context "setting multiple variables at once" do
+      it "can use setup method" do
+        Batsir::Config.setup({:test_var => "test1", :test_var2 => "test2"})
+        Batsir::Config.test_var.should == "test1"
+        Batsir::Config.test_var2.should == "test2"
+      end
+
+      it "merges given settings with default settings when using setup method" do
+        Batsir::Config.setup({:test_var => "test1", :test_var2 => "test2"})
+        Batsir::Config.sidekiq_queue.should == 'batsir'
+      end
+
+      context "with block notation" do
+        it "uses yielding" do
+          Batsir::Config.use do |config|
+            config[:tester1] = "test1"
+            config[:tester2] = "test2"
+          end
+          Batsir::Config.sidekiq_queue.should == 'batsir'
+          Batsir::Config.tester1.should == "test1"
+          Batsir::Config.tester2.should == "test2"
+        end
+
+        it "uses a block" do
+          Batsir::Config.configure do
+            tester3 "test3"
+            tester4 "test4"
+          end
+          Batsir::Config.sidekiq_queue.should == 'batsir'
+          Batsir::Config.tester3.should == "test3"
+          Batsir::Config.tester4.should == "test4"
+        end
+      end
+    end
+  end
+
+  context "with respect to deleting variables" do
+    it "deletes the given key" do
+      Batsir::Config.sidekiq_queue.should_not be_nil
+      Batsir::Config.delete(:sidekiq_queue)
+      Batsir::Config.sidekiq_queue.should be_nil
+    end
+  end
+end
+
+describe Batsir::Config, "with respect to resetting the configuration" do
+  it "resets properly" do
+    Batsir::Config.reset
+    Batsir::Config.to_hash.should == Batsir::Config.defaults
+  end
+end

data/spec/batsir/dsl/chain_mapping_spec.rb

@@ -1,7 +1,7 @@
 require File.join( File.dirname(__FILE__), "..", "..", "spec_helper")
 
 describe Batsir::DSL::ChainMapping do
-  it "should create a chain" do
+  it "creates a chain" do
     block = ::Proc.new do
       aggregator_chain do
       end
@@ -11,7 +11,7 @@ describe Batsir::DSL::ChainMapping do
     chain.should_not be_nil
   end
 
-  it "should be possible to add a stage" do
+  it "can add a stage" do
     block = ::Proc.new do
       aggregator_chain do
         stage "simple_stage" do
@@ -26,7 +26,7 @@ describe Batsir::DSL::ChainMapping do
     chain.stages.first.name.should == "simple_stage"
   end
 
-  it "should set the chain of the stage to the current chain" do
+  it "sets the chain of the stage to the current chain" do
     block = ::Proc.new do
       aggregator_chain do
         stage "simple_stage" do
@@ -40,7 +40,7 @@ describe Batsir::DSL::ChainMapping do
     chain.stages.first.chain.should == chain
   end
 
-  it "should be possible to add multiple stages" do
+  it "can add multiple stages" do
     block = ::Proc.new do
       aggregator_chain do
         stage "first_stage" do
@@ -59,7 +59,7 @@ describe Batsir::DSL::ChainMapping do
     chain.stages.last.name.should == "second_stage"
   end
 
-  it "should be possible to create a complete aggregator chain" do
+  it "can create a complete aggregator chain" do
     stage_name            = "Complete Stage"
     operation1            = "Some Operation"
     operation2            = "Another Operation"
@@ -113,5 +113,4 @@ describe Batsir::DSL::ChainMapping do
       stage.notifiers[notification_class2].first.should == {}
     end
   end
-
 end

data/spec/batsir/dsl/conditional_notifier_mapping_spec.rb

@@ -0,0 +1,80 @@
+require File.join( File.dirname(__FILE__), "..", "..", "spec_helper")
+
+describe Batsir::DSL::ConditionalNotifierMapping do
+  it "creates conditional notifier declarations" do
+    block = lambda do
+      conditional do
+        notify_if "message == 'sometext'", Batsir::Notifiers::Notifier
+      end
+    end
+
+    conditional = ::Blockenspiel.invoke(block, Batsir::DSL::ConditionalNotifierMapping.new)
+    conditional.notifier_declarations.should_not be_empty
+    conditional_notifier = conditional.notifier_declarations.first
+    conditional_notifier.notifier.should == Batsir::Notifiers::Notifier
+  end
+
+  it "passes options to notifiers" do
+    block = lambda do
+      conditional do
+        notify_if "true", Batsir::Notifiers::Notifier, :some => :options
+      end
+    end
+
+    conditional = ::Blockenspiel.invoke(block, Batsir::DSL::ConditionalNotifierMapping.new)
+    conditional.notifier_declarations.should_not be_empty
+    conditional_notifier = conditional.notifier_declarations.first
+    conditional_notifier.options.should have_key :some
+  end
+
+  it "can be used inside a stage" do
+    block = lambda do
+      stage "stage name" do
+        outbound do
+          conditional do
+            notify_if "true", Batsir::Notifiers::Notifier, :some => :options
+          end
+        end
+      end
+    end
+
+    stage = ::Blockenspiel.invoke(block, Batsir::DSL::StageMapping.new)
+    notifier = stage.conditional_notifiers.should_not be_empty
+  end
+
+  context "compiling" do
+    before :all do
+      Celluloid.boot
+
+      block = lambda do
+        stage "stage name" do
+          outbound do
+            conditional do
+              notify_if "true", Batsir::Notifiers::Notifier
+              notify_if "false", Batsir::Notifiers::Notifier
+            end
+          end
+        end
+      end
+
+      stage = ::Blockenspiel.invoke(block, Batsir::DSL::StageMapping.new)
+      created_class = eval( stage.compile )
+      @instance = created_class.new
+    end
+
+    it "stores the conditional notifier" do
+      @instance.filter_queue.notifiers.size == 1
+      conditional = @instance.filter_queue.notifiers.first
+      conditional.should be_kind_of Batsir::Notifiers::ConditionalNotifier
+      conditional.notifiers.size.should == 2
+      conditional.notifiers.first.condition.should be_a Proc
+    end
+
+    it "adds the default transformer" do
+      notifier = @instance.filter_queue.notifiers.first
+      notifier.transformer_queue.size.should == 1
+      notifier.transformer_queue.first.should be_kind_of Batsir::Transformers::Transformer
+    end
+  end
+end
+

data/spec/batsir/dsl/stage_mapping_spec.rb

@@ -1,7 +1,7 @@
 require File.join( File.dirname(__FILE__), "..", "..", "spec_helper")
 
 describe Batsir::DSL::StageMapping do
-  it "should create a simple stage with a name" do
+  it "creates a simple stage with a name" do
     block = ::Proc.new do
       stage "simple_stage" do
       end
@@ -12,7 +12,7 @@ describe Batsir::DSL::StageMapping do
     stage.name.should == "simple_stage"
   end
 
-  it "should be possible to add an filter to the stage" do
+  it "can add a filter to the stage" do
     filter = "Operation"
 
     block = ::Proc.new do
@@ -28,7 +28,25 @@ describe Batsir::DSL::StageMapping do
     stage.filters.should include filter
   end
 
-  it "should be possible to add multiple filters to the stage" do
+  it "can add a filter with options to the stage" do
+    filter  = "Operation"
+    options = { :option => "options" }
+
+    block = ::Proc.new do
+      stage "simple_stage" do
+        filter filter, options
+      end
+    end
+
+    stage = ::Blockenspiel.invoke(block, Batsir::DSL::StageMapping.new)
+    stage.should_not be_nil
+    stage.filters.should_not be_nil
+    stage.filters.should_not be_empty
+    declaration = stage.filter_declarations.find{|decl| decl.filter == filter }
+    declaration.options.should == options
+  end
+
+  it "can add multiple filters to the stage" do
     filter1 = "Operation 1"
     filter2 = "Operation 2"
 
@@ -47,7 +65,7 @@ describe Batsir::DSL::StageMapping do
     stage.filters.should include filter2
   end
 
-  it "should be possible to add an inbound section to a stage" do
+  it "can add an inbound section to a stage" do
     block = ::Proc.new do
       stage "simple_stage" do
         inbound do
@@ -62,7 +80,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptors.should be_empty
   end
 
-  it "should be possible to add a transformers section to the inbound section of a stage" do
+  it "can add a transformers section to the inbound section of a stage" do
     block = ::Proc.new do
       stage "simple_stage" do
         inbound do
@@ -80,7 +98,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptor_transformers.should be_empty
   end
 
-  it "should be possible to add a transformer to the transformers section of the inbound section of a stage" do
+  it "can add a transformer to the transformers section of the inbound section of a stage" do
     transformer = :transformer
 
     block = ::Proc.new do
@@ -102,7 +120,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptor_transformers.first.transformer.should == transformer
   end
 
-  it "should be possible to add a transformer with options to the transformers section of the inbound section of a stage" do
+  it "can add a transformer with options to the transformers section of the inbound section of a stage" do
     transformer = :transformer
     options     = {:foo => :bar}
 
@@ -126,7 +144,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptor_transformers.first.options.should == options
   end
 
-  it "should be possible to add multiple transformers to the transformers section of the inbound section of a stage" do
+  it "can add multiple transformers to the transformers section of the inbound section of a stage" do
     transformer1 = :transformer1
     options     = {:foo => :bar}
     transformer2 = :transformer2
@@ -154,7 +172,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptor_transformers.last.options.should == {}
   end
 
-  it "should be possible to add an acceptor to a stage" do
+  it "can add an acceptor to a stage" do
     acceptor_class = :acceptor_class
 
     block = ::Proc.new do
@@ -173,7 +191,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptors[acceptor_class].first.should == {}
   end
 
-  it "should be possible to add an inbound section with an acceptor with options to the stage" do
+  it "can add an inbound section with an acceptor with options to the stage" do
     acceptor_class = :acceptor_class
     options = {:foo => :bar}
 
@@ -193,7 +211,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptors[acceptor_class].first.should == options
   end
 
-  it "should be possible to add multiple acceptors to a stage" do
+  it "can add multiple acceptors to a stage" do
     acceptor_class1 = :acceptor_class1
     options = {:foo => :bar}
     acceptor_class2 = :acceptor_class2
@@ -217,7 +235,7 @@ describe Batsir::DSL::StageMapping do
     stage.acceptors[acceptor_class2].first.should == {}
   end
 
-  it "should be possible to add an outbound section without any notifiers" do
+  it "can add an outbound section without any notifiers" do
     block = ::Proc.new do
       stage "simple_stage" do
         outbound do
@@ -232,7 +250,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifiers.should be_empty
   end
 
-  it "should be possible to add a transformers section to the outbound section of a stage" do
+  it "can add a transformers section to the outbound section of a stage" do
     block = ::Proc.new do
       stage "simple_stage" do
         outbound do
@@ -250,7 +268,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifier_transformers.should be_empty
   end
 
-  it "should be possible to add a transformer to the transformers section of the outbound section of a stage" do
+  it "can add a transformer to the transformers section of the outbound section of a stage" do
     transformer = :transformer
 
     block = ::Proc.new do
@@ -272,7 +290,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifier_transformers.first.transformer.should == transformer
   end
 
-  it "should be possible to add a transformer with options to the transformers section of the outbound section of a stage" do
+  it "can add a transformer with options to the transformers section of the outbound section of a stage" do
     transformer = :transformer
     options     = {:foo => :bar}
 
@@ -296,7 +314,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifier_transformers.first.options.should == options
   end
 
-  it "should be possible to add multiple transformers to the transformers section of the outbound section of a stage" do
+  it "can add multiple transformers to the transformers section of the outbound section of a stage" do
     transformer1 = :transformer1
     options     = {:foo => :bar}
     transformer2 = :transformer2
@@ -324,7 +342,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifier_transformers.last.options.should == {}
   end
 
-  it "should be possible to add an outbound section to the stage" do
+  it "can add an outbound section to the stage" do
     notification_class = :notification_class
 
     block = ::Proc.new do
@@ -342,7 +360,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifiers[notification_class].first.should == {}
   end
 
-  it "should be possible to add an outbound section with a notifier with options to the stage" do
+  it "can add an outbound section with a notifier with options to the stage" do
     notification_class = :notification_class
     options = {:queue => :somequeue}
 
@@ -361,7 +379,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifiers[notification_class].first.should == options
   end
 
-  it "should be possible to add multiple notifiers to the stage" do
+  it "can add multiple notifiers to the stage" do
     notification_class1 = :notification_class1
     options             = {:queue => :somequeue}
     notification_class2 = :notification_class2
@@ -385,7 +403,7 @@ describe Batsir::DSL::StageMapping do
     stage.notifiers[notification_class2].first.should == {}
   end
 
-  it "should be possible to create a complete stage" do
+  it "can create a complete stage" do
     acceptor_class1     = :acceptor_class1
     options             = {:foo => :bar}
     acceptor_class2     = :acceptor_class2

data/spec/batsir/filter_queue_spec.rb

@@ -1,15 +1,14 @@
 require File.join( File.dirname(__FILE__), "..", "spec_helper" )
 
 describe Batsir::FilterQueue do
-  it "should be possible to add a filter to a queue" do
+  it "can add a filter to a queue" do
     queue = Batsir::FilterQueue.new
     queue.add("Filter")
     queue.should include "Filter"
   end
 
-  it "should not return nil as last operation when no acceptors or notifiers are added" do
+  it "does not return nil as last operation when no acceptors or notifiers are added" do
     queue = Batsir::FilterQueue.new
-
     queue.add("AnotherFilter")
     ops = []
     queue.each do |op|
@@ -18,28 +17,26 @@ describe Batsir::FilterQueue do
     ops.last.should_not be_nil
   end
 
-  it "should be possible to add a notifier" do
+  it "can add a notifier" do
     queue = Batsir::FilterQueue.new
     notifier = "Notifier"
     queue.add_notifier(notifier)
     queue.should include notifier
   end
 
-  it "should be possible to add multiple notifiers" do
+  it "can add multiple notifiers" do
     queue = Batsir::FilterQueue.new
     ops = []
     3.times do |index|
       ops << "Notifier #{index}"
       queue.add_notifier("Notifier #{index}")
     end
-
     ops.each {|op| queue.should include op}
   end
 
-  it "should return notifiers as the last operations" do
-    queue = Batsir::FilterQueue.new
+  it "returns notifiers as the last operations" do
     notifier = "Notifier"
-
+    queue = Batsir::FilterQueue.new
     queue.add("SomeFilter")
     queue.add_notifier(notifier)
     queue.add("AnotherFilter")
@@ -51,23 +48,20 @@ describe Batsir::FilterQueue do
     ops.last.should == notifier
   end
 
-  it "should respond true to #empty? when no operations are added" do
+  it "responds true to #empty? when no operations are added" do
     queue = Batsir::FilterQueue.new
     queue.should be_empty
   end
 
-  it "should not be empty when a notification operation is added" do
+  it "is not empty when a notification operation is added" do
     queue = Batsir::FilterQueue.new
     operation = "Notifier"
-
     queue.add_notifier(operation)
-
     queue.should_not be_empty
   end
 
-  it "should not be empty when a regular operation is added" do
+  it "is not empty when a regular operation is added" do
     queue = Batsir::FilterQueue.new
-
     queue.add("SomeFilter")
     queue.should_not be_empty
   end

data/spec/batsir/filter_spec.rb

@@ -1,12 +1,11 @@
 require File.join( File.dirname(__FILE__), "..", "spec_helper" )
 
 describe Batsir::Filter do
-  it "should be possible to create an filter" do
-    filter = Batsir::Filter.new
-    filter.should_not be_nil
+  it "has an #execute method" do
+    Batsir::Filter.instance_methods.map{|im| im.to_s}.should include "execute"
   end
 
-  it "should have an #execute method" do
-    Batsir::Filter.instance_methods.map{|im| im.to_s}.should include "execute"
+  it "throws an NotImplementedError when #execute method is not overridden" do
+    lambda{subject.execute("testing..1..2..3")}.should raise_error NotImplementedError
   end
 end

data/spec/batsir/log_spec.rb

@@ -0,0 +1,10 @@
+require File.join( File.dirname(__FILE__), "..", "spec_helper" )
+
+describe Batsir::Log do
+  it 'provides a convenience method for logging' do
+    class TestClass
+      include Batsir::Log
+    end
+    TestClass.instance_methods.map{|im| im.to_s}.should include 'log'
+  end
+end

data/spec/batsir/logger_spec.rb

@@ -0,0 +1,46 @@
+require File.join( File.dirname(__FILE__), "..", "spec_helper" )
+
+describe Batsir::Logger do
+  before :all do
+    @logger = Batsir::Logger
+  end
+
+  it 'returns an object of Log4r::Logger class' do
+    @logger.log.should be_a Log4r::Logger
+  end
+
+  it 'allows changing its settings' do
+    @logger.level.should_not == Log4r::DEBUG
+    @logger.level = Log4r::DEBUG
+    @logger.level.should == Log4r::DEBUG
+  end
+
+  it 'can be reset' do
+    current_log = @logger.level
+    Batsir::Logger.reset
+    @logger.level.should_not == current_log
+  end
+
+  it 'is able to use various log levels' do
+    @logger.level = Log4r::DEBUG
+    debug = @logger.debug("debug test message")
+    debug.should be_an Array
+    debug.select{|e| e.is_a?(Log4r::StdoutOutputter)}.should_not be_empty
+
+    info = @logger.info("info test message")
+    info.should be_an Array
+    info.select{|e| e.is_a?(Log4r::StdoutOutputter)}.should_not be_empty
+
+    warn = @logger.warn("warning test message")
+    warn.should be_an Array
+    warn.select{|e| e.is_a?(Log4r::StdoutOutputter)}.should_not be_empty
+
+    err = @logger.error("error test message")
+    err.should be_an Array
+    err.select{|e| e.is_a?(Log4r::StdoutOutputter)}.should_not be_empty
+
+    fatal = @logger.fatal("fatal test message")
+    fatal.should be_an Array
+    fatal.select{|e| e.is_a?(Log4r::StdoutOutputter)}.should_not be_empty
+  end
+end