platte 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 778b2b5738f5225b86802852cfb7adac9bb9e8b903d65115cc8abf93ba920089
+  data.tar.gz: ebf44b9aca79e561a27861c361db16e96cd6fe082054b2a7ae1cb53fdc861bce
+SHA512:
+  metadata.gz: e8b5ada773fa22ec6782be64cc26503ba635e03adc46824e8c41446163165dc1187bc8313d025154bb383cac0a1407ca70d402add9ac07872f0d5d7098cd4f4c
+  data.tar.gz: 4c975521329607e77d7a0f5bcedd192802be5b241e79f89e5a2ccbb54d4923033eaf4fad80f04caea18e6e41d7ff740ccd6c196fce56c0eccfc96093e2888c88

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Kiefernwald
+
+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,51 @@
+# Platte
+
+[![Build Status](https://travis-ci.org/kiefernwald/platte.svg?branch=master)](https://travis-ci.org/kiefernwald/platte)
+[![Coverage Status](https://coveralls.io/repos/github/kiefernwald/platte/badge.svg?branch=specs)](https://coveralls.io/github/kiefernwald/platte?branch=specs)
+
+![Plattenbau](pic.jpg)
+
+*(Transport of Plattenbau parts in Karl-Marx-Stadt, GDR, 1975 [CC BY-SA 3.0 de](https://creativecommons.org/licenses/by-sa/3.0/de/deed.en) Deutsche Fotothek)*
+
+Platte is a small command line tool that combines static HTML pages from modules. It is named after the german word [Plattenbau](https://en.wikipedia.org/wiki/Plattenbau) which is a way of building houses based on pre-fabricated parts.
+
+![Plattenbau](output.png)
+
+## Installation
+
+Platte requires a ruby environment with version 2.3 or higher. To install, run:
+
+`gem install platte`
+
+## Usage
+
+After the gem installation, `platte` is available in command line. It lets you combine a static HTML file from a given set of modules. Modules are folders with some configuation files and code in it and sit in the `modules` subfolder of the tool. They come in two flavours:
+
+1. Main modules names, ending with `.main` – usually they hold the surrounding HTML structure with placeholders for resources
+2. Other modules names end with `.module` – they are building blocks you can freely combine together as the body of a main module 
+
+You can use the `platte` command as follows:
+
+### list
+
+`platte list`
+
+This call shows you which modules are available in your system.
+
+### combine
+
+`platte combine <TARGET FILE> <MAIN MODULE> <MODULE 1> ... <MODULE N>`
+
+This lets you combine a single main-module with any number of other modules to a given target file.
+
+Example call:
+
+`platte combine some/output/file.html html5 header content`
+
+## Module structure
+
+TODO More docs
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kiefernwald/platte.

data/bin/platte

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+# frozen_string_literal: true
+
+require './lib/platte'
+
+Platte.start

data/lib/combinator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'mustache'
+require 'htmlbeautifier'
+require './lib/platte_module'
+
+# Combinator class
+class Combinator
+  INDENTATION = '    '
+
+  # Combines the given platte modules
+  def combine main, modules, beautify: true
+    html = Mustache.render(
+      main.template,
+      module_contents: generate_body(modules),
+      stylesheets: generate_stylesheets(modules),
+    )
+
+    postprocess(html, beautify: beautify)
+  end
+
+  private
+
+  def generate_body platte_modules
+    body = ''
+    platte_modules.each { |mod| body += mod.template.to_s }
+
+    body
+  end
+
+  def generate_stylesheets platte_modules
+    styles = []
+    platte_modules.each { |mod| styles.concat(mod.stylesheets) }
+
+    styles.uniq
+  end
+
+  def postprocess html, beautify: true
+    return HtmlBeautifier.beautify(html, indent: INDENTATION) if beautify
+
+    html
+  end
+end

data/lib/exception/platte_module_creation_exception.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Exception thrown during creation of a Platte module
+class PlatteModuleCreationException < StandardError
+  def initialize reason
+    @reason = reason
+  end
+
+  attr_reader :reason
+end

data/lib/platte.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'fileutils'
+require 'colorize'
+require './lib/combinator'
+require './lib/platte_module_loader'
+
+# Platte command line tool
+class Platte < Thor
+  desc 'combine FILE MAIN [MODULE [MODULE ...]]', 'combine FILE from MAIN and MODULES.'
+  option :no_beautify, type: :boolean, default: false
+  def combine file, main, *modules
+    main_module, platte_modules = get_modules main, modules
+    combine_and_save(file, main_module, platte_modules)
+    copy_assets File.dirname(file), main_module, platte_modules
+    output_final_info
+  rescue PlatteModuleCreationException => e
+    output_error e, "Could not load modules to construct #{file}!"
+  rescue StandardError => e
+    output_error e, "Could not construct #{file}!"
+  end
+
+  desc 'list', 'list all available modules.'
+  def list
+    puts '🏢  The following main modules are available:'.green
+    get_modules_from_folder('modules', extension: 'main').each(&method(:output_single_module))
+    puts "\n📦  The following modules are available:".green
+    get_modules_from_folder('modules').each(&method(:output_single_module))
+  end
+
+  private
+
+  def combine_and_save file, main_module, platte_modules
+    output_module_info(file, main_module, platte_modules)
+    write_to_file file, Combinator.new.combine(main_module, platte_modules, beautify: !options[:no_beautify])
+  end
+
+  def output_final_info
+    puts 'Done.'.green
+    puts '🏢'
+  end
+
+  def output_error error, message
+    puts message.black.on_red
+    puts "  #{error.reason}".red
+  end
+
+  def output_module_info file, main_module, platte_modules
+    puts "#{'🏗  Constructing'.green} #{file.yellow} #{'from the following modules:'.green}"
+    output_single_module(main_module, is_main: true)
+    platte_modules.each(&method(:output_single_module))
+  end
+
+  def output_single_module module_object, is_main: false
+    module_name = is_main ? "#{module_object.name} (main module)" : module_object.name
+    puts "  * #{module_name} – #{module_object.description}".blue
+  end
+
+  def get_modules_from_folder folder, extension: 'module'
+    loader = PlatteModuleLoader.new
+    Dir.glob("*.#{extension}", base: folder)
+       .map { |mod| loader.create_from_folder "modules/#{mod}" }
+  end
+
+  def get_modules main, modules
+    puts 'Loading selected modules...'.green
+    loader = PlatteModuleLoader.new
+    main_module = loader.create_from_folder "modules/#{main}.main"
+    platte_modules = modules.map { |mod| loader.create_from_folder "modules/#{mod}.module" }
+
+    [main_module, platte_modules]
+  end
+
+  def write_to_file file, contents
+    file = File.new(file, 'w')
+    file.write(contents)
+    file.close
+  end
+
+  def copy_assets destination, main, modules
+    puts 'Copying assets...'.green
+    FileUtils.copy_entry "#{main.directory}/assets", "#{destination}/assets"
+    modules&.each { |mod| FileUtils.copy_entry "#{mod.directory}/assets", "#{destination}/assets" }
+  end
+end

data/lib/platte/version.rb

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

data/lib/platte_module.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'exception/platte_module_creation_exception'
+
+# A single module
+class PlatteModule
+  # rubocop:disable Metrics/ParameterLists
+  def initialize folder, name, description, template, stylesheets = [], javascripts = []
+    @folder = folder
+    @name = name
+    @template = template
+    @description = description
+    @stylesheets = stylesheets if stylesheets
+    @javascripts = javascripts if javascripts
+  end
+  # rubocop:enable Metrics/ParameterLists
+
+  def directory
+    File.expand_path "./#{@folder}"
+  end
+
+  attr_reader :name
+  attr_reader :description
+  attr_reader :stylesheets
+  attr_reader :javascripts
+  attr_reader :template
+end

data/lib/platte_module_loader.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Loader for Platte modules
+class PlatteModuleLoader
+  def create_from_folder folder
+    raise PlatteModuleCreationException, "Module at #{folder} could not be found!" unless File.exist? folder
+
+    # Extract info
+    name, description, stylesheets, javascripts = get_module_info(folder)
+
+    # Read template
+    template = File.read("#{folder}/template.mustache")
+
+    PlatteModule.new folder, name, description, template, stylesheets, javascripts
+  end
+
+  private
+
+  def get_module_info folder
+    info = JSON.parse(File.read("#{folder}/info.json"))
+    name = info['name']
+    description = info['description']
+    stylesheets = info['stylesheets'] || nil
+    javascripts = info['javascripts'] || nil
+
+    [name, description, stylesheets, javascripts]
+  end
+end

data/platte.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require 'platte/version'
+
+Gem::Specification.new do |s|
+  s.name = 'platte'
+  s.version = Platte::VERSION
+  s.authors = ['Thomas Bretzke']
+  s.homepage = 'https://github.com/kiefernwald/platte'
+  s.summary = 'A static generator tool for static HTML pages combined from modules.'
+  s.license = 'MIT'
+
+  s.executables = %w[platte]
+  s.require_paths = %w[lib]
+  s.files = %w[LICENSE README.md platte.gemspec] + Dir['lib/**/*.rb', 'bin/*']
+
+  s.required_ruby_version = '~> 2.3'
+
+  s.add_dependency 'colorize'
+  s.add_dependency 'htmlbeautifier'
+  s.add_dependency 'mustache', '~> 1.0'
+  s.add_dependency 'thor'
+
+  s.add_development_dependency 'bundler', '~> 1.16'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rubocop', '~> 0.49.0'
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: platte
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Thomas Bretzke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlbeautifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+description: 
+email: 
+executables:
+- platte
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/platte
+- lib/combinator.rb
+- lib/exception/platte_module_creation_exception.rb
+- lib/platte.rb
+- lib/platte/version.rb
+- lib/platte_module.rb
+- lib/platte_module_loader.rb
+- platte.gemspec
+homepage: https://github.com/kiefernwald/platte
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A static generator tool for static HTML pages combined from modules.
+test_files: []