diverter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b1f6a4d524f4b2f602291f5b6ffa9907cb6ea9bd1d6df9f1029b83d0029002c
+  data.tar.gz: 976cb8b2bd3d951c82588a3756933d4c9e1d5cdc3034188244891d053defc1f2
+SHA512:
+  metadata.gz: ffe5489de472fe31f1a582fe9dd6827f3e6941676ee88754c2743f4d0b27fc78a04e999df36aae1650a5042f4be5ce5356192e39d3db7e547ad519f9a0f6b7f4
+  data.tar.gz: 4f612a8ab935cad717d62e15ce8a94e85dfcd18fc0c98c2067d3dc8ce94e461a3f2c18e4c92b0bb042433eb9b0593c5f5acfa3714cbcb29b90b061094ac1a2d8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in levenshtein_rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2024 Robin Stammer
+
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# diverter
+
+Lightweight Ruby library for executing tasks in a seperate Ruby subprocesses
+
+### Motivation
+
+Ruby very rarely releases memory back to the operating system once allocated.
+This gem realizes a neat trick as suggested by the Book "Ruby Performance Optimization"
+by [Alexander Dymo](https://github.com/adymo): https://pragprog.com/book/adrpo/ruby-performance-optimization
+
+The crucial point is that exiting a subprocess will force Ruby to release
+all the memory allocated in the subprocess back to the OS.
+
+### Synopsis
+
+```Ruby
+class DecadentMemoryConsumer
+  …
+
+  # Needs a lot of memory
+  # to execute some magical
+  # task
+
+  …
+end
+
+# If the predicate :memory_almost_exceeded? evaluates to true,
+# the block will be executed in a forked subprocess
+# that is forced to terminate afterwards
+Diverter.new(condition: memory_almost_exceeded?) do
+  DecadentMemoryConsumer.perform_memory_expensive_operation
+end
+
+# condition defaults to true, so this is equivalent of condition set to true
+Diverter.new do
+  DecadentMemoryConsumer.perform_memory_expensive_operation
+end
+```
+
+### Changelog
+
+#### 0.0.1
+
+Initial version

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/diverter.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'diverter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "diverter"
+  spec.version       = Diverter::VERSION
+  spec.authors       = ["Robin Stammer\n"]
+  spec.email         = ["robin.stammer@posteo.de"]
+  spec.summary       = %q{Lightweight tool for execution of Ruby code in a forked Ruby process}
+  spec.description   = %q{Lightweight tool for execution of Ruby code in a forked Ruby process}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/diverter/version.rb

@@ -0,0 +1,3 @@
+class Diverter
+  VERSION = "0.0.1"
+end

data/lib/diverter.rb

@@ -0,0 +1,21 @@
+require "diverter/version"
+
+class Diverter
+
+  def initialize(condition: true)
+    return unless block_given?
+
+    if !!condition
+      pid = fork do
+        yield
+        exit!(0)
+      end
+
+      # ensure the child process has terminated
+      Process::waitpid(pid)
+    else
+      yield
+    end
+  end
+
+end

data/spec/diverter_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Diverter do
+
+  class Monkey
+    class << self
+      def cheek
+      end
+    end
+  end
+
+  it 'has a version number' do
+    expect(Diverter::VERSION).not_to be nil
+  end
+
+  describe 'its constructor' do
+    context 'without condition delivered' do
+      subject { described_class.new { Monkey.cheek } }
+
+      it 'executes block in a forked process' do
+        expect_any_instance_of(Object).to receive(:fork).and_call_original
+        subject
+      end
+    end
+
+    context 'with condition false' do
+      subject { described_class.new(condition: false) { Monkey.cheek } }
+
+      it 'executes block in unforked' do
+        expect(Monkey).to receive(:cheek)
+        expect_any_instance_of(Object).not_to receive(:fork)
+        subject
+      end
+    end
+
+    context 'with condition nil' do
+      subject { described_class.new(condition: nil) { Monkey.cheek } }
+
+      it 'executes block in unforked' do
+        expect(Monkey).to receive(:cheek)
+        expect_any_instance_of(Object).not_to receive(:fork)
+        subject
+      end
+    end
+
+
+    context 'with condition true' do
+      subject { described_class.new(condition: true) { Monkey.cheek } }
+
+      it 'executes block in a forked process' do
+        expect_any_instance_of(Object).to receive(:fork).and_call_original
+        subject
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'diverter'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: diverter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- 'Robin Stammer
+
+  '
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lightweight tool for execution of Ruby code in a forked Ruby process
+email:
+- robin.stammer@posteo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- diverter.gemspec
+- lib/diverter.rb
+- lib/diverter/version.rb
+- spec/diverter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: Lightweight tool for execution of Ruby code in a forked Ruby process
+test_files:
+- spec/diverter_spec.rb
+- spec/spec_helper.rb