static_site_builder 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d255a1dc76e27d47e5549358a8ac023117b0674a084c74bc1911f073fc5d2d55
-  data.tar.gz: 1d40b7b67100ac3b24c329035466aefb6adcb1a6dfe4bb60328bb7fea09983fb
+  metadata.gz: 441b9a8a2cb695e4a89d333ab1ea85bfd76a3f6c16b4ba747025e440098be784
+  data.tar.gz: dcb8971a377117b95ab0189ae8993b3d2b42c506e7bd8b05b9009976e77a7570
 SHA512:
-  metadata.gz: f3317e6a6cbacf72e49f07fcb4482807c4e52ef3efdff2a62176f5f47565cb7ddc73dc63a883acf45606e4521cbf2024ecb3aaf6ad8f2912c8ff75503e6f0c2a
-  data.tar.gz: b2284fce96a82d5c3aa6e7b63d89f667e2fbd52f8499325c03abf7547c25fba8a0775ef150fca74fd1e8a74f8bdd257c5eeab158dbdfbec17adf77f9cd517cd4
+  metadata.gz: beb2e52cade664496b8f3a4efa5599e2f988a48a638ffe78cd74af481c6d906d4149f95bb90f834ad324dc389c41a6d8d31ee5fbd1b1a9373b529e7482d6ea3d
+  data.tar.gz: 39aa9ce17cc9d4dd7aa4954369174f34af27e64c1b20b159d3901fef931f9c17702493001b7d181c964e9b4b17a8e5a061bd76adb70f8dcbcc777ec386ff6c9b

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
-markdown/
+/markdown/
+/test/fixtures/output
 .DS_Store
-spike.*
+.byebug_history

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.7.0

data/Gemfile

@@ -1,6 +1,8 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+ruby "~> 2.7"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in static_site_builder.gemspec
 gemspec

data/Gemfile.lock

@@ -1,32 +1,40 @@
 PATH
   remote: .
   specs:
-    static_site_builder (0.4.0)
+    static_site_builder (0.5.0)
       redcarpet (~> 3.4)
-      thor (~> 0.20)
+      thor (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    method_source (0.9.2)
-    minitest (5.11.3)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (12.3.2)
-    redcarpet (3.4.0)
-    thor (0.20.3)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    redcarpet (3.5.1)
+    thor (1.1.0)
+    yart (0.1.0)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.0)
+  byebug (~> 11.1)
   minitest (~> 5.11)
   pry (~> 0.12)
-  rake (~> 12.3)
+  rake (~> 13.0)
   static_site_builder!
+  yart (~> 0.1)
+
+RUBY VERSION
+   ruby 2.7.0p0
 
 BUNDLED WITH
-   2.0.1
+   2.2.16

data/README.md

@@ -53,6 +53,22 @@ If using your own template, you must ensure it's valid HTML and that it contains
 
 You can use this gem's built in [default template](https://github.com/michaeltelford/static_site_builder/blob/master/templates/default_template.html) as an example.
 
