iseq_rails_tools 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b5e048c97ff3fdbd635135e589ac488d70bc0c4
+  data.tar.gz: 2a614cd2aa085f5a9638f2157b683dcf522a2c21
+SHA512:
+  metadata.gz: 6cdf29659c15bdde45f5ccb455cf15fedfa17440929a6befc68d16849a3c89e43a1ec70849b0d150aaa1c000b8ab3ae251ce98d8ac17fcdadb4b42930f6e4509
+  data.tar.gz: 3707519c3391f1553d918295451ce636dcaa2a43be8c9305fb9eefcea211a0cff9ce964841f91c63bd1c1d47d6b5c818090afbdf964f171568aefbd7293dfd1c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Kevin Deisz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# IseqRailsTools
+
+[![Build Status](https://travis-ci.org/kddeisz/iseq-rails-tools.svg?branch=master)](https://travis-ci.org/kddeisz/iseq-rails-tools)
+
+Since Ruby 2.3, we've had the ability to dump out compiled Ruby bytecode to files to alleviate that process when ruby files are required. This can significantly boost boot times, especially when running with larger Ruby projects.
+
+This gem hooks into ActiveSupport's autoloading in development mode to bring AOT compiling to Rails. This can improve both the console and server boot times.
+
+When deploying to production, you can take advantage of the quicker boot times by adding the `iseq:all` rake task to your deploy script.
+
+## Usage
+
+1. Add `iseq_rails_tools` to your `Gemfile`.
+2. Run `bundle install` to download the gem.
+3. Add `.iseq/` to your `.gitignore`.
+
+Then when running the console or the server, the compiled files will start to be generated in a new `.iseq` directory in the root of the repository.
+
+## Tasks
+
+`IseqRailsTools` adds a couple `Rake` tasks to your Rails project:
+
+1. `iseq:all` - Compile iseq files for all files under autoloaded paths
+2. `iseq:clear` - Clear out all compiled iseq files
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/iseq-rails-tools.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Credit
+
+A lot of the inspiration (as well as some of the code) for this gem came from Koichi Sasada's great work on the [yomikomu](https://github.com/ko1/yomikomu) gem.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IseqRailsTools'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/iseq_rails_tools.rb

@@ -0,0 +1,40 @@
+require 'digest/sha1'
+require 'fileutils'
+
+require 'iseq_rails_tools/compiler'
+require 'iseq_rails_tools/railtie'
+
+module IseqRailsTools
+  class NullCompiler
+    def clear_compiled_iseq_files
+    end
+
+    def watching?(filepath)
+      false
+    end
+  end
+
+  class << self
+    attr_accessor :compiler
+
+    def clear_compiled_iseq_files
+      compiler.clear_compiled_iseq_files
+    end
+
+    def compile_all
+      compiler.compile_all
+    end
+  end
+
+  self.compiler = NullCompiler.new
+end
+
+RubyVM::InstructionSequence.singleton_class.prepend(Module.new do
+  def load_iseq(filepath)
+    if ::IseqRailsTools.compiler.watching?(filepath)
+      ::IseqRailsTools.compiler.load_iseq(filepath)
+    elsif method(:load_iseq).super_method
+      super
+    end
+  end
+end)

data/lib/iseq_rails_tools/compiler.rb

@@ -0,0 +1,87 @@
+module IseqRailsTools
+  class Compiler
+    DIRECTORY_NAME = '.iseq'
+
+    attr_reader :application, :directory
+
+    def initialize(application)
+      @application = application
+      @directory   = application.root.join(DIRECTORY_NAME).to_s
+      FileUtils.mkdir_p(directory) unless File.directory?(directory)
+    end
+
+    def clear_compiled_iseq_files
+      Dir.glob(File.join(directory, '**/*.yarb')) { |path| FileUtils.rm(path) }
+    end
+
+    def compile_all
+      globs.each do |glob|
+        Dir.glob(glob).each do |filepath|
+          iseq_key = iseq_key_name(filepath)
+          compile_and_store_iseq(filepath, iseq_key)
+        end
+      end
+    end
+
+    def iseq_key_name(filepath)
+      path = filepath.gsub("#{application.root.to_s}/", '')
+                     .gsub(/[^A-Za-z0-9\._-]/) { |c| '%02x' % c.ord }
+      File.join(directory, "#{path}.yarb")
+    end
+
+    def load_iseq(filepath)
+      iseq_key = iseq_key_name(filepath)
+
+      if compiled_iseq_exist?(iseq_key) && compiled_iseq_is_younger?(filepath, iseq_key)
+        binary = File.binread(iseq_key)
+        RubyVM::InstructionSequence.load_from_binary(binary)
+      else
+        compile_and_store_iseq(filepath, iseq_key)
+      end
+    end
+
+    def recompile_modified
+      globs.each do |glob|
+        Dir.glob(glob).each do |filepath|
+          iseq_key = iseq_key_name(filepath)
+
+          if !compiled_iseq_exist?(iseq_key) || !compiled_iseq_is_younger?(filepath, iseq_key)
+            compile_and_store_iseq(filepath, iseq_key)
+          end
+        end
+      end
+    end
+
+    def watching?(filepath)
+      globs.any? { |glob| Dir.glob(glob).include?(filepath) }
+    end
+
+    private
+
+    def compile_and_store_iseq(filepath, iseq_key)
+      Rails.logger.debug("[IseqRailsTools] Compiling #{filepath}")
+      iseq = RubyVM::InstructionSequence.compile_file(filepath)
+      binary = iseq.to_binary("SHA-1:#{::Digest::SHA1.file(filepath).digest}")
+      File.binwrite(iseq_key, binary)
+      iseq
+    rescue SyntaxError, RuntimeError => e
+      puts "#{e}: #{filepath}"
+      nil
+    end
+
+    def compiled_iseq_exist?(iseq_key)
+      File.exist?(iseq_key)
+    end
+
+    def compiled_iseq_is_younger?(filepath, iseq_key)
+      File.mtime(iseq_key) >= File.mtime(filepath)
+    end
+
+    def globs
+      @globs ||=
+        application.config.iseq_compile_paths.map do |directory|
+          File.join(directory, '**/*.rb')
+        end
+    end
+  end
+end

data/lib/iseq_rails_tools/railtie.rb

@@ -0,0 +1,35 @@
+module IseqRailsTools
+  class Railtie < ::Rails::Railtie
+    config.iseq_compile_paths = []
+
+    initializer 'iseq_rails_tools.initialize' do |app|
+      IseqRailsTools.compiler = Compiler.new(app)
+
+      # Yeah, sorry about this. This was the easiest way to get all access to
+      # all of the reloadable paths.
+      app.config.iseq_compile_paths = app.send(:_all_autoload_paths)
+
+      files =
+        app.config.iseq_compile_paths.flat_map do |path|
+          Dir.glob(File.join(path, '**/*.rb'))
+        end
+
+      directories =
+        app.config.iseq_compile_paths.map { |path| [path, 'rb'] }.to_h
+
+      reloader =
+        app.config.file_watcher.new(files, directories) do
+          Rails.logger.debug('[IseqRailsTools] Compiling files')
+          IseqRailsTools.compiler.recompile_modified
+        end
+
+      app.reloaders.unshift(reloader)
+      reloader.execute
+    end
+
+    rake_tasks do
+      rake_paths = File.expand_path(File.join('..', 'tasks', '*.rake'), __dir__)
+      Dir[rake_paths].each { |filepath| load filepath }
+    end
+  end
+end

data/lib/iseq_rails_tools/version.rb

@@ -0,0 +1,3 @@
+module IseqRailsTools
+  VERSION = '0.0.1'
+end

data/lib/tasks/iseq_rails_tools_tasks.rake

@@ -0,0 +1,11 @@
+namespace :iseq do
+  desc 'Compile iseq files for all files under autoloaded paths'
+  task all: :environment do
+    IseqRailsTools.compile_all
+  end
+
+  desc 'Clear out all compiled iseq files'
+  task clear: :environment do
+    IseqRailsTools.clear_compiled_iseq_files
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: iseq_rails_tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Deisz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: |2
+      Allows you to take advantage of ruby's AOT bytecode generation
+      within a Rails project.
+email:
+- kevin.deisz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/iseq_rails_tools.rb
+- lib/iseq_rails_tools/compiler.rb
+- lib/iseq_rails_tools/railtie.rb
+- lib/iseq_rails_tools/version.rb
+- lib/tasks/iseq_rails_tools_tasks.rake
+homepage: https://github.com/kddeisz/iseq-rails-tools
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Use AOT compilation within Rails
+test_files: []