m1key_gallery_generator 0.3.21 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b5f578d034150b3b6c684e054f984a7a775ed7444bc3d8d6847a2b44100d069
-  data.tar.gz: 0f64dcfbd43e25f91b02914e6d238a81ffb5fd529637dfaaec7c9d7e89acaaf9
+  metadata.gz: 72109ba7c003b3c3422537bfb0ed5d34e8ac5e433fafb1d9afd9376675cb1359
+  data.tar.gz: 7c736bf21843a6be2ef91ac23543c329aae370839c9a58822a91fc131d436464
 SHA512:
-  metadata.gz: 394630c56b6856d1f1d83cb51b5e73a7de3490a710a9573831ba62c5ec04f29613282e9d9ec2e635011f53de0cec4bc299fb24f88380223251ffadc5c93f2c58
-  data.tar.gz: 9d23e210cb291562b0c54be21814de74bf0268262efa9a1696fb9c4642e83ff173e36e80fc30447e369c8e2d583f06cd1488918abd2d382ecc0daa0bd3a1996a
+  metadata.gz: d3dde2b5d7c3d083d8d8816a1028896f584366e28a9eb01a5bef8071ffea1e7d7b09494bbdb9ce4231c5bfaadfa2e169c53461bc0ad513c8049f1131bbfddde0
+  data.tar.gz: 1a5455f776039a9ce63ff20269c3a268023d3bd1d7ba5d9df655930fb4ba75b8d13417a86710ed5271545479155d398cd34212d430c27404bd9631ccb460d46a

data/README.md

@@ -1,66 +1,96 @@
 # M1keyGalleryGenerator
 
-This Ruby script generates www.m1key.me style gallery.
+This Ruby script generates [m1key.me](https://www.m1key.me)-style galleries.
 
-A sample gallery is this: https://www.m1key.me/photography/mauritania_part_2/
+A sample gallery: https://www.m1key.me/photography/mauritania_part_2/
 
 ## Status
 
-This is work in progress, but has been used to generate real-life galleries.
+Maintained, used, going strong.
 
 ## Set up
 
-### Fedora 35+
+### Fedora
 
-Install Ruby:
+This was most recently tested on Fedora 43 Workstation ARM.
 
-> dnf install ruby
+Install rbenv using this command (the one shipped with the system is out of date):
 
-Install Ruby Gem Bundler in Fedora 35 and higher:
-
-> gem install bundler
+```
+curl -fsSL https://github.com/rbenv/rbenv-installer/raw/HEAD/bin/rbenv-installer | bash
+```
 
-> dnf install ruby-irb
+Then install Ruby:
 
+```
+rbenv install 4.0.2
+rbenv global 4.0.2
+gem install bundler
+```
 
 ### Ubuntu
 
-Install Ruby using rbenv. Then:
+This was most recently tested on Ubuntu 24.04 AMD.
+
+Install rbenv using this command (the one shipped with the system is out of date):
 
-> rbenv install 3.4.7
+```
+curl -fsSL https://github.com/rbenv/rbenv-installer/raw/HEAD/bin/rbenv-installer | bash
+```
+
+Rbenv hackery:
 
-> rbenv global 3.4.7
+```
+apt install libffi-dev
+apt install libyaml-dev
+```
 
-> gem install bundler
+Then install Ruby:
+
+```
+rbenv install 4.0.2
+rbenv global 4.0.2
+gem install bundler
+gem install rspec
+```
 
 ### Windows
 
-Install Ruby. This has been most recently tested on Ruby 3.4.7.
+This was most recently tested on Windows 11.
 
-Install Gitbash.
+Install Ruby 4.0.2 using rubyinstaller.org. Then run:
 
-> gem install bundler
+```
+gem install bundler
+```
 
 ### All
 
 Install dependencies:
 
-> ./bin/setup
+```
+bundle install
+```
 
 ## Tests
 
-Run the script on some test data. This is required to run other tests.
-This assumes there is a valid gallery.yaml file present in the current folder,
-and the photos themselves in the format DSC_1234.jpg.
-*This is required to run tests.*
+### Setup
 
-> ruby -Ilib bin/console test/data
+```
+ruby -Ilib bin/console test/data
+```
+
+### Synthetic gallery tests
 
-Run other tests:
+```
+rake
+```
 
-> rake
+### Code-level tests
 
-> rspec spec
+```
+rspec spec
+```
 
 ## Usage
 
@@ -70,15 +100,21 @@ Clone the project.
 
 Build the gem.
 
-> gem build m1key_gallery_generator.gemspec
+```
+gem build m1key_gallery_generator.gemspec
+```
 
 Install the gem.
 
-> gem install m1key_gallery_generator-0.3.21.gem
+```
+gem install m1key_gallery_generator-0.4.0.gem
+```
 
-In your gallery directory, have a file called generate.bat that looks like this:
+In your gallery directory, have a file called `generate.bat`s that looks like this:
 
-> ruby c:\Ruby34-x64\lib\ruby\gems\3.4.0\gems\m1key_gallery_generator-0.3.21\bin\console . wait_on_error
+```
+ruby c:\Ruby40-x64\lib\ruby\gems\4.0.0\gems\m1key_gallery_generator-0.4.0\bin\console . wait_on_error
+```
 
 ## Development
 
@@ -88,36 +124,3 @@ To release a new version, update the version number in `version.rb`,
 commit your changes,
 and then run `bundle exec rake release` to create a git tag for the version,
 push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-### Gem
-
-To build gem:
-> gem build m1key_gallery_generator.gemspec
-
-To install gem:
-> gem install m1key_gallery_generator-0.3.21.gem
-
-To test gem:
-> irb
-
-> require 'm1key_gallery_generator'
-
-### Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'm1key_gallery_generator'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install m1key_gallery_generator
-
-## Gotchas
-
-Do not edit the templates in Atom due to its whitespace magic. I used vi instead.

data/Rakefile

@@ -1,9 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:minitest) do |t|
   t.libs << 'test'
 end
 
 desc 'Run tests'
