sawsge 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8b4aef4881751a78644ad5d9073f8e16502c48729642206cc7f8c21194f847
-  data.tar.gz: 12d90812a34c228dae1889e9790e6bfda0f5a6afe30a283183f4433eb202fcdc
+  metadata.gz: e97f4efdfda6c24333e69d1e5a213ff5cf838886620b6a66253e4b15a270bec7
+  data.tar.gz: 9e3d40a49c624280265c5189a20bb95bdab602227e9161925b737f42d0fcd701
 SHA512:
-  metadata.gz: 9f7839d4b44fd4a455cea7f0959fbc8ae16406232205a8e469931e6184aabbee9d4187bb5fcca236073aab95613ed0c1fa579d5694e9c5aa603e8e5d4d2291d6
-  data.tar.gz: 132760b63b2b18f681da97c5352b529b6eb61be97b76151fc74f5be98dd17b5ce02807c9aa0117157b2c5b9b07ba81c73633a6c7719318660a3cf70d935c9527
+  metadata.gz: 25633584a07e77f02536dfbe23cba4e91ad68c72b3c55d7def67e48775cb14db57e1d9459d26514bdc7f42261d129fe017b6432e1fc9de54909907dbf74c2e4c
+  data.tar.gz: 2aa82092c2e6a97afb34a639f02dd93f4f342c8491232812c6ea0da99782d9092cbb777642b4da0a0d2e495d204da80785395abc87cbf76760b8c8a0959efc6f

data/Gemfile

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

data/README.md

@@ -1,11 +1,12 @@
 # sawsge
+
 My simple static site generator for blogs or projects.
 
 ## Installation
 
 Sawsge is availible as a
 [Gem](https://rubygems.org/gems/sawsge) and as an [AUR
-package].
+package](https://aur.archlinux.org/packages/sawsge).
 
 Install as a Gem: `gem install sawsge`
 
@@ -14,10 +15,20 @@ installed.
 
 Install from the AUR: `paru -S sawsge`
 
+## Usage
+
+Run `sawsge [DIRECTORY]` where `[DIRECTORY]` is the source
+directory root. If `[DIRECTORY]` is not provided, Sawsge
+will target `./`
+
 ## File Structure
-In the source directory root should exist `header.html`, `footer.html`, and `config.toml`. Additional files may need to exist for different modes.
+
+In the source directory root should exist `header.html`,
+`footer.html`, and `config.toml`. Additional files may need
+to exist for different modes.
 
 ## Config
+
 Here's an example config for a project:
 ```toml
 [general]
@@ -48,10 +59,28 @@ posts_dirname = "post"
 ```
 
 # General Operation
-Sawsge makes all links on the site point to directories, so there is no `index.html` at the end of any URL (example.com/thing/index.html vs example.com/thing/). Sawsge will build your website to `out_dirname` in your config; make sure there are no files in there, as they will be deleted! 
+
+Sawsge makes all links on the site point to directories, so
+there is no `index.html` at the end of any URL
+(example.com/thing/index.html vs example.com/thing/). Sawsge
+will build your website to `out_dirname` in your config;
+make sure there are no files in there, as they will be
+deleted!
 
 ## Blog Mode
-Blog mode creates a special homepage with the title and a summary of each post, with latest posts at the top. In blog mode, sawsge will look for posts under `posts_dirname` in the config. In `posts_dirname`, each post should be in a directory specifying its date in YYYY/MM/DD format, e.g. `/[posts_dirname]/2021/03/09/index.md`. In its source, the post should include at least one `<h1></h1>` and one `<summary></summary>`HTML block. Both will be used to generate the summary on the front page.
 
-## Usage
-Run `sawsge [dir]` where `[dir]` is the source directory root.
+Blog mode creates a special homepage with the title and a
+summary of each post, with latest posts at the top. In blog
+mode, sawsge will look for posts under `posts_dirname` in
+the config. In `posts_dirname`, each post should be in a
+directory specifying its date in YYYY/MM/DD format, e.g.
+`/[posts_dirname]/2021/03/09/index.md`. In its source, the
+post should include at least one `<h1></h1>` and one
+`<summary></summary>`HTML block. Both will be used to
+generate the summary on the front page.
+
+## Project Mode
+
+Project mode is much simpler than blog mode. It performs no
+special handling with different files--each Markdown file
+will be generated as a plain page.

data/bin/sawsge

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

data/lib/sawsge/blog.rb

@@ -0,0 +1,23 @@
+# 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
+    # So posts are added to Home in chronological order
+    post_paths.reverse!
+
+    @resource_paths -= post_paths
+    @resource_paths.delete home_path
+
+    post_objects = post_paths.map { |path| Post.new(path, @config) }
+    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,34 @@
+# 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))
+
+      @reserved_filenames = config[:general][:ignore] + [CONFIG_FILENAME, @header_filename, @footer_filename]
+
+      @external_links_target_blank = config[:general][:external_links_target_blank]
+
+      @posts_dirname = config[:blog][:posts_dirname]
+    end
+  end
+end

data/lib/sawsge/home.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Sawsge
+  # The homepage
+  class Home < Page
+    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
+          <details open>
+            <summary>
+              <a href=\"/#{File.dirname(post.path)}\">#{post.title}</a> <date>#{post.date}</date>
+            </summary>
+            <p>#{post.summary}</p>
+            <a href=\"#{File.dirname(post.path)}\">Read more</a>
+          </details>
+        HTML
+        @document.at_css('footer').add_previous_sibling summary_fragment
+      end
+    end
+  end
+end

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

@@ -1,58 +1,61 @@
 # 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)
+
+      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 ? h1.content : ''
-               end
+        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
         # blank. mailto links are also ignored, as common
         # obfuscation techniques can interfere with Nokogiri.
         external_links = @document.css('a').reject do |link|
-          begin
           uri = URI(link['href'])
           # If a link is malformed, it's not sawsge's problem
           # to fix.
-          rescue URI::InvalidComponentError
-            false
-          else
-            host = uri.host
-            scheme = uri.scheme
-            host.nil? or host.empty? or scheme == 'mailto' or (not link['target'].nil?)
-          end
+        rescue URI::InvalidComponentError
+          false
+        else
+          host = uri.host
+          scheme = uri.scheme
+          host.nil? or host.empty? or scheme == 'mailto' or !link['target'].nil?
         end
         external_links.each { |link| link['target'] = '_blank' }
       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)
