dimples 7.0.5 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da59c665968b9f7d4c40af3ad3421f7bae8e319de9353f46eaad74600e149e87
-  data.tar.gz: f3a90cf2758800302ebc2d702c546aab3f6767088f2c92c6940df451f7672f70
+  metadata.gz: 119a5b996b99fd1cf525e2928fcee146d226463d589d0c90cc8fc35234556006
+  data.tar.gz: 7556145973db1abb0245c1684b600b162000806d13bd7a4074740f41b8581d52
 SHA512:
-  metadata.gz: 8cc825ba69a5af811de58ab4161b31aaadf87e896fa1def74888e3d42fd22064a27b6eb83424e0c3ee0537817d81f92b8986b4164d636d34b0fd417fb98174a6
-  data.tar.gz: a4afd50dd8bcebab7432214d931cba1384ce62a075901ccdb5f357a95a30a97c11b9bef6f40c6b11063b2e0d342cb5e992c863107d122a619f09554bcb7b0824
+  metadata.gz: 9f33146ac6dde0b55514b55e7abe3c39bb70c6d5c9d23faf1bf043ec9d16047c0b795b28693a00d0c570e42a6491e566043e4f0cc5a30fd8af502917e19b2f1b
+  data.tar.gz: a6199859fa63efa39d2d4b772e2836b539ccc86c54b3a435fd791b9a97c90f6271f42e6020254cac735a159bfadc80f2c88d97b15dc4c2cdeca91e7054466256

data/bin/dimples

@@ -1,14 +1,27 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift(File.join(__dir__, "..", "lib"))
 
-require 'dimples'
+require "dimples"
 
-path = if ARGV[0]
-         File.expand_path(ARGV[0])
-       else
-         File.join(Dir.pwd, 'site')
-       end
+source_path = ARGV[0]
+output_path = ARGV[1]
 
-Dimples::Site.generate(path)
+config_path = File.join(Dir.pwd, "config.yml")
+
+config = {}
+
+if File.exist?(config_path)
+  begin
+    config = YAML.safe_load(File.read(config_path), symbolize_names: true)
+  rescue YAML::Error
+    puts "Error reading config file - reverting to defaults"
+  end
+end
+
+begin
+  Dimples::Site.generate(source_path, output_path, config)
+rescue Dimples::Error => error
+  puts "Error: #{error.message}"
+end

data/lib/dimples/document.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'frontmatter'
+require_relative "frontmatter"
 
 module Dimples
   class Document
@@ -13,7 +13,7 @@ module Dimples
         @metadata, @contents = Dimples::FrontMatter.parse(File.read(path))
       else
         @metadata = {}
-        @contents = ''
+        @contents = ""
       end
 
       @metadata.merge!(metadata)
@@ -24,18 +24,18 @@ module Dimples
     end
 
     def basename
-      @metadata.fetch(:filename, 'index')
+      @metadata.fetch(:filename, "index")
     end
 
     def extension
-      @metadata.fetch(:extension, 'html')
+      @metadata.fetch(:extension, "html")
     end
 
     def layout
       @metadata.fetch(:layout, nil)
     end
 
-    def render(context = {}, content = '')
+    def render(context = {}, content = "")
       context_obj = Object.new
       context.each do |key, value|
         context_obj.instance_variable_set("@#{key}", value)

data/lib/dimples/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Dimples
+  class Error < StandardError
+  end
+
+  class GenerationError < Error
+  end
+
+  class RenderingError < Error
+  end
+end

data/lib/dimples/frontmatter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'yaml'
+require "yaml"
 
 module Dimples
   module FrontMatter

data/lib/dimples/page.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'document'
+require_relative "document"
 
 module Dimples
   class Page < Document

data/lib/dimples/pager.rb

@@ -12,7 +12,7 @@ module Dimples
       @url = url
       @posts = posts
       @per_page = options.fetch(:per_page, PER_PAGE)
-      @page_prefix = options.fetch(:page_prefix, 'page_')
+      @page_prefix = options.fetch(:page_prefix, "page_")
       @page_count = (posts.length.to_f / @per_page.to_i).ceil
 
       step_to(1)
@@ -43,7 +43,7 @@ module Dimples
     end
 
     def current_page_url
-      @current_page != 1 ? "#{@url}#{@page_prefix}#{@current_page}" : @url
+      (@current_page != 1) ? "#{@url}#{@page_prefix}#{@current_page}" : @url
     end
 
     def first_page_url
