indoctrinatr-tools 0.11.0 → 0.12.0

data/lib/indoctrinatr/tools/template_pack_default_values_parser.rb

@@ -29,6 +29,7 @@ module Indoctrinatr
       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
@@ -40,6 +41,9 @@ module Indoctrinatr
       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
 

data/lib/indoctrinatr/tools/template_pack_documentation.rb

@@ -2,6 +2,7 @@ require 'indoctrinatr/tools/template_documentation_content'
 require 'indoctrinatr/tools/template_pack_helpers'
 require 'indoctrinatr/tools/template_documentation_helpers'
 require 'indoctrinatr/tools/configuration_extractor'
+require 'indoctrinatr/tools/pdf_generator'
 require 'erubis'
 require 'to_latex'
 require 'fileutils'
@@ -11,14 +12,16 @@ module Indoctrinatr
     class TemplatePackDocumentation
       include TemplatePackHelpers
       include TemplateDocumentationHelpers
+      include PdfGenerator
 
-      attr_accessor :template_pack_name
+      attr_accessor :template_pack_name, :keep_aux_files
 
-      def initialize 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
+      def call # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         fill_documentation_content
         read_content_tex_file
         read_main_tex_file
@@ -30,9 +33,18 @@ module Indoctrinatr
         copy_source_files
         if compile_documentation_to_pdf
           copy_doc_file_to_template_pack
-          delete_temp_dir
+          if @keep_aux_files
+            copy_helper_files_to_template_pack
+            show_temp_directory
+          else
+            delete_temp_dir
+          end
           show_success
         else
+          if @keep_aux_files
+            copy_helper_files_to_template_pack
+            show_temp_directory
+          end
           handle_latex_error
         end
       end
@@ -57,7 +69,7 @@ module Indoctrinatr
       end
 
       def parse_content_tex_file
-        @parsed_content_tex_file_content = Erubis::Eruby.new(@content_tex_file_content).result(@documentation_content.retrieve_binding)
+        @parsed_content_tex_file_content = Erubis::Eruby.new(@content_tex_file_content).result(@documentation_content.retrieve_binding) # TODO: more useful error messages for user on errors
       end
 
       def parse_main_tex_file
@@ -79,21 +91,30 @@ module Indoctrinatr
       def copy_source_files
         FileUtils.copy_file source_latex_package_file_path, latex_package_destination_path
         FileUtils.copy_file source_letterpaper_file_path, letterpaper_file_destination_path
+        FileUtils.copy_file source_image_tools_package_file_path, image_tools_package_destination_path
       end
 
       def compile_documentation_to_pdf
-        args = ['-xelatex',
-                '-shell-escape',
-                '-interaction=batchmode', # more silent output
-                "-output-directory=#{documentation_compile_dir_path_name}", main_tex_file_destination_path.to_s] # without this xelatex tries to use the current working directory
-        latexmk_successful = system('latexmk', *args) # latexmk instead of running 2.times
-        latexmk_successful # false if error, nil if system command unknown
+        make_pdf main_tex_file_destination_path, documentation_compile_dir_path_name, !@keep_aux_files
+      end
+
+      def copy_helper_files_to_template_pack
+        helper_files_to_copy = [latex_log_file, content_tex_file_destination_path, main_tex_file_destination_path].freeze
+        Dir.mkdir(pack_documentation_dir_path) unless Dir.exist?(pack_documentation_dir_path)
+        FileUtils.copy helper_files_to_copy, pack_documentation_dir_path
+        puts 'TeX files and log file have been copied to doc subdirectory of your template_pack'
       end
 
       def copy_doc_file_to_template_pack
+        # All the documentation shall go into template_pack/doc
+        Dir.mkdir(pack_documentation_dir_path) unless Dir.exist?(pack_documentation_dir_path)
         FileUtils.copy_file documentation_file_path, pack_technical_documentation_file_path
       end
 
+      def show_temp_directory
+        puts "Look into the directory #{documentation_temp_dir} to see all files related to the technical documentation compilation"
+      end
+
       def delete_temp_dir
         FileUtils.remove_entry_secure documentation_compile_dir_path_name
       end

data/lib/indoctrinatr/tools/template_pack_error_checker.rb

