dimples 10.7.2 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b348602f3096e0062a5bfe4a1a69c7396e28e06fb505b86e6f265418b31ae1e
-  data.tar.gz: 2335b720796fdbd545f0ca7813f720de50ad6cf39f6aabf9a624f26cf569707c
+  metadata.gz: 4c840b0dffbd13241c53322349b2d4d8cc27702fd24e23e634f8aa3c68ccb7ef
+  data.tar.gz: a84f8dd4b99af20ad44a60bc42e4155731ed34aadd245987552f105cbc744ad2
 SHA512:
-  metadata.gz: 907c0fec40c9bbd9f2b572021008f30cfa8e37a5c07a696eafdc9c7f4f45328e07ce05945be9806bc0df6dc9c67b090688a73918645df5b7d46390f10c9fc37b
-  data.tar.gz: 9ad1d9698bd51ca77010a172e4901887f919a724285b20b0e451f11d33742aada0442aacb66f3ecd6e338ab195794dab40773be208131744188171892d8099c8
+  metadata.gz: 81dfeb441b90d5861bb75353317e71f9e528a6d6008f221f65af1b5ab98529d0046afc0fdf4bcb2cbb7507d94546784dea360366e427a0394664cbecf19c8f7b
+  data.tar.gz: f66eaa19302fe7c177160fb935fdab210d6e6c02afbeee936ae80880b1a225de94c3432433cee4773b3d4667d111903aaf552d6e7c0955b8f5662e22b1e28209

data/bin/dimples

@@ -19,9 +19,9 @@ if File.exist?(config_path)
 end
 
 OptionParser.new do |parser|
-  parser.banner = "Usage: dimples [options]"
+  parser.banner = 'Usage: dimples [options]'
 
-  parser.on("-o [path]", "--output-path [path]", String, "The directory where your site will be generated") do |option|
+  parser.on('-o [path]', '--output-path [path]', String, 'The directory where your site will be generated') do |option|
     config[:build] = option unless option.nil?
   end
 end.parse!

data/lib/dimples/config.rb

@@ -6,7 +6,7 @@ module Dimples
     SOURCE_PATHS = {
       pages: 'pages',
       posts: 'posts',
-      layouts: 'layouts',
+      templates: 'templates',
       static: 'static'
     }.freeze
 

data/lib/dimples/context.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dimples
+  # Context used when rendering an item in a template
+  class Context
+    def self.from_hash(hash)
+      hash.transform_values! { |value| value.is_a?(Hash) ? Context.from_hash(value) : value }
+
+      Struct.new(*hash.keys) do |_klass|
+        def method_missing(_method_name, *_args)
+          nil
+        end
+
+        def respond_to_missing?(_method_name, _include_private = false)
+          true
+        end
+      end.new(*hash.values)
+    end
+  end
+end

data/lib/dimples/entry.rb

@@ -4,18 +4,15 @@ require 'forwardable'
 require 'pathname'
 
 module Dimples
-  # A class representing a dynamic source entry
+  # A class representing a dynamic source entry that can generate rendered content
   class Entry
-    include Forwardable
-
     FRONT_MATTER_PATTERN = /^(-{3}\n.*?\n?)^(-{3}*$\n?)/m
+    DEFAULT_FILENAME = 'index.html'
 
     attr_accessor :path, :contents, :rendered_contents
     attr_reader :metadata
 
-    def initialize(site:, source:)
-      @site = site
-
+    def initialize(source:)
       contents = case source
                  when Pathname
                    @path = File.expand_path(source)
@@ -28,79 +25,36 @@ module Dimples
     end
 
     def parse_metadata(contents)
-      metadata = default_metadata
+      @metadata = default_metadata
 
       matches = contents.match(FRONT_MATTER_PATTERN)
       if matches
