cheesy-gallery 0.8.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b31592195513a15c1283ba531e6de02357f7c2bfb9d1aaa312df061e5cd6f8b
-  data.tar.gz: 66e4b206545aff52859a71ed9da66b0a600075029e6988de7c3f96a659c0a250
+  metadata.gz: 0af87d93a01619b196b1c7bfb162ee12d309f53961e3a04f523eed0e9c178f52
+  data.tar.gz: 1c52d18ca5e5eff07b51224b0b67f9ae16b6e58304ff76d09de53cbfd4488655
 SHA512:
-  metadata.gz: 7868feeaf207a4b67c3818407a67d766c1c8cb563897f0e98938120934cd9b433c865922be2d6007055c23c489c3182afcabe6d7ef369e6af9f907ed3591ba6e
-  data.tar.gz: 12f0769a64e4a58d1eaf870e788d35d49d234cb6b1e1a79f446238dfad4ee7d96f8468b0d6533b6d7112237bf397274ed166b8a1987ee51284a494285191f84a
+  metadata.gz: d876cfc12640e0d2688ac2c51d636c38083624d278031e32bfbbf6ce5ad54157c9e5299cfb0cd733d0b368006c5d32eb060f41907b3d05eeb1b308ad496e037d
+  data.tar.gz: a2ccf221f4575749a555f6d8a9e7d46c050327bd41ad30861c58f3ed20365e52373a3227c4b7960c052eea3675e7b00fbaa82db2baa2664cfc9ad11ff8245070

data/.github/workflows/publish.yaml

@@ -0,0 +1,20 @@
+name: Publish Gem
+on:
+  push:
+    tags:
+      - "*"
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.0"
+          bundler-cache: true
+      - uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}
+          github_token: ${{secrets.GITHUB_TOKEN}}

data/.github/workflows/tests.yaml

@@ -0,0 +1,39 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  base-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: ["2.7", "3.0", "3.1"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake
+  test-site:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: ["2.7", "3.0", "3.1"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          working-directory: spec/fixtures/test_site
+      - id: build-test-site
+        working-directory: spec/fixtures/test_site
+        run: |
+          bundle exec jekyll build --strict --trace --verbose
+          find _site -type f 
+          echo -e '\n===\n'
+          cat _site/gallery_one/index.html 
+          file _site/gallery_two/third/Morgenspaziergang-3.jpg_thumb.jpg

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 1.1.1
+
+* Address some deprecations warnings thanks to @pdxmph
+* CI housekeeping: move to GHA from travis
+
+# 1.1.0
+
+* Adds aggressive caching to reduce rebuild times.
+  If you need to re-render images for any reason, remove the `.jekyll-cache` folder or change the `_config.yml` file.
+
+* Changes default quality to 85, and instead strips alls comments.
+  This results in better quality pictures with less size.
+
+# 1.0.0
+
+Initial Release

data/README.md

@@ -1,39 +1,61 @@
 # Cheesy::Gallery
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cheesy/gallery`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a jekyll photo gallery to manage large amounts of galleries and pictures. You can see the results at https://www.cheesy.at/fotos/.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Follow Jekyll's documentation on [how to install plugins](https://jekyllrb.com/docs/plugins/installation/) using "cheesy-gallery" as name for the gem and plugin.
+
+## Usage
+
+After successful installation, enable gallery processing for a subdirectory of your site.
+For this example, the folder is called `_my_gallery`:
 
-```ruby
-gem 'cheesy-gallery'
+```yaml
+collections:
+  my_gallery:
+    cheesy-gallery: true
 ```
 
-And then execute:
+From now on, every Jekyll build will take all JPGs in all folders under `_my_gallery` and create a gallery for each folder, linking them according to their structure in the file system.
 
-    $ bundle
+To add a thumbnail to a gallery, put it inside the gallery folder and call it `thumbnail.jpg`.
 
-Or install it yourself as:
+Frontmatter, like titles, etc., are read from the `index.md` file in the gallery.
 
-    $ gem install cheesy-gallery
+Galleries and their contents are sorted by filename.
 
-## Usage
+To layout galleries, check out the [example layout](spec/fixtures/test_site/_layouts/gallery.html) and adapt it to your site's style.
+
+If you want an inline display of your photos, I recommend [glightbox](https://github.com/biati-digital/glightbox) by [biati-digital](https://github.com/biati-digital). Add their CSS and JavaScript to your assets, and link them in the `<head>` of your site:
+
+```html
+<link rel="stylesheet" href="{{ "/assets/glb/glightbox.min.css" | relative_url }}">
+<script src="{{ "/assets/glb/glightbox.min.js" | relative_url }}"></script>
+```
 
-TODO: Write usage instructions here
+ Then, in the gallery layout, add `data-gallery="gallery"` attribute to the `<a>` tag linking to each image, and put
+
+```html
+<script type="text/javascript">
+  const lightbox = GLightbox({selector: '*[data-gallery]'});
+</script>
+```
+
+at the bottom of the layout.
+
+## Caching
+
+This plugin uses aggressive caching to keep render times short.
+If you need to re-render images for any reason, remove the `.jekyll-cache` folder or change the `_config.yml` file.
+See the [Cache API tutorial](https://jekyllrb.com/tutorials/cache-api/) for some background.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. There is also a test site in `spec/fixtures/test_site` that you can use to try out changes.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/DavidS/cheesy-gallery. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## Code of Conduct
-
-Everyone interacting in the Cheesy::Gallery project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/DavidS/cheesy-gallery/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/DavidS/cheesy-gallery. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. See [code of conduct](https://github.com/DavidS/cheesy-gallery/blob/main/CODE_OF_CONDUCT.md) for a local copy.

data/cheesy-gallery.gemspec

@@ -38,9 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'sorbet'
 
   spec.add_dependency 'jekyll', '~> 4.0'
   spec.add_dependency 'rmagick', '~> 4.0'
-  spec.add_dependency 'sorbet-runtime'
 end

data/lib/cheesy-gallery/base_image_file.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 require 'rmagick'
@@ -6,32 +5,47 @@ require 'rmagick'
 # This StaticFile subclass adds additional functionality for images in the
 # gallery
 class CheesyGallery::BaseImageFile < Jekyll::StaticFile
-  extend T::Sig
+  @@render_cache = Jekyll::Cache.new('CheesyGallery::Render') # don't need to worry about inheritance here # rubocop:disable Style/ClassVars
 
-  sig { params(site: Jekyll::Site, collection: Jekyll::Collection, file: Jekyll::StaticFile, dest_path: T.nilable(String)).void }
   def initialize(site, collection, file, dest_path = nil)
-    @source_file = T.let(file, Jekyll::StaticFile)
+    @source_file = file
     super(site, site.source, File.dirname(file.relative_path), dest_path || file.name, collection)
   end
 
   # use the source file's path for this, as this value is used all over the
   # place for mtime checking
-  sig { returns String }
   def path
     @source_file.path
   end
 
   # overwrite this method to add additional processing
-  sig { params(img: Magick::ImageList, path: String).void }
   def process_and_write(img, path)
     img.write(path) {}
   end
 
+  # Inject cache here to override default delete-before-copy behaviour
+  # See jekyll:lib/jekyll/static_file.rb for source
+  def write(dest)
+    dest_path = destination(dest)
+    return false if File.exist?(dest_path) && !modified?
+
+    self.class.mtimes[path] = mtime
+
+    return if @@render_cache.key?("#{dest_path}-rendered") && File.exist?(dest_path)
+
+    FileUtils.mkdir_p(File.dirname(dest_path))
+    FileUtils.rm(dest_path) if File.exist?(dest_path)
+    copy_file(dest_path)
+
+    @@render_cache["#{dest_path}-rendered"] = true
+
+    true
+  end
+
   private
 
   # instead of copying, allow rmagick processing
   # this is only called if the mtime doesn't match
-  sig { params(dest_path: String).void }
   def copy_file(dest_path)
     source = Magick::ImageList.new(path)
     begin

data/lib/cheesy-gallery/gallery_index.rb

@@ -1,14 +1,11 @@
-# typed: strict
 # frozen_string_literal: true
 
 # This Document subclass is used to stand in for gallery indices which do not have a `index.html`
 class CheesyGallery::GalleryIndex < Jekyll::Document
-  extend T::Sig
-
   DEFAULT_CONTENT = "This page intentionally left plank.\n"
+
   # skip reading content, as there is by definition no backing file for this
-  sig { params(_opts: T.untyped).returns(String) }
-  def read_content(_opts)
+  def read_content(_opts = nil)
     self.content = DEFAULT_CONTENT
   end
 end

data/lib/cheesy-gallery/generator.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 require 'jekyll'
@@ -9,11 +8,8 @@ require 'cheesy-gallery/image_thumb'
 
 # The generator modifies the `site` data structure to contain all data necessary by the layouts and tags to render the galleries
 class CheesyGallery::Generator < Jekyll::Generator
-  extend T::Sig
-
-  sig { params(site: Jekyll::Site).void }
   def generate(site)
-    @site = T.let(site, T.nilable(Jekyll::Site))
+    @site = site
     (site.collections.values.find_all { |c| c.metadata['cheesy-gallery'] } || [site.collections['galleries']]).compact.each do |collection|
       collection.metadata['output'] = true unless collection.metadata.key? 'output'
 
@@ -36,7 +32,7 @@ class CheesyGallery::Generator < Jekyll::Generator
         CheesyGallery::ImageFile.new(
           site, collection, f,
           max_size: collection.metadata['max_size'] || '1920x1080',
-          quality: collection.metadata['quality'] || 50
+          quality: collection.metadata['quality'] || 85
         )
       end
 

data/lib/cheesy-gallery/image_file.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 require 'rmagick'
@@ -7,14 +6,13 @@ require 'cheesy-gallery/base_image_file'
 # This StaticFile subclass adds additional functionality for images in the
 # gallery
 class CheesyGallery::ImageFile < CheesyGallery::BaseImageFile
-  @@geometry_cache = T.let(Jekyll::Cache.new('CheesyGallery::Geometry'), Jekyll::Cache) # don't need to worry about inheritance here # rubocop:disable Style/ClassVars
+  @@geometry_cache = Jekyll::Cache.new('CheesyGallery::Geometry') # don't need to worry about inheritance here # rubocop:disable Style/ClassVars
 
-  sig { params(site: Jekyll::Site, collection: Jekyll::Collection, file: Jekyll::StaticFile, max_size: String, quality: Integer).void }
   def initialize(site, collection, file, max_size:, quality:)
     super(site, collection, file)
 
-    @max_size = T.let(max_size, String)
-    @quality = T.let(quality, Integer)
+    @max_size = max_size
+    @quality = quality
 
     realpath = File.realdirpath(path)
     mtime = File.mtime(realpath)
@@ -35,13 +33,17 @@ class CheesyGallery::ImageFile < CheesyGallery::BaseImageFile
   end
 
   # instead of copying, renders an optimised version
-  sig { params(img: Magick::ImageList, path: String).void }
   def process_and_write(img, path)
     img.change_geometry!(@max_size) do |cols, rows, i|
       i.resize!(cols, rows)
     end
+    # follow recommendations from https://stackoverflow.com/a/7262050/4918 to get better compression
+    img.interlace = Magick::PlaneInterlace
+    # but skip the blur to avoid too many changes to the data
+    # img.gaussian_blur(0.05)
+    img.strip!
     # workaround weird {self} initialisation pattern
     quality = @quality
-    img.write(path) { self.quality = quality }
+    img.write(path) { |image| image.quality = quality }
   end
 end

data/lib/cheesy-gallery/image_thumb.rb

@@ -1,4 +1,3 @@
-# typed: strict
 # frozen_string_literal: true
 
 require 'rmagick'
@@ -6,21 +5,18 @@ require 'cheesy-gallery/base_image_file'
 
 # This StaticFile subclass represents thumbnail images for each image. On `write()` it renders a 150x150 center crop of the source
 class CheesyGallery::ImageThumb < CheesyGallery::BaseImageFile
-  sig { returns(Integer) }
   attr_reader :height, :width
 
-  sig { params(site: Jekyll::Site, collection: Jekyll::Collection, file: Jekyll::StaticFile, postfix: String, height: Integer, width: Integer).void }
   def initialize(site, collection, file, postfix, height, width)
     super(site, collection, file, file.name + postfix)
 
-    @height = T.let(height, Integer)
-    @width = T.let(width, Integer)
+    @height = height
+    @width = width
   end
 
   # instead of copying, renders the thumbnail
-  sig { params(img: Magick::ImageList, path: String).void }
   def process_and_write(img, path)
     img.resize_to_fill!(height, width)
-    img.write(path) {}
+    img.write(path)
   end
 end

data/lib/cheesy-gallery/version.rb

@@ -1,6 +1,5 @@
-# typed: strong
 # frozen_string_literal: true
 
 module CheesyGallery
-  VERSION = '0.8.0'
+  VERSION = '1.1.1'
 end

data/lib/cheesy-gallery.rb

@@ -1,9 +1,7 @@
-# typed: strong
 # frozen_string_literal: true
 
 require 'jekyll'
 require 'fileutils'
-require 'sorbet-runtime'
 
 # Main holder of all things cheesy and gallery-y
 module CheesyGallery

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheesy-gallery
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.1.1
 platform: ruby
 authors:
 - David Schmitt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-31 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sorbet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: sorbet-runtime
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - david@black.co.at
@@ -158,10 +130,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/publish.yaml"
+- ".github/workflows/tests.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.md
@@ -177,53 +151,6 @@ files:
 - lib/cheesy-gallery/image_file.rb
 - lib/cheesy-gallery/image_thumb.rb
 - lib/cheesy-gallery/version.rb
-- sorbet/config
-- sorbet/rbi/gems/addressable.rbi
-- sorbet/rbi/gems/ast.rbi
-- sorbet/rbi/gems/codecov.rbi
-- sorbet/rbi/gems/coderay.rbi
-- sorbet/rbi/gems/colorator.rbi
-- sorbet/rbi/gems/concurrent-ruby.rbi
-- sorbet/rbi/gems/docile.rbi
-- sorbet/rbi/gems/ffi.rbi
-- sorbet/rbi/gems/forwardable-extended.rbi
-- sorbet/rbi/gems/i18n.rbi
-- sorbet/rbi/gems/jekyll-sass-converter.rbi
-- sorbet/rbi/gems/jekyll.rbi
-- sorbet/rbi/gems/kramdown.rbi
-- sorbet/rbi/gems/liquid.rbi
-- sorbet/rbi/gems/method_source.rbi
-- sorbet/rbi/gems/parallel.rbi
-- sorbet/rbi/gems/parser.rbi
-- sorbet/rbi/gems/pathutil.rbi
-- sorbet/rbi/gems/pry.rbi
-- sorbet/rbi/gems/public_suffix.rbi
-- sorbet/rbi/gems/rainbow.rbi
-- sorbet/rbi/gems/rake.rbi
-- sorbet/rbi/gems/regexp_parser.rbi
-- sorbet/rbi/gems/rexml.rbi
-- sorbet/rbi/gems/rmagick.rbi
-- sorbet/rbi/gems/rspec-core.rbi
-- sorbet/rbi/gems/rspec-expectations.rbi
-- sorbet/rbi/gems/rspec-mocks.rbi
-- sorbet/rbi/gems/rspec-support.rbi
-- sorbet/rbi/gems/rspec.rbi
-- sorbet/rbi/gems/rubocop-ast.rbi
-- sorbet/rbi/gems/rubocop.rbi
-- sorbet/rbi/gems/ruby-progressbar.rbi
-- sorbet/rbi/gems/safe_yaml.rbi
-- sorbet/rbi/gems/sassc.rbi
-- sorbet/rbi/gems/simplecov-html.rbi
-- sorbet/rbi/gems/simplecov.rbi
-- sorbet/rbi/gems/unicode-display_width.rbi
-- sorbet/rbi/hidden-definitions/errors.txt
-- sorbet/rbi/hidden-definitions/hidden.rbi
-- sorbet/rbi/rmagick.rbi
-- sorbet/rbi/sorbet-typed/lib/rainbow/all/rainbow.rbi
-- sorbet/rbi/sorbet-typed/lib/rake/all/rake.rbi
-- sorbet/rbi/sorbet-typed/lib/rspec-core/all/rspec-core.rbi
-- sorbet/rbi/sorbet-typed/lib/rubocop/>=1.8/rubocop.rbi
-- sorbet/rbi/todo.rbi
 homepage: https://github.com/DavidS/cheesy-gallery
 licenses: []
 metadata:
@@ -245,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.3.15
 signing_key: 
 specification_version: 4
 summary: A jekyll plugin for building galleries.

data/.travis.yml

@@ -1,33 +0,0 @@
----
-os: linux
-dist: focal
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-
-# adopt future bundler 3 config style
-before_install:
-  - bundle config set path ${BUNDLE_PATH:-vendor/bundle}
-  - bundle config set jobs 3
-  - bundle config set retry 3
-install: bundle install
-
-jobs:
-  include:
-  - env: CHECK=ruby
-    script:
-    - bundle exec rake
-  - env: CHECK=sorbet
-    script:
-    - bundle exec srb tc --ignore=/vendor
-  - env: CHECK=build
-    gemfile: spec/fixtures/test_site/Gemfile
-    script:
-    - (cd spec/fixtures/test_site && bundle exec jekyll build --strict --trace --verbose)
-    - (cd spec/fixtures/test_site && find _site -type f && echo -e '\n===\n' && cat _site/gallery_one/index.html && file _site/gallery_two/third/Morgenspaziergang-3.jpg_thumb.jpg)
-
-# only branch-test merges to main
-branches:
-  only:
-  - main

data/sorbet/config

@@ -1,2 +0,0 @@
---dir
-.