fork_break 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b499c0a1fefcb573b97b0b927c0715efc4b570b7
-  data.tar.gz: 4245c08783830dd2819a342e9e02a6247641e110
+  metadata.gz: a045eeead39fd72e60950ac324dd97e1886f1adc
+  data.tar.gz: 2c8be1f3dd8803350b83aaa87967cbbcde7ef27b
 SHA512:
-  metadata.gz: b2ae727120864671c37f8422ff1e9a541829a6751e36cf02b7db2296735e29a1b82134ad5f4241763be90d5d967a1935333b21206fd9efad7d2ab62a9187e866
-  data.tar.gz: 58c7081315b18fa3d8296a67006c2dd0caeb229b787b2443ef67af6c6cfa8eedf31a57aedeb79314669a4218b5ffc1391d0e87e20e3862da76d88a20ab4fa7ef
+  metadata.gz: 76cf51cf876d68c1d97ef8099889b1bc1e829b3d7f4ad121c2bb87f523dcb7afcce3386cda2266bf97d952e288285bef87e0aa4d29a38a8add251565d9afcc34
+  data.tar.gz: c6404a9230a6c0d8022d06290db9bd00ed886d5e0dc689159e1055b957ff70ec6b858bfa1d30f390f465161ecd81af93e1df4125457c4560e005438bcbe1281b

data/.rubocop.yml

@@ -19,3 +19,9 @@ Metrics/AbcSize:
 
 Metrics/MethodLength:
   Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/PerceivedComplexity:
+  Max: 8

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.7
+  - 2.2.3
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+
+before_install:
+  - gem update --system
+  - gem install bundler -v 1.10.6
+install: 'bundle'
+script: 'bundle exec rspec && bundle exec rubocop'
+notifications:
+    email:
+        - pedro.carrico@gmail.com

data/README.md

@@ -1,5 +1,7 @@
 # ForkBreak
 
