malachite 0.2.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5052dfabfaf3ab568017e5dca181503e42aa32ef
-  data.tar.gz: 3e54fe1a9525ff6568127cfe0d94ee86daf31851
+  metadata.gz: 0ba4057a948f808a684ea7dd503ccaabe46bbba5
+  data.tar.gz: 8d2b9b35cd4104cd735e0c92db2c7098b98b30f4
 SHA512:
-  metadata.gz: a43b53c157f009ef74ae837dd005be597c8c292eaa1c4d7fbb95d1748fb157f4a259fd01b93be2e27806ad81d07939dab3e6fc73401aee403248339840d3c72e
-  data.tar.gz: 5034fd9f28ad91b68d74fe1e9438644c111d03bcf14591814b4ab7859874f6a7f8978491210b04290249cd763ff4c2789e83bbf68356755646684db8742e3734
+  metadata.gz: ec0603aa1eac3c6d5428c2b321ef4cb6a5a97f7aa91e36d356872f37419afec30e6a2f806e89ce8eac3e362ac9da93d61a021c93dfdfd7804bb859d9dd787631
+  data.tar.gz: d923d46e0ab54ff1c0d687a24a7019c715cf08b93d5fe5f7df08621f095f616308393e8a3e9d1525390f93bfc49532e95faea3b0822483b813e769c6aab03f89

data/.gitignore

@@ -1,6 +1,5 @@
 Gemfile.lock
 .rvmrc
-.ruby-version
 tags
 *.swp
 *.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/README.md

@@ -1,10 +1,16 @@
 ### Malachite
 