@@ -51,13 +51,13 @@ module Dimples
     end
 
     def last_page_url
-      @page_count != 1 ? "#{@url}#{@page_prefix}#{@page_count}" : @url
+      (@page_count != 1) ? "#{@url}#{@page_prefix}#{@page_count}" : @url
     end
 
     def previous_page_url
       return unless @previous_page
 
-      @previous_page != 1 ? "#{@url}#{@page_prefix}#{@previous_page}" : @url
+      (@previous_page != 1) ? "#{@url}#{@page_prefix}#{@previous_page}" : @url
     end
 
     def next_page_url

data/lib/dimples/post.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'document'
+require_relative "document"
 
-require 'date'
+require "date"
 
 module Dimples
   class Post < Document
@@ -11,11 +11,11 @@ module Dimples
     end
 
     def layout
-      @metadata.fetch(:layout, 'post')
+      @metadata.fetch(:layout, "post")
     end
 
     def slug
-      File.basename(@path, '.markdown')
+      File.basename(@path, ".markdown")
     end
   end
 end

data/lib/dimples/site.rb

@@ -1,28 +1,33 @@
 # frozen_string_literal: true
 
-require_relative 'pager'
+require_relative "pager"
 
-require 'fileutils'
-require 'tilt'
-require 'date'
+require "fileutils"
+require "tilt"
+require "date"
 
 module Dimples
   class Site
-    def self.generate(output_path)
-      new(output_path).generate
+    DEFAULT_CONFIG = { overwrite_directory: false }
+
+    def self.generate(source_path, output_path, config)
+      new(source_path, output_path, config).generate
     end
 
-    attr_accessor :posts, :categories
+    attr_accessor :posts, :pages, :categories, :config
 
-    def initialize(output_path)
+    def initialize(source_path, output_path, config)
       @paths = {
-        source: File.expand_path(Dir.pwd),
-        destination: File.expand_path(output_path)
+        source: File.expand_path(source_path || Dir.pwd),
+        destination: File.expand_path(output_path || File.join(Dir.pwd, "site"))
       }
 
-      @config = read_config
+      @config = DEFAULT_CONFIG
+      @config.merge!(config) if config&.is_a?(Hash)
 
-      %w[pages posts static templates].each { |type| @paths[type.to_sym] = File.join(@paths[:source], type) }
+      %w[pages posts static templates].each do |type|
+        @paths[type.to_sym] = File.join(@paths[:source], type)
+      end
 
       scan_posts
       scan_pages
@@ -31,8 +36,11 @@ module Dimples
 
     def generate
       if Dir.exist?(@paths[:destination])
-        puts "Error: The output directory (#{@paths[:destination]}) already exists."
-        return
+        unless @config[:overwrite_directory]
+          raise GenerationError.new("The build directory (#{@paths[:destination]}) already exists.")
+        end
+
+        FileUtils.rm_rf(@paths[:destination])
       end
 
       Dir.mkdir(@paths[:destination])
@@ -46,16 +54,8 @@ module Dimples
 
     private
 
-    def read_config
-      config_path = File.join(@paths[:source], '.config')
-
-      return {} unless File.exist?(config_path)
-
-      YAML.safe_load(File.read(config_path), symbolize_names: true)
-    end
-
     def read_files(path)
-      Dir[File.join(path, '**', '*.*')].sort
+      Dir[File.join(path, "**", "*.*")].sort
     end
 
     def scan_posts
@@ -65,7 +65,7 @@ module Dimples
       @categories = {}
 
       @posts.each do |post|
-        post.categories.each do |category|
+        post.categories&.each do |category|
           @categories[category] ||= []
           @categories[category] << post
         end
@@ -73,18 +73,17 @@ module Dimples
     end
 
     def scan_pages
-      @pages = read_files(@paths[:pages]).map do |path|
-        Dimples::Page.new(path)
-      end
+      @pages = read_files(@paths[:pages]).map { |path| Dimples::Page.new(path) }
     end
 
     def scan_templates
-      @templates = {}.tap do |templates|
-        read_files(@paths[:templates]).each do |path|
-          key = File.basename(path, '.erb')
-          templates[key] = Dimples::Template.new(path)
+      @templates =
+        {}.tap do |templates|
+          read_files(@paths[:templates]).each do |path|
+            key = File.basename(path, ".erb")
+            templates[key] = Dimples::Template.new(path)
+          end
         end
