sleipnir-api 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 / 2007-07-22
+
+* Initial beta release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 MIYAMUKO Katsuyuki <mailto:miyamuko@gmail.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/Manifest.txt

@@ -0,0 +1,41 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+examples/reload.rb
+helper/helper.rb
+helper/rake.rb
+helper/rake_sh_filter.rb
+helper/util.rb
+lib/sleipnir_api.rb
+lib/sleipnir_api/dialog.rb
+lib/sleipnir_api/key_state.rb
+lib/sleipnir_api/output.rb
+lib/sleipnir_api/process.rb
+lib/sleipnir_api/profile.rb
+lib/sleipnir_api/registry.rb
+lib/sleipnir_api/security.rb
+lib/sleipnir_api/sleipnir.rb
+lib/sleipnir_api/tab.rb
+lib/sleipnir_api/util.rb
+lib/sleipnir_api/version.rb
+lib/sleipnir_api/win32api.rb
+scripts/rdoc_filter.rb
+setup.rb
+spec/matchers/path_eql.rb
+spec/sleipnir_api/dialog_mock_spec.rb
+spec/sleipnir_api/key_state_mock_spec.rb
+spec/sleipnir_api/output_spec.rb
+spec/sleipnir_api/profile_mock_spec.rb
+spec/sleipnir_api/registry_spec.rb
+spec/sleipnir_api/security_mock_spec.rb
+spec/sleipnir_api/security_spec.rb
+spec/sleipnir_api/sleipnir_mock_spec.rb
+spec/sleipnir_api/sleipnir_spec.rb
+spec/sleipnir_api/tab_mock_spec.rb
+spec/sleipnir_api/tab_spec.rb
+spec/sleipnir_api_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,56 @@
+== sleipnir-api - Sleipnir.API の Ruby Interface
+
+=== DESCRIPTION
+
+sleipnir-api は {Sleipnir}[http://www.fenrir.co.jp/sleipnir2-the-world/] の
+COM サーバ (Sleipnir.API) を操作するための Ruby ライブラリです。
+
+WIN32OLE オブジェクトをラップし、Ruby らしいインターフェイスを提供します。
+
+API 仕様は SleipnirAPI を参照してください。
+
+
+=== SYNOPSIS
+
+  require "rubygems"
+  require "sleipnir_api"
+
+  SleipnirAPI.new do |pnir|
+    pnir.each do |tab|
+      if tab.location.href =~ /workspace/
+        tab.location.reload
+      end
+    end
+  end
+
+
+=== INSTALL
+
+[Unix]
+    sudo gem install sleipnir-api
+
+[Windows]
+    gem install sleipnir-api
+
+
+=== CAVEATS
+
+* Sleipnir 2.xx オリジナルの動作と違う部分があります。
+  詳細は SleipnirAPI の「非互換性」を参照してください。
+
+* Sleipnir 2.xx でのテストはあまりしていません。
+
+=== COPYRIGHT
+
+Copyright (c) 2007 MIYAMUKO Katsuyuki.
+
+sleipnir-api is released under an MIT license.
+See {License.txt}[link:files/License_txt.html] for full license.
+
+
+=== OTHER STUFF
+
+Author::          MIYAMUKO Katsuyuki <mailto:miyamuko@gmail.com>
+Home URL::        http://sleipnir-api.rubyforge.org
+Project URL::     http://rubyforge.org/projects/sleipnir-api
+Blog (Japanese):: {id:miyamuko}[http://d.hatena.ne.jp/miyamuko/]

data/Rakefile

@@ -0,0 +1,201 @@
+# -*- mode: ruby -*-
+
+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'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
+
+require 'helper/helper'
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'sleipnir_api', 'version')
+
+AUTHOR = 'MIYAMUKO Katsuyuki'  # can also be an array of Authors
+EMAIL = "miyamuko@gmail.com"
+DESCRIPTION = "Ruby interface to the Sleipnir COM API"
+GEM_NAME = 'sleipnir-api' # what ppl will type to install your gem
+RDOC_DIR = "./html"
+NEWS_FILE = "news.txt"
+
+@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 "ERROR: No rubyforge config file found: #{@config_file}"
+      puts "Run 'rubyforge setup' to prepare your env for access to Rubyforge"
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'sleipnir-api' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "sleipnir-api"
+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 = SleipnirAPI::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store', NEWS_FILE]
+
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject!{|x| Array(x).first == 'hoe' }
+    @extra_deps
+  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.email = EMAIL
+  p.url = HOMEPATH
+
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = []
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+
+  p.description = p.summary = "Ruby interface to the Sleipnir.API WIN32OLE object."
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+
+  p.need_zip = true
+  p.need_tar = true
+end
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_manifest!, :check_version, :publish_docs, :release]
+
+task :check_manifest! => [:check_manifest] do
+  unless $?.success?
+    puts "----"
+    puts "Please update Manifest.txt."
+    exit 1
+  end
+end
+
+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
+  histver = File.read("History.txt")[/^== (\d+\.\d+\.\d+)/, 1]
+  unless ENV['VERSION'] == histver
+    puts "Please update your History.txt to match the release version, currently #{histver}"
+    exit
+  end
+end
+
+# remove :test task defined by Hoe.
+remove_tasks :test, :test_deps, :default
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+task :test => [:spec]
+
+desc "Default task is to run specs"
+task :default => :spec
+
+#
+# new task
+#
+
+desc 'Uninstall the gem package'
+task_for_windows :uninstall_gem do
+  sh "gem.bat uninstall #{ENV['GEMOPTS']} #{GEM_NAME}"
+end
+
+
+#
+# overwrite hoe defined tasks.
+#
+
+remove_tasks(:clobber_docs, :docs, :redocs)
+Rake::RDocTask.new(:docs) do |rd|
+  rd.main = "README.txt"
+  rd.rdoc_dir = RDOC_DIR
+  files = File.read("Manifest.txt").split.grep(/^(lib|bin)|txt$/)
+  files -= ['Manifest.txt']
+  rd.rdoc_files.push(*files)
+
+  rd.options << "-t #{NAME}-#{VERS} Documentation"
+  rd.options << '--charset=UTF-8'
+end
+
+# remove HTML comment and so on.
+task :docs do
+  ruby "scripts/rdoc_filter.rb #{RDOC_DIR}/**/*.html"
+end
+
+
+task_for_windows :install_gem do
+  sh "gem.bat install #{ENV['GEMOPTS']} pkg/*.gem"
+end
+
+task_for_windows :ridocs do
+  sh "rdoc.bat --ri -o ri ."
+end
+
+task_for_windows :publish_docs do
+  Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, @rubyforge_username).upload
+end
+
+# rake publish_docs SCP=pscp
+if ENV["SCP"] and ENV["SCP"] != "scp"
+  add_sh_filter_for(/\Ascp /) {|cmd|
+    cmd[0].sub!(/\Ascp/, ENV["SCP"])
+    cmd[0].sub!(/-rq/, "-r")
+    cmd
+  }
+end
+
+
+task :create_news do
+  subject, title, body, urls = hoe.announcement
+  open(NEWS_FILE, "w") do |w|
+    w.puts subject
+    w.puts "#{title}\n\n#{body}\n\n"
+    w.puts "--"
+    w.puts "Home URL:    #{HOMEPATH}"
+    w.puts "Project URL: #{DOWNLOAD_PATH}"
+  end
+  puts File.read(NEWS_FILE)
+end
+
+override_task :post_news do
+  subject, body = File.read(NEWS_FILE).split(/\n/, 2)
+  require 'rubyforge'
+  rf = RubyForge.new
+  rf.login
+  rf.post_news(RUBYFORGE_PROJECT, subject, body)
+  puts "Posted to rubyforge `#{subject}'."
+  rm_f NEWS_FILE
+end
+
+# vim: syntax=Ruby

