nanoc-webpack.rb 0.4.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b5fa317d727a05360e4e08e5d0e343862686385597adfde1780614f634006bb
+  data.tar.gz: 5824d38fcfc4327524856c94a80c81cb1f0d9fc636f3d540d06e2f32fbffa805
+SHA512:
+  metadata.gz: 1cbd5df5b9e003e2cd5bb96213aa0852fa306f2ec91dab060d61a3930253a62591919fb15917a811c06afe6b322a3a7316dcf1b8a7e8c82827dcf361f8774b39
+  data.tar.gz: 2a5a8f3854cb9164b8b20d02e9920f20cb5143f57457a67db387f8225ce1382d6f100547c1e42e486f070985f302437e8a6d3fcdb4231cefd200d37a83a5cf43

data/.github/workflows/specs.yml

@@ -0,0 +1,23 @@
+name: nanoc-webpack.rb
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  specs:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [3.1, 3.2]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle install
+    - run: bundle exec rspec spec/

data/.gitignore

@@ -0,0 +1,4 @@
+.yardoc/
+/spec/fakefs/
+/pkg/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,53 @@
+##
+# Plugins
+require:
+  - standard
+  - rubocop-rspec
+
+##
+# Defaults: standard-rb
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 3.2
+  Include:
+    - 'lib/*.rb'
+    - 'lib/**/*.rb'
+    - 'spec/*.rb'
+
+##
+# Enabled
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Layout/ArrayAlignment:
+  Enabled: false
+
+##
+# Disabled
+RSpec/FilePath:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/NotToNot:
+  Enabled: false
+RSpec/EmptyLineAfterHook:
+  Enabled: false
+RSpec/EmptyLineAfterSubject:
+  Enabled: false
+RSpec/DescribedClass:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/EmptyLineAfterFinalLet:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/ImplicitSubject:
+  Enabled: false
+Style/LambdaCall:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Layout/ArgumentAlignment:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,4 @@
+-m markdown -M redcarpet --no-private
+-
+README.md
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+gem "nanoc"
+gem "ryo.rb", github: "0x1eef/ryo.rb", tag: "v0.3.0"

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright (C) 2023 by 0x1eef <0x1eef@protonmail.com>
+
+Permission to use, copy, modify, and/or distribute this
+software for any purpose with or without fee is hereby
+granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS
+ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
+RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+## About
+
+nanoc-webpack.rb is a
+[nanoc](https://nanoc.app)
+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.
+
+## Examples
+
+__app.ts__
+
+The following example forwards the entry point `app.ts` to webpack, and
+then writes the result of the webpack compilation to `app.js`:
+
+``` ruby
+# Rules
+require "nanoc-webpack"
+compile "/js/app.ts" do
+  filter(:webpack)
+  write("/js/app.js")
+end
+```
+
+__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:
+
+```ruby
+# Rules
+require "nanoc-webpack"
+compile "/js/ReactApp.jsx" do
+  filter(:webpack, depend_on: ["/js/lib", "/js/components", "/js/hooks"])
+  write("/js/app.js")
+end
+```
+
+__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
+to track `/js/lib/` but not `/js/lib/foo/`:
+
+```ruby
+# Rules
+require "nanoc-webpack"
+compile "/js/ReactApp.jsx" do
+  filter :webpack,
+         depend_on: ["/js/lib", "/js/components", "/js/hooks"],
+         reject: proc { |path| path.start_with?("/js/lib/foo/") }
+  write("/js/app.js")
+end
+```
+
+## Requirements
+
+nanoc-webpack.rb assumes that:
+
+* A "node" executable is available in $PATH.
+* [npm](https://www.npmjs.com) or [yarn](https://yarnpkg.com/) are used for
+  package management.
+* "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>
+
+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.
+
+## License
+
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+<br>
+See [LICENSE](./LICENSE).

data/lib/nanoc/webpack/filter/dependable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Nanoc::Webpack::Filter
+  module Dependable
+    def dependable(paths:, reject: nil)
+      reject ||= proc {}
+      [*paths].flat_map do |path|
+        expand(path).flat_map do
+          node = File.join(root, _1)
+          File.directory?(node) ? dependable(paths: File.join(_1, "*"), reject:) : _1
+        end
+      end.compact
+         .reject(&reject)
+    end
+
+    def expand(path)
+      abs_path = File.join(Dir.getwd, root)
+      glob_str = File.expand_path(File.join(abs_path, path))
+      Dir.glob(glob_str).map { File.join("/", _1.sub(abs_path, "")) }
+    end
+
+    def root
+      @root ||= begin
+        nanoc = Ryo.from(config.each.to_h)
+        source = nanoc.data_sources.find(&:content_dir)
+        source&.content_dir || "content/"
+      end
+    end
+  end
+end

data/lib/nanoc/webpack/filter.rb

@@ -0,0 +1,44 @@
+# 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
+
+  identifier :webpack
+  type :text
+
+  def run(content, options = {})
+    depend_on dependable(paths: options[:depend_on], reject: options[:reject])
+              .map { items[_1] }
+    webpack(temp_file(content))
+  end
+
+  private
+
+  def webpack(file)
+    system "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)
+    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})", []
+    end
+  end
+
+  def temp_file(content)
+    dir = File.join(Dir.getwd, "tmp", "webpack")
+    mkdir_p(dir) unless Dir.exist?(dir)
+    file = Tempfile.new(File.basename(item.identifier.to_s), dir)
+    file.write(content)
+    file.tap(&:flush)
+  end
+end

