bcalc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01d2a28d16a60190de6d027942f5fda91d954b02
+  data.tar.gz: 71c10ae078d348ff6486a9778019c18c12646711
+SHA512:
+  metadata.gz: cd35bd119ccd923a6a977ea7475399bc33f9e3287ca162534cdd535b9285fa68ec0daccfea28bef64336ca0256407368cbc775a51be144a21c841c1f594130a5
+  data.tar.gz: ce32fa7eab0e21a3ddd08a14615599ed804062636f715ad1baed37235e1758044551f08ab1a45b48933ca151747264ef98e1c558559ae9a53cb134b540fd370f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Wojciech Wnętrzak
+
+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,51 @@
+# Bcalc
+
+Ruby bindings to C library Bridge Calculator http://bcalc.w8.pl
+
+## Installation
+
+`$ gem install bcalc`
+
+## Usage
+
+```ruby
+Bcalc::Calculator.new(
+  deal: "N:.63.AKQ987.A9732 A8654.KQ5.T.QJT6 J973.J98742.3.K4 KQT2.AT.J6542.85",
+  declarer: "N",
+  suit: "NT"
+).tricks
+```
+
+or low level:
+
+```ruby
+solver = Bcalc::Lib.bcalcDDS_new(
+  "PBN",
+  "N:.63.AKQ987.A9732 A8654.KQ5.T.QJT6 J973.J98742.3.K4 KQT2.AT.J6542.85",
+  Bcalc::Lib::BCALC_NT,
+  Bcalc::Lib::BCALC_PLAYER_NORTH
+)
+Bcalc::Lib.bcalcDDS_getTricksToTake(solver)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/morgoth/bcalc.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+It uses compiled version of C library by Piotr Beling which uses:
+
+```
+Bridge Calculator (and its C API) is freeware for private and non-commercial use (use to develop freeware applications) and it's distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+Each distributed product which use this API/library should includes readable for end-user information about this fact and link to Bridge Calculator web-page: http://bcalc.w8.pl/
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bcalc.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bcalc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bcalc"
+  spec.version       = Bcalc::VERSION
+  spec.authors       = ["Wojciech Wnętrzak"]
+  spec.email         = ["w.wnetrzak@gmail.com"]
+
+  spec.summary       = %q{C lib wrapper for Bridge Calculator}
+  spec.description   = %q{C lib wrapper for Bridge Calculator}
+  spec.homepage      = "https://github.com/morgoth/bcalc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = ">= 2.0"
+
+  spec.add_dependency "ffi"
+
+  spec.add_development_dependency "bundler", ">= 1.14"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "minitest", ">= 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bcalc"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bcalc.rb

@@ -0,0 +1,6 @@
+require "bcalc/version"
+require "bcalc/lib"
+require "bcalc/calculator"
+
+module Bcalc
+end

data/lib/bcalc/calculator.rb

@@ -0,0 +1,53 @@
+module Bcalc
+  class Calculator
+    SUITS = {
+      "C" => Bcalc::Lib::BCALC_SUIT_CLUBS,
+      "D" => Bcalc::Lib::BCALC_SUIT_DIAMONDS,
+      "H" => Bcalc::Lib::BCALC_SUIT_HEARTS,
+      "S" => Bcalc::Lib::BCALC_SUIT_SPADES,
+      "NT" => Bcalc::Lib::BCALC_NT
+    }
+    PLAYERS = {
+      "N" => Bcalc::Lib::BCALC_PLAYER_NORTH,
+      "E" => Bcalc::Lib::BCALC_PLAYER_EAST,
+      "S" => Bcalc::Lib::BCALC_PLAYER_SOUTH,
+      "W" => Bcalc::Lib::BCALC_PLAYER_WEST,
+    }
+    MAX_TRICKS = 13
+    private_constant :MAX_TRICKS
+
+    attr_reader :deal, :declarer, :suit
+
+    def initialize(deal:, declarer:, suit:)
+      PLAYERS.keys.include?(declarer) || raise(ArgumentError, "Wrong declarer value: #{declarer}")
+      SUITS.keys.include?(suit) || raise(ArgumentError, "Wrong suit value: #{suit}")
+
+      @deal = deal
+      @declarer = declarer
+      @suit = suit
+    end
+
+    # Returns number of tricks that declarer can take
+    def tricks
+      solver = Bcalc::Lib.bcalcDDS_new("PBN", deal, SUITS[suit], leader)
+      raise_on_error(solver)
+      result = Bcalc::Lib.bcalcDDS_getTricksToTake(solver)
+      MAX_TRICKS - result
+    ensure
+      Bcalc::Lib.bcalcDDS_delete(solver)
+    end
+
+    private
+
+    def raise_on_error(solver)
+      if (error = Bcalc::Lib.bcalcDDS_getLastError(solver))
+        raise StandardError, error
+      end
+    end
+
+    def leader
+      index = (PLAYERS.keys.index(declarer) + 1) % 4
+      PLAYERS[PLAYERS.keys[index]]
+    end
+  end
+end

data/lib/bcalc/lib.rb

@@ -0,0 +1,26 @@
+require "ffi"
+
+module Bcalc
+  module Lib
+    extend FFI::Library
+
+    BCALC_PLAYER_NORTH = 0
+    BCALC_PLAYER_EAST = 1
+    BCALC_PLAYER_SOUTH = 2
+    BCALC_PLAYER_WEST = 3
+
+    BCALC_SUIT_CLUBS = 0
+    BCALC_SUIT_DIAMONDS = 1
+    BCALC_SUIT_HEARTS = 2
+    BCALC_SUIT_SPADES = 3
+    BCALC_NT = 4
+
+    ffi_lib "ext/bcalc/libbcalcdds.so"
+
+    attach_function :bcalc_runtimeVersion, [], :int
+    attach_function :bcalcDDS_new, [:string, :string, :int, :int], :pointer
+    attach_function :bcalcDDS_getTricksToTake, [:pointer], :int
+    attach_function :bcalcDDS_delete, [:pointer], :void
+    attach_function :bcalcDDS_getLastError, [:pointer], :string
+  end
+end

data/lib/bcalc/version.rb

@@ -0,0 +1,3 @@
+module Bcalc
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: bcalc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wojciech Wnętrzak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: C lib wrapper for Bridge Calculator
+email:
+- w.wnetrzak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bcalc.gemspec
+- bin/console
+- bin/setup
+- ext/bcalc/libbcalcdds.so
+- lib/bcalc.rb
+- lib/bcalc/calculator.rb
+- lib/bcalc/lib.rb
+- lib/bcalc/version.rb
+homepage: https://github.com/morgoth/bcalc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: C lib wrapper for Bridge Calculator
+test_files: []