nanoc-webpack.rb 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6089712cbc312cd503ad06f0a1d54e27351901f86b870460f1c6d3c205566d4c
-  data.tar.gz: 8c932b943c81803365dcd2e9a7c46b5cfec2790fb05964c73b60e557fcf1461a
+  metadata.gz: 18e7707c0d80e1bb53739670f0a914aadb99117e3888847c7994c02467916401
+  data.tar.gz: 2fab4baa367a41c9e3c12fe076ca1b494504871ac70f775d540d8dc529378969
 SHA512:
-  metadata.gz: 9b9f6f1cc40ada346daac98c1b401dc613c327e41c5bf48b1bf4c6ecad8b50c267b3a46164336e677dd8c28415f2c7262b28cab9ff4ea897c7f6a96491cc3c2a
-  data.tar.gz: 62595779fdff296640fa1ddd0030ab3d97e580378f0129c5a5d9260fe13b92e9a08a006316c8ad5de420133557d7f9542a776f7d2c909c2e37642d1c788a8996
+  metadata.gz: 446b7975cad4fc591237fc5189fae9ac46e65a3544047227cf7e2fdf4130df7ff10251a506cf65519ca76a06e832ce66042f4d45bf629ee8237a601d3fe2ef08
+  data.tar.gz: f97f315d4a5d8fcc788fc88d41730ec2e1704b6a36304edb48128f196a12aaf066734fc9e1e9991ebd673dc92d1238b0f8b022364738791cb3605e88da0a3b65

data/.gitignore

@@ -2,4 +2,5 @@
 .gems/
 /spec/fakefs/
 /pkg/
+/tmp/
 Gemfile.lock

data/README.md

