deadly_serious 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4e5a695f5a8d23a761dcaeec8922f6a05c51810
-  data.tar.gz: 66e33d29d812a6be29dcbb73cc43ec733d3eb15a
+  metadata.gz: 05f3250fb16090279dad66ecabbab4990e170873
+  data.tar.gz: 5bb83f5cb6f050f7f2e008242434e4f556964e09
 SHA512:
-  metadata.gz: e81df18b44cb2f973511ddf230647195672be057e201445ee9a086e29020a2d9752c16fcbc9f590add086f6311c433430d36bc9eb440cee44b77dd5141ef4284
-  data.tar.gz: 796f4998d1710929ec493c2a4845ac5d52105fac24cc5e5f240266a0df5971c9aaf80a11b6ef1b4c1a4f354f61b486b137699f4ee14e0402e988bc3845fe3672
+  metadata.gz: 03bda6d7a58b0c890dbe1b98ace3b8b338ff788725cbd02289797912bb7cc5507ea5331bf447cce4614b9ff058b046b228ad8cd2ce28e3a76b68adb8fad22ca8
+  data.tar.gz: 170776a0f3d4f8fc593b24513027e0341d950590e67ceb945502f7467fa0be6e16f3174c29193225eca82436d5df3f148824f05214c3e60eec3bbbd9f4adc615

data/.ruby-gemset

@@ -0,0 +1 @@
+deadly_serious

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1

data/deadly_serious.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'deadly_serious/version'
@@ -18,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.1'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
 

data/lib/deadly_serious/engine/commands.rb

