docgen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 522e85bbbc438ce5554040433d3a02dd94680dc3
+  data.tar.gz: 358668231571b9660518e0c138af78ce8caccd88
+SHA512:
+  metadata.gz: bd2560accccc14f84f5a61cf6c8172ac293b583f05d09744dc3fd34b9af5ed6121632f43c7a73b9edda9babcedf41675fd342a98af426405727410ff2b4d5177
+  data.tar.gz: af0110752fd7d9b289838d48207810a360544f8a26a8360720e939f1445373f40dc27a57418233e96251a73d4fd3b9b4cadcd602f458f3c2d0f1175a52f6b867

data/.gitignore

@@ -0,0 +1,14 @@
+temp.out
+*temp.pptx
+~*
+.~*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 davenicolette@gmail.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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docgen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dave Nicolette
+
+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,66 @@
+# Docgen
+
+Proof of concept to apply custom updates to template files and output the resulting file in any of several formats, including text, HTML, PDF, LaTeX, and others.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docgen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docgen
+
+## Usage
+
+The gem takes a template document that may contain placeholders for content substitution, and applies substitution values to produce a customized output document. The substitution values are defined in a database as key-value pairs. The placeholders in the template documents contain the key values matching entries in the database. 
+
+Given a template document like this
+
+```
+Hello, ::name::. It's a ::quality:: day today, isn't it?
+```
+
+and substitution values like this
+
+```
+name => Marcia
+quality => dismal
+```
+
+then a call like this
+
+```
+docgen.gen 'pdf', template_text
+```
+
+results in a PDF file containing the text
+
+```
+Hello, Marcia. It's a dismal day today, isn't it?
+```
+
+The code is under development, so it's premature to write comprehensive documentation in a refined way. See the file ```docgen_spec.rb``` for working examples of usage.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/neopragma/docgen. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "docgen"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.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/create_database.sh

@@ -0,0 +1 @@
+sqlite3 docgen < create_database.sql

data/create_database.sql

@@ -0,0 +1,55 @@
+drop table if exists "document_sets";
+create table if not exists "document_sets" (
+    "id" integer not null,
+    "name" varchar(128) not null,
+    "description" varchar(256));
+insert into document_sets ("id", "name", "description")
+	values (1, "default", "Default document set when none is specified");
+insert into document_sets ("id", "name", "description")
+	values (2, "gcpd", "Gotham City Police Department");
+
+drop table if exists "substitutions";
+create table if not exists "substitutions" (
+    "set_id" integer not null,
+    "key" varchar(128) not null,
+    "value" varchar(128) not null);
+
+/* Defaults */
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "client name", "LeadingAgile");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "tlt", "Transformation Leadership Team");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "ivt", "Innovation and Verification Team");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "value stream", "Line of Business");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "portfolio team", "Portfolio Team");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "program team", "Program Team");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "delivery team", "Delivery Team");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "iteration", "Sprint");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "product owner", "Product Owner");
+
+/* Gotham City Police Department */
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "client name", "Gotham City Police Dept.");
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "tlt", "Improvement Guidance Committee");
+insert into substitutions ("set_id", "key", "value") 
+	values ("default", "ivt", "Architectural Guidance Committee");
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "value stream", "Product Line");
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "portfolio team", "Product Line Team");
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "program team", "Coordination Team");
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "delivery team", "Development Pod");
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "iteration", "Development Cadence");
+insert into substitutions ("set_id", "key", "value") 
+	values ("gcpd", "product owner", "Capability Owner");

data/devinit