+      File.new(out_path, 'w').syswrite(serialized_html)
     end
   end
 end

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

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
-module Sawsge
+class Sawsge
   # A blogpost style HTML page
   class Post < Page
     attr_reader :date, :summary
-    def initialize(path)
-      super(path)
+
+    def initialize(path, config)
+      super(path, config)
 
       # 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)
+      parts.delete(config.posts_dirname)
       @date = "#{parts[0]}-#{parts[1]}-#{parts[2]}"
-      @body.css('h1').first.add_next_sibling "<date>#{@date}</date>"
+      @document.css('h1').first.add_next_sibling "<date>#{@date}</date>"
 
       # Look what's in <summary></summary>
       @summary = @document.css('summary').first.content

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,14 +1,18 @@
-module Sawsge
+# frozen_string_literal: true
+
+class Sawsge
   # Any generic file in the website directory
   class Resource
     attr_reader :path
+
     def initialize(path)
       # Path is relative to SRC_DIR, does not include it
       @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.2'
+class Sawsge
+  VERSION = '0.2.1'
 end

data/lib/sawsge.rb

@@ -5,83 +5,63 @@ require 'nokogiri'
 require 'pandoc-ruby'
 require 'pathname'
 require 'set'
-require 'toml'
+require 'tomlrb'
 require 'uri'
+require 'parallel'
+
+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
 
-require_relative 'resource'
-require_relative 'page'
-require_relative 'post'
-require_relative 'home'
-require_relative 'blog'
-require_relative 'project'
-
-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 &&
+        !@config.reserved_filenames.include?(path)
+    end
 
     @resource_objects = Set.new
     @all_objects = Set.new
 
-
-    self.send MODE
+    send @config.mode
 
     resources = @resource_paths.map { |path| Resource.new(path) }
-    @all_objects.merge resources
-
+    @all_objects += resources
 
     # Delete any old builds
-    if Pathname.new(OUT_DIRNAME).exist?
-      FileUtils.remove_dir OUT_DIRNAME
-    end
-    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 { |object| object.build }
+    @all_objects.each { |x| x.build @config.out_dirname }
+    Parallel.each(@all_object) { |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.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Sawyer Shepherd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-05-03 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/home.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Sawsge
-  # The homepage
-  class Home < Page
-    def initialize(path, posts)
-      super(path)
-      posts.each do |post|
-        # Adds collapseable summary of each post on the front
-        # page
-        summary_fragment = Nokogiri::HTML5.fragment <<~HTML
-            <details open>
-              <summary>
-                <a href=\"/#{File.dirname(post.path)}\">#{post.title}</a> <date>#{post.date}</date>
-              </summary>
-              <p>#{post.summary}</p>
-              <a href=\"#{File.dirname(post.path)}\">Read more</a>
-            </details>
-          HTML
-        @document.at_css('footer').add_previous_sibling summary_fragment
-      end
-    end
-  end
-end