ruddy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5472f2049ff6bfd144aeea055ab4e7bf2f28c2a
-  data.tar.gz: b631945110c72dbddb97b16f53a96b4aace394a9
+  metadata.gz: f0b6e57ede4cc6d661e6e1072970ac932815895a
+  data.tar.gz: b22188ffb539b4d7874132da1d133cbd1f44b236
 SHA512:
-  metadata.gz: a48d3d9eb7bb0a5baa0c263675f629af983d940ad2322e6bf34035ad112ebecf1bf96d3901c73358d45494aa6f0eb359fb5a3656b54968b648282972b4a6cc86
-  data.tar.gz: 2cdb71ff621c0cdb7849428ce1d786569764d6542a62e42957df51e881f1f65b977f1a2cb4ea9f9a566654c1133654d03bc1ee7a4b5ed9179704f3631527d271
+  metadata.gz: 9b0286e719425ee74a8dd6c9454dcfeb9a7d3b65b66cb0929af3c540e0e032d3dfc326799444f341676c2c4ae7cca1cc91d5d660cc1ab7da2e4c0be1a83aa1da
+  data.tar.gz: e8021df09d1fac855c30389722a1599f61c7bdef4a6a772dce7f69866cd86102b3a7faa05c2378ed8ff8b7141f405c93747fe9f7964e7eb40ee024d9c640be42

data/lib/ruddy.rb

@@ -1,3 +1,5 @@
 require "ruddy/version"
 require "dde"
+require "ruddy/error"
+require "ruddy/errors"
 require "ruddy/connection"

data/lib/ruddy/connection.rb

@@ -29,7 +29,7 @@ module Ruddy
       result = FFI::MemoryPointer.new(:uint)
 
       data = DDE.client_transaction(buffer, buffer.size, conversation, nil, 0, DDE::XTYP_EXECUTE, timeout, result)
-      raise SystemCallError.new("command execution failed", DDE.last_error(instance)) if data.null?
+      raise Error.new("command execution failed", DDE.last_error(instance)) if data.null?
       DDE.free_data_handle(data)
 
       return result.read_uint
@@ -55,7 +55,7 @@ module Ruddy
     def start
       instance = FFI::MemoryPointer.new(:uint)
       error = DDE.start(instance, CALLBACK, DDE::APPCLASS_STANDARD | DDE::APPCMD_CLIENTONLY, 0)
-      raise SystemCallError.new("DDE management library initialization failed", error) if error != DDE::DMLERR_NO_ERROR
+      raise Error.new("DDE management library initialization failed", error) if error != DDE::DMLERR_NO_ERROR
       @instance = instance.read_uint
     end
 
@@ -68,7 +68,7 @@ module Ruddy
       free_string_handle service_handle
       free_string_handle topic_handle
 
-      raise SystemCallError.new(%{could not connect to DDE service "#{service}"}) if conversation.null?
+      raise Error.new(%{could not connect to DDE service "#{service}"}, DDE.last_error(instance)) if conversation.null?
     end
 
     def create_string_handle(string)

data/lib/ruddy/error.rb

@@ -0,0 +1,31 @@
+module Ruddy
+  class Error < StandardError
+    def initialize(message, errno)
+      super("#{message} - #{description}")
+      @errno = errno
+    end
+
+    attr_reader :errno
+
+    def self.errnos
+      @errnos ||= Hash.new(self)
+    end
+
+    def self.define(errno, description)
+      errnos[errno] = Class.new(self) do
+        define_method(:description) { description }
+        private :description
+      end
+    end
+
+    def self.new(message, errno)
+      errnos[errno].allocate.tap{|instance| instance.send :initialize, message, errno }
+    end
+
+    private
+
+    def description
+      "Unknown error"
+    end
+  end
+end

data/lib/ruddy/errors.rb

