dimples 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9af69955701e46818367fbe965f4bb1071427319
+  data.tar.gz: 2d2c2861d73eef0348bb98f7d06ec6e94c3b007e
+SHA512:
+  metadata.gz: 422c790ef28519c67b634dffe74515cf52f6941e62bff67180822f26cb95c6f89be25608a9c73761a65812d4efbb4e0e80c1e34976bad0dac20d5dbc3d39442e
+  data.tar.gz: d30324038e2fad5432ca578ba84f7936fe961c2e30885a473893dfa2844bb012a9b055ede5bf8d48958de458e20fbe3ff089d1adbed049637774db0a216183a0

data/lib/dimples.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(__dir__)
+
+require 'fileutils'
+require 'yaml'
+require 'erubis'
+require 'redcarpet'
+
+require 'dimples/frontable'
+require 'dimples/publishable'
+require 'dimples/configuration'
+require 'dimples/page'
+require 'dimples/post'
+require 'dimples/site'
+require 'dimples/template'

data/lib/dimples/configuration.rb

@@ -0,0 +1,74 @@
+module Dimples
+  class Configuration
+    def initialize(config = {})
+      @settings = Dimples::Configuration.default_settings
+
+      if config
+        @settings.each_key do |key|
+          if config.key?(key)
+            if @settings[key].is_a?(Hash)
+              @settings[key].merge!(config[key])
+            else
+              @settings[key] = config[key]
+            end
+          end
+        end
+      end
+    end
+
+    def [](key)
+      @settings[key]
+    end
+
+    def self.default_settings
+      current_path = Dir.pwd
+
+      {
+        'source_path' => current_path,
+        'destination_path' => File.join(current_path, 'site'),
+
+        'paths' => {
+          'posts' => 'archives',
+          'post' => '%Y/%m/%d',
+        },
+
+        'layouts' => {
+          'posts' => 'posts',
+          'post' => 'post',
+          'category' => 'category',
+        },
+
+        'markdown' => {
+          'enabled' => true,
+          'options' => {},
+        },
+
+        'pagination' => {
+          'enabled' => true,
+          'per_page' => 10,
+        },
+
+        'generation' => {
+          'paginated_posts' => false,
+          'categories' => true,
+          'year_archives' => true,
+          'month_archives' => true,
+          'day_archives' => true,
+          'feed' => true,
+          'category_feeds' => true,
+        },
+
+        'file_extensions' => {
+          'pages' => 'html',
+          'posts' => 'html',
+        },
+
+        'date_formats' => {
+          'year' => '%Y',
+          'month' => '%Y-%m',
+          'day' => '%Y-%m-%d',
+        }
+      }
+    end
+  end
+end

data/lib/dimples/frontable.rb

@@ -0,0 +1,29 @@
+module Dimples
+  module Frontable
+    def read_with_yaml(path)
+      if path =~ /.yml$/
+        contents = ''
+        metadata = YAML.load_file(path)
+      else
+        contents = File.read(path)
+        matches = contents.match(/^(-{3}\n.*?\n?)^(-{3}*$\n?)/m)
+
+        if matches
+          metadata = YAML.load(matches[1])
+          contents = matches.post_match.strip!
+        end
+      end
+
+      if metadata
+        metadata.each_pair do |key, value|
+          unless instance_variable_get("@#{key}")
+            self.class.send(:attr_accessor, key.to_sym)
+            instance_variable_set("@#{key}", value)
+          end
+        end
+      end
+
+      contents
+    end
+  end
+end

data/lib/dimples/page.rb

@@ -0,0 +1,47 @@
+module Dimples
+  class Page
+    include Frontable
+    include Publishable
+
+    attr_accessor :path
+    attr_accessor :title
+    attr_accessor :template
+    attr_accessor :filename
+    attr_accessor :extension
+    attr_accessor :layout
+
+    attr_writer :contents
+
+    def initialize(site, path = nil)
+      @site = site
+      
+      if path
+        @path = path
+        @contents = read_with_yaml(path)
+        @filename = File.basename(path, File.extname(path))
+      else
+        @filename = 'index'
+      end
+
+      @extension = @site.config['file_extensions']['pages']
+      @layout ||= @site.config['layouts']['page']
+    end
+
+    def type
+      :page
+    end
+
+    def contents
+      @contents
+    end
+
+    def output_file_path(parent_path)
+      parts = [parent_path]
+
+      parts << File.dirname(@path).gsub(@site.source_paths[:pages], '') unless @path.nil?
+      parts << "#{@filename}.#{@extension}"
+
+      File.join(parts)
+    end
+  end
+end

