hello_rust 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19e0bdf829a5269838f604eed25fd9847c8235d0e73ea352f74ab00de7893c37
+  data.tar.gz: 0cb3ce616c1b6f12cbaa1a6fabac9d9c71ce37da937291b58cbce5aef9a05cfa
+SHA512:
+  metadata.gz: 0b0d3208bd9aee1752eac232c95effd903068b5901abfa4857a51e4c633772cc0e0c8d96400dafa65c81a554aa3960393e7b948e28b8d8ca242bfafe9d3f7903
+  data.tar.gz: d8bd43880dd9cea797e6f30b792fbde429d1538fbaa3da8fa828d765a8339f3d3a3197fe0ae9e14c270950875ed21bf32408dc81bf0e0f621400199d9e1be7f0

data/.gitignore

@@ -0,0 +1,17 @@
+/target
+Cargo.lock
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.gem
+
+# rspec failure tracking
+.rspec_status
+

data/.rspec

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

data/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "hello_rust_gem"
+version = "0.1.0"
+authors = ["irxground <irxnjhtchlnrw@gmail.com>"]
+edition = "2018"
+description = "a Ruby native extension using Rust with minimal dependencies"
+homepage = "https://github.com/irxground/hello_rust_gem"
+repository = "https://github.com/irxground/hello_rust_gem"
+license = "MIT"
+
+[lib]
+crate-type = ["cdylib"]

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hello_rust.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "rufo"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    hello_rust (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rufo (0.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hello_rust!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rufo
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 irxground
+
+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,11 @@
+# hello_rust_gem
+
+This project aims to create a Ruby native extension using Rust with minimal dependencies.
+
+## Confirmed platform
+
+- [x] Windows 10 (64bit) + RubyInstaller (x64)
+- [x] Windows 10 (64bit) + RubyInstaller (x86)
+- [ ] macOS Catalina
+- [x] macOS Catalina + rbenv
+- [x] Amazon linux 2 (x86_64) + rbenv

data/Rakefile

@@ -0,0 +1,12 @@
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+require_relative "ext/build_task.rb"
+BuildTask.new("hello_rust", __dir__, File.join(__dir__, "lib"))
+
+task :fmt do
+  system "cargo fmt"
+  system "rufo ."
+end
+
+task :default => [:clobber, :install, :spec]

data/build.rs

@@ -0,0 +1,15 @@
+use std::process::Command;
+
+fn rb_config(key: &str) -> String {
+    let output = Command::new("ruby")
+        .args(&["-e", &format!("print RbConfig::CONFIG['{}']", key)])
+        .output()
+        .expect("failed run ruby");
+
+    return String::from_utf8(output.stdout).unwrap();
+}
+
+fn main() {
+    println!("cargo:rustc-link-search={}", rb_config("libdir"));
+    println!("cargo:rustc-link-lib={}", rb_config("RUBY_SO_NAME"));
+}

data/ext/Rakefile

@@ -0,0 +1,6 @@
+require_relative "./build_task"
+BuildTask.new("hello_rust", File.expand_path("../..", __FILE__), ENV.fetch("RUBYLIBDIR"))
+
+task :default => :install do
+  Rake::Task[:clean].invoke
+end

data/ext/build_task.rb

@@ -0,0 +1,63 @@
+require "json"
+require "rake/tasklib"
+
+class BuildTask < Rake::TaskLib
+  attr_reader :name, :lib_dir
+  attr_reader :manifest_file
+
+  def initialize(name, cargo_dir, lib_dir)
+    @name = name
+    @lib_dir = lib_dir
+    @manifest_file = File.join(cargo_dir, "Cargo.toml")
+
+    define_tasks
+  end
+
+  def define_tasks
+    target_so_dir = File.join(lib_dir, name)
+    target_so = File.join(target_so_dir, "#{name}.#{RbConfig::CONFIG["DLEXT"]}")
+
+    task :cargo do
+      unless system "cargo", "-V"
+        raise "`cargo` command not found. Please install Rust compiler: https://www.rust-lang.org/"
+      end
+    end
+
+    desc "Remove build cache"
+    task :clean => :cargo do
+      sh "cargo", "clean", "--manifest-path", manifest_file
+    end
+
+    desc "Remove build cache and compiled library"
+    task :clobber => :clean do
+      rm_f target_so
+    end
+
+    desc "Compile native extension"
+    task :build => :cargo do
+      env = {}
+      if RUBY_PLATFORM =~ /mingw/
+        env["RUSTUP_TOOLCHAIN"] = "stable-#{RbConfig::CONFIG["host_cpu"]}-pc-windows-gnu"
+      end
+      sh env, "cargo", "build", "--release", "--manifest-path", manifest_file
+    end
+
+    directory target_so_dir
+
+    desc "Place compiled library"
+    task :install => [:build, target_so_dir] do
+      cp cargo_output, target_so, preserve: true, verbose: true
+    end
+  end
+
+  def cargo_output
+    metadata = JSON.parse(`cargo metadata --format-version=1 --manifest-path #{manifest_file}`)
+    cargo_name = metadata.dig("packages", 0, "name")
+    filename = case RUBY_PLATFORM
+      when /mingw/; "#{cargo_name}.dll"
+      when /darwin/; "lib#{cargo_name}.dylib"
+      when /linux/; "lib#{cargo_name}.so"
+      end
+    File.join(metadata["target_directory"], "release", filename)
+  end
+end

data/hello_rust.gemspec

@@ -0,0 +1,29 @@
+require "json"
+# require_relative 'lib/hello_rust/version'
+
+Gem::Specification.new do |spec|
+  cargo_metadata = JSON.parse(`cargo metadata --format-version=1`).dig("packages", 0)
+
+  spec.name = "hello_rust"
+  spec.version = cargo_metadata["version"]
+  spec.authors = ["irxground"]
+  spec.email = ["irxnjhtchlnrw@gmail.com"]
+
+  spec.summary = cargo_metadata["description"]
+  spec.homepage = cargo_metadata["homepage"] || cargo_metadata["repository"]
+  spec.license = cargo_metadata["license"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = cargo_metadata["repository"]
+
+  # 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.extensions = ["ext/Rakefile"]
+  spec.requirements << 'Rust compiler'
+end

data/lib/hello_rust.rb

@@ -0,0 +1 @@
+require "hello_rust/hello_rust"

data/src/lib.rs

@@ -0,0 +1,45 @@
+use std::ffi;
+
+mod ruby {
+    use std::ffi;
+
+    #[repr(transparent)]
+    pub struct Value(usize);
+
+    extern "C" {
+        // VALUE rb_define_module(const char *name)
+        fn rb_define_module(name: *const i8) -> Value;
+
+        // void rb_define_const(VALUE klass, const char *name, VALUE val)
+        fn rb_define_const(klass: Value, name: *const i8, val: Value);
+
+        // VALUE rb_str_new(const char *ptr, long len)
+        fn rb_str_new(ptr: *const u8, len: usize) -> Value;
+    }
+
+    #[inline]
+    pub fn define_module(name: &ffi::CStr) -> Value {
+        unsafe { rb_define_module(name.as_ptr()) }
+    }
+
+    #[inline]
+    pub fn define_const(klass: Value, name: &ffi::CStr, val: Value) {
+        unsafe { rb_define_const(klass, name.as_ptr(), val) }
+    }
+
+    #[inline]
+    pub fn new_string(str: &str) -> Value {
+        unsafe { rb_str_new(str.as_ptr(), str.len()) }
+    }
+}
+
+fn cstring(str: &str) -> ffi::CString {
+    ffi::CString::new(str).unwrap()
+}
+
+#[export_name = "Init_hello_rust"]
+pub extern "C" fn init() {
+    let module = ruby::define_module(&cstring("HelloRust"));
+    let version = ruby::new_string(env!("CARGO_PKG_VERSION"));
+    ruby::define_const(module, &cstring("VERSION"), version)
+}

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: hello_rust
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- irxground
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-17 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- irxnjhtchlnrw@gmail.com
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Cargo.toml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- build.rs
+- ext/Rakefile
+- ext/build_task.rb
+- hello_rust.gemspec
+- lib/hello_rust.rb
+- src/lib.rs
+homepage: https://github.com/irxground/hello_rust_gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/irxground/hello_rust_gem
+  source_code_uri: https://github.com/irxground/hello_rust_gem
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Rust compiler
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: a Ruby native extension using Rust with minimal dependencies
+test_files: []