iseq_rails_tools 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41adbda1e1b89000183500297f553297069a38bf
-  data.tar.gz: 2037d45bda86a9e59d2a01375342bd2f13c32643
+  metadata.gz: 4a802839bd0e4261a2dd82d40a707494ba223eef
+  data.tar.gz: 923dc5b3171c51ed69f92585fe532649c0bbd4df
 SHA512:
-  metadata.gz: cecb536938e03c599314815ccce2a02237d2ee7c236ddd65eaea3be223a398e0f56378179664bdaea81c604c1c412b1c65d8c1933de8e781a7d413023926481d
-  data.tar.gz: 4e89dc8c64eca43d8306d15b40b1acec176e7c132c726b925baa05fd9c1f183ebbac928af2f720a7dd43724003fddedd4cef20a629a40d451f75a7f97ccdb7f8
+  metadata.gz: 50a3674a4d4fde446ff856eba2a06326c380718194946a6a38c22d3ba7ea55ae7054d878a78b29b2ad75b74fca47a85d1458c51dc128fabe3aa18cecabb3d696
+  data.tar.gz: abe87ccfbfd509e806b90b33ead97e5e002ced034633631a693dd47d0be6334f711ab61c089ea613794a68300831107d7099cc97746492f92c3bf96f7b5c5807

data/README.md

@@ -5,8 +5,6 @@
 
 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. A simple way to do this is to make `iseq:all` a prerequisite of `assets:precompile`, like so: `Rake::Task['assets:precompile'].enhance(['iseq:all'])`.
 
 ## Usage

data/lib/iseq_rails_tools/railtie.rb

@@ -1,32 +1,5 @@
 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 }

data/lib/iseq_rails_tools/source_file.rb

@@ -0,0 +1,51 @@
+require 'digest/sha1'
+
+module IseqRailsTools
+  class SourceFile
+    attr_reader :source_path, :iseq_path
+
+    def initialize(source_path, iseq_path)
+      @source_path = source_path
+      @iseq_path   = iseq_path
+    end
+
+    def dump
+      # Lonely operator necessary here because Rails.logger might not be
+      # initialized yet
+      Rails.logger&.debug("[IseqRailsTools] Compiling #{source_path}")
+
+      iseq   = RubyVM::InstructionSequence.compile_file(source_path)
+      digest = ::Digest::SHA1.file(source_path).digest
+      File.binwrite(iseq_path, iseq.to_binary("SHA-1:#{digest}"))
+      iseq
+    rescue SyntaxError, RuntimeError
+      Rails.logger.debug("[IseqRailsTools] Failed to compile #{source_path}")
+      nil
+    end
+
+    def load
+      if compiled? && !needs_recompile?
+        binary = File.binread(iseq_path)
+        RubyVM::InstructionSequence.load_from_binary(binary)
+      else
+        dump
+      end
+    end
+
+    def self.load(source_path)
+      iseq_path = source_path.gsub(/[^A-Za-z0-9\._-]/) { |c| '%02x' % c.ord }
+      iseq_path = File.join(IseqRailsTools.iseq_dir, "#{iseq_path}.yarb")
+      new(source_path, iseq_path).load
+    end
+
+    private
+
+    def compiled?
+      File.exist?(iseq_path)
+    end
+
+    def needs_recompile?
+      File.mtime(source_path) > File.mtime(iseq_path)
+    end
+  end
+end

data/lib/iseq_rails_tools/version.rb

@@ -1,3 +1,3 @@
 module IseqRailsTools
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/iseq_rails_tools.rb

@@ -1,45 +1,37 @@
-require 'digest/sha1'
-require 'fileutils'
-require 'iseq_rails_tools/compiler'
-
-module IseqRailsTools
-  class NullCompiler
-    def clear_compiled_iseq_files
-    end
-
-    def watching?(filepath)
-      false
-    end
-  end
+# Only actually hook into Rails when the environment isn't test so that tools
+# like simplecov will continue to function as expected. Also people do weird
+# stuff in test mode, so who knows.
+if !Rails.env.test? || IseqRailsTools.respond_to?(:internal?)
+  require 'iseq_rails_tools/railtie'
+  require 'iseq_rails_tools/source_file'
 
-  class << self
-    attr_accessor :compiler
+  module IseqRailsTools
+    DIRECTORY_NAME = '.iseq'
 
-    def clear_compiled_iseq_files
-      compiler.clear_compiled_iseq_files
-    end
+    class << self
+      attr_accessor :iseq_dir
 
-    def compile_all
-      compiler.compile_all
+      def clear
+        Dir.glob(File.join(iseq_dir, '**/*.yarb')) { |path| File.delete(path) }
+      end
     end
-  end
 
-  self.compiler = NullCompiler.new
-end
+    root =
+      caller_locations.detect do |location|
+        path = location.absolute_path || location.path
+        if path != __FILE__ && path !~ %r{bundler[\w.-]*/lib/bundler}
+          break File.dirname(path)
+        end
+      end
+    root = File.dirname(root) until File.exist?("#{root}/config.ru")
 
-# Only actually hook into Rails when the environment isn't test so that tools
-# like simplecov will continue to function as expected. Also people do weird
-# stuff in test mode, so who knows.
-unless Rails.env.test?
-  require 'iseq_rails_tools/railtie'
+    self.iseq_dir = File.join(root, DIRECTORY_NAME)
+    FileUtils.mkdir_p(iseq_dir) unless File.directory?(iseq_dir)
+  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
+      ::IseqRailsTools::SourceFile.load(filepath)
     end
   end)
 end

data/lib/tasks/iseq_rails_tools_tasks.rake

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iseq_rails_tools
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,8 +37,8 @@ files:
 - README.md
 - Rakefile
 - lib/iseq_rails_tools.rb
-- lib/iseq_rails_tools/compiler.rb
 - lib/iseq_rails_tools/railtie.rb
+- lib/iseq_rails_tools/source_file.rb
 - lib/iseq_rails_tools/version.rb
 - lib/tasks/iseq_rails_tools_tasks.rake
 homepage: https://github.com/kddeisz/iseq-rails-tools

data/lib/iseq_rails_tools/compiler.rb

@@ -1,87 +0,0 @@
-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