data/lib/dimples/post.rb

@@ -0,0 +1,70 @@
+module Dimples
+  class Post
+    include Frontable
+    include Publishable
+    
+    attr_accessor :path
+    attr_accessor :title
+    attr_accessor :template
+    attr_accessor :filename
+    attr_accessor :extension
+    attr_accessor :layout
+    attr_accessor :slug
+    attr_accessor :date
+    attr_accessor :categories
+    attr_accessor :year
+    attr_accessor :month
+    attr_accessor :day
+
+    attr_writer :contents
+    attr_writer :markdown
+
+    def initialize(site, path)
+      @site = site
+
+      @path = path
+      @contents = read_with_yaml(path)
+
+      @filename = 'index'
+      @extension = @site.config['file_extensions']['posts']
+
+      parts = File.basename(path, File.extname(path)).match(/(\d{4})-(\d{2})-(\d{2})-(.+)/)
+
+      @slug = parts[4]
+      @date = Time.mktime(parts[1], parts[2], parts[3])
+
+      @layout ||= @site.config['layouts']['post']
+      @categories ||= []
+
+      @year = @date.strftime('%Y')
+      @month = @date.strftime('%m')
+      @day = @date.strftime('%d')
+    end
+
+    def type
+      :post
+    end
+
+    def contents
+      @contents
+    end
+
+    def markdown
+      @markdown ||= @site.markdown_engine.render(contents())
+    end
+
+    def output_file_path(parent_path)
+      parts = [parent_path]
+
+      if @site.config['paths']['post']
+        path = @date.strftime(@site.config['paths']['post'])
+        parts.concat(path.split('/')) if path
+      end
+
+      parts << @slug
+      parts << "#{@filename}.#{@extension}"
+
+      File.join(parts)
+    end
+  end
+end

data/lib/dimples/publishable.rb

@@ -0,0 +1,32 @@
+module Dimples
+  module Publishable
+    def write(path, context = false)
+      output = context ? render(contents(), {this: self}.merge(context)) : contents()
+
+      publish_path = output_file_path(path)
+      parent_path = File.dirname(publish_path)
+
+      FileUtils.mkdir_p(parent_path) unless Dir.exist?(parent_path)
+
+      File.open(publish_path, 'w') do |file|
+        file.write(output)
+      end
+    end
+
+    def render(body, context = {}, use_layout = true)
+      context[:site] ||= @site
+
+      begin
+        output = Erubis::Eruby.new(contents()).evaluate(context) { body }
+      rescue SyntaxError => e
+        raise "Syntax error in #{path.gsub(site.source_paths[:root], '')}"
+      end
+
+      if use_layout && @layout && @site.templates[@layout]
+        output = @site.templates[@layout].render(output, context) 
+      end
+
+      output
+    end
+  end
+end

data/lib/dimples/site.rb