@@ -0,0 +1,113 @@
+module DeadlySerious
+  module Engine
+    # Commands make work with Pipelines easier.
+    module Commands
+
+      private def auto_pipe
+        @auto_pipe ||= AutoPipe.new
+      end
+
+      def on_subnet(&block)
+        auto_pipe.on_subnet &block
+      end
+
+      def next_pipe
+        auto_pipe.next
+      end
+
+      def last_pipe
+        auto_pipe.last
+      end
+
+      # Read a file from "data" dir and pipe it to
+      # the next component.
+      def from_file(file_name, writer: next_pipe)
+        file = file_name.sub(/^>?(.*)$/, '>\1')
+        spawn_command(%{cat ((#{file})) > ((#{writer}))})
+      end
+
+      # Write a file to "data" dir from the pipe
+      # of the last component
+      def to_file(file_name, reader: last_pipe)
+        file = file_name.sub(/^>?(.*)$/, '>\1')
+        spawn_command(%{cat ((#{reader})) > ((#{file}))})
+      end
+
+      # Read from a specific named pipe.
+      #
+      # This is useful after a {#spawn_tee}, sometimes.
+      def from_pipe(pipe_name, writer: next_pipe)
+        pipe = pipe_name.sub(/^>?/, '')
+        spawn_command(%{cat ((#{pipe})) > ((#{writer}))})
+      end
+
+      # Write the output of the last component to
+      # a specific named pipe.
+      #
+      # Unless you are connecting different pipelines,
+      # avoid using this or check if you don't need
+      # {#spawn_tee} instead.
+      def to_pipe(pipe_name, reader: last_pipe)
+        pipe = pipe_name.sub(/^>?/, '')
+        spawn_command(%{cat ((#{reader})) > ((#{pipe}))})
+      end
+
+      # Spawn a class connected to the last and next components
+      def spawn_class(a_class, *args, reader: last_pipe, writer: next_pipe)
+        spawn_process(a_class, *args, readers: [reader], writers: [writer])
+      end
+
+      # Spawn {number_of_processes} classes, one process for each of them.
+      # Also, it divides the previous pipe in {number_of_processes} pipes,
+      # an routes data through them.
+      def spawn_class_parallel(number_of_processes, class_name, *args, reader: last_pipe, writer: next_pipe)
+        connect_a = (1..number_of_processes).map { |i| sprintf('%s.%da.splitter', class_name.to_s.downcase.gsub(/\W+/, '_'), i) }
+        connect_b = (1..number_of_processes).map { |i| sprintf('%s.%db.splitter', class_name.to_s.downcase.gsub(/\W+/, '_'), i) }
+        spawn_process(DeadlySerious::Processes::Splitter, readers: [reader], writers: connect_a)
+        connect_a.zip(connect_b).each do |a, b|
+          spawn_class(class_name, *args, reader: a, writer: b)
+        end
+        spawn_process(DeadlySerious::Processes::Joiner, readers: connect_b, writers: [writer])
+      end
+
+      # Pipe from the last component to a intermediate
+      # file (or pipe) while continue the process.
+      #
+      # If a block is provided, it pipes from the last
+      # component INTO the block, while it pipes to the
+      # next component OUT of the block.
+      def spawn_tee(escape = nil, reader: nil, writer: nil, &block)
+        # Lots of contours to make #last_pipe and and #next_pipe
+        # to work correctly.
+        reader ||= last_pipe
+        escape ||= next_pipe
+        writer ||= next_pipe
+
+        # TODO Validates if an "escape" or a block was provided
+        spawn_command(%{cat ((#{reader})) | tee ((#{escape})) > ((#{writer}))})
+
+        return unless block_given?
+        on_subnet do
+          spawn_command(%{cat ((#{escape})) > ((#{next_pipe}))})
+          block.call
+        end
+      end
+
+      # Sometimes we need all previous process to end before
+      # starting new processes. The capacitor command does
+      # exactly that.
+      def spawn_capacitor(charger_file = nil, reader: last_pipe, writer: next_pipe)
+        if charger_file.nil?
+          charger_file = ">#{last_pipe}"
+          temp_charger = true
+        end
+        fail "#{charger_file} must be a file" unless charger_file.start_with?('>')
+        if temp_charger
+          spawn_command("cat ((#{reader})) > ((#{charger_file})); cat ((#{charger_file})) > ((#{writer})); rm ((#{charger_file}))")
+        else
+          spawn_command("cat ((#{reader})) > ((#{charger_file})); cat ((#{charger_file})) > ((#{writer}))")
+        end
+      end
+    end
+  end
+end

data/lib/deadly_serious/engine/spawner.rb

@@ -6,6 +6,8 @@ require 'deadly_serious/processes/splitter'
 module DeadlySerious
   module Engine
     class Spawner
+      include DeadlySerious::Engine::Commands
+
       attr_reader :data_dir, :pipe_dir
 
       def initialize(data_dir: './data',
@@ -14,22 +16,9 @@ module DeadlySerious
         @data_dir = data_dir
         @pipe_dir = pipe_dir
         @ids = []
-        @auto_pipe = AutoPipe.new
         Channel.config(data_dir, pipe_dir, preserve_pipe_dir)
       end
 
-      def on_subnet(&block)
-        @auto_pipe.on_subnet &block
-      end
-
-      def next_pipe
-        @auto_pipe.next
-      end
-
-      def last_pipe
-        @auto_pipe.last
-      end
-
       def run
         Channel.setup
         run_pipeline
@@ -41,10 +30,21 @@ module DeadlySerious
         Channel.teardown
       end
 
+      # Wait all sub processes to finish before
+      # continue the pipeline.
+      #
+      # Always prefer to use {DeadlySerious::Engine::Commands#spawn_capacitor}
+      # if possible.
       def wait_processes!
         wait_children
       end
 
+      # Spawn a  class in a separated process.
+      #
+      # This is a basic command, use it only if you have
+      # more than one input or output pipe. Otherwise
+      # prefer the simplier {DeadlySerious::Engine::Commands#spawn_class}
+      # method.
       def spawn_process(a_class, *args, process_name: a_class.name, readers: [], writers: [])
         writers.each { |writer| create_pipe(writer) }
         fork_it do
@@ -61,6 +61,16 @@ module DeadlySerious
         end
       end
 
+      def spawn_command(a_shell_command)
+        command = a_shell_command.dup
+        a_shell_command.scan(/\(\((.*?)\)\)/) do |(pipe_name)|
+          pipe_path = create_pipe(pipe_name)
+          command.gsub!("((#{pipe_name}))", "'#{pipe_path.gsub("'", "\\'")}'")
+        end
+        @ids << spawn(command)
+      end
+
+      # @deprecated (Use [Spawner#spawn_process] with [Splitter] instead)
       def spawn_processes(a_class, *args, process_name: a_class.name, reader_pattern: nil, writers: [])
         number = last_number(reader_pattern)
 
@@ -76,10 +86,12 @@ module DeadlySerious
         end
       end
 
+      # @deprecated (Use [Spawner#spawn_process] instead)
       def spawn_source(a_class, *args, writer: a_class.dasherize(a_class.name))
         spawn_process(a_class, *args, process_name: process_name, readers: [], writers: [writer])
       end
 
+      # @deprecated (Use [Spawner#spawn_process] instead)
       def spawn_splitter(process_name: 'Splitter', reader: nil, writer: '>output01.txt', number: 2)
         start = last_number(writer)
         finish = start + number - 1
@@ -92,6 +104,7 @@ module DeadlySerious
                       writers: writers)
       end
 
+      # @deprecated (Use [Spawner#spawn_process] with [Splitter] instead)
       def spawn_socket_splitter(process_name: 'SocketSplitter', reader: nil, port: 11000, number: 2)
         spawn_splitter(process_name: process_name,
                        reader: reader,
@@ -99,15 +112,6 @@ module DeadlySerious
                        number: number)
       end
 
-      def spawn_command(a_shell_command)
-        command = a_shell_command.dup
-        a_shell_command.scan(/\(\((.*?)\)\)/) do |(pipe_name)|
-          pipe_path = create_pipe(pipe_name)
-          command.gsub!("((#{pipe_name}))", "'#{pipe_path.gsub("'", "\\'")}'")
-        end
-        @ids << spawn(command)
-      end
-
       private
 
       def append_open_io_if_needed(a_class)
@@ -118,8 +122,6 @@ module DeadlySerious
         Channel.create_pipe(pipe_name)
       end
 
-      # @!group Process Control
-
       def fork_it
         @ids << fork { yield }
       end
@@ -138,13 +140,11 @@ module DeadlySerious
         $0 = "ruby #{self.class.dasherize(name)} <(#{readers.join(' ')}) >(#{writers.join(' ')})"
       end
 
-      # @!endgroup
-      # @!group Minor Helpers
-
       def self.dasherize(a_string)
         a_string.gsub(/(.)([A-Z])/, '\1-\2').downcase.gsub(/\W+/, '-')
       end
 
+      # @deprecated
       def last_number_pattern(a_string)
         last_number_pattern = /(\d+)[^\d]*$/.match(a_string)
         raise %(Writer name "#{writer}" should have a number) if last_number_pattern.nil?
@@ -152,10 +152,12 @@ module DeadlySerious
         last_number_pattern[1]
       end
 
+      # @deprecated
       def last_number(a_string)
         last_number_pattern(a_string).to_i
       end
 
+      # @deprecated
       def pattern_replace(a_string, number)
         pattern = last_number_pattern(a_string)
         pattern_length = pattern.size
@@ -166,8 +168,4 @@ module DeadlySerious
       end
     end
   end
-end
-
-if __FILE__ == $0
-  DeadlySerious::Engine::Spawner.new.run
-end
+end

data/lib/deadly_serious/version.rb

@@ -1,3 +1,3 @@
 module DeadlySerious
-  VERSION = "0.10.0"
+  VERSION = '0.11.0'
 end

data/lib/deadly_serious.rb

@@ -1,4 +1,5 @@
 require 'deadly_serious/version'
+require 'deadly_serious/engine/commands'
 require 'deadly_serious/engine/spawner'
 require 'deadly_serious/engine/base_process'
 require 'deadly_serious/engine/push_pop'

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: deadly_serious
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Ronie Uliana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Flow Based Programming Engine mechanically sympathetic to *nix.
@@ -59,7 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,6 +71,7 @@ files:
 - lib/deadly_serious/engine/auto_pipe.rb
 - lib/deadly_serious/engine/base_process.rb
 - lib/deadly_serious/engine/channel.rb
+- lib/deadly_serious/engine/commands.rb
 - lib/deadly_serious/engine/json_io.rb
 - lib/deadly_serious/engine/json_process.rb
 - lib/deadly_serious/engine/lazy_io.rb
@@ -93,17 +96,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Flow Based Programming engine that relies on named pipes and Linux processes