indoctrinatr-tools 0.15.0 → 0.17.0

data/lib/indoctrinatr/tools/transactions/template_pack_scaffold.rb

@@ -0,0 +1,73 @@
+require 'dry/transaction'
+require 'fileutils'
+
+module Indoctrinatr
+  module Tools
+    module Transactions
+      class TemplatePackScaffold
+        include Dry::Transaction
+
+        step :setup
+        step :validate_setup
+        step :create_folder
+        step :create_asset_folder
+        step :copy_configuration_file
+        step :copy_tex_file
+
+        private
+
+        def setup(template_pack_name)
+          path_name = Pathname.new(Dir.pwd).join(template_pack_name)
+          Success(
+            {
+              template_pack_name:,
+              path_name:,
+              source_config_file_path: Pathname.new(File.expand_path(__dir__)).join('..', '..', 'templates', 'configuration.yaml'),
+              source_tex_file_path: Pathname.new(File.expand_path(__dir__)).join('..', '..', 'templates', 'template.tex.erb'),
+              assets_path: path_name.join('assets'),
+              config_file_path: path_name.join('configuration.yaml'),
+              tex_file_path: path_name.join("#{template_pack_name}.tex.erb")
+            }
+          )
+        end
+
+        def validate_setup(config)
+          return Failure('Please specify a template pack name.') if config[:template_pack_name].nil? || config[:template_pack_name].empty?
+          return Failure("A folder with name '#{config[:template_pack_name]}' already exists.") if Dir.exist? config[:path_name]
+
+          Success(config)
+        end
+
+        def create_folder(config)
+          ::FileUtils.mkdir_p config[:path_name]
+          Success(config)
+        rescue Errno::EROFS
+          Failure('Could not write to target directory!')
+        rescue StandardError => e
+          Failure(e.message)
+        end
+
+        def create_asset_folder(config)
+          ::FileUtils.mkdir_p config[:assets_path]
+          Success(config)
+        rescue StandardError => e
+          Failure(e.message)
+        end
+
+        def copy_configuration_file(config)
+          ::FileUtils.copy_file config[:source_config_file_path], config[:config_file_path]
+          Success(config)
+        rescue StandardError => e
+          Failure(e.message)
+        end
+
+        def copy_tex_file(config)
+          ::FileUtils.copy_file config[:source_tex_file_path], config[:tex_file_path]
+          Success("A template pack scaffold was created in folder '#{config[:template_pack_name]}'. Happy templating…")
+        rescue StandardError => e
+          Failure(e.message)
+        end
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/version.rb

@@ -1,5 +1,5 @@
 module Indoctrinatr
   module Tools
-    VERSION = '0.15.0'.freeze
+    VERSION = '0.17.0'.freeze
   end
 end

data/lib/indoctrinatr_tools.rb

@@ -0,0 +1,12 @@
+require 'zeitwerk'
+require 'dry/cli'
+
+Zeitwerk::Loader.for_gem(warn_on_extra_files: false).tap do |loader|
+  loader.ignore('lib/indoctrinatr/tools/version')
+  loader.ignore('lib/indoctrinatr/templates')
+  loader.setup
+end
+
+Indoctrinatr::Tools::RedclothFormattersLatexPatch.apply
+
+Dry::CLI.new(Indoctrinatr::Tools::Commands).call

metadata