@@ -0,0 +1,278 @@
+module Dimples
+  class Site
+    attr_accessor :source_paths
+    attr_accessor :output_paths
+    attr_accessor :config
+    attr_accessor :templates
+    attr_accessor :categories
+    attr_accessor :archives
+    attr_accessor :pages
+    attr_accessor :posts
+    attr_accessor :latest_post
+    attr_accessor :markdown_engine
+    attr_accessor :page_class
+    attr_accessor :post_class
+
+    def initialize(config = {})
+      @source_paths = {}
+      @output_paths = {}
+      @templates = {}
+      @categories = {}
+      @archives = {}
+
+      @pages = []
+      @posts = []
+
+      @latest_post = false
+
+      @page_class = Dimples::Page
+      @post_class = Dimples::Post
+
+      @config = Dimples::Configuration.new(config)
+
+      @source_paths[:root] = File.expand_path(@config['source_path'])
+      @output_paths[:site] = File.expand_path(@config['destination_path'])
+
+      %w{pages posts templates public}.each do |path|
+        @source_paths[path.to_sym] = File.join(@source_paths[:root], path)
+      end
+
+      @output_paths[:posts] = File.join(@output_paths[:site], @config['paths']['posts'])
+
+      @markdown_engine = if @config['markdown']['enabled']
+        Redcarpet::Markdown.new(Redcarpet::Render::HTML, @config['markdown']['options'])
+      else
+        false
+      end
+    end
+
+    def scan_files
+      Dir.glob(File.join(@source_paths[:templates], '**', '*.*')).each do |path|
+        template = Dimples::Template.new(self, path)
+        @templates[template.slug] = template
+      end
+
+      Dir.glob(File.join(@source_paths[:pages], '**', '*.*')).each do |path|
+        @pages << @page_class.new(self, path)
+      end
+
+      Dir.glob(File.join(@source_paths[:posts], '*.*')).each do |path|
+        @posts << @post_class.new(self, path)
+      end
+
+      @posts.reverse!
+      @latest_post = @posts.first
+
+      @posts.each do |post|
+
+        year = post.year.to_s
+        month = post.month.to_s
+        day = post.day.to_s
+
+        @archives[year] ||= {posts: [], months: {}}
+
+        @archives[year][:posts] << post
+        @archives[year][:months][month] ||= {posts: [], days: {}, name: post.date.strftime('%B')}
+        @archives[year][:months][month][:posts] << post
+        @archives[year][:months][month][:days][day] ||= []
+        @archives[year][:months][month][:days][day] << post
+
+        post.categories.each do |category|
+          (@categories[category] ||= []) << post
+        end
+      end
+    end
+
+    def generate
+      scan_files
+
+      begin
+        FileUtils.remove_dir(@output_paths[:site]) if Dir.exist?(@output_paths[:site])
+        Dir.mkdir(@output_paths[:site])
+      rescue => e
+        raise "Failed to prepare the site directory (#{e})"
+      end
+
+      @posts.each do |post|
+        begin
+          post.write(@output_paths[:posts], {})
+        rescue => e
+          raise "Failed to render post #{File.basename(post.path)} (#{e})"
+        end
+      end
+
+      @pages.each do |page|
+        begin
+          page.write(@output_paths[:site], {})
+        rescue => e
+          raise "Failed to render page from #{page.path.gsub(@source_paths[:root], '')} (#{e})"
+        end
+      end
+
+      if @config['generation']['paginated_posts'] && @posts.length > 0
+        begin
+          paginate(@posts, false, @config['pagination']['per_page'], [@output_paths[:posts]], @config['layouts']['posts'])
+        rescue => e
+          raise "Failed to paginate main posts (#{e})"
+        end
+      end
+
+      if @config['generation']['year_archives'] && @archives.length > 0
+        begin
+          generate_archives
+        rescue => e
+          raise "Failed to generate archives (#{e})"
+        end
+      end
+
+      if @config['generation']['categories'] && @categories.length > 0
+        @categories.each_pair do |slug, posts|  
+          if @config['generation']['category_feeds']
+            begin
+              generate_feed(File.join(@output_paths[:posts], slug), {posts: posts[0..@config['pagination']['per_page'] - 1], category: slug})
+            rescue => e
+              raise "Failed to generate category feed for '#{slug}' (#{e})"
+            end
+          end
+
+          begin
+            paginate(posts, slug.capitalize, @config['pagination']['per_page'], [@output_paths[:posts], slug], @config['layouts']['category'])
+          rescue => e
+            raise "Failed to generate category pages for '#{slug}' (#{e})"
+          end
+        end
+      end
+
+      if @config['generation']['feed'] && @posts.length > 0
+        begin
+          generate_feed(@output_paths[:site], {posts: @posts[0..@config['pagination']['per_page'] - 1]})
+        rescue => e
+          raise "Failed to generate main feed (#{e})"
+        end
+      end
+
+      begin
+        FileUtils.cp_r(File.join(@source_paths[:public], '.'), @output_paths[:site]) if Dir.exists?(@source_paths[:public])
+      rescue => e
+        raise "Failed to copy site assets (#{e})"
+      end
+    end
+
+    def generate_archives
+      if @config['layouts'].has_key?('year')
+        year_template = @config['layouts']['year']
+      elsif @config['layouts'].has_key?('archives')
+        year_template = @config['layouts']['archives']
+      else
+        year_template = @config['layouts']['posts']
+      end
+
+      @archives.each do |year, year_archive|
+
+        if @config['generation']['month_archives']
+          if @config['layouts'].has_key?('month')
+            month_template = @config['layouts']['month']
+          elsif @config['layouts'].has_key?('archives')
+            month_template = @config['layouts']['archives']
+          else
+            month_template = @config['layouts']['posts']
+          end
+
+          year_archive[:months].each do |month, month_archive|
+
+            if @config['generation']['day_archives']
+
+              if @config['layouts'].has_key?('day')
+                day_template = @config['layouts']['day']
+              elsif @config['layouts'].has_key?('archives')
+                day_template = @config['layouts']['archives']
+              else
+                day_template = @config['layouts']['posts']
+              end
+
+              month_archive[:days].each do |day, posts|
+                day_title = posts[0].date.strftime(@config['date_formats']['day'])
+                paginate(posts, day_title, @config['pagination']['per_page'], [@output_paths[:posts], year.to_s, month.to_s, day.to_s], day_template)
+              end
+            end
+
+            month_title = month_archive[:posts][0].date.strftime(@config['date_formats']['month'])
+            paginate(month_archive[:posts], month_title, @config['pagination']['per_page'], [@output_paths[:posts], year.to_s, month.to_s], month_template)
+          end
+        end
+
+        year_title = year_archive[:posts][0].date.strftime(@config['date_formats']['year'])
+        paginate(year_archive[:posts], year_title, @config['pagination']['per_page'], [@output_paths[:posts], year.to_s], year_template)
+      end
+    end
+
+    def generate_feed(path, params)
+      feed = @page_class.new(self)
+
+      feed.filename = 'feed'
+      feed.extension = 'atom'
+      feed.layout = 'feed'
+
+      feed.write(path, params)
+    end
+
+    def paginate(posts, title, per_page, paths, layout, params = {})
+      fail "'#{layout}' template not found" unless @templates.has_key?(layout)
+
+      pages = (posts.length.to_f / per_page.to_i).ceil
+
+      for index in 0...pages
+        range = posts.slice(index * per_page, per_page)
+
+        page = @page_class.new(self)
+
+        page_paths = paths.clone
+        page_title = title ? title : @templates[layout].title
+
+        if page_paths[0] == @output_paths[:site]
+          url_path = '/'
+        else
+          url_path = "/#{File.split(page_paths[0])[-1]}/"
+        end
+
+        url_path += "#{page_paths[1..-1].join('/')}/" if page_paths.length > 1
+
+        if index > 0
+          page_paths.push("page#{index + 1}")
+        end
+
+        pagination = {
+          page: index + 1,
+          pages: pages,
+          total: posts.length,
+          path: url_path
+        }
+
+        if (pagination[:page] - 1) > 0
+          pagination[:previous_page] = pagination[:page] - 1
+        end
+
+        if (pagination[:page] + 1) <= pagination[:pages]
+          pagination[:next_page] = pagination[:page] + 1
+        end
+
+        page.layout = layout
+        page.title = page_title
+
+        page.write(File.join(page_paths), {posts: range, pagination: pagination}.merge(params))
+      end
+    end
+
+    def render(template_slug, content, layout = true)
+      return '' unless @templates[template_slug]
+
+      if content.is_a? String
+        @templates[template_slug].render(content, {}, layout)
+      elsif content.is_a? Hash
+        @templates[template_slug].render('', content, layout)
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/dimples/template.rb

@@ -0,0 +1,19 @@
+module Dimples
+  class Template
+    include Frontable
+    include Publishable
+
+    attr_accessor :slug
+    attr_accessor :title
+    attr_accessor :path
+    attr_accessor :contents
+
+    def initialize(site, path)
+    	@site = site
+      @slug = File.basename(path, File.extname(path))
+      @path = path
+
+      @contents = read_with_yaml(path)
+    end
+  end
+end

data/lib/dimples/version.rb

@@ -0,0 +1,3 @@
+module Dimples
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: dimples
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Bogan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: This is a very simple static site generator, born out of the loins of
+  usesthis.com.
+email:
+- d+dimples@waferbaby.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dimples.rb
+- lib/dimples/configuration.rb
+- lib/dimples/frontable.rb
+- lib/dimples/page.rb
+- lib/dimples/post.rb
+- lib/dimples/publishable.rb
+- lib/dimples/site.rb
+- lib/dimples/template.rb
+- lib/dimples/version.rb
+homepage: http://github.com/waferbaby/dimples
+licenses:
+- LICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A very silly static site generator
+test_files: []