-        metadata.merge!(YAML.safe_load(matches[1], symbolize_names: true, permitted_classes: [Date]))
+        @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, 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(filename) unless filename == 'index.html'
-      end
-    end
-
-    def render(context: {}, body: nil)
-      context[:site] ||= @site
-      context[:page] ||= self
-
-      @rendered_contents = template.render(
-        Object.new.tap do |render_context|
-          context.each do |key, value|
-            render_context.instance_variable_set("@#{key}", value)
-          end
-        end
-      ) { body }
-
-      template = @site.layouts[layout.to_sym] unless layout.nil?
-      return @rendered_contents if template.nil?
-
-      template.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 }
+    def render(context: nil)
+      contents
     end
 
     def method_missing(method_name, *_args)
-      method_sym = method_name.to_sym
-
-      @metadata.send(method_sym)
+      metadata[method_name.to_sym]
     end
 
     def respond_to_missing?(method_name, _include_private = false)
-      @metadata.respond_to?(method_name.to_sym) || super
+      metadata.key?(method_name.to_sym) || super
     end
 
     private
 
     def default_metadata
       {
+        date: @path ? File.birthtime(@path) : Time.now,
         layout: nil,
-        filename: 'index.html'
+        filename: DEFAULT_FILENAME
       }
     end
   end

data/lib/dimples/pager.rb

@@ -5,19 +5,21 @@ module Dimples
   class Pager
     include Enumerable
 
+    DEFAULT_PER_PAGE = 5
+
     attr_reader :current_page, :previous_page, :next_page, :page_count
 
-    def self.paginate(site:, url:, posts:, context: {}, &block)
-      new(site: site, url: url, posts: posts).paginate(context: context, &block)
+    def self.paginate(url:, posts:, per_page: DEFAULT_PER_PAGE, context: {}, &block)
+      new(url: url, posts: posts).paginate(context: context, &block)
     end
 
-    def initialize(site:, url:, posts:)
-      @site = site
+    def initialize(url:, posts:, per_page: DEFAULT_PER_PAGE)
       @url = url
+      @url << '/' unless @url[-1] == '/'
+
       @posts = posts
 
-      @per_page = @site.config.pagination[:per_page]
-      @page_prefix = @site.config.pagination[:page_prefix]
+      @per_page = per_page
       @page_count = (posts.length.to_f / @per_page.to_i).ceil
 
       step_to(1)
@@ -27,14 +29,7 @@ module Dimples
       (1..@page_count).each do |index|
         step_to(index)
 
-        output_directory = File.join(@site.config.build_paths[:root], current_page_path)
-
-        @site.layouts[:posts]&.generate(
-          output_path: File.join(output_directory, 'index.html'),
-          context: metadata.merge(context, url: current_page_url)
-        )
-
-        yield(output_directory, context) if block_given?
+        yield(current_page_path, context.merge(metadata)) if block_given?
       end
     end
 
@@ -63,7 +58,7 @@ module Dimples
     end
 
     def current_page_url
-      @current_page == 1 ? @url : "#{@url}#{@page_prefix}#{@current_page}"
+      @current_page == 1 ? @url : "#{@url}page_#{@current_page}"
     end
 
     def first_page_url
@@ -71,17 +66,17 @@ module Dimples
     end
 
     def last_page_url
-      @page_count == 1 ? @url : "#{@url}#{@page_prefix}#{@page_count}"
+      @page_count == 1 ? @url : "#{@url}page_#{@page_count}"
     end
 
     def previous_page_url
       return unless @previous_page
 
-      @previous_page == 1 ? @url : "#{@url}#{@page_prefix}#{@previous_page}"
+      @previous_page == 1 ? @url : "#{@url}page_#{@previous_page}"
     end
 
     def next_page_url
-      "#{@url}#{@page_prefix}#{@next_page}" if @next_page
+      "#{@url}page_#{@next_page}" if @next_page
     end
 
     def urls
