indoctrinatr-tools 0.16.0 → 0.17.0

data/lib/indoctrinatr/tools/template_pack_documentation.rb

@@ -1,132 +0,0 @@
-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'
-
-module Indoctrinatr
-  module Tools
-    class TemplatePackDocumentation
-      include TemplatePackHelpers
-      include TemplateDocumentationHelpers
-      include PdfGenerator
-
-      attr_accessor :template_pack_name, :keep_aux_files
-
-      def initialize template_pack_name, keep_aux_files = false
-        @template_pack_name = template_pack_name
-        @keep_aux_files = keep_aux_files
-      end
-
-      def call # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        fill_documentation_content
-        read_content_tex_file
-        read_main_tex_file
-        parse_content_tex_file
-        parse_main_tex_file
-        create_temp_compile_dir
-        write_content_tex_file
-        write_main_tex_file
-        copy_source_files
-        if compile_documentation_to_pdf
-          copy_doc_file_to_template_pack
-          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
-
-      private
-
-      def fill_documentation_content
-        configuration = ConfigurationExtractor.new(template_pack_name).call
-        begin
-          @documentation_content = TemplateDocumentationContent.new template_pack_name, configuration
-        rescue IOError => e
-          abort e.message
-        end
-      end
-
-      def read_content_tex_file
-        @content_tex_file_content = File.read content_tex_file_path
-      end
-
-      def read_main_tex_file
-        @main_tex_file_content = File.read source_main_tex_file_path
-      end
-
-      def parse_content_tex_file
-        @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
-        @parsed_main_tex_file_content = Erubis::Eruby.new(@main_tex_file_content).result(@documentation_content.retrieve_binding)
-      end
-
-      def create_temp_compile_dir
-        make_documentation_compile_dir_path_name
-      end
-
-      def write_content_tex_file
-        File.write content_tex_file_destination_path, @parsed_content_tex_file_content
-      end
-
-      def write_main_tex_file
-        File.write main_tex_file_destination_path, @parsed_main_tex_file_content
-      end
-
-      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
-        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
-
-      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 "A documentation for '#{template_pack_name}' has been successfully generated."
-      end
-    end
-  end
-end

data/lib/indoctrinatr/tools/template_pack_error_checker.rb

@@ -1,108 +0,0 @@
-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
-
-      # YAML syntax check
-      def check_config_file_syntax
-        puts 'Checking YAML syntax...'
-        YAML.parse_file config_file_path
-        puts 'YAML syntax ok!'
-        true
-      rescue YAML::SyntaxError => e # no program abort when this exception is thrown
-        puts 'YAML syntax error in configuration.yaml, see error for details:'
-        puts e.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
-
-      # false if something wrong, otherwise returns the key value
-      def check_field_attribute attribute_hash, field_identifier, key
-        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

@@ -1,79 +0,0 @@
-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,69 +0,0 @@
-require 'indoctrinatr/tools/default_values'
-
-module Indoctrinatr
-  module Tools
-    # classes that use this model are required to have template_pack_name as instance variable
-    module TemplatePackHelpers
-      def path_name
-        Pathname.new(Dir.pwd).join template_pack_name
-      end
-
-      def assets_path
-        path_name.join 'assets'
-      end
-
-      def check_for_folder
-        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
-        path_name.join 'configuration.yaml'
-      end
-
-      def tex_file_path
-        path_name.join template_pack_name + '.tex.erb'
-      end
-
-      def tex_with_default_values_file_path
-        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 Security/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
-        pack_documentation_dir_path.join template_pack_name + '_technical_documentation.pdf'
-      end
-
-      def latex_log_file_destination
-        path_name.join template_pack_name + 'documentation_latex_failure.log'
-      end
-    end
-  end
-end

data/lib/indoctrinatr/tools/template_pack_packer.rb

@@ -1,49 +0,0 @@
-require 'indoctrinatr/tools/template_pack_helpers'
-require 'zip'
-
-module Indoctrinatr
-  module Tools
-    class TemplatePackPacker
-      include TemplatePackHelpers
-
-      attr_accessor :template_pack_name
-
-      def initialize template_pack_name
-        @template_pack_name = template_pack_name
-      end
-
-      def call
-        check_for_folder
-        remove_existing_zip
-        zip_template_folder
-        show_success
-      end
-
-      private
-
-      def remove_existing_zip
-        FileUtils.rm destination_zip_file, force: true
-      end
-
-      def zip_template_folder
-        Zip::File.open(destination_zip_file, Zip::File::CREATE) do |zipfile|
-          Dir[File.join(path_name, '**', '**')].each do |file|
-            zipfile.add(internal_file_name(file), file)
-          end
-        end
-      end
-
-      def show_success
-        puts "The template pack '#{template_pack_name}.zip' was created successfully."
-      end
-
-      def destination_zip_file
-        Pathname.new(Dir.pwd).join "#{template_pack_name}.zip"
-      end
-
-      def internal_file_name file_name
-        template_pack_name + '/' + file_name.sub(path_name.to_s, '')[1..-1] # remove leading /
-      end
-    end
-  end
-end

data/lib/indoctrinatr/tools/template_pack_scaffold.rb

@@ -1,57 +0,0 @@
-require 'indoctrinatr/tools/template_pack_helpers'
-require 'fileutils'
-
-module Indoctrinatr
-  module Tools
-    class TemplatePackScaffold
-      include TemplatePackHelpers
-
-      attr_accessor :template_pack_name
-
-      def initialize template_pack_name
-        @template_pack_name = template_pack_name
-      end
-
-      def call
-        create_folder
-        create_asset_folder
-        copy_configuration_file
-        copy_tex_file
-        show_success
-      end
-
-      private
-
-      def create_folder
-        fail 'Please specify a template pack name.' if template_pack_name.nil? || 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
-
-      def create_asset_folder
-        Dir.mkdir path_name.join('assets')
-      end
-
-      def copy_configuration_file
-        FileUtils.copy_file source_config_file_path, config_file_path
-      end
-
-      def copy_tex_file
-        FileUtils.copy_file source_tex_file_path, tex_file_path
-      end
-
-      def show_success
-        puts "A template pack scaffold was created in folder '#{template_pack_name}'. Happy templating…"
-      end
-
-      def source_config_file_path
-        Pathname.new(File.expand_path(__dir__)).join('..', 'templates', 'configuration.yaml')
-      end
-
-      def source_tex_file_path
-        Pathname.new(File.expand_path(__dir__)).join('..', 'templates', 'template.tex.erb')
-      end
-    end
-  end
-end

data/lib/indoctrinatr/tools.rb

@@ -1,9 +0,0 @@
-require 'indoctrinatr/tools/version'
-require 'redcloth_latex_formatter_patch/patch'
-
-begin
-  require 'pry'
-rescue LoadError => e
-  puts e.message
-  # I think we can live without pry
-end

data/spec/fixtures/test/configuration.yaml

@@ -1,26 +0,0 @@
-template_name: Hello World Template
-output_file_name: '#{Time.now.year}_hello_world.pdf'
-textual_description: |
-  This is your first _Indoctrinatr_ template. You can use _Textile_ syntax here to *highlight* important information.
-
-    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."

data/spec/fixtures/test/test.tex.erb

@@ -1,15 +0,0 @@
-% This is the official Indoctrinatr "Hello World Template".
-\documentclass{article}
-
-\begin{document}
-	\section{Hello <%= variable1 -%>}
-	 
-	The <%= variable1 -%> is <%= variable2 -%>!
- 
-	Today is \textbf{<%= date -%>}.
-	
-	% This is is the raw, unescaped input of \texttt{variable1}:
-	\begin{verbatim}
-		<%= raw_variable1 -%>
-	\end{verbatim}
-\end{document}

data/spec/indoctrinatr/templates/configuration_file_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-require 'pathname'
-
-context 'with configuration.yaml' do
-  it 'exists' do
-    configuration_file = Pathname.new(__FILE__).join '..', '..', '..', '..', 'lib', 'indoctrinatr', 'templates', 'configuration.yaml'
-    expect(File.exist?(configuration_file)).to eq true
-  end
-end

