exel 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 942d50f720fa1beb5f52c5723ce1d821435d28eb
-  data.tar.gz: 0cb7aef5c51a65527872c1cf1fea98de526fc38e
+  metadata.gz: 298395fd3c976be0043f2b3834c60da0a8a04a7b
+  data.tar.gz: 637b4947a4098049c0778311372f6ff5ad5fd556
 SHA512:
-  metadata.gz: c9c02c61169f110c8398f12d2ef89d10a9877625371e98e8db255e5358014dcab9d61ca4f61cdb09bc5e2c3b546c6b0c247b6c2b93d595978db11e08521ca94d
-  data.tar.gz: e7a29db4087b5e45424c5192d81d59372b7247373f4483077688ffb6f3406fd7db49540818d9e3c404f2c68dabe2309fbe833b945b0164906b6bb0cdff4aca27
+  metadata.gz: 0962b4d5a42d1636d8701457af0e0cca956c9137b0c678ff1656f421f97e58c36c38f18a096ab9e60a31efcf76346de177dea5f6a9b522946b47813e9897aee0
+  data.tar.gz: 4829d5aef81952163fc7572ecf0f51227ce411672ce50b57007490509fb56f73376cc3ff9a007b6830e802874117701308486ae1ee934beb2c86f7bd1a6f33db

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -22,4 +21,4 @@ tmp
 mkmf.log
 .idea
 *.iml
-.ruby-*
+.ruby-*

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+- 2.2
+- 2.3
+- 2.4
+- 2.5
+notifications:
+  email:
+    recipients:
+      - dev@yroo.com
+    on_success: change
+    on_failure: always

data/Gemfile

@@ -4,4 +4,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in exel.gemspec
 gemspec
 
