snow-data 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4070dd82808151a7dcdd5e41c49fcd14e2dc7f14
-  data.tar.gz: dfaee4ffae49a3c3752f052a3089c6c0010afea2
+SHA256:
+  metadata.gz: 1d9e719eecd9292aa7cdb5019c8c6756c4ac71cc7f1514f99f79d22427d01a8e
+  data.tar.gz: 86a0a3f25e1406c61e39036e8bd5d4aec8527fba6f2000cd6b9e943a113153e5
 SHA512:
-  metadata.gz: 264998e906e61221c5f4ad786a32bcf647b895b02d2af123f244da4a488ced5c2fba8f145b55c877963fca7ff10c14a7022763e9b0a33ecc2a84dbaa6be4696d
-  data.tar.gz: 4b64d995bb9c8ad6c4f187cb919ed3e673b478bdb8d5fb95b93354a6887e2488e16488c3daca301a79545df4003b7e324bcda0599e4181c2fcdd18e162b16796
+  metadata.gz: 851f72c21008c1f6768fa25b10342faec9e87f524ccc3435447c95b4a1dfd02450722b90fc55169a26adb44005a40c4dfae948f776d958d5bbc1f299717e9ed4
+  data.tar.gz: 02d6a54f0b5e8c17756a4523877503e2e169eb681fcd97ad26a960fe3c0bc017d271048b89dbd317d5549050c1e4223c783f2bd23def4a6258865ca179605f93

data/README.md

@@ -8,30 +8,21 @@ Intro
 -----
 
 Snow-Data is a simple gem for dealing with memory and defining structs in a
-C-like way. Incidentally, it's also hideously unsafe, so everything is tainted
-by default. You'll thank me for this later, even if almost every operation does
-bounds-checking where possible to ensure you're not being a horrible person.
+C-like way. It's also hideously unsafe, so everything is tainted by default.
 
 For more information on usage, see the rdoc documentation for Snow::Memory
-and Snow::CStruct, as it explains the important things. Like CStructs. And how
-to talk to people. Ok, it can't help you with that.
-
-_ALLONS-Y!_
-
+and Snow::CStruct, as it should explain most of the important things.
 
 Example
 -------
 
-For those wanting a quick-ish example of using snow-data, I'll include one here
-showing you how you might define a few structs, including a Vec3, Vec2, Color,
-and Vertex and working with those.
-
-Bear in mind that, down the road, it will also be possible to assign snow-math
-types to these as well (provided they use the same underlying types), though I
-wouldn't use this for defining data types for anything other than transit to
-another API that expects its data in a format like this.
+For those wanting a quick-ish example of using snow-data, the following example
+shows how to define a few structs. These are a Vec3, Vec2, Color, and Vertex,
+which may be common in game code.
 
-How you use it, ultimately, is really up to you.
+In practice, this tends not to be highly useful except for interacting with
+some APIs over FFI, such as OpenGL. That said, if it happens to be useful,
+all the better.
 
     #!/usr/bin/env ruby -w
 
@@ -42,11 +33,12 @@ How you use it, ultimately, is really up to you.
     # it helps to illustrate that you can specify alignment).
     Vec3   = Snow::CStruct[:Vec3, 'x: float :4; y: float :4; z: float :4']
     Vec2   = Snow::CStruct[:Vec2, 'x: float :4; y: float :4']
+
     # ui8 is shorthand for uint8_t -- you can write either, and the documentation
     # for CStruct::new explains the short- and long-form names for each primitive
     # type provided by Snow-Data. Further, CStructs defined with a name, as with
     # Vec3, Vec2, and Color, have getters and setters defined in the Memory class
-    # and are usable as member types, as I'll show below.
+    # and are usable as member types (see below).
     Color  = Snow::CStruct[:Color, 'r: ui8; g: ui8; b: ui8; a: ui8']
 
     # Define a vertex type whose members are all also 4-byte aligned. The vertex
@@ -69,7 +61,7 @@ How you use it, ultimately, is really up to you.
       VERTEX_DESCRIPTION
     end
 
