librollenspielsache-rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10c2ae8a313efa474a98ce9e53654ff9168f726e1af15a9ecf70b61b32017fd9
-  data.tar.gz: 4c01d90db9e0fc3fbd6a896e1f474160f59a57393ad8b176d72a33950a330c3c
+  metadata.gz: 9452a60be46275db434a3bd25eed3db89055f86f39bdb432c9103d6cf3176a64
+  data.tar.gz: 05e3f1c206856d71030df129bd50172478c05415b03745b59c14f41a17fc06ed
 SHA512:
-  metadata.gz: d7fabb447a00c37184b2261b657904cae7b7a027fda17e4b113ceb14f6e9f813fb76d4bb07ec1fac76a55991146755c5a8bfa8cf8cbd8b104795a419bf4a1076
-  data.tar.gz: 254c94cc749b93c0c64f0adf6899a17144456ef1a7f0913fbb72603f886e734a1466cba111ee103c81602a0075488fb4afa3e33a9c2fb57af4cdb33a972ef85c
+  metadata.gz: 0133ac744ff1a8822346cb56f6ed713f1b15ff8e0c9e37f506e6575463c1ca4d65b42cc3ca2e0524040a96cf3ee559131e639343f1d845f58e2dd3ecdd34b6e3
+  data.tar.gz: 138ebed85e0713234a2ef2d0deb1607c6166b59b483803eff7e095018208490f4993de10b8296e6c9cbadafe608c2aa00d7517712cb6af3d4bd123cb2b458e41

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.1.1
+
+I was premature in jumping to 0.1.  **This is the only working version of 0.1**.  Semantic version, take two!
+
+* Bump Rust lib
+* Add more tests
+* JSON RollResult
+
 # 0.1.0
 
 Mostly just code formats and paths and stuff.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    librollenspielsache-rb (0.1.0)
+    librollenspielsache-rb (0.1.1)
       ffi
 
 GEM

data/README.md

@@ -1,8 +1,10 @@
-# Librollenspielsache-rb
+# Rollenspielsache-rb
 
 WIP - there's like nothing actually here yet.
 
-![Gem](https://img.shields.io/gem/v/librollenspielsache-rb)
+Currently wrapping [librollenspielsache 0.1.2](https://crates.io/crates/librollenspielsache/0.1.2).
+
+[![Gem Version](https://badge.fury.io/rb/librollenspielsache-rb.svg)](https://badge.fury.io/rb/librollenspielsache-rb)
 
 Ruby bindings for [`librollenspielsache`](https://crates.io/crates/librollenspielsache).
 
@@ -24,9 +26,22 @@ Or install it yourself as:
 
 ## Usage
 
+Coming soon?
 
 ## Development
 
+### Prerequisites
+
+Before using you need to download and successfully run `make all` in [`librollenspielsache`](https://github.com/deciduously/librollenspielsache).  Then, you need to add a file in this project root called `.env` with the following contents:
+
+```
+LD_LIBRARY_PATH="${HOME}/path/to/librollenspielsache/dist"
+```
+
+Adjust to where you build the shared library.
+
+### Run
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests or `rake lint` to run RuboCop. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 For now, this expects a pre-compiled `librollenspielsache.so` available in `ext/`.  One is provided with the repo.

data/Rakefile

@@ -4,13 +4,13 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-ENV['LD_LIBRARY_PATH'] = 'ext'
+ENV['LD_LIBRARY_PATH'] = './ext'
 
 RSpec::Core::RakeTask.new(:spec)
 
 RuboCop::RakeTask.new(:lint) do |task|
   task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
-  task.fail_on_error = false
+  task.fail_on_error = false # I'd rather see all of them
 end
 
 task default: :spec

data/lib/librollenspielsache.rb

@@ -5,6 +5,15 @@ require 'librollenspielsache/dice/roll'
 require 'librollenspielsache/dice/roll_result'
 require 'librollenspielsache/version'
 
-module Librollenspielsache
+module Rollenspielsache
   class Error < StandardError; end
+  # Rust exported fns
+  module Binding
+    include Rollenspielsache::Dice
+    extend FFI::Library
+    ffi_lib 'librollenspielsache'
+
+    # Free a string that was passed from the Rust library
+    attach_function :free_str, :roll_from_str, [:string], :void
+  end
 end

data/lib/librollenspielsache/dice/roll.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-module Librollenspielsache
+require_relative 'roll_result'
+require_relative '../ffi_string'
+
+module Rollenspielsache
   module Dice
     # A single roll
     class Roll < FFI::AutoPointer
@@ -26,8 +29,14 @@ module Librollenspielsache
         Binding.get_repeat self
       end
 
+      def to_s
+        Binding.to_string self
+      end
+
       # Rust exported fns
       module Binding
+        include Rollenspielsache
+        include Rollenspielsache::Dice
         extend FFI::Library
         ffi_lib 'librollenspielsache'
 
@@ -36,7 +45,9 @@ module Librollenspielsache
         # Free the object
         attach_function :free, :roll_free, [], :void
         # Returns a pointer to RollResult
-        attach_function :execute, :roll_execute, [Roll], :pointer
+        attach_function :execute, :roll_execute, [Roll], Dice::RollResult
+        # Get the string
+        attach_function :to_string, :roll_from_str, [Roll], FFIString
         # Get the base
         attach_function :get_base, :roll_base, [Roll], :int
         # Get the repeat

data/lib/librollenspielsache/dice/roll_result.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require 'ffi'
+require_relative '../ffi_string'
 
-module Librollenspielsache
+module Rollenspielsache
   module Dice
     # The Result from a roll
     class RollResult < FFI::AutoPointer
@@ -10,17 +11,33 @@ module Librollenspielsache
         Binding.free ptr
       end
 
-      def to_s(ptr)
-        Binding.to_s ptr
+      def to_json(_optional = nil)
+        wrap = Binding.to_json self
+        wrap.to_s
+      end
+
+      def to_s
+        Binding.to_string self
+      end
+
+      def total
+        Binding.total self
       end
 
       # Rust externs
       module Binding
+        include Rollenspielsache
         extend FFI::Library
         ffi_lib 'librollenspielsache'
 
-        attach_function :to_s, :roll_result_to_string, [:pointer], :string
-        attach_function :free, :roll_result_free, [:pointer], :void
+        # Rust `to_json()`
+        attach_function :to_json, :roll_result_to_json, [RollResult], FFIString
+        # Rust `to_string()`
+        attach_function :to_string, :roll_result_to_string, [RollResult], FFIString
+        # It comes back as a base and modifier, total combines them
+        attach_function :total, :roll_result_total, [RollResult], :int
+        # Pass back to Rust memory management
+        attach_function :free, :roll_result_free, [RollResult], :void
       end
     end
   end

data/lib/librollenspielsache/ffi_string.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+module Rollenspielsache
+  # Wrapped up string
+  class FFIString < FFI::AutoPointer
+    def self.release
+      Binding.free self
+    end
+
+    def to_s
+      @to_s ||= read_string.force_encoding('UTF-8')
+    end
+
+    # Rust externs
+    module Binding
+      extend FFI::Library
+      ffi_lib 'librollenspielsache'
+
+      # Pass back to Rust's memory management
+      attach_function :free, :ffi_string_free, [FFIString], :void
+    end
+  end
+end

data/lib/librollenspielsache/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Librollenspielsache
-  VERSION = '0.1.0'
+module Rollenspielsache
+  VERSION = '0.1.1'
 end

data/librollenspielsache-rb.gemspec

@@ -4,7 +4,7 @@ require_relative 'lib/librollenspielsache/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'librollenspielsache-rb'
-  spec.version       = Librollenspielsache::VERSION
+  spec.version       = Rollenspielsache::VERSION
   spec.authors       = ['Ben Lovy']
   spec.email         = ['ben@deciduously.com']
 
@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/deciduously/librollenspielsache-rb'
   spec.metadata['changelog_uri'] = 'https://github.com/deciduously/librollenspielsache-rb/blob/master/CHANGELOG.md'
 
-  # spec.add_dependency 'dotenv'
   spec.add_dependency 'ffi'
 
   spec.add_development_dependency 'rubocop'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: librollenspielsache-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben Lovy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -61,6 +61,7 @@ files:
 - lib/librollenspielsache.rb
 - lib/librollenspielsache/dice/roll.rb
 - lib/librollenspielsache/dice/roll_result.rb
+- lib/librollenspielsache/ffi_string.rb
 - lib/librollenspielsache/version.rb
 - librollenspielsache-rb.gemspec
 homepage: https://rubygems.org/gems/librollenspielsache-rb