native_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60f2b8067ce19f7f2bdfb9bad44dc3577284274b4216badb79a619242c256813
+  data.tar.gz: 784237bf405374032c60ab792a28a6d6ac9f4d09834b06894cb38c0919943730
+SHA512:
+  metadata.gz: 7d01a030d69b3df024e1742b9fbd4e9f33c1e29369c55a5bd02161043322dde7e676c29161e2a5627bb1ebf8ae9573043920d9b5eb1901433499c1ffdc8c8060
+  data.tar.gz: 23c1bdcce43e7ae85bbadc646ba2d75bd89d9f5ba6ccc02d842a6c12804dc13a310165b42606522bd8ea7f2f251d7ca8c60c1820539ccb6ef3d4c1a1116dac3d

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Lint/Debugger:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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 email 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
+[INSERT CONTACT METHOD].
+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][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 sebi
+
+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.md

@@ -0,0 +1,108 @@
+# NativeRuby 🚀
+
+NativeRuby is a standard library for Ruby implemented in Ruby, designed to take advantage of the YJIT compiler for improved performance. It provides optimized, native Ruby implementations of various core methods and iterators while maintaining the familiar Ruby API. 🔥
+
+## Important Note on Performance ⚠️
+
+**The performance improvements provided by NativeRuby are primarily seen when YJIT is enabled.** Without YJIT, you may not notice significant performance gains. For the best results, always use NativeRuby with YJIT enabled.
+
+## Requirements 📋
+
+- Ruby version: >= 3.0.0
+- YJIT enabled for optimal performance
+
+## Installation 💎
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'native_ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install native_ruby
+
+## Usage 🛠️
+
+To use NativeRuby in your project, you first need to require it:
+
+```ruby
+require 'native_ruby'
+```
+
+Then, you can configure which optimized methods you want to use:
+
+```ruby
+NativeRuby.config do |c|
+  # Load all immutable iterators
+  c.load_all_immutable_iterators!
+
+  # Load all mutable iterators
+  c.load_all_mutable_iterators!
+
+  # Load all optimized methods for a specific class
+  c.require_all_for_class!(Array)
+
+  # Load a specific method for a class
+  c.load(:class, { class: Array, method: :bsearch })
+
+  # Load a specific iterator (mutable or immutable)
+  c.load(:iterators, { class: Array, method: :each, mutable: false })
+end
+```
+
+### Configuration Options ⚙️
+
+- `load_all_immutable_iterators!`: Loads all immutable iterator optimizations.
+- `load_all_mutable_iterators!`: Loads all mutable iterator optimizations.
+- `require_all_for_class!(klass)`: Loads all optimized methods for a given class.
+- `load(type, options)`: Loads a specific optimized method or iterator.
+    - For class methods: `type: :class, class: ClassName, method: :method_name`
+    - For iterators: `type: :iterators, class: ClassName, method: :method_name, mutable: boolean`
+
+## YJIT and Performance 🚀
+
+NativeRuby is specifically designed to work with YJIT (Yet Another Just-In-Time Compiler for Ruby). The performance improvements are primarily realized when YJIT is enabled.
+
+To use NativeRuby with YJIT and see the performance benefits:
+
+1. Ensure you're using Ruby 3.1 or later.
+2. Enable YJIT when running your Ruby script:
+
+```
+ruby --yjit your_script.rb
+```
+
+Without YJIT enabled, you may not see significant performance improvements. Always use NativeRuby with YJIT for optimal results.
+
+## Development 🔧
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/sebyx07/native_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/sebyx07/native_ruby/blob/master/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 NativeRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sebyx07/native_ruby/blob/master/CODE_OF_CONDUCT.md).
+
+## Author 👨‍💻
+
+- **sebi** - [GitHub](https://github.com/sebyx07)
+
+## Links 🔗
+
+- [Homepage](https://github.com/sebyx07/native_ruby)
+- [Source Code](https://github.com/sebyx07/native_ruby)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/native_ruby/configuration.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module NativeRuby
+  class Configuration
+    def load_all_immutable_iterators!
+      Dir.glob(File.join(File.dirname(__FILE__), 'iterators', 'immutable', '**', '*.rb')).each do |file|
+        require file
+      end
+    end
+
+    def load_all_mutable_iterators!
+      Dir.glob(File.join(File.dirname(__FILE__), 'iterators', 'mutable', '**', '*.rb')).each do |file|
+        require file
+      end
+    end
+
+    def require_all_for_class!(klass)
+      Dir.glob(File.join(File.dirname(__FILE__), klass.name.downcase, '**', '*.rb')).each do |file|
+        require file
+      end
+    end
+
+    def load(type, options = {})
+      klass = options[:class]
+      method = options[:method]
+      mutable = options[:mutable]
+      mutable_path = mutable ? 'mutable' : 'immutable'
+
+      if type.to_s == 'class'
+        path = File.join(File.dirname(__FILE__), klass.name.downcase, "#{method}.rb")
+        raise "Cannot load #{klass}.#{method}" unless File.exist?(path)
+
+        return require path
+      end
+
+      path = File.join(File.dirname(__FILE__), type.to_s, mutable_path, "#{klass.name.downcase}", "#{method}.rb")
+      raise "Cannot load #{mutable_path} #{klass}.#{method}" unless File.exist?(path)
+
+      require path
+    end
+  end
+end

data/lib/native_ruby/iterators/immutable/array/each.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Array immutable each method
+class Array
+  # Iterates the given block for each element with index.
+  #
+  # This implementation is considered immutable because it does not modify
+  # the array's size or structure during iteration. The array's length is
+  # calculated once at the beginning and remains constant throughout the iteration.
+  #
+  # If no block is given, returns an Enumerator object.
+  #
+  # @yield [Object] Passes each element of the array to the block.
+  # @return [Array] Returns self.
+  # @return [Enumerator] If no block is given.
+  def each
+    return to_enum(:each) { self.length } unless block_given?
+
+    i = 0
+    length = self.length
+    while i < length
+      yield self[i]
+      i = i.succ
+    end
+
+    self
+  end
+end

data/lib/native_ruby/iterators/immutable/array/map.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Array
+  # Creates a new array containing the values returned by the block.
+  #
+  # This implementation is considered immutable for two reasons:
+  # 1. It does not modify the original array's size or structure.
+  # 2. It creates and returns a new array with the mapped values.
+  #
+  # The original array's length is calculated once at the beginning
+  # and remains constant throughout the iteration.
+  #
+  # If no block is given, returns an Enumerator object.
+  #
+  # @yield [Object] Passes each element of the array to the block.
+  # @return [Array] A new array with the results of running the block once for every element.
+  # @return [Enumerator] If no block is given.
+  def map
+    return to_enum(:map) { self.length } unless block_given?
+
+    i = 0
+    result = []
+    length = self.length
+    while i < length
+      result << yield(self[i])
+      i = i.succ
+    end
+    result
+  end
+end

data/lib/native_ruby/iterators/mutable/array/each.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Array
+class Array
+  # Iterates the given block for each element with index.
+  #
+  # This implementation is considered mutable because:
+  # 1. It recalculates self.length on each iteration, allowing for potential
+  #    changes to the array's size during iteration.
+  # 2. If the array is modified during iteration (e.g., by the yielded block),
+  #    the method will operate on the modified array.
+  #
+  # If no block is given, returns an Enumerator object.
+  #
+  # @yield [Object] Passes each element of the array to the block.
+  # @return [Array] Returns self.
+  # @return [Enumerator] If no block is given.
+  def each
+    return to_enum(:each) { self.length } unless block_given?
+
+    i = 0
+    while i < self.length  # Note: self.length is evaluated on each iteration
+      yield self[i]
+      i = i.succ
+    end
+    self
+  end
+end

data/lib/native_ruby/iterators/mutable/array/map.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Array
+  # Creates a new array containing the values returned by the block.
+  #
+  # This implementation is considered mutable because:
+  # 1. It recalculates self.length on each iteration, allowing for potential
+  #    changes to the array's size during iteration.
+  # 2. If the original array is modified during iteration (e.g., by the yielded block),
+  #    the method will operate on the modified array.
+  #
+  # Note that while the original array can be mutated during iteration,
+  # the method still returns a new array with the mapped values.
+  #
+  # If no block is given, returns an Enumerator object.
+  #
+  # @yield [Object] Passes each element of the array to the block.
+  # @return [Array] A new array with the results of running the block once for every element.
+  # @return [Enumerator] If no block is given.
+  def map
+    return to_enum(:map) { self.length } unless block_given?
+
+    i = 0
+    result = []
+    while i < self.length  # Note: self.length is evaluated on each iteration
+      result << yield(self[i])
+      i = i.succ
+    end
+    result
+  end
+end

data/lib/native_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NativeRuby
+  VERSION = '0.1.0'
+end

data/lib/native_ruby.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'native_ruby/version'
+require_relative 'native_ruby/configuration'
+
+module NativeRuby
+  class Error < StandardError; end
+  def self.config
+    @config ||= Configuration.new
+    yield @config if block_given?
+  end
+end

data/sig/native_ruby.rbs

@@ -0,0 +1,4 @@
+module NativeRuby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: native_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sebi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-10 00:00:00.000000000 Z
+dependencies: []
+description: Standard library for Ruby in ruby, taking the advantage of YJIT compiler
+email:
+- gore.sebyx@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/native_ruby.rb
+- lib/native_ruby/configuration.rb
+- lib/native_ruby/iterators/immutable/array/each.rb
+- lib/native_ruby/iterators/immutable/array/map.rb
+- lib/native_ruby/iterators/mutable/array/each.rb
+- lib/native_ruby/iterators/mutable/array/map.rb
+- lib/native_ruby/version.rb
+- sig/native_ruby.rbs
+homepage: https://github.com/sebyx07/native_ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sebyx07/native_ruby
+  source_code_uri: https://github.com/sebyx07/native_ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: Standard library for Ruby in ruby
+test_files: []