titan 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (November 24, 2010)
+
+Initial version.

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Stefan Sprenger
+
+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,89 @@
+Titan
+======
+
+Titan helps you creating daemon threads, that can be accessed later on. On the one side it creates daemons that run in the background and don't stop if the current process exits. On the other
+side it manages created daemon threads and provides functionality for accessing them later on by a custom id.
+
+Usage
+======
+
+Creating a new daemon thread using Titan is pretty easy:
+
+    Titan::Thread.new do
+      # here comes the programm
+      sleep(15)
+      puts "I'm awake!"
+    end
+
+Furthermore you can pass an id to each created thread that can be used for identification in the future:
+
+    Titan::Thread.new(:id => "my_new_thread") do
+      sleep(15)
+      puts "I'm awake!"
+    end
+
+It's also possible to change the identifier after creation:
+
+    thread = Titan::Thread.new do
+      1+1
+    end
+    thread.id = "my_new_thread"
+
+The identifier must be unique.
+
+If you want to access the thread in the future, Titan::Manager is the tool of your choice:
+
+    thread = Titan::Thread.new(:id => "my_new_thread") do
+      sleep(15)
+      puts "I'm awake!"
+    end
+    Titan::Manager.add(thread)
+
+It manages threads and saves them in a special .titan file that can be found in your home folder.
+
+You can easily list all available threads:
+
+    Titan::Manager.all
+
+By using the manager you can find currently running threads using their identifier:
+
+    thread  = Titan::Manager.find("my_new_thread")
+
+A thread can be forced to exit:
+
+    thread.kill if thread.alive?
+
+If you want to remove threads from the manager, that aren't running any longer, you can do this by:
+
+    Titan::Manager.remove_dead_threads
+
+Furthermore, you can check if a single thread is alive:
+
+    thread = Titan::Manager.find("my_new_thread")
+    thread.alive? # returns true or false
+
+Requirements
+======
+
+* Linux or Mac OS X
+
+Bugs
+======
+
+Please report bugs at http://github.com/flippingbits/titan/issues.
+
+Note on Patches/Pull Requests
+======
+
+* Fork the project from http://github.com/flippingbits/titan.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+======
+
+Copyright (c) 2010 Stefan Sprenger. See LICENSE for details.

data/lib/titan.rb

@@ -0,0 +1,6 @@
+require "titan/version"
+
+module Titan
+  autoload :Manager,  "titan/manager"
+  autoload :Thread,   "titan/thread"
+end

data/lib/titan/manager.rb

@@ -0,0 +1,61 @@
+module Titan
+  #
+  # Titan::Manager provides access to created threads.
+  # It serializes and deserializes them using YAML.
+  #
+  class Manager
+    TITAN_FILE = "#{File.expand_path('~')}/.titan"
+
+    @@threads = {}
+
+    class << self
+      def add(thread)
+        load_threads
+        @@threads[thread.id] = thread
+        save_threads
+      end
+
+      #
+      # Returns a thread that has the given id
+      #
+      def find(id)
+        load_threads
+        @@threads[id]
+      end
+
+      def kill(id)
+        find(id).kill
+      end
+
+      #
+      # Returns all Titan-managed threads
+      #
+      def all_threads
+        load_threads
+        @@threads
+      end
+
+      #
+      # Loads threads from the TITAN_FILE
+      #
+      def load_threads
+        return unless File.exists?(TITAN_FILE)
+        @@threads = YAML::load(File.open(TITAN_FILE)) || {}
+      end
+
+      #
+      # Saves threads to the TITAN_FILE
+      #
+      def save_threads
+        File.open(TITAN_FILE, 'w') { |file| file.write(YAML::dump(@@threads)) }
+      end
+
+      #
+      # Removes threads that are not living anymore
+      #
+      def remove_dead_threads
+        @@threads.each_value { |thread| @@threads.delete(thread.id) unless thread.alive? }
+      end
+    end
+  end
+end

data/lib/titan/thread.rb

@@ -0,0 +1,45 @@
+module Titan
+  #
+  # Titan::Thread helps you creating daemon threads that are independent from your application.
+  # Each Titan::Thread is identified by an id that you can either pass on initialization or
+  # that gets created automatically.
+  #
+  class Thread
+    attr_accessor :id, :pid
+
+    #
+    # Creates a new daemonized thread
+    #
+    def initialize(options = {}, &block)
+      @id   = options[:id] || __id__
+      @pid  = Process.fork do
+        # ignore interrupts
+        Signal.trap('HUP', 'IGNORE')
+        # execute the actual programm
+        block.call
+        # exit the forked process cleanly
+        Kernel.exit!
+      end
+
+      Process.detach(@pid)
+      self
+    end
+
+    #
+    # Kills the daemonized thread
+    #
+    def kill
+      Process.kill('KILL', @pid)
+    end
+
+    #
+    # Returns whether the thread is alive or not
+    #
+    def alive?
+      Process.getpgid(@pid)
+      true
+    rescue Errno::ESRCH
+      false
+    end
+  end
+end

data/lib/titan/version.rb

@@ -0,0 +1,3 @@
+module Titan
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: titan
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stefan Sprenger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Helps you creating and managing daemon threads with Ruby.
+email: info@stefan-sprenger.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- lib/titan/manager.rb
+- lib/titan/thread.rb
+- lib/titan/version.rb
+- lib/titan.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+has_rdoc: true
+homepage: http://github.com/flippingbits/titan
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Helps you creating and managing daemon threads with Ruby.
+test_files: []
+