sizes 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.idea
+*.o
+*.bundle
+*.out
+Makefile

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Colin MacKenzie IV
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,68 @@
+= sizes
+
+A very simple gem that exposes the C *sizeof* keyword to Ruby.
+
+This does _not_ check the memory footprint of a given Ruby object. I may implement that sometime in the future if it's
+really needed, but for now this gem is only useful for checking primitive C types such as float, short, and so on.
+
+I wrote this because I couldn't find any cross-platform way to get these sizes from within Ruby. If it exists, then
+I've just reinvented the wheel, but at least I'm documenting it. :)
+
+== Installation
+
+  gem install sizes
+  
+== Usage
+
+  require 'sizes'
+  import Sizes
+  sizeof(:short)
+  #=> 2
+
+The *sizeof* method can also be called as a module function:
+
+  require 'sizes'
+  Sizes.sizeof(:float)
+  #=> 4
+  
+== More info
+
+Arguments to the #sizeof method can be either symbols or strings, and must be one of the following supported types:
+
+  :char
+  :unsigned_char
+  :signed_char
+  :signed_int
+  :int
+  :signed_short_int
+  :signed_long_int
+  :long_int
+  :long
+  :unsigned_int
+  :unsigned
+  :unsigned_short_int
+  :unsigned_short
+  :unsigned_long_int
+  :unsigned_long
+  :float
+  :double
+  :long_double
+  
+As you can see, some types are represented more than once with varying names. This is purely for convenience.
+
+If the argument does not appear in the above list, an ArgumentError will be raised.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Colin MacKenzie IV. See LICENSE for details.
+http://thoughtsincomputation.com

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sizes"
+    gem.summary = %Q{A very simple gem that exposes the C *sizeof* keyword to Ruby.}
+    gem.description = %Q{A very simple gem that exposes the C *sizeof* keyword to Ruby.}
+    gem.email = "sinisterchipmunk@gmail.com"
+    gem.homepage = "http://thoughtsincomputation.com"
+    gem.authors = ["Colin MacKenzie IV"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.files.concat FileList['ext/**/*.c']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sizes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/ext/sizes/extconf.rb

@@ -0,0 +1,3 @@
+require 'mkmf'
+
+create_makefile("sizes")

data/ext/sizes/sizes.c

@@ -0,0 +1,32 @@
+#include "ruby.h"
+
+static VALUE sizeof_char(VALUE self)               { return INT2FIX(sizeof(char)); }
+static VALUE sizeof_unsigned_char(VALUE self)      { return INT2FIX(sizeof(unsigned char)); }
+static VALUE sizeof_signed_char(VALUE self)        { return INT2FIX(sizeof(signed char)); }
+static VALUE sizeof_signed_int(VALUE self)         { return INT2FIX(sizeof(signed int)); }
+static VALUE sizeof_signed_short_int(VALUE self)   { return INT2FIX(sizeof(signed short int)); }
+static VALUE sizeof_long_int(VALUE self)           { return INT2FIX(sizeof(long int)); }
+static VALUE sizeof_unsigned_int(VALUE self)       { return INT2FIX(sizeof(unsigned int)); }
+static VALUE sizeof_unsigned_short_int(VALUE self) { return INT2FIX(sizeof(unsigned short int)); }
+static VALUE sizeof_unsigned_long_int(VALUE self)  { return INT2FIX(sizeof(unsigned long int)); }
+static VALUE sizeof_float(VALUE self)              { return INT2FIX(sizeof(float)); }
+static VALUE sizeof_double(VALUE self)             { return INT2FIX(sizeof(double)); }
+static VALUE sizeof_long_double(VALUE self)        { return INT2FIX(sizeof(long double)); }
+
+void Init_sizes()
+{
+  VALUE mSizes = rb_define_module("Sizes");
+  
+  rb_define_module_function(mSizes, "sizeof_char",               sizeof_char,               0);
+  rb_define_module_function(mSizes, "sizeof_unsigned_char",      sizeof_unsigned_char,      0);
+  rb_define_module_function(mSizes, "sizeof_signed_char",        sizeof_signed_char,        0);
+  rb_define_module_function(mSizes, "sizeof_signed_int",         sizeof_signed_int,         0);
+  rb_define_module_function(mSizes, "sizeof_signed_short_int",   sizeof_signed_short_int,   0);
+  rb_define_module_function(mSizes, "sizeof_long_int",           sizeof_long_int,           0);
+  rb_define_module_function(mSizes, "sizeof_unsigned_int",       sizeof_unsigned_int,       0);
+  rb_define_module_function(mSizes, "sizeof_unsigned_short_int", sizeof_unsigned_short_int, 0);
+  rb_define_module_function(mSizes, "sizeof_unsigned_long_int",  sizeof_unsigned_long_int,  0);
+  rb_define_module_function(mSizes, "sizeof_float",              sizeof_float,              0);
+  rb_define_module_function(mSizes, "sizeof_double",             sizeof_double,             0);
+  rb_define_module_function(mSizes, "sizeof_long_double",        sizeof_long_double,        0);
+}

data/lib/sizes.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), "../ext/sizes/sizes")
+
+module Sizes
+  module_function
+  
+  STRING_COPIES = %w(char unsigned_char signed_char signed_int int signed_short_int signed_long_int
+                     long_int long unsigned_int unsigned unsigned_short_int unsigned_short unsigned_long_int
+                     unsigned_long float double long_double
+                  ).inject({}) { |hash,key| hash[key] = key.to_sym; hash }.freeze
+    
+  def sizeof(symbol_or_string)
+    # I could just use send("sizeof_#{symbol_or_string}") but that would be slower, and negate any advantage of using
+    # symbols. Not sure how much the speed difference really matters, but it couldn't hurt, right?
+    
+    case symbol_or_string
+      when String
+        if sym = STRING_COPIES[symbol_or_string]
+          sizeof(sym)
+        else
+          raise ArgumentError, "Argument must be one of #{STRING_COPIES.values.inspect}, or a String version of the same"
+        end
+      when :char
+        sizeof_char
+      when :unsigned_char
+        sizeof_unsigned_char
+      when :signed_char
+        sizeof_signed_char
+      when :signed_int, :int
+        sizeof_signed_int
+      when :signed_short_int, :short_int, :short
+        sizeof_signed_short_int
+      when :signed_long_int, :long_int, :long
+        sizeof_long_int
+      when :unsigned_int, :unsigned
+        sizeof_unsigned_int
+      when :unsigned_short_int, :unsigned_short
+        sizeof_unsigned_short_int
+      when :unsigned_long_int, :unsigned_long
+        sizeof_unsigned_long_int
+      when :float
+        sizeof_float
+      when :double
+        sizeof_double
+      when :long_double
+        sizeof_long_double
+      else
+        raise ArgumentError, "Argument must be one of #{STRING_COPIES.values.inspect}, or a String version of the same"
+    end
+  end
+end

