indoctrinatr-tools 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0fe5d601575b7ece3e77dc6b7dde2b31a291c46
-  data.tar.gz: 80e84638993fb7a8a771d3fa2c7c7bfad4317242
+  metadata.gz: 946f82d2025797573ceeedd251de1548a4a098b1
+  data.tar.gz: c1fb29ef98597a90ae8068c93f6aab58aac47f20
 SHA512:
-  metadata.gz: ddff4b9e60e6b0ae25345c6365268966942ff1461949b306b1db036cb30cbefd74e4cf62ef2f8aaaf0b167def2963b038c7df57f2a382e7b1b87d8dcd994901c
-  data.tar.gz: 45a39be9f0bf9d8b4e743944317b45fa56e621b6cd35c9bcc07588aae5a51949a2b35c11b4f2b9524e0c8fd002c4d5ace58759abc37ef7dfb3e3ad069017078c
+  metadata.gz: 89779066419330bf6d47c20f06aa496bb60a08d1f7d5c53134a13fa565aaa3624468ba2f51698b61c0c1f36c4ca8c0eec3518820c1d11a472d4702dd284f32eb
+  data.tar.gz: 643cb0340284d5d995f1b2d58de983ed2d11b3fb2f82a8f8b65d6673bf2cf0761036cd9a73428c55278747aea39161b6e0307e30cd31f6b6b97bc52ac3804751

data/.arcconfig

@@ -1,9 +1,9 @@
 {
   "phabricator.uri": "https://phabricator.dkd.de/",
-  "project.name": "INDOCTRINATRTOOLS",
+  "project.name": "indoctrinatr-tools",
+  "repository.callsign": "INDOCTRINATRTOOLS",
   "arc.feature.start.default": "development",
   "arc.land.onto.default": "development",
   "history.immutable": true,
-  "base": "git:merge-base(development),arc:upstream",
-  "load": []
+  "base": "git:merge-base(development),arc:upstream"
 }

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  Exclude:
+    - tmp/**/*
 Metrics/LineLength:
   Max: 240
 Style/MethodDefParentheses:

data/.rvmrc

@@ -1,4 +1,4 @@
-rvm use 2.1
+rvm use 2.1.9
 
 alias brake='bundle exec'
 alias rubocop='bundle exec rubocop'

data/.travis.yml

@@ -1,15 +1,15 @@
 sudo: true
 language: ruby
 rvm:
+  - '2.3'
   - '2.2'
   - '2.1'
-  - '2.0'
 cache:
   - bundler
   - apt
 before_install:
   - sudo apt-get update && sudo wget https://github.com/scottkosty/install-tl-ubuntu/raw/master/install-tl-ubuntu && sudo chmod +x ./install-tl-ubuntu && sudo ./install-tl-ubuntu
-  - gem install bundler -v 1.10.6
+  - gem install bundler -v 1.12.3
 script:
   - bundle exec indoctrinatr demo
   - bundle exec rake test_with_coveralls

data/README.md

