cobhan 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 309e7e9e4dc297cca788ad4a722c4b5e686e21f071f1faff64d9256ca5eec267
-  data.tar.gz: 3a2f819a9bb2d1d67ea99e3739cadfeb80a27354a2deebd007e57b366d21ebc4
+  metadata.gz: 236a2f8255bfff1d864296be21eeb788aa7e2eda4b6ec351c2acc5c1fdfea8b3
+  data.tar.gz: c7a666719c503f2ab16b72cd5c1e26973aba29a410445de80376703213c1b397
 SHA512:
-  metadata.gz: 91c3c544862b16a4b4a41312bcd3ce5208f75f9fc738e3940bada7c7fac08f899e5cb3fbadd4731ab512e34adcb5a0b0cfd11e9560ef51aa82200a48660d04ef
-  data.tar.gz: 9498b1799ec6834e1659f2183b1d05b9a5e0bbdaa53856facd7200228e3e285b27639124d8edc29e5aeb66f967d2e20a2b8e0aa35e4803d48aaa68b0ecb93d79
+  metadata.gz: 18447be1bb9676bfd0d66ad6c84d91c229181a75775c16b174e52241659ccc43a9083001bf3e0ed2db1bb3d6542c489d1201582a5ae01903084bb1ee189e9079
+  data.tar.gz: ec03eb376934045aec087c9b72ce9a831aee5c74f75fbf185c6a89c51569e798e238686e9737489eeafa9720dfc5ba8885c69570ed93082cc003a1233bd61247

data/.rubocop.yml

@@ -1,13 +1,31 @@
 AllCops:
   TargetRubyVersion: 2.5
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'Vagrantfile'
+    - 'vendor/**/*' # Github Actions
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [0.1.3] - 2022-03-14
+
+- Switch from `centos/7` to `ubuntu/focal64` vagrant box
+- Add ARM64 build and test script for vagrant
+- Add ARM64 build for Github Actions
+- Add coverage report
+
+## [0.1.2] - 2022-03-07
+
+- Configure RuboCop
+- Add `int_to_buffer` and `buffer_to_int`
+
+## [0.1.1] - 2022-03-01
+
+- Fix gemspec description
+- Add Github Actions
+
 ## [0.1.0] - 2022-03-01
 
 - Initial release

data/Gemfile

@@ -1,12 +1,8 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cobhan.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem 'rake', '~> 13.0'

data/README.md

@@ -72,12 +72,27 @@ vagrant ssh
 cd /vagrant/
 bundle install
 bundle exec rspec spec
+
+# Or to run specs on arm64 inside vagrant:
+cd /vagrant/
+spec/support/libcobhandemo/arm64_build_and_test.sh
 ```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/godaddy/cobhan-ruby.
 
+## Releasing new gem version
+
+```
+# Create and push a version tag
+git tag -a v$(rake version) -m "Version $(rake version)"
+git push origin v$(rake version)
+
+# Create a release in Github to trigger .github/workflows/publish.yml workflow
+echo "Version $(rake version)"
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/Rakefile

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+task :version do
+  puts Cobhan::VERSION
+end

data/Vagrantfile

@@ -1,12 +1,15 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-$script = <<-SCRIPT
+SCRIPT = <<~SCRIPT
 set -e
 
+# Update system
+sudo apt-get update
+
 echo "Install RVM"
-gpg --keyserver hkp://pgp.mit.edu --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
-# If key add does not work, see https://rvm.io/rvm/security for alternatives.
+curl -sSL https://rvm.io/mpapis.asc | gpg --import -
+curl -sSL https://rvm.io/pkuczynski.asc | gpg --import -
 curl -sSL https://get.rvm.io | bash -s stable
 source /home/vagrant/.rvm/scripts/rvm
 
@@ -15,17 +18,22 @@ echo "Install Ruby $RUBY_VERSION"
 rvm install $RUBY_VERSION
 
 echo "Install git"
-sudo yum install git -y
+sudo apt-get install git -y
 
 echo "Install docker"
-sudo yum install -y yum-utils
-sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
-sudo yum install docker-ce -y
-sudo usermod -aG docker $USER
+curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+echo \
+  "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
+  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+sudo apt-get update
+sudo apt-get install docker-ce -y
+
+sudo gpasswd -a $USER docker
 sudo systemctl restart docker.service
+sudo systemctl enable docker.service
 SCRIPT
 
