webpacker-legacy 0.1.0

data/lib/tasks/webpacker/check_webpack_binstubs.rake

@@ -0,0 +1,11 @@
+namespace :webpacker do
+  desc "Verifies that bin/webpack & bin/webpack-dev-server are present."
+  task :check_webpack_binstubs do
+    unless File.exist?("bin/webpack") && File.exist?("bin/webpack-dev-server")
+      puts "Webpack binstubs not found.\n"\
+           "Make sure the bin directory or binstubs are not included in .gitignore\n"\
+           "Exiting!"
+      exit!
+    end
+  end
+end

data/lib/tasks/webpacker/check_yarn.rake

@@ -0,0 +1,15 @@
+namespace :webpacker do
+  desc "Verifies if yarn is installed"
+  task :check_yarn do
+    required_yarn_version = "0.20.1"
+
+    begin
+      yarn_version = `yarn --version`
+
+      raise Errno::ENOENT if yarn_version.blank? || Gem::Version.new(yarn_version) < Gem::Version.new(required_yarn_version)
+    rescue Errno::ENOENT
+      puts "Webpacker requires Yarn version >= #{required_yarn_version}. Please download and install the latest version from https://yarnpkg.com/lang/en/docs/install/"
+      puts "Exiting!" && exit!
+    end
+  end
+end

data/lib/tasks/webpacker/clobber.rake

@@ -0,0 +1,17 @@
+require "webpacker/configuration"
+
+namespace :webpacker do
+  desc "Remove the webpack compiled output directory"
+  task clobber: ["webpacker:verify_install", :environment] do
+    output_path = Webpacker::Configuration.output_path
+    FileUtils.rm_r(output_path) if File.exist?(output_path)
+    puts "Removed webpack output path directory #{output_path}"
+  end
+end
+
+# Run clobber if the assets:clobber is run
+if Rake::Task.task_defined?("assets:clobber")
+  Rake::Task["assets:clobber"].enhance do
+    Rake::Task["webpacker:clobber"].invoke
+  end
+end

data/lib/tasks/webpacker/compile.rake

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+require "open3"
+require "webpacker/env"
+require "webpacker/configuration"
+
+namespace :webpacker do
+  desc "Compile javascript packs using webpack for production with digests"
+  task compile: ["webpacker:verify_install", :environment] do
+    puts "[Webpacker] Compiling assets 🎉"
+
+    asset_host = ActionController::Base.helpers.compute_asset_host
+    env = { "NODE_ENV" => Webpacker.env, "ASSET_HOST" => asset_host }.freeze
+
+    stdout_str, stderr_str, status = Open3.capture3(env, "./bin/webpack")
+
+    if status.success?
+      $stdout.puts "\e[32m[Webpacker] Compiled digests for all packs in #{Webpacker::Configuration.entry_path}:\e[0m"
+      $stdout.puts "\e[32m#{JSON.parse(File.read(Webpacker::Configuration.manifest_path))}\e[0m"
+    else
+      $stdout.puts "[Webpacker] Compilation Failed"
+      $stdout.puts "\e[31m#{stdout_str}\e[0m"
+      $stderr.puts "\e[31m#{stderr_str}\e[0m"
+      exit!
+    end
+  end
+end
+
+# Compile packs after we've compiled all other assets during precompilation
+if Rake::Task.task_defined?("assets:precompile")
+  Rake::Task["assets:precompile"].enhance do
+    unless Rake::Task.task_defined?("yarn:install")
+      # For Rails < 5.1
+      Rake::Task["webpacker:yarn_install"].invoke
+    end
+    Rake::Task["webpacker:compile"].invoke
+  end
+end

data/lib/tasks/webpacker/install.rake

@@ -0,0 +1,23 @@
+WEBPACKER_APP_TEMPLATE_PATH = File.expand_path("../../install/template.rb", File.dirname(__FILE__))
+
+if Webpacker.rails_less_than_42?
+  namespace :rails do
+    desc 'Redefined by Webpacker'
+    task template: :environment do
+      puts 'Adding environment for legacy apps'
+    end
+  end
+end
+
+namespace :webpacker do
+  desc "Install webpacker in this application"
+  task install: [:check_node, :check_yarn] do
+    if Rails::VERSION::MAJOR >= 5
+      exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{WEBPACKER_APP_TEMPLATE_PATH}"
+    elsif Rails::VERSION::MAJOR >= 4
+      exec "#{RbConfig.ruby} ./bin/rake rails:template LOCATION=#{WEBPACKER_APP_TEMPLATE_PATH}"
+    else
+      exec "rake rails:template LOCATION=#{WEBPACKER_APP_TEMPLATE_PATH}"
+    end
+  end
+end