+## Beyond Markdown
+
+Markdown makes writing static content easy, but it doesn't support more advanced HTML features (like forms etc). You can write your own HTML within the markdown document and it will be parsed as is. Alternatively, you can use the [`yart`](https://github.com/michaeltelford/yart) gem to turn Ruby into HTML, removing the boiler plate from generating HTML.
+
+For example, placing the following code snippet inside your markdown will create a contact form in the generated HTML page:
+
+    ```yart
+    form action: "/api/contact" do
+        input type: :email, required: true
+        input type: :textarea, required: true
+        button(type: :submit) { "Send Message" }
+    end
+    ```
+
+The important bit here is the ` ```yart ` line which tells the `YART` parser to render this snippet of Ruby into HTML. Check out the [`yart README`](https://github.com/michaeltelford/yart) for more details on how to use the `YART` DSL.
+
 ## Development
 
 I welcome community contribution as long as the changes makes sense.

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 require "static_site_builder"
+require "byebug"
 
 task default: :help
 
@@ -20,7 +21,7 @@ task :build_site, :markdown_dirpath, :output_dirpath do |t, args|
   args.with_defaults(output_dirpath: "./markdown/html")
   puts StaticSiteBuilder.build_website(
     args[:markdown_dirpath],
-    StaticSiteBuilder::HTMLTemplater.new,
+    StaticSiteBuilder::TemplateRenderer.new,
     args[:output_dirpath]
   )
 end

data/exe/site_builder

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
 require "static_site_builder"
 require "thor"
 
-DEFAULT_TEMPLATE = StaticSiteBuilder::HTMLTemplater::DEFAULT_TEMPLATE
+DEFAULT_TEMPLATE = StaticSiteBuilder::TemplateRenderer::DEFAULT_TEMPLATE
 
 class SiteBuilderCLI < Thor
   desc "build", "Builds a static HTML website from markdown"
@@ -16,20 +17,20 @@ class SiteBuilderCLI < Thor
     desc: "HTML template which embeds the markdown (<body>) of each webpage"
   )
   def build
-    template = StaticSiteBuilder::HTMLTemplater.new(
+    template = StaticSiteBuilder::TemplateRenderer.new(
       template_filepath: options[:template],
       gem_included_template: options[:template] == DEFAULT_TEMPLATE
     )
 
-    html = StaticSiteBuilder.build_website(
+    html_files = StaticSiteBuilder.build_website(
       options[:in],
       template,
       options[:out]
     )
 
-    if not html.empty?
-      puts "Site built with #{html.length} HTML file(s):"
-      puts html
+    unless html_files.empty?
+      puts "Site built with #{html_files.length} HTML file(s):"
+      puts html_files
     else
       puts "No markdown files found in: #{options[:in]}"
     end

data/lib/static_site_builder.rb

@@ -1,64 +1,64 @@
-# Require all lib files here to enable a single require.
-require "static_site_builder/version"
-require "static_site_builder/html_templater"
-
 # Require any non lib code here to enable a single require.
 require "fileutils"
 require "redcarpet"
 
+# Require all lib files here to enable a single require.
+require "static_site_builder/version"
+require "static_site_builder/renderers/renderer"
+require "static_site_builder/renderers/yart_renderer"
+require "static_site_builder/renderers/markdown_renderer"
+require "static_site_builder/renderers/template_renderer"
+
 module StaticSiteBuilder
-  # Converts markdown to html and returns it.
-  def self.render(markdown)
-    renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
-      tables: true,
-      fenced_code_blocks: true,
-      autolink: true,
-      strikethrough: true,
-      superscript: true,
-      underline: true,
-      highlight: true,
-      quote: true,
-      footnotes: true
-    )
-    renderer.render(markdown)
+  # Takes a markdown_dirpath, finds all "*.md" files and converts each to a
+  # "*.html" file in order to build a static website. A template is used to
+  # embed each built webpage in. The output_dirpath will default to the
+  # markdown_dirpath if not set.
+  def self.build_website(markdown_dirpath, template, output_dirpath=nil)
+    pattern = "#{markdown_dirpath}/*.md"
+
+    Dir.glob(pattern).map { |f| self.build_webpage(f, template, output_dirpath) }
   end
 
+  private
+
   # Takes a markdown_filepath, reads and converts its contents to html before
   # creating a html file of the same name in the output_dirpath directory.
   # If not provided, the output_dirpath will be the same directory as the
   # markdown file. The output_dirpath will be created if not already.
-  # Note: If the html file already exists it's contents will be overwritten.
+  # Note: If the html file already exists its contents will be overwritten.
   # A template is used to house the html body in, creating a full webpage.
   def self.build_webpage(markdown_filepath, template, output_dirpath=nil)
-    markdown = File.read(markdown_filepath)
+    markdown_filepath = self.remove_trailing_slash(markdown_filepath)
+    output_dirpath = self.remove_trailing_slash(output_dirpath)
 
-    html_body = self.render(markdown)
-    html = template.render(html_body)
+    markdown = File.read(markdown_filepath)
+    html = self.apply_renderers(template, markdown)
 
     dirpath = File.dirname(markdown_filepath)
     output_dirpath ||= dirpath
-    FileUtils.mkdir_p(output_dirpath) unless Dir.exists?(output_dirpath)
+    FileUtils.mkdir_p(output_dirpath) unless Dir.exist?(output_dirpath)
 
     filename_with_md_ext = File.basename(markdown_filepath)
-    filename_without_md_ext = filename_with_md_ext.split(".md")[0]
-    html_filepath = "#{output_dirpath}/#{filename_without_md_ext}.html"
+    filename_without_md_ext = filename_with_md_ext.gsub(".md", "")
 
+    html_filepath = "#{output_dirpath}/#{filename_without_md_ext}.html"
     File.open(html_filepath, "w") { |f| f.write(html) }
+
     html_filepath
   end
 
-  # Takes a markdown_dirpath, finds all "*.md" files and converts each to a
-  # "*.html" file in order to build a static website. A template is used to
-  # embed each built webpage in. The output_dirpath will default to the
-  # markdown_dirpath if not set.
-  def self.build_website(markdown_dirpath, template, output_dirpath=nil)
-    html_filepaths = []
-    pattern = "#{markdown_dirpath}/*.md"
+  # Removes the trailing / (if present) and returns.
+  def self.remove_trailing_slash(filepath)
+    return filepath unless filepath.end_with?("/")
 
-    Dir.glob(pattern).each do |f|
-      html_filepaths << self.build_webpage(f, template, output_dirpath)
-    end
+    filepath.chop
+  end
 
-    html_filepaths
+  # Apply the necessary renderers to the Markdown, returning a HTML String.
+  def self.apply_renderers(template, markdown)
+    markdown = YARTRenderer.new(markdown).render
+    html_body = MarkdownRenderer.new(markdown).render
+    template.render(html_body)
   end
 end

data/lib/static_site_builder/renderers/markdown_renderer.rb

@@ -0,0 +1,30 @@
+module StaticSiteBuilder
+  # Renders Markdown into HTML. Any existing HTML inside the Markdown will NOT be removed,
+  # allowing other renderers to be applied before this one where required.
+  class MarkdownRenderer < Renderer
+    attr_reader :markdown
+
+    def initialize(markdown)
+      super()
+
+      @markdown = markdown
+      @redcarpet = Redcarpet::Markdown.new(
+        Redcarpet::Render::HTML,
+        tables: true,
+        fenced_code_blocks: true,
+        autolink: true,
+        strikethrough: true,
+        superscript: true,
+        underline: true,
+        highlight: true,
+        quote: true,
+        footnotes: true,
+      )
+    end
+
+    # Returns a String of HTML (rendered from the given Markdown).
+    def render
+      @redcarpet.render(@markdown)
+    end
+  end
+end

data/lib/static_site_builder/renderers/renderer.rb

@@ -0,0 +1,11 @@
+module StaticSiteBuilder
+  # Renderer super class to be inherited from.
+  class Renderer
+    def initialize
+    end
+
+    def render
+      raise "Missing `render` method in sub-class"
+    end
+  end
+end

data/lib/static_site_builder/{html_templater.rb → renderers/template_renderer.rb}

@@ -1,7 +1,8 @@
 module StaticSiteBuilder
-  class HTMLTemplater
-    EDITABLE_REGION = '<div id="editable_region"></div>'.freeze
-    DEFAULT_TEMPLATE = "templates/default_template.html".freeze
+  # Renders the given HTML body inside the given HTML webpage template.
+  class TemplateRenderer < Renderer
+    EDITABLE_REGION  = '<div id="editable_region"></div>'.freeze
+    DEFAULT_TEMPLATE = "../templates/default_template.html".freeze
 
     attr_reader :template_filepath, :gem_included_template, :html
 
@@ -18,15 +19,15 @@ module StaticSiteBuilder
         gem_included_template: true,
         html: nil
       )
+      super()
+
       @template_filepath = template_filepath
       @gem_included_template = gem_included_template
       @html = html
 
       read_template unless @html
 
-      if not valid?
-        raise "Missing editable region in template: #{EDITABLE_REGION}"
-      end
+      raise "Missing editable region in template: #{EDITABLE_REGION}" unless valid?
     end
 
     # Returns wether or not the @html has an EDITABLE_REGION or not.
@@ -45,15 +46,17 @@ module StaticSiteBuilder
 
     private
 
-    # Reads the @template_filepath file and sets @html to it's contents.
+    # Reads the @template_filepath file and sets @html to its contents.
     # The correct filepath is decided on based on wether or not the template is
     # built into the gem or on the user's local filesystem.
     def read_template
       path = @template_filepath
+
       if @gem_included_template
         relative_path = "../../#{@template_filepath}"
         path = File.expand_path(relative_path, File.dirname(__FILE__))
       end
+
       @html = File.read(path)
     end
   end

data/lib/static_site_builder/renderers/yart_renderer.rb

@@ -0,0 +1,56 @@
+def yart_installed?
+  require("yart")
+  true
+rescue LoadError
+  puts "Skipping YART rendering because the 'yart' gem isn't installed"
+  false
+end
+
+$yart_installed = yart_installed?
+
+module StaticSiteBuilder
+  # Renders YART snippets into HTML (within a Markdown document).
+  class YARTRenderer < Renderer
+    YART_START_LINE   = "```yart"
+    YART_END_LINE     = "```"
+    YART_PARSE_ERROR  = "'YART.parse' detected in markdown, remove it leaving just the block to be parsed by YART"
+
+    attr_reader :markdown
+
+    def initialize(markdown)
+      super()
+
+      @markdown = markdown
+    end
+
+    # Returns a String of Markdown (having recursively rendered any found YART snippets into HTML).
+    def render
+      return @markdown unless $yart_installed
+
+      lines = @markdown.split("\n")
+      return @markdown unless yart_snippet?(lines)
+
+      yart_lines = extract_yart_lines(lines)
+      yart_snippet = yart_lines[1..-2].join("\n")
+      raise YART_PARSE_ERROR if yart_snippet.include?("YART.parse")
+
+      html = YART.parse { eval(yart_snippet) }
+      @markdown.sub!(yart_lines.join("\n"), html)
+
+      render
+    end
+
+    private
+
+    def yart_snippet?(lines)
+      lines.include?(YART_START_LINE) && lines.include?(YART_END_LINE)
+    end
+
+    def extract_yart_lines(lines)
+      start  = lines.find_index(YART_START_LINE)
+      finish = lines.find_index(YART_END_LINE)
+
+      lines[start..finish]
+    end
+  end
+end

