dimples 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a2db6d510cc724696cd9255569144515c7ad9afd10b4a6da596f50f492d4f9
-  data.tar.gz: f55f43d79d5137c22ccea11e27c50be6de043ee794f3d3ae3ea212508da6bebb
+  metadata.gz: 6b63753932d375ea07672f810b718d628711fcfea4eca7903d4f42816eda0f48
+  data.tar.gz: 5ccf23b0581915612adb9b7c4a6d045c2e0316b8d43cb58b764e16a40ffa0413
 SHA512:
-  metadata.gz: c86532b5690b9bc411d18357101799fe3e6e9c0a2c33ef9fabc2f3975b3fa9551cb45ae97768dcd96a6b0ec7388ceaba4bcdf0dc5a40b3a800ce10b3878c3085
-  data.tar.gz: 815be09d293fba723038a6fb0bbc6123434e03b34bdd7aa52438f276b234ea9e52cf661c2efa0c1120d72533c2149a81b2e5f8a87381ba1f666108b9166ed566
+  metadata.gz: 3647f33e23be41293053ba18653debd6388b7419011a56462a1aecd448ec1d908e9c66ac893136ed26e1b05630d1c14e0370aba31b0da2285a5056258aa6997e
+  data.tar.gz: c183aa6bce34f42eefd0620a4e290ce85893969ddcb30656b3b5443ec29a93e9da1013e9ddcd370f673fee5a00410e94619003a8fb234d0bf7f428ccc78b300e

data/lib/dimples/category.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A single post category for a site.
   class Category
     attr_accessor :name
     attr_accessor :slug

data/lib/dimples/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # Default configuration options for a site.
   module Configuration
     def self.defaults
       {
@@ -11,7 +12,7 @@ module Dimples
         date_formats: default_date_formats,
         feed_formats: default_feed_formats,
         category_names: {},
-        rendering: {},
+        rendering: {}
       }
     end
 
@@ -32,7 +33,7 @@ module Dimples
         day_archives: true,
         categories: true,
         main_feed: true,
-        category_feeds: true,
+        category_feeds: true
       }
     end
 

data/lib/dimples/frontable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # Adds the ability to read frontmatter from a file.
   module Frontable
     def read_with_front_matter(path)
       contents = File.read(path)

data/lib/dimples/page.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A single page on a site.
   class Page
     include Frontable
 

data/lib/dimples/pager.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A paginated collection of posts that can be walked forward or backwards.
   class Pager
     include Enumerable
 

data/lib/dimples/plugin.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A Ruby class that can receive events from Dimples as a site is processed.
   class Plugin
     EVENTS = %i[
-      post_write
-      page_write
+      before_site_generation
+      after_site_generation
+      before_post_write
+      before_page_write
+      after_post_write
+      after_page_write
     ].freeze
 
     def self.inherited(subclass)
@@ -15,12 +20,10 @@ module Dimples
       @plugins ||= @subclasses&.map { |subclass| subclass.new(site) }
     end
 
-    def self.process(site, event, item, &block)
+    def self.send_event(site, event, item = nil)
       plugins(site)&.each do |plugin|
-        plugin.process(event, item, &block) if plugin.supports_event?(event)
+        plugin.process(event, item) if plugin.supports_event?(event)
       end
-
-      yield if block_given?
     end
 
     def initialize(site)

data/lib/dimples/post.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A single dated post on a site.
   class Post < Page
     POST_FILENAME = /(\d{4})-(\d{2})-(\d{2})-(.+)/
 

data/lib/dimples/renderer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A wrapper around Tilt, tied to a single post, page or template.
   class Renderer
     def initialize(site, source)
       @site = site
@@ -14,7 +15,10 @@ module Dimples
       output = engine.render(scope, context) { body }.strip
       @source.metadata[:rendered_contents] = output
 
-      template = @site.templates[@source.metadata[:layout]]
+      if @source.metadata[:layout]
+        template = @site.templates[@source.metadata[:layout]]
+      end
+
       return output if template.nil?
 
       template.render(context, output)

data/lib/dimples/site.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A collection of pages, posts and templates that can generate a website.
   class Site
     attr_reader :config
     attr_reader :categories
@@ -28,6 +29,8 @@ module Dimples
     end
 
     def generate
+      trigger_event(:before_site_generation)
+
       prepare
 
       read_templates
@@ -41,6 +44,8 @@ module Dimples
       publish_pages
       publish_archives
       publish_categories if @config.generation.categories
+
+      trigger_event(:after_site_generation)
     rescue PublishingError, RenderingError, GenerationError => error
       @errors << error
     end
@@ -128,15 +133,17 @@ module Dimples
 
     def publish_posts
       @posts.each do |post|
-        Plugin.process(self, :post_write, post) do
-          path = File.join(
-            @paths[:output],
-            post.date.strftime(@config.paths.posts),
-            post.slug
-          )
-
-          post.write(path)
-        end
+        trigger_event(:before_post_write, post)
+
+        path = File.join(
+          @paths[:output],
+          post.date.strftime(@config.paths.posts),
+          post.slug
+        )
+
+        post.write(path)
+
+        trigger_event(:after_post_write, post)
       end
 
       publish_feeds(@posts, @paths[:output]) if @config.generation.main_feed
@@ -144,18 +151,20 @@ module Dimples
 
     def publish_pages
       @pages.each do |page|
-        Plugin.process(self, :page_write, page) do
-          path = if page.path
-                   File.dirname(page.path).sub(
-                     @paths[:sources][:pages],
-                     @paths[:output]
-                   )
-                 else
+        trigger_event(:before_page_write, page)
+
+        path = if page.path
+                 File.dirname(page.path).sub(
+                   @paths[:sources][:pages],
                    @paths[:output]
-                 end
+                 )
+               else
+                 @paths[:output]
+               end
 
-          page.write(path)
-        end
+        page.write(path)
+
+        trigger_event(:after_page_write, page)
       end
     end
 
@@ -270,5 +279,9 @@ module Dimples
     def archive_day(year, month, day)
       @archives[:day]["#{year}-#{month}-#{day}"] ||= []
     end
+
+    def trigger_event(event, item = nil)
+      Plugin.send_event(self, event, item)
+    end
   end
 end

data/lib/dimples/template.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Dimples
+  # A single template used when rendering pages, posts and other templates.
   class Template
     include Frontable
 

data/lib/dimples/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie