vuf 0.0.1 → 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bernard Rodier
+
+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

@@ -2,6 +2,8 @@
 
 TODO: Write a gem description
 
+[![Gem Version](https://badge.fury.io/rb/vuf.png)](http://badge.fury.io/rb/vuf)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/vuf'
+  t.test_files = FileList['test/lib/vuf/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test
+

data/lib/vuf/batch.rb

@@ -0,0 +1,34 @@
+module Vuf
+  class Batch
+    def initialize(size,&batch)
+      @mutex = Mutex.new
+      @batchQ = SizedQueue.new(size)
+      @batch = batch
+    end
+    
+    def push(obj)
+      @batchQ.push(obj)
+      objsToProc = get_objs(@batchQ.max)
+      @batch.call(objsToProc) unless objsToProc.nil?
+    end
+    
+    def flush
+      objsToProc = get_objs(0)
+      @batch.call(objsToProc)
+    end
+    
+    private
+    def get_objs(size_condition)
+      objToProc = nil
+      @mutex.synchronize do
+        if size_condition <= @batchQ.size
+          objToProc = []
+          objToProc <<  @batchQ.pop until @batchQ.empty?
+          @batchQ.clear
+        end
+      end     
+      return objToProc
+    end
+
+  end
+end

data/lib/vuf/logger.rb

@@ -0,0 +1,5 @@
+module Vuf
+  Logger = Log4r::Logger.new self.name
+  Logger.outputters = Log4r::Outputter.stderr
+  Logger.level=Log4r::INFO
+end

data/lib/vuf/pool.rb

@@ -0,0 +1,91 @@
+module Vuf
+  module Pool
+    # Raises a TypeError to prevent cloning.
+    def clone
+      raise TypeError, "can't clone instance of Pool #{self.class}"
+    end
+
+    # Raises a TypeError to prevent duping.
+    def dup
+      raise TypeError, "can't dup instance of Pool #{self.class}"
+    end
+
+    # By default, do not retain any state when marshalling.
+    def _dump(depth = -1)
+      ''
+    end
+
+    module PoolClassMethods # :nodoc:
+
+      def clone # :nodoc:
+        Pool.__init__(super)
+      end
+
+      # By default calls instance(). Override to retain singleton state.
+      def _load(str)
+        raise TypeError, "can't _load Pool #{self.class}"
+      end
+
+      private
+
+      def inherited(sub_klass)
+        super
+        Pool.__init__(sub_klass)
+      end
+    end
+
+    class << Pool # :nodoc:
+      def __init__(klass) # :nodoc:
+        klass.instance_eval {
+          @pool__instances__ = Queue.new
+          @used__instances__ = Hash.new
+          @pool__mutex__ = Mutex.new
+        }
+        
+        def klass.instance # :nodoc:
+          instance__ = nil
+          @pool__mutex__.synchronize do
+            instance__ = @used__instances__[Thread.current]
+            if instance__.nil? && @pool__instances__.size > 0
+              instance__ = @pool__instances__.pop 
+            end
+            instance__ = new() if instance__.nil?
+            @used__instances__[Thread.current] = instance__
+          end
+          instance__
+        end
+
+        def klass.release # :nodoc:
+          instance__ = nil
+          @pool__mutex__.synchronize do
+            instance__ = @used__instances__.delete(Thread.current)
+            @pool__instances__.push(instance__) unless instance__.nil?
+          end
+          !instance__.nil?
+        end
+        
+        klass
+      end
+
+      private
+
+      # extending an object with Pool is a bad idea
+      undef_method :extend_object
+
+      def append_features(mod)
+        #  help out people counting on transitive mixins
+        unless mod.instance_of?(Class)
+          raise TypeError, "Inclusion of the OO-Singleton module in module #{mod}"
+        end
+        super
+      end
+
+      def included(klass)
+        super
+        klass.private_class_method :new, :allocate
+        klass.extend PoolClassMethods
+        Pool.__init__(klass)
+      end
+    end
+  end
+end

data/lib/vuf/version.rb

@@ -0,0 +1,3 @@
+module Vuf
+  VERSION = "0.0.2"
+end

data/lib/vuf/working_pool.rb

@@ -0,0 +1,81 @@
+module Vuf
+  class WorkingPool
+    ENDING_TASK="ENDING_TASK"
+    
+    def initialize(nb_workers, max_pending_tasks=nil)
+      @nb_workers = nb_workers
+      if max_pending_tasks.nil?
+        @wq = Queue.new
+      else
+	      @wq = SizedQueue.new(max_pending_tasks)
+      end
+      @channels_mutex = Mutex.new
+      @channels = {}
+      @channelsQ = Array.new(@nb_workers){ Queue.new }
+    end
+
+    def run
+      if @workers.nil?
+        @workers=[]
+        @nb_workers.times do 
+	        @workers << Thread.new do
+	          works
+	        end
+        end
+	    end
+    end
+
+    def do(channel=nil,&task)
+      @wq.push([channel,task])
+    end
+
+    def finalize
+      return if @workers.nil?
+      @nb_workers.times do 
+        @wq.push(ENDING_TASK)
+      end
+      @workers.each do |worker|
+        worker.join
+      end
+    end
+    
+    private
+    
+    def try_lock_channel(channel,task)
+      new_channel_q = nil
+      @channels_mutex.synchronize {
+        if @channels[channel].nil?
+	        new_channel_q = @channelsQ.shift
+          @channels[channel]=new_channel_q
+	      end
+      }
+      @channels[channel].push(task)
+      return new_channel_q
+    end
+    
+    def is_clear(channel)
+      is_clear=nil
+      @channels_mutex.synchronize{
+        is_clear = @channels[channel].empty?
+	      @channelsQ << @channels.delete(channel) if is_clear
+      }
+      return is_clear
+    end
+
+    def works
+      task=nil
+      until ENDING_TASK == (task= @wq.pop)
+        channel = task.first
+        task = task.last
+        channelQ = nil
+	channelQ = try_lock_channel(channel,task) unless channel.nil?
+        if channelQ.nil?
+	  task.call
+        else
+          channelQ.pop.call until is_clear(channel)
+	end
+      end
+    end
+  end
+end
+

data/lib/vuf.rb

@@ -0,0 +1,12 @@
+require "thread"
+require "log4r"
+
+require "vuf/version"
+require "vuf/logger"
+require "vuf/working_pool"
+require "vuf/pool"
+require "vuf/batch"
+
+module Vuf
+  # Your code goes here...
+end

data/test/lib/vuf/batch_test.rb

@@ -0,0 +1,26 @@
+require_relative '../../test_helper'
+
+describe Vuf::Batch do
+  subject { 
+    Vuf::Batch.new(50) do |objQ|
+      objQ.size.must_equal(50) unless objQ.empty?
+    end
+  }
+  
+  it "must respond to push" do
+    subject.must_respond_to(:push)
+    1000.times do |i|
+      subject.push(i)
+    end
+  end
+  
+  it "must respond to flush" do
+    subject.must_respond_to(:flush)
+    1000.times do |i|
+      subject.push(i)
+    end
+    subject.flush
+  end  
+  
+end
+

data/test/lib/vuf/pool_test.rb

@@ -0,0 +1,58 @@
+require_relative '../../test_helper'
+
+describe Vuf::Pool do
+  subject {  
+    class TestKlass
+      include Vuf::Pool
+      def initialize
+      end
+    end
+    TestKlass
+  }
+  
+  it "must not respond to new" do
+    subject.wont_respond_to(:new)
+  end
+  
+  it "must respond_to use_instance" do
+    subject.must_respond_to(:instance)
+  end
+  
+  it "must respond_to release" do
+    subject.must_respond_to(:release)
+  end
+end
+
+describe Vuf::Pool do
+  class PoolKlass
+    include Vuf::Pool
+    attr_reader :i_index
+    def initialize
+      @@index ||= 0
+      @@index += 1
+      @i_index = @@index
+      @f = File.open(File.join("test", "tmp", "file_#{@@index}.txt"),"w+")
+    end
+    
+    def write(msg)
+      @f.write(msg)
+    end
+  end
+    
+
+  subject { 5 }
+  
+  it "must create 5 Files" do
+    wp = Vuf::WorkingPool.new(subject)
+    wp.run
+    1000.times do |i|
+      wp.do do 
+        poolklass_instance = PoolKlass.instance
+        poolklass_instance.write("Message #{i.to_s}\n")
+        PoolKlass.release
+      end
+    end
+    wp.finalize
+    Dir[File.join("test", "tmp","file_*.txt")].size.must_equal(subject)
+  end
+end

data/test/lib/vuf/wp_test.rb

@@ -0,0 +1,30 @@
+require_relative '../../test_helper'
+
+describe Vuf::WorkingPool do
+  subject {  Vuf::WorkingPool.new(5) }
+  
+  it "must be a WorkingPool" do
+    subject.must_be_instance_of(Vuf::WorkingPool)
+  end
+  
+  it "must respond_to run" do
+    subject.must_respond_to(:run)
+  end
+
+  it "must respond_to do" do
+    subject.must_respond_to(:do)
+  end
+  
+  it "must respond_to finalize" do
+    subject.must_respond_to(:finalize)
+  end
+
+  it "must handle without error" do
+    subject.run
+    5.times do |i|
+      subject.do { sleep(1/10) }
+    end
+    subject.finalize
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/vuf.rb', __FILE__)

data/test/tmp/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

data/vuf.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vuf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vuf"
+  spec.version       = Vuf::VERSION
+  spec.authors       = ["Bernard Rodier"]
+  spec.email         = ["bernard.rodier@gmail.com"]
+  spec.description   = %q{My Very Usefull Patterns}
+  spec.summary       = %q{This gem provide usefulle patterns like workingpool,
+  batch executor, object instance recyclor, etc..}
+  spec.homepage      = "https://github.com/brodier/vuf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: vuf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Bernard Rodier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,15 +30,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: My Very Usefull Patterns
@@ -45,30 +50,52 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
 - README.md
+- Rakefile
+- lib/vuf.rb
+- lib/vuf/batch.rb
+- lib/vuf/logger.rb
+- lib/vuf/pool.rb
+- lib/vuf/version.rb
+- lib/vuf/working_pool.rb
+- test/lib/vuf/batch_test.rb
+- test/lib/vuf/pool_test.rb
+- test/lib/vuf/wp_test.rb
+- test/test_helper.rb
+- test/tmp/.gitignore
+- vuf.gemspec
 homepage: https://github.com/brodier/vuf
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: This gem provide usefulle patterns like workingpool, batch executor, object
   instance recyclor, etc..
-test_files: []
+test_files:
+- test/lib/vuf/batch_test.rb
+- test/lib/vuf/pool_test.rb
+- test/lib/vuf/wp_test.rb
+- test/test_helper.rb
+- test/tmp/.gitignore

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 4089f9d841dfb7c01a2317d994730b8d76d73ebb
-  data.tar.gz: 5f76bb26084789cdf11930739570ed05fd39858d
-SHA512:
-  metadata.gz: 4671e8622031c303263a6fade5a7c04978aecf0a8eb1340cffb66c2efaa2ad0cfba2376b2e56e10ae2ffeeefa10258c8ff531bc0f74978bad4e37a404bb8d1da
-  data.tar.gz: 259136799b9a50f564682c5fdfd27eaf5e4f7082c4dbb65ebef0b032d2118284de652f771df043d21c7c7886c47a2014e505524c17eaa9e0755104ee9bc4d542