@@ -0,0 +1,42 @@
+module Ruddy
+  AdviseTimeoutError = Error.define(0x4000, "A request for a synchronous advise transaction has timed out.")
+
+  BusyError = Error.define(0x4001, "The response to the transaction caused the DDE_FBUSY flag to be set.")
+
+  DataTimeoutError = Error.define(0x4002, "A request for a synchronous data transaction has timed out.")
+
+  DLLNotInitializedError = Error.define(0x4003, "A DDEML function was called without first calling the DdeInitialize function, or an invalid instance identifier was passed to a DDEML function.")
+
+  DLLUsageError = Error.define(0x4004, "An application initialized as APPCLASS_MONITOR has attempted to perform a DDE transaction, or an application initialized as APPCMD_CLIENTONLY has attempted to perform server transactions.")
+
+  ExecutionTimeoutError = Error.define(0x4005, "A request for a synchronous execute transaction has timed out.")
+
+  InvalidParameterError = Error.define(0x4006, "A parameter failed to be validated by the DDEML. Some of the possible causes follow:
+                                                The application used a data handle initialized with a different item name handle than was required by the transaction.
+                                                The application used a data handle that was initialized with a different clipboard data format than was required by the transaction.
+                                                The application used a client-side conversation handle with a server-side function or vice versa.
+                                                The application used a freed data handle or string handle.
+                                                More than one instance of the application used the same object.")
+
+  LowMemoryError = Error.define(0x4007, "A DDEML application has created a prolonged race condition (in which the server application outruns the client), causing large amounts of memory to be consumed.")
+
+  MemoryError = Error.define(0x4008, "A memory allocation has failed.")
+
+  NoConversationEstablishedError = Error.define(0x400A, "A client's attempt to establish a conversation has failed.")
+
+  NotProcessedError = Error.define(0x4009, "A transaction has failed.")
+
+  PokeTimeoutError = Error.define(0x400B, "A request for a synchronous poke transaction has timed out.")
+
+  PostMessageFailedError = Error.define(0x400C, "An internal call to the PostMessage function has failed.")
+
+  ReentrancyError = Error.define(0x400D, "An application instance with a synchronous transaction already in progress attempted to initiate another synchronous transaction, or the DdeEnableCallback function was called from within a DDEML callback function.")
+
+  ServerDiedError = Error.define(0x400E, "A server-side transaction was attempted on a conversation terminated by the client, or the server terminated before completing a transaction.")
+
+  SystemError = Error.define(0x400F, "An internal error has occurred in the DDEML.")
+
+  UnadviseTimeoutError = Error.define(0x4010, "A request to end an advise transaction has timed out.")
+
+  QueueNotFoundError = Error.define(0x4011, "An invalid transaction identifier was passed to a DDEML function. Once the application has returned from an XTYP_XACT_COMPLETE callback, the transaction identifier for that callback function is no longer valid.")
+end

data/lib/ruddy/version.rb

@@ -1,3 +1,3 @@
 module Ruddy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/ruddy/connection_spec.rb

@@ -1,4 +1,5 @@
 require "ruddy/connection"
+require "ruddy/error"
 require "ffi"
 
 require "support/fake_dde"
@@ -49,14 +50,14 @@ module Ruddy
       context "when initializing the DDE management library fails" do
         it "raises an error" do
           DDE.stub start: 0x4006
-          expect{Connection.new("MY_SERVICE", "my_topic")}.to raise_error SystemCallError, /DDE management library initialization failed/
+          expect{Connection.new("MY_SERVICE", "my_topic")}.to raise_error Error, /DDE management library initialization failed/
         end
 
         it "sets the error code" do
           DDE.stub start: 0x4006
           begin
             Connection.new("MY_SERVICE", "my_topic")
-          rescue SystemCallError => error
+          rescue Error => error
             expect(error.errno).to eq 0x4006
           end
         end
@@ -65,7 +66,19 @@ module Ruddy
       context "when the connection fails" do
         it "raises an error" do
           DDE.stub connect: null_pointer
-          expect{Connection.new("MY_SERVICE", "my_topic")}.to raise_error SystemCallError, /could not connect to DDE service "MY_SERVICE"/
+          expect{Connection.new("MY_SERVICE", "my_topic")}.to raise_error Error, /could not connect to DDE service "MY_SERVICE"/
+        end
+
+        it "sets the error code" do
+          stub_instance 42
+          DDE.stub connect: null_pointer
+          DDE.stub(:last_error).with(42).and_return(0x4009)
+
+          begin
+            Connection.new("MY_SERVICE", "my_topic")
+          rescue Error => error
+            expect(error.errno).to eq 0x4009
+          end
         end
       end
     end
@@ -128,20 +141,21 @@ module Ruddy
         it "raises an error" do
           connection = Connection.new("MY_SERVICE", "my_topic")
           DDE.stub client_transaction: null_pointer
+          DDE.stub last_error: 0x4009
 
-          expect{connection.execute("[Foo(bar)]")}.to raise_error SystemCallError, /command execution failed/
+          expect{connection.execute("[Foo(bar)]")}.to raise_error Error, /command execution failed/
         end
 
         it "sets the error code" do
           stub_instance 42
           connection = Connection.new("MY_SERVICE", "my_topic")
-          DDE.stub(:last_error).with(42).and_return(0x4000)
+          DDE.stub(:last_error).with(42).and_return(0x4009)
           DDE.stub client_transaction: null_pointer
 
           begin
             connection.execute("[Foo(bar)]")
-          rescue SystemCallError => error
-            expect(error.errno).to eq 0x4000
+          rescue Error => error
+            expect(error.errno).to eq 0x4009
           end
         end
       end

data/spec/ruddy/error_spec.rb

@@ -0,0 +1,52 @@
+require "ruddy/error"
+
+module Ruddy
+  describe Error do
+    describe ".new" do
+      after { Error.errnos.clear }
+
+      context "with a known error code" do
+        it "returns an instance of a subclass" do
+          subclass = Error.define(42, "")
+          instance = Error.new("", 42)
+
+          expect(instance).to be_an_instance_of subclass
+        end
+
+        it "sets the error number" do
+          Error.define 42, ""
+          instance = Error.new("", 42)
+
+          expect(instance.errno).to eq 42
+        end
+
+        it "sets the message" do
+          Error.define 42, "bar"
+          instance = Error.new("foo", 42)
+
+          expect(instance.message).to eq "foo - bar"
+        end
+      end
+
+      context "with an unknown error code" do
+        it "returns an instance of itself" do
+          instance = Error.new("", 42)
+
+          expect(instance).to be_an_instance_of Error
+        end
+
+        it "sets the error number" do
+          instance = Error.new("", 42)
+
+          expect(instance.errno).to eq 42
+        end
+
+        it "sets the message" do
+          instance = Error.new("foo", 42)
+
+          expect(instance.message).to eq "foo - Unknown error"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruddy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Haines
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -82,9 +82,12 @@ files:
 - lib/dde/constants.rb
 - lib/ruddy.rb
 - lib/ruddy/connection.rb
+- lib/ruddy/error.rb
+- lib/ruddy/errors.rb
 - lib/ruddy/version.rb
 - ruddy.gemspec
 - spec/ruddy/connection_spec.rb
+- spec/ruddy/error_spec.rb
 - spec/support/fake_dde.rb
 - spec/support/string_pointer_matcher.rb
 homepage: https://github.com/haines/ruddy
@@ -107,11 +110,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Basic Win32 DDE client in Ruby
 test_files:
 - spec/ruddy/connection_spec.rb
+- spec/ruddy/error_spec.rb
 - spec/support/fake_dde.rb
 - spec/support/string_pointer_matcher.rb