dimples 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4cee778dfaf4073d4f09fa374b884e684916696
-  data.tar.gz: 269d2ba199c54bc6c5cb66094ab38069896de042
+  metadata.gz: 3decb7a769a50beb4f4abcff1f8a2480dba31cda
+  data.tar.gz: ef0f049510c3d0a437e80938aa88a9185491c300
 SHA512:
-  metadata.gz: 7d333b6cf6d9475d643e4e8ae47b5b1777ef598489afaaa5e9eb795e97a773fd84010c182176ba90cffc5c4d0cf7cacf676c9ac63a806d964509e41c25f9531b
-  data.tar.gz: 1bd4720fdfc2d8d506110aff782e1307580f4e90f7f9e6c0d8bcc3244a202c06f64d65bc748f7867a1a30814aa189bb8b78510f96700c7abd1a8532979e20483
+  metadata.gz: f217f218f00afa0410927923b6f08e32ee8c1e8a5a1b2b636f6904007a9f44392b201ebc76f649d0bed1394061f1f4cd3875d5d8fc2bf2bbde0afc6733559711
+  data.tar.gz: 9ed527729cca08f35cea1f5229890cd7d31b78959e27d67d4977ec9fe681a7840227d1444b1361bf43b26436573bd6c9d8f3abf66c8d7fa83aaa870361061813

data/lib/dimples.rb

@@ -8,15 +8,16 @@ require 'logger'
 require 'tilt'
 require 'yaml'
 
+require 'dimples/frontable'
+require 'dimples/renderable'
+
 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'
 require 'dimples/template'
 

data/lib/dimples/frontable.rb

@@ -3,28 +3,23 @@
 module Dimples
   # A mixin class that handles reading and parsing front matter from a file.
   module Frontable
-    def read_with_front_matter(path)
-      contents = File.read(path)
-      matches = contents.match(/^(-{3}\n.*?\n?)^(-{3}*$\n?)/m)
+    METADATA_KEYS = %w[title layout extension summary categories].freeze
 
-      if matches
-        metadata = YAML.safe_load(matches[1])
-        contents = matches.post_match.strip
+    def read_with_front_matter
+      @contents = File.read(@path)
 
-        apply_metadata(metadata) if metadata
-      end
+      matches = @contents.match(/^(-{3}\n.*?\n?)^(-{3}*$\n?)/m)
+      return if matches.nil?
 
-      contents
-    end
+      metadata = YAML.safe_load(matches[1])
 
-    def apply_metadata(metadata)
       metadata.each_pair do |key, value|
-        unless respond_to?(key.to_sym)
-          self.class.send(:attr_accessor, key.to_sym)
+        if METADATA_KEYS.include?(key) && respond_to?("#{key}=")
+          send("#{key}=", value)
         end
-
-        send("#{key}=", value)
       end
+
+      @contents = matches.post_match.strip
     end
   end
 end

data/lib/dimples/page.rb

@@ -4,6 +4,7 @@ module Dimples
   # A class that models a single site page.
   class Page
     include Frontable
+    include Renderable
 
     attr_accessor :path
     attr_accessor :title
@@ -11,7 +12,7 @@ module Dimples
     attr_accessor :extension
     attr_accessor :layout
     attr_accessor :contents
-    attr_accessor :rendered_contents
+    attr_accessor :output_directory
 
     def initialize(site, path = nil)
       @site = site
@@ -20,45 +21,36 @@ module Dimples
 
       if @path
         @filename = File.basename(@path, File.extname(@path))
-        @contents = read_with_front_matter(@path)
+        @output_directory = File.dirname(@path).gsub(
+          @site.source_paths[:pages],
+          @site.output_paths[:site]
+        )
+
+        read_with_front_matter
       else
         @filename = 'index'
         @contents = ''
+        @output_directory = @site.output_paths[:site]
       end
     end
 
-    def output_path(parent_path)
-      parts = [parent_path]
-
-      unless @path.nil?
-        parts << File.dirname(@path).gsub(@site.source_paths[:pages], '')
-      end
-
-      parts << "#{@filename}.#{@extension}"
-
-      File.join(parts)
-    end
-
-    def render(context = {})
-      renderer.render(context)
-    end
-
-    def renderer
-      @renderer ||= Renderer.new(@site, self)
+    def output_path
+      File.join(@output_directory, "#{@filename}.#{@extension}")
     end
 
