dimples 2.7.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b52d2144b5fa793210da87b05d71b556da99f92
-  data.tar.gz: 25d265f537063f2cbf077a196b4c5f698f301948
+  metadata.gz: a4cee778dfaf4073d4f09fa374b884e684916696
+  data.tar.gz: 269d2ba199c54bc6c5cb66094ab38069896de042
 SHA512:
-  metadata.gz: a2c53bac19908af864f60bc0c10d5e1dc95ddfd74aa6c224789519aa5101d89eef26ab501e4dddefdfe26a9e04e02574c7138fc3b68a4b2b68f7c1e04351f744
-  data.tar.gz: d3010e778563ba0d9c4a0f0ab536e5e6c354a0da9bebe40914e1ec64e1c1a50b38d233f787d9dcaab5cffe649266986ca54bacf92cc31e8744677022f2ea870d
+  metadata.gz: 7d333b6cf6d9475d643e4e8ae47b5b1777ef598489afaaa5e9eb795e97a773fd84010c182176ba90cffc5c4d0cf7cacf676c9ac63a806d964509e41c25f9531b
+  data.tar.gz: 1bd4720fdfc2d8d506110aff782e1307580f4e90f7f9e6c0d8bcc3244a202c06f64d65bc748f7867a1a30814aa189bb8b78510f96700c7abd1a8532979e20483

data/lib/dimples.rb

@@ -8,14 +8,13 @@ require 'logger'
 require 'tilt'
 require 'yaml'
 
-require 'dimples/errors'
-require 'dimples/logger'
-
-require 'dimples/frontable'
-
 require 'dimples/category'
 require 'dimples/configuration'
+require 'dimples/errors'
+require 'dimples/frontable'
+require 'dimples/logger'
 require 'dimples/page'
+require 'dimples/pagination'
 require 'dimples/post'
 require 'dimples/renderer'
 require 'dimples/site'

data/lib/dimples/configuration.rb

@@ -29,7 +29,7 @@ module Dimples
         'source_path' => Dir.pwd,
         'destination_path' => File.join(Dir.pwd, 'site'),
         'verbose_logging' => false,
-        'class_overrides' => { site: nil, post: nil, page: nil },
+        'class_overrides' => { site: nil, post: nil },
         'rendering' => {},
         'category_names' => {},
         'paths' => default_paths,

data/lib/dimples/pagination.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Dimples
+  # A module that supports pagination.
+  module Pagination
+    def paginate(site, items, path, layout, options = {})
+      context = options[:context] || {}
+      url = path.gsub(site.output_paths[:site], '') + '/'
+      per_page = options[:per_page] || site.config['pagination']['per_page']
+
+      pager = Pager.new(url, items, per_page)
+
+      pager.each do |index, page_items|
+        page = Dimples::Page.new(site)
+        page.layout = layout
+
+        page.title = options[:title] || site.templates[layout].title
+        page.extension = options[:extension] if options[:extension]
+
+        output_path = page.output_path(
+          index != 1 ? File.join(path, "page#{index}") : path
+        )
+
+        context[:items] = page_items
+        context[:pagination] = pager.to_h
+
+        page.write(output_path, context)
+      end
+    end
+
+    # A class that models the context of a single page during pagination.
+    class Pager
+      include Enumerable
+
+      attr_reader :current_page
+      attr_reader :previous_page
+      attr_reader :next_page
+      attr_reader :page_count
+      attr_reader :item_count
+
+      def initialize(url, items, per_page)
+        @url = url
+        @items = items
+        @per_page = per_page
+        @page_count = (items.length.to_f / per_page.to_i).ceil
+
+        step_to(1)
+      end
+
+      def each(&block)
+        (1..@page_count).each do |index|
+          block.yield step_to(index), items_at(index)
+        end
+      end
+
+      def step_to(page)
+        @current_page = (1..@page_count).cover?(page) ? page : 1
+        @previous_page = (@current_page - 1).positive? ? @current_page - 1 : nil
+        @next_page = (@current_page + 1) <= @page_count ? @current_page + 1 : nil
+
+        @current_page
+      end
+
+      def items_at(page)
+        @items.slice((page - 1) * @per_page, @per_page)
+      end
+
+      def previous_page_url
+        return unless @previous_page
+        @previous_page != 1 ? "#{@url}page#{@previous_page}" : @url
+      end
+
+      def next_page_url
+        "#{@url}page#{@next_page}" if @next_page
+      end
+
+      def to_h
+        output = {
+          page: @current_page,
+          page_count: @page_count,
+          item_count: @items.count,
+          url: @url
+        }
+
+        if @previous_page
+          output[:previous_page] = @previous_page
+          output[:previous_page_url] = previous_page_url
+        end
+
+        if @next_page
+          output[:next_page] = @next_page
+          output[:next_page_url] = next_page_url
+        end
+
+        output
+      end
+    end
+  end
+end

