polycrystal 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46441f58bfab74d37c13333f222535918c57664bbb25e41078e722a95a3be082
-  data.tar.gz: 453ce9f790daa4fec95da21809e99b5b5c459b51b6ff0d2e005b8d8eab9d9224
+  metadata.gz: 6b792f50cc3fd49e84d1964fb3a494cad847b945685b887774ccb902e5d37092
+  data.tar.gz: b07a7239c6dfa5daeb20cfdf17c9dee8d592183509d7e2c25e16df0cf63582d6
 SHA512:
-  metadata.gz: 127245a07887867cdb4de1902965cb2523b3a57fd1a065d1a9edcad18f687f034377c1824fd92e7b38fe37f4c19dbae92ba4c78848077c118c567601dd8a4673
-  data.tar.gz: c269b0e48439cd52ae938f3fbdf85ba6b4c21c73b59839be93017971126ad03cb3394e97bdfcc81a3f9e799a3fc863001ad16e17b86a1597bf304d25b5de0e22
+  metadata.gz: fcc7135cbcadd6ccaa981e71192c3305f08e71c82f08883bb0820c938991fb0db7a39cd4cc06a181aae1df5ea59ecde1bc565252d9086a9bd2e29a017756a37c
+  data.tar.gz: 647f6a42daf887880b76e3a42fc3c9f995734e0a57f69cc18766b2e67780092f16aec941998cadf2f4b4830d5cbc73103db3e9678964da72098c825015b018bc

data/.gitignore

@@ -19,3 +19,4 @@ ext/polycrystal/Makefile
 .byebug_history
 /.vscode
 Gemfile.lock
+polycrystal-*.gem

data/README.md

@@ -71,21 +71,42 @@ Polycrystal::Registry.register(
     modules: ['CrystalModule'] 
 )
 
-# directory for entrypoint and compiled library. 
+# cpmpile and load 
+# should be called once, after all Polycrystal::Registry#register calls
+Polycrystal.load
+```
+
+Set custom properties
+```ruby
+# directory for crystal entrypoint and compiled library. 
 build_path = File.expand_path("#{__dir__}/build") 
 FileUtils.mkdir_p(build_path)
 
