indoctrinatr-tools 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a20a3417d2320bbee925716116c0abe837b378e4de871a4e90784435be78a69
-  data.tar.gz: 25119cb987c05ab753652ce16beca1a19e345bfa87fe6bfd957129bd8074ab1f
+  metadata.gz: 9ecf077d9fa4e157d3cab1a0a8cdbc0cfb0e78da076c3cc99248eb2d01223ac9
+  data.tar.gz: 24d93b0dccc5b43e4775870df136ee87d59b23f4f60de001d63f14b22ba41166
 SHA512:
-  metadata.gz: fce3a5ed1d1ba3ddce352de0c068046867bf63b75e003e532c8c0f3b4ba2affaa1d1b6d1ef9a3115d522c37615f08f80d751d4e67c96f3639f7b82bc0631131b
-  data.tar.gz: 4d126f8b3d4394b869a67bb76330dc16617980ccbd163cbe79e790eeace8b5c4412997b7d87c517894813fb8a8f3619be499bbe3bb2ca3195c50a998a0ae0fa6
+  metadata.gz: d64e22fed3f46f3a444177d5ca0391cc383222364b7d85a15de12566fd9e551b20d439393fefd1a1615fbb074acb0d5ee6e15a5a309ae485ee7b3c9ef5482b65
+  data.tar.gz: f5539d4547a696df5bd03becd16cf3f672ffd4b3746c69222018bb15705543f8d9f021a333bf8ec4be6a32936f22d2e717881174e87570db9d78fb8fe40c9ffc

data/.gitignore

@@ -1,54 +1,24 @@
+*.a
+*.bundle
 *.gem
+*.iml
+*.o
 *.rbc
+*.so
 .bundle
 .config
+.idea
 .yardoc
-Gemfile.lock
-InstalledFiles
 _yardoc
 coverage
 doc/
+Gemfile.lock
+InstalledFiles
 lib/bundler/man
+mkmf.log
 pkg
 rdoc
 spec/reports
 test/tmp
 test/version_tmp
 tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-
-# Created by https://www.gitignore.io
-
-### Intellij ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
-
-*.iml
-
-## Directory-based project format:
-.idea/
-# if you remove the above rule, at least ignore the following:
-
-# User-specific stuff:
-# .idea/workspace.xml
-# .idea/tasks.xml
-# .idea/dictionaries
-
-# Sensitive or high-churn files:
-# .idea/dataSources.ids
-# .idea/dataSources.xml
-# .idea/sqlDataSources.xml
-# .idea/dynamic.xml
-# .idea/uiDesigner.xml
-
-# Gradle:
-# .idea/gradle.xml
-# .idea/libraries
-
-# Mongo Explorer plugin:
-# .idea/mongoSettings.xml
-
-# End gitignore.io generated block

data/.rubocop.yml

@@ -3,7 +3,8 @@ require:
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 3.1
   ExtraDetails: true
   DisplayStyleGuide: true
   DisplayCopNames: true
@@ -14,8 +15,6 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 Layout/LineLength:
   Max: 240
-Style/MethodDefParentheses:
-  EnforcedStyle: require_no_parentheses
 Style/Documentation:
   Enabled: false
 Metrics/MethodLength:

data/.ruby-version

@@ -0,0 +1 @@
+3.1

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # indoctrinatr-tools
 
-## v0.15.0 (2020-02-14)
+## v0.17.0 (2022-12-01)
+
+### changes
+
+* migrate to `dry-cli` and `dry-transaction`
+* move to Ruby `~> 3.0` versions (3.0, 3.1)
+* drop support for Ruby 2.x versions
+
+## v0.16.0 (2020-02-14)
 
 ### changes
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2020 Indoctrinatr Development Team, dkd Internet Service GmbH, Frankfurt am Main
+Copyright (c) 2014-2022 Indoctrinatr Development Team, dkd Internet Service GmbH, Frankfurt am Main
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -6,12 +6,12 @@
 
 ## Installation
 
