dimples 10.1.4 → 10.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc9b0a5d7daa298ddcb448b6c01a87cb523f93476073e3b5fc96ae990ae315e3
-  data.tar.gz: 35b8c6c8794af46c60d79594d63b79eff43323b488db487451d30a203b4610e3
+  metadata.gz: 2f3ed77ff3e3b22b7b6698da3a659a250346ef631049636bed41726c460a7fb2
+  data.tar.gz: e8b5e726056c2786c548a22e478ef9094517870b6eb86bef30464cff0d5ba918
 SHA512:
-  metadata.gz: 6130823fd14607307d064fe8a38b6e9ad9afc98c95390ecc32fea62597159f7ff308b74b4b0d09905e85c57b1b13a23c5822f931d8236da223b0f321d41b1a61
-  data.tar.gz: 2746165d1e77dbf494e33126cf64718a1d7ec6781e789996453ec03655a8c3915ecb1e30ead8475d5d8722dae9c47a35adcb36d8b6000eefa0ccd17d1394f21f
+  metadata.gz: 13ec6b697b2f9270abacb21836c515803b310398574d7fe7d4e57ba85fbc32e928268147bc96928efb0ea005344d7154fa55873c334829a9ef9e6d73d492d333
+  data.tar.gz: fcd634d9056027da441de34a1067a12f4e7122e54b164090a0fa48f396b3b622dec8d0165c3541b10990aba89dfacbc9768a181d07f45d876a95751e60eed5a0

data/bin/dimples

@@ -12,15 +12,13 @@ config = {}
 if File.exist?(config_path)
   config = begin
     YAML.safe_load_file(config_path, symbolize_names: true)
-  rescue YAML::Error
-    puts 'Failed to parse config - using defaults'
-  ensure
-    {}
+  rescue StandardError => e
+    puts "Failed to parse config #{e} - using defaults"
   end
 end
 
 begin
-  Dimples::Site.generate(config)
+  Dimples::Site.generate(config:)
 rescue StandardError => e
   puts "Error generating site: #{e}"
 end

data/lib/dimples/config.rb

@@ -3,31 +3,32 @@
 module Dimples
   # Configuration settings for a site.
   class Config
+    SOURCE_PATHS = { pages: 'pages', posts: 'posts', layouts: 'layouts', static: 'static' }.freeze
+
+    attr_accessor :source_paths, :build_paths, :pagination
+
     def self.defaults
       {
-        sources: { root: '.', posts: './posts', pages: './pages', layouts: './layouts', static: './static' },
-        output: { root: './site', posts: './site/posts', categories: './site/categories' }
+        build: './site',
+        source: Dir.pwd,
+        pathnames: { posts: 'posts', categories: 'categories' },
+        pagination: { page_prefix: 'page_', per_page: 5 }
       }
     end
 
     def initialize(options = {})
-      @options = Config.defaults
+      options = Config.defaults.merge(options)
 
-      options&.each do |key, value|
-        @options[key]&.merge!(value)
-      end
-
-      %i[sources output].each do |type|
-        @options[type].each { |key, value| @options[type][key] = File.expand_path(value) }
-      end
+      @source_paths = expand_paths(File.expand_path(options[:source]), SOURCE_PATHS.dup)
+      @build_paths = expand_paths(File.expand_path(options[:build]), options[:pathnames])
+      @pagination = options[:pagination]
     end
 
-    def dig(*args)
-      @options.dig(*args)
-    end
+    def expand_paths(root, paths)
+      root = File.expand_path(root)
 
-    def [](key)
-      @options[key]
+      paths.transform_values! { |value| File.expand_path(File.join(root, value)) }
+      paths.tap { |expanded_paths| expanded_paths[:root] = root }
     end
   end
 end

data/lib/dimples/pager.rb

@@ -3,23 +3,21 @@
 module Dimples
   # A class for paginating a collection of posts.
   class Pager
-    PER_PAGE = 5
-
     include Enumerable
 
     attr_reader :current_page, :previous_page, :next_page, :page_count
 
-    def self.paginate(site, url, posts, metadata = {})
-      new(site, url, posts).paginate(metadata)
+    def self.paginate(site:, url:, posts:, metadata: {})
+      new(site:, url:, posts:).paginate(metadata)
     end
 
