thermite-rails 0.2.0

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150).match?(/This file was generated by Bundler/)
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/thermite/rails.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'rails/version'
+require_relative 'rails/railtie'
+
+module Thermite
+  module Rails
+    # @param root_path [String]
+    # @return [String] Path to the root of the (Rails) project.
+    def self.find_root(root_path)
+      root = File.expand_path(root_path)
+
+      dir = root
+
+      loop do
+        return dir if yield(dir)
+
+        new_dir = File.dirname(dir)
+        raise "Unable to find root for #{root}" if new_dir == dir
+
+        dir = new_dir
+      end
+    end
+
+    # @return [Thermite::Rails::RootProject]
+    def self.root_project
+      require_relative 'rails/root_project'
+      @root_project ||= Thermite::Rails::RootProject.new(::Rails.root.to_s)
+    end
+  end
+end

data/lib/thermite/rails/cargo_runner.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'thermite/cargo'
+
+module Thermite
+  module Rails
+    # Just a wrapper object for thermite's {{Thermite::Cargo}} module.
+    class CargoRunner
+      include Thermite::Cargo
+      include FileUtils
+
+      attr_reader :config
+
+      # @param config [Thermite::Config]
+      def initialize(config)
+        @config = config
+      end
+    end
+  end
+end

data/lib/thermite/rails/check_outdated.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Thermite
+  module Rails
+    # Rack middleware for ensuring projects have been built.
+    class CheckOutdated
+      def initialize(app, project)
+        @app = app
+        @project = project
+        @last_check = 0
+      end
+
+      def call(env)
+        @project.ensure_built!
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/thermite/rails/generators/crate_generator.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'thermite/cargo'
+require 'thermite/config'
+require_relative '../project'
+
+module Thermite
+  module Rails
+    class CrateGenerator < ::Rails::Generators::Base
+      class CargoRunner
+        include Singleton
+        include Thermite::Cargo
+      end
+
+      namespace 'thermite:crate'
+      desc 'add new thermite crate'
+      argument :name, type: :string
+
+      def start
+        say "Creating crate '#{name}'..."
+      end
+
+      def crates_full_path
+        @crates_full_path ||= ::Rails.root.join('crates').to_s
+      end
+
+      def project_full_path
+        @project_full_path ||= File.join(crates_full_path, name)
+      end
+
+      def project
+        @project ||= Thermite::Rails::Project.new(project_full_path)
+      end
+
+      def ext_full_path
+        @ext_full_path ||= File.join(project_full_path, 'ext')
+      end
+
+      def make_crates_dir
+        empty_directory(crates_full_path)
+      end
+
+      def run_crate_new_and_bundle_gem
+        inside(crates_full_path, verbose: true) do
+          run "#{CargoRunner.instance.cargo} new #{name}"
+          run "bundle gem #{name}"
+        end
+      end
+
+      def update_cargo_toml
+        gsub_file(project.cargo_toml_path, "\n[dependencies]") do
+          %(publish = false\n\n[lib]\ncrate-type = ["cdylib"]\n\n[dependencies])
+        end
+      end
+
+      def add_thermite_to_gemspec
+        insert_into_file(project.gemspec_path, after: %(  spec.require_paths = ["lib"])) do
+          lines = %(\n  spec.extensions << 'ext/Rakefile'\n\n)
+          lines + %(  spec.add_runtime_dependency 'thermite', '~> 0')
+        end
+      end
+
+      def add_ext_directory
+        empty_directory(ext_full_path)
+      end
+
+      def add_crate_ext_rakefile
+        rakefile_path = File.join(ext_full_path, 'Rakefile')
+
+        create_file(rakefile_path) do
+          <<~THERM
+            require 'thermite/tasks'
+
+            project_dir = File.dirname(File.dirname(__FILE__))
+            Thermite::Tasks.new(cargo_project_path: project_dir, ruby_project_path: project_dir)
+            task default: %w(thermite:build)
+          THERM
+        end
+      end
+
+      def update_crate_rakefile
+        append_to_file(project.rakefile_path) do
+          %(\nrequire 'thermite/tasks'\n\nThermite::Tasks.new)
+        end
+      end
+
+      def fix_rubocops
+        run "bundle exec rubocop -a #{project_full_path}" if File.read('Gemfile').include?('rubocop')
+      end
+
+      def update_rails_gemfile
+        gem name, path: "crates/#{name}"
+      end
+
+      def bundle_install
+        run 'bundle'
+      end
+    end
+  end
+end

