unsafe 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3046df9216d3ed07a55828695525d493d12e7ff3c5e114ca124727d9e97a67e
-  data.tar.gz: 28b1d67f0bebab2e8bd98b923f5d2b3a5e55b4bd486860a9143526653fddd463
+  metadata.gz: cec5fa74547da5f4ce7a8e1fd42719076270bd0941aae521bf5c649eeee5f9e1
+  data.tar.gz: 3740e000a56441dc9bfaa414e88b0aff9424e7e1d95b4a53ffbda213384f79bc
 SHA512:
-  metadata.gz: e5eb3dc2cf9c3cf31b5feb317d0ec983502a2ddccef87f73a998cfe584e2a0d69b61d0025d765961f507da204206a0149cd8c47e0b97599dee6287f197e0a440
-  data.tar.gz: a5ae1408d0f90691d3bbe471877c3e76645a23e5c5da68805e6b549b544a600620bce49b8deb6cf89a574ad7e85f1ea5879a390d2d78675dd3ba5a0a07853cfc
+  metadata.gz: b487956c7c148d05a61ef80d2097b4f62e74946405fe84f15fb3c674f3fd48fcf0baa35aeaedf04ec85900e53ccd0e520e149988c5d0d5c7d8e10ad0d340fe15
+  data.tar.gz: 2cd9e9fda96f20a0b2340da12fbcc774034f20b5295ab89cf273707f59f32f52921667ad75eefd87a873beec1b236eac36fd6a5c6b8760f70d969ae8c77277c3

data/README.md

@@ -1,39 +1,35 @@
 # Unsafe
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/unsafe`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/jhawthorn/unsafe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jhawthorn/unsafe/blob/main/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Unsafe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jhawthorn/unsafe/blob/main/CODE_OF_CONDUCT.md).
+Have you ever been annoyed that Ruby prevents you from accessing out of bounds elements from Strings or Arrays?
+
+`unsafe` unlocks the full potential of your Ruby programs by allowing accessing and modifying out of bounds memory!
+
+```
+$ gem i unsafe
+$ irb
+>> require "unsafe"
+>> arr = [1,2,3]
+=> [1, 2, 3]
+>> unsafe { arr[1] }
+=> 2
+>> unsafe { arr[2] }
+=> 3
+>> unsafe { arr[3] }
+=> 2.000000000000003
+>> unsafe { arr[-1] }
+=> Array
+>> unsafe { arr[1000000000] }
+[BUG] Segmentation fault at 0x00000002f89824d0
+
+-- Crash Report log information --------------------------------------------
+   See Crash Report log file in one of the following locations:
+```
+
+```
+>> str = "hello, world"
+=> "hello, world"
+>> unsafe { str[-8, 8] }.unpack1("Q")
+=> 12
+>> str.length
+=> 12
+```

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/extensiontask"
+require "minitest/test_task"
 
 task build: :compile
 
@@ -11,4 +12,6 @@ Rake::ExtensionTask.new("unsafe", GEMSPEC) do |ext|
   ext.lib_dir = "lib/unsafe"
 end
 
-task default: %i[clobber compile]
+Minitest::TestTask.create
+
+task default: %i[clobber compile test]

data/ext/unsafe/unsafe.c

@@ -6,10 +6,29 @@ VALUE array_aref(VALUE self, VALUE array, VALUE idx) {
     return RARRAY_PTR(array)[FIX2LONG(idx)];
 }
 
+VALUE array_aset(VALUE self, VALUE array, VALUE idx, VALUE value) {
+    return RARRAY_PTR(array)[FIX2LONG(idx)] = value;
+}
+
+VALUE string_aref(int argc, VALUE *argv, VALUE self) {
+    long idx, len = 1;
+    if (argc == 3) {
+        len = NUM2INT(argv[2]);
+    } else {
+        rb_check_arity(argc, 2, 3);
+    }
+    VALUE string = argv[0];
+    idx = NUM2INT(argv[1]);
+
+    return rb_str_new(RSTRING_PTR(string) + idx, len);
+}
+
 RUBY_FUNC_EXPORTED void
 Init_unsafe(void)
 {
   rb_mUnsafe = rb_define_module("Unsafe");
 
   rb_define_singleton_method(rb_mUnsafe, "array_aref", array_aref, 2);
+  rb_define_singleton_method(rb_mUnsafe, "array_aset", array_aset, 3);
+  rb_define_singleton_method(rb_mUnsafe, "string_aref", string_aref, -1);
 }

data/lib/unsafe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Unsafe
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/unsafe.rb

@@ -25,5 +25,24 @@ Module.new do
     end
   end
 
+  def []=(...)
+    if Thread.current[:__unsafe]
+      Unsafe.array_aset(self, ...)
+    else
+      super
+    end
+  end
   Array.prepend self
 end
+
+Module.new do
+  def [](...)
+    if Thread.current[:__unsafe]
+      Unsafe.string_aref(self, ...)
+    else
+      super
+    end
+  end
+
+  String.prepend self
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: unsafe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
-- John Hawthorn
-autorequire:
+- John "Danger" Hawthorn
 bindir: exe
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies: []
 description: unsafe {} blocks. Just like in Rust
 email:
@@ -34,7 +33,6 @@ metadata:
   homepage_uri: https://github.com/jhawthorn/unsafe
   source_code_uri: https://github.com/jhawthorn/unsafe
   changelog_uri: https://github.com/jhawthorn/unsafe
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: unsafe {} blocks. Just like in Rust
 test_files: []