inkcpp_rb 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b5890b2bbfe3d3c602e99799b9fd2fe650fdef4679bd42faeb6b8a7d9e08996
-  data.tar.gz: 51a71c11f3584b110133d3285f4b7a7a7f249c9ad5a6155eee5999b1748878f5
+  metadata.gz: fc9836fdbf53db4e97756a16f1da5b5aaf2ceb687b5b0106625ef46dec583ee3
+  data.tar.gz: c31f75154ffb5e06f157954eeb84cadd52fa1455029a08aa3bdd3120134f583b
 SHA512:
-  metadata.gz: f4e64b70c287fc7fd8e4e79e76d10d31b318abfcedf3e27a30ebe000247a55b1fdb93599ad6a4cd7cdc40da7035c3ebf4a8b4c3ec32533e2280d7ccfaa753a6f
-  data.tar.gz: 41821d98ba8b4832325d8958e7e324d4218c77c6ef703aa64037cc5bd7028a55dff3629ed5cd5560667e7cc4791a7d0e2b1f2073cf4322fe45f87c5aaa2e052f
+  metadata.gz: c4000451548a7be40123e6be1f3293c62cb0575c78edef98842a6a62107798853b6cce24dbf849432ea771f8bd8e66a375c2cd37982fb224c0da576ade8abf49
+  data.tar.gz: 9cd7ce509dba7793eafc39e28503a93e9e8cdd31bf93de0be2eca35b334ffd405c543f95ee23c36297f0b97d25e580a0fb43e99203c46ecaa75a83f2c38c9013

data/CHANGELOG.md

@@ -1 +1,4 @@
 0.1.0: Initial commit
+0.1.1: Adjust directory structure to fit Ruby norms
+0.1.2: Ensure Rice included as a dependency
+0.1.3: Fix typings for Ink::Story

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    inkcpp_rb (0.1.1)
+    inkcpp_rb (0.1.3)
+      rice (~> 4.3.3)
 
 GEM
   remote: https://rubygems.org/
@@ -75,7 +76,6 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rake-compiler (~> 1.2.8)
-  rice (~> 4.3.3)
   sorbet (~> 0.5.0)
   sorbet-runtime (~> 0.5.0)
   tapioca (~> 0.16.0)

data/README.md

@@ -1,3 +1,19 @@
-# Ink RB
+# InkCPP RB
 
 These are bindings for the InkCPP project in Ruby. They largely follow the same patterns as the official Python bindings, with a few small divergences. 
+
+Install:
+
+```
+bundle add inkcpp_rb
+```
+
+Sorbet typings are included.
+
+## REQUIREMENTS
+
+In order to install this gem your destination must have `cmake` installed as well as have a functioning C++ compilation toolchain.
+
+## WARNING
+
+This gem has largely been developed for my own purposes. I am not yet confident enough in the memory semantics between Rice and InkCPP to say that this is leak free or safe to use in any important environment. If you do use this gem, I strongly suggest you use it in situations where you are not parsing untrusted user input or anything like that. 

data/bin/console

@@ -4,12 +4,6 @@
 require "bundler/setup"
 require "inkcpp_rb"
 
-# 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/inkplay.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# typed: true
+require "bundler/setup"
+require "inkcpp_rb"
+require "tempfile"
+require "sorbet-runtime"
+
+inklecate_path = %x{which inklecate}.chomp
+raise "inklecate binary must be in your PATH - see https://github.com/inkle/ink/releases" if inklecate_path.empty?
+
+story_path = ARGV[0]
+raise "Must specify a story path" if story_path.nil? || story_path.empty?
+
+file = Tempfile.new("inkplay.ink")
+path = file.path
+output = %x{inklecate -o #{path} #{story_path}}
+raise "Could not compile ink json: #{output.inspect}" unless $?.success?
+json_contents = File.read(T.must(path))
+compiled = Ink.compile_json(json_contents)
+story = T.must(Ink::Story.from_binary(compiled))
+runner = T.must(story.new_runner(nil).get)
+while true
+  puts runner.getline
+  if runner.num_choices > 0
+    all_choices = runner.each_choice.to_a
+    all_choices.each do |choice|
+      puts "#{choice.index}. #{choice.text}"
+    end
+    puts "Which choice?"
+    choice_num = STDIN.readline.chomp.to_i
+    chosen = all_choices.detect { |choice| choice.index == choice_num }
+    if chosen
+      runner.choose(choice_num - 1)
+      break if !runner.can_continue
+    end
+  end
+end
+puts "END"

data/bin/setup

@@ -7,4 +7,3 @@ bundle install
 git submodule init
 git submodule update
 
-# Do any other automated setup that you need to do here

data/inkcpp_rb.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "inkcpp bindings in Ruby"
   spec.homepage = "https://git.sr.ht/~netshade/inkcpp_rb"
   spec.required_ruby_version = ">= 2.6.0"
+  spec.requirements << "cmake"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
 
@@ -19,8 +20,6 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://git.sr.ht/~netshade/inkcpp_rb"
   spec.metadata["changelog_uri"] = "https://git.sr.ht/~netshade/inkcpp_rb/tree/main/item/CHANGELOG.md"
 
-  # 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.
   submodules = %w{inkcpp}
   submodule_files = submodules.flat_map do |module_name|
     base_submodule_path = File.join("ext", "inkcpp_rb", module_name)
@@ -41,15 +40,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.extensions = ["ext/inkcpp_rb/extconf.rb"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "rice", "~> 4.3.3"
   spec.add_development_dependency "rake-compiler", "~> 1.2.8"
-  spec.add_development_dependency "rice", "~> 4.3.3"
   spec.add_development_dependency "sorbet", "~> 0.5.0"
   spec.add_development_dependency "sorbet-runtime", "~> 0.5.0"
   spec.add_development_dependency "tapioca", "~> 0.16.0"
   spec.add_development_dependency "debug", "~> 1.1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/inkcpp_rb/version.rb

@@ -1,3 +1,3 @@
 module InkcppRb
-  VERSION = "0.1.1"
-end
+  VERSION = "0.1.3"
+end

data/rbi/inkcpp_rb.rbi

@@ -201,15 +201,15 @@ module Ink
     def self.from_binary(data); end
 
     sig { returns(T.nilable(Ink::StoryImpl)) }
-    def self.new_globals(); end
+    def new_globals(); end
 
     sig { params(globals: T.nilable(Ink::StoryImpl)).returns(Ink::RunnerImpl) }
-    def self.new_runner(globals); end
+    def new_runner(globals); end
 
     sig { params(snapshot: Ink::Snapshot).returns(Ink::StoryImpl) }
-    def self.new_globals_from_snapshot(snapshot); end
+    def new_globals_from_snapshot(snapshot); end
 
     sig { params(snapshot: Ink::Snapshot, globals: T.nilable(Ink::StoryImpl), index: Integer).returns(Ink::StoryImpl) }
-    def self.new_runner_from_snapshot(snapshot, globals, index); end
+    def new_runner_from_snapshot(snapshot, globals, index); end
   end
 end

metadata

@@ -1,42 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: inkcpp_rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Chris Zelenak
 bindir: exe
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: rice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.8
-  type: :development
+        version: 4.3.3
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.8
+        version: 4.3.3
 - !ruby/object:Gem::Dependency
-  name: rice
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.3
+        version: 1.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.3.3
+        version: 1.2.8
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/inkplay.rb
 - bin/setup
 - bin/tapioca
 - ext/inkcpp_rb/extconf.rb
@@ -395,7 +396,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- cmake
 rubygems_version: 3.6.2
 specification_version: 4
 summary: inkcpp bindings in Ruby