cheesy-gallery 0.5.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2dc0d1b0518ec5f9babfd8ac91c4c602cdedf7408761f481c9b7651bb1f6cc2
-  data.tar.gz: f3ba017868795eabf9f7426081c277cc86bd63e5e9921ad206ab0577db2be738
+  metadata.gz: 19931d133435a6a55017ecac411db830706130e548d194cb46acd26a252adfd1
+  data.tar.gz: a1051c7f17f276558d65f681ae61bffb74f3ec3ae6d0089d4f2e1e963f83587a
 SHA512:
-  metadata.gz: 65954e185f7d3220273d277ad6c108e37f429f683ec3bc3a65983ada225e3a4a47e27d0ef4e30489cc4e549b2b4866f7c12858212facb104426e9b8484e96f98
-  data.tar.gz: fb8a7bd3428de2da5e7920eb6d9084035cb68d7acfbf3f242f8a95feacaff749c4e9d4e835e2a09f1c4aeae60dbfa0bfa5c12ebbc0b7fce9d6f1ebe74abfeac2
+  metadata.gz: 9b13062ca2c8117769df7e288aa285a67dcb467c56818faf6a92292492dd9c12f1319159b09c0f936edef88cec566075d3fa1807b15dfc0332e72e17372cedfa
+  data.tar.gz: cae163728e4f9ca11d2dc5059027f39d1c42930f6802d4917850d7e726c603682adbb47dc986d1d6f6363a5cdce3a4627a40e1bd5888c49c9e61a814b083087f

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10
+- package-ecosystem: bundler
+  directory: "/spec/fixtures/test_site"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/.travis.yml

@@ -8,7 +8,6 @@ rvm:
 
 # adopt future bundler 3 config style
 before_install:
-  - bundle config set deployment 'true' # expect Gemfile.lock to be up-to-date for testing
   - bundle config set path ${BUNDLE_PATH:-vendor/bundle}
   - bundle config set jobs 3
   - bundle config set retry 3
@@ -16,7 +15,7 @@ install: bundle install
 
 jobs:
   include:
-  - env: CHECK=rspec
+  - env: CHECK=ruby
     script:
     - bundle exec rake
   - env: CHECK=sorbet

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 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/lib/cheesy-gallery/base_image_file.rb

@@ -8,6 +8,8 @@ require 'rmagick'
 class CheesyGallery::BaseImageFile < Jekyll::StaticFile
   extend T::Sig
 
+  @@render_cache = T.let(Jekyll::Cache.new('CheesyGallery::Render'), Jekyll::Cache) # 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)
@@ -27,6 +29,25 @@ class CheesyGallery::BaseImageFile < Jekyll::StaticFile
     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

data/lib/cheesy-gallery/generator.rb

@@ -32,11 +32,11 @@ class CheesyGallery::Generator < Jekyll::Generator
       end
 
       # create replacements for the files with additional functionality
-      image_files = collection.files.map do |f|
+      image_files = collection.files.sort { |a, b| a.name <=> b.name }.map do |f|
         CheesyGallery::ImageFile.new(
           site, collection, f,
           max_size: collection.metadata['max_size'] || '1920x1080',
-          quality: collection.metadata['quality'] || 50
+          quality: collection.metadata['quality'] || 85
         )
       end
 
@@ -66,6 +66,8 @@ class CheesyGallery::Generator < Jekyll::Generator
 
         # attach images
         doc.data['images'] = files_by_dirname[gallery_path]
+        doc.data['thumbnail_source'] = doc.data['images']&.select { |i| i.name == 'thumbnail.jpg' }&.first || doc.data['images']&.first
+        doc.data['images']&.reject! { |i| i.name == 'thumbnail.jpg' }
 
         # attach parent
         parent = if gallery_path == collection.relative_directory
@@ -77,13 +79,13 @@ class CheesyGallery::Generator < Jekyll::Generator
         doc.data['parent'] = parent
         galleries_by_parent[parent] << doc
 
