work_queue 0.1.1 → 0.1.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Miguel Fonseca
+Copyright (c) 2009-2010 Miguel Fonseca
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -24,4 +24,13 @@ Run the code:
   require 'work_queue'
   wq = WorkQueue.new
   wq.enqueue_b { puts "Hello from the WorkQueue" }
-  wq.join
+  wq.join
+
+Note that you generally want to bound the resources used:
+
+  # Limit the maximum number of simultaneous worker threads
+  WorkQueue.new(10)
+  # Limit the maximum number of queued tasks
+  WorkQueue.new(nil,20)
+  # Limit the maximum time to preserve idle worker threads
+  WorkQueue.new(nil,nil,10)

data/lib/work_queue.rb

@@ -6,13 +6,13 @@
 # This file contains an implementation of a work queue structure.
 #
 # == Version
-# 0.1.1
+# 0.1.2
 #
 # == Author
 # Miguel Fonseca <fmmfonseca@gmail.com>
 #
 # == Copyright
-# Copyright 2009 Miguel Fonseca
+# Copyright 2009-2010 Miguel Fonseca
 #
 # == License
 # MIT (see LICENSE file)
@@ -34,7 +34,7 @@ require 'timeout'
 #
 class WorkQueue
 	
-	VERSION = "0.1.1"
+	VERSION = "0.1.2"
 	
 	##
 	# Creates a new work queue with the desired parameters.
@@ -154,7 +154,7 @@ class WorkQueue
 	#
 	def join
 		cur_threads.times { dismiss_thread }
-		@threads.dup.each { |t| t.join }
+		@threads.dup.each { |thread| thread.join }
 		self
 	end
 	
@@ -166,7 +166,7 @@ class WorkQueue
 	#  wq.stop
 	#
 	def stop
-		@threads.dup.each { |t| t.exit.join }
+		@threads.dup.each { |thread| thread.exit.join }
 		@tasks.clear
 		self
 	end

data/tasks/ftp.rake

@@ -0,0 +1,177 @@
+require 'net/ftp'
+require 'pathname'
+require 'yaml'
+require 'rubygems'
+require 'rake'
+require 'rake/tasklib'
+
+module Rake
+	
+	# = FTPTask
+	#
+	# == Description
+	# A Rake task that transfers local files to an FTP server.
+	#
+	# == Usage
+	#  Rake::FTPTask.new do |t|
+	#   t.host = "ftp.example.com"
+	#   t.user_name = "user"
+	#   t.password = "pass"
+	#   t.path = "public_html/"
+	#   t.upload_files = FileList["doc/**/*"].to_a
+	#  end
+	#
+	# To avoid hard-coding the connection configuration into the source code, the task can obtain that data from a YAML file.
+	#
+	#  Rake::FTPTask.new("ftp.yml") do |t|
+	#   t.path = "public_html/"
+	#   t.upload_files = FileList["doc/**/*"].to_a
+	#  end
+	#
+	#  # ftp.yml
+	#  host = ftp.example.com
+	#  user_name = user
+	#  password = pass
+	#  path = public_html/ 
+	#
+	class FTPTask < TaskLib
+		
+		##
+		# The address of the server (default is nil).
+		#
+		attr_accessor :host
+		
+		##
+		# The user name required to log into the server (default is "anonymous").
+		#
+		attr_accessor :user_name
+		
+		##
+		# The password required for the selected user name (default is nil).
+		#
+		attr_accessor :password
+		
+		##
+		# The (remote) base directory (default is "").
+		#
+		attr_accessor :path
+		
+		##
+		# The array of files to be included in the FTP upload (default is []).
+		#
+		attr_accessor :upload_files
+		
+		##
+		# The boolean to enable progress messages when true (default is false).
+		#
+		attr_accessor :verbose
+		
+		##
+		# Creates a new FTP task.
+		#
+		def initialize(config_file=nil)
+			@host = nil
+			@user_name = "anonymous"
+			@password = nil
+			@path = ""
+			@upload_files = []
+			@verbose = false
+			@ftp = nil
+			@history = {}
+			load_config(config_file) unless config_file.nil?
+			yield self if block_given?
+			define
+		end
+		
+		##
+		# Creates the tasks defined by this task lib.
+		#
+		def define
+			desc "Upload files to an FTP account"
+			task(:upload) do
+				connect
+				upload
+				disconnect
+			end
+		end
+		
+		private
+		
+		##
+		# Reads configuration values from a YAML file.
+		#
+		def load_config(file)
+			config = YAML::load_file(file)
+			@host = config["host"] || @host
+			@user_name = config["user_name"] || @user_name
+			@password = config["password"] || @password
+			@path = config["path"] || @path
+		end
+		
+		##
+		# Establishes the FTP connection.
+		#
+		def connect
+			@ftp = Net::FTP.new(@host, @user_name, @password)
+			puts "Connected to #{@host}" if @verbose
+			puts "Using #{@ftp.binary ? "binary" : "text"} mode to transfer files" if @verbose
+			unless @path.nil? or @path.empty?
+				make_dirs(@path)
+				@ftp.chdir(@path)
+				puts "The working directory is now #{@ftp.getdir}" if @verbose
+			end
+		end
+		
+		##
+		# Closes the FTP connection. Further remote operations are impossible. 
+		#
+		def disconnect
+			@ftp.close
+			puts "Disconnected" if @verbose
+		end
+		
+		##
+		# Iterates through the array of files.
+		#
+		def upload
+			puts "Uploading #{@upload_files.length} files..." if @verbose
+			@upload_files.each do |entry|
+				if File.directory?(entry)
+					make_dirs(entry)
+				else
+					put_file(entry)
+				end
+			end
+		end
+		
+		##
+		# Transfers a local file to the server, relative to the current working directory.
+		#
+		def put_file(name)
+			puts "Uploading file #{name}" if @verbose
+			path = File.dirname(name)
+			make_dirs(path)
+			@ftp.put(name,name)
+		end
+		
+		##
+		# Creates a directory and all its parent directories in the server, relative to the current working directory.
+		#
+		def make_dirs(name)
+			Pathname.new(name).descend do |dir|
+				if @history[dir].nil?
+					@history[dir] = true
+					puts "Creating directory #{dir}" if @verbose
+					@ftp.mkdir(dir) rescue nil
+				end
+			end
+		end
+		
+	end
+	
+end
+
+Rake::FTPTask.new("config/ftp.yml") do |ftp|
+	ftp.upload_files = FileList["doc/**/*"].to_a
+	ftp.verbose = true
+end

data/test/tc_work_queue.rb

@@ -9,7 +9,7 @@
 # Miguel Fonseca <fmmfonseca@gmail.com>
 #
 # == Copyright
-# Copyright 2009 Miguel Fonseca
+# Copyright 2009-2010 Miguel Fonseca
 #
 # == License
 # MIT (see LICENSE file)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: work_queue
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Miguel Fonseca
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 +00:00
+date: 2009-12-28 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -25,6 +25,7 @@ files:
 - LICENSE
 - Rakefile
 - README.rdoc
+- tasks/ftp.rake
 - tasks/gem.rake
 - tasks/rdoc.rake
 - tasks/test.rake