data/lib/nanoc/webpack/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Webpack
+    VERSION = "0.4.5"
+  end
+end

data/lib/nanoc/webpack.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "nanoc"
+require "ryo"
+module Nanoc::Webpack
+  require_relative "webpack/filter"
+end

data/lib/nanoc-webpack.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "nanoc/webpack"

data/nanoc-webpack.rb.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "./lib/nanoc/webpack/version"
+Gem::Specification.new do |gem|
+  gem.name = "nanoc-webpack.rb"
+  gem.authors = ["0x1eef"]
+  gem.email = ["0x1eef@protonmail.com"]
+  gem.homepage = "https://github.com/0x1eef/nanoc-webpack.rb#readme"
+  gem.version = Nanoc::Webpack::VERSION
+  gem.licenses = ["0BSD"]
+  gem.files = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+  gem.summary = "A nanoc filter that can compile textual items with webpack"
+  gem.description = gem.summary
+  gem.add_runtime_dependency "ryo.rb", "~> 0.4"
+  gem.add_development_dependency "yard", "~> 0.9"
+  gem.add_development_dependency "redcarpet", "~> 3.5"
+  gem.add_development_dependency "rspec", "~> 3.10"
+  gem.add_development_dependency "standard", "~> 1.13"
+  gem.add_development_dependency "rubocop-rspec", "~> 2.11"
+end

