crystalruby 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8dc48667be65ee6e6d36ba7efcfc87dfefb133a06cb375a22297db9643221e3
-  data.tar.gz: 40753b3741ae9fb5dec86019d35968027517280a08ae6bffbcf8f2e207fe96b3
+  metadata.gz: 7c552102391f468b4974cb4ac36c4876001743fdec5fa8f2a69577255de4c52d
+  data.tar.gz: f7c104b10cf70eb03ab064117be946d4268c97063ba9302a99613e9c473ded97
 SHA512:
-  metadata.gz: 1682a4405fd2baf66a93fc913af2146fa11e9806b90c8d6ac6d0eebc496b30415204474bd841377e3ea409401608f2907f58d7b717b21520cd4b1fe04d825d86
-  data.tar.gz: 8682ebdcdd83bda6ab29261cdfc627afe1bd211343bc4caa95c9f08cbb30fba663f1aebcf4df1535e27d7a84377449d5028afcce145cc0a91c153721e2d261f1
+  metadata.gz: 0c01cefa9a6f820cd59aed62e02846bd90cd53a742c203b8de0023908c53e77ef2a558adf26023008dcd921e9c9cbc0466a63598361c18ec7cc6bee29a57ce2c
+  data.tar.gz: a9fe76d0b8a93dab4afd94d696d9955a81e75384fd1d4af8a0af5249c30fd51920d46de4728caab630862c889e799f1207f9915176fe861c6624e7a13d994e5a

data/README.md

@@ -133,6 +133,31 @@ def add(a, b)
 end
 ```
 
+## Getting Started
+
+The below is a stand-alone one-file script that allows you to quickly see crystalruby in action.
+
+```ruby
+# crystalrubytest.rb
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'crystalruby', path: '../crystalruby'
+end
+
+require 'crystalruby'
+
+module Adder
+  crystalize [a: :int, b: :int] => :int
+  def add(a, b)
+    a + b * 3
+  end
+end
+
+puts Adder.add(1, 2)
+```
+
 ## Types
 
 Currently primitive types are supported.
@@ -249,7 +274,7 @@ Remember to require these installed shards after installing them. E.g. inside `.
 
 You can edit the default paths for crystal source and library files from within the `./crystalruby.yaml` config file.
 
-### Wrapping Crystal code in Ruby
+## Wrapping Crystal code in Ruby
 
 Sometimes you may want to wrap a Crystal method in Ruby, so that you can use Ruby before the Crystal code to prepare arguments, or after the Crystal code, to apply transformations to the result. A real-life example of this might be an ActionController method, where you might want to use Ruby to parse the request, perform auth etc., and then use Crystal to perform some heavy computation, before returning the result from Ruby.
 To do this, you simply pass a block to the `crystalize` method, which will serve as the Ruby entry point to the function. From within this block, you can invoke `super` to call the Crystal method, and then apply any Ruby transformations to the result.
@@ -270,7 +295,7 @@ end
 MyModule.add("1", "2")
 ```
 
-### Release Builds
+## Release Builds
 
 You can control whether CrystalRuby builds in debug or release mode by setting following config option
 
@@ -303,7 +328,7 @@ CrystalRuby.compile!
 
 Then you can run this file as part of your build step, to ensure all Crystal code is compiled ahead of time.
 
-### Troubleshooting
+## Troubleshooting
 
 The logic to detect when to JIT recompile is not robust and can end up in an inconsistent state. To remedy this it is useful to clear out all generated assets and build from scratch.
 

data/lib/crystalruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crystalruby
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/crystalruby.rb

@@ -292,10 +292,11 @@ module CrystalRuby
               "crystal build --release --no-debug -o #{lib_target} #{config.crystal_main_file}"
             end
 
-      raise "Error compiling crystal code" unless result = system(cmd)
-
+      unless result = system(cmd)
+        File.delete("#{config.crystal_codegen_dir}/index.cr") if File.exist?("#{config.crystal_codegen_dir}/index.cr")
+        raise "Error compiling crystal code"
+      end
       @compiled = true
-      File.delete("#{config.crystal_codegen_dir}/index.cr") if File.exist?("#{config.crystal_codegen_dir}/index.cr")
     end
     extend FFI::Library
     ffi_lib "#{config.crystal_lib_dir}/#{config.crystal_lib_name}"
@@ -303,7 +304,7 @@ module CrystalRuby
     const_set(:ErrorCallback, FFI::Function.new(:void, %i[string string]) do |error_type, message|
       error_type = error_type.to_sym
       is_exception_type = Object.const_defined?(error_type) && Object.const_get(error_type).ancestors.include?(Exception)
-      error_type = is_exception_type ?  Object.const_get(error_type) : RuntimeError
+      error_type = is_exception_type ? Object.const_get(error_type) : RuntimeError
       raise error_type.new(message)
     end)
     attach_rb_error_handler(ErrorCallback)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crystalruby
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Wouter Coppieters