-    # So let's create a vertex.
+    # Now create a vertex:
     a_vertex = Vertex.new { |v|
       v.position      = Vec3.new { |p| p.x = 1; p.y = 2; p.z = 3 }
       v.normal        = Vec3.new { |n| n.x = 0.707107; n.y = 0; n.z = 0.707107 }
@@ -83,7 +75,7 @@ How you use it, ultimately, is really up to you.
 
     puts "Our vertex:\n#{stringify_vertex a_vertex}"
 
-    # For kicks, let's create an array.
+    # Create an array of 64 vertices:
     some_vertices = Vertex[64]
 
     # And set all vertices to the above vertex.
@@ -119,7 +111,3 @@ Snow-Data is licensed under a simplified BSD license, like most of my gems.
     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-    The views and conclusions contained in the software and documentation are those
-    of the authors and should not be interpreted as representing official policies,
-    either expressed or implied, of the FreeBSD Project.

data/ext/extconf.rb

@@ -5,9 +5,6 @@
 
 require 'mkmf'
 
-# Compile as C99
-$CFLAGS += " -std=c99 -Wall -pedantic"
-
 OptKVPair = Struct.new(:key, :value)
 
 option_mappings = {
@@ -53,7 +50,7 @@ else
 end
 
 $CFLAGS += ' -DSD_ALLOW_ALLOCA' if options[:allow_alloca]
-$CFLAGS += ' -DSD_SD_WARN_ON_IMPLICIT_COPY_SIZE' if options[:warn_implicit_size]
+$CFLAGS += ' -DSD_WARN_ON_IMPLICIT_COPY_SIZE' if options[:warn_implicit_size]
 $CFLAGS += ' -DSD_WARN_ON_NO_BYTESIZE_METHOD' if options[:warn_no_bytesize]
 $CFLAGS += ' -DSD_VERBOSE_COPY_LOG' if options[:debug_memory_copy]
 $CFLAGS += ' -DSD_VERBOSE_MALLOC_LOG' if options[:debug_allocations]

data/ext/snow-data/snow-data.c

@@ -5,6 +5,7 @@
 */
 
 #include "ruby.h"
+#include <limits.h>
 #include <stdint.h>
 #include <stdio.h>
 
@@ -1668,7 +1669,9 @@ static VALUE sd_memory_copy(int argc, VALUE *argv, VALUE self)
   size_t destination_offset;
   size_t byte_size;
   size_t self_byte_size;
+  #if defined(SD_WARN_ON_NO_BYTESIZE_METHOD) || defined(SD_WARN_ON_IMPLICIT_COPY_SIZE)
   int source_is_data = 0;
+  #endif
 
   sd_check_null_block(self);
   rb_check_frozen(self);
@@ -1691,11 +1694,13 @@ static VALUE sd_memory_copy(int argc, VALUE *argv, VALUE self)
     }
   }
 
-  if (RTEST(rb_obj_is_kind_of(sd_source, rb_cData))) {
+  if (RTEST(rb_obj_is_kind_of(sd_source, rb_cObject))) {
     /* Otherwise extract a pointer from the object if it's a Data object */
     const struct RData *source_data = RDATA(sd_source);
     source_pointer = ((const uint8_t *)source_data->data);
+    #if defined(SD_WARN_ON_NO_BYTESIZE_METHOD) || defined(SD_WARN_ON_IMPLICIT_COPY_SIZE)
     source_is_data = 1;
+    #endif
   } else if (RTEST(rb_obj_is_kind_of(sd_source, rb_cNumeric))) {
     /* Otherwise, if it's a Numeric, try to convert what is assumed to be an
       address to a pointer */
@@ -1890,7 +1895,8 @@ static VALUE sd_align_size(int argc, VALUE *argv, VALUE self)
 void Init_snowdata_bindings(void)
 {
   VALUE sd_snow_module  = rb_define_module("Snow");
-  VALUE sd_memory_klass = rb_define_class_under(sd_snow_module, "Memory", rb_cData);
+  VALUE sd_memory_klass = rb_define_class_under(sd_snow_module, "Memory", rb_cObject);
+  rb_undef_alloc_func(sd_memory_klass);
 
   kSD_IVAR_BYTESIZE     = rb_intern("@__bytesize__");
   kSD_IVAR_ALIGNMENT    = rb_intern("@__alignment__");

data/lib/snow-data/memory.rb

@@ -77,7 +77,13 @@ class Snow::Memory
   # overlap, refer to different chunks of memory, one might be null, etc.
   #
   def ==(other)
-    self.address == other.address && self.bytesize == other.bytesize
+    return false unless other
+
+    if other.kind_of?(Memory) || (other.respond_to?(:address) && other.respond_to?(:bytesize))
+      self.address == other.address && self.bytesize == other.bytesize
+    else
+      false
+    end
   end
 
 

data/lib/snow-data/version.rb

@@ -7,6 +7,6 @@ module Snow
   #
   # The snow-data version string.
   #
-  SNOW_DATA_VERSION = '1.3.0'.freeze
+  SNOW_DATA_VERSION = '1.4.0'.freeze
 
 end

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: snow-data
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Noel Raymond Cower
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-07-20 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies: []
 description: |
   Snow-Data is a gem for allocating memory and working with existing blocks of
   memory in a moderately safe but still technically really, really unsafe way. It
   also provides functionality for defining C-struct classes, including those with
   other structs as members.
-email: ncower@gmail.com
+email: ncower@nil.dev
 executables: []
 extensions:
 - ext/extconf.rb
@@ -24,46 +24,44 @@ extra_rdoc_files:
 - README.md
 - COPYING
 files:
+- COPYING
+- README.md
+- ext/extconf.rb
+- ext/snow-data/snow-data.c
+- lib/snow-data.rb
+- lib/snow-data/c_struct.rb
 - lib/snow-data/c_struct/array_base.rb
 - lib/snow-data/c_struct/builder.rb
 - lib/snow-data/c_struct/struct_base.rb
-- lib/snow-data/c_struct.rb
 - lib/snow-data/memory.rb
 - lib/snow-data/version.rb
-- lib/snow-data.rb
-- ext/snow-data/snow-data.c
-- ext/extconf.rb
-- COPYING
-- README.md
 homepage: https://github.com/nilium/ruby-snowdata
 licenses:
-- Simplified BSD
+- BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
-- --title
+- "--title"
 - snow-data -- C Data Types
-- --main
+- "--main"
 - README.md
-- --markup=markdown
-- --line-numbers
+- "--markup=markdown"
+- "--line-numbers"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.5
-signing_key: 
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: 'Snow-Data: for working with memory like you''ve got nothing to lose.'
 test_files: []
-has_rdoc: true