ninja 0.1

data/.gitignore

@@ -0,0 +1,2 @@
+dist
+doc

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2008-2009 Nicolas Sanguinetti
+
+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.rdoc

@@ -0,0 +1,31 @@
+= Ninja!
+
+He runs in the background, without being seen
+
+== Install
+
+    gem install ninja
+
+== Use
+
+    require "ninja/threaded"
+
+    # Use a thread pool to run the background jobs
+    Ninja.hide_in(Ninja::Threaded.new(4))
+
+    class FooBar
+      include Ninja
+
+      def my_method
+        # some code
+        in_background do
+          # this code will run in background
+        end
+        # mode code
+      end
+    end
+
+== Credits
+
+Author:: Nicolás Sanguinetti
+License:: MIT (see LICENSE file)

data/Rakefile

@@ -0,0 +1,25 @@
+require "rake/testtask"
+
+begin
+  require "hanna/rdoctask"
+rescue LoadError
+  require "rake/rdoctask"
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.title = "API Documentation for Ninja!"
+  rd.rdoc_files.include("README.rdoc", "LICENSE", "lib/**/*.rb")
+  rd.rdoc_dir = "doc"
+end
+
+begin
+  require "mg"
+  MG.new("ninja.gemspec")
+rescue LoadError
+end
+
+desc "Default: run tests"
+task :default => :test
+
+Rake::TestTask.new

data/lib/ninja.rb

@@ -0,0 +1,12 @@
+module Ninja
+  class << self
+    attr_accessor :hide_in
+  end
+
+  PlainSight = lambda {|b| b.call }
+  self.hide_in = PlainSight
+
+  def in_background(&block)
+    Ninja.hide_in.call(block)
+  end
+end

data/lib/ninja/threaded.rb

@@ -0,0 +1,131 @@
+require File.expand_path(File.dirname(__FILE__) + "/../ninja")
+require "thread"
+
+module Ninja
+  # A thread pool based build engine. This engine simply adds jobs to an
+  # in-memory queue, and processes them as soon as possible.
+  class Threaded
+    # The optional pool size controls how many threads will be created.
+    def initialize(pool_size = 2)
+      @pool = ThreadPool.new(pool_size)
+    end
+
+    # Adds a job to the queue.
+    def call(job)
+      @pool << job
+    end
+
+    # The number of jobs currently in the queue.
+    def njobs
+      @pool.njobs
+    end
+
+    # This method will not return until #njobs returns 0.
+    def wait!
+      Thread.pass until @pool.njobs == 0
+    end
+
+    # Manage a pool of threads, allowing for spin up / spin down of the 
+    # contained threads.
+    # Simply processes work added to it's queue via #push.
+    # The default size for the pool is 2 threads.
+    class ThreadPool
+
+      # A thread safe single value for use as a counter.
+      class Incrementor
+        # The value passed in will be the initial value.
+        def initialize(v = 0)
+          @m = Mutex.new
+          @v = v
+        end
+        # Add the given value to self, default 1.
+        def inc(v = 1)
+          sync { @v += v }
+        end
+        # Subtract the given value to self, default 1.
+        def dec(v = 1)
+          sync { @v -= v }
+        end
+        # Simply shows the value inspect for convenience.
+        def inspect
+          @v.inspect
+        end
+        # Extract the value.
+        def to_i
+          @v
+        end
+
+        private
+        # Wrap the given block in a mutex.
+        def sync(&b)
+          @m.synchronize &b
+        end
+      end
+
+      # The number of threads in the pool.
+      attr_reader :size
+      # The job queue.
+      attr_reader :jobs
+
+      # Set the size of the thread pool. Asynchronously run down threads
+      # that are no longer required, and synchronously spawn new required
+      # threads.
+      def size=(other)
+        @size = other
+
+        if @workers.size > @size
+          (@workers.size - @size).times do
+            @workers.shift[:run] = false
+          end
+        else
+          (@size - @workers.size).times do
+            @workers << spawn
+          end
+        end
+      end
+
+      # Default pool size is 2 threads.
+      def initialize(size = nil)
+        size ||= 2
+        @jobs    = Queue.new
+        @njobs   = Incrementor.new
+        @workers = Array.new(size) { spawn }
+      end
+
+      # Adds a job to the queue, the job can be any number of objects
+      # responding to call, and/or a block.
+      def add(*jobs, &blk)
+        jobs = jobs + Array(blk)
+
+        jobs.each do |job|
+          @jobs << job
+          @njobs.inc
+        end
+      end
+
+      alias_method :push, :add
+      alias_method :<<,   :add
+
+      # A peak at the number of jobs in the queue. N.B. May differ, but 
+      # should be more accurate than +jobs.size+.
+      def njobs
+        @njobs.to_i
+      end
+
+      private
+      # Create a new thread and return it. The thread will run until the 
+      # thread-local value +:run+ is changed to false or nil.
+      def spawn
+        Thread.new do
+          c = Thread.current
+          c[:run] = true
+
+          while c[:run]
+            @jobs.pop.call
+            @njobs.dec
+          end
+        end
+      end
+    end
+  end
+end

data/ninja.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name    = "ninja"
+  s.version = "0.1"
+  s.date    = "2009-08-07"
+
+  s.description = "Run background tasks easily"
+  s.summary     = "Provide several ways to offload tasks to the background"
+  s.homepage    = "http://github.com/foca/ninja"
+
+  s.authors = ["Nicolás Sanguinetti"]
+  s.email   = "contacto@nicolassanguinetti.info"
+
+  s.require_paths     = ["lib"]
+  s.rubyforge_project = "integrity"
+  s.has_rdoc          = true
+  s.rubygems_version  = "1.3.1"
+
+  if s.respond_to?(:add_development_dependency)
+    s.add_development_dependency "sr-mg"
+    s.add_development_dependency "contest"
+    s.add_development_dependency "redgreen"
+  end
+
+  s.files = %w[
+.gitignore
+LICENSE
+README.rdoc
+Rakefile
+ninja.gemspec
+lib/ninja.rb
+lib/ninja/threaded.rb
+]
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: ninja
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- "Nicol\xC3\xA1s Sanguinetti"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-07 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sr-mg
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: contest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Run background tasks easily
+email: contacto@nicolassanguinetti.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- ninja.gemspec
+- lib/ninja.rb
+- lib/ninja/threaded.rb
+has_rdoc: true
+homepage: http://github.com/foca/ninja
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: integrity
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Provide several ways to offload tasks to the background
+test_files: []
+