data/lib/thermite/rails/generators/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Thermite
+  module Rails
+    class InstallGenerator < ::Rails::Generators::Base
+      namespace 'thermite:install'
+      desc 'install thermite'
+
+      def configure_environment
+        environment 'config.thermite.outdated_error = :page_load', env: :development
+      end
+    end
+  end
+end

data/lib/thermite/rails/project.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'tomlrb'
+require 'thermite/config'
+
+module Thermite
+  module Rails
+    # A "project" is a crate that contains both Rust and Ruby code. Usually one
+    # of these will live at [rails root]/crates/[project].
+    class Project
+      class OutdatedBuildError < StandardError
+        # @param name [String] The crate name.
+        def initialize(name)
+          msg = "\n\nThermite crate '#{name}' is outdated. To resolve this issue, " \
+            "run `rake thermite:build:#{name}` and restart your server.\n\n"
+
+          super(msg)
+        end
+      end
+
+      attr_reader :project_path, :config
+
+      # @param project_path [String]
+      def initialize(project_path)
+        @project_path = find_project(project_path)
+        @config = Thermite::Config.new(ruby_project_path: @project_path, cargo_project_path: @project_path)
+      end
+
+      # @return [String] Path to the project's Cargo.toml file.
+      def cargo_toml_path
+        File.join(@project_path, 'Cargo.toml')
+      end
+
+      # @return [String] Path to the project's Cargo.toml file.
+      def gemspec_path
+        File.join(@project_path, "#{crate_name}.gemspec")
+      end
+
+      def rakefile_path
+        File.join(@project_path, 'Rakefile')
+      end
+
+      # @return [String] Path to `[project root]/spec/`.
+      def spec_path
+        File.join(@project_path, 'spec')
+      end
+
+      # @return [String] "package.name" from the crate's Cargo.toml file.
+      def crate_name
+        @crate_name ||= Tomlrb.load_file(cargo_toml_path)['package']['name']
+      end
+
+      # @return [Boolean] Does this project have `[project root]/spec/`?
+      def specs?
+        File.exist?(spec_path)
+      end
+
+      # @return [Boolean] Does this project use thermite?
+      def thermite?
+        return false unless File.exist?(gemspec_path)
+
+        File.read(gemspec_path).include? 'thermite'
+      end
+
+      # @return [Boolean] Has the crate been updated since it was last built?
+      def outdated_build?
+        mtime = Dir["#{@project_path}/src/**/*.rs"].map { |file| File.mtime(file) }.max
+        native = "#{@project_path}/lib/#{@config.shared_library}"
+
+        !File.exist?(native) || File.mtime(native) < mtime
+      end
+
+      # Raise if the project is outdated.
+      def ensure_built!
+        raise OutdatedBuildError, crate_name if outdated_build?
+      end
+
+      private
+
+      # @param project_path [String]
+      def find_project(project_path)
+        Thermite::Rails.find_root(project_path) do |dir|
+          File.exist?("#{dir}/Cargo.toml")
+        end
+      end
+    end
+  end
+end

