exel 1.2.1 → 1.3.0

data/spec/exel/logging_helper_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module EXEL
+  describe LoggingHelper do
+    class HelperClass
+      include LoggingHelper
+    end
+
+    let(:helper) { HelperClass.new }
+
+    describe '#logger' do
+      it 'returns EXEL.logger' do
+        expect(helper.logger).to eq(EXEL.logger)
+      end
+    end
+
+    %i(debug info warn error fatal).each do |level|
+      describe "#log_#{level}" do
+        it "logs a #{level} message" do
+          expect(EXEL.logger).to receive(level).with('test')
+          helper.send("log_#{level}", 'test')
+        end
+      end
+    end
+  end
+end

data/spec/exel/logging_spec.rb

@@ -1,13 +1,33 @@
+# frozen_string_literal: true
 module EXEL
   describe Logging do
     before { @restore_logger = Logging.logger }
     after { Logging.logger = @restore_logger }
 
+    describe Logging::PrefixFormatter do
+      context 'without a Logging prefix' do
+        it 'formats the message' do
+          expect(subject.call('warn', Time.new(2007, 11, 1, 15, 25, 0, '+09:00'), 'test', 'message'))
+              .to eq("2007-11-01 06:25:00 UTC severity=warn, message\n")
+        end
+      end
+
+      context 'with a Logging prefix' do
+        it 'adds the prefix to the formatted message' do
+          Logging.with_prefix('[prefix] ') do
+            expect(subject.call('warn', Time.new(2007, 11, 1, 15, 25, 0, '+09:00'), 'test', 'message'))
+                .to eq("2007-11-01 06:25:00 UTC severity=warn, [prefix] message\n")
+          end
+        end
+      end
+    end
+
     describe '.logger=' do
-      it 'sets a logger' do
-        logger = double(:logger)
+      it 'sets a wrapped logger' do
+        logger = instance_double(Logger)
         Logging.logger = logger
-        expect(Logging.logger).to be(logger)
+        expect(Logging.logger).to be_a(Logging::LoggerWrapper)
+        expect(Logging.logger.__getobj__).to be(logger)
       end
 
       it 'sets a null logger when nil given' do
@@ -28,9 +48,22 @@ module EXEL
         logger = instance_double(Logger)
         expect(Logger).to receive(:new).with('log.txt').and_return(logger)
         expect(logger).to receive(:level=).with(Logger::WARN)
+        expect(logger).to receive(:formatter=).with(Logging::PrefixFormatter)
 
         Logging.logger
       end
     end
+
+    describe '.with_prefix' do
+      it 'sets the prefix before yielding to the block and clears it after' do
+        expect(Logging.prefix).to be_nil
+
+        Logging.with_prefix('testing') do
+          expect(Logging.prefix).to eq('testing')
+        end
+
+        expect(Logging.prefix).to be_nil
+      end
+    end
   end
 end

data/spec/exel/middleware/chain_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+module EXEL
+  module Middleware
+    describe Chain do
+      subject(:chain) { EXEL::Middleware::Chain.new }
+
+      class TestMiddleware
+        def initialize(*)
+        end
+
+        def call
+        end
+      end
+
+      AnotherTestMiddleware = Class.new(TestMiddleware)
+
+      describe '#add' do
+        it 'adds a middleware to the chain' do
+          chain.add(TestMiddleware)
+          expect(chain).to include(TestMiddleware)
+        end
+
+        it 'removes and adds to end if already present' do
+          chain.add(TestMiddleware)
+          chain.add(AnotherTestMiddleware)
+          chain.add(TestMiddleware)
+          expect(chain.entries.map(&:klass)).to eq([AnotherTestMiddleware, TestMiddleware])
+        end
+      end
+
+      describe '#remove' do
+        it 'removes a middleware from the chain' do
+          chain.add(TestMiddleware)
+          chain.add(AnotherTestMiddleware)
+          chain.remove(TestMiddleware)
+          expect(chain.entries.map(&:klass)).to eq([AnotherTestMiddleware])
+        end
+      end
+
+      describe '#include?' do
+        it 'returns true if the middleware class is in the chain' do
+          chain.add(TestMiddleware)
+          expect(chain).to include(TestMiddleware)
+        end
+
+        it 'returns false if the middleware class is not in the chain' do
+          chain.add(TestMiddleware)
+          expect(chain).not_to include(AnotherTestMiddleware)
+        end
+      end
+
+      describe '#invoke' do
+        it 'calls each middleware' do
+          chain.add(TestMiddleware)
+          expect_any_instance_of(TestMiddleware).to receive(:call).with(1, 2, 3)
+          chain.invoke(1, 2, 3)
+        end
+
+        it 'initializes middleware with given constructor arguments' do
+          chain.add(TestMiddleware, 1, 2)
+          expect(TestMiddleware).to receive(:new).with(1, 2).and_return(TestMiddleware.new)
+          chain.invoke
+        end
+      end
+    end
+  end
+end

data/spec/exel/middleware/logging_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module EXEL
+  module Middleware
+    describe Logging do
+      TestProcessor = Class.new
+
+      describe '#call' do
+        it 'yields to the given block' do
+          called = false
+
+          subject.call(Object, {}, {}) do
+            called = true
+          end
+
+          expect(called).to be_truthy
+        end
+
+        it 'logs with context[:log_prefix] and the processor class as the prefix' do
+          expect(EXEL::Logging).to receive(:with_prefix).with('[prefix][EXEL::Middleware::TestProcessor] ')
+          subject.call(TestProcessor, {log_prefix: '[prefix]'}, {}) {}
+        end
+
+        it 'raises rescued exceptions' do
+          expect do
+            subject.call(Object, {}, {}) do
+              raise Exception, 're-raise me'
+            end
+          end.to raise_error Exception, 're-raise me'
+        end
+      end
+    end
+  end
+end

