opm 1.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-07-26
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/opm.rb
+lib/opm/version.rb
+setup.rb

data/README.txt

@@ -0,0 +1,3 @@
+README for opm
+==============
+

data/Rakefile

@@ -0,0 +1,123 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'opm', 'version')
+
+AUTHOR = 'Papp Laszlo'  # can also be an array of Authors
+EMAIL = "pappl@inf.elte.hu"
+DESCRIPTION = "OPM support for Ruby"
+GEM_NAME = 'opm' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'opm' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "opm"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Opm::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'opm documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+

data/lib/opm.rb

@@ -0,0 +1,379 @@
+#
+# Copyright (c) 2007 Papp Laszlo (pappl@inf.elte.hu)
+# 
+# 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.
+require 'opm/version'
+require 'thread'
+require 'drb'
+
+module Opm
+
+# A Temporary Object, if the process is working while we want reach the instance variable,
+# it attaches the running process, and variable name for in the future we can get the value.
+class TemporaryProcessObject
+
+	# The process, which working on the object
+	attr_reader :process
+
+	# Name of the object
+	attr_reader :variable
+
+	def initialize( process, var )
+		@process = process
+		@variable = var
+	end
+end
+
+module OpmException
+	
+	class ProcessException < Exception
+		attr_reader :process
+
+		def initialize(process)
+			@process = process
+		end
+	
+	end
+
+	class NoInput < ProcessException
+	end
+
+	class BeforeFilterFailed < ProcessException
+	end
+
+	class AfterFilterFailed < ProcessException
+	end
+
+end
+
+# For OPM States.. It contains only states, and only one active
+# 
+#  class LoggedIn < OpmStatus
+#    states :logged, :logout
+#  end
+#
+#  stat = LoggedIn.status :logged
+#  stat.status #:logged
+#  
+#  stat.logout
+#  stat.status #:logout
+#
+class OpmStatus
+	class << self
+		#attr_accessor :statuses
+	end
+	
+protected
+	def self.states(*args)
+			@statuses ||= []
+			@statuses += args
+	end
+
+public
+
+  # For generate a status object
+  # @param status: The initializer status
+	def self.status( status )
+		object = new(status)
+		@statuses.each do |stat|
+			class_eval %(class << object
+				def #{stat}
+					@status = :#{stat}
+				end
+				end
+			)
+		end
+		return object
+	end
+
+private
+
+	def self.inherited(subclass)
+		begin
+			self.statuses.each do |stat|
+				subclass.states(stat)
+			end
+		rescue
+		end
+	end
+
+protected
+	def initialize(status)
+		@status = status
+	end
+
+public
+  # The current status. Returns symbol!
+	def status
+		return @status
+	end
+
+  # The same as status method.
+	def to_s
+		return @status
+	end
+end
+
+# Main process class
+#
+#   class Sum < OpmProcess
+#     input :input1, :input2
+#     output :output1
+#
+#     def run
+#       @output1 = @input1 + @input2
+#     end
+#   end
+#
+#   proc = Sum.process :input1 => 1, :input2 => 12
+#   proc.wait
+#   puts proc.output1 # 13
+class OpmProcess
+	
+	class << self
+		#attr_accessor :input_arguments
+		#attr_accessor :output_arguments
+		#attr_accessor :remote
+	end
+
+public
+	
+	# Define input variables. In the process if you use
+	#
+	# include :foo, :bar
+	#
+	# then you can use them as @foo, @bar
+	#
+	def self.input(*args)
+    @input_arguments ||= []
+    @input_arguments += args
+    args.each do |arg|
+      instance_variable_set("@#{arg}", nil)
+    end
+	end
+
+  # Outputs of the process
+  # 
+  #   class SampleProcess < OpmProcess
+  #     input :input
+  #     output :foo
+  #     ...
+  #   end
+  #
+  #   bar = SampleProcess.process :input => "something"
+  #   puts bar.foo
+  #  
+  def self.output(*args)
+    @output_arguments ||= []
+    @output_arguments += args
+    args.each do |arg|
+      instance_variable_set("@#{arg}", nil)
+      class_eval %(class << self; attr_reader :#{arg} end)
+    end
+  end
+
+	def self.remote(args) #:nodoc:
+		@remote = args
+	end
+	
+  # Start the process
+  # @args => Parameters for input variables
+  #
+  def self.process(args={})
+    
+		if @remote != nil
+			#It's not okay yet
+			object = DRb::DRbObject.new object, "druby://#{@remote[:host]}:#{@remote[:port]}" 
+		else
+			object = new
+		end
+    
+		@input_arguments.each do |arg|
+#			throw OpmException::NoInput.new(object) unless args.has_key? arg
+			if args[arg].class == TemporaryProcessObject
+				object.underProcessing = [arg, args[arg]]
+				next
+			end
+			object.instance_variable_set("@#{arg}", args[arg])
+    end
+    
+    @output_arguments.each do |arg|
+      object.instance_variable_set("@#{arg}", args[arg])
+      object.outputsForWait = arg
+			class_eval %( class << object; def #{arg}
+            return @#{arg} unless running?
+ 						return TemporaryProcessObject.new(self, "#{arg}")
+					end 
+        end
+				)
+    end
+		object.start_process
+		return object
+	end
+  
+  
+  # Inherits from base class the input arguments
+  #
+private
+  def self.inherited(subclass)
+    begin
+			self.input_arguments.each do |arg|
+				subclass.input(arg)
+			end
+    
+			self.output_arguments.each do |arg|
+				subclass.output(arg)
+			end
+		rescue
+      # This branch is running when @input_arguments == nil
+    end
+  end
+  
+protected
+  def initialize
+		@underProcessing = []
+		@outputsForWait = []
+
+		@thread = Thread.new do 
+			Thread.stop
+			@underProcessing.each do |p|
+				while p[1].process.running?
+				end
+				instance_variable_set("@#{p[0]}", p[1].process.instance_eval("@#{p[1].variable}")) 
+			end
+		
+			begin
+				
+				if not before
+					@error = OpmException::BeforeFilterFailed.new(self)
+					raise @error
+				end
+			
+				# Run the body of the process
+				run
+
+				if not after
+					@error = OpmException::AfterFilterFailed.new(self)
+					raise @error
+				end
+
+				# Wait for the outputs become active
+				wait_output_done
+			rescue OpmException::BeforeFilterFailed => before
+				onBeforeError
+				Thread.exit
+			rescue OpmException::AfterFilterFailed => after
+				onAfterError
+				Thread.exit
+			end
+		end
+  end
+
+public  
+  # Before filter for process. It's a logical function. If the function returns fault,
+  # the process calls the onBeforeError, where we can set the parameters. For more
+  # information about the cause of the error, use @error variable in onBeforeError.
+  #
+	def before
+		true
+	end
+
+  # Similar to before, but this is checking the result of the process
+  #
+	def after
+		true
+	end
+
+  # Callback function. It will signaled if before is false
+	#
+	def onBeforeError
+	end
+
+  # Look: onBeforeError.
+	#
+	def onAfterError
+	end
+
+  # Secure only one process be running in a block.
+  #
+  def onlyOne(args, &block)
+      @@Mutex ||= Hash.new
+      @@Mutex[args] = Mutex.new if @@Mutex[args] == nil
+      @@Mutex[args].synchronize do
+        yield
+      end
+  end
+
+	def underProcessing=( val ) #:nodoc:
+		@underProcessing << val
+	end
+	
+
+	# For set the output attributes, for wait_output_done
+	def outputsForWait=( val ) #:nodoc:
+		@outputsForWait << val
+	end
+  
+  def start_process #:nodoc:
+    @thread.run
+  end
+
+private
+	# If a process contains another one, then the main process have to wait
+	# the inner process, because the output will be incosistent
+	#
+	def wait_output_done
+		# For all output arguments
+		@outputsForWait.each do |val|
+			# Get the value
+			output = instance_variable_get("@#{val}")
+			
+			# We use exception handler, if output is not TemporaryProcessObject
+			begin
+				# While not active the object
+				#while output.process.running?
+				#end
+				output.process.wait
+
+				# Get the new value of the output
+				var = eval("output.process.#{val}")
+
+				# Set the instance variable
+				instance_variable_set("@#{val}", var)
+			rescue
+				# if output.process not defined, because output is not a TemporaryProcessObject
+			end
+		end
+	end
+
+public
+
+	# Check thread is running
+  def running?
+    return @thread.alive?
+  end
+  
+  def wait
+    @thread.join
+  end
+
+end
+end
+
+