@@ -11,9 +11,9 @@ Rubygem: [![Gem Version](https://badge.fury.io/rb/indoctrinatr-tools.svg)](http:
 1.  Install XeTeX:
 
     Mac OS X: [MacTeX](https://tug.org/mactex/)
- 
+
     Debian/Ubuntu:
-    
+
     ```shell
     apt-get install texlive texlive-xetex texlive-latex-extra texlive-generic-extra
     ```
@@ -27,7 +27,9 @@ Rubygem: [![Gem Version](https://badge.fury.io/rb/indoctrinatr-tools.svg)](http:
 
 ### LaTeX Requirements
 
+* `latexmk`
 * for the template documentation
+  * Tested against TeX Live 2014
   * `dirtree`
   * `datetime2`
 
@@ -40,13 +42,19 @@ Command | Description
 `indoctrinatr new project_name` | Creates a scaffold for a new Template Pack
 `indoctrinatr parse project_name` | Parses a XeTex file with ERB and default values
 `indoctrinatr pdf project_name` | Compiles PDF with default values
+`indoctrinatr pdf_with_field_names project_name` | Generates PDF with the field names as values
 `indoctrinatr doc project_name` | Creates a technical documentation of your template pack
+`indoctrinatr check project_name` | Analyzes your Template Pack for errors
 `indoctrinatr pack project_name` | Creates a Template Pack from a given project folder
 `indoctrinatr demo` | Creates, parses, and compiles a demo project
 `indoctrinatr workflow` | Displays a suggested workflow
 `indoctrinatr bashcompletion` | Displays instructions for bash completion
 `indoctrinatr zshcompletion` | Displays instructions for zsh completion
 
+The commands `pdf`, `pdf_with_field_names` and `doc` have a `keep-aux-files` option. This is helpful if you run in into LaTeX errors, want to inspect the .log file and run LaTeX for yourself again.
+
+The command `doc` does not overwrite existing examples. This means that you can customize the examples that are appended in the documentation.
+
 ## Build
 
 If you want to build the Rubygem yourself, run `rake build` to build and `rake install` to build and install the Indoctrinatr Tools gem.
@@ -60,6 +68,7 @@ What you think of Indoctrinatr and Indoctrinatr Tools? Drop us a line (<opensour
 We are also looking forward to your [GitHub Pull Requests](https://help.github.com/articles/using-pull-requests/).
 
 Manual testing: After cloning the repo, run `bundle exec bin/indoctrinatr` inside the directory for testing your own development changes.
+Automatic testing: run `rake test_with_coveralls`
 
 ## License
 
@@ -69,6 +78,6 @@ Indoctrinatr and Indoctrinatr Tools are licensed under the terms and conditions
 
 [![dkd](assets/images/dkd_logo.png)](https://dkd.de/)
 
-* Luka Lüdicke
+* Luka Lüdicke (development)
 * Nicolai Reuschling (development)
 * Søren Schaffstein (idea, product management)

data/bin/indoctrinatr

@@ -7,7 +7,9 @@ require 'indoctrinatr/tools/template_pack_scaffold'
 require 'indoctrinatr/tools/template_pack_packer'
 require 'indoctrinatr/tools/template_pack_default_values_parser'
 require 'indoctrinatr/tools/template_pack_default_values_compiler'
+require 'indoctrinatr/tools/template_pack_fieldnames_creator'
 require 'indoctrinatr/tools/template_pack_documentation'
+require 'indoctrinatr/tools/template_pack_error_checker'
 
 include GLI::App
 include Indoctrinatr::Tools
@@ -39,7 +41,10 @@ command :workflow do |c|
 4. Run in shell: indoctrinatr pdf demo
    Compiles PDF from demo_with_default_values.tex
 
-5. Run in shell: indoctrinatr pack demo
+5. Run in shell: indoctrinatr check demo
+   Analyzes your Template Pack for potential errors
+
+6. Run in shell: indoctrinatr pack demo
    Creates demo.zip with all required file for upload to Indoctrinatr server
 
 '
@@ -49,7 +54,7 @@ end
 desc 'Create, compile and pack a demo project'
 command :demo do |c|
   c.action do
-    Indoctrinatr::Tools::TemplatePackDemo.new('demo').call
+    TemplatePackDemo.new('demo').call
   end
 end
 
@@ -58,7 +63,7 @@ arg_name 'template-pack-name'
 command :new do |c|
   c.action do |_, _, args|
     template_pack_name = args.join '_'
-    Indoctrinatr::Tools::TemplatePackScaffold.new(template_pack_name).call
+    TemplatePackScaffold.new(template_pack_name).call
   end
 end
 
@@ -67,28 +72,53 @@ arg_name 'template_pack_name'
 command :parse do |c|
   c.action do |_, _, args|
     template_pack_name = args.join '_'
-    Indoctrinatr::Tools::TemplatePackDefaultValuesParser.new(template_pack_name).call
+    TemplatePackDefaultValuesParser.new(template_pack_name).call
   end
 end
 
 desc 'Compile PDF with default values'
 arg_name 'template_pack_name'
 command :pdf do |c|
-  c.action do |_, _, args|
+  c.desc 'Keep generated aux files'
+  c.switch [:'keep-aux-files']
+  c.action do |_, options, args|
     template_pack_name = args.join '_'
+    keep_aux_files = options[:'keep-aux-files']
     TemplatePackDefaultValuesParser.new(template_pack_name).call
-    Indoctrinatr::Tools::TemplatePackDefaultValuesCompiler.new(template_pack_name).call
+    TemplatePackDefaultValuesCompiler.new(template_pack_name, keep_aux_files).call
+  end
+end
+
+desc 'Compile PDF with Variable Names as values'
+arg_name 'template_pack_name'
+command :pdf_with_field_names do |c|
+  c.desc 'Keep generated aux files'
+  c.switch [:'keep-aux-files']
+  c.action do |_, options, args|
+    template_pack_name = args.join '_'
+    keep_aux_files = options[:'keep-aux-files']
+    TemplatePackFieldnamesCreator.new(template_pack_name, keep_aux_files).call
   end
 end
 
 desc 'Create a documentation from a given source folder'
 arg_name 'template_pack_name'
 command :doc do |c|
+  c.desc 'Keep generated aux files'
+  c.switch [:'keep-aux-files']
+  c.action do |_, options, args|
+    template_pack_name = args.join '_'
+    keep_aux_files = options[:'keep-aux-files']
+    TemplatePackDocumentation.new(template_pack_name, keep_aux_files).call
+  end
+end
+
+desc 'Check for errors in the given source folder'
+arg_name 'template_pack_name'
+command :check do |c|
   c.action do |_, _, args|
     template_pack_name = args.join '_'
-    TemplatePackDefaultValuesParser.new(template_pack_name).call # hierarchy - these files are needed. Unfortunately GLI::App does not offer to run other commands
-    TemplatePackDefaultValuesCompiler.new(template_pack_name).call
-    Indoctrinatr::Tools::TemplatePackDocumentation.new(template_pack_name).call
+    TemplatePackErrorChecker.new(template_pack_name).call
   end
 end
 
@@ -97,7 +127,7 @@ arg_name 'template_pack_name'
 command :pack do |c|
   c.action do |_, _, args|
     template_pack_name = args.join '_'
-    Indoctrinatr::Tools::TemplatePackPacker.new(template_pack_name).call
+    TemplatePackPacker.new(template_pack_name).call
   end
 end
 

data/features/demo.feature

@@ -5,13 +5,13 @@ Feature: Running the "demo" command
 
   Scenario:
      When I successfully run `indoctrinatr demo`
-     Then a file named "demo_with_default_values.pdf" should exist
+     Then a file named "demo/doc/demo_technical_documentation.pdf" should exist
       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                     |
-        | demo/demo_with_default_values.tex     |
-        | demo/demo_technical_documentation.pdf |
-        | demo_with_default_values.pdf          |
-        | demo.zip                              |
+        | demo/configuration.yaml                   |
+        | demo/demo.tex.erb                         |
+        | demo/doc/examples/demo_with_default_values.tex |
+        | demo/doc/examples/demo_with_default_values.pdf |
+        | demo/doc/demo_technical_documentation.pdf |
+        | demo.zip                                  |

data/features/doc_keepauxfiles.feature

@@ -0,0 +1,13 @@
+Feature: Running the 'doc' command with keepauxfiles
+
+  Background:
+    Given the default aruba exit timeout is 40 seconds
+
+  Scenario: creating documentation for given project
+    Given I do not have a 'demo' project
+    When I successfully run `indoctrinatr new demo`
+    And I successfully run `indoctrinatr doc demo --keep-aux-files`
+    Then the output should match /A documentation for 'demo' has been successfully generated/
+    Then a file named "demo/doc/demo_technical_documentation.pdf" should exist
+    And a file named "demo/doc/indoctrinatr-technical-documentation.log" should exist
+    And a file named "demo/doc/indoctrinatr-technical-documentation.tex" should exist

data/features/documentation.feature

@@ -1,11 +1,20 @@
 Feature: Running the 'doc' command
 
   Background:
-    Given the default aruba exit timeout is 20 seconds
-
-  Scenario: creating documentation for given project
+    Given the default aruba exit timeout is 40 seconds
     Given I do not have a 'demo' project
     When I successfully run `indoctrinatr new demo`
+
+  Scenario: creating documentation for given project
+    And I successfully run `indoctrinatr doc demo`
+    Then the output should match /Example with field names has been automatically generated for the documentation/
+    Then the output should match /A documentation for 'demo' has been successfully generated/
+    Then a file named "demo/doc/demo_technical_documentation.pdf" should exist
+
+  Scenario: creating the documentation without overwriting a FieldNames PDF example
+    And I successfully run `indoctrinatr pdf_with_field_names demo`
+    Then a file named "demo/doc/examples/demo_with_fieldname_values.pdf" should exist
     And I successfully run `indoctrinatr doc demo`
+    Then the output should not match /Example with field names has been automatically generated for the documentation/
     Then the output should match /A documentation for 'demo' has been successfully generated/
-    Then a file named "demo/demo_technical_documentation.pdf" should exist
+    Then a file named "demo/doc/demo_technical_documentation.pdf" should exist

data/features/fieldnames_pdf.feature

@@ -0,0 +1,9 @@
+Feature: Running the 'pdf_with_field_names' command
+
+  Background:
+    Given the default aruba exit timeout is 20 seconds
+
+  Scenario: for a given 'demo' project
+    Given I have an Indoctrinatr project 'demo'
+    And I run `indoctrinatr pdf_with_field_names demo`
+    Then a file named "demo/doc/examples/demo_with_fieldname_values.pdf" should exist

data/features/fieldnames_pdf_auxfiles.feature

@@ -0,0 +1,10 @@
+Feature: Running the 'pdf_with_field_names' command with keepauxfiles
+
+  Background:
+    Given the default aruba exit timeout is 20 seconds
+
+  Scenario: for a given 'demo' project
+    Given I have an Indoctrinatr project 'demo'
+    And I run `indoctrinatr pdf_with_field_names demo --keep-aux-files`
+    Then a file named "demo/doc/examples/demo_with_fieldname_values.pdf" should exist
+    And a file named "demo/doc/examples/demo_with_fieldname_values.log" should exist

data/features/parse.feature

@@ -3,4 +3,4 @@ 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
+     Then a file named "demo/doc/examples/demo_with_default_values.tex" should exist

data/features/pdf.feature

@@ -7,4 +7,5 @@ Feature: Running the 'pdf' command
     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
+     Then a file named "demo/doc/examples/demo_with_default_values.pdf" should exist
+    # there is not (an easy) way to use the current timestamp. Therefore the template for the 'new' command should not be static

data/features/pdf_keepauxfiles.feature

@@ -0,0 +1,11 @@
+Feature: Running the 'pdf' command with keepauxfiles option
+
+  Background:
+    Given the default aruba exit timeout is 20 seconds
+
+  Scenario: for a given 'demo' project
+    Given I have an Indoctrinatr project 'demo'
+    And I run `indoctrinatr pdf demo --keep-aux-files`
+    Then a file named "demo/doc/examples/demo_with_default_values.pdf" should exist
+    And a file named "demo/doc/examples/demo_with_default_values.log" should exist
+    # there is not (an easy) way to use the current timestamp. Therefore the template for the 'new' command should not be static

data/features/version.feature

@@ -2,4 +2,4 @@ Feature: Running the "version" command
 
   Scenario:
     When I successfully run `indoctrinatr version`
-    Then the output should contain "0.11.0"
+    Then the output should contain "0.12.0"

data/features/workflow.feature

@@ -5,4 +5,5 @@ Feature: Running the "workflow" command
     Then the output should contain "new"
     Then the output should contain "parse"
     Then the output should contain "pdf"
+    Then the output should contain "check"
     Then the output should contain "pack"

data/indoctrinatr-tools.gemspec

@@ -6,9 +6,9 @@ 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.authors       = ['Nicolai Reuschling', 'Luka Lüdicke']
+  spec.email         = ['nicolai.reuschling@dkd.de', 'luka.luedicke@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'
@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
   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 'bundler',   '~> 1.12'
+  spec.add_development_dependency 'rake',      '~> 11.1'
+  spec.add_development_dependency 'rspec',     '~> 3.4'
+  spec.add_development_dependency 'cucumber',  '~> 2.3'
   spec.add_development_dependency 'aruba',     '~> 0.9'
-  spec.add_development_dependency 'rubocop',   '~> 0.33'
+  spec.add_development_dependency 'rubocop',   '~> 0.40'
   spec.add_development_dependency 'pry',       '~> 0.10'
   spec.add_development_dependency 'coveralls', '~> 0.8'
 
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   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.add_dependency 'RedCloth',            '~> 4.3'
 
-  spec.requirements << 'xelatex'
+  spec.requirements << 'LaTeX development enviroment'
 end

data/lib/indoctrinatr/templates/configuration.yaml

@@ -1,17 +1,25 @@
 template_name: Hello World Template
-textual_description: "This is your first Indoctrinatr template.
+textual_description: |
+  This is your first _Indoctrinatr_ template. You can use _Textile_ syntax here to *highlight* important information.
 
-Edit is as you like. Read more at https://github.com/dkd/indoctrinatr."
+    Edit this template as you like. Read more at https://github.com/dkd/indoctrinatr.
 fields:
   -
     name: variable1
+    label: Who is it?
     presentation: text
     default_value: "World"
     description: "The first variable"
+  -
+    name: date
+    label: Date
+    presentation: date
+    default_value: '#{Time.now.year}-#{Time.now.month}-#{Time.now.day}'
   -
     name: variable2
+    label: Type of World
+    required: "true"
     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/dkd-image-tools.sty

@@ -0,0 +1,72 @@
+% Author Søren Schaffstein
+% package "dkd-image-tools"
+% this package provides some image handling tools to make handling of images easier
+
+% include required libraries (tikz, xstring, xparse, graphicx)
+
+%use "graphicx" for including images 
+\usepackage{graphicx}
+
+
+% use "tikz" package for drawing
+\usepackage{tikz}
+
+
+% use "xparse" package to allow command definitions with mutliple optional arguments
+\usepackage{xparse}
+
+
+% use "xstring" package to allow string comparisons
+\usepackage{xstring}
+
+
+
+% creates a placeholder for images with the given dimensions and name
+% usage: 	\imagePlaceholder{<width>}{<height>}{<image name>}[<message>]
+% usage example: \imagePlaceholder{\textwidth}{120mm}{sunset.jpg}[Image not found:]
+\DeclareDocumentCommand{\imagePlaceholder}{ m m m O{} }{%
+	\begin{tikzpicture}[x=#1, y=#2]
+		\draw (0,0) rectangle (1,1);
+		\draw[color=light-gray] (0,0) -- (1,1);
+		\draw[color=light-gray] (0,1) -- (1,0);
+		\node at (0.5, 0.7) {\Large\texttt{#4}};
+		\node at (0.5, 0.5) {\Large\texttt{#3}};
+	\end{tikzpicture}
+}
+
+
+% defines an image placement command that checks if the file exists and places a placeholder if not
+% usage: 	\placeImage{<image name>}[<width>]
+% usage example: \placeImage{sunset.png}[0.5\textwidth]
+\DeclareDocumentCommand{\placeImage}{ m O{\textwidth} }{%
+	% check if filename is not blank (don't return anything if filename is blank)
+	\IfStrEq{#1}{}{}{%
+		\IfFileExists{#1}{%
+			\includegraphics[width=#2]{images/#1}
+		}{%
+			\imagePlaceholder{#2}{#2}{#1}[Image not found:]
+		}
+	}
+}
+
+
+
+% defines a figure placement command that checks if the file exists and places a placeholder if not
+% usage: 	\placeFigure{<image name>}[<caption>][<figure label>][<width>]
+% usage example: \placeFigure{sunset.png}[This is a beautiful sunset!][fig:sun][0.5\textwidth]
+\DeclareDocumentCommand{\placeFigure}{ m O{} O{} O{\textwidth} }{%
+	% check if filename is not blank (don't return anything if filename is blank)
+	\IfStrEq{#1}{}{}{%
+		\begin{figure}[htbp]
+			\placeImage{#1}[#4]
+			% place caption if one was given
+			\IfStrEq{#2}{}{}{%
+				\caption{#2}
+			}
+			% place a label if one was given
+			\IfStrEq{#3}{}{}{%
+				\label{#3} 
+			}
+		\end{figure}
+	}
+}