win32-mmap 0.3.2 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fd737d1d437da5002b90092c5453761d35e5b51
+  data.tar.gz: c111a6f06fbbe986933dd503d80174a059c9d142
+SHA512:
+  metadata.gz: cc7a6cca90f71eac4ea593b4fb7f9098aa89d8c515252e86a9f59983354a0099f2779d74b9f357f8e2d8baf84ff4e92f6bdbd67ed72301e8b4973ae06de3d415
+  data.tar.gz: 16ce6d436951d643f8476a8d673da1274a9e9fdf583aaac265032e1d973e78284a823e473d18914c914dfb8d8e3a7681b81a1d6ec80b10205bedb6b23fde4f9f

data/CHANGES

@@ -1,3 +1,8 @@
+== 0.4.0 - 21-Aug-2013
+* Added methods for reading or writing raw strings to the underlying
+  memory mapped file (as opposed to marshalled data). Thanks go to
+  Frank Quednau for the patch.
+
 == 0.3.2 - 28-Apr-2013
 * Fixed a prototype mismatch in a call to CreateFile. Thanks go to
   Frank Quednau for the spot.

data/README

@@ -1,64 +1,65 @@
 = Description
-   This package provides a Ruby interface for memory mapped I/O on MS Windows.
+  This package provides a Ruby interface for memory mapped I/O on MS Windows.
    
 = Prerequisites
-   windows-pr, 0.5.5 or later.
+  * ffi
+  * test-unit (Testing only)
 
 = Installation
-   gem install win32-mmap
+  gem install win32-mmap
    
 = Synopsis
-   require 'win32/mmap'
-   include Win32
+  require 'win32/mmap'
+  include Win32
    
-   map1 = MMap.new(:file => "C:\\test.map", :size => 1024)
-   map1.foo = 'hello'
-   map1.bar = 77
-   map1.close
+  map1 = MMap.new(:file => "C:\\test.map", :size => 1024)
+  map1.foo = 'hello'
+  map1.bar = 77
+  map1.close
    
-   map2 = MMap.new(:file => "C:\\test.map")
-   p map2.foo # 'hello'
-   p map2.bar # 77
-   map2.close
+  map2 = MMap.new(:file => "C:\\test.map")
+  p map2.foo # 'hello'
+  p map2.bar # 77
+  map2.close
 
 = About Memory Mapped Files under Windows
-   Under Windows, code and data are both repesented by pages of memory backed
-   by files on disk, code by executable image and data by system pagefile
-   (i.e. swapfile). These are called memory mapped files. Memory mapped files
-   can be used to provide a mechanism for shared memory between processes.
-   Different processes are able to share data backed by the same swapfile,
-   whether it's the system pagefile or a user-defined swapfile.
+  Under Windows, code and data are both repesented by pages of memory backed
+  by files on disk, code by executable image and data by system pagefile
+  (i.e. swapfile). These are called memory mapped files. Memory mapped files
+  can be used to provide a mechanism for shared memory between processes.
+  Different processes are able to share data backed by the same swapfile,
+  whether it's the system pagefile or a user-defined swapfile.
 
-   Windows has a tight security system that prevents processes from directly
-   sharing information among each other, but mapped memory files provide a
-   mechanism that works with the Windows security system by using a name that
-   all processes use to open the swapfile.
+  Windows has a tight security system that prevents processes from directly
+  sharing information among each other, but mapped memory files provide a
+  mechanism that works with the Windows security system by using a name that
+  all processes use to open the swapfile.
 
-   A shared section of the swapfile is translated into pages of memory that are
-   addressable by more than one process, Windows uses a system resource called a
-   prototype page table entry (PPTE) to enable more than one process to address
-   the same physical page of memory, thus multiple process can share the same
-   data without violating the Windows system security.
+  A shared section of the swapfile is translated into pages of memory that are
+  addressable by more than one process, Windows uses a system resource called a
+  prototype page table entry (PPTE) to enable more than one process to address
+  the same physical page of memory, thus multiple process can share the same
+  data without violating the Windows system security.
 
-   In short, memory mapped files provide shared memory under Windows.
+  In short, memory mapped files provide shared memory under Windows.
 
-	(This explanation was largely borrowed from Roger Lee's Win32::MMF Perl
-	module.)
+  (This explanation was largely borrowed from Roger Lee's Win32::MMF Perl
+  module.)
 
 = Future Plans
-   Suggestions welcome.
+  Suggestions welcome.
 
 = License
-   Artistic 2.0
+  Artistic 2.0
     
 = Copyright
-   (C) 2003-2013 Daniel J. Berger, All Rights Reserved
+  (C) 2003-2013 Daniel J. Berger, All Rights Reserved
     
 = Warranty
-   This package is provided "as is" and without any express or
-   implied warranties, including, without limitation, the implied
-   warranties of merchantability and fitness for a particular purpose.
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
     
 = Authors
-   Daniel J. Berger
-   Park Heesob
+  Daniel J. Berger
+  Park Heesob

data/Rakefile

@@ -8,7 +8,12 @@ namespace 'gem' do
   desc 'Create the win32-mmap gem.'
   task :create => [:clean] do
     spec = eval(IO.read('win32-mmap.gemspec'))