-A RubyGem which enables calling Go code from Rails. Probably not production ready.
+Call Go functions directly from Rails.
+
+### Requirements
+
+Requires Ruby >= 2.0.0, Go 1.5 <-> 1.11.
+
+Xcode 8.3 is broken, do not use until [this is fixed](https://github.com/golang/go/issues/19734)
 
 ### Installation
 
-Install [Go 1.5 or later](https://golang.org/doc/install) on relevant machines.
+Install [Go](https://golang.org/doc/install). You must have a proper GOPATH.
 
 Add this to your Gemfile:
 
@@ -12,8 +18,6 @@ Add this to your Gemfile:
 gem 'malachite'
 ```
 
-Make a subdirectory of "app" called "go".
-
 ### Write Some Go Functions
 
 Everything in ```app/go``` will get compiled into one library, so to get it to work with
@@ -56,7 +60,7 @@ Check out the wiki on [Testing](https://github.com/zhubert/malachite/wiki/Testin
 
 ### How Does it Work?
 
-One part code generation, another part pure evil.
+Code generation.
 
 * The first time the function is called, Malachite will build a shared library from all the Go code in your ```app/go``` folder
 * It then uses Ruby's Fiddle to call the shared library
@@ -64,7 +68,7 @@ One part code generation, another part pure evil.
 
 Because of the JSON step, you'll only see real performance gains on computationally difficult tasks. Ruby's JSON conversion is a large tax.
 
-Note: You can also request precompilation. In an initializer:
+Note: You can also request precompilation. This is helpful for production environments. In an initializer:
 
 ```ruby
 Malachite.precompile
@@ -73,3 +77,7 @@ Malachite.precompile
 ### Ruby 2.2.4+
 
 It's strongly recommended to use the [newest release of Ruby](https://www.ruby-lang.org/en/news/2015/12/16/unsafe-tainted-string-usage-in-fiddle-and-dl-cve-2015-7551/) as there was a security issue with older versions of Fiddle.
+
+### Production Readiness
+
+Likely more gotchas with architecture variations and Cgo. Submit a PR if you find something.

data/lib/malachite/compiler.rb

@@ -2,10 +2,11 @@ module Malachite
   class Compiler
     def initialize
       @compiled_file = path_to_compiled_file
+      @compiled_header = path_to_compiled_header
     end
 
     def compile
-      return @compiled_file if File.exist?(@compiled_file)
+      return @compiled_file if File.exist?(@compiled_file) && File.exist?(@compiled_header)
       compile!
     end
 
@@ -13,12 +14,23 @@ module Malachite
 
     def compile!
       modify_source_files_in_tmp
+
       if modified_go_files == []
-        fail Malachite::BuildError, 'Nothing to build, there are no Go files in tmp'
+        raise Malachite::BuildError, 'Nothing to build, there are no Go files in tmp'
       end
-      unless system('go', 'build', '-buildmode=c-shared', '-o', @compiled_file, *modified_go_files)
-        fail Malachite::BuildError, 'Unable to Build Shared Library, is Go 1.5+ installed?'
+
+      unless system({ 'CGO_ENABLED' => '1' }, 'go', 'build', '-buildmode=c-shared', '-o', @compiled_file, *modified_go_files)
+        raise Malachite::BuildError, 'Unable to Build Shared Library, is Go 1.5+ installed?'
       end
+
+      unless File.exist?(@compiled_header)
+        raise Malachite::BuildError, 'Unable to Build Header File'
+      end
+
+      unless File.exist?(@compiled_file)
+        raise Malachite::BuildError, 'Unable to Build Shared Object'
+      end
+
       path_to_compiled_file
     end
 
@@ -47,5 +59,9 @@ module Malachite
     def path_to_compiled_file
       Rails.root.join('tmp', 'malachite.so').to_s
     end
+
+    def path_to_compiled_header
+      Rails.root.join('tmp', 'malachite.h').to_s
+    end
   end
 end

data/lib/malachite/tasks/malachite.rake

@@ -2,6 +2,6 @@ namespace :malachite do
   desc 'runs all Go tests in app/go'
   task :test do
     test_files = Dir["#{Rails.root.join('app', 'go')}/**/*.go"]
-    system('go', 'test', *test_files)
+    system({ 'CGO_ENABLED' => '1' }, 'go', 'test', *test_files)
   end
 end

data/lib/malachite/version.rb

@@ -1,3 +1,3 @@
 module Malachite
-  VERSION = '0.2.1'
+  VERSION = '1.1.0'
 end

data/malachite.gemspec

@@ -15,9 +15,8 @@ Gem::Specification.new do |spec|
   spec.version       = Malachite::VERSION
 
   spec.required_ruby_version = '>= 2.0.0'
-  spec.add_dependency 'json', '~> 1.0'
+  spec.add_dependency 'activesupport'
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5'
-  spec.add_development_dependency 'activesupport', '~> 4'
 end

data/test/client_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ClientTest < MiniTest::Unit::TestCase
+class ClientTest < MiniTest::Test
   def setup
     @client = Malachite::Client.new('upcase', ['foo'])
   end

data/test/file_compiler_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class FileCompilerTest < MiniTest::Unit::TestCase
+class FileCompilerTest < MiniTest::Test
   def setup
     @source = Malachite::FileCompiler.new(Rails.root.join('app', 'go', 'upcase.go')).compile
   end

data/test/performance_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+# Not really a performance test, but designed to generate more work
+class PerformanceTest < MiniTest::Test
+  def test_confirm_compilation_matches_fixture
+    1000.times do
+      @client = Malachite::Client.new('upcase', ['foo'])
+      assert_equal @client.call, ['FOO']
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: malachite
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Zack Hubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
 description: A RubyGem which enables calling Go code from Rails.
 email:
 - zhubert@gmail.com
@@ -88,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - README.md
 - Rakefile
@@ -110,6 +97,7 @@ files:
 - test/dummy/app/go/upcase.go
 - test/file_compiler_test.rb
 - test/fixtures/valid_upcase.go
+- test/performance_test.rb
 - test/rails_stub.rb
 - test/test_helper.rb
 homepage: http://www.zhubert.com
@@ -132,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A RubyGem which enables calling Go code from Rails