data/lib/tasks/webpacker/verify_install.rake

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require "webpacker/configuration"
+
+namespace :webpacker do
+  desc "Verifies if webpacker is installed"
+  task verify_install: [:check_node, :check_yarn, :check_webpack_binstubs] do
+    if File.exist?(Webpacker::Configuration.file_path)
+      puts "Webpacker is installed 🎉 🍰"
+      puts "Using #{Webpacker::Configuration.file_path} file for setting up webpack paths"
+    else
+      puts "Configuration config/webpacker.yml file not found. \n"\
+           "Make sure webpacker:install is run successfully before " \
+           "running dependent tasks"
+      exit!
+    end
+  end
+end

data/lib/tasks/webpacker/yarn_install.rake

@@ -0,0 +1,6 @@
+namespace :webpacker do
+  desc "Support for older Rails versions.Install all JavaScript dependencies as specified via Yarn"
+  task :yarn_install, [:arg1, :arg2] do |task, args|
+    system "yarn #{args[:arg1]} #{args[:arg2]}"
+  end
+end

data/lib/webpacker-legacy.rb

@@ -0,0 +1,2 @@
+
+require 'webpacker'

data/lib/webpacker.rb

@@ -0,0 +1,40 @@
+module Webpacker
+  extend self
+
+  def bootstrap
+    Webpacker::Env.load
+    Webpacker::Configuration.load
+    Webpacker::Manifest.load
+  end
+
+  def compile
+    Webpacker::Compiler.compile
+    Webpacker::Manifest.load
+  end
+
+  def env
+    Webpacker::Env.current.inquiry
+  end
+
+  def self.rails32?
+    Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 2
+  end
+
+  def self.rails40?
+    Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR == 0
+  end
+
+  def self.rails41?
+    Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR == 1
+  end
+
+  def self.rails_less_than_42?
+    rails32? || rails40? || rails41?
+  end
+end
+
+require "webpacker/env"
+require "webpacker/configuration"
+require "webpacker/manifest"
+require "webpacker/compiler"
+require "webpacker/railtie" if defined?(Rails)

data/lib/webpacker/compiler.rb

@@ -0,0 +1,20 @@
+require "rake"
+
+module Webpacker::Compiler
+  extend self
+
+  def compile
+    compile_task.invoke
+    compile_task.reenable
+  end
+
+  private
+    def compile_task
+      @compile_task ||= load_rake_task("webpacker:compile")
+    end
+
+    def load_rake_task(name)
+      @load_rakefile ||= Rake.load_rakefile(Rails.root.join("Rakefile"))
+      Rake::Task[name]
+    end
+end

data/lib/webpacker/configuration.rb

@@ -0,0 +1,60 @@
+# Loads webpacker configuration from config/webpacker.yml
+
+require "webpacker/file_loader"
+
+class Webpacker::Configuration < Webpacker::FileLoader
+  class << self
+    def entry_path
+      source_path.join(fetch(:source_entry_path))
+    end
+
+    def output_path
+      public_path.join(fetch(:public_output_path))
+    end
+
+    def manifest_path
+      output_path.join("manifest.json")
+    end
+
+    def source_path
+      Rails.root.join(source)
+    end
+
+    def public_path
+      Rails.root.join("public")
+    end
+
+    def file_path(options = {})
+      root = options[:root] || Rails.root
+      root.join("config/webpacker.yml")
+    end
+
+    def default_file_path
+      file_path(root: Pathname.new(File.dirname(__FILE__)).join("../install"))
+    end
+
+    def source
+      fetch(:source_path)
+    end
+
+    def fetch(key)
+      data.fetch(key, defaults[key])
+    end
+
+    def data
+      load if Webpacker.env.development?
+      raise Webpacker::FileLoader::FileLoaderError.new("Webpacker::Configuration.load must be called first") unless instance
+      instance.data
+    end
+
+    def defaults
+      @defaults ||= HashWithIndifferentAccess.new(YAML.load(default_file_path.read)["default"])
+    end
+  end
+
+  private
+    def load
+      return super unless File.exist?(@path)
+      HashWithIndifferentAccess.new(YAML.load(File.read(@path))[Webpacker.env])
+    end
+end

data/lib/webpacker/env.rb

@@ -0,0 +1,23 @@
+# Singleton registry for determining NODE_ENV from config/webpacker.yml
+require "webpacker/file_loader"
+
+class Webpacker::Env < Webpacker::FileLoader
+  class << self
+    def current
+      raise Webpacker::FileLoader::FileLoaderError.new("Webpacker::Env.load must be called first") unless instance
+      instance.data
+    end
+
+    def file_path
+      Rails.root.join("config", "webpacker.yml")
+    end
+  end
+
+  private
+    def load
+      environments = File.exist?(@path) ? YAML.load(File.read(@path)).keys : [].freeze
+      return ENV["NODE_ENV"] if environments.include?(ENV["NODE_ENV"])
+      return Rails.env if environments.include?(Rails.env)
+      "production"
+    end
+end

data/lib/webpacker/file_loader.rb