data/spec/indoctrinatr/templates/tex_file_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-require 'pathname'
-
-context 'with template.tex.erb' do
-  it 'exists' do
-    template_file = Pathname.new(__FILE__).join '..', '..', '..', '..', 'lib', 'indoctrinatr', 'templates', 'template.tex.erb'
-    expect(File.exist?(template_file)).to eq true
-  end
-end

data/spec/indoctrinatr/tools/textile_support_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require 'indoctrinatr/tools/default_values'
-require 'indoctrinatr/tools/template_pack_configuration'
-
-context "when supporting Textile with 'textilize' function" do
-  let(:configuration) do
-    c = Indoctrinatr::Tools::TemplatePackConfiguration.new
-    c.attributes_as_hashes_in_array = []
-    c.template_asset_path = ''
-    c.output_file_name = ''
-    c
-  end
-  let(:default_values) { Indoctrinatr::Tools::DefaultValues.new configuration }
-
-  it 'parses to LaTeX' do
-    expect(default_values.textile2latex('*strong*')).to eq "\\textbf{strong}\n\n"
-  end
-end

data/spec/indoctrinatr/tools/version_spec.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-require 'indoctrinatr/tools/version'
-
-describe Indoctrinatr::Tools do
-  it 'defines a VERSION constant' do
-    expect(Indoctrinatr::Tools::VERSION).to eq '0.16.0'
-  end
-end

data/spec/redcloth_latex_formatter_patch/patch_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-require 'redcloth_latex_formatter_patch/patch'
-
-context 'with patches for RedCloth::LATEX::Formatter' do
-  it 'tranforms a h1. headline to LaTeX chapter notation' do
-    text = 'h1. Headline'
-    expect(RedCloth.new(text).to_latex).to eq "\\chapter{Headline}\n\n"
-  end
-
-  it 'tranforms a h2. headline to LaTeX section notation' do
-    text = 'h2. Headline'
-    expect(RedCloth.new(text).to_latex).to eq "\\section{Headline}\n\n"
-  end
-
-  it 'tranforms a h3. headline to LaTeX subsection notation' do
-    text = 'h3. Headline'
-    expect(RedCloth.new(text).to_latex).to eq "\\subsection{Headline}\n\n"
-  end
-
-  it 'tranforms a h4. headline to LaTeX subsubsection notation' do
-    text = 'h4. Headline'
-    expect(RedCloth.new(text).to_latex).to eq "\\subsubsection{Headline}\n\n"
-  end
-
-  it 'transforms a table to LaTeX tabu notation' do
-    input = "|_.Headerspalte 1|_.Headerspalte 2|\n|Feld 1,1        |Feld 2,1        |\n|Feld 1,2        |Feld 2,2        |"
-    expected_result = "\\begin{tabu}{ l l }\n    Headerspalte 1 & Headerspalte 2 \\\\\n    \\tabletoprule\n    Feld 1,1         & Feld 2,1         \\\\\n    Feld 1,2         & Feld 2,2         \\\\\n    \\tablebottomrule\n\\end{tabu}\n"
-    expect(RedCloth.new(input).to_latex).to eq expected_result
-  end
-
-  it 'transforms -text- to to LaTeX \st{}' do
-    expect(RedCloth.new('-no no no-').to_latex).to eq "\\st{no no no}\n\n"
-  end
-end

data/spec/spec_helper.rb

@@ -1,2 +0,0 @@
-require 'coveralls'
-Coveralls.wear!

data.tar.gz.sig

@@ -1,3 +0,0 @@
-�g/��b��d�-U�R�(���9�|�~_�sݷҶ�%�u�n�5��"		7
-w&���v�v�~���.?�EͰ�Ҍ�-�`���β�$+�Y���St��zJ��V�ԈbU)���\\3Lr���@���N�K����2�=� �e�@ �Wp
8,�=�Weq���m��vC`��l��Q�Fp���Y�5�'��g�t�-�
E�?��g�
-��g����}�<.�[eMt�[�2��}XgsAlb����V

metadata.gz.sig

@@ -1,2 +0,0 @@
-�!�����/w���3]W����.�ި,�J�p�/��F �U	Xd6��b搡��
-�y(qx/��͓�I�fS4