titan 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.2.0 (December 4, 2010)
+
+- Features
+
+  * Use pid files for each thread instead of one global .titan file
+  * !!! You've to call Titan::Thread#run in order to start the created thread
+
+- Bug fixes
+
+  * Synchronize threads when removing dead ones (Thanks to Tal Atlas)
+
 ## 0.1.1 (November 26, 2010)
 
 - Features

data/README.md

@@ -15,31 +15,32 @@ and require it
 
     require "titan"
 
-Creating a new daemon thread using Titan is pretty easy:
+Creating a new daemon thread using Titan is pretty easy. First, you've create a new Titan::Thread object and then call its #run method:
 
-    Titan::Thread.new do
+    thread = Titan::Thread.new do
       # here comes the programm
       sleep(15)
       puts "I'm awake!"
     end
+    thread.run
 
 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
+    end.run
 
-It's also possible to change the identifier after creation:
+It's also possible to change the identifier after creation and while the thread is running:
 
     thread = Titan::Thread.new do
       1+1
-    end
+    end.run
     thread.id = "my_new_thread"
 
 The identifier must be unique.
 
-Titan manages created threads and saves them in a special .titan file that can be found in your home folder.
+Titan manages created threads and saves them in pid files inside of a .titan\_threads directory that can be found in your home folder.
 
 You can easily list all available threads:
 

data/lib/titan/thread.rb

@@ -7,7 +7,7 @@ module Titan
   # that gets created automatically.
   #
   class Thread
-    TITAN_FILE = "#{File.expand_path('~')}/.titan"
+    TITAN_DIRECTORY = File.expand_path('.titan_threads', '~')
 
     attr_accessor :id, :pid
 
@@ -17,18 +17,11 @@ module Titan
     # 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)
-      Titan::Thread.add(self)
+      @id       = options[:id] || __id__
+      @pid      = -1
+      @programm = block
+      @@threads[@id] = self
+      self
     end
 
     #
@@ -48,6 +41,9 @@ module Titan
       false
     end
 
+    #
+    # Changes the id of the thread and starts synchronization
+    #
     def id=(id)
       @@threads.delete(@id)
       @id = id
@@ -55,14 +51,40 @@ module Titan
       Titan::Thread.save_threads
     end
 
-    class << self
-      def add(thread)
-        load_threads
-        @@threads[thread.id] = thread
-        save_threads
-        thread
+    #
+    # Returns the file where its pid gets saved
+    #
+    def pid_file
+      File.expand_path(@id.to_s + ".pid", Titan::Thread::TITAN_DIRECTORY)
+    end
+
+    #
+    # Opens the pid file and save its pid in it
+    #
+    def save
+      Titan::Thread.check_filesystem
+      File.open(pid_file, 'w') { |file| file.write(@pid) }
+      @@threads[@id] = self
+    end
+
+    #
+    # Executes the given programm
+    #
+    def run
+      @pid  = Process.fork do
+        # ignore interrupts
+        Signal.trap('HUP', 'IGNORE')
+        # execute the actual programm
+        @programm.call
+        # exit the forked process cleanly
+        Kernel.exit!
       end
+      Process.detach(@pid)
+      save
+      self
+    end
 
+    class << self
       #
       # Returns a thread that has the given id
       #
@@ -84,25 +106,46 @@ module Titan
       end
 
       #
-      # Loads threads from the TITAN_FILE
+      # Loads threads from pid files inside the TITAN_DIRECTORY
       #
       def load_threads
-        return unless File.exists?(TITAN_FILE)
-        @@threads = YAML::load(File.open(TITAN_FILE)) || {}
+        check_filesystem
+        pid_files.each{ |pid_file|
+          thread     = Titan::Thread.new(:id => File.basename(pid_file, ".pid"))
+          thread.pid = File.read(File.expand_path(pid_file, TITAN_DIRECTORY))
+          @@threads[thread.id] = thread
+        }
       end
 
       #
-      # Saves threads to the TITAN_FILE
+      # Saves threads to pid files inside the TITAN_DIRECTORY
       #
       def save_threads
-        File.open(TITAN_FILE, 'w') { |file| file.write(YAML::dump(@@threads)) }
+        pid_files.each { |pid_file| File.delete (File.expand_path(pid_file, TITAN_DIRECTORY)) }
+        @@threads.each_value{ |thread| thread.save }
       end
 
       #
       # Removes threads that are not living anymore
       #
       def remove_dead_threads
-        @@threads.each_value { |thread| @@threads.delete(thread.id) unless thread.alive? }
+        @@threads.delete_if { |thread_id,thread| !thread.alive? }
+        save_threads
+        @@threads
+      end
+
+      #
+      # Checks the file system for neccessary directories and permissions
+      #
+      def check_filesystem
+        Dir.mkdir(TITAN_DIRECTORY) unless File.directory?(TITAN_DIRECTORY)
+      end
+
+      #
+      # Returns a list of all pid files available in the TITAN_DIRECTORY
+      #
+      def pid_files
+        Dir.entries(TITAN_DIRECTORY) - [".", ".."]
       end
     end
   end

data/lib/titan/version.rb

@@ -1,3 +1,3 @@
 module Titan
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Stefan Sprenger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-26 00:00:00 +01:00
+date: 2010-12-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +26,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
         - 2
-        - 9
-        version: 1.2.9
+        - 0
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 description: Helps you creating and managing daemon threads with Ruby.