malloc 0.2.0 → 0.2.1

data/Makefile

@@ -2,13 +2,14 @@
 .SUFFIXES: .gem .o .cc .hh .rb .tar .gz .bz2
 
 RUBY_VERSION = 1.8
-MALLOC_VERSION = 0.2.0
+MALLOC_VERSION = 0.2.1
 
 CP = cp
-RM = rm -f
+RM = rm -Rf
 MKDIR = mkdir -p
 GEM = gem$(RUBY_VERSION)
 RUBY = ruby$(RUBY_VERSION)
+YARDOC = yardoc
 TAR = tar
 GIT = git
 SITELIBDIR = $(shell $(RUBY) -r mkmf -e "puts \"\#{Config::CONFIG['sitelibdir']}\"")
@@ -46,6 +47,9 @@ install-gem:: malloc-$(MALLOC_VERSION).gem
 uninstall-gem::
 	$(GEM) uninstall malloc || echo Nothing to uninstall
 
+yardoc:: README $(LIB)
+	$(YARDOC)
+
 check:: ext/malloc.so $(LIB) $(TEST)
 	$(RUBY) -rrubygems -Iext -Ilib -Itest test/ts_malloc.rb
 
@@ -81,5 +85,5 @@ malloc-$(MALLOC_VERSION).tar.bz2: $(SOURCES)
 	$(TAR) cjf $@ $(SOURCES)
 
 clean::
-	rm -f *~ ext/*~ ext/*.o ext/*.so ext/Makefile lib/*~ lib/*.so test/*~ doc/*~ *.gem
+	$(RM) *~ ext/*~ ext/*.o ext/*.so ext/Makefile lib/*~ lib/*.so test/*~ *.gem doc
 

data/README

@@ -1,2 +1 @@
 This Ruby extension defines the class Hornetseye::Malloc. Hornetseye::Malloc#new allows you to allocate memory, using Hornetseye::Malloc#+ one can do pointer manipulation, and Hornetseye::Malloc#read and Hornetseye::Malloc#write provide reading Ruby strings from memory and writing Ruby strings to memory.
-

data/binary.gemspec

@@ -1,7 +1,7 @@
 require 'date'
 Gem::Specification.new do |s|
   s.name = %q{malloc}
-  s.version = '0.2.0'
+  s.version = '0.2.1'
   s.platform = Gem::Platform::CURRENT
   s.date = Date.today.to_s
   s.summary = %q{Object for raw memory allocation and pointer operations}
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.test_files = Dir.glob( 'test/tc_*.rb' )
   s.require_paths = [ 'lib', 'ext' ]
   s.rubyforge_project = %q{hornetseye}
-  s.has_rdoc = true
-  s.extra_rdoc_files = [ 'README' ]
-  s.rdoc_options = %w{--exclude=/Makefile|.*\.(cc|hh|rb)/ --main README}
+  s.has_rdoc = 'yard'
+  # s.extra_rdoc_files = [ 'README' ]
+  # s.rdoc_options = %w{--exclude=/Makefile|.*\.(cc|hh|rb)/ --main README}
 end

data/lib/malloc_ext.rb

@@ -1,23 +1,36 @@
+# Namespace of the Hornetseye project.
 module Hornetseye
 
+  # Class for allocating raw memory and for doing pointer operations.
   class Malloc
 
     class << self
 
       alias_method :orig_new, :new
 
+      # Create new Malloc object.
+      #
+      # @param [size] Number of bytes to allocate.
+      # @return [Malloc] A new Malloc object.
       def new( size )
         retval = orig_new size
         retval.instance_eval { @size = size }
         retval
       end
 
+      private :orig_new
+
     end
 
+    # Number of bytes allocated.
     attr_reader :size
 
     alias_method :orig_plus, :+
 
+    # Operator for doing pointer arithmetic.
+    #
+    # @param [offset] Non-negative offset for pointer.
+    # @return [Malloc] A new Malloc object.
     def +( offset )
       if offset > @size
         raise "Offset must not be more than #{@size} (but was #{offset})"
@@ -28,16 +41,28 @@ module Hornetseye
       retval
     end
 
+    private :orig_plus
+
     alias_method :orig_read, :read
 
+    # Read data from memory.
+    #
+    # @param [length] Number of bytes to read.
+    # @return [String] A string containing the data.
     def read( length )
       raise "Only #{@size} bytes of memory left to read " +
         "(illegal attempt to read #{length} bytes)" if length > @size
       orig_read length
     end
 
+    private :orig_read
+
     alias_method :orig_write, :write
 
+    # Write data to memory.
+    #
+    # @param [string] A string with the data.
+    # @return [String] Returns the parameter `string`.
     def write( string )
       if string.bytesize > @size
         raise "Must not write more than #{@size} bytes of memory " +
@@ -46,14 +71,20 @@ module Hornetseye
       orig_write string
     end
 
+    private :orig_write
+
   end
 
 end
 
+# The string class of the standard library.
 class String
 
   unless method_defined? :bytesize
 
+    # This method won't be overriden if it is defined already.
+    #
+    # Provided for compatibility with Ruby 1.8.6. Same as #size.
     def bytesize
       size
     end

data/source.gemspec

@@ -1,7 +1,7 @@
 require 'date'
 Gem::Specification.new do |s|
   s.name = %q{malloc}
-  s.version = '0.2.0'
+  s.version = '0.2.1'
   s.platform = Gem::Platform::RUBY
   s.date = Date.today.to_s
   s.summary = %q{Object for raw memory allocation and pointer operations}
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.require_paths = [ 'lib', 'ext' ]
   s.rubyforge_project = %q{hornetseye}
   s.extensions = %w{ext/extconf.rb}
-  s.has_rdoc = true
-  s.extra_rdoc_files = [ 'README' ]
-  s.rdoc_options = %w{--exclude=/Makefile|.*\.(cc|hh|rb)/ --main README}
+  s.has_rdoc = 'yard'
+  # s.extra_rdoc_files = [ 'README' ]
+  # s.rdoc_options = %w{--exclude=/Makefile|.*\.(cc|hh|rb)/ --main README}
 end

data/test/tc_malloc.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'malloc'
+Kernel::require 'malloc'
 
 class TC_Malloc < Test::Unit::TestCase
 
@@ -10,9 +10,9 @@ class TC_Malloc < Test::Unit::TestCase
 
   def test_read_write
     m = Hornetseye::Malloc.new 6
-    m.write 'abcdef'
+    assert_equal 'abcdef', m.write( 'abcdef' )
     assert_equal 'abcdef', m.read( 6 )
-    m.write 'ghi'
+    assert_equal 'ghi', m.write( 'ghi' )
     assert_equal 'ghidef', m.read( 6 )
     assert_raise( RuntimeError ) { m.read 7 }
     assert_raise( RuntimeError ) { m.write 'abcdefg' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: malloc
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jan Wedekind
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 +00:00
+date: 2009-12-10 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -19,8 +19,8 @@ executables: []
 
 extensions: 
 - ext/extconf.rb
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
 - source.gemspec
 - binary.gemspec
@@ -36,15 +36,13 @@ files:
 - ext/extconf.rb
 - test/ts_malloc.rb
 - test/tc_malloc.rb
-has_rdoc: true
+has_rdoc: yard
 homepage: http://wedesoft.github.com/malloc/
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --exclude=/Makefile|.*\.(cc|hh|rb)/
-- --main
-- README
+rdoc_options: []
+
 require_paths: 
 - lib
 - ext