my_scripts 0.1.5 → 0.1.7

data/HISTORY

@@ -31,3 +31,11 @@
 == 0.1.5 / 2010-04-17
 
 * Debugging wake
+
+== 0.1.6 / 2010-04-17
+
+* Msdn added
+
+== 0.1.7 / 2010-04-29
+
+* Msdn helper extracted - for RubyMine script

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.7

data/bin/msdn

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/my_scripts'
+
+MyScripts::CLI.run :msdn, ARGV

data/lib/my_scripts/cli.rb

@@ -12,8 +12,8 @@ module MyScripts
 
     # Instantiates new CLI(command line interface) and runs script with given name (token)
     # and argv inside new CLI instance
-    def self.run( script_name, argv )
-      new.run script_name, argv
+    def self.run( script_name, argv, argf=ARGF )
+      new.run script_name, argv, argf
     end
 
     # Creates new command line interface
@@ -24,11 +24,11 @@ module MyScripts
     end
 
     # Runs a script with given name (token) and argv inside this CLI instance
-    def run( script_name, argv )
+    def run( script_name, argv, argf=ARGF )
       script = script_class_name(script_name).to_class
       raise ScriptNameError.new("Script #{script_class_name(script_name)} not found") unless script
       
-      script.new(script_name, argv, self).run
+      script.new(script_name, self, argv, argf).run
     end
 
     private

data/lib/my_scripts/script.rb

@@ -2,10 +2,11 @@ module MyScripts
   # Base class for all scripts. Subclass it and override run method with actual
   # work your script will be doing
   class Script
-    def initialize( name, argv, cli )
+    def initialize( name, cli, argv, argf )
       @name = name
-      @argv = argv
       @cli = cli
+      @argv = argv
+      @argf = argf
     end
 
     def version

data/lib/my_scripts/scripts/msdn/msdn_helper.rb