data/TODO.txt

@@ -0,0 +1,11 @@
+== TODO
+
+* Sleipnir の起動・終了を WMI を使わずに実装。
+* Sleipnir の終了時に Window Handle をちゃんと見る。
+* grepnir
+* example
+* ExecCommand
+  * コマンドの一覧
+* Sleipnir 2.x のサポート
+  * ExecAction とか
+

data/examples/reload.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
+require "sleipnir_api"
+
+if ARGV.empty?
+  puts "Usage: #{$0} REGEXP..."
+  exit 1
+end
+
+regexp = ARGV.map {|arg| Regexp.compile(arg) rescue Regexp.compile(Regexp.quote(arg)) }
+
+SleipnirAPI.new do |pnir|
+  pnir.each do |tab|
+    if regexp.any? {|re| re.match(tab.location.href) }
+      puts tab.location.href
+      tab.location.reload
+    end
+  end
+end

data/helper/helper.rb

@@ -0,0 +1,3 @@
+require "helper/util"
+require "helper/rake"
+require "helper/rake_sh_filter"

data/helper/rake.rb

@@ -0,0 +1,58 @@
+require "rubygems"
+require "rake"
+
+def tasks
+  Rake.application.instance_eval { @tasks }
+end
+
+def current_scope
+  Rake.application.instance_eval { @scope.last }
+end
+
+def task_defined?(task_name)
+  Rake::Task.task_defined?(task_name)
+end
+
+def remove_tasks(*task_names)
+  task_names.flatten.each do |task_name|
+    remove_task(task_name)
+  end
+end
+
+def remove_task(task_name)
+  tasks.delete(task_name.to_s)
+end
+
+def lookup_task(task_name)
+  Rake::Task[task_name] rescue nil
+end
+
+def rakecall(task_name)
+  lookup_task(task_name).invoke
+end
+
+def override_task(task_args, &block)
+  task_name, deps = Rake.application.resolve_args(task_args)
+  original = lookup_task(task_name)
+  orgproc = lambda {} # nop
+  if original
+    Rake.application.last_comment = original.comment
+    deps |= original.prerequisites
+    orgproc = lambda{ original.execute }
+  end
+
+  remove_task(task_name)
+  Rake::Task.define_task(task_name => deps) do |t|
+    block.call(t, orgproc)
+  end
+end
+
+def task_for_windows(task_args, &block)
+  override_task(task_args) do |t, org|
+    if windows?
+      block.call(t)
+    else
+      org.call
+    end
+  end
+end

data/helper/rake_sh_filter.rb

@@ -0,0 +1,23 @@
+module FileUtils
+  SHELL_COMMAND_FILTER = []
+
+  alias sh_original sh
+  def sh(*cmd, &block)
+    cmd = SHELL_COMMAND_FILTER.inject(cmd){|c,filter| filter.call(c) or c }
+    sh_original(*cmd, &block)
+  end
+
+  def add_sh_filter(&block)
+    SHELL_COMMAND_FILTER << block
+  end
+
+  def add_sh_filter_for(pattern, &block)
+    add_sh_filter {|cmd|
+      if cmd[0] =~ pattern
+        block.call(cmd)
+      else
+        cmd
+      end
+    }
+  end
+end