sawsge 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8b4aef4881751a78644ad5d9073f8e16502c48729642206cc7f8c21194f847
-  data.tar.gz: 12d90812a34c228dae1889e9790e6bfda0f5a6afe30a283183f4433eb202fcdc
+  metadata.gz: b8cb16b8c9c5893d01c2d1fc0ba82457e24a9f6fcb670781f9990aecac4773ba
+  data.tar.gz: 9388f1a50ff785504b8e5b9463b45418f25f9b43de33f93838d06742b8ab6e02
 SHA512:
-  metadata.gz: 9f7839d4b44fd4a455cea7f0959fbc8ae16406232205a8e469931e6184aabbee9d4187bb5fcca236073aab95613ed0c1fa579d5694e9c5aa603e8e5d4d2291d6
-  data.tar.gz: 132760b63b2b18f681da97c5352b529b6eb61be97b76151fc74f5be98dd17b5ce02807c9aa0117157b2c5b9b07ba81c73633a6c7719318660a3cf70d935c9527
+  metadata.gz: cb1c6014f224e896b001420fbf3c96a30b16571d1dbadcc05f6d5f623b7bf550692b3dbccd721453ca520a8b74df8ada8e9cccfc9e41c3d31959aa62428c1231
+  data.tar.gz: 67e941e2c2ea82468bf51b30232fcfb32e9103b4d762336652d29de3211997217d265cafe349b0f74c7db534ef27713974edf26d8d4baeeec25463d4b0b61240

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/lib/blog.rb

@@ -2,22 +2,22 @@
 
 module Sawsge
   def self.blog
-      home_path = 'index.md'
+    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!
+    # 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
+    @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]
+    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

@@ -9,14 +9,14 @@ module Sawsge
         # 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
+          <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

data/lib/page.rb

@@ -4,6 +4,7 @@ module Sawsge
   # An HTML page
   class Page < Resource
     attr_reader :title
+
     def initialize(path)
       super(path)
       html_body_fragment = PandocRuby.convert(File.new(@path, 'r').read, from: :markdown, to: :html)
@@ -17,9 +18,9 @@ module Sawsge
       # 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 = @body.at_css('h1')
+        h1 ? h1.content : ''
+      end
       @document.at_css('title').content = @title
 
       if EXTERNAL_LINKS_TARGET_BLANK
@@ -29,21 +30,18 @@ module Sawsge
         # 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
@@ -52,7 +50,7 @@ module Sawsge
       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

@@ -4,6 +4,7 @@ module Sawsge
   # A blogpost style HTML page
   class Post < Page
     attr_reader :date, :summary
+
     def initialize(path)
       super(path)
 

data/lib/resource.rb

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 module 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)

data/lib/sawsge/version.rb

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

data/lib/sawsge.rb

@@ -16,7 +16,6 @@ require_relative 'blog'
 require_relative 'project'
 
 module Sawsge
-
   HELP_STRING = 'Usage: sawsge [DIRECTORY]'
 
   SRC_DIR = ARGV[0] || Dir.pwd
@@ -30,7 +29,6 @@ module Sawsge
   # TODO: Put these in the config
   POSTS_DIRNAME = CONFIG['blog']['posts_dirname']
 
-
   HEADER_FILENAME = CONFIG['general']['header_filename']
   FOOTER_FILENAME = CONFIG['general']['footer_filename']
 
@@ -46,7 +44,6 @@ module Sawsge
 
   MODE = CONFIG['general']['mode']
 
-
   # Returns the first directory in a path, eg.
   # `foo/bar/bin.txt` becomes `foo`
   def self.top_parent_dir(path)
@@ -67,21 +64,16 @@ module Sawsge
     @resource_objects = Set.new
     @all_objects = Set.new
 
-
-    self.send MODE
+    send MODE
 
     resources = @resource_paths.map { |path| Resource.new(path) }
     @all_objects.merge resources
 
-
     # Delete any old builds
-    if Pathname.new(OUT_DIRNAME).exist?
-      FileUtils.remove_dir OUT_DIRNAME
-    end
+    FileUtils.remove_dir OUT_DIRNAME if Pathname.new(OUT_DIRNAME).exist?
     FileUtils.mkpath OUT_DIRNAME
 
-
     # Write each file
-    @all_objects.each { |object| object.build }
+    @all_objects.each(&:build)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sawsge
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sawyer Shepherd