static_site_builder 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e6e265e60bc23ea318b0736c778efd4a5acdeb2378a07dc21e848d1288d2050
+  data.tar.gz: 1a625002dd47b9034a4f88b58d095ce81a3328884846ede2b7d5e38120e4f139
+SHA512:
+  metadata.gz: 957179e544171175d94d867ad78431c36f825176303192ceb53a8e677d6ae3a1d3306c90ad92a5d69358aa7a0b14aa92134252eed1155d623cbadd3d04cc1561
+  data.tar.gz: 015bf0e7f5f4392aa5b8b54c43dc6e91029d28b4eeb4192d9de5a9a219c6786658235370899ac1e2ebe57d9ed001ce1aaba4f5639ec8923bca4eca8108ec6142

data/.dockerignore

@@ -0,0 +1,7 @@
+.DS_Store
+README.md
+LICENSE.txt
+Dockerfile
+CODE_OF_CONDUCT.md
+.travis.yml
+.dockerignore

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+markdown/
+.DS_Store
+spike.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at michael.telford@live.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,24 @@
+FROM ruby:2.4-alpine3.4
+MAINTAINER Michael Telford
+
+RUN apk --update add --virtual \
+      build_deps \
+      build-base \
+      ruby-dev \
+      libc-dev \
+      linux-headers \
+      openssl-dev \
+      postgresql-dev \
+      libxml2-dev \
+      libxslt-dev \
+      bash \
+      make \
+      git \
+      curl \
+      curl-dev \
+      jq
+
+WORKDIR /app
+COPY . /app
+
+CMD ["bash"]

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    static_site_builder (0.2.0)
+      redcarpet (~> 3.4)
+      thor (~> 0.20)
+
+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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.11)
+  pry (~> 0.12)
+  rake (~> 12.3)
+  static_site_builder!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michael Telford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Static Site Builder
+
+Build a HTML website from markdown files.
+
+This gem will convert your markdown files into HTML files, embedding the generated HTML into a template (making up the full webpage). This gem's default [Bootstrap](https://getbootstrap.com/) template will be used unless you specify a template of your own. More on this further down.
+
+## Installation
+
+    $ gem install static_site_builder
+
+This will add an executable called `site_builder` to your `$PATH`.
+
+## Usage
+
+```sh
+$ mkdir -p ~/my_site
+$ cd ~/my_site
+$ echo "# My Amazing Website" >> index.md
+$ site_builder build
+Site built with 1 HTML file(s):
+./index.html
+$ open index.html
+```
+
+That's it! In this instance, there will be a newly generated mobile friendly `index.html` file in the same directory.
+
+Of course, you can specify an input and output directory as well as a custom HTML template to use instead of the default one.
+
+For full usage of `site_builder`, see:
+
+    $ site_builder help build
+
+## Templating
+
+The default template uses Bootstrap 4.1 to enable a stylish and responsive website design out of the box.
+
+Custom templates are simply HTML files which include an editable region (inside a `<body>` tag) consisting of the following markdown:
+
+```html
+<div id="editable_region"></div>
+```
+
+The editable region `div` will be replaced with the generated HTML from your markdown.
+
+Of course you can include anything else that's common to your site in your template e.g.
+
+- Navigation menu
+- Links to your own style sheets
+- Javascript applying to the whole site
+- etc...
+
+If using your own template, you must ensure it's valid HTML and that it contains the editable region `div` seen above. That's it.
+
+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.
+
+## Development
+
+I welcome community contribution as long as the changes makes sense.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `*.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/michaeltelford/static_site_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/michaeltelford/static_site_builder/blob/master/LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the StaticSiteBuilder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/michaeltelford/static_site_builder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "static_site_builder"
+
+task default: :help
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :help do
+  system "rake -D"
+end
+
+desc "Builds a static HTML site from markdown files"
+task :build_site, :markdown_dirpath, :output_dirpath do |t, args|
+  args.with_defaults(markdown_dirpath: "./markdown")
+  args.with_defaults(output_dirpath: args[:markdown_dirpath])
+  puts StaticSiteBuilder.build_website(
+    args[:markdown_dirpath],
+    StaticSiteBuilder::HTMLTemplater.new,
+    args[:output_dirpath]
+  )
+end

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "static_site_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+def reload
+  load "./lib/static_site_builder.rb"
+end
+
+puts "Type 'reload' to pull in new code changes."
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/site_builder

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "static_site_builder"
+require "thor"
+
+DEFAULT_TEMPLATE = StaticSiteBuilder::HTMLTemplater::DEFAULT_TEMPLATE
+
+class SiteBuilderCLI < Thor
+  desc "build", "Builds a static HTML website from markdown"
+  option :in, default: ".", desc: "Input markdown file dir"
+  option :out, default: ".", desc: "Output HTML file dir"
+  option(
+    :template,
+    default: DEFAULT_TEMPLATE,
+    desc: "HTML template which embeds the markdown (<body>) of each webpage"
+  )
+  def build
+    template = StaticSiteBuilder::HTMLTemplater.new(
+      template_filepath: options[:template],
+      gem_included_template: options[:template] == DEFAULT_TEMPLATE
+    )
+
+    html = StaticSiteBuilder.build_website(
+      options[:in],
+      template,
+      options[:out]
+    )
+
+    if not html.empty?
+      puts "Site built with #{html.length} HTML file(s):"
+      puts html
+    else
+      puts "No markdown files found in: #{options[:in]}"
+    end
+  rescue Exception => ex
+    puts "An error occurred: #{ex.message}"
+  end
+end
+
+SiteBuilderCLI.start(ARGV)

data/lib/static_site_builder.rb

@@ -0,0 +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"
+
+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)
+  end
+
+  # 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.
+  # 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)
+
+    html_body = self.render(markdown)
+    html = template.render(html_body)
+
+    dirpath = File.dirname(markdown_filepath)
+    output_dirpath ||= dirpath
+    FileUtils.mkdir_p(output_dirpath) unless Dir.exists?(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"
+
+    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"
+
+    Dir.glob(pattern).each do |f|
+      html_filepaths << self.build_webpage(f, template, output_dirpath)
+    end
+
+    html_filepaths
+  end
+end

data/lib/static_site_builder/html_templater.rb

@@ -0,0 +1,60 @@
+module StaticSiteBuilder
+  class HTMLTemplater
+    EDITABLE_REGION = '<div id="editable_region"></div>'.freeze
+    DEFAULT_TEMPLATE = "templates/default_template.html".freeze
+
+    attr_reader :template_filepath, :gem_included_template, :html
+
+    # Initializes a HTML template with either a template_filepath to a HTML file
+    # or a HTML string. Either way the HTML should be valid and contain the
+    # EDITABLE_REGION. If no params are provided then the DEFAULT_TEMPLATE is
+    # used instead. The DEFAULT_TEMPLATE uses bootstrap 4 (from a CDN).
+    # The html takes precedence over the template_filepath if provided.
+    # The gem_included_template param distinguishes between a user created
+    # template (on their local file system) and an included template (built
+    # into the gem) e.g. the DEFAULT_TEMPLATE.
+    def initialize(
+        template_filepath: DEFAULT_TEMPLATE,
+        gem_included_template: true,
+        html: nil
+      )
+      @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
+    end
+
+    # Returns wether or not the @html has an EDITABLE_REGION or not.
+    # This method does not check if the HTML is valid or not. That's your
+    # responsibility.
+    def valid?
+      @html.include?(EDITABLE_REGION)
+    end
+
+    # Renders the HTML template by replacing the EDITABLE_REGION with the
+    # html_body param. It's your responsibility to ensure the html_body is valid
+    # HTML within the context of a 'body' tag e.g. <body>#{html_body}</body>
+    def render(html_body)
+      @html.gsub(EDITABLE_REGION, html_body)
+    end
+
+    private
+
+    # Reads the @template_filepath file and sets @html to it's 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
+end

data/lib/static_site_builder/version.rb

@@ -0,0 +1,3 @@
+module StaticSiteBuilder
+  VERSION = "0.2.0"
+end

data/static_site_builder.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "static_site_builder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "static_site_builder"
+  spec.version       = StaticSiteBuilder::VERSION
+  spec.authors       = ["Michael Telford"]
+  spec.email         = ["michael.telford@live.com"]
+
+  spec.summary       = "Static site builder."
+  spec.description   = "Gem for building static content websites from markdown."
+  spec.homepage      = "https://github.com/michaeltelford/static_site_builder"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '~> 2.5'
+
+  # 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.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ["site_builder"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "pry", "~> 0.12"
+
+  spec.add_runtime_dependency "redcarpet", "~> 3.4"
+  spec.add_runtime_dependency "thor", "~> 0.20"
+end

data/templates/default_template.html

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/css/bootstrap.min.css" integrity="sha384-WskhaSGFgHYWDcbwN70/dfYBj47jz9qbsMId/iRN3ewGhXQFZCSftd1LZCfmhktB" crossorigin="anonymous">
+</head>
+<body>
+  <div id="editable_region"></div>
+</body>
+</html>

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: static_site_builder
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Michael Telford
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: Gem for building static content websites from markdown.
+email:
+- michael.telford@live.com
+executables:
+- site_builder
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/site_builder
+- lib/static_site_builder.rb
+- lib/static_site_builder/html_templater.rb
+- lib/static_site_builder/version.rb
+- static_site_builder.gemspec
+- templates/default_template.html
+homepage: https://github.com/michaeltelford/static_site_builder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Static site builder.
+test_files: []