dimples 10.3.0 → 10.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f3ed77ff3e3b22b7b6698da3a659a250346ef631049636bed41726c460a7fb2
-  data.tar.gz: e8b5e726056c2786c548a22e478ef9094517870b6eb86bef30464cff0d5ba918
+  metadata.gz: e6e1dd000f00d1a0c036bcc03a0d7b9523d7145de9c76ccd4128e39e95570a4c
+  data.tar.gz: 6d777e2d5fef15a5c48ea52403b8c2ee24e0c561b94c31a070ea4c7672a4d11c
 SHA512:
-  metadata.gz: 13ec6b697b2f9270abacb21836c515803b310398574d7fe7d4e57ba85fbc32e928268147bc96928efb0ea005344d7154fa55873c334829a9ef9e6d73d492d333
-  data.tar.gz: fcd634d9056027da441de34a1067a12f4e7122e54b164090a0fa48f396b3b622dec8d0165c3541b10990aba89dfacbc9768a181d07f45d876a95751e60eed5a0
+  metadata.gz: 197d162d903034d703c90835c1b088b59b3c4de5684df44139aa8fda92571f0455e741bf8b55ee8112d617eb2d22d1c02db025bd7d394ce8b4e99f4adab04239
+  data.tar.gz: ac6a8367a217c8be63dab2811ca3e7a189a3d9a53884b422edb80c3dd5562dd9029ef68bbaa1adb3d793526755724315f8ec7978207caa3c2e6c2c5f0548c0b3

data/bin/dimples

@@ -18,7 +18,7 @@ if File.exist?(config_path)
 end
 
 begin
-  Dimples::Site.generate(config:)
+  Dimples::Site.generate(config: config)
 rescue StandardError => e
   puts "Error generating site: #{e}"
 end

data/lib/dimples/config.rb

@@ -5,14 +5,16 @@ module Dimples
   class Config
     SOURCE_PATHS = { pages: 'pages', posts: 'posts', layouts: 'layouts', static: 'static' }.freeze
 
-    attr_accessor :source_paths, :build_paths, :pagination
+    attr_accessor :source_paths, :build_paths, :site, :pagination, :generation
 
     def self.defaults
       {
-        build: './site',
         source: Dir.pwd,
+        build: './site',
         pathnames: { posts: 'posts', categories: 'categories' },
-        pagination: { page_prefix: 'page_', per_page: 5 }
+        site: { name: nil, domain: nil },
+        pagination: { page_prefix: 'page_', per_page: 5 },
+        generation: { api: false, main_feed: true, category_feeds: false }
       }
     end
 
@@ -21,7 +23,9 @@ module Dimples
 
       @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]
     end
 
     def expand_paths(root, paths)

data/lib/dimples/entries/base.rb

@@ -0,0 +1,93 @@
+# 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/{sources → entries}/layout.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Dimples
-  module Sources
+  module Entries
     # A class for a single layout used on a site.
     class Layout < Base
-      def template
-        @template ||= Tilt::ERBTemplate.new { @contents }
+      def initialize(site:, path:)
+        super(site: site, source: Pathname.new(path))
       end
     end
   end

data/lib/dimples/{sources → entries}/page.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module Dimples
-  module Sources
+  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],
@@ -12,13 +16,7 @@ module Dimples
       end
 
       def url
-        super.tap do |url|
-          url.concat(filename) unless filename == 'index.html'
-        end
-      end
-
-      def template
-        @template ||= Tilt::ERBTemplate.new { @contents }
+        output_directory.tap { |url| url.concat(filename) unless filename == 'index.html' }
       end
 
       private

data/lib/dimples/{sources → entries}/post.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module Dimples
-  module Sources
+  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],
@@ -12,7 +16,7 @@ module Dimples
       end
 
       def slug
-        File.basename(@path)
+        File.basename(@path, '.markdown')
       end
 
       def template
@@ -24,7 +28,7 @@ module Dimples
       def default_metadata
         super.tap do |defaults|
           defaults[:layout] = 'post'
-          defaults[:slug] = File.basename(@path, '.markdown')
+          defaults[:slug] = slug
           defaults[:date] = File.birthtime(@path)
           defaults[:categories] = []
         end

data/lib/dimples/metadata.rb

@@ -1,9 +1,6 @@
-# frozen_string_literal: true
-
 module Dimples
-  # A class representing metadata passed into a template for rendering.
   class Metadata
-    attr_reader :keys
+    include Enumerable
 
     def initialize(source)
       source.each do |key, value|
@@ -11,9 +8,37 @@ module Dimples
         instance_variable_set("@#{key}", build(value))
       end
 
-      @keys = source.keys
+      @data = source
+    end
+
+    def keys
+      @data.keys
     end
 
+    def [](key)
+      @data[key]
+    end
+
+    def each(&block)
+      @data.each(&block)
+    end
+
+    def each_key(&block)
+      @data.keys.each(&block)
+    end
+
+    def method_missing(method_name, *_args)
+      return @data[method_name] if @data.key?(method_name)
+
+      nil
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @data.key?(method_name) || super
+    end
+
+    private
+
     def build(item)
       case item
       when Array
@@ -24,13 +49,5 @@ module Dimples
         item
       end
     end
-
-    def method_missing(_method_name, *_args)
-      nil
-    end
-
-    def respond_to_missing?(_method_name, _include_private)
-      true
-    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:, metadata: {})
-      new(site:, url:, posts:).paginate(metadata)
+    def self.paginate(site:, url:, posts:, context: {})
+      new(site: site, url: url, posts: posts).paginate(context: context)
     end
 
     def initialize(site:, url:, posts:)
