nanoc-gzip.rb 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 908677c7913fa3a7f9e4ca35816e62a288065d3103b61d9a8a7468722bd23a88
+  data.tar.gz: 47232afc6b2025b46ddc0ba88df5deef8b6de463faf0998c0beca1d9d01e28a0
+SHA512:
+  metadata.gz: 19c4a1e137926b59df1894a2adf424fe48a2c9f56fa4bf5d7b1133702e61b1bb16984aa58b793c63961e0c277e90c266599c0c32cdbd4bb63512e530412a402f
+  data.tar.gz: 743f721d9400f3a503217164c4b83107a0240637daeaeefde850af249ab9b392c23ca97537a895cc975c744c52f519e072be3bf42bdad379533d2c539e7405bb

data/.github/workflows/specs.yml

@@ -0,0 +1,23 @@
+name: nanoc-gzip.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: ruby test/nanoc_gzip_filter_test.rb

data/.gitignore

@@ -0,0 +1,2 @@
+.yardoc/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,24 @@
+##
+# Plugins
+require:
+  - standard
+  - rubocop-rspec
+
+##
+# Defaults: standard-rb
+inherit_gem:
+  standard: config/base.yml
+
+##
+# Enabled
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+##
+# Disabled
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Style/TrivialAccessors:
+  Enabled: false
+Style/CommandLiteral:
+  Enabled: false

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

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,78 @@
+## About
+
+nanoc-gzip.rb is a
+[nanoc](https://nanoc.app)
+filter that integrates gzip compression into nanoc-powered
+websites. The filter can be combined with the nginx module
+[gzip_static](http://nginx.org/en/docs/http/ngx_http_gzip_static_module.html)
+or its equivalent in other web servers.
+
+## Examples
+
+**Defaults**
+
+The following example demonstrates the compression of "app.js".
+The uncompressed version (app.js) and the compressed version
+(app.js.gz) are both written to disk:
+
+```ruby
+# Rules
+require "nanoc-gzip"
+compile "/js/app.js" do
+  write("/js/app.js")
+  filter(:gzip)
+  write("/js/app.js.gz")
+end
+```
+
+**Options**
+
+The filter can be configured with "level", and
+"strategy" options. Both are integer values. The
+default level is 9. And the default strategy
+is 0. The
+[zlib manual](https://www.zlib.net/manual.html#Constants)
+documents what integers are accepted and what
+they represent. Example:
+
+``` ruby
+# Rules
+require "nanoc-gzip"
+compile "/js/app.js" do
+  write("/js/app.js")
+  filter(:gzip, {level: 1, strategy: 2})
+  write("/js/app.js.gz")
+end
+```
+
+## Sources
+
+* [Source code (GitHub)](https://github.com/0x1eef/nanoc-gzip.rb)
+* [Source code (GitLab)](https://gitlab.com/0x1eef/nanoc-gzip.rb)
+
+## <a id='install'>Install</a>
+
+**Git**
+
+nanoc-gzip.rb is distributed as a RubyGem through its git repositories. <br>
+[GitHub](https://github.com/0x1eef/nanoc-gzip.rb),
+and
+[GitLab](https://gitlab.com/0x1eef/nanoc-gzip.rb)
+are available as sources.
+
+```ruby
+# Gemfile
+gem "nanoc-gzip.rb", github: "0x1eef/nanoc-gzip.rb", tag: "v0.2.2"
+```
+
+**Rubygems.org**
+
+nanoc-gzip.rb can also be installed via rubygems.org.
+
+    gem install nanoc-gzip.rb
+
+## License
+
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+<br>
+See [LICENSE](./LICENSE).

data/lib/nanoc-gzip/core_ext/nanoc/core/executor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "nanoc/core/executor"
+class Nanoc::Core::Executor
+  module Patch
+    def filter_for_filtering(filter_name)
+      klass = Nanoc::Core::Filter.named!(filter_name)
+      if klass.from_binary_or_text?
+        klass.new(assigns)
+      else
+        super
+      end
+    end
+  end
+  prepend(Patch)
+end

data/lib/nanoc-gzip/core_ext/nanoc/core/filter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "nanoc/core/filter"
+class Nanoc::Core::Filter
+  def self.from_binary_or_text?
+    return false unless @from.is_a?(Array)
+    @from.sort == %i[binary text]
+  end
+end

data/lib/nanoc-gzip/core_ext/nanoc.rb

@@ -0,0 +1,3 @@
+require "nanoc"
+require_relative "nanoc/core/executor"
+require_relative "nanoc/core/filter"

data/lib/nanoc-gzip/gzip/filter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Nanoc::Gzip::Filter < Nanoc::Filter
+  identifier :gzip
+  type [:binary, :text] => :binary
+  include Nanoc::Gzip
+
+  ##
+  # @param [String] str
+  # @return [String]
+  def run(str, options = {})
+    gzip(
+      item.binary? ? File.binread(str) : str,
+      options[:level],
+      options[:strategy]
+    )
+  end
+end

data/lib/nanoc-gzip/gzip.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "nanoc"
+module Nanoc::Gzip
+  require "zlib"
+  require_relative "gzip/filter"
+  include Zlib
+
+  ##
+  # Compresses a string, and writes the string to "Nanoc::Filter#output_filename".
+  #
+  # @param [String] content
+  #  The contents of a file.
+  #
+  # @param [Integer] level
+  #  The compression level represented by an integer between 0, and 9. <br>
+  #  The default is 9 (Zlib::BEST_COMPRESSION).
+  #
+  # @param [Integer] strategy
+  #  The compression strategy represented by an integer between 0, and 4. <br>
+  #  The default is 0 (Zlib::DEFAULT_STRATEGY).
+  #
+  # @return [void]
+  def gzip(content, level, strategy)
+    level ||= BEST_COMPRESSION
+    strategy ||= DEFAULT_STRATEGY
+    GzipWriter.open(output_filename, level, strategy) { _1.write(content) }
+  end
+end

data/lib/nanoc-gzip/version.rb

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

data/lib/nanoc-gzip.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "nanoc-gzip/core_ext/nanoc"
+require_relative "nanoc-gzip/gzip"

data/nanoc-gzip.rb.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "./lib/nanoc-gzip/version"
+Gem::Specification.new do |gem|
+  gem.name = "nanoc-gzip.rb"
+  gem.authors = ["0x1eef"]
+  gem.email = ["0x1eef@protonmail.com"]
+  gem.homepage = "https://github.com/0x1eef/nanoc-gzip.rb#readme"
+  gem.version = Nanoc::Gzip::VERSION
+  gem.licenses = ["0BSD"]
+  gem.files = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+  gem.summary = "A nanoc filter that compresses content in the gzip format"
+  gem.description = gem.summary
+  gem.metadata = { "documentation_uri" => "https://0x1eef.github.io/x/nanoc-gzip.rb" }
+
+  ##
+  # Default gems
+  # Pinned to specific versions for OpenBSD support
+  gem.add_runtime_dependency "json", "= 2.6.1"
+  gem.add_runtime_dependency "racc", "= 1.6.0"
+  gem.add_runtime_dependency "stringio", "= 3.0.1"
+  gem.add_runtime_dependency "set", "= 1.0.2"
+
+  gem.add_runtime_dependency "nanoc", "~> 4.12"
+  gem.add_development_dependency "test-unit", "~> 3.5"
+  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/test/nanoc_gzip_filter_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "setup"
+
+class FilterTest < Test::Unit::TestCase
+  module BinaryItem
+    def item
+      OpenStruct.new("binary?" => true)
+    end
+  end
+
+  module TextItem
+    def item
+      OpenStruct.new("binary?" => false)
+    end
+  end
+
+  def teardown
+    FileUtils.rm(filter.output_filename)
+  end
+
+  def test_text_item
+    filter.extend(TextItem).run("hello world")
+    assert_match %r{^application/(x-)?gzip}, file(filter.output_filename)
+  end
+
+  def test_binary_item
+    bin_file = File.join(__dir__, "bin_test_file")
+    File.binwrite(bin_file, "hello world")
+    filter.extend(BinaryItem).run(bin_file)
+    assert_match %r{^application/(x-)?gzip}, file(filter.output_filename)
+  ensure
+    FileUtils.rm(bin_file)
+  end
+
+  private
+
+  def filter
+    @filter ||= Nanoc::Filter.named!(:gzip).new
+  end
+
+  def file(path)
+    %x(file -bi #{path}).chomp
+  end
+end

data/test/setup.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "test/unit"
+require "nanoc-gzip"

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-gzip.rb
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- '0x1eef'
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: racc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: set
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: 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 compresses content in the gzip format
+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-gzip.rb
+- lib/nanoc-gzip/core_ext/nanoc.rb
+- lib/nanoc-gzip/core_ext/nanoc/core/executor.rb
+- lib/nanoc-gzip/core_ext/nanoc/core/filter.rb
+- lib/nanoc-gzip/gzip.rb
+- lib/nanoc-gzip/gzip/filter.rb
+- lib/nanoc-gzip/version.rb
+- nanoc-gzip.rb.gemspec
+- test/nanoc_gzip_filter_test.rb
+- test/setup.rb
+homepage: https://github.com/0x1eef/nanoc-gzip.rb#readme
+licenses:
+- 0BSD
+metadata:
+  documentation_uri: https://0x1eef.github.io/x/nanoc-gzip.rb
+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.5.3
+signing_key:
+specification_version: 4
+summary: A nanoc filter that compresses content in the gzip format
+test_files: []