data/lib/static_site_builder/version.rb

@@ -1,3 +1,3 @@
 module StaticSiteBuilder
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/static_site_builder.gemspec

@@ -13,10 +13,10 @@ Gem::Specification.new do |spec|
   spec.description   = "Gem for building static content websites from markdown."
   spec.homepage      = "https://github.com/michaeltelford/static_site_builder"
   spec.license       = "MIT"
-  
+
   spec.post_install_message = "Added the executable 'site_builder' to $PATH"
 
-  spec.required_ruby_version = '~> 2.5'
+  spec.required_ruby_version = '~> 2.7'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -35,10 +35,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "byebug", "~> 11.1"
+  spec.add_development_dependency "yart", "~> 0.1"
 
   spec.add_runtime_dependency "redcarpet", "~> 3.4"
-  spec.add_runtime_dependency "thor", "~> 0.20"
+  spec.add_runtime_dependency "thor", "~> 1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static_site_builder
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Michael Telford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-04 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: yart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '1.1'
 description: Gem for building static content websites from markdown.
 email:
 - michael.telford@live.com
@@ -115,7 +143,10 @@ files:
 - bin/setup
 - exe/site_builder
 - lib/static_site_builder.rb
-- lib/static_site_builder/html_templater.rb
+- lib/static_site_builder/renderers/markdown_renderer.rb
+- lib/static_site_builder/renderers/renderer.rb
+- lib/static_site_builder/renderers/template_renderer.rb
+- lib/static_site_builder/renderers/yart_renderer.rb
 - lib/static_site_builder/version.rb
 - static_site_builder.gemspec
 - templates/default_template.html
@@ -132,15 +163,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gem for building static content websites from markdown.