@@ -0,0 +1,149 @@
+# Make sure Strings respond to snake_case (even if this helper is called out of containing lib context)
+# This is needed when this file is required by RubyMine script "msdn_converter.rb"
+unless "".respond_to? :snake_case
+  class String
+    def snake_case
+      self.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+              gsub(/([a-z\d])([A-Z])/, '\1_\2').
+              tr("-", "_").downcase
+    end
+  end
+end
+
+module MyScripts
+
+  module MsdnHelper
+
+    def self.convert(text, page_margin=6, page_width=110)
+      # Removing extra lines and spaces
+      text.gsub! /(^\s*|\r)/m, ""
+
+      # Extracting original function/struct syntax (definition)
+      syntax = text[/^Syntax.*?(}|\)).*?;/m]
+
+      if syntax =~ /typedef struct/  # this is a struct description
+        type = :struct
+
+        name = syntax.match(/}\s*([\w*]*)/m)[1] # first word after }
+        params = syntax.scan(/\s(\w*)\s           # member type is a first word, followed by whitespace
+                                (\*?[\w]*)        # followed by member name
+                                (?:\[([\w]*)\])?  # POSSIBLY followed by [array dimension] ( it may be number or CONST)
+                                (?:\s*?;)/mx)     # ending with a semi-colon
+
+        # Creating different representations of struct syntax
+        ffi_params = params.map{|p| ":#{p[1].snake_case}, " + (p[2] ? "[:#{p[0]}, #{p[2]}]" : ":#{p[0]}")}.
+                join(",\n         ")
+        ffi_syntax = "\nclass #{name} < FFI::Struct\n  layout #{ffi_params}\nend\n"
+
+        original_params = params.map{|p| "#{p[0]} #{p[1]}" + (p[2] ? "[#{p[2]}]" : "")}.join("; ")
+        original_syntax = "[*Typedef*] struct { #{original_params} } #{name};"
+
+      elsif syntax =~ /.\(.*\);/m  # this is a function descriptions
+        type = :function
+
+        returns, name = syntax.match(/(\w*\*?|\w*\*? \w*\*?) (\w*)\(/m)[1..2]
+        params = syntax.scan(/\s(\w*\*?) (\w*)(?:,|\s*\);)/m)
+
+        # Creating different representations of method(function) syntax
+        ffi_params = params.map{|p| ":" + p.first}.join(", ")
+        ffi_returns = returns =~ /BOOL/ ? ":int8, boolean: true" : ":#{returns}"
+        ffi_syntax = "function :#{name}, [#{ffi_params}], #{ffi_returns}"
+
+        original_params = params.empty? ? 'void' : params.map{|p| p.join(" ")}.join(", ")
+        original_syntax = "[*Syntax*] #{returns} #{name}( #{original_params} );"
+
+        call_syntax = "success = #{name.snake_case}(#{params.map{|p| p.last.snake_case}.join(", ")})"
+        snake_syntax = "success = #{name.snake_case}(#{params.map{|p| "#{p.last.snake_case}=0"}.join(", ")})"
+        camel_syntax = "success = #{name}(#{params.map{|p| "#{p.last.snake_case}=0"}.join(", ")})"
+
+        # Adding Enhanced API description and :call-seq: directive
+        text += "\n---\n<b>Enhanced (snake_case) API: </b>"
+        text += "\n\n:call-seq:\n #{call_syntax}\n \n"
+
+      else
+        type = :unknown
+        return 'Unknown syntax. Only functions and structs are converted.'
+      end
+
+      # Formatting params/members into two column table
+      params.each {|p| text.gsub!(Regexp.new("^#{p[1]}\n"), "#{p[1]}:: ")}
+
+      # Replacing MSDN idioms with RDoc ones, cutting some slack, adding extra info
+      replace = {
+              /^Syntax.*?(}|\)).*?;/m => "\n#{original_syntax}",
+              /^Parameters\s*/m => "\n",
+              /^Members\s*/m => "\n",
+              /^Return Value\n\s*/m => "\n*Returns*:: ",
+              /^Remarks\s*/m => "---\n*Remarks*:\n",
+              }
+      replace.each {|from, to| text.gsub!( from, to)}
+
+      # Chopping long lines into smaller ones (while keeping indent)
+      text_width = page_width - page_margin - 2
+      lines = []
+      text.split("\n").each do |line|
+        list_label = line.match(/:: |^\[.*?\] /)
+        indent = list_label ? list_label.end(0) : 0
+
+        first_pattern = Regexp.new ".{1,#{text_width}}(?: |$)"
+        chunk_pattern = Regexp.new ".{1,#{text_width - indent}}(?: |$)"
+        if line.length < text_width || indent > text_width || !(first_chunk = line.match(first_pattern))
+          lines << line
+        else
+          lines << first_chunk[0]
+          line[first_chunk.end(0)..-1].scan(chunk_pattern).each do |chunk|
+            lines << " " * indent + chunk
+          end
+        end
+      end
+      text = lines.join("\n")
+
+      # Inserting initial white spaces with comment sign
+      tab = " " * page_margin
+      text.gsub! /^(?!##)/m, tab + "# "
+
+      # Closing off with ffi syntax definition
+      text += "\n#{tab}#{ffi_syntax}"
+
+      if type == :function
+        # Prepending function with RDoc meta-method hint
+        text = "#{tab}##\n#{text}"
+
+        # Extracting description
+        description = text[Regexp.new "(?<=(?:^F|f)unction\\s).{1,#{text_width}}(?: |$)"]
+
+        # Adding Rspec examples
+        text += %Q[
+
+    describe "##{name.snake_case}" do
+      spec{ use{ #{camel_syntax} }}
+      spec{ use{ #{snake_syntax} }}
+
+      it "original api #{description}" do
+        pending
+        #{camel_syntax}
+      end
+
+      it "snake_case api #{description}" do
+        pending
+        #{snake_syntax}
+      end
+
+    end # describe #{name.snake_case}\n]
+      end
+
+      text
+    end
+
+  end
+end
+
+# if this script file is called directly, convert given file (default test.txt) to stdout
+if __FILE__ == $0
+  test_file = ARGV[0] || 'test.txt' # File.expand_path(File.dirname(__FILE__) + '/test')
+  File.open(test_file) do |f|
+    puts MyScripts::MsdnHelper.convert f.readlines.join("\n")
+  end
+end
+
+

data/lib/my_scripts/scripts/msdn.rb

@@ -0,0 +1,19 @@
+module MyScripts
+
+  # This script converts text copied from MSND function or struct description
+  # into RDoc-compatible comment format. It also adds function and spec stub
+  # (both are used by Win gem). This reduces dramatically amount of manual work
+  # needed to convert MSDN info into RDoc
+  #
+  class Msdn < Script
+    VERSION = '0.0.1'
+
+    def run
+      usage "[in_file] File containing MSDN text (reads from stdin if no infile)" if @argv.size > 1
+
+      puts MsdnHelper.convert @argf.read
+    end
+
+
+  end
+end

data/spec/files/msdn/ddeinit_in.txt

@@ -0,0 +1,100 @@
+DdeInitialize Function
+
+--------------------------------------------------------------------------------
+
+The DdeInitialize function registers an application with the Dynamic Data Exchange Management Library (DDEML). An application must call this function before calling any other Dynamic Data Exchange Management Library (DDEML) function.
+
+Syntax
+
+UINT DdeInitialize(          LPDWORD pidInst,
+    PFNCALLBACK pfnCallback,
+    DWORD afCmd,
+    DWORD ulRes
+);
+Parameters
+
+pidInst
+[in, out] Pointer to the application instance identifier. At initialization, this parameter should point to 0. If the function succeeds, this parameter points to the instance identifier for the application. This value should be passed as the idInst parameter in all other DDEML functions that require it. If an application uses multiple instances of the DDEML dynamic-link library (DLL), the application should provide a different callback function for each instance.
+If pidInst points to a nonzero value, reinitialization of the DDEML is implied. In this case, pidInst must point to a valid application-instance identifier.
+
+pfnCallback
+[in] Pointer to the application-defined Dynamic Data Exchange (DDE) callback function. This function processes DDE transactions sent by the system. For more information, see the DdeCallback callback function.
+afCmd
+[in] Specifies a set of APPCMD_, CBF_, and MF_ flags. The APPCMD_ flags provide special instructions to DdeInitialize. The CBF_ flags specify filters that prevent specific types of transactions from reaching the callback function. The MF_ flags specify the types of DDE activity that a DDE monitoring application monitors. Using these flags enhances the performance of a DDE application by eliminating unnecessary calls to the callback function.
+This parameter can be one or more of the following values.
+
+APPCLASS_MONITOR
+Makes it possible for the application to monitor DDE activity in the system. This flag is for use by DDE monitoring applications. The application specifies the types of DDE activity to monitor by combining one or more monitor flags with the APPCLASS_MONITOR flag. For details, see the following Remarks section.
+APPCLASS_STANDARD
+Registers the application as a standard (nonmonitoring) DDEML application.
+APPCMD_CLIENTONLY
+Prevents the application from becoming a server in a DDE conversation. The application can only be a client. This flag reduces consumption of resources by the DDEML. It includes the functionality of the CBF_FAIL_ALLSVRXACTIONS flag.
+APPCMD_FILTERINITS
+Prevents the DDEML from sending XTYP_CONNECT and XTYP_WILDCONNECT transactions to the application until the application has created its string handles and registered its service names or has turned off filtering by a subsequent call to the DdeNameService or DdeInitialize function. This flag is always in effect when an application calls DdeInitialize for the first time, regardless of whether the application specifies the flag. On subsequent calls to DdeInitialize, not specifying this flag turns off the application's service-name filters, but specifying it turns on the application's service name filters.
+CBF_FAIL_ALLSVRXACTIONS
+Prevents the callback function from receiving server transactions. The system returns DDE_FNOTPROCESSED to each client that sends a transaction to this application. This flag is equivalent to combining all CBF_FAIL_ flags.
+CBF_FAIL_ADVISES
+Prevents the callback function from receiving XTYP_ADVSTART and XTYP_ADVSTOP transactions. The system returns DDE_FNOTPROCESSED to each client that sends an XTYP_ADVSTART or XTYP_ADVSTOP transaction to the server.
+CBF_FAIL_CONNECTIONS
+Prevents the callback function from receiving XTYP_CONNECT and XTYP_WILDCONNECT transactions.
+CBF_FAIL_EXECUTES
+Prevents the callback function from receiving XTYP_EXECUTE transactions. The system returns DDE_FNOTPROCESSED to a client that sends an XTYP_EXECUTE transaction to the server.
+CBF_FAIL_POKES
+Prevents the callback function from receiving XTYP_POKE transactions. The system returns DDE_FNOTPROCESSED to a client that sends an XTYP_POKE transaction to the server.
+CBF_FAIL_REQUESTS
+Prevents the callback function from receiving XTYP_REQUEST transactions. The system returns DDE_FNOTPROCESSED to a client that sends an XTYP_REQUEST transaction to the server.
+CBF_FAIL_SELFCONNECTIONS
+Prevents the callback function from receiving XTYP_CONNECT transactions from the application's own instance. This flag prevents an application from establishing a DDE conversation with its own instance. An application should use this flag if it needs to communicate with other instances of itself but not with itself.
+CBF_SKIP_ALLNOTIFICATIONS
+Prevents the callback function from receiving any notifications. This flag is equivalent to combining all CBF_SKIP_ flags.
+CBF_SKIP_CONNECT_CONFIRMS
+Prevents the callback function from receiving XTYP_CONNECT_CONFIRM notifications.
+CBF_SKIP_DISCONNECTS
+Prevents the callback function from receiving XTYP_DISCONNECT notifications.
+CBF_SKIP_REGISTRATIONS
+Prevents the callback function from receiving XTYP_REGISTER notifications.
+CBF_SKIP_UNREGISTRATIONS
+Prevents the callback function from receiving XTYP_UNREGISTER notifications.
+MF_CALLBACKS
+Notifies the callback function whenever a transaction is sent to any DDE callback function in the system.
+MF_CONV
+Notifies the callback function whenever a conversation is established or terminated.
+MF_ERRORS
+Notifies the callback function whenever a DDE error occurs.
+MF_HSZ_INFO
+Notifies the callback function whenever a DDE application creates, frees, or increments the usage count of a string handle or whenever a string handle is freed as a result of a call to the DdeUninitialize function.
+MF_LINKS
+Notifies the callback function whenever an advise loop is started or ended.
+MF_POSTMSGS
+Notifies the callback function whenever the system or an application posts a DDE message.
+MF_SENDMSGS
+Notifies the callback function whenever the system or an application sends a DDE message.
+ulRes
+Reserved; must be set to zero.
+Return Value
+
+
+If the function succeeds, the return value is DMLERR_NO_ERROR.
+
+If the function fails, the return value is one of the following values:
+
+
+DMLERR_DLL_USAGE
+DMLERR_INVALIDPARAMETER
+DMLERR_SYS_ERROR
+
+
+
+Remarks
+
+An application that uses multiple instances of the DDEML must not pass DDEML objects between instances.
+
+A DDE monitoring application should not attempt to perform DDE operations (establish conversations, issue transactions, and so on) within the context of the same application instance.
+
+A synchronous transaction fails with a DMLERR_REENTRANCY error if any instance of the same task has a synchronous transaction already in progress.
+
+The CBF_FAIL_ALLSVRXACTIONS flag causes the DDEML to filter all server transactions and can be changed by a subsequent call to DdeInitialize. The APPCMD_CLIENTONLY flag prevents the DDEML from creating key resources for the server and cannot be changed by a subsequent call to DdeInitialize.
+
+There is an ANSI version and a Unicode version of DdeInitialize. The version called determines the type of the window procedures used to control DDE conversations (ANSI or Unicode), and the default value for the iCodePage member of the CONVCONTEXT structure (CP_WINANSI or CP_WINUNICODE).
+
+Windows 95/98/Me: DdeInitializeW is supported by the Microsoft Layer for Unicode (MSLU). To use this, you must add certain files to your application, as outlined in Microsoft Layer for Unicode on Windows 95/98/Me Systems .

data/spec/files/msdn/ddeinit_out.txt

@@ -0,0 +1,145 @@
+      ##
+      # DdeInitialize Function
+      # --------------------------------------------------------------------------------
+      # The DdeInitialize function registers an application with the Dynamic Data Exchange Management Library 
+      # (DDEML). An application must call this function before calling any other Dynamic Data Exchange 
+      # Management Library (DDEML) function.
+      # 
+      # [*Syntax*] UINT DdeInitialize( LPDWORD pidInst, PFNCALLBACK pfnCallback, DWORD afCmd, DWORD ulRes );
+      # 
+      # pidInst:: [in, out] Pointer to the application instance identifier. At initialization, this parameter 
+      #           should point to 0. If the function succeeds, this parameter points to the instance 
+      #           identifier for the application. This value should be passed as the idInst parameter in all 
+      #           other DDEML functions that require it. If an application uses multiple instances of the 
+      #           DDEML dynamic-link library (DLL), the application should provide a different callback 
+      #           function for each instance.
+      # If pidInst points to a nonzero value, reinitialization of the DDEML is implied. In this case, pidInst 
+      # must point to a valid application-instance identifier.
+      # pfnCallback:: [in] Pointer to the application-defined Dynamic Data Exchange (DDE) callback function. 
+      #               This function processes DDE transactions sent by the system. For more information, see 
+      #               the DdeCallback callback function.
+      # afCmd:: [in] Specifies a set of APPCMD_, CBF_, and MF_ flags. The APPCMD_ flags provide special 
+      #         instructions to DdeInitialize. The CBF_ flags specify filters that prevent specific types of 
+      #         transactions from reaching the callback function. The MF_ flags specify the types of DDE 
+      #         activity that a DDE monitoring application monitors. Using these flags enhances the 
+      #         performance of a DDE application by eliminating unnecessary calls to the callback function.
+      # This parameter can be one or more of the following values.
+      # APPCLASS_MONITOR
+      # Makes it possible for the application to monitor DDE activity in the system. This flag is for use by 
+      # DDE monitoring applications. The application specifies the types of DDE activity to monitor by 
+      # combining one or more monitor flags with the APPCLASS_MONITOR flag. For details, see the following 
+      # Remarks section.
+      # APPCLASS_STANDARD
+      # Registers the application as a standard (nonmonitoring) DDEML application.
+      # APPCMD_CLIENTONLY
+      # Prevents the application from becoming a server in a DDE conversation. The application can only be a 
+      # client. This flag reduces consumption of resources by the DDEML. It includes the functionality of the 
+      # CBF_FAIL_ALLSVRXACTIONS flag.
+      # APPCMD_FILTERINITS
+      # Prevents the DDEML from sending XTYP_CONNECT and XTYP_WILDCONNECT transactions to the application 
+      # until the application has created its string handles and registered its service names or has turned 
+      # off filtering by a subsequent call to the DdeNameService or DdeInitialize function. This flag is 
+      # always in effect when an application calls DdeInitialize for the first time, regardless of whether the 
+      # application specifies the flag. On subsequent calls to DdeInitialize, not specifying this flag turns 
+      # off the application's service-name filters, but specifying it turns on the application's service name 
+      # filters.
+      # CBF_FAIL_ALLSVRXACTIONS
+      # Prevents the callback function from receiving server transactions. The system returns 
+      # DDE_FNOTPROCESSED to each client that sends a transaction to this application. This flag is equivalent 
+      # to combining all CBF_FAIL_ flags.
+      # CBF_FAIL_ADVISES
+      # Prevents the callback function from receiving XTYP_ADVSTART and XTYP_ADVSTOP transactions. The system 
+      # returns DDE_FNOTPROCESSED to each client that sends an XTYP_ADVSTART or XTYP_ADVSTOP transaction to 
+      # the server.
+      # CBF_FAIL_CONNECTIONS
+      # Prevents the callback function from receiving XTYP_CONNECT and XTYP_WILDCONNECT transactions.
+      # CBF_FAIL_EXECUTES
+      # Prevents the callback function from receiving XTYP_EXECUTE transactions. The system returns 
+      # DDE_FNOTPROCESSED to a client that sends an XTYP_EXECUTE transaction to the server.
+      # CBF_FAIL_POKES
+      # Prevents the callback function from receiving XTYP_POKE transactions. The system returns 
+      # DDE_FNOTPROCESSED to a client that sends an XTYP_POKE transaction to the server.
+      # CBF_FAIL_REQUESTS
+      # Prevents the callback function from receiving XTYP_REQUEST transactions. The system returns 
+      # DDE_FNOTPROCESSED to a client that sends an XTYP_REQUEST transaction to the server.
+      # CBF_FAIL_SELFCONNECTIONS
+      # Prevents the callback function from receiving XTYP_CONNECT transactions from the application's own 
+      # instance. This flag prevents an application from establishing a DDE conversation with its own 
+      # instance. An application should use this flag if it needs to communicate with other instances of 
+      # itself but not with itself.
+      # CBF_SKIP_ALLNOTIFICATIONS
+      # Prevents the callback function from receiving any notifications. This flag is equivalent to combining 
+      # all CBF_SKIP_ flags.
+      # CBF_SKIP_CONNECT_CONFIRMS
+      # Prevents the callback function from receiving XTYP_CONNECT_CONFIRM notifications.
+      # CBF_SKIP_DISCONNECTS
+      # Prevents the callback function from receiving XTYP_DISCONNECT notifications.
+      # CBF_SKIP_REGISTRATIONS
+      # Prevents the callback function from receiving XTYP_REGISTER notifications.
+      # CBF_SKIP_UNREGISTRATIONS
+      # Prevents the callback function from receiving XTYP_UNREGISTER notifications.
+      # MF_CALLBACKS
+      # Notifies the callback function whenever a transaction is sent to any DDE callback function in the 
+      # system.
+      # MF_CONV
+      # Notifies the callback function whenever a conversation is established or terminated.
+      # MF_ERRORS
+      # Notifies the callback function whenever a DDE error occurs.
+      # MF_HSZ_INFO
+      # Notifies the callback function whenever a DDE application creates, frees, or increments the usage 
+      # count of a string handle or whenever a string handle is freed as a result of a call to the 
+      # DdeUninitialize function.
+      # MF_LINKS
+      # Notifies the callback function whenever an advise loop is started or ended.
+      # MF_POSTMSGS
+      # Notifies the callback function whenever the system or an application posts a DDE message.
+      # MF_SENDMSGS
+      # Notifies the callback function whenever the system or an application sends a DDE message.
+      # ulRes:: Reserved; must be set to zero.
+      # 
+      # *Returns*:: If the function succeeds, the return value is DMLERR_NO_ERROR.
+      # If the function fails, the return value is one of the following values:
+      # DMLERR_DLL_USAGE
+      # DMLERR_INVALIDPARAMETER
+      # DMLERR_SYS_ERROR
+      # ---
+      # *Remarks*:
+      # An application that uses multiple instances of the DDEML must not pass DDEML objects between 
+      # instances.
+      # A DDE monitoring application should not attempt to perform DDE operations (establish conversations, 
+      # issue transactions, and so on) within the context of the same application instance.
+      # A synchronous transaction fails with a DMLERR_REENTRANCY error if any instance of the same task has a 
+      # synchronous transaction already in progress.
+      # The CBF_FAIL_ALLSVRXACTIONS flag causes the DDEML to filter all server transactions and can be changed 
+      # by a subsequent call to DdeInitialize. The APPCMD_CLIENTONLY flag prevents the DDEML from creating key 
+      # resources for the server and cannot be changed by a subsequent call to DdeInitialize.
+      # There is an ANSI version and a Unicode version of DdeInitialize. The version called determines the 
+      # type of the window procedures used to control DDE conversations (ANSI or Unicode), and the default 
+      # value for the iCodePage member of the CONVCONTEXT structure (CP_WINANSI or CP_WINUNICODE).
+      # Windows 95/98/Me: DdeInitializeW is supported by the Microsoft Layer for Unicode (MSLU). To use this, 
+      # you must add certain files to your application, as outlined in Microsoft Layer for Unicode on Windows 
+      # 95/98/Me Systems .
+      # 
+      # ---
+      # <b>Enhanced (snake_case) API: </b>
+      # 
+      # :call-seq:
+      #  success = dde_initialize(pid_inst, pfn_callback, af_cmd, ul_res)
+      #  
+      function :DdeInitialize, [:LPDWORD, :PFNCALLBACK, :DWORD, :DWORD], :UINT
+
+    describe "#dde_initialize" do
+      spec{ use{ success = DdeInitialize(pid_inst=0, pfn_callback=0, af_cmd=0, ul_res=0) }}
+      spec{ use{ success = dde_initialize(pid_inst=0, pfn_callback=0, af_cmd=0, ul_res=0) }}
+
+      it "original api registers an application with the Dynamic Data Exchange Management Library " do
+        pending
+        success = DdeInitialize(pid_inst=0, pfn_callback=0, af_cmd=0, ul_res=0)
+      end
+
+      it "snake_case api registers an application with the Dynamic Data Exchange Management Library " do
+        pending
+        success = dde_initialize(pid_inst=0, pfn_callback=0, af_cmd=0, ul_res=0)
+      end
+
+    end # describe dde_initialize

data/spec/files/msdn/msg_in.txt

@@ -0,0 +1,27 @@
+The MSG structure contains message information from a thread's message queue.
+
+Syntax
+
+typedef struct {
+    HWND hwnd;
+    UINT message;
+    WPARAM wParam;
+    LPARAM lParam;
+    DWORD time;
+    POINT pt;
+} MSG, *PMSG;
+Members
+
+hwnd
+Handle to the window whose window procedure receives the message. hwnd is NULL when the message is a thread message.
+message
+Specifies the message identifier. Applications can only use the low word; the high word is reserved by the system.
+wParam
+Specifies additional information about the message. The exact meaning depends on the value of the message member.
+lParam
+Specifies additional information about the message. The exact meaning depends on the value of the message member.
+time
+Specifies the time at which the message was posted.
+pt
+Specifies the cursor position, in screen coordinates, when the message was posted.
+--------

data/spec/files/msdn/msg_out.txt

@@ -0,0 +1,25 @@
+      # The MSG structure contains message information from a thread's message queue.
+      # 
+      # [*Typedef*] struct { HWND hwnd; UINT message; WPARAM wParam; LPARAM lParam; DWORD time; POINT pt } 
+      #             MSG;
+      # 
+      # hwnd:: Handle to the window whose window procedure receives the message. hwnd is NULL when the message 
+      #        is a thread message.
+      # message:: Specifies the message identifier. Applications can only use the low word; the high word is 
+      #           reserved by the system.
+      # wParam:: Specifies additional information about the message. The exact meaning depends on the value of 
+      #          the message member.
+      # lParam:: Specifies additional information about the message. The exact meaning depends on the value of 
+      #          the message member.
+      # time:: Specifies the time at which the message was posted.
+      # pt:: Specifies the cursor position, in screen coordinates, when the message was posted.
+      # --------
+      
+class MSG < FFI::Struct
+  layout :hwnd, :HWND,
+         :message, :UINT,
+         :w_param, :WPARAM,
+         :l_param, :LPARAM,
+         :time, :DWORD,
+         :pt, :POINT
+end

data/spec/files/msdn/struct1_in.txt

@@ -0,0 +1,41 @@
+    The MONCONVSTRUCT structure contains information about a Dynamic Data Exchange (DDE) conversation. A DDE monitoring application can use this structure to obtain information about a conversation that has been established or has terminated.
+
+    Syntax
+
+    typedef struct tagMONCONVSTRUCT {
+        UINT cb;
+        BOOL fConnect;
+        DWORD dwTime;
+        HANDLE hTask;
+        HSZ hszSvc;
+        HSZ hszTopic;
+        HCONV hConvClient;
+        HCONV hConvServer;
+    } MONCONVSTRUCT, *PMONCONVSTRUCT;
+    Members
+
+    cb
+    Specifies the structure's size, in bytes.
+    fConnect
+    Indicates whether the conversation is currently established. A value of TRUE indicates the conversation is established; FALSE indicates it is not.
+    dwTime
+    Specifies the Windows time at which the conversation was established or terminated. Windows time is the number of milliseconds that have elapsed since the system was booted.
+    hTask
+    Handle to a task (application instance) that is a partner in the conversation.
+    hszSvc
+    Handle to the service name on which the conversation is established.
+    hszTopic
+    Handle to the topic name on which the conversation is established.
+    hConvClient
+    Handle to the client conversation.
+    hConvServer
+    Handle to the server conversation.
+    Remarks
+
+    Because string handles are local to the process, the hszSvc and hszTopic members are global atoms. Similarly, conversation handles are local to the instance; therefore, the hConvClient and hConvServer members are window handles.
+
+    The hConvClient and hConvServer members of the MONCONVSTRUCT structure do not hold the same value as would be seen by the applications engaged in the conversation. Instead, they hold a globally unique pair of values that identify the conversation.
+
+    Structure Information
+
+    Header Declared in Ddeml.h, include Windows.h

data/spec/files/msdn/struct1_out.txt

@@ -0,0 +1,38 @@
+      # The MONCONVSTRUCT structure contains information about a Dynamic Data Exchange (DDE) conversation. A 
+      # DDE monitoring application can use this structure to obtain information about a conversation that has 
+      # been established or has terminated.
+      # 
+      # [*Typedef*] struct { UINT cb; BOOL fConnect; DWORD dwTime; HANDLE hTask; HSZ hszSvc; HSZ hszTopic; 
+      #             HCONV hConvClient; HCONV hConvServer } MONCONVSTRUCT;
+      # 
+      # cb:: Specifies the structure's size, in bytes.
+      # fConnect:: Indicates whether the conversation is currently established. A value of TRUE indicates the 
+      #            conversation is established; FALSE indicates it is not.
+      # dwTime:: Specifies the Windows time at which the conversation was established or terminated. Windows 
+      #          time is the number of milliseconds that have elapsed since the system was booted.
+      # hTask:: Handle to a task (application instance) that is a partner in the conversation.
+      # hszSvc:: Handle to the service name on which the conversation is established.
+      # hszTopic:: Handle to the topic name on which the conversation is established.
+      # hConvClient:: Handle to the client conversation.
+      # hConvServer:: Handle to the server conversation.
+      # ---
+      # *Remarks*:
+      # Because string handles are local to the process, the hszSvc and hszTopic members are global atoms. 
+      # Similarly, conversation handles are local to the instance; therefore, the hConvClient and hConvServer 
+      # members are window handles.
+      # The hConvClient and hConvServer members of the MONCONVSTRUCT structure do not hold the same value as 
+      # would be seen by the applications engaged in the conversation. Instead, they hold a globally unique 
+      # pair of values that identify the conversation.
+      # Structure Information
+      # Header Declared in Ddeml.h, include Windows.h
+      
+class MONCONVSTRUCT < FFI::Struct
+  layout :cb, :UINT,
+         :f_connect, :BOOL,
+         :dw_time, :DWORD,
+         :h_task, :HANDLE,
+         :hsz_svc, :HSZ,
+         :hsz_topic, :HSZ,
+         :h_conv_client, :HCONV,
+         :h_conv_server, :HCONV
+end

data/spec/files/msdn/struct_in.txt

@@ -0,0 +1,57 @@
+MONCBSTRUCT Structure
+
+--------------------------------------------------------------------------------
+
+The MONCBSTRUCT structure contains information about the current Dynamic Data Exchange (DDE) transaction. A DDE debugging application can use this structure when monitoring transactions that the system passes to the DDE callback functions of other applications.
+
+Syntax
+
+typedef struct tagMONCBSTRUCT {
+    UINT cb;
+    DWORD dwTime;
+    HANDLE hTask;
+    DWORD dwRet;
+    UINT wType;
+    UINT wFmt;
+    HCONV hConv;
+    HSZ hsz1;
+    HSZ hsz2;
+    HDDEDATA hData;
+    ULONG_PTR dwData1;
+    ULONG_PTR dwData2;
+    CONVCONTEXT cc;
+    DWORD cbData;
+    DWORD Data[8];
+} MONCBSTRUCT, *PMONCBSTRUCT;
+Members
+
+cb
+Specifies the structure's size, in bytes.
+dwTime
+Specifies the Windows time at which the transaction occurred. Windows time is the number of milliseconds that have elapsed since the system was booted.
+hTask
+Handle to the task (application instance) containing the DDE callback function that received the transaction.
+dwRet
+Specifies the value returned by the DDE callback function that processed the transaction.
+wType
+Specifies the transaction type.
+wFmt
+Specifies the format of the data exchanged (if any) during the transaction.
+hConv
+Handle to the conversation in which the transaction took place.
+hsz1
+Handle to a string.
+hsz2
+Handle to a string.
+hData
+Handle to the data exchanged (if any) during the transaction.
+dwData1
+Specifies additional data.
+dwData2
+Specifies additional data.
+cc
+Specifies a CONVCONTEXT structure containing language information used to share data in different languages.
+cbData
+Specifies the amount, in bytes, of data being passed with the transaction. This value can be more than 32 bytes.
+Data
+Contains the first 32 bytes of data being passed with the transaction (8 * sizeof(DWORD)).

data/spec/files/msdn/struct_out.txt

@@ -0,0 +1,47 @@
+      # MONCBSTRUCT Structure
+      # --------------------------------------------------------------------------------
+      # The MONCBSTRUCT structure contains information about the current Dynamic Data Exchange (DDE) 
+      # transaction. A DDE debugging application can use this structure when monitoring transactions that the 
+      # system passes to the DDE callback functions of other applications.
+      # 
+      # [*Typedef*] struct { UINT cb; DWORD dwTime; HANDLE hTask; DWORD dwRet; UINT wType; UINT wFmt; HCONV 
+      #             hConv; HSZ hsz1; HSZ hsz2; HDDEDATA hData; ULONG_PTR dwData1; ULONG_PTR dwData2; 
+      #             CONVCONTEXT cc; DWORD cbData; DWORD Data[8] } MONCBSTRUCT;
+      # 
+      # cb:: Specifies the structure's size, in bytes.
+      # dwTime:: Specifies the Windows time at which the transaction occurred. Windows time is the number of 
+      #          milliseconds that have elapsed since the system was booted.
+      # hTask:: Handle to the task (application instance) containing the DDE callback function that received 
+      #         the transaction.
+      # dwRet:: Specifies the value returned by the DDE callback function that processed the transaction.
+      # wType:: Specifies the transaction type.
+      # wFmt:: Specifies the format of the data exchanged (if any) during the transaction.
+      # hConv:: Handle to the conversation in which the transaction took place.
+      # hsz1:: Handle to a string.
+      # hsz2:: Handle to a string.
+      # hData:: Handle to the data exchanged (if any) during the transaction.
+      # dwData1:: Specifies additional data.
+      # dwData2:: Specifies additional data.
+      # cc:: Specifies a CONVCONTEXT structure containing language information used to share data in different 
+      #      languages.
+      # cbData:: Specifies the amount, in bytes, of data being passed with the transaction. This value can be 
+      #          more than 32 bytes.
+      # Data:: Contains the first 32 bytes of data being passed with the transaction (8 * sizeof(DWORD)).
+      
+class MONCBSTRUCT < FFI::Struct
+  layout :cb, :UINT,
+         :dw_time, :DWORD,
+         :h_task, :HANDLE,
+         :dw_ret, :DWORD,
+         :w_type, :UINT,
+         :w_fmt, :UINT,
+         :h_conv, :HCONV,
+         :hsz_1, :HSZ,
+         :hsz_2, :HSZ,
+         :h_data, :HDDEDATA,
+         :dw_data_1, :ULONG_PTR,
+         :dw_data_2, :ULONG_PTR,
+         :cc, :CONVCONTEXT,
+         :cb_data, :DWORD,
+         :data, [:DWORD, 8]
+end

data/spec/my_scripts/scripts/msdn/msdn_helper_spec.rb

@@ -0,0 +1,2 @@
+# Delegation (for autospec)
+require 'my_scripts/scripts/msdn_spec'

data/spec/my_scripts/scripts/msdn_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'my_scripts/scripts/shared'
+
+module MyScriptsTest
+
+  describe MyScripts::Msdn do
+    before(:each) do
+      @name  = 'msdn'
+    end
+
+    context 'With explicit infile, no outfile' do
+
+      it 'reads from infile, writes to stdout' do
+        test_files(@name).each do |infile, outfile|
+          create_cli
+          stdout_should_receive outfile.readlines.map(&:chomp).join("\n") + "\n"
+          cli "#{@name} #{infile}", infile
+        end
+      end
+    end
+
+    it 'reads from temp file' do
+      text = test_files(@name)[1].first.read
+      temp_file = File.expand_path('/tmp/msdn_temp_file')
+      File.open(temp_file, 'w') do |f| f.write(text) end
+
+      lambda{@changed_text = `msdn /tmp/msdn_temp_file`}.should_not raise_error
+      # puts "\n\nResult: #{@changed_text}"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -23,10 +23,10 @@ module MyScriptsTest
     @cli = MyScripts::CLI.new(@stdin, @stdout, @kernel)
   end
 
-  def cli(command_line)
+  def cli(command_line, argf=ARGF)
     raise "Command line should be non-empty String" unless command_line.respond_to?(:split) && command_line != ''
     argv = command_line.split(' ')
-    @cli.run argv.shift.to_sym, argv
+    @cli.run argv.shift.to_sym, argv, argf
   end
 
   # Sets expectation for Kernel to receive system call with specific messages/patterns
@@ -56,4 +56,20 @@ module MyScriptsTest
     end
   end
 
+  # Lists files of specific type
+  def test_files(dir)
+
+    files_dir = Pathname(__FILE__).dirname + 'files' + dir
+    infiles_glob = (files_dir + '*_in.txt').to_s
+    outfiles_glob = (files_dir + '*_out.txt').to_s
+    infiles = Pathname.glob(infiles_glob)
+    outfiles = Pathname.glob(outfiles_glob)
+
+    if infiles.size == outfiles.size
+      infiles.zip(outfiles)
+    else
+      nil
+    end
+  end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 7
+  version: 0.1.7
 platform: ruby
 authors: 
 - arvicco
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-17 00:00:00 +04:00
+date: 2010-04-29 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,7 @@ executables:
 - citi
 - gitto
 - jew
+- msdn
 - rabbit
 - wake
 extensions: []
@@ -63,6 +64,7 @@ files:
 - bin/citi
 - bin/gitto
 - bin/jew
+- bin/msdn
 - bin/rabbit
 - bin/wake
 - lib/my_scripts/cli.rb
@@ -72,11 +74,23 @@ files:
 - lib/my_scripts/scripts/citi.rb
 - lib/my_scripts/scripts/gitto.rb
 - lib/my_scripts/scripts/jew.rb
+- lib/my_scripts/scripts/msdn/msdn_helper.rb
+- lib/my_scripts/scripts/msdn.rb
 - lib/my_scripts/scripts/rabbit.rb
 - lib/my_scripts/scripts/wake.rb
 - lib/my_scripts.rb
+- spec/files/msdn/ddeinit_in.txt
+- spec/files/msdn/ddeinit_out.txt
+- spec/files/msdn/msg_in.txt
+- spec/files/msdn/msg_out.txt
+- spec/files/msdn/struct1_in.txt
+- spec/files/msdn/struct1_out.txt
+- spec/files/msdn/struct_in.txt
+- spec/files/msdn/struct_out.txt
 - spec/my_scripts/extensions_spec.rb
 - spec/my_scripts/scripts/gitto_spec.rb
+- spec/my_scripts/scripts/msdn/msdn_helper_spec.rb
+- spec/my_scripts/scripts/msdn_spec.rb
 - spec/my_scripts/scripts/shared.rb
 - spec/my_scripts_spec.rb
 - spec/spec.opts
@@ -132,8 +146,18 @@ signing_key:
 specification_version: 3
 summary: Describe package my_scripts
 test_files: 
+- spec/files/msdn/ddeinit_in.txt
+- spec/files/msdn/ddeinit_out.txt
+- spec/files/msdn/msg_in.txt
+- spec/files/msdn/msg_out.txt
+- spec/files/msdn/struct1_in.txt
+- spec/files/msdn/struct1_out.txt
+- spec/files/msdn/struct_in.txt
+- spec/files/msdn/struct_out.txt
 - spec/my_scripts/extensions_spec.rb
 - spec/my_scripts/scripts/gitto_spec.rb
+- spec/my_scripts/scripts/msdn/msdn_helper_spec.rb
+- spec/my_scripts/scripts/msdn_spec.rb
 - spec/my_scripts/scripts/shared.rb
 - spec/my_scripts_spec.rb
 - spec/spec.opts