data/sizes.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sizes}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Colin MacKenzie IV"]
+  s.date = %q{2010-10-27}
+  s.description = %q{A very simple gem that exposes the C *sizeof* keyword to Ruby.}
+  s.email = %q{sinisterchipmunk@gmail.com}
+  s.extensions = ["ext/sizes/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ext/sizes/extconf.rb",
+     "ext/sizes/sizes.c",
+     "lib/sizes.rb",
+     "sizes.gemspec",
+     "spec/sizes_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/support/dump_sizes.c"
+  ]
+  s.homepage = %q{http://thoughtsincomputation.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A very simple gem that exposes the C *sizeof* keyword to Ruby.}
+  s.test_files = [
+    "spec/sizes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/sizes_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# These tests describe correct values for my machine. YMMV.
+# To check correct values for your machine, compile and run spec/support/dump_sizes.cpp.
+
+describe "Sizes" do
+  include Sizes
+  
+  it "should work as a module function" do
+    Sizes.sizeof(:char).should == 1
+  end
+
+  context "should report correct size:" do
+    it "char" do
+      sizeof(:char).should == 1
+    end
+
+    it "unsigned char" do
+      sizeof(:unsigned_char).should == 1
+    end
+
+    it "signed char" do
+      sizeof(:signed_char).should == 1
+    end
+
+    it "signed int" do
+      sizeof(:signed_int).should == 4
+    end
+
+    it "int" do
+      sizeof(:int).should == 4
+    end
+
+    it "signed short int" do
+      sizeof(:signed_short_int).should == 2
+    end
+
+    it "signed long int" do
+      sizeof(:signed_long_int).should == 8
+    end
+
+    it "long int" do
+      sizeof(:long_int).should == 8
+    end
+
+    it "long" do
+      sizeof(:long).should == 8
+    end
+
+    it "unsigned int" do
+      sizeof(:unsigned_int).should == 4
+    end
+
+    it "unsigned" do
+      sizeof(:unsigned).should == 4
+    end
+
+    it "unsigned short int" do
+      sizeof(:unsigned_short_int).should == 2
+    end
+
+    it "unsigned short" do
+      sizeof(:unsigned_short).should == 2
+    end
+
+    it "unsigned long int" do
+      sizeof(:unsigned_long_int).should == 8
+    end
+
+    it "unsigned long" do
+      sizeof(:unsigned_long).should == 8
+    end
+
+    it "float" do
+      sizeof(:float).should == 4
+    end
+
+    it "double" do
+      sizeof(:double).should == 8
+    end
+
+    it "long double" do
+      sizeof(:long_double).should == 16
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sizes'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/support/dump_sizes.c

@@ -0,0 +1,27 @@
+#include <stdio.h>
+
+int main(int argc, char **argv)
+{
+  printf("Correct values for sizeof(...) for this machine:\n\n");
+  printf("char               : %ld\n", sizeof(char));
+  printf("unsigned char      : %ld\n", sizeof(unsigned char));
+  printf("signed char        : %ld\n", sizeof(signed char));
+  printf("signed int         : %ld\n", sizeof(int));
+  printf("   / int\n");
+  printf("signed short int   : %ld\n", sizeof(signed short int));
+  printf("   / short int\n");
+  printf("   / short\n");
+  printf("signed long int    : %ld\n", sizeof(signed long int));
+  printf("   / long int\n");
+  printf("   / long\n");
+  printf("unsigned int       : %ld\n", sizeof(unsigned int));
+  printf("   / unsigned\n");
+  printf("unsigned short int : %ld\n", sizeof(unsigned short int));
+  printf("   / unsigned short\n");
+  printf("unsigned long int  : %ld\n", sizeof(unsigned long int));
+  printf("   / unsigned long\n");
+  printf("float              : %ld\n", sizeof(float));
+  printf("double             : %ld\n", sizeof(double));
+  printf("long double        : %ld\n", sizeof(long double));
+}
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: sizes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Colin MacKenzie IV
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-27 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: A very simple gem that exposes the C *sizeof* keyword to Ruby.
+email: sinisterchipmunk@gmail.com
+executables: []
+
+extensions: 
+- ext/sizes/extconf.rb
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ext/sizes/extconf.rb
+- ext/sizes/sizes.c
+- lib/sizes.rb
+- sizes.gemspec
+- spec/sizes_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/dump_sizes.c
+has_rdoc: true
+homepage: http://thoughtsincomputation.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A very simple gem that exposes the C *sizeof* keyword to Ruby.
+test_files: 
+- spec/sizes_spec.rb
+- spec/spec_helper.rb