-# cpmpile and load 
-# should be called once, after all Polycrystal::Registry#register calls
-Polycrystal::Loader.new(build_path: build_path).load
+
+Polycrystal.load(
+    # directory for crystal entrypoint and compiled library. 
+    build_path: build_path,
+    # used to find lib with installed shards. SHARDS_INSTALL_PATH is used if present
+    shardfile: "./crystal/shard.yml", 
+    # Polycrystal::NO_PRECOMPILE - compile everytime
+    # Polycrystal::LAZY_COMPILE - compile if not yet compiled
+    # Polycrystal::REQUIRE_AOT - not compile, require to be precompiled
+    precompile: Polycrystal::LAZY_COMPILE, # by default
+)
 ```
 
 ## TODO
 
 1. Test suite
+2. Remove C code from this extension.
+   * C code is not required. Crystal code may be directly compiled to extension and loaded using standard `requre`
+   * To achieve that, anyolite glue files should be compiled to object files and linked to existing ruby correctly. I got segfault when I built glue files outside of ruby extension
 2. Code should not be recompiled if it was not changed
+   * Rudimentary implementation is present, but more stable is preferrable: `Polycrystal.load(precompile: Polycrystal::LAZY_COMPILE)`
 3. Ability to precompile all code on demand, e.g. for Docker images
-4. make shards work. Anyolite may be loaded from shards, if my patches are merged, or better alternatives implemented
+   * It is possible to do that right now by calling `Polycrystal.load(precompile: Polycrystal::LAZY_COMPILE)` in separate command, while loading Crystal module using `Polycrystal.load(precompile: Polycrystal::REQUIRE_AOT)`
+4. make shards work. DONE, except:
+   * Anyolite can't be loaded from shards, because it's postinstall script downloads and compiles it's own mruby 
 
 ## Development
 

data/lib/polycrystal/compiler.rb

@@ -1,32 +1,54 @@
 # frozen_string_literal: true
 
+require 'zlib'
+
 module Polycrystal
   class Compiler
-    attr_reader :build_path, :registry
+    attr_reader :build_path, :shardfile, :registry, :precompile
 
-    def initialize(build_path:, registry: Polycrystal::Registry.instance)
+    def initialize(build_path:, shardfile: nil, registry: Polycrystal::Registry.instance, precompile: LAZY_COMPILE)
       @build_path = build_path
       @registry = registry
-      # load anyolite
-      add_anyolite
+      @shardfile = shardfile
+      @precompile = precompile
     end
 
     def prepare
       # load anyolite
       add_anyolite
+      # add lib with shards
+      use_shards
       # write crystal entrypoint
       in_file.write(entrypoint)
       in_file.close
     end
 
     def execute
-      # run compiler
-      puts command
-      raise 'Failed to compile crystal module' unless system(command)
+      if precompile == NO_PRECOMPILE
+        compile
+      elsif precompile == REQUIRE_AOT
+        raise 'Crystal module should be compiled before run' unless File.exist?(outfile)
+      else
+        compile unless File.exist?(outfile)
+      end
 
       outfile
     end
 
+    private
+
+    def use_shards
+      shard_path = ENV.fetch('SHARDS_INSTALL_PATH') do
+        return unless shardfile
+
+        shardfile_path = File.expand_path(shardfile)
+        return unless File.exist?(shardfile_path)
+
+        "#{File.dirname(shardfile_path)}/lib"
+      end
+      registry.register(path: shard_path)
+    end
+
     def add_anyolite
       registry.register(
         path: find_anyolite,
@@ -87,16 +109,16 @@ module Polycrystal
     end
 
     def crystal_link_flags
-        case RUBY_PLATFORM
-        when /darwin/
-            "-dynamic -bundle"
-        when /linux/
-            mapfile = File.expand_path("#{build_path}/version.map")
-            File.write(mapfile, "VERS_1.1 {\tglobal:\t\t*;};")
-            "-shared -Wl,--version-script=#{mapfile}"
-        else
-            raise "Unknown platform"
-        end
+      case RUBY_PLATFORM
+      when /darwin/
+        '-dynamic -bundle'
+      when /linux/
+        mapfile = File.expand_path("#{build_path}/version.map")
+        File.write(mapfile, "VERS_1.1 {\tglobal:\t\t*;};")
+        "-shared -Wl,--version-script=#{mapfile}"
+      else
+        raise 'Unknown platform'
+      end
     end
 
     def pad_line(line, n)
@@ -112,31 +134,31 @@ module Polycrystal
     end
 
     def outfile
-      File.expand_path("#{build_path}/polycrystal_module.#{lib_ext}")
+      @outfile ||= File.expand_path("#{build_path}/polycrystal#{compile_hash}_module.#{lib_ext}")
     end
 
     def lib_ext
-        case RUBY_PLATFORM
-        when /darwin/
-            "bundle"
-        when /linux/
-            "so"
-        else
-            raise "Unknown platform"
-        end
+      case RUBY_PLATFORM
+      when /darwin/
+        'bundle'
+      when /linux/
+        'so'
+      else
+        raise 'Unknown platform'
+      end
     end
 
     def include_paths
-      existing = `#{compiler_cmd} env`.split("\n").find { |line| line.start_with?('CRYSTAL_PATH') }
-      [existing, *crystal_paths].join(':')
+      existing = `#{compiler_cmd} env CRYSTAL_PATH`.strip
+      ["CRYSTAL_PATH=#{existing}", *crystal_paths].join(':')
     end
 
     def anyolite_glue
       "-L#{RbConfig::CONFIG['libdir']} #{RbConfig::CONFIG['LIBRUBYARG_SHARED']} " \
-      "#{File.expand_path("#{__dir__}/../../ext/polycrystal/data_helper.o")} " \
-      "#{File.expand_path("#{__dir__}/../../ext/polycrystal/error_helper.o")} " \
-      "#{File.expand_path("#{__dir__}/../../ext/polycrystal/return_functions.o")} " \
-      "#{File.expand_path("#{__dir__}/../../ext/polycrystal/script_helper.o")} "
+        "#{File.expand_path("#{__dir__}/../../ext/polycrystal/data_helper.o")} " \
+        "#{File.expand_path("#{__dir__}/../../ext/polycrystal/error_helper.o")} " \
+        "#{File.expand_path("#{__dir__}/../../ext/polycrystal/return_functions.o")} " \
+        "#{File.expand_path("#{__dir__}/../../ext/polycrystal/script_helper.o")} "
     end
 
     def compiler_cmd
@@ -162,5 +184,20 @@ module Polycrystal
 
       local_path
     end
