fib_rust 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f8f68fb59b27416b76971650329df902aebb36079c720391b4293a0125bf813
+  data.tar.gz: 14ecab3caf75a52dd12a2eba734b729d27c169461e8227a951e731b351d4d63d
+SHA512:
+  metadata.gz: 2bbbac9511674704769b77ab3f62d5612a955a3a3362265e0121b879c424b9fb4b9b1f4d2cb4d73042682dd5f703826ff39e7ff7a55fe7cdc239e9a904b60775
+  data.tar.gz: 5b30c639c9ba323e1a3e86690eddb4d3cc32802f8e55f2e8b2157c4a0aa179b03f875cc6736830b6ed0ed35757f0b493db051cabbcf00c83be3f2312d2c8b6f6

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+#Added by cargo
+/rust/target
+/rust/Cargo.lock

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fib_rust.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    fib_rust (0.1.0)
+      ffi
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.8.2)
+    diff-lcs (1.3)
+    ffi (1.13.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler (~> 2.0)
+  fib_rust!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dmitry Gruzd
+
+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,59 @@
+# FibRust
+
+This is rust-backed version of fibonacci function.
+
+## Performance comparison
+
+```
+❯ rake benchmark
+❯ rake benchmark
+Calculating -------------------------------------
+                ruby    542.633k (± 0.4%) i/s -      2.721M in   5.014871s
+      ruby_recursive      4.761  (± 0.0%) i/s -     24.000  in   5.041325s
+    ruby_memoization    195.055k (± 1.2%) i/s -    989.456k in   5.073389s
+            fib_rust      8.051M (± 0.5%) i/s -     40.276M in   5.002752s
+
+Comparison:
+            fib_rust:  8051043.9 i/s
+                ruby:   542633.4 i/s - 14.84x  (± 0.00) slower
+    ruby_memoization:   195055.3 i/s - 41.28x  (± 0.00) slower
+      ruby_recursive:        4.8 i/s - 1691152.45x  (± 0.00) slower
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fib_rust'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fib_rust
+
+## Usage
+
+TODO: Write usage instructions here
+```ruby
+2.6.6 :001 > FibRust[40]
+ => 102334155
+```
+
+## 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 tags, 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/[USERNAME]/fib_rust.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,62 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :rust_build do
+  require 'ffi'
+  `cd rust && cargo build --release`
+  `mv -f ./rust/target/release/libfib.#{FFI::Platform::LIBSUFFIX} ./lib/fib_rust/`
+end
+
+task :rust_test do
+  `cd rust && cargo test`
+end
+
+task :build => :rust_build
+task :spec => :rust_build
+
+task :test => %w[rust_test spec]
+
+task :benchmark do
+  require 'fib_rust'
+  require 'benchmark/ips'
+
+  def ruby_fib(iterations)
+    first_num, second_num = [0, 1]
+
+    iterations.times do
+      first_num, second_num = second_num, first_num + second_num
+    end
+
+    first_num
+  end
+
+  def ruby_recursive(iterations)
+    return iterations if (0..1).include? iterations
+
+    (ruby_recursive(iterations - 1) + ruby_recursive(iterations - 2))
+  end
+
+  def ruby_memoization(iterations)
+    fib = Hash.new do |numbers, index|
+      numbers[index] = fib[index - 2] + fib[index - 1]
+    end.update(0 => 0, 1 => 1)
+
+    fib[iterations]
+  end
+
+  ITERATIONS = 30
+
+  Benchmark.ips do |x|
+    x.report('ruby') { ruby_fib(ITERATIONS) }
+    x.report('ruby_recursive') { ruby_recursive(ITERATIONS) }
+    x.report('ruby_memoization') { ruby_memoization(ITERATIONS) }
+    x.report('fib_rust') { FibRust[ITERATIONS] }
+
+    x.compare!
+  end
+end
+task :bench => :benchmark

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fib_rust"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fib_rust.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fib_rust/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fib_rust"
+  spec.version       = FibRust::VERSION
+  spec.authors       = ["Dmitry Gruzd"]
+  spec.email         = ["dgruzd@gitlab.com"]
+
+  spec.summary       = %q{This is rust-backed fibonacci number generator}
+  spec.description   = %q{Get the fibonacci number}
+  spec.homepage      = "https://gitlab.com/dgruzd/fib_rust"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://gitlab.com/dgruzd/fib_rust"
+    spec.metadata["changelog_uri"] = "https://gitlab.com/dgruzd/fib_rust"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ffi"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "benchmark-ips"
+end

data/lib/fib_rust.rb

@@ -0,0 +1,8 @@
+require 'fib_rust/version'
+require 'fib_rust/ffi'
+
+module FibRust
+  def self.[](n)
+    FibRust.fib(n)
+  end
+end

data/lib/fib_rust/ffi.rb

@@ -0,0 +1,8 @@
+require 'ffi'
+
+module FibRust
+  extend FFI::Library
+  lib_name = "libfib.#{::FFI::Platform::LIBSUFFIX}"
+  ffi_lib File.expand_path(lib_name, __dir__)
+  attach_function :fib, [:uint], :uint
+end

data/lib/fib_rust/version.rb

@@ -0,0 +1,3 @@
+module FibRust
+  VERSION = "0.1.0"
+end

data/rust/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "fib"
+version = "0.1.0"
+authors = ["Dmitry Gruzd <dgruzd@gitlab.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]

data/rust/src/lib.rs

@@ -0,0 +1,18 @@
+#[no_mangle]
+pub extern "C" fn fib(n: u32) -> u32 {
+    let mut x = (0, 1);
+    for _ in 0..n {
+        x = (x.1, x.0 + x.1)
+    }
+    x.0
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn it_works() {
+        assert_eq!(fib(5), 5);
+    }
+}

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: fib_rust
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Gruzd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get the fibonacci number
+email:
+- dgruzd@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fib_rust.gemspec
+- lib/fib_rust.rb
+- lib/fib_rust/ffi.rb
+- lib/fib_rust/libfib.dylib
+- lib/fib_rust/libfib.so
+- lib/fib_rust/version.rb
+- rust/Cargo.toml
+- rust/src/lib.rs
+homepage: https://gitlab.com/dgruzd/fib_rust
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/dgruzd/fib_rust
+  source_code_uri: https://gitlab.com/dgruzd/fib_rust
+  changelog_uri: https://gitlab.com/dgruzd/fib_rust
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: This is rust-backed fibonacci number generator
+test_files: []