codegrinder 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc3ea67250438aecd1e7e009932be8c1c1f436fb
+  data.tar.gz: 02ac2c07c98258132216974f8e9f2de52de79b2c
+SHA512:
+  metadata.gz: 3440d4e4cf1bfcc379f7cd3c957110e394361ac967b0ebc8c51217169185dc99c003926434f958ad0d7162ece255f000da791a39972edcf0eada44d2d58a7678
+  data.tar.gz: dc03d0f32bc722a67f94f34249d591a2d14383eab9735af484aaa9ec507ea6f07f98efa337f13702fa6ef031c283d9a1c3f9323759798973b66f96c43464616b

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    parser (2.3.0.pre.2)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    rainbow (2.0.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry-byebug
+  rspec (~> 3.3)
+  rubocop

data/README.md

@@ -0,0 +1,71 @@
+# Will it grind ?
+
+Yes, and in parallel !
+
+codegrinder is a queue associated to one or several thread that share
+the same logic, and process the elements inserted into it.
+
+## How to install ?
+
+`gem install codegrinder`
+
+## How to use ?
+
+First, you have to require codegrinder:
+
+```ruby
+require 'codegrinder'
+```
+
+Next, you have to build your codegrinder:
+
+```ruby
+# That codegrinder print the square of any inserted value:
+my_grinder = CodeGrinder.new { |i| print(String(i ** 2) + "\n") }
+```
+
+At last, you can start it:
+
+```ruby
+# Starting the grinder with 4 threads. If no number is given, a single
+# thread is used.
+my_grinder.start(4)
+```
+
+From now on, any time you will insert a value in your grinder, it will be
+squared and printed to screen by one of your 4 threads.
+
+**Full example:**
+
+```ruby
+# Parallelized tiny pry-like implementation
+
+STDOUT.sync = true
+STDERR.sync = true
+
+require 'codegrinder'
+
+code_processor = CodeGrinder.new do |code|
+  begin
+    STDERR.write "  => #{eval(code).inspect}\n"
+  rescue StandardError => e
+    STDERR.write "  => #{e.class}: #{e.message}\n"
+  end
+end
+
+code_processor.start(4)
+
+QUIT = 'quit'
+
+def self.next_command
+  STDOUT.write("Enter command:\n")
+  result = gets
+  result.nil? ? QUIT : result.chomp
+end
+
+while (command = next_command) != QUIT
+  code_processor << command
+end
+```
+
+This small ruby shell can process up to 4 commands at the same time.

data/codegrinder.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'codegrinder/version'
+Gem::Specification.new do |s|
+  s.name = 'codegrinder'
+  s.version = CodeGrinder::Version::STRING
+  s.summary = 'Multithreaded processing queue'
+  s.description = 'Allow to easily create a queue whose elements are processed in parallel threads'
+  s.authors = ['Alexandre Ignjatovic']
+  s.email = 'alexandre.ignjatovic@gmail.com'
+  s.files = `git ls-files`.split($RS).reject do |file|
+    file =~ %r{^(?:
+    spec/.*
+    samples/.*
+    |.*\.swp
+    |Gemfile
+    |Rakefile
+    |\.rspec
+    |\.gitignore
+    |\.rubocop.yml
+    )$}x
+  end
+  s.require_paths = ['lib']
+  s.homepage = 'https://github.com/bankair/codegrinder'
+  s.license = 'MIT'
+end

data/lib/codegrinder.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+require 'codegrinder/version'
+require 'codegrinder/processor'
+
+module CodeGrinder
+  def self.new(&block)
+    Processor.new(&block)
+  end
+end

data/lib/codegrinder/processor.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require 'codegrinder/worker_thread_set'
+require 'thread'
+
+module CodeGrinder
+  ##
+  # A Processor object is the association of a queue, and one or several
+  # threads that pop what is inserted into the queue, and process it
+  # according to the block passed at initialization time.
+  #
+  # You want a queue processed by several threads ? CodeGrinder::Processor is
+  # the guy.
+  class Processor < Queue
+    protected
+
+    attr_accessor :block, :threads, :running
+
+    public
+
+    ##
+    # Initialize a new CodeGrinder::Processor.
+    # **Parameters:**
+    # * block: a proc applied to all elements inserted into the grinder.
+    def initialize(&block)
+      super()
+      self.block = block || fail(RuntimError, 'Missing block')
+      self.threads = WorkerThreadSet.null_object
+      self.running = false
+    end
+
+    def running?
+      running
+    end
+
+    DEFAULT_WORKER_COUNT = 1
+
+    ##
+    # Start the code grinder processor.
+    # **Parameters:**
+    # * ng_workers: the number of parallel threads to use for that grinder.
+    # **Return:** self.
+    def start(nb_workers = DEFAULT_WORKER_COUNT)
+      fail('Cannot start a running thread') if running?
+      self.threads = WorkerThreadSet.new(nb_workers) do
+        # using self as a end of job marker
+        # (inserted in the stop method)
+        while ((args = pop) != self)
+          block.call(*args)
+        end
+      end
+      self.running = true
+      self
+    end
+
+    ##
+    # Stop the code grinder processor.
+    # **Return:** self.
+    def stop
+      return self unless running?
+      # using self as a end of job marker
+      # (tested in the start method)
+      threads.count.times { self << self }
+      threads.join
+      self.threads = WorkerThreadSet.null_object
+      self.running = false
+      self
+    end
+  end
+end

data/lib/codegrinder/version.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module CodeGrinder
+  # This module holds the Lambdada version information.
+  module Version
+    STRING = '0.0.0'
+
+    module_function
+
+    def version(_debug = false)
+      STRING
+    end
+  end
+end

data/lib/codegrinder/worker_thread_set.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'thread'
+require 'set'
+
+##
+# A set of worker threads, whose behavior is the very same
+class WorkerThreadSet < Set
+  def initialize(count, &block)
+    fail(RuntimError, 'Missing block') if block.nil?
+    super()
+    count.times { self << Thread.new(&block) }
+  end
+
+  def join
+    each(&:join)
+  end
+
+  def self.null_object
+    NullWorkerThreadSet.instance
+  end
+
+  ##
+  # Null object. Used as inert value
+  class NullWorkerThreadSet
+    require 'singleton'
+    include Singleton
+    def join
+      # Silently do nothing. Like some that guy I met at work, once.
+    end
+  end
+end

data/samples/minipry.rb

@@ -0,0 +1,29 @@
+# Parallelized tiny pry-like implementation
+
+STDOUT.sync = true
+STDERR.sync = true
+
+require 'codegrinder'
+
+code_processor = CodeGrinder.new do |code|
+  begin
+    STDERR.write "  => #{eval(code).inspect}\n"
+  rescue StandardError => e
+    STDERR.write "  => #{e.class}: #{e.message}\n"
+  end
+end
+
+code_processor.start(4)
+
+QUIT = 'quit'
+
+def self.next_command
+  STDOUT.write("Enter command:\n")
+  result = gets
+  result.nil? ? QUIT : result.chomp
+end
+
+while (command = next_command) != QUIT
+  code_processor << command
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: codegrinder
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Alexandre Ignjatovic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-15 00:00:00.000000000 Z
+dependencies: []
+description: Allow to easily create a queue whose elements are processed in parallel
+  threads
+email: alexandre.ignjatovic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile.lock
+- README.md
+- codegrinder.gemspec
+- lib/codegrinder.rb
+- lib/codegrinder/processor.rb
+- lib/codegrinder/version.rb
+- lib/codegrinder/worker_thread_set.rb
+- samples/minipry.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bankair/codegrinder
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Multithreaded processing queue
+test_files: []
+has_rdoc: