twips 0.11.3.pre.dev

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c18541fb2b07353ba3d3ee6ee802524e9001b88d0efea12c3b8730bb6f56691b
+  data.tar.gz: ccf9e79ea763c4c1ccd2893f67c17f13787038f5733ebb239ef8844e9afa1d67
+SHA512:
+  metadata.gz: 580e1d4e37f8413e8412ad1569bfe5e6886ba8e162a35eee2a0f3bb57c7803503e277b484b6e2e6314771c3178c4dfb14afbe58e63c81c377b16bfdc2af3fc42
+  data.tar.gz: 83f8041e97e16d7345ef765fc061b6c87803c3cb4b23bf62548be09205d8f5d6cf23f58a1fb278b61d8e6399c11ea35813a7b9a2c5559d835c10fea3cc0858c7

data/ext/twips/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "twips-rb"
+version.workspace = true
+license.workspace = true
+edition.workspace = true
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+magnus = { version = "0.8.2" }
+twips = { path = "../../../lib" }

data/ext/twips/extconf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+# https://github.com/oxidize-rb/rb-sys/tree/main/gem
+create_rust_makefile("twips/twips_rb")

data/ext/twips/src/lib.rs

@@ -0,0 +1,75 @@
+use std::str::FromStr;
+
+use magnus::{function, prelude::*, Error, Ruby};
+
+use twips::scramble::{
+    derive_scramble_for_event_seeded, random_scramble_for_event,
+    scramble_finder::free_memory_for_all_scramble_finders, DerivationSalt, DerivationSeed, Event,
+};
+
+fn rb_random_scramble_for_event(ruby: &Ruby, event_str: String) -> Result<String, Error> {
+    let event = Event::try_from(event_str.as_str())
+        .map_err(|e| Error::new(ruby.exception_arg_error(), e.description))?;
+
+    random_scramble_for_event(event)
+        .map(|scramble| scramble.to_string())
+        .map_err(|e| Error::new(ruby.exception_runtime_error(), e.description))
+}
+
+fn rb_derive_scramble_for_event(
+    ruby: &Ruby,
+    hex_derivation_seed_str: String,
+    derivation_salt_hierarchy_str: Vec<String>,
+    subevent_str: String,
+) -> Result<String, Error> {
+    let subevent = Event::try_from(subevent_str.as_str())
+        .map_err(|e| Error::new(ruby.exception_arg_error(), e.description))?;
+
+    let derivation_seed = DerivationSeed::from_str(&hex_derivation_seed_str)
+        .map_err(|e| Error::new(ruby.exception_arg_error(), e))?;
+
+    let hierarchy = derivation_salt_hierarchy_str
+        .iter()
+        .map(|s| s.as_str())
+        .map(DerivationSalt::from_str)
+        .collect::<Result<Vec<DerivationSalt>, String>>()
+        .map_err(|e| Error::new(ruby.exception_arg_error(), e))?;
+
+    derive_scramble_for_event_seeded(&derivation_seed, &hierarchy, subevent)
+        .map(|scramble| scramble.to_string())
+        .map_err(|e| Error::new(ruby.exception_runtime_error(), e))
+}
+
+fn rb_free_memory_for_all_scramble_finders() -> usize {
+    free_memory_for_all_scramble_finders()
+}
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let module = ruby.define_module("Twips")?;
+
+    module.define_singleton_method(
+        "random_scramble_for_event",
+        function!(rb_random_scramble_for_event, 1),
+    )?;
+
+    module.define_singleton_method(
+        "derive_scramble_for_event",
+        function!(rb_derive_scramble_for_event, 3),
+    )?;
+
+    module.define_singleton_method(
+        "free_memory_for_all_scramble_finders",
+        function!(rb_free_memory_for_all_scramble_finders, 0),
+    )?;
+
+    Ok(())
+}
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn stub_test() -> Result<(), String> {
+        Ok(())
+    }
+}

data/lib/twips/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Twips
+  VERSION = "0.11.3-dev"
+end

data/lib/twips.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "twips/version"
+require_relative "twips/twips_rb"
+
+##
+# Top level module.
+#
+# Methods defined in ext/twips/src/lib.rs
+#
+# Ex Twips.random_scramble_for_event(event_id) => String
+#
+module Twips
+end

data/sig/twips.rbs

@@ -0,0 +1,7 @@
+module Twips
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  def self.random_scramble_for_event: (String) -> String
+  def self.derive_scramble_for_event: (String, String, String) -> String
+end

data/twips.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/twips/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "twips"
+  spec.version = Twips::VERSION
+  spec.authors = ["Lucas Garron", "Tom Rokicki", "Gregor Billing"]
+
+  spec.summary = "Ruby scramble generation using twips"
+  spec.description = "Ruby scramble generation using twips."
+  spec.homepage = "https://github.com/cubing/twips"
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.required_rubygems_version = ">= 3.4.6"
+
+  spec.metadata["bug_tracker_uri"] = "https://github.com/cubing/twips/issues"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/cubing/twips"
+
+  spec.files = Dir["ext/**/*"] +
+               Dir["lib/**/*.rb"] +
+               Dir["sig/twips.rbs"] +
+               Dir["twips.gemspec"]
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/twips/extconf.rb"]
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.add_dependency("rb_sys", "~> 0.9.117")
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: twips
+version: !ruby/object:Gem::Version
+  version: 0.11.3.pre.dev
+platform: ruby
+authors:
+- Lucas Garron
+- Tom Rokicki
+- Gregor Billing
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.117
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.117
+description: Ruby scramble generation using twips.
+executables: []
+extensions:
+- ext/twips/extconf.rb
+extra_rdoc_files: []
+files:
+- ext/twips/Cargo.toml
+- ext/twips/extconf.rb
+- ext/twips/src/lib.rs
+- lib/twips.rb
+- lib/twips/version.rb
+- sig/twips.rbs
+- twips.gemspec
+homepage: https://github.com/cubing/twips
+licenses: []
+metadata:
+  bug_tracker_uri: https://github.com/cubing/twips/issues
+  homepage_uri: https://github.com/cubing/twips
+  source_code_uri: https://github.com/cubing/twips
+  rubygems_mfa_required: 'true'
+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: 3.4.6
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby scramble generation using twips
+test_files: []