-    Gem::Builder.new(spec).build
+    if Gem::VERSION.to_f < 2.0
+      Gem::Builder.new(spec).build
+    else
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    end
   end
 
   desc 'Install the win32-mmap gem.'

data/lib/win32/mmap.rb

@@ -9,7 +9,7 @@ module Win32
   #
   class MMap
     # The version of the win32-mmap library.
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
 
     include Windows::Constants
     include Windows::Functions
@@ -292,6 +292,25 @@ module Win32
       @autolock
     end
 
+    # Writes a string directly to the underlying file
+    def write_string(content)
+      lock_pattern do
+        ptr = FFI::Pointer.new(:char, @address)
+        ptr.write_string(content,content.length)
+      end
+    end
+
+    # Reads a string of a given length from the beginning of the file
+    # if no length is given, reads the file with the @size attribute
+    # of this instance
+    def read_string(length = @size)
+      lock_pattern do
+        FFI::MemoryPointer.new(:char, length)
+        ptr = FFI::Pointer.new(:char, @address)
+        ptr.read_string(length)
+      end
+    end
+
     private
 
     # :stopdoc:
@@ -301,8 +320,6 @@ module Win32
     #--
     # This replaces the getvar/setvar API from 0.1.0.
     #
-    # TODO: FIX!
-    #
     def method_missing(method_id, *args)
       method = method_id.id2name
       args = args.first if args.length == 1
@@ -311,44 +328,41 @@ module Win32
         method.chop!
         @hash["#{method}"] = args
 
-        if @autolock
-          if mmap_lock
-            instance_variable_set("@#{method}", args)
-            marshal = Marshal.dump(@hash)
-            ptr = FFI::Pointer.new(:char, @address)
-            ptr.write_string(marshal,marshal.length)
-            mmap_unlock
-          end
-        else
+        lock_pattern do
           instance_variable_set("@#{method}", args)
           marshal = Marshal.dump(@hash)
           ptr = FFI::Pointer.new(:char, @address)
           ptr.write_string(marshal,marshal.length)
         end
+
       else # Getter
-        buf = FFI::MemoryPointer.new(:char, @size)
-
-        if @autolock
-          if mmap_lock
-            ptr = FFI::Pointer.new(:char, @address)
-            buf = ptr.read_string(@size)
-            hash = Marshal.load(buf)
-            val  = hash["#{method}"]
-            instance_variable_set("@#{method}", val)
-            mmap_unlock
-          end
-        else
-           ptr = FFI::Pointer.new(:char, @address)
-           buf = ptr.read_string(@size)
-           hash = Marshal.load(buf)
-           val  = hash["#{method}"]
-           instance_variable_set("@#{method}", val)
+
+        lock_pattern do
+          buf = FFI::MemoryPointer.new(:char, @size)
+          ptr = FFI::Pointer.new(:char, @address)
+          buf = ptr.read_string(@size)
+          hash = Marshal.load(buf)
+          val  = hash["#{method}"]
+          instance_variable_set("@#{method}", val)
         end
 
         return instance_variable_get("@#{method}")
       end
     end
 
+    def lock_pattern
+      if @autolock
+        if mmap_lock
+          output = yield
+          mmap_unlock
+          output
+        end
+      else
+         output = yield
+         output
+      end
+    end
+
     # Adds a semaphore lock the mapping.  Only used if +autolock+ is set
     # to true in the constructor.
     #

data/test/test_win32_mmap.rb

@@ -14,7 +14,7 @@ class TC_Win32_Mmap < Test::Unit::TestCase
   end
 
   test "version is set to expected value" do
-    assert_equal('0.3.2', MMap::VERSION)
+    assert_equal('0.4.0', MMap::VERSION)
   end
 
   test "dynamic variable names and string values work as expected" do
@@ -45,6 +45,12 @@ class TC_Win32_Mmap < Test::Unit::TestCase
     assert_equal([{1=>2}, [1,2,3], 'foo'], @mmap.barray)
   end
 
+  test "primitive write/read of file" do
+    input = "Greetings, astute reader"
+    assert_nothing_raised{ @mmap.write_string(input) }
+    assert_equal(input, @mmap.read_string(input.length))
+  end
+
   test "passing an invalid option raises an argument error" do
     assert_raises(ArgumentError){ MMap.new(:foo => 1) }
   end

data/win32-mmap.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'win32-mmap'
-  spec.version   = '0.3.2'
+  spec.version   = '0.4.0'
   spec.author    = 'Daniel J. Berger'
   spec.license   = 'Artistic 2.0'
   spec.email     = 'djberg96@gmail.com'

metadata

@@ -1,34 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: win32-mmap
 version: !ruby/object:Gem::Version
-  version: 0.3.2
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    The win32-mmap library provides an interface for memory mapped
-  IO on\n    MS Windows.\n"
+description: |2
+      The win32-mmap library provides an interface for memory mapped IO on
+      MS Windows.
 email: djberg96@gmail.com
 executables: []
 extensions: []
@@ -53,27 +51,26 @@ files:
 homepage: https://github.com/djberg96/win32-mmap
 licenses:
 - Artistic 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: win32utils
-rubygems_version: 1.8.24
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Memory mapped IO for Windows.
 test_files:
 - test/test_win32_mmap.rb