@@ -1,193 +1,170 @@
 --- !ruby/object:Gem::Specification
 name: indoctrinatr-tools
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Nicolai Reuschling
-- Luka Lüdicke
-autorequire: 
-bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDjjCCAnagAwIBAgIBATANBgkqhkiG9w0BAQUFADBGMRswGQYDVQQDDBJuaWNv
-  bGFpLnJldXNjaGxpbmcxEzARBgoJkiaJk/IsZAEZFgNka2QxEjAQBgoJkiaJk/Is
-  ZAEZFgJkZTAeFw0xNjA5MTQwODI4MDFaFw0xNzA5MTQwODI4MDFaMEYxGzAZBgNV
-  BAMMEm5pY29sYWkucmV1c2NobGluZzETMBEGCgmSJomT8ixkARkWA2RrZDESMBAG
-  CgmSJomT8ixkARkWAmRlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
-  vlHNuOcO6oCtv59swqYd181lxf2sCVwajmLuXC0EiYfwMCKRlelLmmYOH61arTCJ
-  iUaoGOCE9HCt1ZxVkN/bcSIqMO4MNbRuq2o2DrBsKWSMaCvUYTJi6F+JyKlL/XFY
-  Pc9NoIyT1FJ5UnDC3M0lBsvJOdRkjxuK5pImv+lei3ZarIL/7TP511fMjTRbrzo1
-  GltFvcM1HaXk/n2DU2IevCI+PNaP6+IiAJe3iPnDElxmYQO4lAhkt2RwtyntcYyk
-  Wc2w5yvsEy/Dj/k0lL/tAb+fuPfEw6sJGmt53fjrGVSgbmx5W67ua8KGQ4WV4SSQ
-  qia8AR2ILljAHZl3USm2SQIDAQABo4GGMIGDMAkGA1UdEwQCMAAwCwYDVR0PBAQD
-  AgSwMB0GA1UdDgQWBBRsKZ1MC723dEnBg972E4nclYGV+jAkBgNVHREEHTAbgRlu
-  aWNvbGFpLnJldXNjaGxpbmdAZGtkLmRlMCQGA1UdEgQdMBuBGW5pY29sYWkucmV1
-  c2NobGluZ0Bka2QuZGUwDQYJKoZIhvcNAQEFBQADggEBAJ16ezxNfUUADQ4y3PwM
-  2+E26mJS0sUegKaL+YjD9egiEJkA5BPGhd9+FbRy9eNN4G86G161v97odCSXwGSE
-  Mnk0CbTpL7i/OdxgwE2xyxaf3pGU5Qw676Vu1rSvTUdYzu8W8OvmH5BVq3o7TPqW
-  JKgPr7MayKysuMrevACFOMzLxxcyHOxs096U/0ei93La54dqCUBA449Wt9aufwGP
-  5ioQ8Y60Ugn6PY1YT48+dvM53frMrYA8/ts51cItvU9iJAfYIeE7Zfi9XBRxZ0W6
-  HOu/JTkMVu8oWst3Fhxdqaqw1a1uFYiG5VkcX0hsPUFS+ZDJhAhi1eu5Pea1dZq4
-  CZs=
-  -----END CERTIFICATE-----
-date: 2017-04-16 00:00:00.000000000 Z
+- Eike Henrich
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: gli
+  name: dry-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: dry-transaction
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +179,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: to_latex
   requirement: !ruby/object:Gem::Requirement
@@ -217,33 +222,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: RedCloth
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
-description: 
+        version: '2.6'
+description:
 email:
 - nicolai.reuschling@dkd.de
-- luka.luedicke@dkd.de
+- eike.henrich@dkd.de
 executables:
 - indoctrinatr
 extensions: []
 extra_rdoc_files: []
 files:
-- ".arcconfig"
-- ".coveralls.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -251,26 +254,8 @@ files:
 - Rakefile
 - assets/images/dkd_logo.png
 - assets/images/logo.png
-- bin/indoctrinatr
-- certs/dkd-reuschling.pem
 - 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/pdf_with_timestamp.feature
-- features/scaffold.feature
-- features/step_definitions/common.rb
-- features/step_definitions/indoctrinatr_cli.rb
-- features/support/env.rb
-- features/version.feature
-- features/workflow.feature
+- exe/indoctrinatr
 - indoctrinatr-tools.gemspec
 - lib/indoctrinatr/templates/configuration.yaml
 - lib/indoctrinatr/templates/documentation/dkd-image-tools.sty
@@ -279,41 +264,47 @@ files:
 - lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation.tex.erb
 - lib/indoctrinatr/templates/documentation/indoctrinatr_letterpaper.pdf
 - lib/indoctrinatr/templates/template.tex.erb
