indoctrinatr-tools 0.16.0 → 0.17.0

data/bin/indoctrinatr

@@ -1,182 +0,0 @@
-#!/usr/bin/env ruby
-require 'gli'
-require 'indoctrinatr/tools/version'
-require 'indoctrinatr/tools/template_pack_demo'
-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'
-
-# rubocop:disable Style/MixinUsage
-include GLI::App
-include Indoctrinatr::Tools
-# rubocop:enable Style/MixinUsage
-
-program_desc 'Create and manage Template Packs for Indoctrinatr'
-version Indoctrinatr::Tools::VERSION
-config_file '.indoctrinatr.rc'
-
-desc 'Display current version'
-command :version do |c|
-  c.action do
-    puts Indoctrinatr::Tools::VERSION
-  end
-end
-
-desc 'Display the suggested workflow'
-command :workflow do |c|
-  c.action do
-    puts <<~HEREDOC
-      The workflow for a project (e.g. demo) typically looks like this:
-
-      1. Run in shell: indoctrinatr new demo
-         Creates a new Indoctrinatr Template Pack in the folder demo
-
-      2. Edit demo.tex.erb and configuration.yaml according to needs
-
-      3. Run in shell: indoctrinatr parse demo
-         Parses tex file demo_with_default_values.tex with ERB and default values from configuration.yaml
-
-      4. Run in shell: indoctrinatr pdf demo
-         Compiles PDF from demo_with_default_values.tex
-
-      5. Run in shell: indoctrinatr check demo
-         Analyzes your Template Pack for potential errors
-
-      6. Run in shell: indoctrinatr doc demo
-         Creates a technical documentation for the Template Pack
-
-      7. Run in shell: indoctrinatr pack demo
-         Creates demo.zip with all required file for upload to Indoctrinatr server
-    HEREDOC
-  end
-end
-
-desc 'Create, compile and pack a demo project'
-command :demo do |c|
-  c.action do
-    TemplatePackDemo.new('demo').call
-  end
-end
-
-pre do |global_options, _, _, args|
-  # modify template_pack_name argument. This removes a trailing '/' that we get when users use tab completion
-  global_options['template_pack_name'] = File.split(args[0])[1] unless args.empty?
-  true # pre condition returns false when nothing is done
-end
-
-desc 'Create a scaffold for a new Template Pack'
-arg_name 'template-pack-name'
-command :new do |c|
-  c.action do |global_options, _, _|
-    template_pack_name = global_options['template_pack_name']
-    TemplatePackScaffold.new(template_pack_name).call
-  end
-end
-
-desc 'Parse XeTeX file with ERB and default values of Template Pack'
-arg_name 'template_pack_name'
-command :parse do |c|
-  c.action do |global_options, _, _|
-    template_pack_name = global_options['template_pack_name']
-    TemplatePackDefaultValuesParser.new(template_pack_name).call
-  end
-end
-
-desc 'Compile PDF with default values'
-arg_name 'template_pack_name'
-command :pdf do |c|
-  c.desc 'Keep generated aux files'
-  c.switch [:'keep-aux-files']
-  c.action do |global_options, options, _|
-    template_pack_name = global_options['template_pack_name']
-    keep_aux_files = options[:'keep-aux-files']
-    TemplatePackDefaultValuesParser.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 |global_options, options, _|
-    template_pack_name = global_options['template_pack_name']
-    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 |global_options, options, _|
-    template_pack_name = global_options['template_pack_name']
-    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 |global_options, _, _|
-    template_pack_name = global_options['template_pack_name']
-    TemplatePackErrorChecker.new(template_pack_name).call
-  end
-end
-
-desc 'Create a Template Pack from a given source folder'
-arg_name 'template_pack_name'
-command :pack do |c|
-  c.action do |global_options, _, _|
-    template_pack_name = global_options['template_pack_name']
-    TemplatePackPacker.new(template_pack_name).call
-  end
-end
-
-desc 'Display instructions for bash completion'
-command :bashcompletion do |c|
-  c.action do
-    puts <<~HEREDOC
-      Add this to your .bashrc (and open up a new shell):
-      complete -F get_indoctrinatr_targets indoctrinatr
-      function get_indoctrinatr_targets()
-      {
-          if [ -z $2 ] ; then
-              COMPREPLY=(`indoctrinatr help -c`)
-          else
-              COMPREPLY=(`indoctrinatr help -c $2`)
-          fi
-      }
-    HEREDOC
-  end
-end
-
-# thanks to http://devopsbox.es/posts/2013/10-31-the-cleanest-gli-bash-zsh-tab-completion.html
-desc 'Display instructions for zsh completion'
-command :zshcompletion do |c|
-  c.action do
-    puts 'Add this to your .zshrc (and open up a new shell):
-if [[ -n ${ZSH_VERSION-} ]]; then
-  autoload -U +X bashcompinit && bashcompinit
-fi
-complete -F get_indoctrinatr_commands indoctrinatr
-function get_indoctrinatr_commands()
-{
-  local binary="indoctrinatr"
-  help_params=${COMP_WORDS[@]:1}
-  clean_params=${help_params//-*([^ ])?( )}
-  COMPREPLY=(`$binary help -c $clean_params`)
-}
-'
-  end
-end
-
-exit run(ARGV)

data/certs/dkd-reuschling.pem

@@ -1,20 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDVjCCAj6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAqMSgwJgYDVQQDDB9uaWNv
-bGFpLnJldXNjaGxpbmcvREM9ZGtkL0RDPWRlMB4XDTIwMDIxNDE1MTcwNloXDTIx
-MDIxMzE1MTcwNlowKjEoMCYGA1UEAwwfbmljb2xhaS5yZXVzY2hsaW5nL0RDPWRr
-ZC9EQz1kZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL5RzbjnDuqA
-rb+fbMKmHdfNZcX9rAlcGo5i7lwtBImH8DAikZXpS5pmDh+tWq0wiYlGqBjghPRw
-rdWcVZDf23EiKjDuDDW0bqtqNg6wbClkjGgr1GEyYuhficipS/1xWD3PTaCMk9RS
-eVJwwtzNJQbLyTnUZI8biuaSJr/pXot2WqyC/+0z+ddXzI00W686NRpbRb3DNR2l
-5P59g1NiHrwiPjzWj+viIgCXt4j5wxJcZmEDuJQIZLdkcLcp7XGMpFnNsOcr7BMv
-w4/5NJS/7QG/n7j3xMOrCRpred346xlUoG5seVuu7mvChkOFleEkkKomvAEdiC5Y
-wB2Zd1EptkkCAwEAAaOBhjCBgzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
-HQ4EFgQUbCmdTAu9t3RJwYPe9hOJ3JWBlfowJAYDVR0RBB0wG4EZbmljb2xhaS5y
-ZXVzY2hsaW5nQGRrZC5kZTAkBgNVHRIEHTAbgRluaWNvbGFpLnJldXNjaGxpbmdA
-ZGtkLmRlMA0GCSqGSIb3DQEBCwUAA4IBAQBk1mExobXS3Uljuvadir5gAWkGQSRt
-queISF2e9iQKmuXV3auAy0UWbHTBqjwu8dJtzQTX5UOtfG/Jt1QIU3X6sEBuMY76
-Zbyu2NYp54ESAAyZFpt2prs7oDkRiDYk6FdZ7mHLTjPgr8nZV0qqONRfzmWmpImG
-PxsXUcEiEZej8d8C5vcHy3bwXb/+CjzcKrcqN67lkXwrA9jzqMuqnjVuhx+JMXJ5
-kHAKYJXqSQLXcRmkRlqCNGKAJSy6FmpClVbei309Yg3dl4PmFSc8GdLcWD1keOvE
-qzeIYbdD18i9ZRk4hfm8vEpevt+xRgM+3ughiJIaiWI3eO3C+VRszvqU
------END CERTIFICATE-----

data/features/autocompletion_support.feature

@@ -1,9 +0,0 @@
-Feature: Checking autocompletion
-  Scenario: Running the 'bashcompletion' command
-    When I successfully run `indoctrinatr bashcompletion`
-    Then the output should contain "get_indoctrinatr_targets()"
-
-  Scenario: Running the 'zshcompletion' command
-    When I successfully run `indoctrinatr zshcompletion`
-    Then the output should contain "autoload -U +X bashcompinit && bashcompinit"
-     And the output should contain "get_indoctrinatr_commands()"

data/features/demo.feature

@@ -1,17 +0,0 @@
-Feature: Running the "demo" command
-
-  Background:
-    Given the default aruba exit timeout is 60 seconds
-
-  Scenario:
-    When I successfully run `indoctrinatr demo`
-    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/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

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

data/features/fieldnames_pdf.feature

@@ -1,9 +0,0 @@
-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'
-     When 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

@@ -1,10 +0,0 @@
-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'
-     When 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/pack.feature

@@ -1,11 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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/doc/examples/demo_with_default_values.tex" should exist

data/features/pdf.feature

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

data/features/pdf_keepauxfiles.feature

@@ -1,11 +0,0 @@
-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'
-     When 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/pdf_with_timestamp.feature

@@ -1,8 +0,0 @@
-Feature: Running the 'pdf' command with timestamp in filename
-  Scenario: using the test fixture
-    Given I use the fixture named "test"
-     When I cd to "../"
-      And I run the Indoctrinatr command 'parse test'
-      And I run `indoctrinatr pdf test`
-      # String interpolation for "file named should exist" does not work. Therefore less strict regexp matching:
-     Then a file matching %r<test/doc/examples/\d{4}_hello_world\.pdf> should exist

data/features/scaffold.feature

@@ -1,23 +0,0 @@
-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

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

data/features/step_definitions/indoctrinatr_cli.rb

@@ -1,11 +0,0 @@
-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

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

data/features/version.feature

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

data/features/workflow.feature

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

data/lib/indoctrinatr/tools/directory_helpers.rb

@@ -1,19 +0,0 @@
-module Indoctrinatr
-  module Tools
-    module DirectoryHelpers
-      def print_dirtree_style directory = '.'
-        Dir.glob("#{directory}/**/*").inject [] do |entries, entry| # list entries recursively
-          nesting = entry.count(File::SEPARATOR) + 1 # nesting starts with 2, because for \dirtree 1 is root
-          name = entry.split(File::SEPARATOR).last
-          entries.push ".#{nesting} #{name}. " # formatting for \dirtree: .<level><space><text-node>.<space>
-        end
-      end
-
-      # default file types for template docs
-      def list_files_of_type directory = '.', types = %w[erb rb yaml sty tex]
-        # found and modified from http://stackoverflow.com/a/3504307/1796645
-        Dir.glob("#{directory}/**/*.{#{types.join(',')}}") # recursively list files of type in types array
-      end
-    end
-  end
-end

data/lib/indoctrinatr/tools/template_pack_default_values_compiler.rb

@@ -1,47 +0,0 @@
-require 'indoctrinatr/tools/configuration_extractor'
-require 'indoctrinatr/tools/pdf_generator'
-require 'fileutils'
-
-module Indoctrinatr
-  module Tools
-    class TemplatePackDefaultValuesCompiler
-      include TemplatePackHelpers
-      include PdfGenerator
-
-      attr_accessor :template_pack_name
-
-      def initialize template_pack_name, keep_aux_files = false
-        @template_pack_name = template_pack_name
-        @keep_aux_files = keep_aux_files
-      end
-
-      def call
-        check_for_folder
-        compile_tex_file
-        rename_if_necessary
-      end
-
-      def pdf_exists?
-        check_for_folder
-        file_path = pdf_with_default_values_file_path ConfigurationExtractor.new(template_pack_name).call
-        File.exist? file_path
-      end
-
-      private
-
-      def compile_tex_file
-        make_pdf tex_with_default_values_file_path, pack_documentation_examples_dir_path, !@keep_aux_files
-      end
-
-      def rename_if_necessary # rubocop:disable Metrics/AbcSize
-        configuration = ConfigurationExtractor.new(template_pack_name).call # TODO: avoid repeated calling of the ConfigurationExtrator
-        @default_values = DefaultValues.new configuration
-        return if @default_values.customized_output_file_name == @default_values.default_file_name
-
-        custom_filepath = pack_documentation_examples_dir_path + @default_values.customized_output_file_name
-        FileUtils.rm custom_filepath if File.exist? custom_filepath
-        FileUtils.mv(pack_documentation_examples_dir_path + @default_values.default_file_name, custom_filepath)
-      end
-    end
-  end
-end

data/lib/indoctrinatr/tools/template_pack_default_values_parser.rb

@@ -1,55 +0,0 @@
-require 'indoctrinatr/tools/template_pack_helpers'
-require 'indoctrinatr/tools/default_values'
-require 'indoctrinatr/tools/configuration_extractor'
-require 'erubis'
-require 'to_latex'
-
-module Indoctrinatr
-  module Tools
-    class TemplatePackDefaultValuesParser
-      include TemplatePackHelpers
-
-      attr_accessor :template_pack_name, :configuration, :default_values, :tex_file_content, :parsed_tex_file_content
-
-      def initialize template_pack_name
-        @template_pack_name = template_pack_name
-      end
-
-      def call
-        check_for_folder
-        read_config_file
-        read_tex_file
-        parse_tex_file
-        write_tex_file
-        show_success
-      end
-
-      private
-
-      def read_config_file
-        @configuration = ConfigurationExtractor.new(template_pack_name).call
-        @default_values = DefaultValues.new @configuration
-        @default_values._use_default_values
-      end
-
-      def read_tex_file
-        @tex_file_content = File.read tex_file_path
-      end
-
-      def parse_tex_file
-        @parsed_tex_file_content = Erubis::Eruby.new(@tex_file_content).result(default_values.retrieve_binding)
-      end
-
-      def write_tex_file
-        # Create directory to avoid file creation errors
-        Dir.mkdir(pack_documentation_dir_path) unless Dir.exist?(pack_documentation_dir_path)
-        Dir.mkdir(pack_documentation_examples_dir_path) unless Dir.exist?(pack_documentation_examples_dir_path)
-        File.write tex_with_default_values_file_path, parsed_tex_file_content
-      end
-
-      def show_success
-        puts "The template pack '#{template_pack_name}' has been successfully parsed with default values."
-      end
-    end
-  end
-end

data/lib/indoctrinatr/tools/template_pack_demo.rb

@@ -1,23 +0,0 @@
-require 'indoctrinatr/tools/template_pack_helpers'
-
-module Indoctrinatr
-  module Tools
-    class TemplatePackDemo
-      include TemplatePackHelpers
-
-      attr_accessor :template_pack_name
-
-      def initialize template_pack_name
-        @template_pack_name = template_pack_name
-      end
-
-      def call
-        TemplatePackScaffold.new(template_pack_name).call
-        TemplatePackDefaultValuesParser.new(template_pack_name).call
-        TemplatePackDefaultValuesCompiler.new(template_pack_name).call
-        TemplatePackDocumentation.new(template_pack_name).call
-        TemplatePackPacker.new(template_pack_name).call
-      end
-    end
-  end
-end