data/spec/exel/middleware_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module EXEL
+  describe Middleware do
+    class IORecorder
+      def initialize(input, output)
+        @input = input
+        @output = output
+      end
+
+      def call(_processor, context, args)
+        @input << args[:input]
+        yield
+        @output << context[:output]
+      end
+    end
+
+    class RescueErrors
+      def call(_processor, _context, _args)
+        yield
+      rescue
+        nil
+      end
+    end
+
+    class AddProcessor
+      def initialize(context)
+        @context = context
+      end
+
+      def process(_)
+        @context[:output] = @context[:input] + 1
+        raise 'rescue me'
+      end
+    end
+
+    before :all do
+      EXEL::Job.define :middleware_test_job do
+        process with: AddProcessor, input: 1
+      end
+    end
+
+    let(:input) { [] }
+    let(:output) { [] }
+
+    before do
+      EXEL.configure do |config|
+        config.middleware.add(IORecorder, input, output)
+        config.middleware.add(RescueErrors)
+      end
+    end
+
+    after do
+      EXEL.configure do |config|
+        config.middleware.remove(IORecorder)
+        config.middleware.remove(RescueErrors)
+      end
+    end
+
+    it 'can configure custom middleware' do
+      expect(EXEL.configuration.middleware.entries.map(&:klass)).to eq([IORecorder, RescueErrors])
+    end
+
+    it 'invokes the middleware around the processor' do
+      EXEL::Job.run(:middleware_test_job)
+      expect(input).to eq([1])
+      expect(output).to eq([2])
+    end
+  end
+end

data/spec/exel/null_instruction_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   describe NullInstruction do
     it { is_expected.to respond_to :execute }

data/spec/exel/processors/async_processor_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   module Processors
     describe AsyncProcessor do

data/spec/exel/processors/run_processor_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   module Processors
     describe RunProcessor do

data/spec/exel/processors/split_processor_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   module Processors
     describe SplitProcessor do
@@ -82,13 +83,7 @@ module EXEL
       end
 
       def create_file(lines)
-        content = ''
-
-        lines.times do |i|
-          line = CSV.generate_line(["line#{i}"])
-          content << line
-        end
-
+        content = Array.new(lines) { |i| CSV.generate_line(["line#{i}"]) }.join
         StringIO.new(content)
       end
     end

data/spec/exel/providers/local_file_provider_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   module Providers
     describe LocalFileProvider do

data/spec/exel/providers/threaded_async_provider_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   module Providers
     class ContextMutatingProcessor

data/spec/exel/sequence_node_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   describe SequenceNode do
     subject(:node) { described_class.new(instance_double(ASTNode), instance_double(ASTNode)) }

data/spec/exel/value_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module EXEL
   describe Value do
     let(:uri) { 's3://test_file.csv' }

data/spec/exel_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 describe EXEL do
   describe '.async_provider' do
     context 'with no async provider set in the configuration' do

data/spec/integration/integration_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 describe EXEL do
   let(:context) { EXEL::Context.new(resource: csv_file, email_service: email_service, delete_resource: false) }
   let(:csv_file) { File.open(File.expand_path('../../fixtures/sample.csv', __FILE__)) }

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'codeclimate-test-reporter'
 CodeClimate::TestReporter.start
 

data/spec/support/integration_test_classes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 Person = Struct.new(:name, :email)
 
 class RecordLoader

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exel
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - yroo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,28 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
+        version: 0.39.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec-focused
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +193,10 @@ files:
 - lib/exel/job.rb
 - lib/exel/listen_instruction.rb
 - lib/exel/logging.rb
+- lib/exel/logging/logger_wrapper.rb
+- lib/exel/logging_helper.rb
+- lib/exel/middleware/chain.rb
+- lib/exel/middleware/logging.rb
 - lib/exel/null_instruction.rb
 - lib/exel/processor_helper.rb
 - lib/exel/processors/async_processor.rb
@@ -225,7 +215,12 @@ files:
 - spec/exel/instruction_spec.rb
 - spec/exel/job_spec.rb
 - spec/exel/listen_instruction_spec.rb
+- spec/exel/logging/logger_wrapper_spec.rb
+- spec/exel/logging_helper_spec.rb
 - spec/exel/logging_spec.rb
+- spec/exel/middleware/chain_spec.rb
+- spec/exel/middleware/logging_spec.rb
+- spec/exel/middleware_spec.rb
 - spec/exel/null_instruction_spec.rb
 - spec/exel/processors/async_processor_spec.rb
 - spec/exel/processors/run_processor_spec.rb
@@ -272,7 +267,12 @@ test_files:
 - spec/exel/instruction_spec.rb
 - spec/exel/job_spec.rb
 - spec/exel/listen_instruction_spec.rb
+- spec/exel/logging/logger_wrapper_spec.rb
+- spec/exel/logging_helper_spec.rb
 - spec/exel/logging_spec.rb
+- spec/exel/middleware/chain_spec.rb
+- spec/exel/middleware/logging_spec.rb
+- spec/exel/middleware_spec.rb
 - spec/exel/null_instruction_spec.rb
 - spec/exel/processors/async_processor_spec.rb
 - spec/exel/processors/run_processor_spec.rb