-task default: :test
+task default: [:minitest, :spec]

data/bin/console

@@ -34,10 +34,10 @@ begin
   if update_date.to_s == ''
     update_date = Date.today.strftime('%Y-%m-%d')
   end
-  gallery = ViewableGallery.new(gallery_config.title, gallery_config.description, gallery_config.slug,
-    gallery_config.sources, gallery_config.upload_date, gallery_config.map_url, gallery_config.map_title,
-    gallery_config.year, viewable_photos, gallery_config.small_print, gallery_config.blurb, gallery_config.genre,
-    update_date).
+  gallery = ViewableGallery.new(title: gallery_config.title, description: gallery_config.description, slug: gallery_config.slug,
+    sources: gallery_config.sources, upload_date: gallery_config.upload_date, map_url: gallery_config.map_url, map_title: gallery_config.map_title,
+    year: gallery_config.year, viewable_photos: viewable_photos, small_print: gallery_config.small_print, blurb: gallery_config.blurb, genre: gallery_config.genre,
+    update_date: update_date).
       update_using(
       add_tabs_before_every_description_line(3),
       add_links_to_descriptions,

data/lib/m1key_gallery_generator/gallery_config.rb

@@ -9,7 +9,7 @@ module GalleryGenerator
 
     def initialize(yaml_config_file_name)
       puts "Attempting to parse #{yaml_config_file_name} to read gallery configuration..."
-      gallery_configuration = YAML.safe_load_file(yaml_config_file_name, permitted_classes: [Date, Symbol], permitted_symbols: [])
+      gallery_configuration = YAML.safe_load_file(yaml_config_file_name, permitted_classes: [Date])
       puts 'Parsed, seemingly.'
       puts
 

data/lib/m1key_gallery_generator/template.erb

@@ -158,7 +158,7 @@
     <details class="sources" id="sources">
       <summary>Sources</summary>
       <ul class="smallprint"><% sources.each_with_index do |source, index| %>
-        <li><%= index + 1 %>: <a href="<%= source %>" rel="noopener noreferrer" class="nav-link"><% if source.length > 100 %><%= source[0..50] %>[...]<%= source[-30..-1] %><% else %><%= source %><% end -%></a></li><% end %>
+        <li><%= index + 1 %>: <a href="<%= source %>" target="_blank" rel="noopener noreferrer" class="nav-link"><% if source.length > 100 %><%= source[0..50] %>[...]<%= source[-30..-1] %><% else %><%= source %><% end -%></a></li><% end %>
       </ul>
     </details>
   <% end -%>

data/lib/m1key_gallery_generator/version.rb

@@ -1,3 +1,3 @@
 module M1keyGalleryGenerator
-  VERSION = '0.3.21'
+  VERSION = '0.4.0'
 end

data/lib/m1key_gallery_generator/viewable_gallery.rb

@@ -3,7 +3,7 @@ require_relative 'string_utils'
 module GalleryGenerator
   class ViewableGallery
     attr_reader :title, :description, :slug, :sources, :upload_date, :map_url, :map_title, :year, :photos, :small_print, :blurb, :genre, :update_date
-    def initialize(title, description, slug, sources, upload_date, map_url, map_title, year, viewable_photos, small_print, blurb, genre, update_date)
+    def initialize(title:, description:, slug:, sources:, upload_date:, map_url:, map_title:, year:, viewable_photos:, small_print:, blurb:, genre:, update_date:)
       @title = String.new(title)
       @description = description
       @slug = slug
@@ -30,9 +30,9 @@ module GalleryGenerator
         updated_gallery = update_function.call(updated_gallery)
       end
 
-      ViewableGallery.new(updated_gallery.title, updated_gallery.description, updated_gallery.slug,
-          updated_gallery.sources, updated_gallery.upload_date, updated_gallery.map_url,
-          updated_gallery.map_title, updated_gallery.year, to_viewable_photos(updated_gallery.photos), updated_gallery.small_print, updated_gallery.blurb, updated_gallery.genre, updated_gallery.update_date)
+      ViewableGallery.new(title: updated_gallery.title, description: updated_gallery.description, slug: updated_gallery.slug,
+          sources: updated_gallery.sources, upload_date: updated_gallery.upload_date, map_url: updated_gallery.map_url,
+          map_title: updated_gallery.map_title, year: updated_gallery.year, viewable_photos: to_viewable_photos(updated_gallery.photos), small_print: updated_gallery.small_print, blurb: updated_gallery.blurb, genre: updated_gallery.genre, update_date: updated_gallery.update_date)
     end
 
     def to_viewable_photos(mutable_viewable_photos)

data/m1key_gallery_generator.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = M1keyGalleryGenerator::VERSION
   spec.authors       = ['Michal Huniewicz']
   spec.email         = ['REDACTED']
-  spec.required_ruby_version = '>= 3.0'
+  spec.required_ruby_version = '>= 4.0'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -16,17 +16,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/m1key/m1key_gallery_generator'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) || f.start_with?('.') }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'exifr', '~> 1.4', '>= 1.4.0'
+  spec.add_runtime_dependency 'exifr', '~> 1.5', '>= 1.5.1'
+  spec.add_runtime_dependency 'logger', '~> 1.7'
 
-  spec.add_development_dependency 'bundler', '~> 2.4', '>= 2.4.10'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'minitest', '~> 5.15'
-  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'bundler', '~> 4.0', '>= 4.0.6'
+  spec.add_development_dependency 'rake', '~> 13.3', '>= 13.3.1'
+  spec.add_development_dependency 'minitest', '~> 6.0', '>= 6.0.2'
+  spec.add_development_dependency 'rspec', '~> 4.0.0.beta1'
   spec.add_development_dependency 'fiddle', '~> 1.1.8'
   spec.add_development_dependency 'htmlentities', '~> 4.4.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: m1key_gallery_generator
 version: !ruby/object:Gem::Version
-  version: 0.3.21
+  version: 0.4.0
 platform: ruby
 authors:
 - Michal Huniewicz
@@ -15,82 +15,108 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.10
+        version: 4.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.10
+        version: 4.0.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.3.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.15'
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 4.0.0.beta1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: 4.0.0.beta1
 - !ruby/object:Gem::Dependency
   name: fiddle
   requirement: !ruby/object:Gem::Requirement
@@ -127,9 +153,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -160,14 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: m1key.me-style gallery generator.
 test_files: []

data/.github/workflows/ruby.yml

@@ -1,38 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['3.2.2']
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-    # uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,38 +0,0 @@
-index.html
-uzbekistan*
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-.idea
-*.iml
-.rakeTasks
-vendor
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/lib/bundler/man/
-
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color