@@ -23,13 +23,13 @@ module Dimples
       step_to(1)
     end
 
-    def paginate(metadata)
+    def paginate(context: {})
       (1..@page_count).each do |index|
         step_to(index)
 
-        @site.layouts['posts']&.write(
+        @site.layouts[:posts]&.write(
           output_path: File.join(@site.config.build_paths[:root], current_page_url, 'index.html'),
-          metadata: metadata.merge(pagination: self.metadata, url: current_page_url)
+          context: context.merge(pagination: self.metadata, url: current_page_url)
         )
       end
     end

data/lib/dimples/site.rb

@@ -11,7 +11,7 @@ module Dimples
     attr_accessor :config
 
     def self.generate(config: {})
-      new(config:).generate
+      new(config: config).generate
     end
 
     def initialize(config: {})
@@ -30,26 +30,26 @@ module Dimples
 
     def posts
       @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!
+        Dimples::Entries::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::Sources::Page.new(site: self, path:)
+        Dimples::Entries::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'), Dimples::Sources::Layout.new(site: self, path:)]
+        [File.basename(path, '.erb').to_sym, Dimples::Entries::Layout.new(site: self, path: path)]
       end
     end
 
     def categories
       @categories ||= {}.tap do |categories|
         posts.each do |post|
-          post.categories.each do |category|
+          post.metadata[:categories].each do |category|
             categories[category] ||= []
             categories[category].append(post)
           end
@@ -69,10 +69,10 @@ module Dimples
       Pager.paginate(
         site: self,
         url: @config.build_paths[:posts].gsub(@config.build_paths[:root], '').concat('/'),
-        posts:
+        posts: posts
       )
 
-      generate_feed(output_path: @config.build_paths[:root], posts:)
+      generate_feed(output_path: @config.build_paths[:root], posts: posts) if @config.generation[:main_feed]
     end
 
     def generate_post(post)
@@ -89,16 +89,18 @@ module Dimples
 
     def generate_categories
       categories.each do |category, posts|
-        metadata = { title: category.capitalize, category: category }
+        context = { title: category.capitalize, category: category }
 
         Pager.paginate(
           site: self,
           url: "/categories/#{category}/",
-          posts:,
-          metadata:
+          posts: posts,
+          context: context
         )
 
-        generate_feed(output_path: File.join(@config.build_paths[:root], 'categories', category), posts:)
+        if @config.generation[:category_feeds]
+          generate_feed(output_path: File.join(@config.build_paths[:root], 'categories', category), posts: posts)
+        end
       end
     end
 
@@ -107,7 +109,7 @@ module Dimples
 
       layouts['feed'].write(
         output_path: File.join(output_path, 'feed.atom'),
-        metadata: { posts: posts.slice(0, 10) }
+        context: { posts: posts.slice(0, 10) }
       )
     end
 

data/lib/dimples/version.rb

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

data/lib/dimples.rb

@@ -7,7 +7,7 @@ require 'dimples/metadata'
 require 'dimples/pager'
 require 'dimples/site'
 
-require 'dimples/sources/base'
-require 'dimples/sources/page'
-require 'dimples/sources/post'
-require 'dimples/sources/layout'
+require 'dimples/entries/base'
+require 'dimples/entries/page'
+require 'dimples/entries/post'
+require 'dimples/entries/layout'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 10.3.0
+  version: 10.5.0
 platform: ruby
 authors:
 - Daniel Bogan
@@ -62,13 +62,13 @@ 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/metadata.rb
 - lib/dimples/pager.rb
 - lib/dimples/site.rb
-- lib/dimples/sources/base.rb
-- lib/dimples/sources/layout.rb
-- lib/dimples/sources/page.rb
-- lib/dimples/sources/post.rb
 - lib/dimples/version.rb
 homepage: http://github.com/waferbaby/dimples
 licenses:

data/lib/dimples/sources/base.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Dimples
-  module Sources
-    # A base class representing a source file with frontmatter metadata that can be rendered.
-    class Base
-      FRONT_MATTER_PATTERN = /^(-{3}\n.*?\n?)^(-{3}*$\n?)/m
-
-      attr_accessor :path, :metadata, :contents
-
-      def initialize(site:, path:)
-        @site = site
-        @path = File.expand_path(path)
-        @contents = File.read(@path)
-
-        parse_metadata(@contents)
-      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
-
-        @metadata.each_key do |key|
-          self.class.send(:define_method, key.to_sym) { @metadata[key] }
-        end
-      end
-
-      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(context: metadata)
-
-        FileUtils.mkdir_p(output_dir) unless File.directory?(output_dir)
-        File.write(output_path, output)
-      end
-
-      def render(context: {}, body: nil)
-        context[:site] ||= @site.metadata
-        context[:page] ||= metadata
-
-        output = template.render(Metadata.new(context)) { body }
-        return output unless @metadata[:layout] && @site.layouts[@metadata[:layout]]
-
-        @site.layouts[@metadata[:layout]].render(context:, body: output)
-      end
-
-      def output_directory
-        @site.config.build_paths[:root]
-      end
-
-      def url_for(path)
-        path.gsub(@site.config.build_paths[:root], '').concat('/')
-      end
-
-      def template
-        raise NotImplementedError, 'You must set a Tilt template for this class.'
-      end
-
-      private
-
-      def default_metadata
-        {
-          layout: nil,
-          filename: 'index.html'
-        }
-      end
-    end
-  end
-end