data/lib/dimples/renderer.rb

@@ -10,7 +10,9 @@ module Dimples
       callback = proc { @source.contents }
 
       @engine = if @source.path
-                  Tilt.new(@source.path, {}, &callback)
+                  ext = File.extname(@source.path)[1..-1]
+                  options = @site.config['rendering'][ext] || {}
+                  Tilt.new(@source.path, options, &callback)
                 else
                   Tilt::StringTemplate.new(&callback)
                 end

data/lib/dimples/site.rb

@@ -3,6 +3,8 @@
 module Dimples
   # A class that models a single site.
   class Site
+    include Pagination
+
     attr_accessor :source_paths
     attr_accessor :output_paths
     attr_accessor :config
@@ -12,7 +14,6 @@ module Dimples
     attr_accessor :pages
     attr_accessor :posts
     attr_accessor :latest_post
-    attr_accessor :page_class
     attr_accessor :post_class
     attr_accessor :errors
 
@@ -28,31 +29,8 @@ module Dimples
       @archives = { year: {}, month: {}, day: {} }
       @latest_post = false
 
-      @page_class = @config.class_override(:page) || Dimples::Page
       @post_class = @config.class_override(:post) || Dimples::Post
 
-      set_source_paths
-      set_output_paths
-    end
-
-    def generate
-      prepare_output_directory
-      scan_files
-      generate_files
-      copy_assets
-    rescue Errors::RenderingError,
-           Errors::PublishingError,
-           Errors::GenerationError => e
-      @errors << e.message
-    end
-
-    def generated?
-      @errors.count.zero?
-    end
-
-    private
-
-    def set_source_paths
       @source_paths = {
         root: File.expand_path(@config['source_path'])
       }
@@ -60,9 +38,7 @@ module Dimples
       %w[pages posts public templates].each do |path|
         @source_paths[path.to_sym] = File.join(@source_paths[:root], path)
       end
-    end
 
-    def set_output_paths
       @output_paths = {
         site: File.expand_path(@config['destination_path'])
       }
@@ -73,15 +49,18 @@ module Dimples
       end
     end
 
-    def prepare_output_directory
-      if Dir.exist?(@output_paths[:site])
-        FileUtils.remove_dir(@output_paths[:site])
-      end
+    def generate
+      scan_files
+      generate_files
+      copy_assets
+    rescue Errors::RenderingError,
+           Errors::PublishingError,
+           Errors::GenerationError => e
+      @errors << e.message
+    end
 
-      Dir.mkdir(@output_paths[:site])
-    rescue => e
-      error_message = "Couldn't prepare the output directory (#{e.message})"
-      raise Errors::GenerationError, error_message
+    def generated?
+      @errors.count.zero?
     end
 
     def scan_files
@@ -113,7 +92,7 @@ module Dimples
     end
 
     def scan_page(path)
-      @page_class.new(self, path)
+      Dimples::Page.new(self, path)
     end
 
     def scan_posts
@@ -141,29 +120,26 @@ module Dimples
           @categories[slug].posts << post
         end
 
-        add_post_to_archives(post)
+        archive_year(post.year) << post
+        archive_month(post.year, post.month) << post
+        archive_day(post.year, post.month, post.day) << post
       end
     end
 
-    def add_post_to_archives(post)
-      archive_year(post.year) << post
-      archive_month(post.year, post.month) << post
-      archive_day(post.year, post.month, post.day) << post
-    end
-
-    def archive_year(year)
-      @archives[:year][year] ||= []
-    end
-
-    def archive_month(year, month)
-      @archives[:month]["#{year}/#{month}"] ||= []
-    end
+    def prepare_output_directory
+      if Dir.exist?(@output_paths[:site])
+        FileUtils.remove_dir(@output_paths[:site])
+      end
 
-    def archive_day(year, month, day)
-      @archives[:day]["#{year}/#{month}/#{day}"] ||= []
+      Dir.mkdir(@output_paths[:site])
+    rescue => e
+      error_message = "Couldn't prepare the output directory (#{e.message})"
+      raise Errors::GenerationError, error_message
     end
 
     def generate_files
+      prepare_output_directory
+
       generate_pages unless @pages.count.zero?
 
       return if @posts.count.zero?
@@ -182,9 +158,7 @@ module Dimples
         generate_post(post)
       end
 
-      layout = @config['layouts']['posts']
-
-      paginate(posts: @posts, path: @output_paths[:archives], layout: layout)
+      paginate(self, @posts, @output_paths[:archives], @config['layouts']['posts'])
 
       generate_posts_feeds if @config['generation']['feeds']
     end
