dimples 10.5.1 → 10.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8184ca5d9bfa136040e8f3c8156113b4513609ea1b51deb5b5c158e8e1dff141
-  data.tar.gz: 10339f5e0e2a64aea876a0047594479361433637c7b7ac39283b8242044d416a
+  metadata.gz: 46c0d12cf89d7318ad1c0e9717a3389bc3b4033676206caddc8f31081975797a
+  data.tar.gz: ed93b72589065aa25a013624ffec85a17a24629b15188bf3f0a83cbac4c52904
 SHA512:
-  metadata.gz: b46cb1009cf405021d7fdd26a0183267c4cbd1c4221ea8c5cc004b5770fe6f0090dff1408aa06ffb1784da93c2a87565a3832c84e7f4ba5a9f5e2b7e26f53105
-  data.tar.gz: 74cf7f30146d038b2f137c47b35f965708105a7e69997a61e051e60caca9595085b0d0dfcc7bcc770c93cd71b04834995d4c21ac687fc9a6145f256fe64d18d7
+  metadata.gz: 8518ff8cc7c925122dbe8ca28c0775497068a15ed2bc8426cf5006591e988e52c26c35d2c7a31b2229cd3f95825e654b126133122dbeab65b7b056918f99788d
+  data.tar.gz: f1a58dc7294faec5b8e47547fccc07fea07225ba500cf509c55fcd84f0f4242757e27ebe2eb8d270de01218f53a14cc3d844ecb9181fccac631ba3d6089c93c4

data/lib/dimples/config.rb

@@ -3,7 +3,12 @@
 module Dimples
   # Configuration settings for a site.
   class Config
-    SOURCE_PATHS = { pages: 'pages', posts: 'posts', layouts: 'layouts', static: 'static' }.freeze
+    SOURCE_PATHS = {
+      pages: 'pages',
+      posts: 'posts',
+      layouts: 'layouts',
+      static: 'static'
+    }.freeze
 
     attr_accessor :source_paths, :build_paths, :site, :pagination, :generation
 
@@ -14,15 +19,27 @@ module Dimples
         pathnames: { posts: 'posts', categories: 'categories' },
         site: { name: nil, domain: nil },
         pagination: { page_prefix: 'page_', per_page: 5 },
-        generation: { api: false, main_feed: true, category_feeds: false }
+        generation: { main_feed: true, category_feeds: false }
       }
     end
 
     def initialize(options = {})
-      options = Config.defaults.merge(options)
+      options = Config.defaults.to_h do |key, value|
+        unless options[key].nil?
+          value = case options[key]
+                  when Hash
+                    value.merge!(options[key])
+                  else
+                    options[key]
+                  end
+        end
+
+        [key, 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])
+
       @site = options[:site]
       @pagination = options[:pagination]
       @generation = options[:generation]