data/lib/thermite/rails/railtie.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require_relative 'check_outdated'
+require_relative 'root_project'
+
+module Thermite
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.thermite = ActiveSupport::OrderedOptions.new
+
+      rake_tasks do
+        load File.expand_path(File.join('tasks', 'thermite.rake'), __dir__)
+        load File.expand_path(File.join('tasks', 'rspec.rake'), __dir__) if defined?(::RSpec)
+      end
+
+      generators do
+        require_relative 'generators/crate_generator'
+        require_relative 'generators/install_generator'
+      end
+
+      initializer 'thermite.build_check' do |app|
+        project = Thermite::Rails::RootProject.new(app.root)
+
+        # This will be added by the install generator, but people may forget to run it
+        if ::Rails.env.development? && !config.thermite.key?(:outdated_error)
+          config.thermite.outdated_error = :page_load
+        end
+
+        if config.thermite.delete(:outdated_error) == :page_load
+          config.app_middleware.insert_after ::ActionDispatch::Callbacks,
+            Thermite::Rails::CheckOutdated, project
+        end
+      end
+    end
+  end
+end

data/lib/thermite/rails/root_project.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'project'
+
+module Thermite
+  module Rails
+    # A root project is really just the Rails project, which can have a number of
+    # nested "projects" under crates/[project name].
+    class RootProject
+      attr_reader :path
+
+      # @param path [String]
+      def initialize(path)
+        @path = find_root(path)
+      end
+
+      # @return [Array<Thermite::Rails::Project>]
+      def projects
+        @projects ||= Dir["#{@path}/crates/*"].
+                      find_all { |f| File.exist?("#{f}/Cargo.toml") }.
+                      find_all { |f| File.exist?("#{f}/Cargo.toml") }.
+                      map { |d| Thermite::Rails::Project.new(d) }.
+                      find_all(&:thermite?)
+      end
+
+      # @return [Array<Thermite::Rails::Project>]
+      def projects_with_specs
+        projects.find_all(&:specs?)
+      end
+
+      def ensure_built!
+        projects.each(&:ensure_built!)
+      end
+
+      private
+
+      # @param path [String]
+      # @return [String]
+      def find_root(path)
+        Thermite::Rails.find_root(path) do |dir|
+          !Dir["#{dir}/{Gemfile,*.gemspec}"].empty?
+        end
+      end
+    end
+  end
+end

data/lib/thermite/rails/tasks/project_rake_task.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'rake/tasklib'
+require 'thor/shell/color'
+
+module Thermite
+  module Rails
+    module Tasks
+      # Base class to be used for creating Rake tasks for individual Projects.
+      class ProjectRakeTask < ::Rake::TaskLib
+        delegate :crate_name, :project_path, to: :@project
+
+        # @param project [Thermite::Rails::Project]
+        def initialize(project)
+          @project = project
+          @shell = Thor::Shell::Color.new
+        end
+
+        # @param [String]
+        def crate_name_for_ruby
+          crate_name.underscore
+        end
+
+        # @param [String]
+        def task_name
+          raise 'Define in child'
+        end
+
+        # In your child class, this method should `define` the Rake task.
+        def define_rake_task
+          return if Rake::Task.task_defined?(task_name)
+
+          raise 'Define in child'
+        end
+
+        # @return [Boolean] Has a task with this name already been defined?
+        def defined?
+          Rake::Task.task_defined?(task_name)
+        end
+
+        # @param message [String]
+        # @param color Whatever is supported by highline.
+        def color_puts(message, color = :blue)
+          @shell.say "[#{crate_name}] #{message}", color
+        end
+
+        private
+
+        # @param task_name [String]
+        def run_task(task_name)
+          color_puts("Running task: #{task_name}", :blue)
+
+          load_and do
+            Rake::Task[task_name].invoke
+          end
+        rescue RuntimeError => ex
+          if ex.message.match?("Don't know how to build task '#{task_name}'")
+            color_puts("#{ex.message}; skipping", :yellow)
+          else
+            abort ex.message
+          end
+        end
+
+        def load_and
+          Dir.chdir(project_path) do
+            load_rakefile do
+              yield
+            end
+          end
+        end
+
+        def load_rakefile
+          load 'Rakefile'
+          yield
+        rescue LoadError => ex
+          color_puts("Skipping due to LoadError: #{ex.message}", :red)
+        end
+      end
+    end
+  end
+end