indoctrinatr-tools 0.10.0

data/lib/indoctrinatr/templates/template.tex.erb

@@ -0,0 +1,8 @@
+% This is the official Indoctrinatr "Hello World Template".
+\documentclass{article}
+
+\begin{document}
+		 \section{Hello <%= variable1 -%>}
+		 
+		 The <%= variable1 -%> is <%= variable2 -%>!
+\end{document}

data/lib/indoctrinatr/tools.rb

@@ -0,0 +1,9 @@
+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/lib/indoctrinatr/tools/configuration_extractor.rb

@@ -0,0 +1,27 @@
+require 'indoctrinatr/tools/template_pack_configuration'
+
+module Indoctrinatr
+  module Tools
+    class ConfigurationExtractor
+      include TemplatePackHelpers
+
+      attr_reader :template_pack_name
+
+      def initialize template_pack_name
+        @template_pack_name = template_pack_name
+      end
+
+      def call # rubocop:disable Metrics/AbcSize
+        config_file = YAML.load_file config_file_path
+        configuration = TemplatePackConfiguration.new
+        configuration.template_asset_path = assets_path.to_s
+        configuration.default_file_name = "#{template_pack_name}_with_default_values.pdf"
+        configuration.output_file_name = config_file.fetch('output_file_name', "#{template_pack_name}_with_default_values.pdf")
+        configuration.template_name = config_file.fetch 'template_name'
+        configuration.textual_description = config_file.fetch 'textual_description'
+        configuration.attributes_as_hashes_in_array = config_file.fetch 'fields', []
+        configuration
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/default_values.rb

@@ -0,0 +1,54 @@
+require 'redcloth'
+
+module Indoctrinatr
+  module Tools
+    class DefaultValues
+      def initialize configuration
+        @_configuration = configuration
+        _build_from_configuration
+      end
+
+      def textile2latex textile
+        RedCloth.new(textile).to_latex
+      end
+
+      def retrieve_binding
+        binding
+      end
+
+      def customized_output_file_name
+        @_customized_output_file_name ||= eval('"' + @_output_file_name + '"') # rubocop:disable Lint/Eval
+      end
+
+      def template_asset_path
+        @_template_asset_path
+      end
+
+      def output_file_name
+        @_output_file_name
+      end
+
+      def default_file_name
+        @_default_file_name
+      end
+
+      def _build_from_configuration # rubocop:disable Metrics/AbcSize
+        @_template_asset_path = @_configuration.template_asset_path
+        @_output_file_name = @_configuration.output_file_name
+        @_default_file_name = @_configuration.default_file_name
+
+        @_configuration.attributes_as_hashes_in_array.each do |attribute_hash|
+          instance_variable_set("@_#{attribute_hash['name']}", attribute_hash['default_value'])
+
+          define_singleton_method "raw_#{attribute_hash['name']}".to_sym do
+            instance_variable_get("@_#{attribute_hash['name']}")
+          end
+
+          define_singleton_method attribute_hash['name'].to_sym do
+            instance_variable_get("@_#{attribute_hash['name']}").to_latex
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/directory_helpers.rb

@@ -0,0 +1,18 @@
+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
+
+      def list_files_of_type directory = '.', types = %w(erb rb yaml sty tex) # default file types for template docs
+        # 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_documentation_content.rb

@@ -0,0 +1,52 @@
+require 'indoctrinatr/tools/template_pack_configuration'
+require 'indoctrinatr/tools/directory_helpers'
+require 'indoctrinatr/tools/template_documentation_source_file'
+require 'indoctrinatr/tools/default_values'
+
+module Indoctrinatr
+  module Tools
+    class TemplateDocumentationContent
+      include DirectoryHelpers
+      include TemplatePackHelpers
+
+      attr_accessor :template_pack_name, :list_of_files
+
+      def initialize template_pack_name, configuration
+        @configuration = configuration
+        @template_pack_name = template_pack_name
+        @list_of_files = print_dirtree_style @template_pack_name
+        @attributes = configuration.attributes_as_hashes_in_array # we need: name, presentation, default_value, description
+        @template_name = configuration.template_name
+        @files = read_template_files_content
+        @default_values_pdf_path = pdf_with_default_values_file_path
+        # should have been generated automatically, error if something went wrong with it:
+        fail IOError, "template with default values does not exist in current directory. Run indoctrinatr pdf #{template_pack_name}" unless File.exist? @default_values_pdf_path
+      end
+
+      def retrieve_binding
+        binding
+      end
+
+      private
+
+      def read_template_files_content
+        filenames = list_files_of_type template_pack_name
+        filenames.inject [] do |files, filename|
+          files.push TemplateDocumentationSourceFile.new filename
+        end
+      end
+
+      def pdf_with_default_values_file_path
+        # TODO: this would make more sense in one of the Helpers modules, but we don't want to create a new dependency there. Move this when file path shenanigans are generally revised.
+        # get file path for template with default values:
+        default_values = DefaultValues.new @configuration
+        # if there is a change in where the pdf command (compiler class) 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 default_values.customized_output_file_name
+        else
+          Pathname.new(Dir.pwd).join default_values.output_file_name
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/template_documentation_helpers.rb