data/lib/dimples/entry.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'pathname'
+
+module Dimples
+  # A class representing a dynamic source entry
+  class Entry
+    include Forwardable
+
+    FRONT_MATTER_PATTERN = /^(-{3}\n.*?\n?)^(-{3}*$\n?)/m
+
+    attr_accessor :path, :contents, :rendered_contents
+    attr_reader :metadata
+
+    def initialize(site:, source:)
+      @site = site
+
+      contents = case source
+                 when Pathname
+                   @path = File.expand_path(source)
+                   File.read(@path)
+                 when String
+                   source
+                 end
+
+      parse_metadata(contents)
+    end
+
+    def parse_metadata(contents)
+      metadata = default_metadata
+
+      matches = contents.match(FRONT_MATTER_PATTERN)
+      if matches
+        metadata.merge!(YAML.safe_load(matches[1], symbolize_names: true, permitted_classes: [Date]))
+        @contents = matches.post_match.strip
+      else
+        @contents = contents
+      end
+
+      @metadata = Metadata.new(metadata)
+    end
+
+    def generate(output_path: nil, context: {})
+      output_path = File.join(output_directory, @metadata[:filename]) if output_path.nil?
+      write(output_path: output_path, body: render(context: context))
+    end
+
+    def write(output_path:, body:)
+      parent_directory = File.dirname(output_path)
+
+      FileUtils.mkdir_p(parent_directory) unless File.directory?(parent_directory)
+      File.write(output_path, body)
+    end
+
+    def url
+      @url ||= output_directory.gsub(@site.config.build_paths[:root], '').tap do |url|
+        url.concat(@metadata[:filename]) unless @metadata[:filename] == 'index.html'
+      end
+    end
+
+    def render(context: {}, body: nil)
+      context[:site] ||= @site.metadata
+      context[:page] ||= @metadata
+
+      @rendered_contents = template.render(Metadata.new(context)) { body }
+
+      layout = @site.layouts[@metadata.layout.to_sym] if @metadata.layout
+      return @rendered_contents if layout.nil?
+
+      layout.render(context: context, body: @rendered_contents)
+    end
+
+    def output_directory
+      @output_directory ||= @site.config.build_paths[:root]
+    end
+
+    def template
+      @template ||= Tilt::ERBTemplate.new { @contents }
+    end
+
+    def to_h
+      @metadata.to_h.merge({ contents: contents })
+    end
+
+    def method_missing(method_name, *_args)
+      @metadata.send(method_name)
+    end
+
+    def respond_to_missing?(_method_name, _include_private = false)
+      true
+    end
+
+    private
+
+    def default_metadata
+      {
+        layout: nil,
+        filename: 'index.html'
+      }
+    end
+  end
+end

data/lib/dimples/layout.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Dimples
+  # A class for a single layout used on a site.
+  class Layout < Entry
+    def initialize(site:, path:)
+      super(site: site, source: Pathname.new(path))
+    end
+  end
+end

data/lib/dimples/page.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dimples
+  # A single page on a site.
+  class Page < Entry
+    def initialize(site:, path:)
+      super(site: site, source: Pathname.new(path))
+    end
+
+    def output_directory
+      @output_directory ||= File.dirname(@path).gsub(
+        @site.config.source_paths[:pages],
+        @site.config.build_paths[:root]
+      ).concat('/')
+    end
+
+    private
+
+    def default_metadata
+      super.merge!(layout: 'page')
+    end
+  end
+end

data/lib/dimples/pager.rb

@@ -7,8 +7,8 @@ module Dimples
 
     attr_reader :current_page, :previous_page, :next_page, :page_count
 
-    def self.paginate(site:, url:, posts:, context: {})
-      new(site: site, url: url, posts: posts).paginate(context: context)
+    def self.paginate(site:, url:, posts:, context: {}, &block)
+      new(site: site, url: url, posts: posts).paginate(context: context, &block)
     end
 
     def initialize(site:, url:, posts:)
@@ -27,10 +27,16 @@ module Dimples
       (1..@page_count).each do |index|
         step_to(index)
 