-    def write(path, context = {})
-      output = context ? render(context) : contents
-      parent_path = File.dirname(path)
+    def write(context = {})
+      FileUtils.mkdir_p(@output_directory) unless Dir.exist?(@output_directory)
 
-      FileUtils.mkdir_p(parent_path) unless Dir.exist?(parent_path)
-
-      File.open(path, 'w+') do |file|
-        file.write(output)
+      File.open(output_path, 'w+') do |file|
+        file.write(context ? render(context) : contents)
       end
     rescue SystemCallError => e
       error_message = "Failed to write #{path} (#{e.message})"
       raise Errors::PublishingError, error_message
     end
+
+    def inspect
+      "#<Dimples::Page @output_path=#{output_path}>"
+    end
   end
 end

data/lib/dimples/pagination.rb

@@ -12,19 +12,21 @@ module Dimples
 
       pager.each do |index, page_items|
         page = Dimples::Page.new(site)
-        page.layout = layout
 
+        page.output_directory = if index == 1
+                                  path
+                                else
+                                  File.join(path, "page#{index}")
+                                end
+
+        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)
+        page.write(context)
       end
     end
 
@@ -56,7 +58,7 @@ module Dimples
       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
+        @next_page = @current_page + 1 <= @page_count ? @current_page + 1 : nil
 
         @current_page
       end