-- lib/indoctrinatr/tools.rb
+- lib/indoctrinatr/tools/command_autocomplete_helpers.rb
+- lib/indoctrinatr/tools/commands.rb
+- lib/indoctrinatr/tools/commands/bash_completions.rb
+- lib/indoctrinatr/tools/commands/check.rb
+- lib/indoctrinatr/tools/commands/completion_commands.rb
+- lib/indoctrinatr/tools/commands/demo.rb
+- lib/indoctrinatr/tools/commands/doc.rb
+- lib/indoctrinatr/tools/commands/pack.rb
+- lib/indoctrinatr/tools/commands/parse.rb
+- lib/indoctrinatr/tools/commands/pdf.rb
+- lib/indoctrinatr/tools/commands/pdf_with_field_names.rb
+- lib/indoctrinatr/tools/commands/scaffold.rb
+- lib/indoctrinatr/tools/commands/version.rb
+- lib/indoctrinatr/tools/commands/workflow.rb
+- lib/indoctrinatr/tools/commands/zsh_completions.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/redcloth_formatters_latex_patch.rb
 - lib/indoctrinatr/tools/template_documentation_content.rb
 - lib/indoctrinatr/tools/template_documentation_helpers.rb
 - lib/indoctrinatr/tools/template_documentation_source_file.rb
 - lib/indoctrinatr/tools/template_pack_configuration.rb
-- lib/indoctrinatr/tools/template_pack_default_values_compiler.rb
-- 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
+- lib/indoctrinatr/tools/transactions/template_pack_default_values_compiler.rb
+- lib/indoctrinatr/tools/transactions/template_pack_default_values_parser.rb
+- lib/indoctrinatr/tools/transactions/template_pack_demo.rb
+- lib/indoctrinatr/tools/transactions/template_pack_documentation.rb
+- lib/indoctrinatr/tools/transactions/template_pack_error_checker.rb
+- lib/indoctrinatr/tools/transactions/template_pack_fieldnames_creator.rb
+- lib/indoctrinatr/tools/transactions/template_pack_packer.rb
+- lib/indoctrinatr/tools/transactions/template_pack_scaffold.rb
 - lib/indoctrinatr/tools/version.rb
-- lib/redcloth_latex_formatter_patch/patch.rb
-- spec/fixtures/test/configuration.yaml
-- spec/fixtures/test/test.tex.erb
-- spec/indoctrinatr/templates/configuration_file_spec.rb
-- spec/indoctrinatr/templates/tex_file_spec.rb
-- spec/indoctrinatr/tools/textile_support_spec.rb
-- spec/indoctrinatr/tools/version_spec.rb
-- spec/redcloth_latex_formatter_patch/patch_spec.rb
-- spec/spec_helper.rb
-homepage: ''
+- lib/indoctrinatr_tools.rb
+homepage: https://github.com/dkd/indoctrinatr
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -321,7 +312,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -329,36 +320,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - LaTeX development enviroment
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.3.26
+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).
-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/pdf_with_timestamp.feature
-- features/scaffold.feature
-- features/step_definitions/common.rb
-- features/step_definitions/indoctrinatr_cli.rb
-- features/support/env.rb
-- features/version.feature
-- features/workflow.feature
-- spec/fixtures/test/configuration.yaml
-- spec/fixtures/test/test.tex.erb
-- spec/indoctrinatr/templates/configuration_file_spec.rb
-- spec/indoctrinatr/templates/tex_file_spec.rb
-- spec/indoctrinatr/tools/textile_support_spec.rb
-- spec/indoctrinatr/tools/version_spec.rb
-- spec/redcloth_latex_formatter_patch/patch_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.arcconfig

@@ -1,9 +0,0 @@
-{
-  "phabricator.uri": "https://phabricator.dkd.de/",
-  "project.name": "indoctrinatr-tools",
-  "repository.callsign": "INDOCTRINATRTOOLS",
-  "arc.feature.start.default": "development",
-  "arc.land.onto.default": "development",
-  "history.immutable": true,
-  "base": "git:merge-base(development),arc:upstream"
-}

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.travis.yml

@@ -1,15 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - '2.4.1'
-  - '2.3.4'
-  - '2.2.7'
-cache: bundler
-
-before_install:
-  - gem install bundler --no-document
-
-script:
-  - bundle exec rubocop --version
-  - bundle exec rubocop --display-cop-names --extra-details 
-  - bundle exec indoctrinatr new demo