win_gui 0.1.6 → 0.2.0

data/spec/spec_helper.rb

@@ -1,118 +1,90 @@
-lib_dir = File.join(File.dirname(__FILE__), "..", "lib" )
-$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include?(lib_dir)
-require 'spec'
-require 'win_gui'
-require 'note'
-
-# Customize RSpec with my own extensions
-module SpecMacros
-
-  # wrapper for it method that extracts description from example source code, such as:
-  # spec { use{    function(arg1 = 4, arg2 = 'string')  }}
-  def spec &block
-    it description_from(*block.source_location), &block
-  end
-
-  # reads description line from source file and drops external brackets (like its{}, use{}
-  def description_from(file, line)
-    File.open(file) do |f|
-      f.lines.to_a[line-1].gsub( /(spec.*?{)|(use.*?{)|}/, '' ).strip
-    end
-  end
-end
-
-Spec::Runner.configure { |config| config.extend(SpecMacros) }
-
-module GuiTest
-  include WinGui
-
-  # Test related Constants:
-  TEST_TIMEOUT = 0.001
-  TEST_KEY_DELAY = 0.001
-  TEST_SLEEP_DELAY = 0.01
-  TEST_APP_PATH = File.join(File.dirname(__FILE__), "test_apps/locknote/LockNote.exe" )
-  TEST_APP_START = 'start "" "' + TEST_APP_PATH + '"'
-  TEST_WIN_TITLE = 'LockNote - Steganos LockNote'
-  TEST_WIN_CLASS = 'ATL:00434098'
-  TEST_WIN_RECT = [710, 400, 1210, 800]
-  TEST_MAX_RECT = [-4, -4, 1924, 1204]  # on my 1920x1200 display
-  TEST_MIN_RECT = [-32000, -32000, -31840, -31976]
-  TEST_TEXTAREA_CLASS = 'ATL:00434310'
-  TEST_STATUSBAR_CLASS = 'msctls_statusbar32' 
-  TEST_IMPOSSIBLE = 'Impossible'
-  TEST_ERROR_CONVERSION = /Can.t convert/
-
-  # Helper methods:
-  def use
-    lambda {yield}.should_not raise_error
-  end
-
-  def any_handle
-    WinGui.def_api 'FindWindow', 'PP', 'L' unless respond_to? :find_window
-    find_window(nil, nil)
-  end
-
-  def not_a_handle
-    123
-  end
-
-  def any_block
-    lambda {|*args| args}
-  end
-
-  def hide_method(*names) # hide original method(s) if it is defined
-    names.map(&:to_s).each do |name|
-      WinGui.module_eval do
-        aliases = generate_names(name, {}).flatten + [name]
-        aliases.map(&:to_s).each do |ali|
-          if method_defined? ali
-            alias_method "orig_#{ali}".to_sym, ali
-            remove_method ali
-          end
-        end
-      end
-    end
-  end
-
-  def restore_method(*names) # restore original method if it was hidden
-    names.map(&:to_s).each do |name| 
-      WinGui.module_eval do
-        aliases = generate_names(name, {}).flatten + [name]
-        aliases.map(&:to_s).each do |ali|
-          temp = "orig_#{ali}".to_sym
-          if method_defined? temp
-            alias_method ali, temp
-            remove_method temp
-          end
-        end
-      end
-    end
-  end
-
-  def launch_test_app
-    system TEST_APP_START
-    sleep TEST_SLEEP_DELAY until (handle = find_window(nil, TEST_WIN_TITLE))
-    @launched_test_app = Window.new handle
-  end
-
-  def close_test_app(app = @launched_test_app)
-    while app and app.respond_to? :handle and find_window(nil, TEST_WIN_TITLE)
-      post_message(app.handle, WM_SYSCOMMAND, SC_CLOSE, 0)
-      sleep TEST_SLEEP_DELAY
-    end
-    @launched_test_app = nil
-  end
-
-  # Creates test app object and yields it back to the block
-  def test_app
-    app = launch_test_app
-
-    def app.textarea #define singleton method retrieving app's text area
-      Window.new find_window_ex(self.handle, 0, TEST_TEXTAREA_CLASS, nil)
-    end
-
-    yield app
-    close_test_app
-  end
-
-end
+require 'spec'
+require 'spec/autorun'
+require 'win_gui'
+
+# Customize RSpec with my own extensions
+module SpecMacros
+
+  # wrapper for it method that extracts description from example source code, such as:
+  # spec { use{    function(arg1 = 4, arg2 = 'string')  }}
+  def spec &block
+    it description_from(*block.source_location), &block
+  end
+
+  # reads description line from source file and drops external brackets (like its{}, use{}
+  def description_from(file, line)
+    File.open(file) do |f|
+      f.lines.to_a[line-1].gsub( /(spec.*?{)|(use.*?{)|}/, '' ).strip
+    end
+  end
+end
+
+Spec::Runner.configure { |config| config.extend(SpecMacros) }
+
+module WinGuiTest
+  include Win::Gui
+
+  # Test related Constants:
+  TIMEOUT = 0.001
+  KEY_DELAY = 0.001
+  SLEEP_DELAY = 0.01
+  APP_PATH = File.join(File.dirname(__FILE__), "../misc/locknote/LockNote.exe" )
+  APP_START = RUBY_PLATFORM =~ /cygwin/ ? "cmd /c start `cygpath -w #{APP_PATH}`" : "start #{APP_PATH}"
+#          end
+#
+#          'start "" "' + APP_PATH + '"'
+  WIN_TITLE = 'LockNote - Steganos LockNote'
+  WIN_CLASS = 'ATL:00434098'
+  WIN_RECT = [710, 400, 1210, 800]
+  MAX_RECT = [-4, -4, 1924, 1204]  # on my 1920x1200 display
+  MIN_RECT = [-32000, -32000, -31840, -31976]
+  TEXTAREA_CLASS = 'ATL:00434310'
+  STATUSBAR_CLASS = 'msctls_statusbar32'
+  IMPOSSIBLE = 'Impossible'
+  ERROR_CONVERSION = /Can.t convert/
+
+  # Helper methods:
+  def use
+    lambda {yield}.should_not raise_error
+  end
+
+  def any_handle
+    WinGui.def_api 'FindWindow', 'PP', 'L' unless respond_to? :find_window
+    find_window(nil, nil)
+  end
+
+  def not_a_handle
+    123
+  end
+
+  def any_block
+    lambda {|*args| args}
+  end
+
+  def launch_test_app
+    system APP_START
+    sleep SLEEP_DELAY until (handle = find_window(nil, WIN_TITLE))
+    @launched_test_app = Window.new handle
+  end
+
+  def close_test_app(app = @launched_test_app)
+    while app && app.respond_to?(:handle) && find_window(nil, WIN_TITLE)
+      post_message(app.handle, WM_SYSCOMMAND, SC_CLOSE, nil)
+      sleep SLEEP_DELAY
+    end
+    @launched_test_app = nil
+  end
+
+  # Creates test app object and yields it back to the block
+  def test_app
+    app = launch_test_app
+
+    def app.textarea #define singleton method retrieving app's text area
+      Window.new find_window_ex(self.handle, 0, TEXTAREA_CLASS, nil)
+    end
+
+    yield app
+    close_test_app
+  end
+
+end

data/spec/win_gui/window_spec.rb

@@ -1,124 +1,121 @@
-require File.join(File.dirname(__FILE__), ".." , "spec_helper" )
-
-module GuiTest
-  
-  describe Window do
-    before(:each) { @app = launch_test_app }
-    after(:each){ close_test_app }
-    
-    context 'creating' do
-      it 'can be wrapped around any existing window' do
-        any_handle = find_window(nil, nil)
-        use{ Window.new any_handle }
-      end
-      
-      it 'can be wrapped around specific window' do
-        use{ Window.new @app.handle }
-      end
-    end
-    
-    context 'manipulating' do
-      
-      it 'has handle property equal to underlying window handle' do
-        any_handle = find_window(nil, nil)
-        any = Window.new any_handle
-        any.handle.should == any_handle
-      end
-      
-      it 'has text property equal to underlying window text(title)' do
-        @app.text.should == TEST_WIN_TITLE
-      end
-
-      it 'closes when asked nicely' do
-        @app.close
-        sleep TEST_SLEEP_DELAY # needed to ensure window had enough time to close down
-        find_window(nil, TEST_WIN_TITLE).should == nil
-      end
-      
-      it 'waits f0r window to disappear (NB: this happens before handle is released!)' do 
-        start = Time.now 
-        @app.close
-        @app.wait_for_close
-         (Time.now - start).should be <= WG_CLOSE_TIMEOUT
-        window_visible?(@app.handle).should be false
-      end
-    end
-    
-    context '.top_level class method' do
-      it 'finds any top-level window (title = nil) and wraps it in a Window object' do
-        use { @win = Window.top_level(title = nil, timeout_sec = 3) }
-        Window.should === @win
-      end
-      
-      it 'finds top-level window by title and wraps it in a Window object' do
-        win = Window.top_level( TEST_WIN_TITLE, 1)
-        win.handle.should == @app.handle
-      end
-    end
-    
-    context '#child' do
-      spec { use { @control = @app.child(title_class_id = nil)  }} 
-
-      it 'finds any child window(control) if given nil' do
-        @app.child(nil).should_not == nil
-      end
-      
-      it 'finds child window(control) by class' do
-        @app.child(TEST_TEXTAREA_CLASS).should_not == nil
-      end
-      
-      it 'finds child window(control) by name' do
-        pending 'Need to find control with short name'
-        @app.child(TEST_TEXTAREA_TEXT).should_not == nil
-      end
-
-      it 'finds child window(control) by control ID' do
-        pending 'Need to find some control ID'
-        @app.child(TEST_TEXTAREA_ID).should_not == nil
-      end
-      
-      it 'raises error if wrong control is given' do
-        expect { @app.child('Impossible Control')}.to raise_error "Control 'Impossible Control' not found"
-      end
-      it 'substitutes & for _ when searching by title ("&Yes" type controls)'
-      
-    end
-    
-    context '#children' do
-      spec { use { children = @app.children  }}
-
-      it 'returns an array' do
-        @app.children.should be_a_kind_of(Array)
-      end
-
-      it 'returns an array of all child windows to the given window ' do
-        children = @app.children
-        children.should be_a_kind_of Array
-        children.should_not be_empty
-        children.should have(2).elements
-        children.each{|child| child?(@app.handle, child.handle).should == true }
-        get_class_name(children.last.handle).should == TEST_TEXTAREA_CLASS
-      end
-
-#      it 'finds child window(control) by name' do
-#        pending 'Need to find control with short name'
-#        @app.child(TEST_TEXTAREA_TEXT).should_not == nil
-#      end
-#
-#      it 'finds child window(control) by control ID' do
-#        pending 'Need to find some control ID'
-#        @app.child(TEST_TEXTAREA_ID).should_not == nil
-#      end
-#
-#      it 'raises error if wrong control is given' do
-#        expect { @app.child('Impossible Control')}.to raise_error "Control 'Impossible Control' not found"
-#      end
-#      it 'substitutes & for _ when searching by title ("&Yes" type controls)'
-      
-    end
-
-    context '#click' do
-      it 'emulates clicking of the control identified by id'
-    end
-  end
+require File.join(File.dirname(__FILE__), ".." , "spec_helper" )
+
+module WinGuiTest
+  include WinGui
+
+  describe Window do
+    before(:each) { @app = launch_test_app }
+    after(:each){ close_test_app }
+    
+    context 'initializing' do
+      it 'can be wrapped around any existing window' do
+        any_handle = find_window(nil, nil)
+        use{ Window.new any_handle }
+      end
+    end
+    
+    context 'manipulating' do
+      
+      it 'has handle property equal to underlying window handle' do
+        any_handle = find_window(nil, nil)
+        any = Window.new any_handle
+        any.handle.should == any_handle
+      end
+      
+      it 'has text property equal to underlying window text(title)' do
+        @app.text.should == WIN_TITLE
+      end
+
+      it 'closes when asked nicely' do
+        @app.close
+        sleep SLEEP_DELAY # needed to ensure window had enough time to close down
+        find_window(nil, WIN_TITLE).should == nil
+      end
+      
+      it 'waits f0r window to disappear (NB: this happens before handle is released!)' do 
+        start = Time.now 
+        @app.close
+        @app.wait_for_close
+         (Time.now - start).should be <= WG_CLOSE_TIMEOUT
+        window_visible?(@app.handle).should be false
+      end
+    end
+    
+    context '.top_level class method' do
+      it 'finds any top-level window (title = nil) and wraps it in a Window object' do
+        use { @win = Window.top_level(title = nil, timeout_sec = 3) }
+        Window.should === @win
+      end
+      
+      it 'finds top-level window by title and wraps it in a Window object' do
+        win = Window.top_level( WIN_TITLE, 1)
+        win.handle.should == @app.handle
+      end
+    end
+    
+    context '#child' do
+      spec { use { @control = @app.child(title_class_id = nil)  }} 
+
+      it 'finds any child window(control) if given nil' do
+        @app.child(nil).should_not == nil
+      end
+      
+      it 'finds child window(control) by class' do
+        @app.child(TEXTAREA_CLASS).should_not == nil
+      end
+      
+      it 'finds child window(control) by name' do
+        pending 'Need to find control with short name'
+        @app.child(TEXTAREA_TEXT).should_not == nil
+      end
+
+      it 'finds child window(control) by control ID' do
+        pending 'Need to find some control ID'
+        @app.child(TEXTAREA_ID).should_not == nil
+      end
+      
+      it 'raises error if wrong control is given' do
+        expect { @app.child('Impossible Control')}.to raise_error "Control 'Impossible Control' not found"
+      end
+      it 'substitutes & for _ when searching by title ("&Yes" type controls)'
+      
+    end
+    
+    context '#children' do
+      spec { use { children = @app.children  }}
+
+      it 'returns an array' do
+        @app.children.should be_a_kind_of(Array)
+      end
+
+      it 'returns an array of all child windows to the given window ' do
+        children = @app.children
+        children.should be_a_kind_of Array
+        children.should_not be_empty
+        children.should have(2).elements
+        children.each{|child| child?(@app.handle, child.handle).should == true }
+        get_class_name(children.last.handle).should == TEXTAREA_CLASS
+      end
+
+#      it 'finds child window(control) by name' do
+#        pending 'Need to find control with short name'
+#        @app.child(TEXTAREA_TEXT).should_not == nil
+#      end
+#
+#      it 'finds child window(control) by control ID' do
+#        pending 'Need to find some control ID'
+#        @app.child(TEXTAREA_ID).should_not == nil
+#      end
+#
+#      it 'raises error if wrong control is given' do
+#        expect { @app.child('Impossible Control')}.to raise_error "Control 'Impossible Control' not found"
+#      end
+#      it 'substitutes & for _ when searching by title ("&Yes" type controls)'
+      
+    end
+
+    context '#click' do
+      it 'emulates clicking of the control identified by id'
+    end
+  end
 end

data/tasks/common.rake

@@ -0,0 +1,14 @@
+#task :default => 'test:run'
+#task 'gem:release' => 'test:run'
+
+#Bundler not ready for prime time just yet
+#desc 'Bundle dependencies'
+#task :bundle do
+#  output = `bundle check 2>&1`
+#
+#  unless $?.to_i == 0
+#    puts output
+#    system "bundle install"
+#    puts
+#  end
+#end

data/tasks/doc.rake

@@ -0,0 +1,14 @@
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+namespace :doc do
+  require 'rake/rdoctask'
+  Rake::RDocTask.new do |rdoc|
+#    Rake::RDocTask.new(:rdoc => "rdoc", :clobber_rdoc => "clobber", :rerdoc => "rerdoc") do |rdoc|
+    rdoc.rdoc_dir = DOC_PATH.basename.to_s
+    rdoc.title = "#{NAME} #{VERSION} Documentation"
+    rdoc.main = "README.doc"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+end

data/tasks/gem.rake

@@ -0,0 +1,39 @@
+desc "Alias to gem:release"
+task :release => 'gem:release'
+
+desc "Alias to gem:install"
+task :install => 'gem:install'
+
+desc "Alias to gem:build"
+task :gem => 'gem:build'
+
+namespace :gem do
+  gem_file = "#{NAME}-#{VERSION}.gem"
+
+  desc "(Re-)Build gem"
+  task :build do
+    puts "Remove existing gem package"
+    rm_rf PKG_PATH
+    puts "Build new gem package"
+    system "gem build #{NAME}.gemspec"
+    puts "Move built gem to package dir"
+    mkdir_p PKG_PATH
+    mv gem_file, PKG_PATH
+  end
+
+  desc "Cleanup already installed gem(s)"
+  task :cleanup do
+    puts "Cleaning up installed gem(s)"
+    system "gem cleanup #{NAME}"
+  end
+
+  desc "Build and install gem"
+  task :install => :build do
+    system "gem install #{PKG_PATH}/#{gem_file}"
+  end
+
+  desc "Build and push gem to Gemcutter"
+  task :release => [:build, 'git:tag'] do
+    system "gem push #{PKG_PATH}/#{gem_file}"
+  end
+end

data/tasks/git.rake

@@ -0,0 +1,34 @@
+desc "Alias to git:commit"
+task :git => 'git:commit'
+
+namespace :git do
+
+  desc "Stage and commit your work [with message]"
+  task :commit, [:message] do |t, args|
+    puts "Staging new (unversioned) files"
+    system "git add --all"
+    if args.message
+      puts "Committing with message: #{args.message}"
+      system %Q[git commit -a -m "#{args.message}" --author arvicco]
+    else
+      puts "Committing"
+      system %Q[git commit -a -m "No message" --author arvicco]
+    end
+  end
+
+  desc "Push local changes to Github"
+  task :push => :commit do
+    puts "Pushing local changes to remote"
+    system "git push"
+  end
+
+  desc "Create (release) tag on Github"
+  task :tag => :push do
+    tag = VERSION
+    puts "Creating git tag: #{tag}"
+    system %Q{git tag -a -m "Release tag #{tag}" #{tag}}
+    puts "Pushing #{tag} to remote"
+    system "git push origin #{tag}"
+  end
+
+end

data/tasks/spec.rake

@@ -0,0 +1,19 @@
+desc 'Alias to spec:spec'
+task :spec => 'spec:spec'
+
+namespace :spec do
+  require 'spec/rake/spectask'
+
+  desc "Run all specs"
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts = ['--options', %Q{"#{BASE_PATH}/spec/spec.opts"}]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  desc "Run specs with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+  end
+end

data/tasks/version.rake

@@ -0,0 +1,71 @@
+class Version
+  attr_accessor :major, :minor, :patch, :build
+
+  def initialize(version_string)
+    raise "Invalid version #{version_string}" unless version_string =~ /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/
+    @major = $1.to_i
+    @minor = $2.to_i
+    @patch = $3.to_i
+    @build = $4
+  end
+
+  def bump_major(x)
+    @major += x.to_i
+    @minor = 0
+    @patch = 0
+    @build = nil
+  end
+
+  def bump_minor(x)
+    @minor += x.to_i
+    @patch = 0
+    @build = nil
+  end
+
+  def bump_patch(x)
+    @patch += x.to_i
+    @build = nil
+  end
+
+  def update(major, minor, patch, build=nil)
+    @major = major
+    @minor = minor
+    @patch = patch
+    @build = build
+  end
+
+  def write(desc = nil)
+    CLASS_NAME::VERSION_FILE.open('w') {|file| file.puts to_s }
+    (BASE_PATH + 'HISTORY').open('a') do |file|
+      file.puts "\n== #{to_s} / #{Time.now.strftime '%Y-%m-%d'}\n"
+      file.puts "\n* #{desc}\n" if desc
+    end
+  end
+
+  def to_s
+    [major, minor, patch, build].compact.join('.')
+  end
+end
+
+desc 'Set version: [x.y.z] - explicitly, [1/10/100] - bump major/minor/patch, [.build] - build'
+task :version, [:command, :desc] do |t, args|
+  version = Version.new(VERSION)
+  case args.command
+    when /^(\d+)\.(\d+)\.(\d+)(?:\.(.*?))?$/  # Set version explicitly
+      version.update($1, $2, $3, $4)
+    when /^\.(.*?)$/                        # Set build
+      version.build = $1
+    when /^(\d{1})$/                          # Bump patch
+      version.bump_patch $1
+    when /^(\d{1})0$/                         # Bump minor
+      version.bump_minor $1
+    when /^(\d{1})00$/                        # Bump major
+      version.bump_major $1
+    else                                      # Unknown command, just display VERSION
+      puts "#{NAME} #{version}"
+      next
+  end
+
+  puts "Writing version #{version} to VERSION file"
+  version.write args.desc
+end