indoctrinatr-tools 0.16.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.16.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,36 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: indoctrinatr-tools
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Nicolai Reuschling
-- Luka Lüdicke
-autorequire: 
-bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDVjCCAj6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAqMSgwJgYDVQQDDB9uaWNv
-  bGFpLnJldXNjaGxpbmcvREM9ZGtkL0RDPWRlMB4XDTIwMDIxNDE1MTcwNloXDTIx
-  MDIxMzE1MTcwNlowKjEoMCYGA1UEAwwfbmljb2xhaS5yZXVzY2hsaW5nL0RDPWRr
-  ZC9EQz1kZTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL5RzbjnDuqA
-  rb+fbMKmHdfNZcX9rAlcGo5i7lwtBImH8DAikZXpS5pmDh+tWq0wiYlGqBjghPRw
-  rdWcVZDf23EiKjDuDDW0bqtqNg6wbClkjGgr1GEyYuhficipS/1xWD3PTaCMk9RS
-  eVJwwtzNJQbLyTnUZI8biuaSJr/pXot2WqyC/+0z+ddXzI00W686NRpbRb3DNR2l
-  5P59g1NiHrwiPjzWj+viIgCXt4j5wxJcZmEDuJQIZLdkcLcp7XGMpFnNsOcr7BMv
-  w4/5NJS/7QG/n7j3xMOrCRpred346xlUoG5seVuu7mvChkOFleEkkKomvAEdiC5Y
-  wB2Zd1EptkkCAwEAAaOBhjCBgzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
-  HQ4EFgQUbCmdTAu9t3RJwYPe9hOJ3JWBlfowJAYDVR0RBB0wG4EZbmljb2xhaS5y
-  ZXVzY2hsaW5nQGRrZC5kZTAkBgNVHRIEHTAbgRluaWNvbGFpLnJldXNjaGxpbmdA
-  ZGtkLmRlMA0GCSqGSIb3DQEBCwUAA4IBAQBk1mExobXS3Uljuvadir5gAWkGQSRt
-  queISF2e9iQKmuXV3auAy0UWbHTBqjwu8dJtzQTX5UOtfG/Jt1QIU3X6sEBuMY76
-  Zbyu2NYp54ESAAyZFpt2prs7oDkRiDYk6FdZ7mHLTjPgr8nZV0qqONRfzmWmpImG
-  PxsXUcEiEZej8d8C5vcHy3bwXb/+CjzcKrcqN67lkXwrA9jzqMuqnjVuhx+JMXJ5
-  kHAKYJXqSQLXcRmkRlqCNGKAJSy6FmpClVbei309Yg3dl4PmFSc8GdLcWD1keOvE
-  qzeIYbdD18i9ZRk4hfm8vEpevt+xRgM+3ughiJIaiWI3eO3C+VRszvqU
-  -----END CERTIFICATE-----
-date: 2020-02-14 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: aruba
@@ -38,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -61,145 +40,145 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.21'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: dry-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: dry-transaction
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: gli
+  name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: RedCloth
   requirement: !ruby/object:Gem::Requirement
@@ -242,19 +221,32 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
-description: 
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description:
 email:
 - nicolai.reuschling@dkd.de
-- luka.luedicke@dkd.de
+- eike.henrich@dkd.de
 executables:
 - indoctrinatr
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -262,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
@@ -290,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
@@ -332,7 +312,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -340,35 +320,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - LaTeX development enviroment
-rubygems_version: 3.1.2
-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: []

checksums.yaml.gz.sig

@@ -1,3 +0,0 @@
- ��
Q�q���Hy��wt�	�ɹ`�u����G��&�P�ω�O�s�h؉r&tI�:���
-���1���r=)絛t��(
-!�|��dž��sf��N��ͽ"��(԰W��u��Է~

data/.coveralls.yml

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

data/.travis.yml

@@ -1,16 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5
-
-before_install:
-  - gem install bundler --version=2.1.4 --no-doc
-  - gem install bundler-audit --no-doc
-
-script:
-  - bundle-audit check --update
-  - bundle exec rubocop .
-  - bundle exec indoctrinatr new demo