-    def initialize(site, url, posts)
+    def initialize(site:, url:, posts:)
       @site = site
       @url = url
       @posts = posts
 
-      @per_page = @site.config.dig(:pagination, :per_page) || PER_PAGE
-      @page_prefix = @site.config.dig(:pagination, :page_prefix) || 'page_'
+      @per_page = @site.config.pagination[:per_page]
+      @page_prefix = @site.config.pagination[:page_prefix]
       @page_count = (posts.length.to_f / @per_page.to_i).ceil
 
       step_to(1)
@@ -30,8 +28,8 @@ module Dimples
         step_to(index)
 
         @site.layouts['posts']&.write(
-          File.join(@site.config[:output][:root], current_page_url, 'index.html'),
-          metadata.merge(pagination: self.metadata, url: current_page_url)
+          output_path: File.join(@site.config.build_paths[:root], current_page_url, 'index.html'),
+          metadata: metadata.merge(pagination: self.metadata, url: current_page_url)
         )
       end
     end

data/lib/dimples/site.rb

@@ -10,11 +10,11 @@ module Dimples
   class Site
     attr_accessor :config
 
-    def self.generate(config = {})
-      new(config).generate
+    def self.generate(config: {})
+      new(config:).generate
     end
 
-    def initialize(config = {})
+    def initialize(config: {})
       @config = Config.new(config)
     end
 
@@ -29,20 +29,20 @@ module Dimples
     end
 
     def posts
-      @posts ||= Dir.glob(File.join(@config[:sources][:posts], '**', '*.markdown')).map do |path|
-        Dimples::Sources::Post.new(self, path)
+      @posts ||= Dir.glob(File.join(@config.source_paths[:posts], '**', '*.markdown')).map do |path|
+        Dimples::Sources::Post.new(site: self, path:)
       end.sort_by!(&:date).reverse!
     end
 
     def pages
-      @pages ||= Dir.glob(File.join(@config[:sources][:pages], '**', '*.erb')).map do |path|
-        Dimples::Sources::Page.new(self, path)
+      @pages ||= Dir.glob(File.join(@config.source_paths[:pages], '**', '*.erb')).map do |path|
+        Dimples::Sources::Page.new(site: self, path:)
       end
     end
 
     def layouts
-      @layouts ||= Dir.glob(File.join(@config[:sources][:layouts], '**', '*.erb')).to_h do |path|
-        [File.basename(path, '.erb'), Dimples::Sources::Layout.new(self, path)]
+      @layouts ||= Dir.glob(File.join(@config.source_paths[:layouts], '**', '*.erb')).to_h do |path|
+        [File.basename(path, '.erb'), Dimples::Sources::Layout.new(site: self, path:)]
       end
     end
 
@@ -64,42 +64,65 @@ module Dimples
     private
 
     def generate_posts
-      posts.each(&:write)
-      Pager.paginate(self, @config[:output][:posts].gsub(@config[:output][:root], '').concat('/'), posts)
-      generate_feed(@config[:output][:root], posts)
+      posts.each { |post| generate_post(post) }
+
+      Pager.paginate(
+        site: self,
+        url: @config.build_paths[:posts].gsub(@config.build_paths[:root], '').concat('/'),
+        posts:
+      )
+
+      generate_feed(output_path: @config.build_paths[:root], posts:)
+    end
+
+    def generate_post(post)
+      post.write
+    end
+
+    def generate_pages
+      pages.each { |page| generate_page(page) }
+    end
+
+    def generate_page(page)
+      page.write
     end
 
     def generate_categories
       categories.each do |category, posts|
         metadata = { title: category.capitalize, category: category }
-        Pager.paginate(self, "/categories/#{category}/", posts, metadata)
-        generate_feed(File.join(@config[:output][:root], 'categories', category), posts)
-      end
-    end
 
-    def generate_pages
-      pages.each(&:write)
+        Pager.paginate(
+          site: self,
+          url: "/categories/#{category}/",
+          posts:,
+          metadata:
+        )
+
+        generate_feed(output_path: File.join(@config.build_paths[:root], 'categories', category), posts:)
+      end
     end
 
-    def generate_feed(output_path, posts)
+    def generate_feed(output_path:, posts:)
       return if layouts['feed'].nil?
 
       layouts['feed'].write(
-        File.join(output_path, 'feed.atom'),
-        posts: posts.slice(0, 10)
+        output_path: File.join(output_path, 'feed.atom'),
+        metadata: { posts: posts.slice(0, 10) }
       )
     end
 
     def prepare_output_directory
