lifer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 225194090fc0812a6c9c760203e4c8e2b3d74b8a83a9b8393ebdbf691a942c90
-  data.tar.gz: 4fa359e525044b675b6e429501a53e6c6f2d6495ab5938681e3b83b068c5628f
+  metadata.gz: c5891938dbf0269f6cf30b14cd14130025b2214e0b03b6c756d48efa1abf8ae3
+  data.tar.gz: a6bb29832ac1e2ccde939d17f6c84643c5d8f3544d0cda7f407a696d642836e7
 SHA512:
-  metadata.gz: 334f8a7359bac5537ae3279d01c1d153fec4d9ae27b7c29dc2132f4443227b0c7c4409f2fe6461592ec53690c66e04e7e6018e6ca5bc2e23d60b7afa432160b9
-  data.tar.gz: 475dbdb28f05668418d90531832103b8592f3734270e5d3d3cd0400feafc3760570d116a2a27c9730c6f39421524ea00b1d843af9cb93bd2645c5fb2c6b852a1
+  metadata.gz: 6cd12ec2588d1afc192352219a98e04672ce721069160bc5b3f0db5e2c91998a156318d30ee7a3299d062f32127b0cf9cc9d7eea7ece320212627c3e27344d91
+  data.tar.gz: 1506e4a3bf8957dce6dbacccf25d75a52edf710c886a8955b979dede89b698dfc8f0a8dd1571fa6275ad8737ad0cdc2e9897503b16bb848bcaef2027ddfb8fcf

data/.github/workflows/main.yml

@@ -4,13 +4,14 @@ on: [push,pull_request]
 
 jobs:
   build:
+    name: Run RSpec test suite
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.2
+        ruby-version: 3.1.2
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/.gitignore

@@ -1,11 +1,13 @@
+# Ruby tooling.
+.rspec_status
 /.bundle/
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
-/pkg/
 /spec/reports/
-/tmp/
 
-# rspec failure tracking
-.rspec_status
+# Gem builds.
+lifer*.gem
+
+# Temp files.
+/tmp/

data/Gemfile.lock