@@ -76,7 +78,7 @@ module Dimples
 
       def to_h
         output = {
-          page: @current_page,
+          current_page: @current_page,
           page_count: @page_count,
           item_count: @items.count,
           url: @url

data/lib/dimples/post.rb

@@ -3,8 +3,9 @@
 module Dimples
   # A class that models a single site post.
   class Post < Page
-    attr_accessor :categories
     attr_accessor :slug
+    attr_accessor :summary
+    attr_accessor :categories
     attr_accessor :year
     attr_accessor :month
     attr_accessor :day
@@ -24,6 +25,11 @@ module Dimples
       @layout = @site.config['layouts']['post']
 
       self.date = Time.mktime(parts[1], parts[2], parts[3])
+
+      @output_directory = File.join(
+        @date.strftime(@site.output_paths[:posts]),
+        @slug.to_s
+      )
     end
 
     def date=(date)
@@ -34,9 +40,8 @@ module Dimples
       @day = @date.strftime('%d')
     end
 
-    def output_path(parent_path)
-      parent_path = @date.strftime(parent_path) if parent_path.match?(/%/)
-      File.join([parent_path, @slug.to_s, "#{@filename}.#{@extension}"])
+    def inspect
+      "#<Dimples::Post @slug=#{@slug} @output_path=#{output_path}>"
     end
   end
 end

data/lib/dimples/renderable.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Dimples
+  # A mixin class that allows a document to render via Tilt.
+  module Renderable
+    attr_accessor :rendered_contents
+
+    def render(context = {}, body = nil)
+      context[:site] ||= @site
+      context[:this] ||= self
+      context[:type] ||= self.class.name.split('::').last.downcase.to_sym
+
+      scope = Object.new.tap do |s|
+        context.each_pair do |key, value|
+          s.instance_variable_set("@#{key}".to_sym, value)
+        end
+      end
+
+      output = rendering_engine.render(scope) { body }.strip
+      @rendered_contents = output
+
+      if @site.templates[layout]
+        @site.templates[layout].render(context, output)
+      else
+        output
+      end
+    end
+
+    def rendering_engine
+      @rendering_engine ||= begin
+        callback = proc { contents }
+
+        if @path
+          ext = File.extname(@path)[1..-1]
+          options = @site.config['rendering'][ext] || {}
+          Tilt.new(@path, options, &callback)
+        else
+          Tilt::StringTemplate.new(&callback)
+        end
+      end
+    end
+  end
+end

data/lib/dimples/site.rb

@@ -31,18 +31,13 @@ module Dimples
 
       @post_class = @config.class_override(:post) || Dimples::Post
 
-      @source_paths = {
-        root: File.expand_path(@config['source_path'])
-      }
+      @source_paths = { root: File.expand_path(@config['source_path']) }
+      @output_paths = { site: File.expand_path(@config['destination_path']) }
 
       %w[pages posts public templates].each do |path|
         @source_paths[path.to_sym] = File.join(@source_paths[:root], path)
       end
 
-      @output_paths = {
-        site: File.expand_path(@config['destination_path'])
-      }
-
       %w[archives posts categories].each do |path|
         output_path = File.join(@output_paths[:site], @config['paths'][path])
         @output_paths[path.to_sym] = output_path
@@ -50,8 +45,20 @@ module Dimples
     end
 
     def generate
-      scan_files
-      generate_files
+      scan_templates
+      scan_pages
+      scan_posts
+
+      prepare_output_directory
+
+      generate_pages unless @pages.count.zero?
+
+      unless @posts.count.zero?
+        generate_posts
+        generate_archives
+        generate_categories if @config['generation']['categories']
+      end
+
       copy_assets
     rescue Errors::RenderingError,
            Errors::PublishingError,
@@ -63,12 +70,6 @@ module Dimples
       @errors.count.zero?
     end
 
-    def scan_files
-      scan_templates
-      scan_pages
-      scan_posts
-    end
-
     def scan_templates
       Dir.glob(File.join(@source_paths[:templates], '**', '*.*')).each do |path|
         template = Dimples::Template.new(self, path)
@@ -137,48 +138,29 @@ module Dimples
       raise Errors::GenerationError, error_message
     end
 
-    def generate_files
-      prepare_output_directory
-
-      generate_pages unless @pages.count.zero?
-
-      return if @posts.count.zero?
-
-      generate_posts
-      generate_archives
-      generate_categories if @config['generation']['categories']
-    end
-
     def generate_posts
       if @config['verbose_logging']
         Dimples.logger.debug_generation('posts', @posts.length)
       end
 
-      @posts.each do |post|
-        generate_post(post)
-      end
+      @posts.each(&:write)
 
-      paginate(self, @posts, @output_paths[:archives], @config['layouts']['posts'])
+      paginate(
+        self,
+        @posts,
+        @output_paths[:archives],
+        @config['layouts']['posts']
+      )
 
       generate_posts_feeds if @config['generation']['feeds']
     end
 
-    def generate_post(post)
-      post.write(post.output_path(@output_paths[:posts]))
-    end
-
     def generate_pages
       if @config['verbose_logging']
         Dimples.logger.debug_generation('pages', @pages.length)
       end
 
-      @pages.each do |page|
-        generate_page(page)
-      end
-    end
-
-    def generate_page(page)
-      page.write(page.output_path(@output_paths[:site]))
+      @pages.each(&:write)
     end
 
     def generate_categories
@@ -187,61 +169,61 @@ module Dimples
       end
 
       @categories.each_value do |category|
-        generate_category(category)
-      end
-
-      generate_category_feeds if @config['generation']['category_feeds']
-    end
+        path = File.join(@output_paths[:categories], category.slug)
 
-    def generate_category(category)
-      path = File.join(@output_paths[:categories], category.slug)
+        options = {
+          context: { category: category.slug },
+          title: category.name
+        }
 
-      options = {
-        context: { category: category.slug },
-        title: category.name
-      }
+        paginate(
+          self,
+          category.posts,
+          path,
+          @config['layouts']['category'],
+          options
+        )
+      end
 
-      paginate(self, category.posts, path, @config['layouts']['category'], options)
+      generate_category_feeds if @config['generation']['category_feeds']
     end
 
     def generate_archives
       %w[year month day].each do |date_type|
-        if @config['generation']["#{date_type}_archives"]
-          generate_archive_posts(date_type)
-        end
-      end
-    end
+        next unless @config['generation']["#{date_type}_archives"]
 
-    def generate_archive_posts(date_type)
-      @archives[date_type.to_sym].each do |date, posts|
-        year, month, day = date.split('/')
+        @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
+          dates = { year: year }
+          dates[:month] = month if month
+          dates[:day] = day if day
 
-        path = File.join(@output_paths[:archives], dates.values)
+          path = File.join(@output_paths[:archives], dates.values)
+          layout = @config['layouts']["#{date_type}_archives"]
 
-        options = {
-          context: dates,
-          title: posts[0].date.strftime(@config['date_formats'][date_type])
-        }
+          options = {
+            context: dates,
+            title: posts[0].date.strftime(@config['date_formats'][date_type])
+          }
 
-        paginate(self, posts, path, @config['layouts']["#{date_type}_archives"], options)
+          paginate(self, posts, path, layout, options)
+        end
       end
     end
 
-    def generate_feeds(path, options)
+    def generate_feeds(path, context)
       feed_templates.each do |format|
         next unless @templates[format]
 
         feed = Dimples::Page.new(self)
 
+        feed.output_directory = path
         feed.filename = 'feed'
         feed.extension = @templates[format].slug
         feed.layout = format
 
-        feed.write(feed.output_path(path), options)
+        feed.write(context)
       end
     end
 
@@ -259,6 +241,10 @@ 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']
@@ -270,6 +256,12 @@ module Dimples
       raise Errors::GenerationError, "Site assets failed to copy (#{e.message})"
     end
 
+    def inspect
+      "#<Dimples::Site " \
+      "@source_paths=#{@source_paths} " \
+      "@output_paths=#{@output_paths}>"
+    end
+
     private
 
     def archive_year(year)
@@ -283,9 +275,5 @@ module Dimples
     def archive_day(year, month, day)
       @archives[:day]["#{year}/#{month}/#{day}"] ||= []
     end
-
-    def feed_templates
-      @feed_templates ||= @templates.keys.select { |k| k =~ /^feeds\./ }
-    end
   end
 end

data/lib/dimples/template.rb

@@ -4,28 +4,24 @@ module Dimples
   # A class that models a single template.
   class Template
     include Frontable
+    include Renderable
 
     attr_accessor :path
     attr_accessor :title
     attr_accessor :slug
     attr_accessor :layout
     attr_accessor :contents
-    attr_accessor :rendered_contents
 
     def initialize(site, path)
       @site = site
       @slug = File.basename(path, File.extname(path))
       @path = path
 
-      @contents = read_with_front_matter(path)
+      read_with_front_matter
     end
 
-    def render(context = {}, body = nil)
-      renderer.render(context, body)
-    end
-
-    def renderer
-      @renderer ||= Renderer.new(@site, self)
+    def inspect
+      "#<Dimples::Template @slug=#{@slug} @path=#{@path}>"
     end
   end
 end

data/lib/dimples/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dimples
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +160,7 @@ files:
 - lib/dimples/page.rb
 - lib/dimples/pagination.rb
 - lib/dimples/post.rb
-- lib/dimples/renderer.rb
+- lib/dimples/renderable.rb
 - lib/dimples/site.rb
 - lib/dimples/template.rb
 - lib/dimples/version.rb

data/lib/dimples/renderer.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Dimples
-  # A class that renders the contents of a document into markup.
-  class Renderer
-    def initialize(site, source)
-      @site = site
-      @source = source
-
-      callback = proc { @source.contents }
-
-      @engine = if @source.path
-                  ext = File.extname(@source.path)[1..-1]
-                  options = @site.config['rendering'][ext] || {}
-                  Tilt.new(@source.path, options, &callback)
-                else
-                  Tilt::StringTemplate.new(&callback)
-                end
-    end
-
-    def render(context = {}, body = nil)
-      output = @engine.render(scope(context)) { body }.strip
-      @source.rendered_contents = output
-
-      template = @site.templates[@source.layout]
-      output = template.render(context, output) unless template.nil?
-
-      output
-    end
-
-    def scope(context = {})
-      context[:site] ||= @site
-      context[:this] ||= @source
-      context[:type] ||= @source.class.name.split('::').last.downcase.to_sym
-
-      Object.new.tap do |scope|
-        context.each_pair do |key, value|
-          scope.instance_variable_set("@#{key}".to_sym, value)
-        end
-      end
-    end
-  end
-end