-gem 'codeclimate-test-reporter', group: :test, require: nil
+gem 'codeclimate-test-reporter', '0.6.0', group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    exel (1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    ffi (1.9.23)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.3.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.45.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec-focused (0.1.0)
+      rubocop (>= 0.37)
+    ruby-progressbar (1.9.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    terminal-notifier (1.6.3)
+    terminal-notifier-guard (1.7.0)
+    thor (0.20.0)
+    unicode-display_width (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  codeclimate-test-reporter (= 0.6.0)
+  exel!
+  guard (~> 2)
+  guard-rspec (~> 4)
+  guard-rubocop (~> 1)
+  pry-byebug
+  rake (~> 10)
+  rspec (~> 3)
+  rubocop (~> 0.45.0)
+  rubocop-rspec-focused (~> 0)
+  terminal-notifier (~> 1.6.0)
+  terminal-notifier-guard (~> 1.7.0)
+
+BUNDLED WITH
+   1.16.2

data/exel.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard', '~> 2'
   spec.add_development_dependency 'guard-rspec', '~> 4'
   spec.add_development_dependency 'guard-rubocop', '~> 1'
-  spec.add_development_dependency 'terminal-notifier', '~> 1'
-  spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
-  spec.add_development_dependency 'rubocop', '~> 0.39.0'
+  spec.add_development_dependency 'terminal-notifier', '~> 1.6.0'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.7.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45.0'
   spec.add_development_dependency 'rubocop-rspec-focused', '~> 0'
   spec.add_development_dependency 'pry-byebug'
 end

data/lib/exel/context.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'tempfile'
+require 'securerandom'
 
 module EXEL
   # The +Context+ is the shared memory of a running job. It acts as the source of input to processors and the place for

data/lib/exel/deferred_context_value.rb

@@ -48,7 +48,7 @@ module EXEL
 
     # Given a context, returns the value that this instance was acting as a placeholder for.
     def get(context)
-      keys.reduce(context) { |a, e| a[e] }
+      keys.reduce(context) { |acc, elem| acc[elem] }
     end
   end
 end

data/lib/exel/error/job_termination.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:disable Lint/InheritException
 module EXEL
   module Error
     # If a processor raises a JobTermination exception, the job will immediately stop running without raising anything.
@@ -15,3 +16,4 @@ module EXEL
     end
   end
 end
+# rubocop:enable Lint/InheritException

data/lib/exel/events.rb

@@ -12,6 +12,10 @@ module EXEL
       listeners_for_event(event, context).each { |listener| listener.send(event, context, data) }
     end
 
+    def self.included(other)
+      other.class_eval { attr_reader :context }
+    end
+
     private
 
     def listeners_for_event(event, context)

data/lib/exel/job.rb

@@ -27,6 +27,7 @@ module EXEL
       def run(dsl_code_or_name, context = {})
         context = EXEL::Context.new(context) if context.instance_of?(Hash)
         (ast = parse(dsl_code_or_name)) ? ast.start(context) : raise(%(Job "#{dsl_code_or_name}" not found))
+        context
       end
 
       private

data/lib/exel/processor_helper.rb

@@ -63,7 +63,7 @@ module EXEL
     def ensure_transaction_duration(duration, start_time)
       elapsed_time = Time.now.to_f - start_time.to_f
       time_to_sleep = duration.second.to_f - elapsed_time
-      sleep(time_to_sleep) if time_to_sleep > 0
+      sleep(time_to_sleep) if time_to_sleep.positive?
     end
   end
 end

data/lib/exel/processors/split_processor.rb

@@ -12,6 +12,8 @@ module EXEL
     # * +:delete_resource+ Defaults to true, can be set to false to preserve the original resource. Otherwise, it will
     #   be deleted when splitting is complete
     # * +:chunk_size+ Set to specify the number of lines that each chunk should contain
+    # * +:max_chunks+ Set to specify the maximum number of chunks that should be processed. The resource will not be
+    #   consumed beyond this limit.
     class SplitProcessor
       include EXEL::LoggingHelper
 
@@ -26,12 +28,16 @@ module EXEL
         @tempfile_count = 0
         @context = context
         @file = context[:resource]
+        @max_chunks = @context[:max_chunks] || Float::INFINITY
         @context[:delete_resource] = true if @context[:delete_resource].nil?
       end
 
       def process(callback)
         process_file(callback)
         finish(callback)
+      ensure
+        @file.close
+        File.delete(@file.path) if @context[:delete_resource]
       end
 
       def process_line(line, callback)
@@ -61,6 +67,8 @@ module EXEL
 
         CSV.foreach(@file.path, csv_options) do |line|
           process_line(line, callback)
+
+          break if @tempfile_count == @max_chunks
         end
       rescue CSV::MalformedCSVError => e
         log_error "CSV::MalformedCSVError => #{e.message}"
@@ -94,7 +102,6 @@ module EXEL
 
       def finish(callback)
         process_line(:eof, callback)
-        File.delete(@file.path) if @context[:delete_resource]
       end
     end
   end

data/lib/exel/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module EXEL
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/spec/exel/events_spec.rb

@@ -3,12 +3,20 @@ module EXEL
   describe Events do
     class EventTest
       include Events
+
+      def initialize(context)
+        @context = context
+      end
     end
 
-    subject(:events) { EventTest.new }
+    subject(:events) { EventTest.new(context) }
     let(:event_listener) { double(:event_listener) }
     let(:context) { EXEL::Context.new(Events::LISTENERS_KEY => {event: [event_listener]}) }
 
+    it 'defines an attr_reader for context on the class it is included in' do
+      expect(events.context).to eq(context)
+    end
+
     describe '#register_listener' do
       context 'when no listeners have been defined' do
         let(:context) { EXEL::Context.new }

data/spec/exel/job_spec.rb

@@ -34,6 +34,12 @@ module EXEL
           expect(ast).to receive(:start).with(context)
           Job.run('code', context)
         end
+
+        it 'returns the context' do
+          allow(Job::Parser).to receive(:parse).and_return(ast)
+          result = Job.run('code', context)
+          expect(result).to be(context)
+        end
       end
 
       context 'with a job name' do
@@ -49,6 +55,11 @@ module EXEL
             expect(ast).to receive(:start).with(context)
             Job.run(:test_job, context)
           end
+
+          it 'returns the context' do
+            result = Job.run(:test_job, context)
+            expect(result).to be(context)
+          end
         end
 
         context 'of a undefined job' do

data/spec/exel/processors/split_processor_spec.rb

@@ -25,6 +25,7 @@ module EXEL
           expect(splitter).to receive(:process_line).with(:eof, callback)
 
           expect(File).to receive(:delete).with(file.path)
+          expect(file).to receive(:close)
 
           splitter.process(callback)
         end
@@ -43,6 +44,37 @@ module EXEL
           context[:delete_resource] = false
           splitter.process(callback)
         end
+
+        it 'stops splitting at :max_chunks if it is set in the context' do
+          allow(CSV).to receive(:foreach).and_yield(['line0']).and_yield(['line1']).and_yield(['line2'])
+
+          chunk_file = create_file(0)
+
+          allow(Tempfile).to receive(:new).and_return(chunk_file)
+          expect(callback).to receive(:run).once
+          allow_any_instance_of(StringIO).to receive(:path).and_return('test path')
+
+          expect(File).to receive(:delete).with(file.path)
+
+          context[:chunk_size] = 2
+          context[:max_chunks] = 1
+          splitter.process(callback)
+
+          expect(chunk_file.read).to eq("line0\nline1\n")
+        end
+
+        it 'ensures that the source file gets closed and deleted' do
+          allow(CSV).to receive(:foreach).and_raise(Interrupt)
+
+          expect(File).to receive(:delete).with(file.path)
+          expect(file).to receive(:close)
+
+          begin
+            splitter.process(callback)
+          rescue Interrupt
+            nil
+          end
+        end
       end
 
       describe '#process_line' do

data/spec/support/integration_test_classes.rb

@@ -18,8 +18,6 @@ end
 class EmailProcessor
   include EXEL::Events
 
-  attr_reader :context
-
   def initialize(context)
     @context = context
     @people = context[:people]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exel
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - yroo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-26 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: terminal-notifier-guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.45.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.39.0
+        version: 0.45.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec-focused
   requirement: !ruby/object:Gem::Requirement
@@ -176,7 +176,9 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -254,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: EXEL, the Elastic eXEcution Language