@@ -220,15 +194,14 @@ module Dimples
     end
 
     def generate_category(category)
-      params = {
-        posts: category.posts,
-        title: category.name,
-        path: File.join(@output_paths[:categories], category.slug),
-        layout: @config['layouts']['category'],
-        context: { category: category.slug }
+      path = File.join(@output_paths[:categories], category.slug)
+
+      options = {
+        context: { category: category.slug },
+        title: category.name
       }
 
-      paginate(params)
+      paginate(self, category.posts, path, @config['layouts']['category'], options)
     end
 
     def generate_archives
@@ -240,27 +213,21 @@ module Dimples
     end
 
     def generate_archive_posts(date_type)
-      @archives[date_type.to_sym].each_value do |posts|
-        post = posts[0]
-
-        dates = case date_type
-                when 'year'
-                  { year: post.year }
-                when 'month'
-                  { year: post.year, month: post.month }
-                when 'day'
-                  { year: post.year, month: post.month, day: post.day }
-                end
-
-        params = {
-          posts: posts,
-          title: post.date.strftime(@config['date_formats'][date_type]),
-          path: File.join(@output_paths[:archives], dates.values),
-          layout: @config['layouts']["#{date_type}_archives"],
-          context: dates
+      @archives[date_type.to_sym].each do |date, posts|
+        year, month, day = date.split('/')
+
+        dates = { year: year }
+        dates[:month] = month if month
+        dates[:day] = day if day
+
+        path = File.join(@output_paths[:archives], dates.values)
+
+        options = {
+          context: dates,
+          title: posts[0].date.strftime(@config['date_formats'][date_type])
         }
 
-        paginate(params)
+        paginate(self, posts, path, @config['layouts']["#{date_type}_archives"], options)
       end
     end
 
@@ -268,7 +235,7 @@ module Dimples
       feed_templates.each do |format|
         next unless @templates[format]
 
-        feed = @page_class.new(self)
+        feed = Dimples::Page.new(self)
 
         feed.filename = 'feed'
         feed.extension = @templates[format].slug
@@ -292,10 +259,6 @@ module Dimples
       end
     end
 
-    def feed_templates
-      @feed_templates ||= @templates.keys.select { |k| k =~ /^feeds\./ }
-    end
-
     def copy_assets
       if Dir.exist?(@source_paths[:public])
         Dimples.logger.debug('Copying assets...') if @config['verbose_logging']
@@ -307,51 +270,22 @@ module Dimples
       raise Errors::GenerationError, "Site assets failed to copy (#{e.message})"
     end
 
-    def paginate(posts:, title: nil, path:, layout: false, context: {})
-      per_page = @config['pagination']['per_page']
-      pages = (posts.length.to_f / per_page.to_i).ceil
-      url = path.gsub(@output_paths[:site], '') + '/'
-
-      (1..pages).each do |index|
-        page = @page_class.new(self)
-
-        page.layout = layout
-        page.title = title || @templates[layout].title
-
-        output_path = File.join(path, index != 1 ? "page#{index}" : '')
-
-        context[:posts] = posts.slice((index - 1) * per_page, per_page)
-        context[:pagination] = build_pagination(index, pages, posts.count, url)
+    private
 
-        page.write(page.output_path(output_path), context)
-      end
+    def archive_year(year)
+      @archives[:year][year] ||= []
     end
 
-    def build_pagination(index, pages, item_count, url)
-      pagination = {
-        page: index,
-        pages: pages,
-        post_count: item_count,
-        url: url
-      }
-
-      if (index - 1).positive?
-        pagination[:previous_page] = index - 1
-        pagination[:previous_page_url] = url
-
-        if pagination[:previous_page] != 1
-          page_string = "page#{pagination[:previous_page]}"
-          pagination[:previous_page_url] += page_string
-        end
-      end
+    def archive_month(year, month)
+      @archives[:month]["#{year}/#{month}"] ||= []
+    end
 
-      if (index + 1) <= pages
-        pagination[:next_page] = index + 1
-        page_string = "#{url}page#{pagination[:next_page]}"
-        pagination[:next_page_url] = page_string
-      end
+    def archive_day(year, month, day)
+      @archives[:day]["#{year}/#{month}/#{day}"] ||= []
+    end
 
-      pagination
+    def feed_templates
+      @feed_templates ||= @templates.keys.select { |k| k =~ /^feeds\./ }
     end
   end
 end

data/lib/dimples/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 2.7.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-09 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -144,6 +144,7 @@ files:
 - lib/dimples/frontable.rb
 - lib/dimples/logger.rb
 - lib/dimples/page.rb
+- lib/dimples/pagination.rb
 - lib/dimples/post.rb
 - lib/dimples/renderer.rb
 - lib/dimples/site.rb