-      end
     end
 
     def write_file(path, content)
@@ -95,23 +94,27 @@ module Dimples
     end
 
     def generate_paginated_posts(posts, path, context = {})
-      pager = Dimples::Pager.new("#{path.sub(@paths[:destination], '')}/", posts)
+      pager = Dimples::Pager.new("#{path.sub(@paths[:destination], "")}/", posts)
 
       pager.each do |index|
-        page = Dimples::Page.new(nil, layout: 'posts')
-
-        page_path = if index == 1
-                      path
-                    else
-                      File.join(path, "page_#{index}")
-                    end
-
-        write_file(File.join(page_path, page.filename), render(page, context.merge!(pagination: pager.to_context)))
+        page = Dimples::Page.new(nil, layout: "posts")
+
+        page_path =
+          if index == 1
+            path
+          else
+            File.join(path, "page_#{index}")
+          end
+
+        write_file(
+          File.join(page_path, page.filename),
+          render(page, context.merge!(pagination: pager.to_context))
+        )
       end
     end
 
     def generate_posts
-      directory_path = File.join(@paths[:destination], @config.dig(:paths, :posts) || 'posts')
+      directory_path = File.join(@paths[:destination], @config.dig(:paths, :posts) || "posts")
       Dir.mkdir(directory_path)
 
       @posts.each do |post|
@@ -125,11 +128,12 @@ module Dimples
 
     def generate_pages
       @pages.each do |page|
-        path = if page.path
-                 File.dirname(page.path).sub(@paths[:pages], @paths[:destination])
-               else
-                 @paths[:destination]
-               end
+        path =
+          if page.path
+            File.dirname(page.path).sub(@paths[:pages], @paths[:destination])
+          else
+            @paths[:destination]
+          end
 
         write_file(File.join(path, page.filename), render(page, page: page))
       end
@@ -137,7 +141,7 @@ module Dimples
 
     def generate_categories
       @categories.each do |category, posts|
-        category_path = File.join(@paths[:destination], 'categories', category)
+        category_path = File.join(@paths[:destination], "categories", category)
 
         generate_paginated_posts(posts, category_path, category: category)
         generate_feed(posts.slice(0, 10), category_path)
@@ -145,14 +149,14 @@ module Dimples
     end
 
     def generate_feed(posts, path)
-      page = Dimples::Page.new(nil, layout: 'feed')
-      write_file(File.join(path, 'feed.atom'), render(page, posts: posts))
+      page = Dimples::Page.new(nil, layout: "feed")
+      write_file(File.join(path, "feed.atom"), render(page, posts: posts))
     end
 
     def copy_assets
       return unless Dir.exist?(@paths[:static])
 
-      FileUtils.cp_r(File.join(@paths[:static], '.'), @paths[:destination])
+      FileUtils.cp_r(File.join(@paths[:static], "."), @paths[:destination])
     end
 
     def render(object, context = {}, content = nil)
@@ -160,7 +164,8 @@ module Dimples
 
       output = object.render(context, content)
 
-      output = render(@templates[object.layout], context, output) if object.layout && @templates[object.layout]
+      output = render(@templates[object.layout], context, output) if object.layout &&
+        @templates[object.layout]
 
       output
     end

data/lib/dimples/template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'document'
+require_relative "document"
 
 module Dimples
   class Template < Document

data/lib/dimples/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dimples
-  VERSION = '7.0.5'
+  VERSION = "8.0.0"
 end

data/lib/dimples.rb

@@ -2,7 +2,8 @@
 
 $LOAD_PATH.unshift(__dir__)
 
-require 'dimples/page'
-require 'dimples/post'
-require 'dimples/template'
-require 'dimples/site'
+require "dimples/errors"
+require "dimples/page"
+require "dimples/post"
+require "dimples/template"
+require "dimples/site"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 7.0.5
+  version: 8.0.0
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-14 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -58,28 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.28'
 description: A simple tool for building static websites.
 email:
 - d+dimples@waferbaby.com
@@ -91,6 +119,7 @@ files:
 - bin/dimples
 - lib/dimples.rb
 - lib/dimples/document.rb
+- lib/dimples/errors.rb
 - lib/dimples/frontmatter.rb
 - lib/dimples/page.rb
 - lib/dimples/pager.rb