-      raise "The site directory (#{@config[:output][:root]}) already exists." if Dir.exist?(@config[:output][:root])
+      if Dir.exist?(@config.build_paths[:root])
+        raise "The site directory (#{@config.build_paths[:root]}) already exists."
+      end
 
-      Dir.mkdir(@config[:output][:root])
+      Dir.mkdir(@config.build_paths[:root])
     end
 
     def copy_assets
-      return unless Dir.exist?(@config[:sources][:static])
+      return unless Dir.exist?(@config.source_paths[:static])
 
-      FileUtils.cp_r(File.join(@config[:sources][:static], '.'), @config[:output][:root])
+      FileUtils.cp_r(File.join(@config.source_paths[:static], '.'), @config.build_paths[:root])
     end
   end
 end

data/lib/dimples/sources/base.rb

@@ -8,59 +8,56 @@ module Dimples
 
       attr_accessor :path, :metadata, :contents
 
-      def initialize(site, path)
+      def initialize(site:, path:)
         @site = site
         @path = File.expand_path(path)
-
-        @metadata = default_metadata
         @contents = File.read(@path)
 
         parse_metadata(@contents)
-        assign_metadata
       end
 
       def parse_metadata(contents)
+        @metadata = default_metadata
+
         matches = contents.match(FRONT_MATTER_PATTERN)
         return unless matches
 
         @metadata.merge!(YAML.safe_load(matches[1], symbolize_names: true, permitted_classes: [Date]))
         @contents = matches.post_match.strip
-      end
 
-      def assign_metadata
         @metadata.each_key do |key|
           self.class.send(:define_method, key.to_sym) { @metadata[key] }
         end
       end
 
-      def write(output_path = nil, metadata = {})
+      def write(output_path: nil, metadata: {})
         output_path = File.join(output_directory, filename) if output_path.nil?
         output_dir = File.dirname(output_path)
 
         @metadata[:url] = url_for(output_dir)
 
-        output = render(metadata)
+        output = render(context: metadata)
 
         FileUtils.mkdir_p(output_dir) unless File.directory?(output_dir)
         File.write(output_path, output)
       end
 
-      def render(render_metadata = {}, body = nil)
-        render_metadata[:site] ||= @site.metadata
-        render_metadata[:page] ||= metadata
+      def render(context: {}, body: nil)
+        context[:site] ||= @site.metadata
+        context[:page] ||= metadata
 
-        output = template.render(Metadata.new(render_metadata)) { body }
+        output = template.render(Metadata.new(context)) { body }
         return output unless @metadata[:layout] && @site.layouts[@metadata[:layout]]
 
-        @site.layouts[@metadata[:layout]].render(render_metadata, output)
+        @site.layouts[@metadata[:layout]].render(context:, body: output)
       end
 
       def output_directory
-        @site.config[:output][:root]
+        @site.config.build_paths[:root]
       end
 
       def url_for(path)
-        path.gsub(@site.config[:output][:root], '').concat('/')
+        path.gsub(@site.config.build_paths[:root], '').concat('/')
       end
 
       def template

data/lib/dimples/sources/page.rb

@@ -6,8 +6,8 @@ module Dimples
     class Page < Base
       def output_directory
         @output_directory ||= File.dirname(@path).gsub(
-          @site.config[:sources][:pages],
-          @site.config[:output][:root]
+          @site.config.source_paths[:pages],
+          @site.config.build_paths[:root]
         ).concat('/')
       end
 

data/lib/dimples/sources/post.rb

@@ -6,8 +6,8 @@ module Dimples
     class Post < Base
       def output_directory
         @output_directory ||= File.dirname(@path).gsub(
-          @site.config[:sources][:posts],
-          @site.config[:output][:posts]
+          @site.config.source_paths[:posts],
+          @site.config.build_paths[:posts]
         ).concat("/#{slug}/")
       end
 

data/lib/dimples/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dimples
-  VERSION = '10.1.4'
+  VERSION = '10.3.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 10.1.4
+  version: 10.3.0
 platform: ruby
 authors:
 - Daniel Bogan
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb
@@ -76,7 +75,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A basic static site generator
 test_files: []