malachite 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ba4057a948f808a684ea7dd503ccaabe46bbba5
-  data.tar.gz: 8d2b9b35cd4104cd735e0c92db2c7098b98b30f4
+SHA256:
+  metadata.gz: d03c3c2f8c6c1f7f95459b33f9b1fc1de9059f9450979220d8078e323c6d7f59
+  data.tar.gz: d5fd7eebc38c4dd8ece734a2e763998e5c8fc110ea839254608b949c3304a53a
 SHA512:
-  metadata.gz: ec0603aa1eac3c6d5428c2b321ef4cb6a5a97f7aa91e36d356872f37419afec30e6a2f806e89ce8eac3e362ac9da93d61a021c93dfdfd7804bb859d9dd787631
-  data.tar.gz: d923d46e0ab54ff1c0d687a24a7019c715cf08b93d5fe5f7df08621f095f616308393e8a3e9d1525390f93bfc49532e95faea3b0822483b813e769c6aab03f89
+  metadata.gz: da6e655906d4dc4e6460747a2fda0f251f11d8b905a4ce00ad781d25813ce39e82893cc91c2f13ff2103f849ebc87840de13a19f84ef70329554b2055475e6da
+  data.tar.gz: 156e3a2c07a8270cd0cb09343885cc590887b8962a9cc0d107ba1e19c8b5b196d7dbe13983917a43aae0b2b4453bd16748919f509bd5e0426653314467c3ff51

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.6.3

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -2,11 +2,11 @@
 
 Call Go functions directly from Rails.
 
+
 ### Requirements
 
-Requires Ruby >= 2.0.0, Go 1.5 <-> 1.11.
+Requires Ruby >= 2.0.0, Go 1.5+.
 