@@ -0,0 +1,59 @@
+require 'tmpdir'
+
+module Indoctrinatr
+  module Tools
+    module TemplateDocumentationHelpers
+      attr_accessor :documentation_compile_dir_path_name
+
+      def make_documentation_compile_dir_path_name
+        @documentation_compile_dir_path_name = Pathname.new Dir.mktmpdir 'indoctrinatr_tools_tmp'
+      end
+
+      def content_tex_file_path
+        documentation_files_path.join 'indoctrinatr-technical-documentation-content.tex.erb'
+      end
+
+      def source_latex_package_file_path
+        documentation_files_path.join 'indoctrinatr-technical-documentation.sty'
+      end
+
+      def source_letterpaper_file_path
+        documentation_files_path.join 'indoctrinatr_letterpaper.pdf'
+      end
+
+      def source_main_tex_file_path
+        documentation_files_path.join 'indoctrinatr-technical-documentation.tex.erb'
+      end
+
+      def latex_package_destination_path
+        documentation_compile_dir_path_name.join 'indoctrinatr-technical-documentation.sty'
+      end
+
+      def letterpaper_file_destination_path
+        documentation_compile_dir_path_name.join 'indoctrinatr_letterpaper.pdf'
+      end
+
+      def content_tex_file_destination_path
+        documentation_compile_dir_path_name.join 'indoctrinatr-technical-documentation-content.tex'
+      end
+
+      def main_tex_file_destination_path
+        documentation_compile_dir_path_name.join 'indoctrinatr-technical-documentation.tex'
+      end
+
+      def documentation_file_path
+        documentation_compile_dir_path_name.join 'indoctrinatr-technical-documentation.pdf'
+      end
+
+      def latex_log_file
+        documentation_compile_dir_path_name.join 'indoctrinatr-technical-documentation.log'
+      end
+
+      private
+
+      def documentation_files_path
+        Pathname.new(File.expand_path(File.dirname(__FILE__))).join('..', 'templates', 'documentation')
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/template_documentation_source_file.rb

@@ -0,0 +1,31 @@
+module Indoctrinatr
+  module Tools
+    class TemplateDocumentationSourceFile
+      attr_reader :name, :content, :language
+
+      def initialize filename
+        @name = filename
+        @content = File.read filename
+        @language = set_programming_language
+      end
+
+      private
+
+      def set_programming_language
+        case File.extname(@name)
+        when '.tex'
+          language = 'TeX'
+        when '.sty'
+          language = 'TeX'
+        when '.erb' # .erb files are just supposed to be tex.erb files. TODO: more correct
+          language = 'TeX'
+        when '.rb'
+          language = 'Ruby'
+        else # probably YAML
+          language = 'unspecified'
+        end
+        language
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/template_pack_configuration.rb

@@ -0,0 +1,7 @@
+module Indoctrinatr
+  module Tools
+    class TemplatePackConfiguration
+      attr_accessor :template_asset_path, :default_file_name, :template_name, :textual_description, :output_file_name, :attributes_as_hashes_in_array
+    end
+  end
+end

data/lib/indoctrinatr/tools/template_pack_default_values_compiler.rb

@@ -0,0 +1,38 @@
+require 'indoctrinatr/tools/configuration_extractor'
+require 'fileutils'
+
+module Indoctrinatr
+  module Tools
+    class TemplatePackDefaultValuesCompiler
+      include TemplatePackHelpers
+
+      attr_accessor :template_pack_name
+
+      def initialize template_pack_name
+        @template_pack_name = template_pack_name
+      end
+
+      def call
+        check_for_folder
+        compile_tex_file
+        rename_if_necessary
+      end
+
+      private
+
+      def compile_tex_file
+        args = ['-shell-escape', '-interaction', 'batchmode', tex_with_default_values_file_path.to_s]
+        2.times { system('xelatex', *args) } # run two times for proper table-of-contents and page count handling. TODO: use latexmk
+      end
+
+      def rename_if_necessary
+        configuration = ConfigurationExtractor.new(template_pack_name).call
+        @default_values = DefaultValues.new configuration
+        return if @default_values.customized_output_file_name == @default_values.default_file_name
+
+        FileUtils.rm @default_values.customized_output_file_name if File.exist? @default_values.customized_output_file_name
+        FileUtils.mv(@default_values.default_file_name, @default_values.customized_output_file_name)
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/template_pack_default_values_parser.rb

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

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

data/lib/indoctrinatr/tools/template_pack_documentation.rb

@@ -0,0 +1,111 @@
+require 'indoctrinatr/tools/template_documentation_content'
+require 'indoctrinatr/tools/template_pack_helpers'
+require 'indoctrinatr/tools/template_documentation_helpers'
+require 'indoctrinatr/tools/configuration_extractor'
+require 'erubis'
+require 'to_latex'
+require 'fileutils'
+
+module Indoctrinatr
+  module Tools
+    class TemplatePackDocumentation
+      include TemplatePackHelpers
+      include TemplateDocumentationHelpers
+
+      attr_accessor :template_pack_name
+
+      def initialize template_pack_name
+        @template_pack_name = template_pack_name
+      end
+
+      def call
+        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
+          delete_temp_dir
+          show_success
+        else
+          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 => ex
+          abort ex.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)
+      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
+      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
+      end
+
+      def copy_doc_file_to_template_pack
+        FileUtils.copy_file documentation_file_path, pack_technical_documentation_file_path
+      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