mmap-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fb151f030e0b0589643543db0b58b68ae8cec87809e9530f5c234279086f66e
+  data.tar.gz: dbab0de3484efd158f45735baa60d1ecc9123ca7697235aac73d09e9c6099387
+SHA512:
+  metadata.gz: dab2685661d12266b3ad9cc8ae852bdf90077b8d76e3d378538fb0448802c8da4e46d0e27c45173517c402b8c602fa8830cd5f195e98d43960192443ae11594d
+  data.tar.gz: eebdf6617f5c2d1ae3c69841bac49a40b3737c4ee3bd00659072c4ceec306b1aff3a882a2466737a4d18265ec5f663c3ae882eae1c0503c7720bf8720d6bf4e3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-19
+
+- Rewrite tenderlove/mmap with modern Ruby support

data/README.md

@@ -0,0 +1,92 @@
+# MmapRuby
+
+![Version](https://img.shields.io/gem/v/mmap-ruby)
+![Build](https://img.shields.io/github/actions/workflow/status/joshuay03/mmap-ruby/.github/workflows/main.yml?branch=main)
+
+[`mmap`](https://en.wikipedia.org/wiki/Mmap) wrapper for Ruby.
+
+A modern fork of https://github.com/tenderlove/mmap.
+
+**Docs:** https://joshuay03.github.io/mmap-ruby
+
+**Example:**
+
+```ruby
+# frozen_string_literal: true
+
+require "mmap-ruby"
+
+PAGESIZE = 4096
+
+file = File.open("aa", "w")
+file.write("\0" * PAGESIZE)
+file.write("test")
+file.write("\0" * PAGESIZE)
+file.close
+
+mmap = Mmap.new("aa", "rw", offset: 0)
+p mmap.size == "test".size + (2 * PAGESIZE)
+p mmap.scan(/[a-z.]+/) == ["test"]
+p mmap.index("test") == PAGESIZE
+p mmap.rindex("test") == PAGESIZE
+p mmap.sub!(/[a-z.]+/, "toto") == mmap
+p mmap.scan(/[a-z.]+/) == ["toto"]
+begin
+  mmap.sub!(/[a-z.]+/, "alpha")
+  puts "not OK, must give an error"
+rescue
+  puts "OK: #$!"
+end
+mmap.munmap
+
+mmap = Mmap.new("aa", "rw")
+p mmap.index("toto") == PAGESIZE
+p mmap.sub!(/([a-z.]+)/, "alpha") == mmap
+p $& == "toto"
+p $1 == "toto"
+p mmap.index("toto") == nil
+p mmap.index("alpha") == PAGESIZE
+p mmap.size == 5 + 2 * PAGESIZE
+mmap.gsub!(/\0/, "X")
+p mmap.size == 5 + 2 * PAGESIZE
+
+File.delete("aa")
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add mmap-ruby
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install mmap-ruby
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests.
+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/[joshuay03]/mmap-ruby. 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/[joshuay03]/mmap-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [Ruby license](https://www.ruby-lang.org/en/about/license.txt).
+
+## Code of Conduct
+
+Everyone interacting in the MmapRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/[joshuay03]/mmap-ruby/blob/main/CODE_OF_CONDUCT.md).

data/ext/mmap_ruby/extconf.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+# Makes all symbols private by default to avoid unintended conflict
+# with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
+# selectively, or entirely remove this flag.
+append_cflags("-fvisibility=hidden")
+
+create_makefile("mmap_ruby/mmap_ruby")