-Xcode 8.3 is broken, do not use until [this is fixed](https://github.com/golang/go/issues/19734)
 
 ### Installation
 
@@ -54,6 +54,7 @@ More examples can be found in [examples](https://github.com/zhubert/malachite/wi
 
 Note: This would actually be slower than doing it in Ruby, due to the JSON serialization.
 
+
 ### Testing
 
 Check out the wiki on [Testing](https://github.com/zhubert/malachite/wiki/Testing)
@@ -62,22 +63,13 @@ Check out the wiki on [Testing](https://github.com/zhubert/malachite/wiki/Testin
 
 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
+* On every load in development and one time on boot elsewhere, 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
 * Arguments are passed back and forth via JSON
 
 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. This is helpful for production environments. In an initializer:
-
-```ruby
-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/Rakefile

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = 'test/*_test.rb'

data/lib/malachite.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'malachite/version'
-fail "Malachite #{Malachite::VERSION} does not support Ruby < 2.0.0" if RUBY_VERSION < '2.0.0'
+raise "Malachite #{Malachite::VERSION} does not support Ruby < 2.0.0" if RUBY_VERSION < '2.0.0'
 
 require 'json'
 require 'fiddle'
@@ -13,26 +15,6 @@ require 'malachite/file_compiler'
 require 'malachite/compiler'
 
 module Malachite
-  DEFAULTS = {
-    precompile: false
-  }
-
-  def self.options
-    @options ||= DEFAULTS.dup
-  end
-
-  def self.options=(opts)
-    @options = opts
-  end
-
-  def self.precompile?
-    Malachite.options.fetch(:precompile, false)
-  end
-
-  def self.precompile
-    Malachite.options[:precompile] = true
-  end
-
   def self.method_missing(name, args)
     Malachite::Client.new(name, args).call
   end
@@ -46,8 +28,4 @@ module Malachite
   end
 end
 
-if defined?(::Rails::Engine)
-  require 'malachite/railtie'
-else
-  fail "Malachite #{Malachite::VERSION} requires Rails"
-end
+require 'malachite/railtie' if defined?(Rails)

data/lib/malachite/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Malachite
   class Client
     def initialize(name, args)

data/lib/malachite/compiler.rb

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'open3'
+
 module Malachite
   class Compiler
     def initialize
@@ -7,6 +12,7 @@ module Malachite
 
     def compile
       return @compiled_file if File.exist?(@compiled_file) && File.exist?(@compiled_header)
+
       compile!
     end
 
@@ -15,21 +21,12 @@ module Malachite
     def compile!
       modify_source_files_in_tmp
 
-      if modified_go_files == []
-        raise Malachite::BuildError, 'Nothing to build, there are no Go files in tmp'
-      end
-
-      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
+      raise Malachite::BuildError, 'Nothing to build, there are no Go files in tmp' if modified_go_files == []
 
-      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
+      stdout, stderr, status = Open3.capture3({ 'CGO_ENABLED' => '1' }, 'go', 'build', '-buildmode=c-shared', '-o', @compiled_file, *modified_go_files)
+      raise Malachite::BuildError, "Unable to Build Shared Library: #{stdout} #{stderr}" unless status.success?
+      raise Malachite::BuildError, 'Unable to Build Header File' unless File.exist?(@compiled_header)
+      raise Malachite::BuildError, 'Unable to Build Shared Object' unless File.exist?(@compiled_file)
 
       path_to_compiled_file
     end
@@ -38,6 +35,7 @@ module Malachite
       source_files.each do |f|
         Malachite::FileCompiler.new(f).compile
       end
+
       File.open(Rails.root.join('tmp', 'main.go').to_s, 'w') do |file|
         file.puts main_boilerplate
         file.close
@@ -53,7 +51,7 @@ module Malachite
     end
 
     def main_boilerplate
-      File.read(File.expand_path('../main.go.tmpl', __FILE__))
+      File.read(File.expand_path('main.go.tmpl', __dir__))
     end
 
     def path_to_compiled_file

data/lib/malachite/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Malachite
   class BuildError < StandardError; end
   class ArgumentError < StandardError; end

data/lib/malachite/file_compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Malachite
   class FileCompiler
     def initialize(file)
@@ -20,22 +22,22 @@ module Malachite
     private
 
     def cgo_tmpl
-      cgo = File.read(File.expand_path('../cgo.tmpl', __FILE__))
-      return cgo.gsub(/HEADER/, RbConfig::CONFIG['rubyhdrdir']).gsub(/ARCH/, RbConfig::CONFIG['rubyarchhdrdir'])
+      cgo = File.read(File.expand_path('cgo.tmpl', __dir__))
+      cgo.gsub(/HEADER/, RbConfig::CONFIG['rubyhdrdir']).gsub(/ARCH/, RbConfig::CONFIG['rubyarchhdrdir'])
     end
 
-    def source_file(f)
-      File.readlines(f).drop(1)
+    def source_file(file)
+      File.readlines(file).drop(1)
     end
 
     def exporter_boilerplate(file)
-      exporter = File.read(File.expand_path('../exporter.go.tmpl', __FILE__))
+      exporter = File.read(File.expand_path('exporter.go.tmpl', __dir__))
       method_name, method_type = extract_method_and_type(file)
-      return exporter.gsub(/YYYYYY/, "#{method_type}{}").gsub(/XXXXXX/, method_name)
+      exporter.gsub(/YYYYYY/, "#{method_type}{}").gsub(/XXXXXX/, method_name)
     end
 
-    def file_has_handle_function?(f)
-      source = File.read(f)
+    def file_has_handle_function?(file)
+      source = File.read(file)
       match = /^func Handle(.*?)\(\w+ (.*?)\)/.match(source)
       match != nil
     end

data/lib/malachite/function.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fiddle'
 
 module Malachite

data/lib/malachite/function_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Malachite
   def self.function_cache
     @function_cache ||= {}
@@ -9,7 +11,8 @@ module Malachite
 
   def self.from_function_cache(method_name)
     existing_function = Malachite.function_cache[method_name]
-    return existing_function if existing_function != nil
+    return existing_function unless existing_function.nil?
+
     Malachite.add_to_function_cache(method_name)
   end
 
@@ -37,6 +40,6 @@ module Malachite
   end
 
   def self.shared_object_path
-    @so_path ||= Malachite::Compiler.new.compile
+    @shared_object_path ||= Malachite::Compiler.new.compile
   end
 end

data/lib/malachite/railtie.rb

@@ -1,22 +1,22 @@
+# frozen_string_literal: true
+
 module Malachite
-  def self.hook_rails!
-    Dir.glob(Rails.root.join('tmp', '*.so')).each do |file|
+  def self.setup!
+    Dir.glob(Rails.root.join('tmp', '*.{so,go,h}')).each do |file|
       File.delete(file)
     end
-    Dir.glob(Rails.root.join('tmp', '*.go')).each do |file|
-      File.delete(file)
-    end
-    Dir.glob(Rails.root.join('tmp', '*.h')).each do |file|
-      File.delete(file)
-    end
-    Malachite::Compiler.new.compile if Malachite.precompile?
+
+    Malachite::Compiler.new.compile
   end
-  class MalachiteRailtie < Rails::Railtie
+
+  class Railtie < Rails::Railtie
     rake_tasks do
       load 'malachite/tasks/malachite.rake'
     end
-    initializer 'malachite.configure_rails_initialization' do
-      Malachite.hook_rails!
+
+    # Executed once in production/staging and before each request in development.
+    config.to_prepare do
+      Malachite.setup!
     end
   end
 end

data/lib/malachite/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each do |task|
   load task
 end

data/lib/malachite/tasks/malachite.rake

@@ -4,4 +4,18 @@ namespace :malachite do
     test_files = Dir["#{Rails.root.join('app', 'go')}/**/*.go"]
     system({ 'CGO_ENABLED' => '1' }, 'go', 'test', *test_files)
   end
+
+  desc 'deletes any existing shared library and re-compiles'
+  task :compile do
+    Dir.glob(Rails.root.join('tmp', '*.so')).each do |file|
+      File.delete(file)
+    end
+    Dir.glob(Rails.root.join('tmp', '*.go')).each do |file|
+      File.delete(file)
+    end
+    Dir.glob(Rails.root.join('tmp', '*.h')).each do |file|
+      File.delete(file)
+    end
+    Malachite::Compiler.new.compile
+  end
 end

data/lib/malachite/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Malachite
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/malachite.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
   spec.add_dependency 'activesupport'
-  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5'
 end

data/test/client_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class ClientTest < MiniTest::Test

data/test/file_compiler_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class FileCompilerTest < MiniTest::Test
@@ -7,7 +9,7 @@ class FileCompilerTest < MiniTest::Test
 
   def test_confirm_compilation_matches_fixture
     compiled = File.read(Rails.root.join('tmp', 'upcase.go')).to_s
-    valid = File.read(File.expand_path('../fixtures/valid_upcase.go', __FILE__)).gsub(/HEADER/, RbConfig::CONFIG['rubyhdrdir']).gsub(/ARCH/, RbConfig::CONFIG['rubyarchhdrdir'])
+    valid = File.read(File.expand_path('fixtures/valid_upcase.go', __dir__)).gsub(/HEADER/, RbConfig::CONFIG['rubyhdrdir']).gsub(/ARCH/, RbConfig::CONFIG['rubyarchhdrdir'])
     assert_equal compiled, valid
   end
 end

data/test/performance_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 # Not really a performance test, but designed to generate more work

data/test/rails_stub.rb

@@ -1,12 +1,22 @@
+# frozen_string_literal: true
+
 require 'pathname'
+require 'ostruct'
+
 module Rails
-  Engine = {}
+  Engine = {}.freeze
+
   def self.root
     Pathname.new(File.join(Dir.pwd, 'test', 'dummy'))
   end
+
   class Railtie
     def self.rake_tasks; end
 
+    def self.config
+      OpenStruct.new(to_prepare: {})
+    end
+
     def self.initializer(_); end
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_stub'
 require 'malachite'
 require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: malachite
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Zack Hubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-01 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A RubyGem which enables calling Go code from Rails