object-threads 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "depq", ">= 0.4"
+#   gem "hash-utils", ">= 0.7.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 - 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+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,56 @@
+Object Threads
+==============
+
+**Object Threads** emulates Python threading API paradigm. Creating
+threads by giving some block to constructor is sometime slightly 
+unpractical way of running threads. This library allows encapsulating 
+threads to classes, so class can define itself as thread which can be 
+run by plain method call. 
+
+For example:
+
+    require "thread/object"
+
+    class Foo
+        include Thread::Object
+        
+        def run
+            sleep 10
+            puts "Something in thread."
+        end
+    end
+    
+    Foo::new.start!
+    sleep 5
+    
+    puts "Something in main."
+    
+Will print out `"Something in main."` and then `"Something in thread."`.
+
+Thread object module directly supports `#alive?` and `#shutdown!` 
+methods only for thread manipulation. For other operations with the 
+thread, call directly object's `#native_thread` property which contains 
+appropriate native [Ruby Thread][1] object. This setup is for avoiding 
+potential method name conflicts between module and user class.
+    
+    
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+
+Copyright
+---------
+
+Copyright © 2010-2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[1]: http://www.ruby-doc.org/core/classes/Thread.html
+[2]: http://github.com/martinkozak/qrpc/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "object-threads"
+  gem.homepage = "http://github.com/martinkozak/object-threads"
+  gem.license = "MIT"
+  gem.summary = 'Emulates Python threading API paradigm. Creating threads by giving some block to constructor is sometime slightly unpractical way of running threads. This library allows encapsulating threads to classes, so class can define itself as thread which can be run by plain method call.'
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "qrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/thread/object.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+# (c) 2010-2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "thread"
+
+##
+# Standard Ruby's +Thread+ class.
+#
+
+class Thread
+
+    ##
+    # Represents Python-style class interfacing thread.
+    #
+    
+    module Object
+
+        ##
+        # Holds Ruby native thread instance.
+        # @return [Thread] Ruby native thread object
+        #
+
+        attr_accessor :native_thread
+        @native_thread
+        
+        ##
+        # Runs the thread code.
+        # @abstract
+        # 
+        
+        def run
+            raise Exception::new("Method #run must be overriden. It should contain body of the thread.")
+        end
+
+        ##
+        # Starts the thread by calling the +#run+ method as in Python.
+        # It's non-blocking, of sure.
+        #
+        # Uncacthed rxceptions raised by thread are written out to 
+        # +STDERR+ by default. This feature can be turned of by the 
+        # +silent+ argument.
+        #
+        # @param [nil, :silent] silent indicates, it shouln't write 
+        #   exceptions out
+        # @return [Thread] native Ruby thread
+        # @see #run
+        #
+        
+        def start!(silent = nil)
+            @native_thread = Thread::new do
+                begin
+                    self.run()
+                rescue ::Exception => e
+                    if silent != :silent
+                        self.log "THREAD EXCEPTION! " << e.class.to_s << ": " << e.message
+                        e.backtrace.each { |i| self.log i }
+                    end
+                end
+            end
+            
+            return @native_thread
+        end
+
+        ##
+        # Shutdowns the thread.
+        #
+
+        def shutdown!
+            @native_thread.terminate()
+        end
+        
+        ##
+        # Indicates thread is alive.
+        # @param [Boolean] +true+ if it is, +false+ in otherwise
+        #
+        
+        def alive?
+            @native_thread.alive?
+        end
+        
+        ##
+        # Logs an message.
+        # By overriding this, you can change the format.
+        #
+        # @param [String] message message for writing out
+        #
+
+        def log(message)
+            STDERR.write "[" << Time.now.strftime("%Y-%m-%d %H:%M:%S") << "] " << self.class.name << ": " << message.to_s << "\n"
+        end    
+
+    end
+end

data/test.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$:.push("./lib")
+require "thread/object"
+
+class Foo
+    include Thread::Object
+    
+    def run
+        puts "XYZ"
+    end
+end
+
+puts Foo::new.start!
+sleep(10)

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: object-threads
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/thread/object.rb
+- test.rb
+has_rdoc: true
+homepage: http://github.com/martinkozak/object-threads
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1958335550909864169
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Emulates Python threading API paradigm. Creating threads by giving some block to constructor is sometime slightly unpractical way of running threads. This library allows encapsulating threads to classes, so class can define itself as thread which can be run by plain method call.
+test_files: []
+