@@ -0,0 +1,104 @@
+require 'indoctrinatr/tools/template_pack_helpers'
+
+module Indoctrinatr
+  module Tools
+    class TemplatePackErrorChecker
+      include TemplatePackHelpers
+
+      # class wide constants
+      # needs to match indoctrinatr's TemplateField model
+      VALID_PRESENTATIONS = %w(text textarea checkbox radiobutton dropdown date range file).freeze
+      REQUIRES_AVAILABLE_OPTIONS = %w(dropdown checkbox radiobutton).freeze
+
+      attr_accessor :template_pack_name, :config_file
+      def initialize template_pack_name
+        @template_pack_name = template_pack_name
+      end
+
+      def call
+        check_config_file_existence && check_config_file_syntax && check_attributes
+        # TODO: check multiple variable name declaration (low-prio)
+      end
+
+      private
+
+      def check_config_file_existence
+        return true if File.exist? config_file_path
+        puts 'The file configuration.yaml does not exist in the template_pack directory'
+        false
+      end
+
+      def check_config_file_syntax # YAML syntax check
+        puts 'Checking YAML syntax...'
+        YAML.parse_file config_file_path
+        puts 'YAML syntax ok!'
+        true
+      rescue YAML::SyntaxError => exception # no program abort when this exception is thrown
+        puts 'YAML syntax error in configuration.yaml, see error for details:'
+        puts exception.message
+        false
+      end
+
+      def check_attributes
+        configuration = ConfigurationExtractor.new(template_pack_name).call
+        puts 'Checking...'
+
+        configuration.attributes_as_hashes_in_array.each_with_index do |attribute_hash, index|
+          identifier = "Variable number #{index + 1}" # string for the user to localize variable with errors/warnings
+          name_field = check_field_attribute attribute_hash, identifier, 'name'
+          identifier = "Variable \"#{name_field}\"" if name_field != false
+
+          check_presentation attribute_hash, identifier
+
+          check_field_attribute attribute_hash, identifier, 'default_value'
+
+          check_field_attribute attribute_hash, identifier, 'description'
+          # idea: warning if no required attribute?
+        end
+      end
+
+      def check_field_attribute attribute_hash, field_identifier, key # false if something wrong, otherwise returns the key value
+        unless attribute_hash.key? key
+          puts "The #{field_identifier} has no #{key} type set!"
+          return false
+        end
+        if attribute_hash[key].nil? || attribute_hash[key].empty?
+          puts "The #{field_identifier} has an empty #{key}!"
+          false
+        else
+          attribute_hash[key]
+        end
+      end
+
+      def check_presentation attribute_hash, identifier
+        presentation = check_field_attribute attribute_hash, identifier, 'presentation'
+        return false unless presentation
+        # check if it is one of the options
+        puts "Not an allowed presentation option set for #{identifier}" unless VALID_PRESENTATIONS.include? presentation
+        check_available_options attribute_hash, identifier, presentation if REQUIRES_AVAILABLE_OPTIONS.include? presentation
+        check_presentation_range attribute_hash, identifier, presentation if presentation == 'range'
+      end
+
+      def check_available_options attribute_hash, identifier, presentation_type
+        unless attribute_hash.key? 'available_options'
+          puts "The #{identifier} has no available_options (needed for #{presentation_type} presentation)"
+          return false
+        end
+        available_options = attribute_hash['available_options']
+        if available_options.nil?
+          puts("available_options for #{identifier} is empty (needed for #{presentation_type} presentation)")
+          false
+        else
+          puts("available_options for #{identifier} has only one option. That is useless.") if available_options.count(',') == 1
+          true
+        end
+      end
+
+      def check_presentation_range attribute_hash, identifier, presentation
+        puts "The #{identifier} has no start_of_range field (needed for #{presentation} presentation)" unless attribute_hash.key? 'start_of_range'
+        puts "The #{identifier} has no end_of_range field (needed for #{presentation} presentation)" unless attribute_hash.key? 'end_of_range'
+        # TODO: check for content
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/template_pack_fieldnames_creator.rb

@@ -0,0 +1,79 @@
+require 'indoctrinatr/tools/template_pack_helpers'
+require 'indoctrinatr/tools/field_name_values'
+require 'indoctrinatr/tools/configuration_extractor'
+require 'indoctrinatr/tools/pdf_generator'
+require 'erubis'
+require 'to_latex'
+
+module Indoctrinatr
+  module Tools
+    class TemplatePackFieldnamesCreator
+      include TemplatePackHelpers
+      include PdfGenerator
+
+      attr_accessor :template_pack_name, :configuration, :field_name_values, :tex_file_content, :parsed_tex_file_content
+
+      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
+        read_config_file
+        read_tex_file
+        parse_tex_file
+        write_tex_file
+        if compile_tex_file
+          show_success
+          true
+        else
+          handle_latex_error
+          false
+        end
+      end
+
+      def pdf_exists?
+        check_for_folder
+        File.exist? pdf_with_fieldname_values_file_path
+      end
+
+      private
+
+      def read_config_file
+        @configuration = ConfigurationExtractor.new(template_pack_name).call
+        @field_name_values = FieldNameValues.new @configuration
+        field_name_values._field_names_as_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(field_name_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_fieldname_values_file_path, parsed_tex_file_content
+      end
+
+      def compile_tex_file
+        make_pdf tex_with_fieldname_values_file_path, pack_documentation_examples_dir_path, !@keep_aux_files
+      end
+
+      def handle_latex_error
+        puts 'possible LaTeX compilation failure!' # see #{latex_log_file_destination} for details. " # idea: process $CHILD_STATUS
+        # FileUtils.copy_file latex_log_file, latex_log_file_destination
+      end
+
+      def show_success
+        puts "The template pack '#{template_pack_name}' has been successfully parsed with the variable names"
+        puts 'Please check the .tex file and modify it to your needs and compile it again'
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/template_pack_helpers.rb

@@ -1,3 +1,5 @@
+require 'indoctrinatr/tools/default_values'
+
 module Indoctrinatr
   module Tools
     module TemplatePackHelpers # classes that use this model are required to have template_pack_name as instance variable
@@ -10,8 +12,8 @@ module Indoctrinatr
       end
 
       def check_for_folder
-        fail 'Please specify a template pack name.' if template_pack_name.empty?
-        fail "A folder with name '#{template_pack_name}' does not exist." unless Dir.exist? path_name
+        fail 'Please specify a template pack name.' if template_pack_name.empty? # rubocop:disable Style/SignalException
+        fail "A folder with name '#{template_pack_name}' does not exist." unless Dir.exist? path_name # rubocop:disable Style/SignalException
       end
 
       def config_file_path
@@ -23,11 +25,39 @@ module Indoctrinatr
       end
 
       def tex_with_default_values_file_path
-        path_name.join template_pack_name + '_with_default_values.tex'
+        pack_documentation_examples_dir_path.join template_pack_name + '_with_default_values.tex'
+      end
+
+      # get file path for PDF example with default values:
+      def pdf_with_default_values_file_path configuration # rubocop:disable Metrics/AbcSize
+        default_values = DefaultValues.new configuration
+        # if there is a change in where the pdf command (DefaultValuesCompiler) saves it's output, this logic needs to be updated
+        if default_values.customized_output_file_name == default_values.default_file_name
+          Pathname.new(Dir.pwd).join pack_documentation_examples_dir_path + default_values.customized_output_file_name
+        else
+          Pathname.new(Dir.pwd).join pack_documentation_examples_dir_path + eval('"' + default_values.output_file_name + '"') # rubocop:disable Lint/Eval
+          # usage of eval to execute the interpolation of a custom filename string with interpolation - e.g. a filename with the current date
+        end
+      end
+
+      def pdf_with_fieldname_values_file_path
+        "#{pack_documentation_examples_dir_path.join template_pack_name}_with_fieldname_values.pdf"
+      end
+
+      def tex_with_fieldname_values_file_path
+        "#{pack_documentation_examples_dir_path.join template_pack_name}_with_fieldname_values.tex"
+      end
+
+      def pack_documentation_dir_path
+        path_name.join 'doc'
+      end
+
+      def pack_documentation_examples_dir_path
+        pack_documentation_dir_path.join 'examples'
       end
 
       def pack_technical_documentation_file_path
-        path_name.join template_pack_name + '_technical_documentation.pdf'
+        pack_documentation_dir_path.join template_pack_name + '_technical_documentation.pdf'
       end
 
       def latex_log_file_destination

data/lib/indoctrinatr/tools/template_pack_scaffold.rb

@@ -23,8 +23,8 @@ module Indoctrinatr
       private
 
       def create_folder
-        fail 'Please specify a template pack name.' if template_pack_name.empty?
-        fail "A folder with name '#{template_pack_name}' already exists." if Dir.exist? path_name
+        fail 'Please specify a template pack name.' if template_pack_name.empty? # rubocop:disable Style/SignalException
+        fail "A folder with name '#{template_pack_name}' already exists." if Dir.exist? path_name # rubocop:disable Style/SignalException
 
         Dir.mkdir path_name
       end

data/lib/indoctrinatr/tools/version.rb

@@ -1,5 +1,5 @@
 module Indoctrinatr
   module Tools
-    VERSION = '0.11.0'
+    VERSION = '0.12.0'.freeze
   end
 end

data/lib/redcloth_latex_formatter_patch/patch.rb

@@ -3,7 +3,8 @@ require 'redcloth'
 module RedCloth
   module Formatters
     module LATEX
-      { h1: 'chapter',
+      {
+        h1: 'chapter',
         h2: 'section',
         h3: 'subsection',
         h4: 'subsubsection'

data/spec/indoctrinatr/templates/configuration_file_spec.rb

@@ -4,6 +4,6 @@ require 'pathname'
 describe 'configuration.yaml' do
   it 'should exist' do
     configuration_file = Pathname.new(__FILE__).join '..', '..', '..', '..', 'lib', 'indoctrinatr', 'templates', 'configuration.yaml'
-    expect(File.exist? configuration_file).to eq true
+    expect(File.exist?(configuration_file)).to eq true
   end
 end

data/spec/indoctrinatr/templates/tex_file_spec.rb

@@ -4,6 +4,6 @@ require 'pathname'
 describe 'template.tex.erb' do
   it 'should exist' do
     template_file = Pathname.new(__FILE__).join '..', '..', '..', '..', 'lib', 'indoctrinatr', 'templates', 'template.tex.erb'
-    expect(File.exist? template_file).to eq true
+    expect(File.exist?(template_file)).to eq true
   end
 end

data/spec/indoctrinatr/tools/version_spec.rb

@@ -3,6 +3,6 @@ require 'indoctrinatr/tools/version'
 
 describe Indoctrinatr::Tools do
   it 'defines a VERSION constant' do
-    expect(Indoctrinatr::Tools::VERSION).to eq '0.11.0'
+    expect(Indoctrinatr::Tools::VERSION).to eq '0.12.0'
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: indoctrinatr-tools
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Nicolai Reuschling
+- Luka Lüdicke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +17,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '0.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '0.40'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -184,17 +185,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
 description: 
 email:
 - nicolai.reuschling@dkd.de
+- luka.luedicke@dkd.de
 executables:
 - indoctrinatr
 extensions: []
@@ -216,10 +218,14 @@ files:
 - cucumber.yml
 - features/autocompletion_support.feature
 - features/demo.feature
+- features/doc_keepauxfiles.feature
 - features/documentation.feature
+- features/fieldnames_pdf.feature
+- features/fieldnames_pdf_auxfiles.feature
 - features/pack.feature
 - features/parse.feature
 - features/pdf.feature
+- features/pdf_keepauxfiles.feature
 - features/scaffold.feature
 - features/step_definitions/common.rb
 - features/step_definitions/indoctrinatr_cli.rb
@@ -228,6 +234,7 @@ files:
 - features/workflow.feature
 - indoctrinatr-tools.gemspec
 - lib/indoctrinatr/templates/configuration.yaml
+- lib/indoctrinatr/templates/documentation/dkd-image-tools.sty
 - lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation-content.tex.erb
 - lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation.sty
 - lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation.tex.erb
@@ -235,8 +242,11 @@ files:
 - lib/indoctrinatr/templates/template.tex.erb
 - lib/indoctrinatr/tools.rb
 - lib/indoctrinatr/tools/configuration_extractor.rb
+- lib/indoctrinatr/tools/content_for_tex_files.rb
 - lib/indoctrinatr/tools/default_values.rb
 - lib/indoctrinatr/tools/directory_helpers.rb
+- lib/indoctrinatr/tools/field_name_values.rb
+- lib/indoctrinatr/tools/pdf_generator.rb
 - lib/indoctrinatr/tools/template_documentation_content.rb
 - lib/indoctrinatr/tools/template_documentation_helpers.rb
 - lib/indoctrinatr/tools/template_documentation_source_file.rb
@@ -245,6 +255,8 @@ files:
 - lib/indoctrinatr/tools/template_pack_default_values_parser.rb
 - lib/indoctrinatr/tools/template_pack_demo.rb
 - lib/indoctrinatr/tools/template_pack_documentation.rb
+- lib/indoctrinatr/tools/template_pack_error_checker.rb
+- lib/indoctrinatr/tools/template_pack_fieldnames_creator.rb
 - lib/indoctrinatr/tools/template_pack_helpers.rb
 - lib/indoctrinatr/tools/template_pack_packer.rb
 - lib/indoctrinatr/tools/template_pack_scaffold.rb
@@ -275,21 +287,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- xelatex
+- LaTeX development enviroment
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 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.)
+  Germany).
 test_files:
 - features/autocompletion_support.feature
 - features/demo.feature
+- features/doc_keepauxfiles.feature
 - features/documentation.feature
+- features/fieldnames_pdf.feature
+- features/fieldnames_pdf_auxfiles.feature
 - features/pack.feature
 - features/parse.feature
 - features/pdf.feature
+- features/pdf_keepauxfiles.feature
 - features/scaffold.feature
 - features/step_definitions/common.rb
 - features/step_definitions/indoctrinatr_cli.rb