nanoc-webpack.rb 0.5.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22ee6ae13d75181d02e95948c6f00446a7f92effe96fcc87c8e017f95c707a3e
-  data.tar.gz: bccc782d822fe1b6f843204a45b6eff75f677979bc7f4c68c853a71351f649ce
+  metadata.gz: 18e7707c0d80e1bb53739670f0a914aadb99117e3888847c7994c02467916401
+  data.tar.gz: 2fab4baa367a41c9e3c12fe076ca1b494504871ac70f775d540d8dc529378969
 SHA512:
-  metadata.gz: 6dc66a6c40e1cadcdd50de9acd480ec69d80364bcd1b61e31345fdf4ab817fa7bb51c31fdd0790971b6915cbcce80c372b600b932cb450fac4caf947aa113579
-  data.tar.gz: 6509714bfa75b8d55b7030736a94f8ea66226bd7a86ceecc958c1749d08abc58618940a4cb1c009924bc76a172dedab0ccb6956facfb9e77145c222c6de73211
+  metadata.gz: 446b7975cad4fc591237fc5189fae9ac46e65a3544047227cf7e2fdf4130df7ff10251a506cf65519ca76a06e832ce66042f4d45bf629ee8237a601d3fe2ef08
+  data.tar.gz: f97f315d4a5d8fcc788fc88d41730ec2e1704b6a36304edb48128f196a12aaf066734fc9e1e9991ebd673dc92d1238b0f8b022364738791cb3605e88da0a3b65

data/.gitignore

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

data/README.md

@@ -2,50 +2,44 @@
 
 nanoc-webpack.rb is a
 [nanoc](https://nanoc.app)
-filter
-that integrates
+filter that integrates
 [webpack](https://webpack.js.org/)
-into nanoc-powered websites. The filter provides a bridge that
-connects nanoc, and the JavaScript, TypeScript, and nodejs ecosystems.
+into nanoc. <br>
+The filter acts as a bridge that connects nanoc,
+and the JavaScript, TypeScript, and nodejs ecosystems.
 
 ## Examples
 
-### Defaults
+**Defaults**
 
-#### /js/main/App.tsx
-
-The following example forwards the entry point `/js/main/App.tsx` to webpack,
-and then writes the result to `/js/app.js`. This example and all the other
-examples assume that the files `webpack.config.js`, `tsconfig.json`, and
-`package.json` already exist at the root of the project:
+The following example forwards the entry point `/js/main/App.tsx`
+to webpack. <br> The result is then written to `/js/main/app.js`:
 
 ``` ruby
 # Rules
 require "nanoc-webpack"
 compile "/js/main/App.tsx" do
   filter(:webpack)
-  write("/js/app.js")
+  write("/js/main/app.js")
 end
 ```
 
-### Options
-
-#### Option: "depend_on"
+**Option: depend_on**
 
-The `depend_on` option tells nanoc what files an entry point imports or requires.
-When a file being tracked by the `depend_on` option undergoes a change, nanoc
-will initiate a recompilation of the entry point:
+When a file or directory tracked by the `depend_on` option
+is observed to have changed, nanoc will initiate a recompilation
+of the entry point:
 
 ```ruby
 # Rules
 require "nanoc-webpack"
 compile "/js/main/App.tsx" do
   filter(:webpack, depend_on: ["/js/lib", "/js/components", "/js/hooks"])
-  write("/js/app.js")
+  write("/js/main/app.js")
 end
 ```
 
-#### Option: "reject"
+**Option: reject**
 
 The `depend_on` option can be combined with the `reject` option to exclude
 certain files or directories from being tracked. For example, maybe you want
@@ -58,63 +52,39 @@ compile "/js/main/App.tsx" do
   filter :webpack,
          depend_on: ["/js/lib", "/js/components", "/js/hooks"],
          reject: proc { |path| path.start_with?("/js/lib/foo/") }
-  write("/js/app.js")
+  write("/js/main/app.js")
 end
 ```
 
-#### Option: "args"
+**Option: argv**
 
-The `args` option can be used to forward command-line options directly
-to the webpack executable.
-<br>
-`$ webpack build --help verbose` provides a list of all available options,
-and
-[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:
+The `argv` option forwards command-line options directly
+to the webpack executable. <br>
+[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, args: {"--no-stats" => true}
-  write("/js/app.js")
+  filter(:webpack, argv: ["--node-env", "production"])
+  write("/js/main/app.js")
 end
 ```
 
-
-## Requirements
-
-nanoc-webpack.rb assumes that:
-
-* A "node" executable is available in $PATH.
-* "webpack" / "webpack-cli" exist as dependencies in package.json.
-
-## Sources
-
-* [Source code (GitHub)](https://github.com/0x1eef/nanoc-webpack.rb)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/nanoc-webpack.rb)
-
 ## <a id='install'>Install</a>
 
-**Git**
-
-nanoc-webpack.rb is distributed as a RubyGem through its git repositories. <br>
-[GitHub](https://github.com/0x1eef/nanoc-webpack.rb),
-and
-[GitLab](https://gitlab.com/0x1eef/nanoc-webpack.rb)
-are available as sources.
-
-```ruby
-# Gemfile
-gem "nanoc-webpack.rb", github: "0x1eef/nanoc-webpack.rb", tag: "v0.5.6"
-```
-
 **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
 
+## Sources
+
+* [GitHub](https://github.com/0x1eef/nanoc-webpack.rb#readme)
+* [GitLab](https://gitlab.com/0x1eef/nanoc-webpack.rb#about)
+
 ## License
 
 [BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).

data/lib/nanoc/webpack/filter.rb

@@ -1,74 +1,67 @@
 # frozen_string_literal: true
 
 ##
-# Compiles a textual nanoc item with webpack.
-class Nanoc::Webpack::Filter < Nanoc::Filter
-  require_relative "filter/dependable"
-  Error = Class.new(RuntimeError)
-  include FileUtils
-  include Dependable
+# Compiles a nanoc item with webpack.
+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 given 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
 
-  def run(content, options = {})
-    args = options[:args] || options["args"] || {}
-    depend_on dependable(paths: options[:depend_on], reject: options[:reject])
-              .map { items[_1] }
-    webpack temporary_file_for(content),
-            args: self.class.default_options.merge(args)
-  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, args: {})
-    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(args)
-    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_for(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.5.6"
+    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/nanoc-webpack.rb.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.summary = "nanoc-webpack.rb integrates webpack into nanoc."
   gem.description = gem.summary
-  gem.add_runtime_dependency "ryo.rb", "~> 0.4"
+  gem.add_runtime_dependency "ryo.rb", "~> 0.5"
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"
   gem.add_development_dependency "rspec", "~> 3.10"

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, args: {"--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.5.6
+  version: 0.8.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-09 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ryo.rb
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -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