crystalruby 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26b2e0d15fd3b320f700a1f0571b8bb5d8991a4ed1c60cfcd9f003b48bb9f891
-  data.tar.gz: 27243d104172eef50adfc46524a0b9052410636dc0b39e142fc3e53c04ded1f0
+  metadata.gz: 7c552102391f468b4974cb4ac36c4876001743fdec5fa8f2a69577255de4c52d
+  data.tar.gz: f7c104b10cf70eb03ab064117be946d4268c97063ba9302a99613e9c473ded97
 SHA512:
-  metadata.gz: a54c1cf883a7dea97d66e9c18903139713aaec0b965026a21fc2e14ced85c13fc676f7d8e76ecc9a2e6ca2fc69034185a9fa4eb6fc66a6986cc9bb2d037738fb
-  data.tar.gz: 0f29fe7bad266af6593d0e4533af27a9be925372befe40ed0e4ee5ea8c9293c7ea62aab4b1664eaf3d2202eb3000b3dda1dfbdc44ae9e924e2de017f5516a6bc
+  metadata.gz: 0c01cefa9a6f820cd59aed62e02846bd90cd53a742c203b8de0023908c53e77ef2a558adf26023008dcd921e9c9cbc0466a63598361c18ec7cc6bee29a57ce2c
+  data.tar.gz: a9fe76d0b8a93dab4afd94d696d9955a81e75384fd1d4af8a0af5249c30fd51920d46de4728caab630862c889e799f1207f9915176fe861c6624e7a13d994e5a

data/README.md

@@ -1,4 +1,19 @@
-# crystalruby
+<table>
+  <tr>
+    <td><img src="logo.png" alt="logo" width="150"></td>
+    <td>
+      <h1 align="center">crystalruby</h1>
+      <p align="center">
+        <a href="https://rubygems.org/gems/crystalruby">
+          <img alt="GEM Version" src="https://img.shields.io/gem/v/crystalruby?color=168AFE&include_prereleases&logo=ruby&logoColor=FE1616">
+        </a><br>
+        <a href="https://rubygems.org/gems/crystalruby">
+          <img alt="GEM Downloads" src="https://img.shields.io/gem/dt/crystalruby?color=168AFE&logo=ruby&logoColor=FE1616">
+        </a>
+      </p>
+    </td>
+  </tr>
+</table>
 
 `crystalruby` is a gem that allows you to write Crystal code, inlined in Ruby. All you need is a modern crystal compiler installed on your system.
 
@@ -118,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.
@@ -234,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.
@@ -255,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
 
@@ -288,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.
 
@@ -310,7 +350,6 @@ It should support escape hatches to allow it to coexist with code that performs
 The library is currently in its infancy. Planned additions are:
 
 - Replace existing checksum process, with one that combines results of inline and external crystal to more accurately detect when recompilation is necessary.
-- Support for automatic serialization of nested data structures (holding _ONLY_ primitives), using JSON as our serialization protocol (prioritizing portability over raw serialization performance. JSON generation and parsing is bundled into the stdlib in both languages).
 - Simple mixin/concern that utilises `FFI::Struct` for bi-directional passing of Ruby objects and Crystal objects (by value).
 - Install command to generate a sample build script, and supports build command (which simply verifies then invokes this script)
 - Call Ruby from Crystal using FFI callbacks (implement `.expose_to_crystal`)

data/lib/crystalruby/template.rb

@@ -1,4 +1,3 @@
-require 'pry-byebug'
 module CrystalRuby
   module Template
     Dir[File.join(File.dirname(__FILE__), "templates", "*.cr")].each do |file|

data/lib/crystalruby/typebuilder.rb

@@ -65,115 +65,3 @@ module CrystalRuby
     end
   end
 end
-
-# class UnionType
-#   attr_reader :inner
-
-#   def initialize(*inner)
-#     @inner = inner
-#   end
-
-#   def |(other)
-#     UnionType.new(*inner, *other.inner)
-#   end
-
-#   def inspect
-#     elements = inner.map(&:inspect).join(" | ")
-#   end
-# end
-
-# class Type
-#   attr_reader :inner, :contains
-
-#   def initialize(name)
-#     @name = name
-#     @contains = contains
-#     @inner = [self]
-#   end
-
-#   def |(other)
-#     UnionType.new(*inner, *other.inner)
-#   end
-
-#   def inspect
-#     if @contains
-#       "#{@name}(#{@contains.inspect})"
-#     else
-#       @name
-#     end
-#   end
-# end
-
-# module_function
-
-# %w[
-#   Bool Uint8 Uint16 Uint32 Uint64 Int8 Int16 Int32 Int64 Float32 Float64 String Time Symbol
-#   Null
-# ].map do |t|
-#   cls = Class.new(Type)
-#   const_set(t, cls)
-#   define_method(t.downcase) do
-#     cls.new(t)
-#   end
-# end
-
-# def build(&blk)
-#   instance_exec(&blk)
-# end
-
-# def hash(key_type, value_type)
-#   Hash.new(key_type, value_type)
-# end
-
-# def array(type)
-#   Array.new(type)
-# end
-
-# def tuple(*types)
-#   Tuple.new(*types)
-# end
-
-# def named_tuple(type_hash)
-#   NamedTuple.new(type_hash)
-# end
-
-# def NamedTuple(type_hash)
-#   NamedTuple.new(type_hash)
-# end
-
-# class Hash < Type
-#   HASH_KEY_TYPES = %w[String Symbol].freeze
-#   def initialize(key_type, value_type)
-#     super("Hash")
-#     @key_type = key_type
-#     @value_type = value_type
-#     raise "Invalid key type" unless [Uint8, Uint16, Uint32, Uint64, Int8, Int16, Int32, Int64,
-#                                      String].include?(key_type)
-#     raise "Invalid value type" unless value_type.is_a?(Type)
-#   end
-# end
-
-# class Array < Type
-#   def initialize(value_type)
-#     super("Array")
-#     @value_type = value_type
-#     raise "Invalid value type" unless value_type.is_a?(Type)
-#   end
-# end
-
-# class NamedTuple < Type
-#   def initialize(types_hash)
-#     raise "keys must be symbols" unless types_hash.keys.all? { |k| k.is_a?(Symbol) }
-#     raise "Invalid value type" unless types_hash.values.all? { |v| v.is_a?(Type) }
-
-#     super("NamedTuple")
-#     @types_hash = types_hash
-#   end
-# end
-
-# class Tuple < Type
-#   def initialize(*value_types)
-#     super("Tuple")
-#     raise "Invalid value type" unless value_types.all? { |v| v.is_a?(Type) }
-#   end
-# end

data/lib/crystalruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crystalruby
-  VERSION = "0.1.4"
+  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.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Wouter Coppieters
@@ -107,6 +107,7 @@ files:
 - lib/crystalruby/types/union_type.rb
 - lib/crystalruby/version.rb
 - lib/module.rb
+- logo.png
 - sig/crystalruby.rbs
 homepage: https://github.com/wouterken/crystalruby
 licenses: