inkcpp_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9108f35d9ee3f30702c1b2c73c77b1cd86a98122bfa4ae92bb47227af78b0307
+  data.tar.gz: 98e7b0ece1ede52080f09421f2c8d5fdd5ad5e803c34266ab1a0eca209247356
+SHA512:
+  metadata.gz: 7da2986d457633e3e88175fc15fc52c58490e2c553f99e731a54c142454439529338a1e6cdeca371d0ee4704465b1a6d54601230232fee57edc56901a44a90ea
+  data.tar.gz: 4571001c48c80c561cb9517b53d5ccd735368a32271c666c8bedfc9922f01faccab8b3d09c2b0e1dbd89330c9ffa66c59d1ae9abd7f6fc16c33c57b4b8962dc6

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/CHANGELOG.md

@@ -0,0 +1 @@
+0.1.0: Initial commit

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in inkcpp_rb.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    inkcpp_rb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark (0.4.0)
+    date (3.4.1)
+    debug (1.1.0)
+      irb
+      reline (>= 0.2.7)
+    erubi (1.13.1)
+    io-console (0.8.0)
+    irb (1.14.3)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    minitest (5.25.4)
+    netrc (0.11.0)
+    parallel (1.26.3)
+    prism (1.3.0)
+    psych (5.2.2)
+      date
+      stringio
+    rake (13.2.1)
+    rake-compiler (1.2.8)
+      rake
+    rbi (0.2.2)
+      prism (~> 1.0)
+      sorbet-runtime (>= 0.5.9204)
+    rdoc (6.10.0)
+      psych (>= 4.0.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rice (4.3.3)
+    sorbet (0.5.11746)
+      sorbet-static (= 0.5.11746)
+    sorbet-runtime (0.5.11746)
+    sorbet-static (0.5.11746-universal-darwin)
+    sorbet-static (0.5.11746-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11746)
+      sorbet (= 0.5.11746)
+      sorbet-runtime (= 0.5.11746)
+    spoom (1.5.0)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    stringio (3.1.2)
+    tapioca (0.16.7)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-24
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.1.0)
+  inkcpp_rb!
+  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)
+
+BUNDLED WITH
+   2.3.4

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Chris Zelenak
+
+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,3 @@
+# Ink 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. 

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/extensiontask"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+
+Rake::ExtensionTask.new("inkcpp_rb")
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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/setup

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

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/ext/inkcpp_rb/extconf.rb