data/spec/dependable_spec.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative "setup"
+
+RSpec.describe Nanoc::Webpack::Filter::Dependable do
+  subject { filter.dependable(paths: target, reject:) }
+  let(:paths) { ["/1", "/1/1.txt", "/1/2", "/1/2/1.txt"] }
+  let(:root) { File.join("spec", "fakefs", "content") }
+  let(:reject) { nil }
+  let(:filter) do
+    Object.new.instance_exec(root, paths) do |root, paths|
+      extend Nanoc::Webpack::Filter::Dependable
+      define_singleton_method(:items) { paths.each_with_object({}) { _2[_1] = _1 } }
+      define_singleton_method(:root) { root }
+      self
+    end
+  end
+  include FileUtils
+
+  before do
+    mkdir_p(root)
+    paths.each do
+      path = File.join(root, _1)
+      File.extname(path).empty? ? mkdir_p(path) : touch(path)
+    end
+  end
+
+  after { rm_rf(root) }
+
+  context "when the directory depth is 2" do
+    context "when given /1 as a path" do
+      let(:target) { "/1" }
+      it { is_expected.to contain_exactly("/1/1.txt", "/1/2/1.txt") }
+    end
+
+    context "when given /1/2 as a path" do
+      let(:target) { "/1/2" }
+      it { is_expected.to contain_exactly("/1/2/1.txt") }
+    end
+  end
+
+  context "when the directory depth is 5" do
+    let(:paths) { super().concat(["/1/2/3/4/5", "/1/2/3/4/5/1.txt"]) }
+
+    context "when given /1 as a path" do
+      let(:target) { "/1" }
+      it do
+        is_expected.to contain_exactly(
+          "/1/1.txt",
+          "/1/2/1.txt",
+          "/1/2/3/4/5/1.txt"
+        )
+      end
+    end
+
+    context "when given /1/2 as a path" do
+      let(:target) { "/1/2" }
+      it { is_expected.to contain_exactly("/1/2/1.txt", "/1/2/3/4/5/1.txt") }
+    end
+
+    context "when given /1/2/3 as a path" do
+      let(:target) { "/1/2/3" }
+      it { is_expected.to contain_exactly("/1/2/3/4/5/1.txt") }
+    end
+
+    context "when depth 5 has descendant directories" do
+      let(:paths) do
+        super().concat([
+          "/1/2/3/4/5/a", "/1/2/3/4/5/a/a.txt",
+          "/1/2/3/4/5/b", "/1/2/3/4/5/b/b.txt",
+          "/1/2/3/4/5/c", "/1/2/3/4/5/c/c.txt"
+        ])
+      end
+
+      context "when given /1 as a path" do
+        let(:target) { "/1" }
+        it do
+          is_expected.to contain_exactly(
+            "/1/1.txt", "/1/2/1.txt", "/1/2/3/4/5/1.txt",
+            "/1/2/3/4/5/a/a.txt", "/1/2/3/4/5/b/b.txt",
+            "/1/2/3/4/5/c/c.txt"
+          )
+        end
+      end
+    end
+  end
+
+  context "when one or more directories are excluded" do
+    let(:paths) { super().concat(["/2/3", "/2/3/1.txt", "/3/4", "/3/4/1.txt"]) }
+
+    context "when the target is [!12]" do
+      let(:target) { "/[!12]/" }
+      it { is_expected.to contain_exactly("/3/4/1.txt") }
+    end
+
+    context "when the reject filter is used" do
+      let(:paths) do
+        ["/lib/WebPackage/", "/lib/WebPackage/foo.ts",
+         "/lib/Web/", "/lib/Web/foo.ts",
+         "/lib/foo/", "/lib/foo/foo.ts"]
+      end
+      let(:target) { "/lib/" }
+      let(:reject) { proc { |path| path.include?("WebPackage") } }
+
+      it do
+        is_expected.to contain_exactly("/lib/Web/foo.ts", "/lib/foo/foo.ts")
+      end
+    end
+  end
+end

data/spec/setup.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nanoc-webpack"

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-webpack.rb
+version: !ruby/object:Gem::Version
+  version: 0.4.5
+platform: ruby
+authors:
+- '0x1eef'
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ryo.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: A nanoc filter that can compile textual items with webpack
+email:
+- 0x1eef@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/specs.yml"
+- ".gitignore"
+- ".projectile"
+- ".rubocop.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- lib/nanoc-webpack.rb
+- lib/nanoc/webpack.rb
+- lib/nanoc/webpack/filter.rb
+- lib/nanoc/webpack/filter/dependable.rb
+- lib/nanoc/webpack/version.rb
+- nanoc-webpack.rb.gemspec
+- spec/dependable_spec.rb
+- spec/setup.rb
+homepage: https://github.com/0x1eef/nanoc-webpack.rb#readme
+licenses:
+- 0BSD
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A nanoc filter that can compile textual items with webpack
+test_files: []