@@ -7,10 +7,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
     diff-lcs (1.5.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
     kramdown (2.4.0)
       rexml
     rake (13.0.6)
+    reline (0.3.1)
+      io-console (~> 0.5)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -27,12 +35,14 @@ GEM
     rspec-support (3.11.0)
 
 PLATFORMS
-  x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
+  debug
   lifer!
   rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.2.22
+   2.3.21

data/lib/lifer/builder/html.rb

@@ -1,11 +1,8 @@
 require "fileutils"
 
-# FIXME:
-# This builder is not currently designed in a good way. Every builder should
-# have an interface that lets us swap steps in and out in an easy way.
-#
 class Lifer::Builder::HTML
   DEFAULT_OUTPUT_DIRECTORY_NAME = "_build"
+  FALLBACK_URI_STRATEGY = "simple"
 
   class << self
     def execute(root:)
@@ -15,21 +12,17 @@ class Lifer::Builder::HTML
 
   def execute
     # Remove any existing output directory.
+    #
     FileUtils.rm_r(output_directory)
 
     # Go into the fresh build directory and generate each HTML file from the
     # given directory.
+    #
     Dir.chdir(output_directory) do
       Lifer.collections.each do |collection|
         collection.entries.each do |entry|
-          initialize_subdirectories_for entry
-
-          File.open(uri_strategy.file_for(entry), "w") { |f|
-            f.write Lifer::Layout.build(
-              entry: entry,
-              template: layout_for(collection)
-            )
-          }
+          generate_output_directories_for entry, current_collection: collection
+          generate_output_file_for entry, current_collection: collection
         end
       end
     end
@@ -37,18 +30,27 @@ class Lifer::Builder::HTML
 
   private
 
-  attr_reader :root, :uri_strategy
+  attr_reader :root
 
   def initialize(root:)
     @root = root
-    @uri_strategy = Lifer::URIStrategy::Simple.new(directory: root)
   end
 
-  def initialize_subdirectories_for(entry)
-    return if (dirname = uri_strategy.dirname_for(entry)).nil? ||
-      Dir.exist?(dirname)
+  def generate_output_directories_for(entry, current_collection:)
+    dirname =
+      Pathname File.dirname(uri_strategy(current_collection).output_file(entry))
+    FileUtils.mkdir_p dirname unless Dir.exist?(dirname)
+  end
 
-    FileUtils.mkdir_p uri_strategy.dirname_for(entry)
+  def generate_output_file_for(entry, current_collection:)
+    File.open(uri_strategy(current_collection).output_file(entry), "w") { |file|
+      file.write(
+        Lifer::Layout.build(
+          entry: entry,
+          template: layout_for(current_collection)
+        )
+      )
+    }
   end
 
   def layout_for(collection)
@@ -70,4 +72,14 @@ class Lifer::Builder::HTML
     Dir.mkdir(dir)
     Pathname(dir)
   end
+
+  def uri_strategy(current_collection)
+    collection_settings =
+      Lifer.settings[current_collection.name] || Lifer.settings[:root]
+    current_uri_strategy =
+      collection_settings && collection_settings[:uri_strategy] ||
+        FALLBACK_URI_STRATEGY
+
+    Lifer::URIStrategy.find_by_name(current_uri_strategy).new(root: root)
+  end
 end

data/lib/lifer/entry.rb

@@ -1,8 +1,11 @@
+require "date"
 require "kramdown"
+require "time"
 
 require_relative "utilities"
 
 class Lifer::Entry
+  FILENAME_DATE_FORMAT = /^(\d{4}-\d{1,2}-\d{1,2})-/
   FRONTMATTER_REGEX = /^---\n(.*)---\n/m
 
   attr_reader :file
@@ -17,18 +20,31 @@ class Lifer::Entry
     full_text.gsub(FRONTMATTER_REGEX, "").strip
   end
 
+  def date
+    date_data = frontmatter[:date] || filename_date
+
+    case date_data
+    when Time then date_data
+    when String then DateTime.parse(date_data).to_time
+    else
+      puts "[%s]: no date metadata" % [file]
+      nil
+    end
+  rescue ArgumentError => error
+    puts "[%s]: %s" % [file, error]
+    nil
+  end
+
   def frontmatter
-    return nil unless frontmatter?
+    return {} unless frontmatter?
 
     Lifer::Utilities.symbolize_keys(
-      YAML.load full_text[FRONTMATTER_REGEX, 1]
+      YAML.load(full_text[FRONTMATTER_REGEX, 1], permitted_classes: [Time])
     )
   end
 
   def full_text
-    return unless file
-
-    File.readlines(file).join
+    File.readlines(file).join if file
   end
 
   def to_html
@@ -37,7 +53,13 @@ class Lifer::Entry
 
   private
 
+  def filename_date
+    return unless file && File.basename(file).match?(FILENAME_DATE_FORMAT)
+
+    File.basename(file).match(FILENAME_DATE_FORMAT)[1]
+  end
+
   def frontmatter?
-    full_text.match? FRONTMATTER_REGEX
+    full_text && full_text.match?(FRONTMATTER_REGEX)
   end
 end

data/lib/lifer/uri_strategy/base.rb

@@ -1,19 +1,15 @@
 class Lifer::URIStrategy::Base
-  attr_reader :directory
+  attr_reader :root
 
-  def initialize(directory:)
-    @directory = directory
+  def initialize(root:)
+    @root = root
   end
 
   def name
     raise NotImplementedError, "implement on a subclass"
   end
 
-  def dirname_for(entry)
-    raise NotImplementedError, "implement on a subclass"
-  end
-
-  def file_for(entry)
+  def output_file(entry)
     raise NotImplementedError, "implement on a subclass"
   end
 end

data/lib/lifer/uri_strategy/pretty.rb

@@ -0,0 +1,13 @@
+class Lifer::URIStrategy::Pretty < Lifer::URIStrategy::Base
+  def name
+    "pretty"
+  end
+
+  def output_file(entry)
+    basename = File.basename(entry.file, ".*")
+
+    Pathname entry.file.to_s
+      .gsub(/#{root}[\/]{0,1}/, "")
+      .gsub(/#{basename}(\..+)/, "#{basename}/index.html")
+  end
+end

data/lib/lifer/uri_strategy/simple.rb

@@ -1,23 +1,13 @@
 class Lifer::URIStrategy::Simple < Lifer::URIStrategy::Base
-  def name_for(entry)
-    File.basename(entry.file, ".*")
+  def name
+    "simple"
   end
 
-  def dirname_for(entry)
-    return nil if (path = entry.file.dirname.to_s) == directory.to_s
+  def output_file(entry)
+    basename = File.basename(entry.file, ".*")
 
-    Pathname entry.file.dirname.to_s.gsub(
-      /#{directory}[\/]{0,1}/,
-      ""
-    )
-  end
-
-  def file_for(entry)
-    Pathname(
-      [
-        dirname_for(entry),
-        ("%s.html" % name_for(entry))
-      ].compact.join("/")
-    )
+    Pathname entry.file.to_s
+      .gsub(/#{root}[\/]{0,1}/, "")
+      .gsub(/#{basename}(\..+)/, "#{basename}.html")
   end
 end

data/lib/lifer/uri_strategy.rb

@@ -1,4 +1,13 @@
-module Lifer::URIStrategy; end
+class Lifer::URIStrategy
+  class << self
+    def find_by_name(name)
+      self.const_get name.capitalize
+    rescue NameError => error
+      raise StandardError, "no URI strategy '#{name}'"
+    end
+  end
+end
 
 require_relative "uri_strategy/base"
+require_relative "uri_strategy/pretty"
 require_relative "uri_strategy/simple"

data/lifer.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Lifer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end
 
 Gem::Specification.new do |spec|
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Minimal static weblog generator."
   spec.description   = "Minimal static weblog generator. Good RSS feeds."
   spec.homepage      = "https://github.com/benjaminwil/lifer"
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -35,4 +35,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "kramdown", "~> 2.4"
+
+  spec.add_development_dependency "debug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - benjamin wil
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: debug
+  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'
 description: Minimal static weblog generator. Good RSS feeds.
 email:
 - benjamin@super.gd
@@ -33,7 +47,6 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
-- ".rspec"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -53,6 +66,7 @@ files:
 - lib/lifer/templates/layout.html.erb
 - lib/lifer/uri_strategy.rb
 - lib/lifer/uri_strategy/base.rb
+- lib/lifer/uri_strategy/pretty.rb
 - lib/lifer/uri_strategy/simple.rb
 - lib/lifer/utilities.rb
 - lifer.gemspec
@@ -71,14 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Minimal static weblog generator.

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper