win32ole-pp 0.0.1

data/CHANGELOG.txt

@@ -0,0 +1,3 @@
+2007-02-11  MIYAMUKO Katsuyuki
+
+	* win32ole-pp 0.0.1 released!

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 / 2007-02-12
+
+* 1st release.
+

data/Manifest.txt

@@ -0,0 +1,28 @@
+CHANGELOG.txt
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+examples/test.rb
+lib/win32ole_pp.rb
+lib/win32ole_pp/extentions.rb
+lib/win32ole_pp/extentions/common.rb
+lib/win32ole_pp/extentions/win32ole.rb
+lib/win32ole_pp/extentions/win32ole_event.rb
+lib/win32ole_pp/extentions/win32ole_method.rb
+lib/win32ole_pp/extentions/win32ole_param.rb
+lib/win32ole_pp/extentions/win32ole_type.rb
+lib/win32ole_pp/extentions/win32ole_variable.rb
+lib/win32ole_pp/init.rb
+lib/win32ole_pp/pp.rb
+lib/win32ole_pp/to_s.rb
+lib/win32ole_pp/version.rb
+setup.rb
+test/helper.rb
+test/test_version.rb
+test/test_win32ole.rb
+test/test_win32ole_event.rb
+test/test_win32ole_method.rb
+test/test_win32ole_param.rb
+test/test_win32ole_type.rb
+test/test_win32ole_variable.rb

data/README.txt

@@ -0,0 +1,100 @@
+== win32ole-pp
+
+* Author: MIYAMUKO Katsuyuki <mailto:miyamuko@gmail.com>
+* URL: http://win32ole-pp.rubyforge.org/
+
+=== DESCRIPTION:
+
+win32ole_pp - provide pretty printer for WIN32OLE and smart #to_s.
+
+=== FEATURES/PROBLEMS:
+
+* add WIN32OLE#pretty_print method for pp.
+* overwrite WIN32OLE#to_s.
+
+=== SYNOPSIS:
+
+  require "pp"
+  require "win32ole"
+  require "win32ole_pp"
+
+  fs = WIN32OLE.new("Scripting.FileSystemObject")
+
+  puts fs    #=> #<WIN32OLE:0x14c9270: IFileSystem3>
+  pp fs      #=> #<WIN32OLE:0x14c9270: IFileSystem3
+             #     Drives=#<WIN32OLE:0x14c8e4c: IDriveCollection>>
+
+  m = fs.ole_method("DeleteFolder")
+
+  puts m     #=> #<WIN32OLE_METHOD:0x14c6638: VOID DeleteFolder([in] BSTR FolderSpec, [in, optional] BOOL Force)>
+  pp m       #=> #<WIN32OLE_METHOD:0x14c6638: DeleteFolder
+             #     dispid=1201,
+             #     event?=false,
+             #     event_interface=nil,
+             #     helpcontext=2182037,
+             #     helpfile="C:\\WINDOWS\\system32\\VBENLR98.CHM",
+             #     helpstring="Delete a folder",
+             #     invkind=1,
+             #     invoke_kind="FUNC",
+             #     name="DeleteFolder",
+             #     offset_vtbl=96,
+             #     params=
+             #      [#<WIN32OLE_PARAM:0x14c08d2: FolderSpec
+             #         default=nil,
+             #         input?=true,
+             #         name="FolderSpec",
+             #         ole_type="BSTR",
+             #         ole_type_detail=["BSTR"],
+             #         optional?=false,
+             #         output?=false,
+             #         retval?=false>,
+             #       #<WIN32OLE_PARAM:0x14c08be: Force
+             #         default=false,
+             #         input?=true,
+             #         name="Force",
+             #         ole_type="BOOL",
+             #         ole_type_detail=["BOOL"],
+             #         optional?=true,
+             #         output?=false,
+             #         retval?=false>],
+             #     return_type="VOID",
+             #     return_type_detail=["VOID"],
+             #     return_vtype=24,
+             #     size_opt_params=0,
+             #     size_params=2,
+             #     visible?=true>
+
+
+=== REQUIREMENTS:
+
+* pp (standard library)
+* win32ole (standard library)
+
+=== INSTALL:
+
+  gem install win32ole-pp
+
+=== LICENSE:
+
+win32ole-pp is released under the MIT license.
+
+Copyright (c) 2007 MIYAMUKO Katsuyuki.
+
+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/Rakefile