-Vagrant.configure("2") do |config|
-  config.vm.box = "centos/7"
-  config.vm.provision "shell", inline: $script, privileged: false
+Vagrant.configure('2') do |config|
+  config.vm.box = 'ubuntu/focal64'
+  config.vm.provision 'shell', inline: SCRIPT, privileged: false
 end

data/cobhan.gemspec

@@ -1,26 +1,28 @@
 # frozen_string_literal: true
 
-require_relative "lib/cobhan/version"
+require_relative 'lib/cobhan/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "cobhan"
+  spec.name = 'cobhan'
   spec.version = Cobhan::VERSION
-  spec.authors = ["GoDaddy"]
-  spec.email = ["oss@godaddy.com"]
+  spec.authors = ['GoDaddy']
+  spec.email = ['oss@godaddy.com']
 
-  spec.summary = "Ruby wrapper library for the Cobhan FFI system"
-  spec.description = "Cobhan FFI is a proof of concept system for enabling shared code to be written in Rust or Go and consumed from all major languages/platforms in a safe and effective way, using easy helper functions to manage any unsafe data marshaling."
+  spec.summary = 'Ruby wrapper library for the Cobhan FFI system'
+  spec.description = <<~DESCRIPTION
+    Cobhan FFI is a proof of concept system for enabling shared code to be written
+    in Rust or Go and consumed from all major languages/platforms in a safe and effective way,
+    using easy helper functions to manage any unsafe data marshaling.
+  DESCRIPTION
 
-  spec.summary       = 'Wrapper sample for Golang c-shared build'
-  spec.description   = 'Wrapper sample for Golang c-shared build implementation'
+  spec.homepage = 'https://github.com/godaddy/cobhan-ruby'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.homepage = "https://github.com/godaddy/cobhan-ruby"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.5.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/godaddy/cobhan-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/godaddy/cobhan-ruby/blob/main/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/godaddy/cobhan-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/godaddy/cobhan-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # 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.
@@ -29,12 +31,14 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:bin|demo|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'ffi', '~> 1.15.4'
 
   spec.add_development_dependency 'rspec', '~> 3.10.0'
   spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'simplecov-console', '~> 0.9.1'
 end

data/lib/cobhan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cobhan
-  VERSION = "0.1.0"
+  VERSION = '0.1.3'
 end

data/lib/cobhan.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "cobhan/version"
+require_relative 'cobhan/version'
 
 require 'ffi'
 
+# Cobhan module includes helper functions to manage unsafe data marshaling.
 module Cobhan
   UnsupportedPlatformError = Class.new(StandardError)
 
@@ -58,7 +59,7 @@ module Cobhan
     length = 0 - length
     filename = buffer.get_bytes(BUFFER_HEADER_SIZE, length)
     # Read file with name in payload, and replace payload
-    bytes = IO.binread(filename)
+    bytes = File.binread(filename)
     File.delete(filename)
     bytes
   end
@@ -70,4 +71,14 @@ module Cobhan
     buffer_ptr.put_int32(SIZEOF_INT32, 0) # Reserved - must be zero
     buffer_ptr
   end
+
+  def int_to_buffer(number)
+    buffer_ptr = FFI::MemoryPointer.new(1, SIZEOF_INT32 * 2, false)
+    buffer_ptr.put_int64(0, number)
+    buffer_ptr
+  end
+
+  def buffer_to_int(buffer_ptr)
+    buffer_ptr.get_int64(0)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobhan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - GoDaddy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -52,7 +52,38 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-description: Wrapper sample for Golang c-shared build implementation
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: |
+  Cobhan FFI is a proof of concept system for enabling shared code to be written
+  in Rust or Go and consumed from all major languages/platforms in a safe and effective way,
+  using easy helper functions to manage any unsafe data marshaling.
 email:
 - oss@godaddy.com
 executables: []
@@ -66,7 +97,6 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -82,7 +112,8 @@ metadata:
   homepage_uri: https://github.com/godaddy/cobhan-ruby
   source_code_uri: https://github.com/godaddy/cobhan-ruby
   changelog_uri: https://github.com/godaddy/cobhan-ruby/blob/main/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +128,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
-summary: Wrapper sample for Golang c-shared build
+summary: Ruby wrapper library for the Cobhan FFI system
 test_files: []

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cobhan (0.1.0)
-      ffi (~> 1.15.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.5.0)
-    ffi (1.15.5)
-    parallel (1.21.0)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.25.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-darwin-20
-
-DEPENDENCIES
-  cobhan!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
-
-BUNDLED WITH
-   2.3.3