-        # add thumbnail when there are images
-        next if doc.data['images'].nil?
+        # only add thumbnail when there is a thumbnail source
+        next unless doc.data['thumbnail_source']
 
         collection.files << doc.data['thumbnail'] = CheesyGallery::ImageThumb.new(
           site,
           collection,
-          doc.data['images'].first,
+          doc.data['thumbnail_source'],
           '_index.jpg',
           collection.metadata['gallery_thumbnail_size'] || 72,
           collection.metadata['gallery_thumbnail_size'] || 72,

data/lib/cheesy-gallery/image_file.rb

@@ -7,6 +7,8 @@ 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
+
   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)
@@ -14,14 +16,22 @@ class CheesyGallery::ImageFile < CheesyGallery::BaseImageFile
     @max_size = T.let(max_size, String)
     @quality = T.let(quality, Integer)
 
-    # read file metadata in the same way it will be processed
-    Jekyll.logger.debug 'Identifying:', path
-    source = Magick::Image.ping(path).first
-    source.change_geometry!(@max_size) do |cols, rows, _img|
-      data['height'] = rows
-      data['width'] = cols
+    realpath = File.realdirpath(path)
+    mtime = File.mtime(realpath)
+    geom = @@geometry_cache.getset("#{realpath}##{mtime}") do
+      result = [100, 100]
+      # read file metadata in the same way it will be processed
+      Jekyll.logger.debug 'Identifying:', path
+      source = Magick::Image.ping(path).first
+      source.change_geometry!(@max_size) do |cols, rows, _img|
+        result = [rows, cols]
+      end
+      source.destroy!
+      result
     end
-    source.destroy!
+
+    data['height'] = geom[0]
+    data['width'] = geom[1]
   end
 
   # instead of copying, renders an optimised version
@@ -30,6 +40,11 @@ class CheesyGallery::ImageFile < CheesyGallery::BaseImageFile
     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 }

data/lib/cheesy-gallery/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module CheesyGallery
-  VERSION = '0.5.0'
+  VERSION = '1.1.0'
 end

data/sorbet/rbi/gems/addressable.rbi

@@ -0,0 +1,147 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/addressable/all/addressable.rbi
+#
+# addressable-2.7.0
+
+module Addressable
+end
+module Addressable::VERSION
+end
+module Addressable::IDNA
+  def self.lookup_unicode_combining_class(codepoint); end
+  def self.lookup_unicode_compatibility(codepoint); end
+  def self.lookup_unicode_composition(unpacked); end
+  def self.lookup_unicode_lowercase(codepoint); end
+  def self.punycode_adapt(delta, numpoints, firsttime); end
+  def self.punycode_basic?(codepoint); end
+  def self.punycode_decode(punycode); end
+  def self.punycode_decode_digit(codepoint); end
+  def self.punycode_delimiter?(codepoint); end
+  def self.punycode_encode(unicode); end
+  def self.punycode_encode_digit(d); end
+  def self.to_ascii(input); end
+  def self.to_unicode(input); end
+  def self.unicode_compose(unpacked); end
+  def self.unicode_compose_pair(ch_one, ch_two); end
+  def self.unicode_decompose(unpacked); end
+  def self.unicode_decompose_hangul(codepoint); end
+  def self.unicode_downcase(input); end
+  def self.unicode_normalize_kc(input); end
+  def self.unicode_sort_canonical(unpacked); end
+end
+class Addressable::IDNA::PunycodeBadInput < StandardError
+end
+class Addressable::IDNA::PunycodeBigOutput < StandardError
+end
+class Addressable::IDNA::PunycodeOverflow < StandardError
+end
+class Addressable::URI
+  def +(uri); end
+  def ==(uri); end
+  def ===(uri); end
+  def absolute?; end
+  def authority; end
+  def authority=(new_authority); end
+  def basename; end
+  def default_port; end
+  def defer_validation; end
+  def display_uri; end
+  def domain; end
+  def dup; end
+  def empty?; end
+  def eql?(uri); end
+  def extname; end
+  def fragment; end
+  def fragment=(new_fragment); end
+  def freeze; end
+  def hash; end
+  def host; end
+  def host=(new_host); end
+  def hostname; end
+  def hostname=(new_hostname); end
+  def inferred_port; end
+  def initialize(options = nil); end
+  def inspect; end
+  def ip_based?; end
+  def join!(uri); end
+  def join(uri); end
+  def merge!(uri); end
+  def merge(hash); end
+  def normalize!; end
+  def normalize; end
+  def normalized_authority; end
+  def normalized_fragment; end
+  def normalized_host; end
+  def normalized_password; end
+  def normalized_path; end
+  def normalized_port; end
+  def normalized_query(*flags); end
+  def normalized_scheme; end
+  def normalized_site; end
+  def normalized_user; end
+  def normalized_userinfo; end
+  def omit!(*components); end
+  def omit(*components); end
+  def origin; end
+  def origin=(new_origin); end
+  def password; end
+  def password=(new_password); end
+  def path; end
+  def path=(new_path); end
+  def port; end
+  def port=(new_port); end
+  def query; end
+  def query=(new_query); end
+  def query_values(return_type = nil); end
+  def query_values=(new_query_values); end
+  def relative?; end
+  def remove_composite_values; end
+  def replace_self(uri); end
+  def request_uri; end
+  def request_uri=(new_request_uri); end
+  def route_from(uri); end
+  def route_to(uri); end
+  def scheme; end
+  def scheme=(new_scheme); end
+  def self.convert_path(path); end
+  def self.encode(uri, return_type = nil); end
+  def self.encode_component(component, character_class = nil, upcase_encoded = nil); end
+  def self.escape(uri, return_type = nil); end
+  def self.form_encode(form_values, sort = nil); end
+  def self.form_unencode(encoded_value); end
+  def self.heuristic_parse(uri, hints = nil); end
+  def self.ip_based_schemes; end
+  def self.join(*uris); end
+  def self.normalize_component(component, character_class = nil, leave_encoded = nil); end
+  def self.normalize_path(path); end
+  def self.normalized_encode(uri, return_type = nil); end
+  def self.parse(uri); end
+  def self.port_mapping; end
+  def self.unencode(uri, return_type = nil, leave_encoded = nil); end
+  def self.unencode_component(uri, return_type = nil, leave_encoded = nil); end
+  def self.unescape(uri, return_type = nil, leave_encoded = nil); end
+  def self.unescape_component(uri, return_type = nil, leave_encoded = nil); end
+  def site; end
+  def site=(new_site); end
+  def split_path(path); end
+  def tld; end
+  def tld=(new_tld); end
+  def to_hash; end
+  def to_s; end
+  def to_str; end
+  def user; end
+  def user=(new_user); end
+  def userinfo; end
+  def userinfo=(new_userinfo); end
+  def validate; end
+end
+class Addressable::URI::InvalidURIError < StandardError
+end
+module Addressable::URI::CharacterClasses
+end

data/sorbet/rbi/gems/ast.rbi

@@ -0,0 +1,49 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/ast/all/ast.rbi
+#
+# ast-2.4.2
+
+module AST
+end
+class AST::Node
+  def +(array); end
+  def <<(element); end
+  def ==(other); end
+  def append(element); end
+  def assign_properties(properties); end
+  def children; end
+  def clone; end
+  def concat(array); end
+  def deconstruct; end
+  def dup; end
+  def eql?(other); end
+  def fancy_type; end
+  def hash; end
+  def initialize(type, children = nil, properties = nil); end
+  def inspect(indent = nil); end
+  def original_dup; end
+  def to_a; end
+  def to_ast; end
+  def to_s(indent = nil); end
+  def to_sexp(indent = nil); end
+  def to_sexp_array; end
+  def type; end
+  def updated(type = nil, children = nil, properties = nil); end
+end
+class AST::Processor
+  include AST::Processor::Mixin
+end
+module AST::Processor::Mixin
+  def handler_missing(node); end
+  def process(node); end
+  def process_all(nodes); end
+end
+module AST::Sexp
+  def s(type, *children); end
+end