+
+    def compile
+      # run compiler
+      puts command
+      raise 'Failed to compile crystal module' unless system(command)
+    end
+
+    def compile_hash
+      paths = crystal_paths.sort + [in_file.path]
+      paths.map { |path| path_hash(path) }.reduce(:^).to_s(32)
+    end
+
+    def path_hash(path)
+      Zlib.crc32(`ls -lRF #{path}`)
+    end
   end
 end

data/lib/polycrystal/loader.rb

@@ -2,18 +2,13 @@
 
 module Polycrystal
   class Loader
-    attr_reader :build_path, :registry
+    attr_reader :compiler
 
-    def initialize(build_path:, registry: Polycrystal::Registry.instance)
-      @build_path = build_path
-      @registry = registry
+    def initialize(compiler:)
+      @compiler = compiler
     end
 
     def load
-      compiler = Polycrystal::Compiler.new(
-        build_path: build_path,
-        registry: registry
-      )
       compiler.prepare
       library = compiler.execute
       load_library(library) # load_library is defined in C file

data/lib/polycrystal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Polycrystal
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/polycrystal.rb

@@ -8,5 +8,19 @@ require 'polycrystal/loader'
 
 module Polycrystal
   class Error < StandardError; end
-  # Your code goes here...
+
+  PRECOMPILE = [
+    NO_PRECOMPILE = :no_precompile,
+    LAZY_COMPILE = :lazy_compile,
+    REQUIRE_AOT = :require_compiled
+  ].freeze
+
+  def self.load(build_path: nil, shardfile: nil, precompile: LAZY_COMPILE)
+    build_path ||= "#{Dir.pwd}/build"
+    shardfile ||= "#{Dir.pwd}/shard.yml" if File.exist?("#{Dir.pwd}/shard.yml")
+    shardfile ||= "#{Dir.pwd}/crystal/shard.yml" if File.exist?("#{Dir.pwd}/crystal/shard.yml")
+
+    compiler = Polycrystal::Compiler.new(build_path: build_path, shardfile: shardfile, precompile: precompile)
+    Polycrystal::Loader.new(compiler: compiler).load
+  end
 end

data/sample_project/.gitignore

@@ -1 +1,2 @@
-/build
+/build
+/crystal/lib

data/sample_project/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    polycrystal (0.1.1)
+    polycrystal (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/sample_project/crystal/sample.cr

@@ -1,8 +1,14 @@
+require "jwt"
+
 class CrystalModule
     class SomeThing
         def some_method
             69.0
         end
+
+        def check_deps
+            JWT.encode({"test" => "key"}, "SecretKey", JWT::Algorithm::HS256)
+        end
     end
 
     class CrystalClass

data/sample_project/crystal/shard.lock

@@ -0,0 +1,14 @@
+version: 2.0
+shards:
+  bindata:
+    git: https://github.com/spider-gazelle/bindata.git
+    version: 1.10.0
+
+  jwt:
+    git: https://github.com/crystal-community/jwt.git
+    version: 1.6.0
+
+  openssl_ext:
+    git: https://github.com/spider-gazelle/openssl_ext.git
+    version: 2.2.0
+

data/sample_project/crystal/shard.yml

@@ -0,0 +1,14 @@
+name: sample_project
+version: 0.1.0
+
+# authors:
+#   - name <email@example.com>
+
+# description: |
+#   Short description of sample_project
+
+dependencies:
+  jwt:
+    github: crystal-community/jwt
+
+# license: MIT

data/sample_project/sample.rb

@@ -11,8 +11,4 @@ Polycrystal::Registry.register(
   modules: ['CrystalModule']
 )
 
-build_path = File.expand_path("#{__dir__}/build")
-
-FileUtils.mkdir_p(build_path)
-
-Polycrystal::Loader.new(build_path: build_path).load
+Polycrystal.load

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: polycrystal
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andrii Hrushetskyi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,8 @@ files:
 - sample_project/Gemfile
 - sample_project/Gemfile.lock
 - sample_project/crystal/sample.cr
+- sample_project/crystal/shard.lock
+- sample_project/crystal/shard.yml
 - sample_project/sample.rb
 homepage: https://github.com/ahrushetskyi/polycrystal
 licenses:
@@ -109,7 +111,7 @@ metadata:
   source_code_uri: https://github.com/ahrushetskyi/polycrystal
   changelog_uri: https://github.com/ahrushetskyi/polycrystal/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Integrate Crystal into ruby
 test_files: []