@@ -0,0 +1,93 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'rake/contrib/rubyforgepublisher'
+require './lib/win32ole_pp/version.rb'
+
+
+RUBYFORGE_PROJECT = 'win32ole-pp'
+
+# command filter hack.
+$shell_command_filter = []
+alias sh_original sh
+def sh(*cmd, &block)
+  cmd = $shell_command_filter.inject(cmd){|c,filter| filter(c) or c }
+  sh_original(*cmd, &block)
+end
+
+# rake publish_docs SCP=pscp
+if ENV["SCP"] and ENV["SCP"] != "scp"
+  $shell_command_filter << lambda {|cmd|
+    cmd[0] = cmd[0].sub(/\Ascp/, ENV["SCP"]).sub(/-rq/, "-r") if cmd[0] =~ /\Ascp /
+    cmd
+  }
+end
+
+def remove_task(task_name)
+  Rake.application.instance_eval {
+    @tasks.delete(task_name.to_s)
+  }
+end
+
+def with_temporary_rename(from, to)
+  mv from, to
+  yield
+ensure
+  mv to, from
+end
+
+
+Hoe.new(RUBYFORGE_PROJECT, WIN32OLE_PP::VERSION::STRING) do |p|
+  p.rubyforge_name = RUBYFORGE_PROJECT
+  p.summary = 'pretty printer for WIN32OLE'
+
+  p.author = ["MIYAMUKO Katsuyuki"]
+  p.email = "miyamuko@gmail.com"
+  p.url = "http://win32ole-pp.rubyforge.org/"
+
+  p.description = p.paragraphs_of('README.txt', 3..3).join("\n\n")
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+
+  p.need_zip = true
+  p.need_tar = false
+end
+
+
+#
+# new task
+#
+
+desc 'Uninstall the gem package'
+task :uninstall_gem do
+  sh "gem.bat uninstall #{RUBYFORGE_PROJECT}"
+end
+
+
+#
+# overwrite hoe defined tasks for Windows
+#
+
+remove_task(:install_gem)
+desc 'Install the package as a gem'
+task :install_gem => [:clean, :package] do
+  sh "gem.bat install pkg/*.gem"
+end
+
+remove_task(:ridocs)
+desc "Generate ri locally for testing"
+task :ridocs => :clean do
+  sh "rdoc.bat --ri -o ri ."
+end
+
+remove_task(:publish_docs)
+desc 'Publish RDoc to RubyForge'
+task :publish_docs => [:clean, :docs] do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  with_temporary_rename("doc", "html") {
+    Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, config["username"]).upload
+  }
+end
+
+
+# vim: syntax=Ruby

data/examples/test.rb

@@ -0,0 +1,84 @@
+require "pp"
+require "win32ole"
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
+require "win32ole_pp"
+
+def h(banner)
+  puts
+  puts "-" * 79
+  puts banner
+  puts "-" * 79
+  puts
+end
+
+def olep(banner, obj)
+  puts "========== #{banner} (to_s_original, to_s, inspect, p, pp)"
+  puts obj.to_s_original
+  puts obj.to_s
+  puts obj.inspect
+  p obj
+  pp obj
+end
+
+def arrp(banner, obj)
+  puts "========== #{banner} (p, pp)"
+  pp obj
+end
+
+
+h("WIN32OLE")
+
+current_drive = Dir.pwd[/\A([a-z]):/i, 1]
+fs = WIN32OLE.new("Scripting.FileSystemObject")
+drives = fs.Drives
+drive = fs.Drives.Item(current_drive)
+
+olep("fs", fs)
+olep("drives", drives)
+olep("drive", drive)
+
+
+h("WIN32OLE_METHOD")
+
+m_drives = fs.ole_method("Drives")
+m_create_folder = fs.ole_method("CreateFolder")
+m_delete_folder = fs.ole_method("DeleteFolder")
+
+olep("m_drives", m_drives)
+olep("m_create_folder", m_create_folder)
+olep("m_delete_folder", m_delete_folder)
+
+
+h("WIN32OLE_PARAM")
+
+param_create_folder = m_create_folder.params
+param_delete_folder = m_delete_folder.params
+
+olep("param_create_folder[0]", param_create_folder[0])
+arrp("param_create_folder", param_create_folder)
+
+olep("param_delete_folder[0]", param_delete_folder[0])
+arrp("param_delete_folder", param_delete_folder)
+
+
+h("WIN32OLE_TYPE")
+
+types = WIN32OLE_TYPE.ole_classes("Microsoft Script Control 1.0")
+types.extend(Enumerable)
+constants = types.find{|e| e.name =~ /Constants/ }
+olep("script constants type", constants)
+
+
+h("WIN32OLE_VARIABLE")
+
+vars = constants.variables
+olep("script constants vars[0]", vars[0])
+arrp("script constants vars", vars)
+
+
+h("WIN32OLE_EVENT")
+
+ie = WIN32OLE.new('InternetExplorer.Application')
+event = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents')
+olep("web browser events", event)