@@ -0,0 +1,19 @@
+require "mkmf-rice"
+
+cmake_path = %x{which cmake}.chomp
+raise "cmake required" unless $?.success? && !cmake_path.empty?
+
+inkcpp_dir = File.join(File.dirname(File.realpath(__FILE__)), "inkcpp")
+build_dir = File.join(inkcpp_dir, "build")
+dist_dir = File.join(build_dir, "dist")
+FileUtils.mkdir_p(dist_dir)
+FileUtils.mkdir_p(build_dir)
+succeed = system(%Q{cd #{build_dir} && cmake -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_INSTALL_PREFIX=#{dist_dir} .. &&  cmake --build . --config Release && cmake --install . --component lib}, out: STDOUT)
+raise "cmake failed" unless succeed
+inkcpp_lib_dir = File.join(dist_dir, "lib", "ink")
+inkcpp_include_dir = File.join(dist_dir, "include")
+
+$CXXFLAGS += %Q{ -I#{inkcpp_include_dir}}
+$LDFLAGS += %Q{ -L#{inkcpp_lib_dir} -linkcpp -linkcpp_compiler}
+
+create_makefile "inkcpp_rb/inkcpp_rb"

data/ext/inkcpp_rb/inkcpp/.clang-format

@@ -0,0 +1,99 @@
+---
+AccessModifierOffset: -2
+AlignAfterOpenBracket: BlockIndent
+AlignArrayOfStructures: Right
+# readd padOperation if bumped from clang 14
+AlignConsecutiveAssignments: AcrossComments
+AlignConsecutiveBitFields: AcrossComments
+AlignConsecutiveDeclarations: AcrossComments
+AlignConsecutiveMacros: AcrossComments
+AlignEscapedNewlines: Left
+AlignOperands: AlignAfterOperator
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: Always
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: Inline
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: true
+BinPackParameters: true
+BreakBeforeBraces: Linux
+# BreakAfterAttributes: Always
+BreakBeforeBinaryOperators: All
+UseTab: ForIndentation
+Standard: Latest
+SpacesInSquareBrackets: false
+SpacesInParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum: 1
+  Maximum: 1
+SpacesInContainerLiterals: false
+SpacesInConditionalStatement: false
+SpacesInCStyleCastParentheses: true
+SpacesInAngles: Never
+SpacesBeforeTrailingComments: 1
+SpaceInEmptyParentheses: false
+SpaceInEmptyBlock: false
+SpaceBeforeSquareBrackets: false
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeInheritanceColon: true
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCaseColon: false
+SpaceBeforeAssignmentOperators: true
+SpaceAroundPointerQualifiers: Before
+PointerAlignment: Left
+SpaceAfterTemplateKeyword: false
+SpaceAfterLogicalNot: true
+SpaceAfterCStyleCast: true
+SortUsingDeclarations: false
+SortIncludes: Never
+ShortNamespaceLines: 0
+SeparateDefinitionBlocks: Always
+# RequiresExpressionIndentation: OuterScope
+# BreakBeforeConceptDeclarations: Always
+# BreakBeforeInlineASMColon: Always
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeComma
+BreakInheritanceList: BeforeComma
+BreakStringLiterals: true
+ColumnLimit: 100
+CompactNamespaces: true
+Cpp11BracedListStyle: true
+EmptyLineBeforeAccessModifier: Always
+FixNamespaceComments: true
+IncludeBlocks: Preserve
+IndentAccessModifiers: false
+IndentCaseBlocks: false
+IndentCaseLabels: true
+IndentExternBlock: Indent
+IndentGotoLabels: false
+IndentPPDirectives: AfterHash
+# IndentRequiresClause: true
+IndentWidth: 2
+TabWidth: 2
+IndentWrappedFunctionNames: true
+# InsertBraces: true
+# InsertNewlineAtEOF: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+LambdaBodyIndentation: Signature
+Language: Cpp
+# LineEnding: LF
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: Inner
+QualifierAlignment: Left
+ReferenceAlignment: Left
+ReflowComments: true
+RemoveBracesLLVM: false
+# RemoveSemicolon: false
+# RequiresClausePosition: OwnLine
+UseCRLF: false
+DeriveLineEnding: false

data/ext/inkcpp_rb/inkcpp/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: JBenda

data/ext/inkcpp_rb/inkcpp/.github/workflows/build.yml

@@ -0,0 +1,344 @@
+name: build
+on: 
+  push: 
+    branches: 
+      - master
+  pull_request:
+
+env:
+  BUILD_TYPE: release
+
+jobs:
+  compilation:
+    name: Compilation and Unit Tests
+    runs-on: ${{ matrix.os }}
+    strategy: 
+      matrix:
+        include:
+          - os: macos-latest
+            artifact: macos
+            name: MacOSX
+            inklecate_url: https://github.com/inkle/ink/releases/download/v1.1.1/inklecate_mac.zip
+            proof: false
+            unreal: false
+          - os: macos-14
+            artifact: macos-arm
+            name: MacOSX-ARM
+            inklecate_url: https://github.com/inkle/ink/releases/download/v1.1.1/inklecate_mac.zip
+            proof: false
+            unreal: false
+          - os: windows-latest
+            artifact: win64
+            name: Windows x64
+            inklecate_url: https://github.com/inkle/ink/releases/download/v1.1.1/inklecate_windows.zip
+            proof: false
+            unreal: false
+          - os: "ubuntu-20.04"
+            artifact: linux
+            name: Linux x64
+            inklecate_url: https://github.com/inkle/ink/releases/download/v1.1.1/inklecate_linux.zip
+            proof: true
+            unreal: true
+
+    steps:
+
+    # Checkout project
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+
+    # Setup python
+    - uses: actions/setup-python@v5
+      if: ${{ matrix.proof }}
+      with:
+        python-version: '3.x'
+
+    # Setup CMake
+    - name: Setup cmake
+      uses: jwlawson/actions-setup-cmake@v2
+      with:
+        cmake-version: '3.22.x'
+
+    # Create a build directory to store all the CMake generated files
+    - name: Create Build Environment
+      run: cmake -E make_directory ${{github.workspace}}/build
+
+    # Run CMake configuration to create build files
+    - name: Configure CMake
+      shell: bash
+      working-directory: ${{github.workspace}}/build
+      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DINKCPP_PY=OFF -DINKCPP_C=ON -DINKCPP_TEST=ON -DINKCPP_INKLECATE=OS
+
+    # Build using CMake and OS toolkit
+    - name: Build
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: cmake --build . --config $BUILD_TYPE
+
+    # Run CMake tests (unit tests, etc.)
+    - name: CTests
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: ctest . -C $BUILD_TYPE -V
+
+    # Copy all build artifacts to the bin directory
+    - name: Install Cl
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: cmake --install . --config $BUILD_TYPE --prefix comp_cl --component cl
+    - name: Upload Cl
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ matrix.artifact }}-cl
+        path: build/comp_cl/
+
+    - name: Install Lib
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: cmake --install . --config $BUILD_TYPE --prefix comp_lib --component lib
+    - name: Upload Lib
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ matrix.artifact }}-lib
+        path: build/comp_lib/
+
+    - name: Install CLib
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: cmake --install . --config $BUILD_TYPE --prefix comp_clib --component clib
+    - name: Upload Clib
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{matrix.artifact}}-clib
+        path: build/comp_clib
+
+    - name: Install UE
+      if: ${{ matrix.unreal }}
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: cmake --install . --config $BUILD_TYPE --prefix comp_unreal --component unreal
+    - name: Upload UE
+      if: ${{ matrix.unreal }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: unreal
+        path: build/comp_unreal/
+
+    # Make sure Inkproof has everything it needs to run our executable
+    - name: Setup Ink Proof
+      if: ${{ matrix.proof }}
+      shell: bash
+      working-directory: proofing/ink-proof
+      run: |
+        python3 install_deps.py
+        cp ../inkcpp_runtime_driver drivers/
+        chmod +x drivers/inkcpp_runtime_driver
+        mkdir deps/inkcpp
+        cp ../../build/comp_cl/* deps/inkcpp/
+        chmod +x deps/inkcpp/inkcpp_cl
+    
+    # Run it
+    - name: Run Ink Proof
+      if: ${{ matrix.proof }}
+      shell: bash
+      working-directory: proofing/ink-proof
+      run: |
+        python3 proof.py --examples 'I...' inklecate_v1.1.1 inkcpp_runtime > run.out
+        echo -e "| ${{ matrix.name }} | $(cat run.out) |" > ${{ matrix.artifact }}.txt
+
+    # Creates a "disabled" artifact if ink proofing is disabled
+    - name: Create Disabled InkProof Results File
+      if: ${{ !matrix.proof }}
+      shell: bash
+      run: |
+        mkdir -p proofing/ink-proof
+        echo "| ${{ matrix.name }} | DISABLED |" > proofing/ink-proof/${{ matrix.artifact }}.txt
+
+    # Upload results artifact
+    - name: Upload Results Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: result-${{ matrix.artifact }}
+        path: proofing/ink-proof/${{ matrix.artifact }}.txt
+
+    # Upload website artifact
+    - name: Upload Ink-Proof Website Artifact
+      if: ${{ matrix.proof }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ matrix.artifact }}-www
+        path: proofing/ink-proof/out
+
+  build-doc:
+    name: Build Doxygen documentation
+    needs: [compilation, build-python]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+    - name: Set upt Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install Doxygen
+      run: |
+        sudo apt-get install graphviz -y
+        wget https://www.doxygen.nl/files/doxygen-1.10.0.linux.bin.tar.gz
+        gunzip doxygen-*.tar.gz
+        tar xf doxygen-*.tar
+        cd doxygen-1.10.0/
+        sudo make install
+    - name: Setup cmake
+      uses: jwlawson/actions-setup-cmake@v2
+      with:
+        cmake-version: '3.22.x'
+    - name: Create Build Environment
+      run: cmake -E make_directory ${{github.workspace}}/build
+    - name: Configure CMake
+      shell: bash
+      working-directory: ${{github.workspace}}/build
+      run: cmake $GITHUB_WORKSPACE -DINKCPP_PY=ON -DINKCPP_DOC_BlueprintUE=ON
+    - name: Build
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      run: cmake --build . --target doc
+    - name: Upload
+      uses: actions/upload-artifact@v4
+      with:
+        name: doxygen
+        path: Documentation/
+
+  build-python:
+    name: Build Python package
+    needs: compilation
+    runs-on: ubuntu-latest
+    steps:        
+    - uses: actions/checkout@v4
+      with:
+        submodules: true
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: install build
+      run: >-
+        python3 -m
+        pip install
+        build
+        pytest
+        --user
+    - name: Build python release
+      run: python3 -m build
+
+    - uses: suisei-cn/actions-download-file@v1.6.0
+      name: Download Inklecate 
+      id: download_inklecate 
+      with:
+        url: https://github.com/inkle/ink/releases/download/v1.1.1/inklecate_linux.zip
+        target: "inklecate/"
+    - name: Deploy Inkelcate 
+      shell: bash
+      run: |
+        cd inklecate
+        unzip *.zip
+        echo "INKLECATE=${{ matrix.inklecate_pre }}$GITHUB_WORKSPACE/inklecate/inklecate${{ matrix.inklecate_post }}" >> $GITHUB_ENV
+
+    - name: Test python release
+      run: |
+        python3 -m pip install dist/*.whl --user
+        python3 -m pytest
+    - name: Remove wheel
+      run: |
+        rm dist/*.whl
+    - name: Upload Python files
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distribution
+        path: dist/
+
+  clang-format:
+    name: "Check Formatting"
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'master' }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Fetch master branch
+        run: |
+          git fetch origin master
+      - name: Check clang-format
+        run: |
+          diff=$(git clang-format-14 --extensions c,cpp,h,hpp --style file -q --diff origin/master)
+          echo $diff
+          if [ "$diff" != "" ]; then
+            echo run git clang-format --extensions c,cpp,h,hpp --style file master
+            echo or upstream/master depending on your setup
+            clang
+          fi
+
+  reporting:
+    name: "Pull Request Report"
+    # if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == 'brwarner/inkcpp' }}
+    if: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'master' }}
+    runs-on: ubuntu-latest
+    needs: [compilation, clang-format]
+    permissions:
+      pull-requests: write
+    steps:
+      # Download Ink Proof Results
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: result-*
+          path: "results"
+          merge-multiple: true
+
+      # Create comment text
+      - name: Create Comment Text File
+        shell: bash
+        run: |
+          echo "### Ink Proof Results" >> comment.txt
+          echo "" >> comment.txt
+          echo "These results are obtained by running the [Ink-Proof Testing Suite](https://github.com/chromy/ink-proof) on the compiled binaries in this pull request." >> comment.txt
+          echo "" >> comment.txt
+          echo "| System | Results |" >> comment.txt
+          echo "| --- | --- |" >> comment.txt
+          FILES="results/*.txt"
+          for f in $FILES
+          do
+            echo "Reading results from $f"
+            cat "$f" >> comment.txt
+          done
+      
+      # Post Comment
+      - uses: marocchino/sticky-pull-request-comment@v2.9.0
+        with:
+          recreate: true
+          path: comment.txt
+  
+  pages:
+    permissions:
+      contents: write
+    name: "Upload Ink-Proof to Github Pages"
+    needs: [ compilation, build-doc ]
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v4
+
+      # Download Ink Proof page for Linux
+      - uses: actions/download-artifact@v4
+        with:
+          name: linux-www
+          path: www/proof
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: doxygen
+          path: www
+
+      # Deploy to Github Pages
+      - name: Deploy Page
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: inkproof-page
+          folder: www