+[![Build Status](https://secure.travis-ci.org/forkbreak/fork_break.png)](http://travis-ci.org/forkbreak/fork_break) [![Dependency Status](https://gemnasium.com/forkbreak/fork_break.png)](https://gemnasium.com/forkbreak/fork_break) [![Gem Version](https://badge.fury.io/rb/fork_break.svg)](http://badge.fury.io/rb/fork_break) [![Code Climate](https://codeclimate.com/github/forkbreak/fork_break/badges/gpa.svg)](https://codeclimate.com/github/forkbreak/fork_break)
+
 Testing multiprocess behaviour is difficult and requires a way to synchronize processes at
 specific execution points. This gem allows the parent process to control the behaviour of child processes using
 breakpoints. It was originally built for testing the behaviour of database transactions and locking mechanisms.
@@ -98,6 +100,9 @@ puts counter_after_synced_execution("counter_with_lock",    true)  # => 2
 puts counter_after_synced_execution("counter_without_lock", false) # => 1
 ```
 
+When running outside a ForkBreak process the breakpoints will be ignored so that you can use the same classes with
+breakpoints in production code.
+
 There's also the possibility of adding a predefined timeout to the wait function and having it raise an exception.
 
 ```ruby
@@ -115,3 +120,6 @@ process.finish.wait(timeout: 1) # will raise ForkBreak::WaitTimeout after 1 seco
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+ForkBreak is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/fork_break.gemspec

@@ -1,19 +1,20 @@
-require_relative 'lib/fork_break/version'
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'fork_break/version'
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Petter Remen']
-  gem.email         = ['petter.remen@gmail.com']
+  gem.authors       = ['Petter Remen', 'Pedro Carriço']
   gem.summary       =
     'Testing multiprocess behaviour is difficult and requires a way to synchronize processes at specific execution ' \
     'points. This gem allows the parent process to control the behaviour of child processes using breakpoints. It was' \
     'originally built for testing the behaviour of database transactions and locking mechanisms.'
   gem.description   = 'Fork with breakpoints for syncing child process execution'
-  gem.homepage      = 'http://github.com/remen/fork_break'
+  gem.homepage      = 'http://github.com/forkbreak/fork_break'
   gem.licenses      = ['MIT']
-
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'fork_break'
   gem.require_paths = ['lib']
   gem.version       = ForkBreak::VERSION

data/lib/fork_break.rb

@@ -1,4 +1,5 @@
 require 'fork'
+require 'fork_break/null_breakpoint_setter'
 require 'fork_break/breakpoint_setter'
 require 'fork_break/breakpoints'
 require 'fork_break/process'

data/lib/fork_break/null_breakpoint_setter.rb

@@ -0,0 +1,7 @@
+module ForkBreak
+  class NullBreakpointSetter
+    def <<(*)
+      # no-op
+    end
+  end
+end

data/lib/fork_break/process.rb

@@ -4,16 +4,21 @@ module ForkBreak
       attr_accessor :breakpoint_setter
     end
 
+    attr_reader :return_value
+
+    @breakpoint_setter = NullBreakpointSetter.new
+
     def initialize(debug = false, &block)
       @debug = debug
       @fork = Fork.new(:return, :to_fork, :from_fork) do |child_fork|
         self.class.breakpoint_setter = breakpoints = BreakpointSetter.new(child_fork, debug)
 
         breakpoints << :forkbreak_start
-        block.call(breakpoints)
+        returned_value = block.call(breakpoints)
         breakpoints << :forkbreak_end
 
         self.class.breakpoint_setter = nil
+        returned_value
       end
     end
 
@@ -31,6 +36,9 @@ module ForkBreak
         loop do
           brk = @fork.receive_object
           puts "Parent is receiving object #{brk} from #{@fork.pid}" if @debug
+
+          @return_value = @fork.return_value if brk == :forkbreak_end
+
           if brk == @next_breakpoint
             return self
           elsif brk == :forkbreak_end

data/lib/fork_break/version.rb

@@ -1,3 +1,3 @@
 module ForkBreak
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/spec/fork_break_spec.rb

@@ -59,7 +59,7 @@ describe ForkBreak::Process do
       end
     end
 
-    def counter_after_synced_execution(counter_path, with_lock) # rubocop:disable Metrics/AbcSize
+    def counter_after_synced_execution(counter_path, with_lock)
       process1, process2 = 2.times.map do
         ForkBreak::Process.new { FileCounter.open(counter_path, with_lock).increase }
       end
@@ -86,6 +86,21 @@ describe ForkBreak::Process do
     end
   end
 
+  it 'ignores breakpoints when running outside a ForkBreak process' do
+    class Foo
+      include ForkBreak::Breakpoints
+
+      def bar
+        breakpoints << :test
+        'baz'
+      end
+    end
+
+    expect(Foo.new.breakpoints).to be_kind_of(ForkBreak::NullBreakpointSetter)
+    expect { Foo.new.bar }.to_not raise_error
+    expect(Foo.new.bar).to eq('baz')
+  end
+
   it 'raises the process exception' do
     class MyException < StandardError; end
 
@@ -103,4 +118,18 @@ describe ForkBreak::Process do
 
     expect { process.finish.wait(timeout: 0.01) }.to raise_error(ForkBreak::WaitTimeout)
   end
+
+  it 'keeps the return value of the process' do
+    class Foo
+      include ForkBreak::Breakpoints
+
+      def bar
+        'baz'
+      end
+    end
+
+    process = ForkBreak::Process.new { Foo.new.bar }.finish.wait
+
+    expect(process.return_value).to eq('baz')
+  end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fork_break
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Petter Remen
+- Pedro Carriço
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fork
@@ -65,8 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.27.1
 description: Fork with breakpoints for syncing child process execution
-email:
-- petter.remen@gmail.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -74,6 +74,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -82,11 +83,12 @@ files:
 - lib/fork_break.rb
 - lib/fork_break/breakpoint_setter.rb
 - lib/fork_break/breakpoints.rb
+- lib/fork_break/null_breakpoint_setter.rb
 - lib/fork_break/process.rb
 - lib/fork_break/version.rb
 - spec/fork_break_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/remen/fork_break
+homepage: http://github.com/forkbreak/fork_break
 licenses:
 - MIT
 metadata: {}
@@ -106,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Testing multiprocess behaviour is difficult and requires a way to synchronize