@@ -97,14 +92,14 @@ module Dimples
     def metadata
       {
         posts: posts_at(current_page),
-        pagination: Metadata.new(
+        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

@@ -1,36 +1,34 @@
 # frozen_string_literal: true
 
 module Dimples
-  # A page from a site with a date.
+  # A single post for a site.
   class Post < Entry
-    def initialize(site:, path:)
-      super(site: site, source: Pathname.new(path))
+    @markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+
+    class << self
+      attr_reader :markdown
     end
 
-    def output_directory
-      @output_directory ||= File.dirname(@path).gsub(
-        @site.config.source_paths[:posts],
-        @site.config.build_paths[:posts]
-      ).concat("/#{slug}/")
+    def initialize(path:)
+      super(source: Pathname.new(path))
     end
 
     def slug
-      File.basename(@path, File.extname(@path))&.downcase
+      File.basename(path, File.extname(path))&.downcase
     end
 
-    def template
-      @template ||= Tilt::RedcarpetTemplate.new { @contents }
+    def render(context: nil)
+      Dimples::Post.markdown.render(contents)
     end
 
     private
 
     def default_metadata
-      super.tap do |defaults|
-        defaults[:layout] = 'post'
-        defaults[:slug] = slug
-        defaults[:date] = File.birthtime(@path)
-        defaults[:categories] = []
-      end
+      super.merge!(
+        layout: 'post',
+        slug: slug,
+        categories: []
+      )
     end
   end
 end

data/lib/dimples/site.rb

@@ -2,7 +2,7 @@
 
 require 'date'
 require 'fileutils'
-require 'tilt'
+require 'redcarpet'
 require 'yaml'
 
 module Dimples
@@ -29,20 +29,22 @@ module Dimples
     end
 
     def posts
-      @posts ||= Dir.glob(File.join(@config.source_paths[:posts], '**', '*.markdown')).map do |path|
-        Dimples::Post.new(site: self, path: path)
-      end.sort_by! { |post| post.date }.reverse!
+      @posts ||= source_files(path: :posts, extension: 'markdown').map do |path|
+        Dimples::Post.new(path: path)
+      end
+        .sort_by!(&:date)
+        .reverse!
     end
 
     def pages
-      @pages ||= Dir.glob(File.join(@config.source_paths[:pages], '**', '*.erb')).map do |path|
-        Dimples::Page.new(site: self, path: path)
+      @pages ||= source_files(path: :pages, extension: 'erb').map do |path|
+        Dimples::Template.new(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::Layout.new(site: self, path: path)]
+    def templates
+      @templates ||= source_files(path: :templates, extension: 'erb').to_h do |path|
+        [File.basename(path, '.erb').to_sym, Dimples::Template.new(path: path)]
       end
     end
 
@@ -59,20 +61,33 @@ module Dimples
 
     private
 
+    def source_files(path:, extension:)
+      Dir.glob(File.join(@config.source_paths[path], '**', "*.#{extension}"))
+    end
+
     def generate_posts
       posts.each { |post| generate_post(post) }
 
-      Pager.paginate(
-        site: self,
-        url: @config.build_paths[:posts].gsub(@config.build_paths[:root], '').concat('/'),
-        posts: posts
-      )
+      url = @config.build_paths[:posts].gsub(@config.build_paths[:root], '').concat('/')
+
+      Pager.paginate(url: url, posts: posts) do |url, page_context|
+        generate_entry(
+          entry: templates[:posts],
+          output_path: File.join(@config.build_paths[:root], url),
+          context: page_context
+        )
+      end
 
       generate_feed(output_path: @config.build_paths[:root], posts: posts) if @config.generation[:main_feed]
     end
 
     def generate_post(post)
-      post.generate
+      path = File.dirname(post.path).gsub(
+        @config.source_paths[:posts],
+        @config.build_paths[:posts]
+      ).concat("/#{post.slug}/")
+
+      generate_entry(entry: post, output_path: path)
     end
 
     def generate_pages
@@ -80,7 +95,12 @@ module Dimples
     end
 
     def generate_page(page)
-      page.generate
+      path = File.dirname(page.path).gsub(
+        @config.source_paths[:pages],
+        @config.build_paths[:root]
+      ).concat('/')
+
+      generate_entry(entry: page, output_path: path)
     end
 
     def generate_categories
@@ -88,11 +108,16 @@ module Dimples
         context = { title: category.capitalize, category: category }
 
         Pager.paginate(
-          site: self,
           url: "/categories/#{category}/",
           posts: posts,
           context: context
-        )
+        ) do |url, page_context|
+          generate_entry(
+            entry: templates[:posts],
+            output_path: File.join(@config.build_paths[:root], url),
+            context: page_context
+          )
+        end
 
         if @config.generation[:category_feeds]
           generate_feed(output_path: File.join(@config.build_paths[:root], 'categories', category), posts: posts)
@@ -101,14 +126,36 @@ module Dimples
     end
 
     def generate_feed(output_path:, posts:)
-      return if layouts[:feed].nil?
+      return if templates[:feed].nil?
 
-      layouts[:feed].generate(
-        output_path: File.join(output_path, 'feed.atom'),
+      generate_entry(
+        entry: templates[:feed],
+        output_path: output_path,
         context: { posts: posts.slice(0, 10) }
       )
     end
 
+    def generate_entry(entry:, output_path:, context: {})
+      unless context[:url]
+        url = output_path.gsub(@config.build_paths[:root], '')
+        url = File.join(url, entry.filename) unless entry.filename == Dimples::Entry::DEFAULT_FILENAME
+
+        context[:url] = url
+      end
+
+      context = { page: Context.from_hash(entry.metadata.merge(context)), site: self }
+      body = entry.contents
+      full_path = File.join(output_path, entry.filename)
+
+      until entry.nil?
+        body = entry.render(context: context) { body }
+        entry = templates[entry.layout&.to_sym]
+      end
+
+      FileUtils.mkdir_p(output_path) unless File.directory?(output_path)
+      File.write(full_path, body)
+    end
+
     def prepare_output_directory
       if Dir.exist?(@config.build_paths[:root])
         unless @config.generation[:overwrite_existing_site]

data/lib/dimples/template.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Dimples
+  # A class for a single ERB template file used on a site.
+  class Template < Entry
+    def initialize(path:)
+      super(source: Pathname.new(path))
+    end
+
+    def render(context:)
+      context.merge!(metadata)
+
+      context.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+
+      erb = ERB.new(contents)
+      erb.result(binding)
+    end
+  end
+end

data/lib/dimples/version.rb

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

data/lib/dimples.rb

@@ -3,10 +3,9 @@
 $LOAD_PATH.unshift(__dir__)
 
 require 'dimples/config'
-require 'dimples/metadata'
+require 'dimples/context'
 require 'dimples/pager'
 require 'dimples/site'
 require 'dimples/entry'
-require 'dimples/page'
+require 'dimples/template'
 require 'dimples/post'
-require 'dimples/layout'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 10.7.2
+  version: 11.0.0
 platform: ruby
 authors:
 - Daniel Bogan
@@ -37,20 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-- !ruby/object:Gem::Dependency
-  name: tilt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
 description: A simple tool for building static websites.
 email:
 - d+dimples@waferbaby.com
@@ -62,13 +48,12 @@ files:
 - bin/dimples
 - lib/dimples.rb
 - lib/dimples/config.rb
+- lib/dimples/context.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/template.rb
 - lib/dimples/version.rb
 homepage: http://github.com/waferbaby/dimples
 licenses:

data/lib/dimples/layout.rb

@@ -1,10 +0,0 @@
-# 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/metadata.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Dimples
-  # A tiny wrapper around metadata for rendering
-  class Metadata
-    def initialize(source)
-      source.each do |key, value|
-        self.class.send(:attr_reader, key)
-        instance_variable_set("@#{key}", value.is_a?(Hash) ? Metadata.new(value) : value)
-      end
-    end
-
-    def method_missing(_method_name, *_args)
-      nil
-    end
-
-    def respond_to_missing?(_method_name, _include_private = false)
-      true
-    end
-  end
-end

data/lib/dimples/page.rb

@@ -1,23 +0,0 @@
-# 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