frontman-ssg 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 874f589b9d149419ec7d8c8fa1b4891ecb9ab1af9a396bf50f5955d70757a6df
+  data.tar.gz: 1f3da03d51ae4352212258f02f91631463709b39204578b4ebc096fef1c6899e
+SHA512:
+  metadata.gz: a8f152c9dc2f6f3bc2c949beb5f9a6daf6b2c2308ef5beac28dc735711c5715f4e5bd565d2eba86f4ff3836e0f538e82936e2b998ab69a658b59053031f51fad
+  data.tar.gz: a62dea5dc5054e61a171852425d5f1ee3c750f6c2ee231d41f6b6a03d63a2c35f29e5919021166650e5411725a83d2930334692d8de947c2f8b3823cc2355e35

data/.circleci/config.yml

@@ -0,0 +1,42 @@
+version: 2.1
+
+jobs:
+  build:
+    parameters:
+      ruby_version:
+        type: string
+
+    working_directory: ~/repo
+    docker:
+      - image: circleci/ruby:<< parameters.ruby_version >>
+
+    steps:
+      - checkout
+      - run:
+          name: Install dependencies
+          command: |
+            gem install bundler
+            bundle check || bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - run:
+          name: Lint code
+          command: |
+            bundle exec rubocop
+
+      - run:
+          name: Check types
+          command: |
+            bundle exec srb tc . --ignore=/vendor
+
+      - run:
+          name: Run tests
+          command: |
+            bundle exec rspec
+
+workflows:
+  workflow:
+    jobs:
+      - build:
+          matrix:
+            parameters:
+              ruby_version: ["2.3", "2.4", "2.5", "2.6", "2.7"]

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,9 @@
+# Code of conduct
+
+**All people who choose to be part of the community are required to agree with the following code of conduct.**
+This code of conduct is based on [Ruby's code of conduct](https://www.ruby-lang.org/en/conduct/). 
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: "bug"
+---
+
+## Description
+
+<!-- A clear and concise description of what the bug is. -->
+
+## How to reproduce
+
+<!-- Exact steps to reproduce the behavior, with details of your (development) environment. -->
+
+## Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+## Suggested solution
+<!-- If you have one, you can suggest a solution. -->
+
+## Relevant resources
+
+<!-- If applicable, add files, urls and/or screenshots to help explain your problem. -->

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest a new feature for this project
+title: ''
+labels: "enhancement"
+---
+
+## Description
+
+<!-- A clear and concise description of what the new feature should entail. -->
+
+## Motivation
+
+<!-- A clear and concise description of why this new feature is needed, e.g., "I find it frustrating that [...]" -->
+
+## Solution
+
+<!-- A clear and concise description of a solution you already have in mind, if any. -->
+
+## Additional context
+
+<!-- Add any other context or screenshots about the feature request here. -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+| Q                 | A
+| ----------------- | ----------
+| Bug fix?          | yes/no
+| New feature?      | yes/no
+| Related issue     | fix #... <!-- remove this line if not fixing any issue -->
+
+## Description
+<!--
+
+Please give a clear and concise
+description of what the PR does.
+
+-->
+
+## Tested
+<!--
+
+Please give a clear and concise
+description of how you tested your PR.
+
+-->
+

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+/coverage
+Gemfile.lock
+spec/frontman/build
+

data/.rubocop.yml

@@ -0,0 +1,88 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - '**/Rakefile'
+    - 'vendor/**/*'
+
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'frontman-ssg.gemspec'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/**/*'
+    - 'project-templates/**/*'
+
+Style/MethodMissingSuper:
+  Exclude:
+    - 'lib/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/frontman/sitemap_tree.rb'
+    - 'lib/frontman/data_store.rb'
+    - 'lib/frontman/builder/builder.rb'
+    - 'lib/frontman/commands/**/*'
+    - 'lib/frontman/resource.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/frontman/sitemap_tree.rb'
+    - 'lib/frontman/data_store.rb'
+    - 'lib/frontman/builder/statistics_collector.rb'
+    - 'lib/frontman/commands/**/*'
+    - 'lib/frontman/resource.rb'
+
+Style/ClassVars:
+  Exclude:
+    - 'lib/frontman/sitemap_tree.rb'
+    - 'lib/frontman/bootstrapper.rb'
+    - 'lib/frontman/config.rb'
+    - 'lib/frontman/resource.rb'
+    - 'lib/frontman/data_store_file.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/frontman/app.rb'
+    - 'lib/frontman/builder/builder.rb'
+    - 'lib/frontman/resource.rb'
+    - 'lib/frontman/sitemap_tree.rb'
+
+Style/ConditionalAssignment:
+  Exclude:
+    - 'lib/frontman/builder/builder.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/frontman/resource.rb'
+    - 'lib/frontman/commands/serve.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/frontman/resource.rb'
+    - 'lib/frontman/commands/serve.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+
+Metrics/LineLength:
+  Exclude:
+    - 'frontman-ssg.gemspec'
+    - 'spec/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/frontman/helpers/**/*'
+
+Metrics/ParameterLists:
+  Exclude:
+    - 'lib/frontman/app.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/frontman/commands/serve.rb'

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+We document all notable changes to the project in the file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [semantic versioning](http://semver.org/).
+
+# Release Notes
+## [Unreleased](https://github.com/algolia/frontman/compare/0.0.2...master)
+## [0.0.2](https://github.com/algolia/frontman/tree/0.0.2)
+The initial alpha release.
+

data/CONTRIBUTING.md

@@ -0,0 +1,42 @@
+We encourage you to contribute to Frontman if they have ideas for improvements to the project. 
+Your help is essential to keeping Frontman fast and easy to use.
+
+## Opening an issue
+
+When you open an issue, please provide as many details as possible to replicate the issue.
+It would be even better to have a link to a (forked) repository so that we can see the behavior right away.
+
+## Security issues
+
+If you find a security issue in Frontman, please open an issue an add the `Security` label.
+
+## Submitting a pull request
+
+Keep your changes as focused as possible. If there are multiple changes you'd like to make, consider submitting them as separate pull requests unless they are related to each other.
+
+Here are a few tips to increase the likelihood of us merging your pull request:
+
+- [ ] Write tests.
+- [ ] Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+- [ ] Allow [edits from maintainers](https://blog.github.com/2016-09-07-improving-collaboration-with-forks/).
+
+## Code style
+All Ruby code must follow the [Ruby community style guide](https://rubystyle.guide/). The `bundle exec rubocop` command runs [Rubocop](https://docs.rubocop.org/en/stable/) to ensure the code follows these conventions.
+
+## Tests
+If you create a PR that fixes a bug, we expect you to create a test demonstrating the buggy behavior. The test should pass after your PR. 
+
+For any code you introduce, you must add tests that confirm that the **public API** of your code works as expected.
+
+## Breaking changes
+Ideally, Frontman should remain backward compatible so that updating Frontman is easy for everyone.
+However, we're ready to break backward compatibility if needed.
+
+If you want to make a change that breaks backward compatibility, please describe them in your pull request and explain why you had to make these changes.
+
+## Resources
+
+- [Code of conduct](.github/CODE_OF_CONDUCT.md)
+- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
+- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
+- [GitHub Help](https://help.github.com)

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-present Algolia, Inc.
+
+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/Rakefile

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'frontman/version'
+require 'rake'
+require 'rspec/core/rake_task'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+namespace :frontman do
+  GEM_VERSION_FILE = File.join(Dir.pwd, 'lib/frontman/version.rb')
+  GIT_TAG_URL      = 'https://github.com/algolia/frontman/releases/tag/'
+
+  def last_commit_date
+    `git log -1 --date=short --format=%cd`.chomp
+  end
+
+  def latest_tag
+    `git describe --tags --abbrev=0`.chomp
+  end
+
+  def changelog(git_start = latest_tag, git_end = 'HEAD', format = '%s')
+    `git log --no-decorate --no-merges --pretty=format:#{format} #{git_start}..#{git_end}`
+  end
+
+  desc 'Write latest changes to CHANGELOG.md'
+  task :changelog, [:version] do |t, args|
+    # Filters-out commits containing some keywords and adds header
+    exceptions_regexp = Regexp.union(['README'])
+    title = "## [#{args[:version]}] (#{GIT_TAG_URL}#{args[:version]}) (#{last_commit_date})\n\n"
+    changes = changelog.each_line
+                       .map { |line| exceptions_regexp === line ? nil : "* #{line.capitalize}" }
+                       .unshift(title)
+                       .push("\n\n")
+                       .join
+
+    puts changes
+    puts "\n\e[31mDo you want to update the CHANGELOG.md with the text above? [y/N]\e[0m"
+    exit if STDIN.gets.chomp.downcase != 'y'
+
+    # Rewrite CHANGELOG.md
+    old_changes = File.readlines('CHANGELOG.md', 'r').join
+    File.open('CHANGELOG.md', 'w') { |file| file.write(changes, old_changes) }
+
+    puts 'CHANGELOG.md successfully updated'
+  end
+
+  desc 'Bump gem version'
+  task :semver, [:version] do |t, args|
+
+    File.open(GEM_VERSION_FILE, 'w') do |file|
+      file.write <<~SEMVER
+        module Frontman
+          VERSION = "#{args[:version]}"
+        end
+      SEMVER
+    end
+
+    # This force to reload the file with the newest version.
+    # Hence, `gemspec.version` invoked by Bundler later on will be correct.
+    load GEM_VERSION_FILE
+
+    puts "Bumped gem version from #{latest_tag} to #{args[:version]}"
+  end
+
+  desc 'Release a new version of this gem'
+  task :release, [:version] => %i[changelog semver] do |t, args|
+    `git add #{File.expand_path('../lib/frontman/version.rb', __FILE__)} CHANGELOG.md`
+    `git commit -m "Bump to version #{args[:version]}"`
+
+    # Invoke Bundler :release task
+    # https://github.com/bundler/bundler/blob/master/lib/bundler/gem_helper.rb
+    #
+    # Rake::Task[:release].invoke
+  end
+end
+
+module Bundler
+  class GemHelper
+    def version_tag
+      version.to_s
+    end
+  end
+end

data/SECURITY.md

@@ -0,0 +1,6 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Since Frontman is used to statically generate HTML, and therefore not used on live servers, it should not pose security vulnerabilities. 
+However, in case you do find a vulnerability, please create an issue in the repository with the details of the vulnerability.

data/bin/frontman

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'frontman/cli'
+
+Frontman::CLI.start

data/frontman-ssg.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: false
+
+require './lib/frontman/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'frontman-ssg'
+  s.version               = Frontman::VERSION
+  s.date                  = '2019-06-06'
+  s.summary               = 'A Middleman-inspired static site generator built for speed.'
+  s.description           = 'A Middleman-inspired static site generator built for speed.'
+  s.authors               = ['Devin Beeuwkes']
+  s.email                 = 'devin@algolia.com'
+  s.homepage              = 'https://github.com/algolia/frontman/wiki'
+  s.license               = 'MIT'
+  s.files                 = `git ls-files`.split("\n")
+  s.require_path          = 'lib'
+  s.executables           = ['frontman']
+
+  # Min Ruby version
+  s.required_ruby_version = '~> 2', '>= 2.3.0'
+
+  # Development tools
+  s.add_development_dependency 'rake', '~> 12.3'
+  s.add_development_dependency 'rspec', '~> 3.8'
+  s.add_development_dependency 'rubocop', '~> 0.71.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.3.0'
+  s.add_development_dependency 'simplecov', '~> 0.16'
+  s.add_development_dependency 'sorbet', '~> 0.5'
+
+  # Frontman dependencies
+  s.add_runtime_dependency 'better_errors', '~> 2.6'
+  s.add_runtime_dependency 'binding_of_caller', '~> 0.8'
+  s.add_runtime_dependency 'bundler'
+  s.add_runtime_dependency 'dotenv', '~> 2.7'
+  s.add_runtime_dependency 'erubis', '~> 2.7'
+  s.add_runtime_dependency 'haml', '~> 5.0'
+  s.add_runtime_dependency 'htmlentities', '~> 4.3'
+  s.add_runtime_dependency 'kramdown', '~> 2.1'
+  s.add_runtime_dependency 'kramdown-parser-gfm', '~> 1.1'
+  s.add_runtime_dependency 'listen', '~> 3.0'
+  s.add_runtime_dependency 'nokogiri', '~> 1.10'
+  s.add_runtime_dependency 'parallel', '~> 1.17'
+  s.add_runtime_dependency 'rouge', '~> 3.16'
+  s.add_runtime_dependency 'sinatra', '~> 2.0'
+  s.add_runtime_dependency 'sorbet-runtime', '~> 0.5'
+  s.add_runtime_dependency 'thor', '~> 0.20'
+  s.add_runtime_dependency 'yaml-front-matter', '0.0.1'
+end