@@ -5,7 +5,7 @@ nanoc-webpack.rb is a
 filter that integrates
 [webpack](https://webpack.js.org/)
 into nanoc. <br>
-The filter acts as a  bridge that connects nanoc,
+The filter acts as a bridge that connects nanoc,
 and the JavaScript, TypeScript, and nodejs ecosystems.
 
 ## Examples
@@ -56,19 +56,18 @@ compile "/js/main/App.tsx" do
 end
 ```
 
-**Option: cli**
+**Option: argv**
 
-The `cli` option forwards command-line options directly
+The `argv` option forwards command-line options directly
 to the webpack executable. <br>
-[Nanoc::Webpack.default_options](https://0x1eef.github.io/x/nanoc-webpack.rb/Nanoc/Webpack.html#default_options-class_method)
-returns the default options nanoc-webpack.rb will
-forward to webpack:
+[Nanoc::Webpack.default_argv](https://0x1eef.github.io/x/nanoc-webpack.rb/Nanoc/Webpack.html#default_argv-class_method)
+returns the default command-line options forwarded to webpack:
 
 ```ruby
 # Rules
 require "nanoc-webpack"
 compile "/js/main/App.tsx" do
-  filter(:webpack, cli: {"--no-stats" => true})
+  filter(:webpack, argv: ["--node-env", "production"])
   write("/js/main/app.js")
 end
 ```
@@ -77,7 +76,7 @@ end
 
 **Rubygems.org**
 
-nanoc-webpack.rb can also be installed via rubygems.org.
+nanoc-webpack.rb can be installed via rubygems.org.
 
     gem install nanoc-webpack.rb
 

data/lib/nanoc/webpack/filter.rb

@@ -2,81 +2,66 @@
 
 ##
 # Compiles a nanoc item with webpack.
-class Nanoc::Webpack::Filter < Nanoc::Filter
-  require_relative "filter/dependable"
-  include FileUtils
-  include Dependable
-  Error = Class.new(RuntimeError)
+module Nanoc::Webpack
+  class Filter < Nanoc::Filter
+    require_relative "filter/dependable"
+    require_relative "spawn"
+    include Dependable
+    include Spawn
+    include FileUtils
 
-  identifier :webpack
-  type :text
+    identifier :webpack
+    type :text
 
-  ##
-  # @example
-  #   Nanoc::Webpack.default_options.merge!(
-  #     "--cache-type" => "memory"
-  #   )
-  #
-  # @return [Hash]
-  #  Returns the default command-line options forwarded to webpack.
-  def self.default_options
-    @default_options ||= {"--cache-type" => "filesystem"}
-  end
+    ##
+    # @example
+    #   Nanoc::Webpack.default_argv.replace ["--cache-type", "memory"]
+    #
+    # @return [Hash]
+    #  The default command-line options forwarded to webpack.
+    def self.default_argv
+      @default_argv ||= ["--cache-type", "filesystem"]
+    end
 
-  ##
-  # @param [String] content
-  #  The contents of a file.
-  #
-  # @param [Hash] options
-  #  A hash of options.
-  #
-  # @return [void]
-  def run(content, options = {})
-    options = Ryo.from(options)
-    depend_on dependable(paths: options.depend_on, reject: options.reject)
-              .map { items[_1] }
-    webpack temporary_file(content),
-            cli: self.class.default_options.merge(options.cli || {})
-  end
+    ##
+    # @param [String] content
+    #  The contents of a file.
+    #
+    # @param [Hash] options
+    #  A hash of options.
+    #
+    # @return [void]
+    def run(content, options = {})
+      options = Ryo.from(options)
+      path    = temporary_file(content).path
+      depend_on dependable(paths: options.depend_on, reject: options.reject)
+                  .map { items[_1] }
+      spawn "node",
+            ["./node_modules/webpack/bin/webpack.js",
+             "--entry", File.join(Dir.getwd, item.attributes[:content_filename]),
+             "--output-path", File.dirname(path),
+             "--output-filename", File.basename(path),
+             *default_argv, *(options.argv || [])],
+            log: File.join(tmpdir, "webpack.log")
+    ensure
+      rm(path)
+    end
 
-  private
+    private
 
-  def webpack(file, cli:)
-    sh "node",
-       "./node_modules/webpack/bin/webpack.js",
-       "--entry", File.join(Dir.getwd, item.attributes[:content_filename]),
-       "--output-path", File.dirname(file.path),
-       "--output-filename", File.basename(file.path),
-       *webpack_args(cli)
-    if $?.success?
-      File.read(file.path).tap { file.tap(&:unlink).close }
-    else
-      rm_f Dir.glob(File.join(File.dirname(file.path), "*"))
-      file.close
-      raise Error, "webpack.js exited unsuccessfully (exit code: #{$?.exitstatus})", []
+    def default_argv
+      self.class.default_argv
     end
-  end
 
-  def webpack_args(args)
-    args.each_with_object([]) do |(key, value), ary|
-      if value.equal?(true)
-        ary << key
-      else
-        ary.concat [key, value.to_s]
-      end
+    def temporary_file(content)
+      mkdir_p(tmpdir)
+      file = Tempfile.new(File.basename(item.identifier.to_s), tmpdir)
+      file.write(content)
+      file.tap(&:flush)
     end
-  end
-
-  def temporary_file(content)
-    dir = File.join(Dir.getwd, "tmp", "nanoc-webpack.rb")
-    mkdir_p(dir) unless Dir.exist?(dir)
-    file = Tempfile.new(File.basename(@item.identifier.to_s), dir)
-    file.write(content)
-    file.tap(&:flush)
-  end
 
-  def sh(*args)
-    print "webpack: ", args.join(" "), "\n"
-    system(*args)
+    def tmpdir
+      File.join(Dir.getwd, "tmp", "webpack")
+    end
   end
 end

data/lib/nanoc/webpack/spawn.rb

@@ -0,0 +1,19 @@
+module Nanoc::Webpack
+  module Spawn
+    Error = Class.new(RuntimeError)
+    def spawn(exe, argv, log:)
+      Kernel.spawn(
+        exe, *argv, { STDOUT => log, STDERR => log }
+      )
+      Process.wait
+      unless $?.success?
+        raise Error,
+              "#{File.basename(exe)} exited unsuccessfully " \
+              "(exit code: #{$?.exitstatus}, " \
+              "item: #{item.identifier}, " \
+              "log: #{log.gsub(Dir.getwd, '')[1..]})",
+              []
+      end
+    end
+  end
+end

data/lib/nanoc/webpack/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Webpack
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

data/lib/nanoc/webpack.rb

@@ -5,9 +5,9 @@ module Nanoc::Webpack
   require "ryo"
   require_relative "webpack/filter"
   ##
-  # @example (see Nanoc::Webpack::Filter.default_options)
-  # @return (see Nanoc::Webpack::Filter.default_options)
-  def self.default_options
-    Nanoc::Webpack::Filter.default_options
+  # @example (see Nanoc::Webpack::Filter.default_argv)
+  # @return (see Nanoc::Webpack::Filter.default_argv)
+  def self.default_argv
+    Nanoc::Webpack::Filter.default_argv
   end
 end

data/spec/filter_spec.rb

@@ -136,7 +136,8 @@ RSpec.describe Nanoc::Webpack::Filter do
 
     context "with default arguments" do
       it "executes nodejs" do
-        expect(filter).to receive(:system).with(*cmdline)
+        expect(Kernel).to receive(:spawn).with(*cmdline, instance_of(Hash))
+        expect(Process).to receive(:wait)
         filter.run(item)
       end
     end
@@ -145,8 +146,9 @@ RSpec.describe Nanoc::Webpack::Filter do
       let(:cmdline) { super().concat(["--no-cache"]) }
 
       it "executes nodejs with an argument" do
-        expect(filter).to receive(:system).with(*cmdline)
-        filter.run(item, cli: {"--no-cache" => true})
+        expect(Kernel).to receive(:spawn).with(*cmdline, instance_of(Hash))
+        expect(Process).to receive(:wait)
+        filter.run(item, argv: ["--no-cache"])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-webpack.rb
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ryo.rb
@@ -114,6 +114,7 @@ files:
 - lib/nanoc/webpack.rb
 - lib/nanoc/webpack/filter.rb
 - lib/nanoc/webpack/filter/dependable.rb
+- lib/nanoc/webpack/spawn.rb
 - lib/nanoc/webpack/version.rb
 - nanoc-webpack.rb.gemspec
 - spec/filter_spec.rb