indoctrinatr-tools 0.10.0

data/features/pack.feature

@@ -0,0 +1,11 @@
+Feature: Running the 'pack' command
+
+  Background:
+    Given the default aruba exit timeout is 20 seconds
+
+  Scenario:
+    Given I have an Indoctrinatr project 'demo'
+     When I successfully run `indoctrinatr parse demo`
+      And I run `indoctrinatr pdf demo`
+      And I run `indoctrinatr pack demo`
+     Then a file named "demo.zip" should exist

data/features/parse.feature

@@ -0,0 +1,6 @@
+Feature: Running the 'parse' command
+
+  Scenario: for a given 'demo' project
+    Given I have an Indoctrinatr project 'demo'
+     When I successfully run `indoctrinatr parse demo`
+     Then a file named "demo/demo_with_default_values.tex" should exist

data/features/pdf.feature

@@ -0,0 +1,10 @@
+Feature: Running the 'pdf' command
+
+  Background:
+    Given the default aruba exit timeout is 20 seconds
+
+  Scenario: for a given 'demo' project
+    Given I have an Indoctrinatr project 'demo'
+     When I successfully run `indoctrinatr parse demo`
+      And I run `indoctrinatr pdf demo`
+     Then a file named "demo_with_default_values.pdf" should exist

data/features/scaffold.feature

@@ -0,0 +1,23 @@
+Feature: Running the 'new' command
+
+  Scenario: with a valid name 'demo'
+    Given I do not have a 'demo' project
+     When I successfully run `indoctrinatr new demo`
+     Then the output should match /A template pack scaffold was created in folder 'demo'. Happy templating…/
+      And a directory named "demo" should exist
+      And a directory named "demo/assets" should exist
+      And the following files should exist:
+        | demo/configuration.yaml |
+        | demo/demo.tex.erb |
+
+  Scenario: with an empty name
+    Given I do not have a 'demo' project
+     When I run `indoctrinatr new`
+     Then the exit status should be 1
+      And the output should match /Please specify a template pack name/
+
+  Scenario: with the same name as an existing directory
+    Given I have an Indoctrinatr project 'demo'
+     When I run `indoctrinatr new demo`
+     Then the exit status should be 1
+      And the output should match /A folder with name 'demo' already exists/

data/features/step_definitions/common.rb

@@ -0,0 +1,3 @@
+When(/I wait (.*) seconds?/) do |seconds|
+  sleep(seconds.to_i)
+end

data/features/step_definitions/indoctrinatr_cli.rb

@@ -0,0 +1,11 @@
+Given(/^I do not have (?:a|an) '(.*)' project$/) do |project_name|
+  FileUtils.rm_rf project_name
+end
+
+Given(/^I have an Indoctrinatr project '(.*)'$/) do |project_name|
+  step "I run the Indoctrinatr command 'new #{project_name}'"
+end
+
+When(/^I run the Indoctrinatr command '(.*)'$/) do |command|
+  step "I successfully run `indoctrinatr #{command}`"
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/features/version.feature

@@ -0,0 +1,5 @@
+Feature: Running the "version" command
+
+  Scenario:
+    When I successfully run `indoctrinatr version`
+    Then the output should contain "0.10.0"

data/features/workflow.feature

@@ -0,0 +1,8 @@
+Feature: Running the "workflow" command
+
+  Scenario:
+    When I successfully run `indoctrinatr workflow`
+    Then the output should contain "new"
+    Then the output should contain "parse"
+    Then the output should contain "pdf"
+    Then the output should contain "pack"

data/indoctrinatr-tools.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'indoctrinatr/tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'indoctrinatr-tools'
+  spec.version       = Indoctrinatr::Tools::VERSION
+  spec.authors       = ['Nicolai Reuschling']
+  spec.email         = ['nicolai.reuschling@dkd.de']
+  spec.summary       = 'indoctrinatr-tools provides a set of command line tools for Indoctrinatr (an Open Source Software project by dkd Internet Service GmbH, Frankfurt am Main, Germany.)'
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',   '~> 1.9'
+  spec.add_development_dependency 'rake',      '~> 10.4'
+  spec.add_development_dependency 'rspec',     '~> 3.3'
+  spec.add_development_dependency 'cucumber',  '~> 2.0'
+  spec.add_development_dependency 'aruba',     '~> 0.9'
+  spec.add_development_dependency 'rubocop',   '~> 0.33'
+  spec.add_development_dependency 'pry',       '~> 0.10'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+
+  spec.add_dependency 'gli',                 '~> 2.12'
+  spec.add_dependency 'rubyzip',             '~> 1.1'
+  spec.add_dependency 'erubis',              '~> 2.7'
+  spec.add_dependency 'to_latex',            '~> 0.5'
+  spec.add_dependency 'RedCloth',            '~> 4.2'
+
+  spec.requirements << 'xelatex'
+end

