native-filenames 0.1.0.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c972ba496f5136718b8a7ca674d1d7ec6fd6f12e186719a0881ac88b0f9fc2d1
+  data.tar.gz: c958cead6aa754d3834b63008ba8c76859f80c3dd0bcce42b4ae420a135b743f
+SHA512:
+  metadata.gz: 1c786f91fbac9bd186a57a66cffd6c7c31fa97e2d067b61f7026d5aaa54f2d45609a6128208a8d43a6d12405f4f7d5549b41eb2e219720017358e9b010c0bec3
+  data.tar.gz: 7dceee8348e52dee157799b3474bb2203e9e72c5f3945df222191e8b3f63d3b3c8210923e958fa36bf542485d618b8c47c7e19bfff138ea03e73f45310717a92

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CODE_OF_CONDUCT.adoc

@@ -0,0 +1,134 @@
+
+= Contributor Covenant Code of Conduct
+
+== Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+== Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+== Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+== Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+== Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+ivo@ivoanjo.me.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+== Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+=== 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+=== 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+=== 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+=== 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+== Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant,
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by
+Mozilla's code of conduct enforcement ladder.
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+
+
+
+
+
+
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ivo Anjo
+
+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.adoc

@@ -0,0 +1,65 @@
+= `native-filenames`
+:toc:
+:toc-placement: macro
+:toclevels: 4
+:toc-title:
+
+`native-filenames` is a Ruby gem for finding out where native methods are defined.
+
+Here's a few examples:
+
+[source,ruby]
+----
+[1] pry(main)> require 'native-filenames'
+
+# Modern versions of bigdecimal use a native extension:
+[2] pry(main)> require 'bigdecimal'
+[3] pry(main)> NativeFilenames.filename_for(BigDecimal.singleton_class, :save_rounding_mode)
+=> "/rvm/gems/ruby-3.4.4/gems/bigdecimal-3.2.2/lib/bigdecimal.so"
+
+# Can also enquire about the standard library:
+[4] pry(main)> NativeFilenames.filename_for(Array, :each)
+=> "/rvm/rubies/ruby-3.4.4/bin/../lib/libruby.so.3.4"
+
+# If something is written in Ruby, then you get an error:
+[5] pry(main)> NativeFilenames.filename_for(Pry.singleton_class, :start)
+RuntimeError: direct_bind_get_cfunc failed: method_entry is not a cfunc (RuntimeError)
+----
+
+== Installation
+
+Install the gem and add to the application's `Gemfile` or `gems.rb` file by executing:
+
+[source,bash]
+----
+$ bundle add native-filenames
+----
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+[source,bash]
+----
+$ gem install native-filenames
+----
+
+== Usage
+
+Use `require "native-filenames"` to load the gem.
+
+== Requirements
+
+`native-filenames` has been tested on Ruby 2.5+. It can probably run on older Rubies too, but I have no use-case for it. PRs to extend support for older Rubies (and what's your use-case) are welcome :)
+
+=== Installation and deployment
+
+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 https://rubygems.org[rubygems.org]. To run specs, run `bundle exec rake spec`.
+
+To run all actions (build the extension, check linting, and run specs), run `bundle exec rake`.
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ivoanjo/native-filenames. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the https://github.com/ivoanjo/native-filenames/blob/master/CODE_OF_CONDUCT.adoc[code of conduct].
+
+== Code of Conduct
+
+Everyone interacting in the native-filenames project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the https://github.com/ivoanjo/native-filenames/blob/master/CODE_OF_CONDUCT.adoc[code of conduct].

data/ext/native_filenames_extension/extconf.rb

@@ -0,0 +1,54 @@
+# native-filenames: Ruby gem for finding out where native methods are defined
+# Copyright (c) 2025 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of native-filenames.
+#
+# MIT License
+#
+# 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.
+
+if ["jruby", "truffleruby"].include?(RUBY_ENGINE)
+  raise \
+    "\n#{"-" * 80}\nSorry! This gem is unsupported on #{RUBY_ENGINE}. Since it relies on a lot of guts of MRI Ruby, " \
+    "it's impossible to make a direct port.\n" \
+    "Perhaps a #{RUBY_ENGINE} equivalent could be created -- help is welcome! :)\n#{"-" * 80}"
+end
+
+require "mkmf"
+
+append_cflags("-std=gnu99")
+append_cflags("-Wno-declaration-after-statement")
+append_cflags("-Wno-compound-token-split-by-macro")
+append_cflags("-Werror-implicit-function-declaration")
+append_cflags("-Wunused-parameter")
+append_cflags("-Wold-style-definition")
+append_cflags("-Wall")
+append_cflags("-Wextra")
+append_cflags("-Werror") if ENV["ENABLE_WERROR"] == "true"
+
+# Used to get native filenames (dladdr1 is preferred, so we only check for the other if not available)
+# Note it's possible none are available
+if have_header("dlfcn.h")
+  (have_struct_member("struct link_map", "l_name", "link.h") && have_func("dladdr1")) || have_func("dladdr")
+else
+  have_header("windows.h")
+end
+
+create_header
+create_makefile "native_filenames_extension"

data/lib/native-filenames.rb

@@ -0,0 +1,32 @@
+# native-filenames: Ruby gem for finding out where native methods are defined
+# Copyright (c) 2025 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of native-filenames.
+#
+# MIT License
+#
+# 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.
+
+# frozen_string_literal: true
+
+require_relative "native_filenames/version"
+require "native_filenames_extension"
+
+module NativeFilenames
+end

data/lib/native_filenames/version.rb

@@ -0,0 +1,30 @@
+# native-filenames: Ruby gem for finding out where native methods are defined
+# Copyright (c) 2025 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of native-filenames.
+#
+# MIT License
+#
+# 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.
+
+# frozen_string_literal: true
+
+module NativeFilenames
+  VERSION = "0.1.0.dev"
+end

data/native-filenames.gemspec

@@ -0,0 +1,51 @@
+# native-filenames: Ruby gem for finding out where native methods are defined
+# Copyright (c) 2025 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of native-filenames.
+#
+# MIT License
+#
+# 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.
+
+# frozen_string_literal: true
+
+require_relative "lib/native_filenames/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "native-filenames"
+  spec.version = NativeFilenames::VERSION
+  spec.authors = ["Ivo Anjo"]
+  spec.email = ["ivo@ivoanjo.me"]
+
+  spec.summary = "Ruby gem for finding out where native methods are defined"
+  spec.homepage = "https://github.com/ivoanjo/native-filenames"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|examples|ext)/|\.(?:git|travis|circleci)|appveyor)}) ||
+        [".editorconfig", ".ruby-version", ".standard.yml", "gems.rb", "Rakefile"].include?(f)
+    end
+  end
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/native_filenames_extension/extconf.rb"]
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: native-filenames
+version: !ruby/object:Gem::Version
+  version: 0.1.0.dev
+platform: ruby
+authors:
+- Ivo Anjo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- ivo@ivoanjo.me
+executables: []
+extensions:
+- ext/native_filenames_extension/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.adoc
+- LICENSE
+- README.adoc
+- ext/native_filenames_extension/extconf.rb
+- lib/native-filenames.rb
+- lib/native_filenames/version.rb
+- native-filenames.gemspec
+homepage: https://github.com/ivoanjo/native-filenames
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Ruby gem for finding out where native methods are defined
+test_files: []