win32-mmap 0.2.2 → 0.2.3

data/CHANGES

@@ -1,3 +1,10 @@
+== 0.2.3 - 12-Aug-2009
+* Changed license to Artistic 2.0.
+* The MMap.open method now properly handles a block.
+* Some gemspec updates, including the license and description.
+* Changed test and example file names.
+* Some Rakefile updates, including tasks for running example programs.
+
 == 0.2.2 - 16-May-2007
 * Fixed a bug where marshalled data that happened to end with a "\0" would
   cause the getter to fail.

data/MANIFEST

@@ -3,9 +3,8 @@
 * README
 * Rakefile
 * win32-mmap.gemspec
-* doc/mmap.rdoc
-* examples/mmap_test.rb
-* examples/test_client.rb
-* examples/test_server.rb
+* examples/example_mmap.rb
+* examples/example_mmap_client.rb
+* examples/example_mmap_server.rb
 * lib/win32/mmap.rb
-* test/tc_mmap.rb
+* test/test_win32_mmap.rb

data/README

@@ -2,7 +2,7 @@
    This package provides a Ruby interface for memory mapped I/O on MS Windows.
    
 = Prerequisites
-   Ruby 1.8.0 or later.
+   Ruby 1.8.2 or later.
    windows-pr, 0.5.5 or later.
 
 = Installation
@@ -30,15 +30,15 @@
 
 = 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 an data by system pagefile