-[![Gem Version](https://badge.fury.io/rb/indoctrinatr-tools.svg)](http://badge.fury.io/rb/indoctrinatr-tools) [![Coverage Status](https://coveralls.io/repos/dkd/indoctrinatr-tools/badge.svg?branch=development&service=github)](https://coveralls.io/github/dkd/indoctrinatr-tools?branch=development)  master [![Travis CI Status: master](https://travis-ci.org/dkd/indoctrinatr-tools.svg?branch=master)](https://travis-ci.org/dkd/indoctrinatr-tools) development  [![Travis CI Status: development](https://travis-ci.org/dkd/indoctrinatr-tools.svg?branch=development)](https://travis-ci.org/dkd/indoctrinatr-tools)
+[![Gem Version](https://badge.fury.io/rb/indoctrinatr-tools.svg)](http://badge.fury.io/rb/indoctrinatr-tools)
 
 
 1.  Install XeTeX:
 
-    Mac OS X: [MacTeX](https://tug.org/mactex/)
+    Mac OS X: [MacTeX](https://tug.org/mactex/) (e.g. `brew install mactex`)
 
     Debian/Ubuntu:
 
@@ -30,7 +30,7 @@
 
 * `latexmk`
 * for the template documentation
-  * Tested against TeX Live 2014
+  * Tested against TeX Live 2022
   * `dirtree`
   * `datetime2`
 
@@ -49,8 +49,6 @@ Command | Description
 `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.
 
@@ -69,7 +67,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`
+Automatic testing: run `rspec`
 
 ## License
 
@@ -80,5 +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 (development)
+* Eike Henrich (development)
 * Nicolai Reuschling (development)
 * Søren Schaffstein (idea, product management)

data/Rakefile

@@ -7,26 +7,11 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
 task default: :spec
 
-require 'cucumber'
-require 'cucumber/rake/task'
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = 'features --format pretty'
-end
-
-require 'coveralls/rake/task'
-Coveralls::RakeTask.new
-task test_with_coveralls: [:rubocop, :spec, :features, 'coveralls:push']
-
-desc 'Start up IRB session with Indoctrinatr Tools loaded'
-task :console do
-  exec 'irb -r indoctrinatr/tools -I ./lib'
-end
-
 desc 'Run demo'
 task :demo do
-  puts `bin/indoctrinatr new demo`
-  puts `bin/indoctrinatr parse demo`
-  puts `bin/indoctrinatr pdf demo`
-  puts `bin/indoctrinatr doc demo`
-  puts `bin/indoctrinatr pack demo`
+  puts `exe/indoctrinatr new demo`
+  puts `exe/indoctrinatr parse demo`
+  puts `exe/indoctrinatr pdf demo`
+  puts `exe/indoctrinatr doc demo`
+  puts `exe/indoctrinatr pack demo`
 end

data/cucumber.yml

@@ -1 +1 @@
-default: --format=progress
+default: --format=progress --publish-quiet

data/exe/indoctrinatr

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+
+require_relative '../lib/indoctrinatr_tools'

data/indoctrinatr-tools.gemspec

@@ -5,39 +5,39 @@ require 'indoctrinatr/tools/version'
 Gem::Specification.new do |spec|
   spec.name          = 'indoctrinatr-tools'
   spec.version       = Indoctrinatr::Tools::VERSION
-  spec.authors       = ['Nicolai Reuschling', 'Luka Lüdicke']
-  spec.email         = ['nicolai.reuschling@dkd.de', 'luka.luedicke@dkd.de']
+  spec.authors       = ['Nicolai Reuschling', 'Eike Henrich']
+  spec.email         = ['nicolai.reuschling@dkd.de', 'eike.henrich@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.homepage      = 'https://github.com/dkd/indoctrinatr'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '~> 2.5'
+  spec.required_ruby_version = '~> 3.1'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'aruba',     '~> 0.14'
-  spec.add_development_dependency 'bundler',   '~> 2.0'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'cucumber',  '~> 3.0'
-  spec.add_development_dependency 'pry',       '~> 0.11'
-  spec.add_development_dependency 'rake',      '~> 13.0'
-  spec.add_development_dependency 'rspec',     '~> 3.7'
-  spec.add_development_dependency 'rubocop',   '~> 0.79'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.3'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.22'
+  spec.add_development_dependency 'aruba', '~> 2.1'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'cucumber', '~> 8.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.10'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
 
-  spec.add_dependency 'erubis',   '~> 2.7'
-  spec.add_dependency 'gli',      '~> 2.16'
+  spec.add_dependency 'dry-cli', '~> 1.0'
+  spec.add_dependency 'dry-transaction', '~> 0.13'
+  spec.add_dependency 'erubis', '~> 2.7'
   spec.add_dependency 'RedCloth', '~> 4.3'
-  spec.add_dependency 'rubyzip',  '~> 2'
+  spec.add_dependency 'rubyzip', '~> 2'
   spec.add_dependency 'to_latex', '~> 0.5'
-
-  spec.cert_chain  = ['certs/dkd-reuschling.pem']
-  spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $PROGRAM_NAME.end_with?('gem')
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 
   spec.requirements << 'LaTeX development enviroment'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation-content.tex.erb

@@ -25,10 +25,10 @@
 \begin{landscape}
   \chapter{Variables}
 
-  \begin{longtabu}{ l l X l X }
-    \tabletoprule
+  \begin{longtable}{ l l l l l }
+%    \tabletoprule
     \textbf{Variable} & \textbf{Presentation} & \textbf{Default Value} & \textbf{Required} & \textbf{Description} \\
-    \tabletoprule
+%    \tabletoprule
     \endhead
     <% @attributes.each do |attribute| %>
       \texttt{<%= attribute['name'].to_latex -%>}
@@ -37,5 +37,5 @@
       & <%= 'true' if attribute['required'] == 'true' -%> <%# empty if false or not set. Wish by Søren for better readability-%>
       & <%= attribute['description'].to_latex if attribute['description'] -%>\\ <%# if condition to ignore errors on empty description field -%>
     <% end %>
-  \end{longtabu}
+  \end{longtable}
 \end{landscape}

data/lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation.sty

@@ -157,24 +157,9 @@
 \MakeOuterQuote{"}
 
 
-% package for better table creation
-\usepackage{tabu}
 % use "longtable" package to allow multi page tables
 \usepackage{longtable}
 
-
-% define horizontal lines for use in tables
-\newcommand{\tabletoprule}{\tabucline[1pt]{-}}
-\newcommand{\tablebottomrule}{\tabucline[1pt]{-}}
-\newcommand{\tablemiddlerule}{\tabucline[0.5pt]{-}}
-\newcommand{\tablesumrule}{\tabucline[0.5pt]{-}\tabucline[0.5pt]{-}}
-
-% increase spacing between table rows
-\tabulinesep=2mm
-
-% have alternating row colours in tables
-\rowcolors{1}{light-gray}{white} 
-
 % allow row spanning in tables
 \usepackage{multirow}
 

data/lib/indoctrinatr/tools/command_autocomplete_helpers.rb

@@ -0,0 +1,9 @@
+module Indoctrinatr
+  module Tools
+    class CommandAutocompleteHelpers
+      def self.handle_autocomplete(path)
+        path.gsub(%r{(.*)(/$|\\$)}, '\1')
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/bash_completions.rb

@@ -0,0 +1,21 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class BashCompletions < Dry::CLI::Command
+        desc 'Print a guide how to add indoctrinatr-tools integration to .bashrc.'
+
+        def call(**)
+          puts <<~HEREDOC
+            Add this to your .bashrc (and open up a new shell):
+
+            complete -F get_indoctrinatr_targets indoctrinatr
+            function get_indoctrinatr_targets()
+            {
+              COMPREPLY=(`indoctrinatr completions`)
+            }
+          HEREDOC
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/check.rb

@@ -0,0 +1,26 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Check < Dry::CLI::Command
+        desc 'Display the suggested workflow.'
+
+        argument :template_pack_name, desc: 'Name of template pack'
+
+        def call(template_pack_name:, **)
+          template_pack_name = CommandAutocompleteHelpers.handle_autocomplete(template_pack_name)
+
+          Indoctrinatr::Tools::Transactions::TemplatePackErrorChecker.new.call(template_pack_name) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/completion_commands.rb

@@ -0,0 +1,25 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class CompletionCommands < Dry::CLI::Command
+        def call(**)
+          puts <<~HEREDOC
+            bashcompletion
+            check
+            completions
+            demo
+            doc
+            new
+            pack
+            parse
+            pdf
+            pdf_with_field_names
+            version
+            workflow
+            zshcompletion
+          HEREDOC
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/demo.rb

@@ -0,0 +1,22 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Demo < Dry::CLI::Command
+        desc 'Create, compile and pack a demo project.'
+
+        def call(**)
+          Indoctrinatr::Tools::Transactions::TemplatePackDemo.new.call('demo') do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/doc.rb

@@ -0,0 +1,28 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Doc < Dry::CLI::Command
+        desc 'Create a documentation from a given source folder.'
+
+        argument :template_pack_name, desc: 'Name of template pack'
+        option :keep_aux_files, type: :boolean, default: false, desc: 'The option to keep aux files'
+
+        def call(template_pack_name:, **options)
+          template_pack_name = CommandAutocompleteHelpers.handle_autocomplete(template_pack_name)
+          keep_aux_files = options.fetch(:keep_aux_files)
+
+          Indoctrinatr::Tools::Transactions::TemplatePackDocumentation.new.call(template_pack_name:, keep_aux_files:) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/pack.rb

@@ -0,0 +1,26 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Pack < Dry::CLI::Command
+        desc 'Create a Template Pack from a given source folder.'
+
+        argument :template_pack_name, desc: 'Name of template pack'
+
+        def call(template_pack_name:, **)
+          template_pack_name = CommandAutocompleteHelpers.handle_autocomplete(template_pack_name)
+
+          Indoctrinatr::Tools::Transactions::TemplatePackPacker.new.call(template_pack_name) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/parse.rb

@@ -0,0 +1,26 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Parse < Dry::CLI::Command
+        desc 'Parse XeTeX file with ERB and default values of Template Pack.'
+
+        argument :template_pack_name, desc: 'Name of template pack'
+
+        def call(template_pack_name:, **)
+          template_pack_name = CommandAutocompleteHelpers.handle_autocomplete(template_pack_name)
+
+          Indoctrinatr::Tools::Transactions::TemplatePackDefaultValuesParser.new.call(template_pack_name) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/pdf.rb

@@ -0,0 +1,39 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Pdf < Dry::CLI::Command
+        desc 'Compile PDF with default values.'
+
+        argument :template_pack_name, desc: 'Name of template pack'
+        option :keep_aux_files, type: :boolean, default: false, desc: 'The option to keep aux files'
+
+        def call(template_pack_name:, **options)
+          template_pack_name = CommandAutocompleteHelpers.handle_autocomplete(template_pack_name)
+          keep_aux_files = options.fetch(:keep_aux_files)
+
+          Indoctrinatr::Tools::Transactions::TemplatePackDefaultValuesParser.new.call(template_pack_name) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+
+          Indoctrinatr::Tools::Transactions::TemplatePackDefaultValuesCompiler.new.call(template_pack_name:, keep_aux_files:) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/pdf_with_field_names.rb

@@ -0,0 +1,28 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class PdfWithFieldNames < Dry::CLI::Command
+        desc 'Compile PDF with Variable Names as values.'
+
+        argument :template_pack_name, desc: 'Name of template pack'
+        option :keep_aux_files, type: :boolean, default: false, desc: 'The option to keep aux files'
+
+        def call(template_pack_name:, **options)
+          template_pack_name = CommandAutocompleteHelpers.handle_autocomplete(template_pack_name)
+          keep_aux_files = options.fetch(:keep_aux_files)
+
+          Indoctrinatr::Tools::Transactions::TemplatePackFieldnamesCreator.new.call(template_pack_name:, keep_aux_files:) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/scaffold.rb

@@ -0,0 +1,26 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Scaffold < Dry::CLI::Command
+        desc 'Scaffold new project.'
+
+        argument :template_pack_name, desc: 'Name of template pack'
+
+        def call(template_pack_name: '', **)
+          template_pack_name = CommandAutocompleteHelpers.handle_autocomplete(template_pack_name)
+
+          Indoctrinatr::Tools::Transactions::TemplatePackScaffold.new.call(template_pack_name) do |result|
+            result.success do |message|
+              puts message
+            end
+
+            result.failure do |message|
+              puts message
+              exit 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/commands/version.rb

@@ -0,0 +1,13 @@
+module Indoctrinatr
+  module Tools
+    module Commands
+      class Version < Dry::CLI::Command
+        desc 'Print installed version of indoctrinatr-tools.'
+
+        def call(*)
+          puts Indoctrinatr::Tools::VERSION
+        end
+      end
+    end
+  end
+end