data/lib/indoctrinatr/templates/configuration.yaml

@@ -0,0 +1,17 @@
+template_name: Hello World Template
+textual_description: "This is your first Indoctrinatr template.
+
+Edit is as you like. Read more at https://github.com/dkd/indoctrinatr."
+fields:
+  -
+    name: variable1
+    presentation: text
+    default_value: "World"
+    description: "The first variable"
+  -
+    name: variable2
+    presentation: dropdown
+    default_value: "not enough"
+    available_options: "not enough, beautiful, your oyster, a template"
+    description: "The second variable. The description name can be very long and should adequately describe what the variable is for etc. pp."
+    required: "true"

data/lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation-content.tex.erb

@@ -0,0 +1,36 @@
+% latex template author: Søren Schaffstein
+% let compiler know which file is the root file
+% !TEX root = indoctrinatr-technical-documentation.tex
+
+\chapter{Template Structure}
+
+
+\section{Files in Template}
+\dirtree{%
+	.1 /.
+	<% list_of_files.each do |item| %>
+	<%= item.to_latex %>
+	<% end %>
+}
+
+<% @files.each do |file| %>
+\section{<%= file.name.to_latex -%>}
+
+\begin{lstlisting}<%="[language=#{file.language}]" unless file.language == 'unspecified' %>
+<%= file.content.gsub('\end{lstlisting}', '\end{lstlisting}'.to_latex) %><%# this escaping is important, so that lstlisting does not break. \begin lstlisting is ignored %>
+\end{lstlisting}
+
+<% end %>
+
+\chapter{Variables}
+		
+\begin{tabu}{ l l X l X }
+	\textbf{Variable} & \textbf{Presentation} & \textbf{Default Value} & \textbf{Required} & \textbf{Description} \\
+	<% @attributes.each do |attribute| %>
+		\texttt{<%= attribute['name'].to_latex -%>}
+		& <%= attribute['presentation'].to_latex -%>
+		& <%= attribute['default_value'].to_latex -%>
+		& <%= 'true' if attribute['required'] == 'true' -%> <%# empty if false or not set. Wish by Søren for better readability-%>
+		& <%= attribute['description'].to_latex -%>\\
+	<% end %>
+\end{tabu}

data/lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation.sty