-   (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.
+   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
+   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
@@ -47,7 +47,7 @@
    the same physical page of memory, thus multiple process can share the same
    data without violating the Windows system security.
 
-   In short, MMF's 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.)
@@ -56,10 +56,10 @@
    Suggestions welcome.
 
 = License
-   Ruby's
+   Artistic 2.0
     
 = Copyright
-   (C) 2003-2007 Daniel J. Berger, All Rights Reserved
+   (C) 2003-2009 Daniel J. Berger, All Rights Reserved
     
 = Warranty
    This package is provided "as is" and without any express or

data/Rakefile

@@ -13,9 +13,19 @@ task :install do
    FileUtils.cp(file, installdir, :verbose => true)
 end
 
+desc 'Run the example mmap file program'
+task :example_file do
+   ruby '-Ilib examples/example_mmap_file.rb'
+
+desc 'Run the example mmap server'
+task :example_server do
+   ruby '-Ilib examples/example_mmap_server.rb'
+
+desc 'Run the example mmap client'
+task :example_client do
+   ruby '-Ilib examples/example_mmap_client.rb'
+
 Rake::TestTask.new do |t|
-   t.libs << 'test'
    t.verbose = true
    t.warning = true
-   t.test_files = FileList['test/tc_mmap.rb']
 end

data/examples/example_mmap_client.rb

@@ -0,0 +1,20 @@
+#######################################################################
+# example_mmap_client.rb
+#
+# This program demonstrates a simple mmap client. You should run this
+# program *after* you have run the example server program in a
+# separate terminal.
+#
+# You can run this program via the 'rake example_client' task.
+#
+# Modify this program as you see fit.
+#######################################################################
+require 'win32/mmap'
+include Win32
+
+mmap = MMap.open('alpha')
+
+p mmap.foo
+p mmap.bar
+
+mmap.close

data/examples/example_mmap_file.rb

@@ -0,0 +1,25 @@
+#######################################################################
+# example_mmap_file.rb
+#
+# This sample script demonstrates creating a memory mapped file, then
+# later reading from it. You can run this example via the
+# 'rake example_file' task.
+#
+# Modify this program as you see fit.
+#######################################################################
+require 'win32/mmap'
+include Win32
+
+map1 = MMap.new(:file => "C:\\mmap.test", :size => 1024)
+
+map1.foo = 'hello'
+map1.bar = 77
+
+map1.close
+
+map2 = MMap.new(:file => "C:\\mmap.test")
+
+p map2.foo
+p map2.bar
+
+map2.close

data/examples/example_mmap_server.rb

@@ -0,0 +1,20 @@
+#######################################################################
+# example_mmap_server.rb
+#
+# A test script for general futzing.  Run this in its own terminal
+# then run the example_mmap_client.rb program in a separate terminal.
+# You can run this program via the 'rake example_server' task.
+# 
+# Modify as you see fit. 
+#######################################################################
+require 'win32/mmap'
+include Win32
+
+mmap = MMap.new(:name => 'alpha', :size => 2000)
+
+mmap.foo = 'hello'
+mmap.bar = 27
+
+sleep 100
+
+mmap.close

data/lib/win32/mmap.rb

@@ -6,14 +6,18 @@ require 'windows/msvcrt/buffer'
 require 'windows/synchronize'
 require 'windows/memory'
 
+# The Win32 module serves as a namespace only.
+#
 module Win32
 
-   # Memory mapped files for MS Windows.
+   # The MMap class encapsulates functions for memory mapped files.
    #
    class MMap
-      VERSION = '0.2.2'
+      
+      # The version of the win32-mmap library.
+      VERSION = '0.2.3'
 
-      # All errors generated by Win32::MMap are of type MMap::Error.
+      # Error typically raised in any method of Win32::MMap should fail.
       #
       class Error < StandardError; end
 
@@ -242,10 +246,10 @@ module Win32
       #--
       # This forces MMap.new to use OpenFileMapping() behind the scenes.
       #
-      def self.open(name, opts={})
+      def self.open(name, opts={}, &block)
          opts[:name] = name
          opts[:open] = true        
-         self.new(opts)
+         self.new(opts, &block)
       end
       
       # Sets whether or not the mapping handle can be inherited
@@ -300,6 +304,8 @@ module Win32
       end
 
       private
+      
+      # :stopdoc:
 
       # This is used to allow dynamic getters and setters between memory
       # mapped objects.

data/test/{tc_mmap.rb → test_win32_mmap.rb}

@@ -1,5 +1,5 @@
 #####################################################################
-# tc_mmap.rb
+# test_win32_mmap.rb
 #
 # Test suite for the win32-mmap package. This should be run via the
 # 'rake test' task.
@@ -8,13 +8,13 @@ require 'test/unit'
 require 'win32/mmap'
 include Win32
 
-class TC_Mmap < Test::Unit::TestCase
+class TC_Win32_Mmap < Test::Unit::TestCase
    def setup
       @mmap = MMap.new(:name => 'test', :size => 100)
    end
 
    def test_version
-      assert_equal('0.2.2', MMap::VERSION)
+      assert_equal('0.2.3', MMap::VERSION)
    end
    
    def test_dynamic_string_value

data/win32-mmap.gemspec

@@ -1,24 +1,27 @@
-require "rubygems"
+require 'rubygems'
 
 spec = Gem::Specification.new do |gem|
-   gem.name        = "win32-mmap"
-   gem.version     = "0.2.2"
-   gem.author      = "Daniel J. Berger"
-   gem.email       = "djberg96@gmail.com"
-   gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
-   gem.platform    = Gem::Platform::RUBY
-   gem.summary     = "Memory mapped IO for Windows."
-   gem.description = "Memory mapped IO for Windows."
-   gem.test_file   = "test/tc_mmap.rb"
-   gem.has_rdoc    = true
-   gem.files       = Dir["lib/win32/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
-   gem.files.reject! { |fn| fn.include? "CVS" }
-   gem.require_path = "lib"
-   gem.extra_rdoc_files = ["MANIFEST", "README", "CHANGES"]
-   gem.add_dependency("windows-pr", ">= 0.5.6")
-end
+   gem.name      = 'win32-mmap'
+   gem.version   = '0.2.3'
+   gem.author    = 'Daniel J. Berger'
+   gem.license   = 'Artistic 2.0'
+   gem.email     = 'djberg96@gmail.com'
+   gem.homepage  = 'http://www.rubyforge.org/projects/win32utils'
+   gem.platform  = Gem::Platform::RUBY
+   gem.summary   = 'Memory mapped IO for Windows.'
+   gem.test_file = 'test/test_win32_mmap.rb'
+   gem.has_rdoc  = true
+   gem.files     = Dir['**/*'].reject{ |f| f.include?('CVS') }
+
+   gem.rubyforge_project = 'win32utils'
+   gem.extra_rdoc_files  = ['MANIFEST', 'README', 'CHANGES']
 
-if $0 == __FILE__
-   Gem.manage_gems
-   Gem::Builder.new(spec).build
+   gem.add_dependency('windows-pr')
+
+   gem.description = <<-EOF
+      The win32-mmap library provides an interface for memory mapped IO on
+      MS Windows.
+   EOF
 end
+
+Gem::Builder.new(spec).build

metadata

@@ -1,68 +1,75 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.3
-specification_version: 1
 name: win32-mmap
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
-date: 2007-05-16 00:00:00 -06:00
-summary: Memory mapped IO for Windows.
-require_paths: 
-- lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/win32utils
-rubyforge_project: 
-description: Memory mapped IO for Windows.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.3
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: windows-pr
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "      The win32-mmap library provides an interface for memory mapped IO on\n      MS Windows.\n"
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MANIFEST
+- README
+- CHANGES
 files: 
-- lib/win32/mmap.rb
-- test/CVS
-- test/tc_mmap.rb
 - CHANGES
-- CVS
-- doc
-- examples
-- lib
+- examples/example_mmap_client.rb
+- examples/example_mmap_file.rb
+- examples/example_mmap_server.rb
+- lib/win32/mmap.rb
 - MANIFEST
 - Rakefile
 - README
-- test
+- test/test_win32_mmap.rb
 - win32-mmap.gemspec
-test_files: 
-- test/tc_mmap.rb
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/win32utils
+licenses: 
+- Artistic 2.0
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: 
-- MANIFEST
-- README
-- CHANGES
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: windows-pr
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.5.6
-    version: 
+rubyforge_project: win32utils
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Memory mapped IO for Windows.
+test_files: 
+- test/test_win32_mmap.rb