sawsge 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8cb16b8c9c5893d01c2d1fc0ba82457e24a9f6fcb670781f9990aecac4773ba
-  data.tar.gz: 9388f1a50ff785504b8e5b9463b45418f25f9b43de33f93838d06742b8ab6e02
+  metadata.gz: b2a7067cfade9bf1831c7bf6f46d09bd23912b8f02ca9739ab3b281383a1348b
+  data.tar.gz: 04cb0c0e02a735460b7f3b0688abeac45d771ec702b6a8227d610b134458345c
 SHA512:
-  metadata.gz: cb1c6014f224e896b001420fbf3c96a30b16571d1dbadcc05f6d5f623b7bf550692b3dbccd721453ca520a8b74df8ada8e9cccfc9e41c3d31959aa62428c1231
-  data.tar.gz: 67e941e2c2ea82468bf51b30232fcfb32e9103b4d762336652d29de3211997217d265cafe349b0f74c7db534ef27713974edf26d8d4baeeec25463d4b0b61240
+  metadata.gz: b458f8adb18c62f8e6b101ecc572ae41bce854e8970aa0564fbec70e7b278bd133795b69ff1255fa13bc7d027fcc4c223cab06bff8fa92c908714f109b6006bd
+  data.tar.gz: 4e1da958f57c9b4feacbe0d655e4db6093ef977efb8ed6a544791146582177fe44c96339e54c1710ede9cd317a877228f39cdab7348287c9c236d42f84da56d6

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/bin/sawsge

@@ -3,4 +3,4 @@
 
 require 'sawsge'
 
-Sawsge.sawsge
+Sawsge.cli

data/lib/sawsge/blog.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Sawsge
+  def blog
+    home_path = 'index.md'
+
+    # Does not work if you have parent directories for your
+    # posts dir, e.g. you set posts_dirname in config.toml to
+    # foo/bar/baz/etc...
+    post_paths = @resource_paths.select do |path|
+      top_parent_dir(path) == @config.posts_dirname && File.extname(path) == '.md'
+    end
+
+    @resource_paths -= post_paths
+    @resource_paths.delete home_path
+
+    post_objects = post_paths.map { |path| Post.new(path, @config) }
+
+    post_objects.sort_by! { |x| x.date }
+    # Posts are now in reverse chronological order
+
+    i_last_nil_date = 0
+    while post_objects[i_last_nil_date].date.empty?
+      i_last_nil_date += 1
+    end
+
+    post_objects.rotate!(i_last_nil_date).reverse!
+    # Posts are now in chronological order with dateless
+    # posts being first
+
+    home_object = Home.new(home_path, post_objects, @config)
+    @all_objects = post_objects + [home_object]
+  end
+end

data/lib/sawsge/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'tomlrb'
+
+class Sawsge
+  class Config
+    attr_reader :external_links_target_blank,
+                :posts_dirname, :footer_filename, :reserved_filenames,
+                :src_dir, :out_dirname, :mode, :header_filename,
+                :header_path, :footer_path
+
+    def initialize(src_dir)
+      config_path = File.join(src_dir, CONFIG_FILENAME)
+      config = Tomlrb.load_file(config_path, symbolize_keys: true)
+
+      @src_dir = File.expand_path src_dir
+
+      @out_dirname = config.dig(:general, :out_dirname)
+      @mode = config[:general][:mode]
+
+      @header_filename = config.dig(:general, :header_filename)
+      @footer_filename = config.dig(:general, :footer_filename)
+
+      @header_path = File.expand_path(File.join(@src_dir, @header_filename))
+      @footer_path = File.expand_path(File.join(@src_dir, @footer_filename))
+
+      ignored_files = config[:general][:ignore] || []
+      @reserved_filenames = ignored_files + [CONFIG_FILENAME, @header_filename, @footer_filename]
+
+      @external_links_target_blank = config[:general][:external_links_target_blank] || true
+
+      @posts_dirname = config[:blog][:posts_dirname]
+    end
+  end
+end

data/lib/{home.rb → sawsge/home.rb}

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-module Sawsge
+class Sawsge
   # The homepage
   class Home < Page
-    def initialize(path, posts)
-      super(path)
-      posts.each do |post|
+    def initialize(path, posts, config)
+      super(path, config)
+
+      posts.each_with_index do |post, _i|
         # Adds collapseable summary of each post on the front
         # page
         summary_fragment = Nokogiri::HTML5.fragment <<~HTML
@@ -19,6 +20,7 @@ module Sawsge
         HTML
         @document.at_css('footer').add_previous_sibling summary_fragment
       end
+
     end
   end
 end

data/lib/{page.rb → sawsge/page.rb}

@@ -1,29 +1,40 @@
 # frozen_string_literal: true
 
-module Sawsge
+class Sawsge
   # An HTML page
   class Page < Resource
     attr_reader :title
 
-    def initialize(path)
+    def initialize(path, config)
       super(path)
-      html_body_fragment = PandocRuby.convert(File.new(@path, 'r').read, from: :markdown, to: :html)
-      @document = Nokogiri::HTML5(HEADER + FOOTER)
-      @body = Nokogiri::HTML5.fragment(html_body_fragment)
+
+      markdown = File.read(@path)
+      options = {
+        :from => :markdown,
+        :to   => :html
+      }
+      html_body_fragment = PandocRuby.convert(markdown, options)
+
+      header = File.read config.header_path
+      footer = File.read config.footer_path
+
+      # @document = Nokogiri::HTML5(header + footer)
+      # @body = Nokogiri::HTML5.fragment(header + html_body_fragment + footer)
+      @document = Nokogiri::HTML5(header + html_body_fragment + footer)
 
       # Place body fragment after header (and before footer)
-      header = @document.at_css('header')
-      @body = header.add_next_sibling(@body)
+      # header_location = @document.at_css('header')
+      # @body = header.add_next_sibling(@body)
 
       # Parse the body fragment instead of the whole document,
       # as the header may have another h1 within
       @title = begin
-        h1 = @body.at_css('h1')
+        h1 = @document.at_css('h1')
         h1 ? h1.content : ''
       end
       @document.at_css('title').content = @title
 
-      if EXTERNAL_LINKS_TARGET_BLANK
+      if config.external_links_target_blank
         # For any `a` tag where the href attribute has no
         # hostname (external link) and no existing `target`
         # attribute, add an attribute `target` with value
@@ -44,10 +55,10 @@ module Sawsge
       end
     end
 
-    def build
+    def build(out_dirname)
       serialized_html = @document.serialize
-      out_path = File.join(OUT_DIRNAME, @path.sub('index.md', 'index.html'))
-      out_dir = File.join(OUT_DIRNAME, File.dirname(@path))
+      out_path = File.join(out_dirname, @path.sub('index.md', 'index.html'))
+      out_dir = File.join(out_dirname, File.dirname(@path))
 
       FileUtils.mkpath out_dir
       File.new(out_path, 'w').syswrite(serialized_html)

data/lib/sawsge/post.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Sawsge
+  # A blogpost style HTML page
+  class Post < Page
+    attr_reader :date, :summary
+
+    def initialize(path, config)
+      super(path, config)
+
+      # Get the summary and date of the post
+      @summary = @document.css('summary').first.content
+      # If a date is specified within the <time> tag on the
+      # page, use that, otherwise use an empty string
+      @date = begin
+          date = @document.css('time').first
+          date ? date.content : ''
+      end
+    end
+
+  end
+end

data/lib/{project.rb → sawsge/project.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-module Sawsge
-  def self.project
+class Sawsge
+  def project
     page_paths = @resource_paths.select { |path| File.extname(path) == '.md' }
 
-    @resource_paths.subtract page_paths
+    @resource_paths -= page_paths
 
-    page_objects = page_paths.map { |path| Page.new(path) }
+    page_objects = page_paths.map { |path| Page.new(path, @config) }
 
     @all_objects.merge page_objects
   end

data/lib/{resource.rb → sawsge/resource.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Sawsge
+class Sawsge
   # Any generic file in the website directory
   class Resource
     attr_reader :path
@@ -10,9 +10,9 @@ module Sawsge
       @path = path
     end
 
-    def build
-      FileUtils.mkpath File.join(OUT_DIRNAME, File.dirname(@path))
-      FileUtils.cp @path, File.join(OUT_DIRNAME, @path)
+    def build(out_dirname)
+      FileUtils.mkpath File.join(out_dirname, File.dirname(@path))
+      FileUtils.cp @path, File.join(out_dirname, @path)
     end
   end
 end

data/lib/sawsge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Sawsge
-  VERSION = '0.1.3'
+class Sawsge
+  VERSION = '1.0.0'
 end

data/lib/sawsge.rb

@@ -3,77 +3,66 @@
 require 'fileutils'
 require 'nokogiri'
 require 'pandoc-ruby'
+require 'parallel'
 require 'pathname'
 require 'set'
-require 'toml'
+require 'tomlrb'
 require 'uri'
 
-require_relative 'resource'
-require_relative 'page'
-require_relative 'post'
-require_relative 'home'
-require_relative 'blog'
-require_relative 'project'
+require 'sawsge/resource'
+require 'sawsge/page'
+require 'sawsge/post'
+require 'sawsge/home'
+require 'sawsge/blog'
+require 'sawsge/project'
+require 'sawsge/config'
+
+# Returns the first directory in a path, eg.
+# `foo/bar/bin.txt` becomes `foo`
+def top_parent_dir(path)
+  Pathname.new(path).each_filename.to_a[0]
+end
 
-module Sawsge
+class Sawsge
   HELP_STRING = 'Usage: sawsge [DIRECTORY]'
 
-  SRC_DIR = ARGV[0] || Dir.pwd
-
   CONFIG_FILENAME = 'config.toml'
-  CONFIG_STRING = File.read(File.join(SRC_DIR, CONFIG_FILENAME))
-  CONFIG = TOML::Parser.new(CONFIG_STRING).parsed
-
-  OUT_DIRNAME = CONFIG['general']['out_dirname']
-
-  # TODO: Put these in the config
-  POSTS_DIRNAME = CONFIG['blog']['posts_dirname']
-
-  HEADER_FILENAME = CONFIG['general']['header_filename']
-  FOOTER_FILENAME = CONFIG['general']['footer_filename']
 
-  HEADER = HEADER_FILENAME.empty? ? '' : File.read(File.join(SRC_DIR, HEADER_FILENAME))
-  FOOTER = FOOTER_FILENAME.empty? ? '' : File.read(File.join(SRC_DIR, FOOTER_FILENAME))
-
-  EXTERNAL_LINKS_TARGET_BLANK = CONFIG['general']['external_links_target_blank']
-
-  IGNORE = CONFIG['general']['ignore']
-
-  # Resources that will not be put into the out folder
-  RESERVED_FILENAMES = [CONFIG_FILENAME, HEADER_FILENAME, FOOTER_FILENAME] + IGNORE
-
-  MODE = CONFIG['general']['mode']
+  def initialize(src_dir)
+    @config = Config.new(src_dir)
+  end
 
-  # Returns the first directory in a path, eg.
-  # `foo/bar/bin.txt` becomes `foo`
-  def self.top_parent_dir(path)
-    Pathname.new(path).each_filename.to_a[0]
+  def self.cli
+    src_dir = ARGV[0] || Dir.pwd
+    new(src_dir).build
   end
 
-  def self.sawsge
+  def build
     # Gross, but easy
-    Dir.chdir SRC_DIR
+    Dir.chdir @config.src_dir
 
     # Find all files recursively
-    @resource_paths = Set.new(Dir.glob('**/*').select do |path|
+    @resource_paths = Dir.glob('**/*').select do |path|
       File.file?(path) &&
-        top_parent_dir(path) != OUT_DIRNAME &&
-        !RESERVED_FILENAMES.include?(path)
-    end)
+        top_parent_dir(path) != @config.out_dirname &&
+        # Exclude explicitly ignored files
+        !@config.reserved_filenames.include?(path)
+    end
 
     @resource_objects = Set.new
     @all_objects = Set.new
 
-    send MODE
+    # Execute blog or project specific code.
+    send @config.mode
 
     resources = @resource_paths.map { |path| Resource.new(path) }
-    @all_objects.merge resources
+    @all_objects += resources
 
     # Delete any old builds
-    FileUtils.remove_dir OUT_DIRNAME if Pathname.new(OUT_DIRNAME).exist?
-    FileUtils.mkpath OUT_DIRNAME
+    FileUtils.remove_dir @config.out_dirname if Pathname.new(@config.out_dirname).exist?
+    FileUtils.mkpath @config.out_dirname
 
     # Write each file
-    @all_objects.each(&:build)
+    Parallel.each(@all_objects) { |x| x.build @config.out_dirname }
   end
 end

data/sawsge.gemspec

@@ -10,24 +10,27 @@ Gem::Specification.new do |s|
   s.description = 'Sawsge is an opinionated static site generator with TOML-configurable modes for blogs and projects. It takes Markdown files as source and uses Pandoc behind the scences to generate HTML files.'
   s.authors     = ['Sawyer Shepherd']
   s.email       = 'contact@sawyershepherd.org'
-  s.files       = [
-    'LICENSE',
-    'README.md',
-    'bin/sawsge',
-    'sawsge.gemspec',
-    'lib/sawsge/version.rb',
-    'lib/sawsge.rb',
-    'lib/blog.rb',
-    'lib/home.rb',
-    'lib/page.rb',
-    'lib/post.rb',
-    'lib/project.rb',
-    'lib/resource.rb'
-
+  s.files       = %w[
+    Gemfile
+    LICENSE
+    README.md
+    bin/sawsge
+    lib/sawsge.rb
+    lib/sawsge/blog.rb
+    lib/sawsge/config.rb
+    lib/sawsge/home.rb
+    lib/sawsge/page.rb
+    lib/sawsge/post.rb
+    lib/sawsge/project.rb
+    lib/sawsge/resource.rb
+    lib/sawsge/version.rb
+    sawsge.gemspec
   ]
   s.homepage    = 'https://github.com/sawshep/sawsge'
   s.license     = 'GPL-3.0'
   s.required_ruby_version = '>= 3.0'
   s.add_runtime_dependency 'pandoc-ruby', '~> 2.1'
-  s.add_runtime_dependency 'toml', '~> 0.3'
+  s.add_runtime_dependency 'tomlrb', '~> 2.0', '>= 2.0.1'
+  s.add_runtime_dependency 'nokogiri', '~> 1.12', '>= 1.12.4'
+  s.add_runtime_dependency 'parallel', '~> 1.22', '>= 1.22.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sawsge
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Sawyer Shepherd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pandoc-ruby
@@ -25,19 +25,65 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: toml
+  name: tomlrb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.4
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.22.1
 description: Sawsge is an opinionated static site generator with TOML-configurable
   modes for blogs and projects. It takes Markdown files as source and uses Pandoc
   behind the scences to generate HTML files.
@@ -47,16 +93,18 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE
 - README.md
 - bin/sawsge
-- lib/blog.rb
-- lib/home.rb
-- lib/page.rb
-- lib/post.rb
-- lib/project.rb
-- lib/resource.rb
 - lib/sawsge.rb
+- lib/sawsge/blog.rb
+- lib/sawsge/config.rb
+- lib/sawsge/home.rb
+- lib/sawsge/page.rb
+- lib/sawsge/post.rb
+- lib/sawsge/project.rb
+- lib/sawsge/resource.rb
 - lib/sawsge/version.rb
 - sawsge.gemspec
 homepage: https://github.com/sawshep/sawsge

data/lib/blog.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Sawsge
-  def self.blog
-    home_path = 'index.md'
-
-    # Does not work if you have parent directories for your
-    # posts dir, e.g. you set posts_dirname in config.toml to
-    # foo/bar/baz/etc...
-    post_paths = resource_paths.select do |path|
-      top_parent_dir(path) == POSTS_DIRNAME && File.extname(path) == '.md'
-    end
-    # So posts are added to Home in chronological order
-    post_paths.reverse!
-
-    @resource_paths.subtract post_paths
-    @resource_paths.delete home_path
-
-    post_objects = post_paths.map { |path| Post.new(path) }
-    home_object = Home.new(home_path, post_objects)
-    @all_objects = post_objects + [home_object]
-  end
-end

data/lib/post.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Sawsge
-  # A blogpost style HTML page
-  class Post < Page
-    attr_reader :date, :summary
-
-    def initialize(path)
-      super(path)
-
-      # There's got to be a more idiomatic way to do this! The
-      # current implementation is disguisting.
-      # Also doesn't work if POSTS_DIRNAME is more than 2
-      # directories
-      parts = Pathname.new(@path).each_filename.to_a[1..]
-      parts.delete(POSTS_DIRNAME)
-      @date = "#{parts[0]}-#{parts[1]}-#{parts[2]}"
-      @body.css('h1').first.add_next_sibling "<date>#{@date}</date>"
-
-      # Look what's in <summary></summary>
-      @summary = @document.css('summary').first.content
-    end
-  end
-end