@@ -0,0 +1,195 @@
+% Author: Søren Schaffstein
+% specify the page margins
+\usepackage[top=41mm, bottom=25mm, left=24mm, right=12.4mm]{geometry}
+
+
+% define macros for headers and footers
+\newcommand{\customLHead}{\fontsize{7}{8}\mainFont \textcolor{hot-chocolate}{\customDocumentTitle{}}}
+\newcommand{\customLFoot}{\fontsize{7}{8}\mainFont \textcolor{hot-chocolate}{\href{http://indoctrinatr.dkd.de}{indoctrinatr.dkd.de} powered by dkd Internet Service GmbH | Kaiserstraße 73 | 60329 Frankfurt | Germany}}
+\newcommand{\customRFoot}{\fontsize{7}{8}\mainFont \textcolor{hot-chocolate}{Page \thepage/\pageref{LastPage}}}
+
+
+% allow the usage of colour in the document
+\usepackage[cmyk,table]{xcolor}
+
+% define colors for use in the document
+\definecolor{lime-green}{cmyk}{0.25,0,0.83,0}
+\definecolor{hot-chocolate}{cmyk}{0,0.6,1,0.8}
+\definecolor{alarm-red}{cmyk}{0.15,0.95,1,0.05}
+\definecolor{light-gray}{cmyk}{0,0,0,0.1}
+% use colors with \textcolor{<declared-color>}{<text>}
+
+
+% define document language
+\usepackage{polyglossia}
+\setdefaultlanguage{english}
+
+
+% use dkd letterpaper in background 
+\usepackage{wallpaper}
+% use 2nd page letterpaper for all pages 
+\ULCornerWallPaper{1}{indoctrinatr_letterpaper.pdf}
+
+% define fonts to use in this document
+% fontspec allows the use of system fonts but requires the use of XeTeX
+\usepackage{fontspec}
+\setmainfont{Arial}
+
+
+% define appearance of headlines
+\usepackage{titlesec}
+% Specify different font for section headings
+\newfontfamily\mainFont[]{Arial}
+\newfontfamily\headlineFont[]{Arial Bold}
+
+% Setting of font and size
+% {\fontsize{<font size>}{<line height>} \selectfont <Text>}
+% {\fontsize{40}{48} \selectfont Lorem ipsum}
+
+% \chapter can only be defined in document type report and only by using 
+% the advanced command \titleformat (\titleformat* does not work)
+% \titleformat{\chapter}[hang]{\large\bfseries}{\thechapter\quad}{0pt}{}
+% \titleformat{\section}[hang]{\large\bfseries}{\thesection\quad}{0pt}{}
+% \titleformat{\subsection}[hang]{\large\bfseries}{\thesubsection\quad}{0pt}{}
+% \titleformat{\subsubsection}[hang]{\large\bfseries}{\thesubsubsection\quad}{0pt}{}
+% \titleformat{\paragraph}[hang]{\large\bfseries}{\theparagraph\quad}{0pt}{}
+\titleformat{\chapter}[hang]{\fontsize{18}{19}\headlineFont}{\thechapter\quad}{0pt}{}
+\titleformat*{\section}{\fontsize{13}{15}\headlineFont}
+\titleformat*{\subsection}{\fontsize{11}{13}\headlineFont}
+\titleformat*{\subsubsection}{\fontsize{10}{13}\headlineFont}
+
+% define space before and after headlines
+% \titlespacing{<command>}{<left>}{<before-sep>}{<after-sep>}[<right-sep>]
+% \titlespacing{\chapter}{0pt}{-3em}{6pt}
+% \titlespacing{\section}{0pt}{6pt}{6pt}
+% \titlespacing{\subsection}{0pt}{6pt}{6pt}
+% \titlespacing{\subsubsection}{0pt}{6pt}{6pt}
+% \titlespacing{\paragraph}{0pt}{6pt}{6pt}
+\titlespacing{\chapter}{0mm}{8.0mm}{8.0mm}
+\titlespacing{\section}{0mm}{6.2mm}{2.0mm}
+\titlespacing{\subsection}{0mm}{6.2mm}{2.0mm}
+\titlespacing{\subsubsection}{0mm}{4.0mm}{0mm}
+
+
+% define appearance of bullet lists
+\renewcommand{\labelitemi}{$\bullet$}
+\renewcommand{\labelitemii}{$\bullet$}
+\renewcommand{\labelitemiii}{$\bullet$}
+\renewcommand{\labelitemiv}{$\bullet$}
+
+
+% use package 'last page' to be able to access the "number of pages in document" with \pageref{LastPage}
+\usepackage{lastpage}
+
+% define headers and footers
+% use fancyhdr package for exact header and footer definition
+\usepackage{fancyhdr}
+% set \pagestyle{fancy} for "fancyhdr" package
+\pagestyle{fancy}
+
+% define position and height of header & footer
+% define distance from (page edge + 1in)
+\setlength{\topmargin}{-1.4mm}
+% define height of the header
+\setlength{\headheight}{3mm}
+% define distance after header to text
+\setlength{\headsep}{14.8mm}
+% define distance from text end to footer baseline
+\setlength{\footskip}{7mm}
+
+% clear default header settings
+\fancyhf{}
+% possible header and footer commands
+% \lhead[<ch-even>]{<ch-odd>}
+% \chead[<ch-even>]{<ch-odd>}
+% \rhead[<rh-even>]{<rh-odd>}
+% \lfoot[<lf-even>]{<lf-odd>}
+% \cfoot[<cf-even>]{<cf-odd>}
+% \rfoot[<rf-even>]{<rf-odd>}
+\lhead{\customLHead{}}
+\lfoot{\customLFoot{}}
+\rfoot{\customRFoot{}}
+% remove lines in headers and footers
+\renewcommand{\headrulewidth}{0pt}
+\renewcommand{\footrulewidth}{0pt}
+
+%redefine "plain" pagestyle to look like "fancy" so all pages look similar
+\fancypagestyle{plain}{%
+	\fancyhf{}
+	\lhead{\customLHead{}}
+	\lfoot{\customLFoot{}}
+	\rfoot{\customRFoot{}}
+
+	% remove lines in headers and footers
+	\renewcommand{\headrulewidth}{0pt}
+	\renewcommand{\footrulewidth}{0pt}
+}
+
+
+% allow formatting of program code
+\usepackage{listings}
+% configure the style of listings
+\lstset{
+	backgroundcolor=\color{light-gray},
+	basicstyle=\small,
+	numbers=left,
+	stepnumber=5,
+	breaklines=true,
+	defaultdialect=[LaTeX]TeX
+}
+% preload the language styles used in this documentation
+\lstloadlanguages{TeX, Ruby}
+
+
+% remove indentation of first line in paragraphs
+\setlength{\parindent}{0mm}
+
+% define empty space between paragraphs
+\setlength{\parskip}{2mm}
+
+% allow underlining and strikethrough of text
+\usepackage[normalem]{ulem}
+
+
+% use "csquotes" package to automatically create correct quotes
+\usepackage{csquotes}
+% define symbol used to create quotes
+\MakeOuterQuote{"}
+
+
+% package for better table creation
+\usepackage{tabu}
+% use "longtable" package to allow multi page tables
+\usepackage{longtable}
+
+
+% define horizontal lines for use in tables
+\newcommand{\tabletoprule}{\tabucline[1pt]{-}}
+\newcommand{\tablebottomrule}{\tabucline[1pt]{-}}
+\newcommand{\tablemiddlerule}{\tabucline[0.5pt]{-}}
+\newcommand{\tablesumrule}{\tabucline[0.5pt]{-}\tabucline[0.5pt]{-}}
+
+% increase spacing between table rows
+\tabulinesep=2mm
+
+% have alternating row colours in tables
+\rowcolors{1}{light-gray}{white} 
+
+% allow row spanning in tables
+\usepackage{multirow}
+
+
+% package for external pdf document inclusion
+\usepackage{pdfpages}
+
+
+% use "isodate" package for automatic formatting of dates
+\usepackage[iso,english]{isodate}
+
+
+% use "dirtree" package to show the directory tree of the Indoctrinatr-Template
+\usepackage{dirtree}
+
+% set space between dirtree lines
+\setlength{\DTbaselineskip}{5mm}
+

data/lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation.tex.erb

@@ -0,0 +1,89 @@
+% dkd technical documentation template
+% Author (LaTeX): Søren Schaffstein
+% Requires XeLaTeX to render!
+% !TEX program = XeLaTeX
+
+% create an A4 portrait format document with 10pt font size
+\documentclass[10pt,a4paper]{report}
+
+
+% use dkd-letter style to apply design styles
+\usepackage{indoctrinatr-technical-documentation}
+
+
+%define labels to use in this document
+\newcommand{\dkd}{\emph{dkd}}
+\newcommand{\customDocumentTitle}{Documentation for "<%= @template_name -%>"}
+\newcommand{\customKeywords}{Indoctrinatr, Template}
+
+
+% allow usage an inclusion of hyperlinks in the document
+% IMPORTANT: package must be included last in the preamble
+\usepackage{hyperref}
+% define PDF metadata and link colors in document
+\hypersetup{
+	pdftitle={\customDocumentTitle},
+	pdfauthor={indoctrinatr-tools},
+	pdfkeywords={\customKeywords},
+	pdfproducer={LaTeX with hyperref},
+	pdfcreator={LaTeX},
+	linkcolor=lime-green,
+	citecolor=black,
+	filecolor=black,
+	urlcolor=lime-green,
+	colorlinks=true
+}
+
+
+\begin{document}
+	% define title page of the report
+	\begin{titlepage}
+		% set all text aligned left
+		\begin{flushleft}
+			% start with vertical space (use \vspace* at beginning of page)
+			\vspace*{52mm}
+			% set document title
+			{\fontsize{18}{19}\headlineFont \customDocumentTitle{}}
+			% add vertical space after document title
+			\vspace{18.5mm}
+			% add document details in a tabbed format
+			\begin{tabbing}
+				% define tabstop distances
+				\hspace*{26.25mm}\=\hspace{26.25mm}\=\kill
+				% add document details separated by tabs
+				Document title: \>\customDocumentTitle{}\\
+				Date: \>\today\\ % use datetime2
+			\end{tabbing}
+		\end{flushleft}
+	\end{titlepage}
+
+
+	% add table of contents
+	\tableofcontents
+
+	% include a LaTeX file with the actual documentation content
+	\input{indoctrinatr-technical-documentation-content.tex}
+	
+	% add prrendered templates in the appendix
+	\appendix
+	\chapter{Template filled with sample data}
+	% remove default wallpaper
+	\ClearWallPaper
+	% include the prerendered template
+	% pages=- selects all pages
+	\includepdf[pages=-]{<%= @default_values_pdf_path -%>} % template_with_default_values.pdf "#{@template_name}_with_default_values.pdf"
+	% restore wallpaper
+	\ULCornerWallPaper{1}{indoctrinatr_letterpaper.pdf}
+
+	% this feature is postponed, until LaTeX complications with image tags are resolved:
+	%
+	%\chapter{Template filled with variable names}
+	% remove default wallpaper
+	%\ClearWallPaper
+	% include the prerendered template
+	% pages=- selects all pages
+	%\includepdf[pages=-]{template_with_variable_names.pdf}
+	% restore wallpaper
+	%\ULCornerWallPaper{1}{indoctrinatr_letterpaper.pdf}
+
+\end{document}