-        @site.layouts[:posts]&.write(
-          output_path: File.join(@site.config.build_paths[:root], current_page_url, 'index.html'),
-          context: context.merge(pagination: self.metadata, url: current_page_url)
+        output_directory = File.join(@site.config.build_paths[:root], current_page_url)
+
+        context.merge!(metadata, url: current_page_url)
+
+        @site.layouts[:posts]&.generate(
+          output_path: File.join(output_directory, 'index.html'),
+          context: context
         )
+
+        yield(output_directory, context) if block_given?
       end
     end
 
@@ -89,12 +95,14 @@ module Dimples
     def metadata
       {
         posts: posts_at(current_page),
-        current_page: @current_page,
-        page_count: @page_count,
-        post_count: @posts.count,
-        previous_page: @previous_page,
-        next_page: @next_page,
-        urls: urls
+        pagination: {
+          current_page: @current_page,
+          page_count: @page_count,
+          post_count: @posts.count,
+          previous_page: @previous_page,
+          next_page: @next_page,
+          urls: urls
+        }
       }
     end
   end

data/lib/dimples/post.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Dimples
+  # A page from a site with a date.
+  class Post < Entry
+    def initialize(site:, path:)
+      super(site: site, source: Pathname.new(path))
+    end
+
+    def output_directory
+      @output_directory ||= File.dirname(@path).gsub(
+        @site.config.source_paths[:posts],
+        @site.config.build_paths[:posts]
+      ).concat("/#{slug}/")
+    end
+
+    def slug
+      File.basename(@path, File.extname(@path))&.downcase
+    end
+
+    def template
+      @template ||= Tilt::RedcarpetTemplate.new { @contents }
+    end
+
+    def to_h
+      super.reject { |k, _| %i[filename layout].include?(k) }.tap do |output|
+        output[:date] = output[:date].iso8601 unless output[:date].nil?
+        output[:url] ||= url
+      end
+    end
+
+    private
+
+    def default_metadata
+      super.tap do |defaults|
+        defaults[:layout] = 'post'
+        defaults[:slug] = slug
+        defaults[:date] = File.birthtime(@path)
+        defaults[:categories] = []
+      end
+    end
+  end
+end

data/lib/dimples/site.rb

@@ -30,19 +30,19 @@ module Dimples
 
     def posts
       @posts ||= Dir.glob(File.join(@config.source_paths[:posts], '**', '*.markdown')).map do |path|
-        Dimples::Entries::Post.new(site: self, path: path)
+        Dimples::Post.new(site: self, path: path)
       end.sort_by! { |post| post.metadata[:date] }.reverse!
     end
 
     def pages
       @pages ||= Dir.glob(File.join(@config.source_paths[:pages], '**', '*.erb')).map do |path|
-        Dimples::Entries::Page.new(site: self, path: path)
+        Dimples::Page.new(site: self, path: path)
       end
     end
 
     def layouts
       @layouts ||= Dir.glob(File.join(@config.source_paths[:layouts], '**', '*.erb')).to_h do |path|
-        [File.basename(path, '.erb').to_sym, Dimples::Entries::Layout.new(site: self, path: path)]
+        [File.basename(path, '.erb').to_sym, Dimples::Layout.new(site: self, path: path)]
       end
     end
 
@@ -76,7 +76,7 @@ module Dimples
     end
 
     def generate_post(post)
-      post.write
+      post.generate
     end
 
     def generate_pages
@@ -84,7 +84,7 @@ module Dimples
     end
 
     def generate_page(page)
-      page.write
+      page.generate
     end
 
     def generate_categories
@@ -107,7 +107,7 @@ module Dimples
     def generate_feed(output_path:, posts:)
       return if layouts[:feed].nil?
 
-      layouts[:feed].write(
+      layouts[:feed].generate(
         output_path: File.join(output_path, 'feed.atom'),
         context: { posts: posts.slice(0, 10) }
       )

data/lib/dimples/version.rb

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

data/lib/dimples.rb

@@ -6,8 +6,7 @@ require 'dimples/config'
 require 'dimples/metadata'
 require 'dimples/pager'
 require 'dimples/site'
-
-require 'dimples/entries/base'
-require 'dimples/entries/page'
-require 'dimples/entries/post'
-require 'dimples/entries/layout'
+require 'dimples/entry'
+require 'dimples/page'
+require 'dimples/post'
+require 'dimples/layout'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 10.5.1
+  version: 10.6.0
 platform: ruby
 authors:
 - Daniel Bogan
@@ -62,12 +62,12 @@ files:
 - bin/dimples
 - lib/dimples.rb
 - lib/dimples/config.rb
-- lib/dimples/entries/base.rb
-- lib/dimples/entries/layout.rb
-- lib/dimples/entries/page.rb
-- lib/dimples/entries/post.rb
+- lib/dimples/entry.rb
+- lib/dimples/layout.rb
 - lib/dimples/metadata.rb
+- lib/dimples/page.rb
 - lib/dimples/pager.rb
+- lib/dimples/post.rb
 - lib/dimples/site.rb
 - lib/dimples/version.rb
 homepage: http://github.com/waferbaby/dimples

data/lib/dimples/entries/base.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-require 'pathname'
-
-module Dimples
-  module Entries
-    # A class representing a dynamic source entry
-    class Base
-      include Forwardable
-
-      FRONT_MATTER_PATTERN = /^(-{3}\n.*?\n?)^(-{3}*$\n?)/m
-
-      attr_accessor :path, :contents, :rendered_contents
-      attr_reader :metadata
-
-      def initialize(site:, source:)
-        @site = site
-
-        contents = case source
-                   when Pathname
-                     @path = File.expand_path(source)
-                     File.read(@path)
-                   when String
-                     source
-                   end
-
-        parse_metadata(contents)
-      end
-
-      def parse_metadata(contents)
-        metadata = default_metadata
-
-        matches = contents.match(FRONT_MATTER_PATTERN)
-        if matches
-          metadata.merge!(YAML.safe_load(matches[1], symbolize_names: true, permitted_classes: [Date]))
-          @contents = matches.post_match.strip
-        else
-          @contents = contents
-        end
-
-        @metadata = Metadata.new(metadata)
-      end
-
-      def write(output_path: nil, context: {})
-        output_path = File.join(output_directory, @metadata[:filename]) if output_path.nil?
-
-        parent_directory = File.dirname(output_path)
-        output = render(context: context)
-
-        FileUtils.mkdir_p(parent_directory) unless File.directory?(parent_directory)
-        File.write(output_path, output)
-      end
-
-      def render(context: {}, body: nil)
-        context[:site] ||= @site.metadata
-        context[:page] ||= @metadata
-
-        @rendered_contents = template.render(Metadata.new(context)) { body }
-
-        layout = @site.layouts[@metadata.layout.to_sym] if @metadata.layout
-        return @rendered_contents if layout.nil?
-
-        layout.render(context: context, body: @rendered_contents)
-      end
-
-      def output_directory
-        @output_directory ||= @site.config.build_paths[:root]
-      end
-
-      def template
-        @template ||= Tilt::ERBTemplate.new { @contents }
-      end
-
-      def method_missing(method_name, *_args)
-        @metadata.send(method_name)
-      end
-
-      def respond_to_missing?(method_name, include_private = false)
-        true
-      end
-
-      private
-
-      def default_metadata
-        {
-          layout: nil,
-          filename: 'index.html'
-        }
-      end
-    end
-  end
-end

data/lib/dimples/entries/layout.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Dimples
-  module Entries
-    # A class for a single layout used on a site.
-    class Layout < Base
-      def initialize(site:, path:)
-        super(site: site, source: Pathname.new(path))
-      end
-    end
-  end
-end

data/lib/dimples/entries/page.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Dimples
-  module Entries
-    # A single page on a site.
-    class Page < Base
-      def initialize(site:, path:)
-        super(site: site, source: Pathname.new(path))
-      end
-
-      def output_directory
-        @output_directory ||= File.dirname(@path).gsub(
-          @site.config.source_paths[:pages],
-          @site.config.build_paths[:root]
-        ).concat('/')
-      end
-
-      def url
-        output_directory.tap { |url| url.concat(filename) unless filename == 'index.html' }
-      end
-
-      private
-
-      def default_metadata
-        super.merge!(layout: 'page')
-      end
-    end
-  end
-end

data/lib/dimples/entries/post.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Dimples
-  module Entries
-    # A page from a site with a date.
-    class Post < Base
-      def initialize(site:, path:)
-        super(site: site, source: Pathname.new(path))
-      end
-
-      def output_directory
-        @output_directory ||= File.dirname(@path).gsub(
-          @site.config.source_paths[:posts],
-          @site.config.build_paths[:posts]
-        ).concat("/#{slug}/")
-      end
-
-      def slug
-        File.basename(@path, '.markdown')
-      end
-
-      def template
-        @template ||= Tilt::RedcarpetTemplate.new { @contents }
-      end
-
-      private
-
-      def default_metadata
-        super.tap do |defaults|
-          defaults[:layout] = 'post'
-          defaults[:slug] = slug
-          defaults[:date] = File.birthtime(@path)
-          defaults[:categories] = []
-        end
-      end
-    end
-  end
-end