data/lib/win32ole_pp/extentions/common.rb

@@ -0,0 +1,61 @@
+module WIN32OLE_PP
+  module Extentions
+    module Common
+
+      module Utils
+        module_function
+
+        def address_banner(subname = nil)
+          if subname
+            "%s:0x%x: %s" % [self.class, object_id, subname]
+          else
+            "%s:0x%x" % [self.class, object_id]
+          end
+        end
+      end
+
+      module PrettyPrint
+        module_function
+
+        def property_group(q, banner, props, value_block = nil)
+          value_block ||= lambda {|q,v| q.pp v }
+          q.group(2, "#<#{banner}", '>') {
+            q.seplist(props, lambda { q.text "," }) {|prop|
+              k, v = prop
+              q.breakable
+              q.text k
+              q.text '='
+              q.group(1) {
+                q.breakable ''
+                value_block.call(q, v)
+              }
+            }
+          }
+        end
+      end
+
+      module ToStringHook
+        def self.included(klass)
+          klass.class_eval {
+            def self.included(klass)
+              klass.send(:alias_method, :to_s_original, :to_s)
+              klass.send(:alias_method, :to_s, :to_s_ext)
+            end
+          }
+        end
+      end
+
+      module InitializeHook
+        def self.included(klass)
+          klass.class_eval {
+            def self.included(klass)
+              klass.send(:alias_method, :initialize_original, :initialize)
+              klass.send(:alias_method, :initialize, :initialize_ext)
+            end
+          }
+        end
+      end
+
+    end
+  end
+end

data/lib/win32ole_pp/extentions/win32ole.rb

@@ -0,0 +1,40 @@
+module WIN32OLE_PP
+  module Extentions
+    module WIN32OLE
+
+      module SmartToString
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::ToStringHook
+
+        def to_s_ext
+          "#<#{address_banner(ole_obj_help.name)}>"
+        rescue
+          to_s_original
+        end
+      end
+
+      module PrettyPrint
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::PrettyPrint
+
+        def pretty_print(q)
+          props = ole_properties.map{|e| [e.name, self[e.name]] rescue nil }.compact
+          property_group(q, address_banner(ole_obj_help.name), props, lambda {|q,v|
+            if ::WIN32OLE === v
+              q.text v.to_s
+            else
+              q.pp v
+            end
+          })
+        end
+
+        def ole_properties
+          ole_get_methods.select{|e| e.params.empty? }.sort_by{|e| e.name }
+        end
+        module_function :ole_properties
+
+      end
+
+    end
+  end
+end

data/lib/win32ole_pp/extentions/win32ole_event.rb

@@ -0,0 +1,38 @@
+module WIN32OLE_PP
+  module Extentions
+    module WIN32OLE_EVENT
+
+      module Initializer
+        include WIN32OLE_PP::Extentions::Common::InitializeHook
+
+        def initialize_ext(ole, event = nil)
+          @ole_class = ole.ole_obj_help.name
+          @event = event
+          initialize_original(ole, event)
+        end
+      end
+
+      module SmartToString
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::ToStringHook
+
+        def to_s_ext
+          "#<%s: %s.%s>" % [address_banner, @ole_class, @event]
+        rescue
+          to_s_original
+        end
+      end
+
+      module PrettyPrint
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::PrettyPrint
+
+        def pretty_print(q)
+          props = [["ole_class", @ole_class], ["event_interface", @event]]
+          property_group(q, address_banner(@event), props)
+        end
+      end
+
+    end
+  end
+end

data/lib/win32ole_pp/extentions/win32ole_method.rb

@@ -0,0 +1,27 @@
+module WIN32OLE_PP
+  module Extentions
+    module WIN32OLE_METHOD
+
+      module SmartToString
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::ToStringHook
+
+        def to_s_ext
+          "#<%s: %s %s(%s)>" % [address_banner, return_type, name, params.map{|e| e.to_s_simple} * ', ']
+        end
+      end
+
+      module PrettyPrint
+        PROPERTIES = (::WIN32OLE_METHOD.instance_methods - Object.instance_methods).sort
+
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::PrettyPrint
+
+        def pretty_print(q)
+          property_group(q, address_banner(name), PROPERTIES.map{|e| [e, send(e)] })
+        end
+      end
+
+    end
+  end
+end

data/lib/win32ole_pp/extentions/win32ole_param.rb

@@ -0,0 +1,44 @@
+module WIN32OLE_PP
+  module Extentions
+    module WIN32OLE_PARAM
+
+      module SmartToString
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::ToStringHook
+
+        def to_s_ext
+          "#<%s: %s>" % [address_banner, to_s_simple]
+        rescue
+          to_s_original
+        end
+
+        def to_s_simple
+          type = []
+          type << "in" if input?
+          type << "out" if output?
+          type << "retval" if retval?
+          type << "optional" if optional?
+          if type.empty?
+            "%s %s" % [ole_type, name]
+          else
+            "[%s] %s %s" % [type * ", ", ole_type, name]
+          end
+        rescue
+          to_s_original
+        end
+      end
+
+      module PrettyPrint
+        PROPERTIES = (::WIN32OLE_PARAM.instance_methods - Object.instance_methods).sort
+
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::PrettyPrint
+
+        def pretty_print(q)
+          property_group(q, address_banner(name), PROPERTIES.map{|e| [e, send(e)] })
+        end
+      end
+
+    end
+  end
+end

data/lib/win32ole_pp/extentions/win32ole_type.rb

@@ -0,0 +1,29 @@
+module WIN32OLE_PP
+  module Extentions
+    module WIN32OLE_TYPE
+
+      module SmartToString
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::ToStringHook
+
+        def to_s_ext
+          "#<#{address_banner(name)}>"
+        rescue
+          to_s_original
+        end
+      end
+
+      module PrettyPrint
+        PROPERTIES = (::WIN32OLE_TYPE.instance_methods - Object.instance_methods).sort
+
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::PrettyPrint
+
+        def pretty_print(q)
+          property_group(q, address_banner(name), PROPERTIES.map{|e| [e, send(e)] })
+        end
+      end
+
+    end
+  end
+end

data/lib/win32ole_pp/extentions/win32ole_variable.rb

@@ -0,0 +1,29 @@
+module WIN32OLE_PP
+  module Extentions
+    module WIN32OLE_VARIABLE
+
+      module SmartToString
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::ToStringHook
+
+        def to_s_ext
+          "#<%s: %s=%s>" % [address_banner, name, value.inspect]
+        rescue
+          to_s_original
+        end
+      end
+
+      module PrettyPrint
+        PROPERTIES = (::WIN32OLE_VARIABLE.instance_methods - Object.instance_methods).sort
+
+        include WIN32OLE_PP::Extentions::Common::Utils
+        include WIN32OLE_PP::Extentions::Common::PrettyPrint
+
+        def pretty_print(q)
+          property_group(q, address_banner(name), PROPERTIES.map{|e| [e, send(e)] })
+        end
+      end
+
+    end
+  end
+end

data/lib/win32ole_pp/extentions.rb

@@ -0,0 +1,28 @@
+require "win32ole"
+
+require "win32ole_pp/extentions/common.rb"
+require "win32ole_pp/extentions/win32ole.rb"
+require "win32ole_pp/extentions/win32ole_type.rb"
+require "win32ole_pp/extentions/win32ole_variable.rb"
+require "win32ole_pp/extentions/win32ole_method.rb"
+require "win32ole_pp/extentions/win32ole_param.rb"
+require "win32ole_pp/extentions/win32ole_event.rb"
+
+module WIN32OLE_PP
+
+  WIN32OLE_CLASSES = [
+    WIN32OLE,
+    WIN32OLE_TYPE,
+    WIN32OLE_VARIABLE,
+    WIN32OLE_METHOD,
+    WIN32OLE_PARAM,
+    WIN32OLE_EVENT,
+  ]
+
+  def self.include_extentions(plugin)
+    WIN32OLE_CLASSES.each do |klass|
+      ext = eval("WIN32OLE_PP::Extentions::#{klass.name}::#{plugin}") rescue nil
+      klass.class_eval { include ext } if ext
+    end
+  end
+end

data/lib/win32ole_pp/init.rb

@@ -0,0 +1 @@
+WIN32OLE_PP::include_extentions(:Initializer)

data/lib/win32ole_pp/pp.rb

@@ -0,0 +1 @@
+WIN32OLE_PP::include_extentions(:PrettyPrint)

data/lib/win32ole_pp/to_s.rb

@@ -0,0 +1 @@
+WIN32OLE_PP::include_extentions(:SmartToString)

data/lib/win32ole_pp/version.rb

@@ -0,0 +1,9 @@
+module WIN32OLE_PP
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/win32ole_pp.rb

@@ -0,0 +1,8 @@
+require "win32ole"
+
+require "win32ole_pp/version.rb"
+require "win32ole_pp/extentions.rb"
+
+require "win32ole_pp/init.rb"
+require "win32ole_pp/to_s.rb"
+require "win32ole_pp/pp.rb"