@@ -0,0 +1,71 @@
+#!/bin/bash
+# devinit
+# Set up the development environment for docgen.
+# (assumes bash)
+
+declare -a debian_pkg
+debian_pkg[${#debian_pkg[@]}]='git'                        # version control client
+debian_pkg[${#debian_pkg[@]}]='build-essential'            # build dependencies
+debian_pkg[${#debian_pkg[@]}]="linux-headers-$(uname -r)"
+debian_pkg[${#debian_pkg[@]}]='ruby'
+debian_pkg[${#debian_pkg[@]}]='ruby-dev'
+debian_pkg[${#debian_pkg[@]}]='sqlite3'                    # database for docgen
+debian_pkg[${#debian_pkg[@]}]='inputenc'                   # kramdown LaTeX output
+debian_pkg[${#debian_pkg[@]}]='fontenc'         
+debian_pkg[${#debian_pkg[@]}]='listings'         
+debian_pkg[${#debian_pkg[@]}]='hyperref'         
+
+
+
+
+
+function identify_os {
+  THIS_OS=
+  if [[ "$OSTYPE" == "linux-gnu" ]]; then
+    THIS_OS='Linux'
+    identify_linux_package_manager
+  else
+    'Unsupported OS'  
+#   elif [[ "$OSTYPE" == "darwin"* ]]; then
+#     echo 'OSX detected'
+#   elif [[ "$OSTYPE" == "cygwin" ]]; then
+#     echo 'Cygwin detected'
+#   elif [[ "$OSTYPE" == "msys" ]]; then
+#     echo 'Mingw32 detected'
+#   elif [[ "$OSTYPE" == "freebsd"* ]]; then
+#     echo 'FreeBSD detected'
+#   else
+#     echo 'OS not identified'
+  fi
+}
+
+function identify_linux_package_manager {
+  if [[ $(which apt) ]]; then
+    PKG_MGR='apt'
+  elif [[ $(which yum) ]]; then
+  	PKG_MGR='yum'
+  fi
+}
+
+function install_packages {
+  echo '' > devinit.log
+  identify_os
+  for name in "${debian_pkg[@]}"
+  do
+    if [[ -n "$(dpkg -l | grep ${name})" ]]; then 
+      echo "package ${name} is installed...skipping install" >> devinit.log
+    else
+      echo "installing package ${name}" >> devinit.log
+      sudo apt install -y "$name" &>> devinit.log
+    fi 
+  done
+}
+
+function configure_postgresql {
+  $(sudo cp /etc/postgresql/*/main/postgresql.conf ./postgresql.conf.orig)
+  $(sudo cp /etc/postgresql/*/main/pg_hba.conf ./pg_hba.conf.orig)
+  $(sudo cp ./pg_hba.conf /etc/postgresql/*/main)
+  $(sudo sed -i "/#listen_addresses/c\listen_addresses = \'*\'" /etc/postgresql/*/main/postgresql.conf)
+}
+
+install_packages

data/devinit.log

@@ -0,0 +1,25 @@
+
+package git is installed...skipping install
+package build-essential is installed...skipping install
+package linux-headers-4.4.0-59-generic is installed...skipping install
+package ruby is installed...skipping install
+package ruby-dev is installed...skipping install
+package sqlite3 is installed...skipping install
+installing package inputenc
+
+WARNING: apt does not have a stable CLI interface. Use with caution in scripts.
+
+Reading package lists...
+Building dependency tree...
+Reading state information...
+E: Unable to locate package inputenc
+package fontenc is installed...skipping install
+package listings is installed...skipping install
+installing package hyperref
+
+WARNING: apt does not have a stable CLI interface. Use with caution in scripts.
+
+Reading package lists...
+Building dependency tree...
+Reading state information...
+E: Unable to locate package hyperref

data/docgen.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docgen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docgen"
+  spec.version       = Docgen::VERSION
+  spec.authors       = ["Dave Nicolette"]
+  spec.email         = ["davenicolette@gmail.com"]
+
+  spec.summary       = %q{Merge boilerplate and custom content to generate documents.}
+  spec.description   = %q{Generate documents in various formats based on standard boilerplate and custom content.}
+  spec.homepage      = "https://github.com/neopragma/docgen"
+  spec.license       = "MIT"
+
+  # 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'] = "http://localhost"
+  # 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   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "sqlite3", "~> 1.3"
+  spec.add_dependency "sequel", "~> 4.43"
+  spec.add_dependency "kramdown", "~> 1.13"
+  spec.add_dependency "nokogiri", "~> 1.7"
+  spec.add_dependency "prawn", "~> 2.1"
+  spec.add_dependency "prawn-table", "~> 0.2"
+  spec.add_dependency "rubyzip", "~> 1.2"
+end

data/document.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <% if @converter.root.options[:encoding] %>
+    <meta http-equiv="Content-type" content="text/html;charset=<%= @converter.root.options[:encoding] %>">
+    <% end %>
+<%
+extend ::Kramdown::Utils::Html
+title = ''
+h = @converter.root.children.find {|c| c.type == :header}
+if h
+  collector = lambda {|c| c.children.collect {|cc| cc.type == :text ? escape_html(cc.value, :text) : collector.call(cc)}.join('')}
+  title = collector.call(h)
+end
+%>
+    <title><%= title %></title>
+    <meta name="generator" content="kramdown <%= ::Kramdown::VERSION %>" />
+  </head>
+  <body>
+  <%= @body %>
+  </body>
+</html>