indoctrinatr-tools 0.10.0

data/lib/indoctrinatr/tools/template_pack_helpers.rb

@@ -0,0 +1,38 @@
+module Indoctrinatr
+  module Tools
+    module TemplatePackHelpers # classes that use this model are required to have template_pack_name as instance variable
+      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?
+        fail "A folder with name '#{template_pack_name}' does not exist." unless Dir.exist? path_name
+      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
+        path_name.join template_pack_name + '_with_default_values.tex'
+      end
+
+      def pack_technical_documentation_file_path
+        path_name.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

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

@@ -0,0 +1,57 @@
+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.empty?
+        fail "A folder with name '#{template_pack_name}' already exists." if Dir.exist? path_name
+
+        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(File.dirname(__FILE__))).join('..', 'templates', 'configuration.yaml')
+      end
+
+      def source_tex_file_path
+        Pathname.new(File.expand_path(File.dirname(__FILE__))).join('..', 'templates', 'template.tex.erb')
+      end
+    end
+  end
+end

data/lib/indoctrinatr/tools/version.rb

@@ -0,0 +1,5 @@
+module Indoctrinatr
+  module Tools
+    VERSION = '0.10.0'
+  end
+end

data/lib/redcloth_latex_formatter_patch/patch.rb

@@ -0,0 +1,35 @@
+require 'redcloth'
+
+module RedCloth
+  module Formatters
+    module LATEX
+      { h1: 'chapter',
+        h2: 'section',
+        h3: 'subsection',
+        h4: 'subsubsection'
+      }.each do |m, tag|
+        define_method(m) do |opts|
+          case opts[:align]
+          when 'left' then
+            "\\begin{flushleft}\\#{tag}{#{opts[:text]}}\\end{flushleft}\n\n"
+          when 'right' then
+            "\\begin{flushright}\\#{tag}{#{opts[:text]}}\\end{flushright}\n\n"
+          when 'center' then
+            "\\begin{center}\\#{tag}{#{opts[:text]}}\\end{center}\n\n"
+          else
+            "\\#{tag}{#{opts[:text]}}\n\n"
+          end
+        end
+      end
+
+      def table_close _opts
+        output = "\\begin{tabu}{ #{'l ' * @table[0].size}}\n"
+        @table.each do |row|
+          output << "    #{row.join(' & ')} \\\\\n"
+        end
+        output << "\\end{tabu}\n"
+        output
+      end
+    end
+  end
+end

data/spec/indoctrinatr/templates/configuration_file_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'pathname'
+
+describe 'configuration.yaml' do
+  it 'should exist' 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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'pathname'
+
+describe 'template.tex.erb' do
+  it 'should exist' 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

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'indoctrinatr/tools/default_values'
+require 'indoctrinatr/tools/template_pack_configuration'
+
+describe "support for 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

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

data/spec/redcloth_latex_formatter_patch/patch_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'redcloth_latex_formatter_patch/patch'
+
+describe '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    Feld 1,1         & Feld 2,1         \\\\\n    Feld 1,2         & Feld 2,2         \\\\\n\\end{tabu}\n"
+    expect(RedCloth.new(input).to_latex).to eq expected_result
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,304 @@
+--- !ruby/object:Gem::Specification
+name: indoctrinatr-tools
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Nicolai Reuschling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: to_latex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 
+email:
+- nicolai.reuschling@dkd.de
+executables:
+- indoctrinatr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".arcconfig"
+- ".coveralls.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- assets/images/dkd_logo.png
+- assets/images/logo.png
+- bin/indoctrinatr
+- cucumber.yml
+- features/autocompletion_support.feature
+- features/demo.feature
+- features/documentation.feature
+- features/pack.feature
+- features/parse.feature
+- features/pdf.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
+- indoctrinatr-tools.gemspec
+- lib/indoctrinatr/templates/configuration.yaml
+- lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation-content.tex.erb
+- lib/indoctrinatr/templates/documentation/indoctrinatr-technical-documentation.sty
+- 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/configuration_extractor.rb
+- lib/indoctrinatr/tools/default_values.rb
+- lib/indoctrinatr/tools/directory_helpers.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_helpers.rb
+- lib/indoctrinatr/tools/template_pack_packer.rb
+- lib/indoctrinatr/tools/template_pack_scaffold.rb
+- lib/indoctrinatr/tools/version.rb
+- lib/redcloth_latex_formatter_patch/patch.rb
+- 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: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- xelatex
+rubyforge_project: 
+rubygems_version: 2.4.8
+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/documentation.feature
+- features/pack.feature
+- features/parse.feature
+- features/pdf.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/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