dryft 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dryft.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    dryft (0.0.1)
+      nokogiri
+      sqlite3-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    nokogiri (1.4.4)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dryft!
+  nokogiri
+  sqlite3-ruby

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Chris Berkhout (http://chrisberkhout.com)
+
+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.rdoc

@@ -0,0 +1,112 @@
+= DRYFT for WinAutomation
+
+== Description
+
+DRYFT (Don't Repeat Yourself Factoring Tool) lets you define procedures in
+WinAutomation[http://www.winautomation.com/] that can be included in multiple
+other places and easily maintained from their original definition locations
+without introducing consistency issues.
+
+== Installation
+
+1. Install Ruby 1.8.7 with 
+   {RubyInstaller for Windows}[http://rubyinstaller.org].
+2. Run <tt>gem install dryft</tt>.
+3. Complete any additional setup for the <tt>sqlite3-ruby</tt> gem.
+
+== Conventions for procedures
+
+A procedure is a WinAutomation job that follows DRYFT conventions, and can
+therefore have DRYFT manage its dependencies on other procedures.
+
+=== Creating a procedure
+
+To create a procedure, create a job with a name enclosed in angle brackets: e.g.
+<tt><your procedure name></tt>. Extra text may follow the closing bracket and
+will not be considered part of the procedure name, however, the opening bracket
+must be the first character of the job name.
+
+DRYFT ignores any jobs that do not follow the procedure naming convention. Only
+proper procedures can include other procedures.
+
+=== Defining the steps of a procedure
+
+Inside the job, start the procedure definition with a comment step starting:
+<tt><your procedure name></tt>. The procedure name must be at the start of the
+comment, but may be followed by other text. This is the opening tag.
+
+After that, add another comment step that has the procedure name with a 
+forward-slash following the opening angle bracket: 
+<tt></your procedure name></tt>. This is the closing tag.
+
+Any steps you place between the opening and closing tags will be considered part
+of the procedure definition and will be copied to wherever the procedure is used
+in other procedures. Any steps before the opening tag or after the closing tag
+will not be copyed.
+
+This means that you can use steps outside of the definition to help you make the
+procedure definition job run by itself. For example, you may have a large 
+procedure that dynamically sets up certain configuration variables before 
+calling a smaller procedure. In the job defining the smaller procedure you can
+hard-code the configuration variables before the opening tag so that that job can
+be run by itself.
+
+Similarly, steps after the closing tag can be used to provide feedback that is
+helpful when running the procedure definition job individually, but which
+shouldn't be included when the procedure is used within a larger one.
+
+=== Using a procedure in other procedures
+
+To use one procedure within another, copy the steps from the opening tag to the
+closing tag in the source procedure, and paste them into the destination 
+procedure wherever you want them to run.
+
+=== Updating a procedure automatically
+
+Now, if you make some changes to the procedure in its defining job, you can
+run DRYFT to automatically copy those changes across to wherever that procedure
+is used in others. Be aware that if you change the steps between a procedures
+opening and closing tags in a job that uses it (rather than defines it), DRYFT
+will overwrite those changes with the old steps from the original procedure
+definition job.
+
+A procedure can include multiple other procedures and they can be nested to any
+depth. DRYFT resovles dependencies so that any given procedure will only ever be
+updated after all of its dependencies have been updated. It will detect improper
+use of opening and closing tags and generate appropriate error messages. For
+example, it will report unbalanced tags, use of undefined procedures and 
+circular dependencies.
+
+When using the WinAutomation console, it is necessary to press F5 to refresh
+the job list after DRYFT performs updates. This is because updated jobs are 
+assigned new IDs as a way of forcing the WinAutomation to disregard its old copy
+of the job code.
+
+=== In conclusion
+
+Go ahead and define procedures as you please, maintain them from their original
+definition jobs and run DRYFT (and refresh with F5) often to ensure your jobs 
+database is consistent.
+
+== Usage
+
+To run load and update the default WinAutomation jobs database:
+  dryft
+
+To load and update a WinAutomation jobs database in a different location:
+  dryft \path\to\your\Jobs.dat
+
+== Compatibility
+
+DRYFT has been developed using WinAutomation version 3.1.4.628 (released 
+December 17, 2010). It may work on earlier versions and will probably work
+on later 3.1.x versions.
+
+== Copyright
+
+DRYFT comes to you under the MIT license. See LICENSE.txt for details.
+
+== Feedback
+
+I would love to hear any feedback you have about DRYFT! 
+The best way to reach me is via email at gmail.com (chrisberkhout@).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/dryft

@@ -0,0 +1,6 @@
+#!/usr/bin/ruby
+
+require 'dryft'
+
+db_file = ARGV[0] || '\Documents and Settings\All Users\Application Data\Softomotive\WinAutomation\Jobs.dat' 
+DRYFT::Jobs.new(db_file).update_all

data/dryft.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dryft/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dryft"
+  s.version     = Dryft::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Berkhout"]
+  s.email       = ["chrisberkhout@gmail.com"]
+  s.homepage    = "http://github.com/chrisberkhout/dryft"
+  s.summary     = %q{Don't Repeat Yoursef Factoring Tool for WinAutomation}
+  s.description = %q{Define WinAutomation procedures that can be included elsewhere without consistency issues.}
+
+  s.rubyforge_project = "dryft"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("sqlite3-ruby")
+  s.add_dependency("nokogiri")
+end

data/lib/dryft.rb

@@ -0,0 +1,13 @@
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'sqlite3'
+require 'nokogiri'
+
+require 'ruby/object'
+require 'nokogiri/node'
+require 'nokogiri/node_set'
+
+require 'dryft/job'
+require 'dryft/jobs'

data/lib/dryft/job.rb

@@ -0,0 +1,126 @@
+module DRYFT
+  class Job
+
+    attr_reader :id, :name, :proc, :def_acts, :deps
+
+    def initialize(db, info)
+      @db = db
+      @id = get_id(db, info)
+      load
+    end
+  
+    def reload
+      load
+    end
+  
+    def update_from_deps(jobs)
+      no_change = true
+      @deps.each do |dep|
+        src_job = jobs.by_proc(dep[:proc])
+        if dep[:acts].not_equivalent_to?( src_job.def_acts )
+          no_change = false
+          dep[:acts].after( src_job.def_acts.to_xml )
+          dep[:acts].unlink
+          puts "At #{@name}:#{dep[:start]}, updated procedure <#{dep[:proc]}> from its definition."
+        end
+      end
+      if no_change
+        puts "No change to '#{@name}'."
+      else
+        updated_code = @doc.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::NO_DECLARATION)
+        @db.execute("UPDATE jobcode SET code = ? WHERE hex(id) = ?", [updated_code, @id])
+
+        # Switch to a new job ID, because there is no way to trigger a reload ov the original job ID's code.
+        new_id = @db.execute("SELECT HEX(RANDOMBLOB(LENGTH(Id))) FROM jobcode")[0][0]
+        @db.execute("UPDATE compilerproperties SET JobId = x'#{new_id}' WHERE hex(JobId) = ?", [@id])
+        @db.execute("UPDATE jobaddon SET JobId = x'#{new_id}' WHERE hex(JobId) = ?", [@id])
+        @db.execute("UPDATE jobaddonassembly SET JobId = x'#{new_id}' WHERE hex(JobId) = ?", [@id])
+        @db.execute("UPDATE jobattachment SET JobId = x'#{new_id}' WHERE hex(JobId) = ?", [@id])
+        @db.execute("UPDATE jobcode SET Id = x'#{new_id}' WHERE hex(Id) = ?", [@id])
+        @db.execute("UPDATE jobinfo SET Id = x'#{new_id}' WHERE hex(Id) = ?", [@id])
+        @db.execute("UPDATE jobproperties SET Id = x'#{new_id}' WHERE hex(Id) = ?", [@id])
+        @db.execute("UPDATE jobproperties2 SET Id = x'#{new_id}' WHERE hex(Id) = ?", [@id])
+        @db.execute("UPDATE triggers SET JobId = x'#{new_id}' WHERE hex(JobId) = ?", [@id])
+        @id = new_id
+
+        reload
+      end
+    end
+  
+    protected
+  
+    def get_id(db, info)
+      case info.keys[0]
+      when :id
+        info[:id]
+      when :name
+        rows = db.execute("SELECT hex(id) FROM jobinfo WHERE name = ?", [info[:name]])
+        abort "ERROR: tried to load the job named '#{info[:name]}', but that name is not unique." if rows.length > 1
+        abort "ERROR: tried to load the job named '#{info[:name]}', but it was not found." if rows.length == 0
+        rows[0][0]
+      when :proc
+        rows = db.execute("SELECT hex(id) FROM jobinfo WHERE name LIKE ?", ["<#{info[:proc]}>%"])
+        abort "ERROR: tried to load the procedure named '#{info[:proc]}', but that name is not unique." if rows.length > 1
+        abort "ERROR: tried to load the procedure named '#{info[:proc]}', but it was not found." if rows.length == 0
+        rows[0][0]
+      end
+    end
+  
+    def load
+      rows = @db.execute("SELECT hex(i.id), i.name, c.code FROM jobinfo i, jobcode c WHERE i.id = c.id AND hex(i.id) = ?", [@id])
+      abort "ERROR: tried to load the job with ID '#{@id}', but it was not found." if rows.length == 0
+      @id, @name, @code = rows[0]
+      if @name =~ /^\<([^\/\>].*?)\>.*/
+        @proc = $1
+      else
+        abort "ERROR: tried to initialise a job ('#{@name}') that is not a procedure."
+      end
+      parse
+    end
+  
+    def parse
+      @actions = nil
+      @def_acts = nil
+      @deps = []
+      stack = []
+      def_start = nil
+      def_end = nil
+
+      @doc = Nokogiri::XML(@code)
+      @actions = @doc.xpath("//xmlns:ActionFlow[@Name='Main Flow']/*")
+      @actions.each_with_index do |a,i|
+      
+        comment = a.xpath("./descendant-or-self::xmlns:CommentAction/xmlns:Comment").first
+        if comment && comment.inner_text =~ /^\<([^\/\>].*?)\>.*/ # opening tag
+
+          tag = $1
+          abort "ERROR: at '#{@name}:#{i+1}', attempt to define <#{@proc}> within <#{stack.last[:tag]}>." if tag == @proc && stack.length > 0
+          abort "ERROR: at '#{@name}:#{i+1}', reopening <#{tag}> here implies circular dependency." if tag.is_in? stack.map{ |e| e[:tag] }
+          stack.push({:tag => tag, :start => (i+1) })
+
+        elsif comment && comment.inner_text =~ /^\<\/(.*?)\>.*/ # closing tag
+
+          tag = $1
+          abort "ERROR: at '#{name}:#{i+1}', attempt to close <#{tag}> when nothing was open." if stack.length == 0
+          abort "ERROR: at '#{name}:#{i+1}', attempt to close <#{tag}> when close of <#{stack.last[:tag]}> was expected." if stack.last[:tag] != tag
+          if tag == @proc # end of definition of the procedure
+            def_start = stack.last[:start]
+            def_end   = i+1
+          elsif stack.length == 1 || stack[-2][:tag] == @proc # end of definition of a direct dependency
+            @deps.push({ :proc => tag, :start => stack.last[:start], :end => i+1, :acts => @actions[(stack.last[:start]-1)..(i)] })
+          end
+          stack.pop
+
+        end
+      
+      end # each action
+    
+      abort "ERROR: in '#{@name}', there was no code to define the procedure <#{@proc}>." if def_start.nil?
+      abort "ERROR: in '#{@name}', no closing tag for the definition of <#{@proc}>." if def_end.nil?
+      abort "ERROR: in '#{@name}', the following tags were not closed: <#{stack.map{ |e| e[:tag] }.join('>, <')}>." if stack.length > 0
+    
+      @def_acts = @actions[ (def_start-1) .. (def_end-1) ]
+    end # parse
+
+  end
+end # module

data/lib/dryft/jobs.rb

@@ -0,0 +1,63 @@
+module DRYFT
+  class Jobs
+  
+    def initialize(db_file)
+      abort "ERROR: The specified WinAutomation jobs database does not exist: #{db_file}" if !File.exists?(db_file)
+      @job_list = get_jobs(SQLite3::Database.new db_file)
+      puts "Loaded the WinAutomation jobs database from: #{db_file}"
+    end
+
+    def by_id(id)
+      (@job_list.select{ |j| j.id == id }).first
+    end
+    def by_name(name)
+      (@job_list.select{ |j| j.name == name }).first
+    end
+    def by_proc(proc)
+      (@job_list.select{ |j| j.proc == proc }).first
+    end
+
+    def update_all
+      resolve_list(@job_list).each do |j|
+        j.update_from_deps(self)      
+      end
+      puts "Updated all procedures.\n\n"
+      puts "Please PRESS F5 in the WinAutomation Console to refresh the jobs list!"
+    end
+  
+    protected 
+  
+    def get_jobs(db)
+      jobs = []
+      rows = db.execute("SELECT hex(id) FROM jobinfo WHERE name LIKE '<%>%'")
+      rows.each do |r|
+        id = r[0]
+        jobs.push( Job.new(db, :id => id) )
+      end
+      jobs
+    end
+  
+    def resolve_list(job_list)
+      resolved = []
+      job_list.each{ |j| resolved = resolve(j, resolved) }
+      resolved
+    end
+  
+    def resolve(job, resolved = [], unresolved = [])
+      if job.not_in? resolved
+        unresolved << job
+        job.deps.each do |dep|
+          abort "ERROR: at '#{job.name}:#{dep[:start]}', the procedure <#{dep[:proc]}> is used but not defined." if by_proc(dep[:proc]).nil?
+          if by_proc(dep[:proc]).not_in? resolved
+            abort "ERROR: circular dependency detected: <#{job.proc}> -> <#{dep[:proc]}>." if by_proc(dep[:proc]).is_in? unresolved
+            resolved = resolve(by_proc(dep[:proc]), resolved, unresolved)
+            unresolved -= resolved
+          end
+        end
+        resolved << job
+      end
+      return resolved
+    end
+  
+  end
+end # module

data/lib/dryft/version.rb

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

data/lib/nokogiri/node.rb

@@ -0,0 +1,32 @@
+class Nokogiri::XML::Node
+
+  def equivalent_to?(other)
+
+    self_nodes  = []
+    other_nodes = []
+    
+    self.traverse  { |n| self_nodes  << n }
+    other.traverse { |n| other_nodes << n }
+    
+    return false if self_nodes.length != other_nodes.length
+    
+    0.upto(self_nodes.length-1) do |i|
+
+      s = self_nodes[i]  ; s_attribs = {} ; s.attributes.each_pair { |k,v| s_attribs[k] = v.value }
+      o = other_nodes[i] ; o_attribs = {} ; o.attributes.each_pair { |k,v| o_attribs[k] = v.value }
+
+      return false if s.name != o.name
+      return false if ((s.text? || s.cdata?) && s.text) != ((o.text? || o.cdata?) && o.text)
+      return false if s_attribs != o_attribs
+
+    end
+    
+    return true
+    
+  end
+  
+  def not_equivalent_to?(other)
+    !equivalent_to?(other)
+  end
+  
+end

data/lib/nokogiri/node_set.rb

@@ -0,0 +1,13 @@
+class Nokogiri::XML::NodeSet 
+  
+  def equivalent_to?(other)
+    return false if self.length != other.length
+    0.upto(self.length-1) { |i| return false if self[i].not_equivalent_to?( other[i] ) }
+    return true
+  end
+  
+  def not_equivalent_to?(other)
+    !equivalent_to?(other)
+  end
+  
+end

data/lib/ruby/object.rb

@@ -0,0 +1,11 @@
+class Object
+
+  def is_in?(array)
+    array.include?(self)
+  end
+
+  def not_in?(array)
+    !array.include?(self)
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: dryft
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Berkhout
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Define WinAutomation procedures that can be included elsewhere without consistency issues.
+email: 
+- chrisberkhout@gmail.com
+executables: 
+- dryft
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/dryft
+- dryft.gemspec
+- lib/.DS_Store
+- lib/dryft.rb
+- lib/dryft/job.rb
+- lib/dryft/jobs.rb
+- lib/dryft/version.rb
+- lib/nokogiri/node.rb
+- lib/nokogiri/node_set.rb
+- lib/ruby/.DS_Store
+- lib/ruby/object.rb
+has_rdoc: true
+homepage: http://github.com/chrisberkhout/dryft
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: dryft
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Don't Repeat Yoursef Factoring Tool for WinAutomation
+test_files: []
+