preval 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b1ef70f4fe7a2d5280f11a2466a8543d95fd55a82a7c148b3e9eee720b3ec03
-  data.tar.gz: 8756a3c7ed21d3b9765925f3888b72349bb215a60230c249e86c87fe3efdeae1
+  metadata.gz: 8e6a0c329c5ed18bfae8f21d08c13d96a2abb5c258d4233795c75c1e40019c3a
+  data.tar.gz: ea764b40b8983db9e8398a86df971c03d47be73bf3c31ec043293e3f8323cf93
 SHA512:
-  metadata.gz: 7c60862886c355c7aa6412947e0d0fc7530fe74d8e506ffcbdd9d62a50e80b6a48d586dd777968adaeeadba49fc6ab01cb4cccbc358aa0530d56e51fb2bb68b0
-  data.tar.gz: 41bc24f5cf74cf2f06704cf2519ab46753c54a63be181190dca2eaafa33d425caa0b6ed8709ba39ed8b26723aadeb366c69b6896c06e51d3c190c01970c20df2
+  metadata.gz: 14f7fd99735026b877061a53db6c13b795e4ea0a98e9ae3f0bfbd52ccabec28e712027323074c1b564f0c561c1f2af726e550e5415ad9014bfb5e9c42f63deb9
+  data.tar.gz: 1551ab23dfb06db810a3522727db2ae1915084f00c560072fafbb8033d921a113c78d51edaead97ad19eff82320ee883b81d43b0d870a5e4305949c269402050

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2019-04-18
+### Added
+- Hook into the `bootsnap` gem if it's loaded.
+
+## [0.1.0] - 2019-03-08
+### Added
+- Initial release. 🎉
+
+[Unreleased]: https://github.com/kddeisz/preval/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/kddeisz/preval/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/kddeisz/preval/compare/49c899...v0.1.0

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'bootsnap'
 gem 'sinatra'

data/Gemfile.lock

@@ -1,12 +1,15 @@
 PATH
   remote: .
   specs:
-    preval (0.1.0)
+    preval (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    bootsnap (1.4.3)
+      msgpack (~> 1.0)
     minitest (5.11.3)
+    msgpack (1.2.10)
     mustermann (1.0.3)
     rack (2.0.6)
     rack-protection (2.0.5)
@@ -23,6 +26,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bootsnap
   bundler (~> 2.0)
   minitest (~> 5.11)
   preval!

data/README.md

@@ -4,7 +4,7 @@
 
 Certain optimizations that are common in compilers are not immediately possible with Ruby on account of Ruby's flexibility. For example, most compilers will run through a process called [constant folding](https://en.wikipedia.org/wiki/Constant_folding) to eliminate the need to perform extraneous operations at runtime (e.g., `5 + 2` in the source can be replaced with `7`). However, because Ruby allows you to override the `Integer#+` method, it's possible that `5 + 2` would not evaluate to `7`. `preval` assumes that most developers will not override the `Integer#+` method, and performs optimizations under that assumption.
 
-Users must opt in to each of `preval`'s optimizations, as there's no real way of telling whether or not it is 100% safe for any codebase. The more optimizations are allowed to run, the most time and memory savings later. Users can also define their own optimizations by subclassing the `Preval::Visitor` class and using the existing `Preval::Node` APIs to replace and update the Ruby AST as necessary.
+Users must opt in to each of `preval`'s optimizations, as there's no real way of telling whether or not it is 100% safe for any codebase. The more optimizations are allowed to run, the more time and memory savings later. Users can also define their own optimizations by subclassing the `Preval::Visitor` class and using the existing `Preval::Node` APIs to replace and update the Ruby AST as necessary.
 
 ## Installation
 
@@ -24,9 +24,9 @@ Or install it yourself as:
 
 ## Usage
 
-At the moment, this gem is a POC and should not be used in production. If you want to experiment with it, you can use the `bootsnap` gem to hook into the compilation process and run `Preval.process` over the source as it comes through. This will eventually be automated.
+If you're using the `bootsnap` gem, `preval` will automatically hook into its compilation step. Otherwise, you'll need to manually call `Preval.process(source)` with your own iseq loader (you can check out [yomikomu](https://github.com/ko1/yomikomu) for an example).
 
-Each optimization is generally named for the function it performs, and can be enabled through the `enable!` method on the visitor class.
+Each optimization is generally named for the function it performs, and can be enabled through the `enable!` method on the visitor class. If you do not explicitly call `enable!` on any optimizations, nothing will change with your source.
 
 * `Preval::Visitors::Arithmetic`
   * replaces constant expressions with their evaluation (e.g., `5 + 2` becomes `7`)

data/bin/print

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'preval'
+
+Preval::Visitors::Arithmetic.enable!
+Preval::Visitors::Loops.enable!
+
+source = ARGV.first
+puts Preval.process(File.exist?(source) ? File.read(source) : source)

data/lib/preval.rb

@@ -23,3 +23,20 @@ require 'preval/version'
 require 'preval/visitor'
 require 'preval/visitors/arithmetic'
 require 'preval/visitors/loops'
+
+if defined?(Bootsnap)
+  load_iseq = RubyVM::InstructionSequence.method(:load_iseq)
+
+  if load_iseq.source_location[0].include?('/bootsnap/')
+    Bootsnap::CompileCache::ISeq.singleton_class.prepend(
+      Module.new do
+        def input_to_storage(source, path)
+          source = Preval.process(source)
+          RubyVM::InstructionSequence.compile(source, path, path).to_binary
+        rescue SyntaxError
+          raise Bootsnap::CompileCache::Uncompilable, 'syntax error'
+        end
+      end
+    )
+  end
+end

data/lib/preval/format.rb

@@ -60,7 +60,7 @@ module Preval
     to(:do_block) { " do#{body[0] ? " #{source(0)}" : ''}\n#{source(1)}\nend" }
     to(:dot2) { join('..') }
     to(:dot3) { join('...') }
-    to(:dyna_symbol) { ":\"#{source(0)}\"" }
+    to(:dyna_symbol) { starts_with?(:xstring_add) ? ":\"#{source(0)}\"" : ":\"#{source(0).join}\"" }
     to(:END) { "END {\n#{source(0)}\n}"}
     to(:else) { "else\n#{source(0)}" }
     to(:elsif) { "elsif #{source(0)}\n#{source(1)}#{body[2] ? "\n#{source(2)}" : ''}" }

data/lib/preval/version.rb

@@ -1,3 +1,3 @@
 module Preval
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preval
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,12 +61,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
+- bin/print
 - bin/setup
 - docs/index.html
 - docs/server.rb
@@ -98,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Automatically optimizes your Ruby code