@@ -0,0 +1,24 @@
+# Provides a base singleton-configuration pattern for loading a file, given a path
+class Webpacker::FileLoader
+  class NotFoundError < StandardError; end
+  class FileLoaderError < StandardError; end
+
+  class_attribute :instance
+  attr_accessor :data
+
+  class << self
+    def load(path = file_path)
+      self.instance = new(path)
+    end
+  end
+
+  private
+    def initialize(path)
+      @path = path
+      @data = load
+    end
+
+    def load
+      {}.freeze
+    end
+end

data/lib/webpacker/helper.rb

@@ -0,0 +1,62 @@
+module Webpacker::Helper
+  # Computes the full path for a given webpacker asset.
+  # Return relative path using manifest.json and passes it to asset_url helper
+  # This will use asset_path internally, so most of their behaviors will be the same.
+  # Examples:
+  #
+  # In development mode:
+  #   <%= asset_pack_path 'calendar.js' %> # => "/packs/calendar.js"
+  # In production mode:
+  #   <%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
+  def asset_pack_path(name, *options)
+    asset_path(Webpacker::Manifest.lookup(name), *options)
+  end
+  # Creates a script tag that references the named pack file, as compiled by Webpack per the entries list
+  # in config/webpack/shared.js. By default, this list is auto-generated to match everything in
+  # app/javascript/packs/*.js. In production mode, the digested reference is automatically looked up.
+  #
+  # Examples:
+  #
+  #   # In development mode:
+  #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <script src="/packs/calendar.js" data-turbolinks-track="reload"></script>
+  #
+  #   # In production mode:
+  #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
+  def javascript_pack_tag(name, *options)
+    javascript_include_tag(Webpacker::Manifest.lookup("#{name}#{compute_asset_extname(name, type: :javascript)}"), *options)
+  end
+
+  # Creates a link tag that references the named pack file, as compiled by Webpack per the entries list
+  # in config/webpack/shared.js. By default, this list is auto-generated to match everything in
+  # app/javascript/packs/*.js. In production mode, the digested reference is automatically looked up.
+  #
+  # Examples:
+  #
+  #   # In development mode:
+  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/packs/calendar.css" data-turbolinks-track="reload" />
+  #
+  #   # In production mode:
+  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/packs/calendar-1016838bab065ae1e122.css" data-turbolinks-track="reload" />
+  def stylesheet_pack_tag(name, *options)
+    stylesheet_link_tag(Webpacker::Manifest.lookup("#{name}#{compute_asset_extname(name, type: :stylesheet)}"), *options)
+  end
+
+  def compute_asset_extname(source, options = {})
+    return if options[:extname] == false
+    extname = options[:extname] || ASSET_EXTENSIONS[options[:type]]
+    if extname && File.extname(source) != extname
+      extname
+    else
+      nil
+    end
+  end
+
+  ASSET_EXTENSIONS = {
+        javascript: ".js",
+        stylesheet: ".css"
+  }
+end

data/lib/webpacker/manifest.rb

@@ -0,0 +1,51 @@
+# Singleton registry for accessing the packs path using generated manifest.
+# This allows javascript_pack_tag, stylesheet_pack_tag, asset_pack_path to take a reference to,
+# say, "calendar.js" or "calendar.css" and turn it into "/packs/calendar.js" or
+# "/packs/calendar.css" in development. In production mode, it returns compiles
+# files, # "/packs/calendar-1016838bab065ae1e314.js" and
+# "/packs/calendar-1016838bab065ae1e314.css" for long-term caching
+
+require "webpacker/file_loader"
+
+class Webpacker::Manifest < Webpacker::FileLoader
+  class << self
+    def file_path
+      Webpacker::Configuration.manifest_path
+    end
+
+    def lookup(name)
+      load if Webpacker.env.development?
+
+      if Webpacker.env.test?
+        find(name) || compile_and_find!(name)
+      else
+        find!(name)
+      end
+    end
+
+    def lookup_path(name)
+      Rails.root.join(File.join(Webpacker::Configuration.public_path, lookup(name)))
+    end
+
+    private
+      def find(name)
+        instance.data[name.to_s] if instance
+      end
+
+      def find!(name)
+        raise Webpacker::FileLoader::FileLoaderError.new("Webpacker::Manifest.load must be called first") unless instance
+        instance.data[name.to_s] || raise(Webpacker::FileLoader::NotFoundError.new("Can't find #{name} in #{file_path}. Is webpack still compiling?"))
+      end
+
+      def compile_and_find!(name)
+        Webpacker.compile
+        find!(name)
+      end
+  end
+
+  private
+    def load
+      return super unless File.exist?(@path)
+      JSON.parse(File.read(@path))
+    end
+end

data/lib/webpacker/railtie.rb

@@ -0,0 +1,18 @@
+require "rails/railtie"
+
+require "webpacker/helper"
+
+class Webpacker::Engine < ::Rails::Engine
+  initializer :webpacker do |app|
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.helper Webpacker::Helper
+    end
+
+    ActiveSupport.on_load :action_view do
+      include Webpacker::Helper
+    end
+
+    Webpacker.bootstrap
+    Spring.after_fork { Webpacker.bootstrap } if defined?(Spring)
+  end
+end