indoctrinatr-tools 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cfcf2736b68b9902cc18507c94b29a88f934cd4
+  data.tar.gz: 4fa1c18ad931c87f30ce99b1dd0ac4ae86c91fe9
+SHA512:
+  metadata.gz: a18f5e2bbb59133915532cf9651428b6eec4b3981d5f700f1696a3556bc56dce37ff7b38cbb07d7901ac13f7d016f15874da287248262100f2eabccb17358397
+  data.tar.gz: fc606fac8c306de16693b5c8d1d60b50f45a042e1ae6e510eab49a45dfc2e2d9b651a3f178b73393739b5da749cb6f5e6460d42fa689d3a36560cf1bdd989a18

data/.arcconfig

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

data/.coveralls.yml

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

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+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

@@ -0,0 +1,10 @@
+Metrics/LineLength:
+  Max: 200
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 20
+Style/TrivialAccessors:
+  Enabled: false

data/.rvmrc

@@ -0,0 +1,5 @@
+rvm use 2.1
+
+alias brake='bundle exec'
+alias rubocop='bundle exec rubocop'
+alias cucumber='brake cucumber'

data/.travis.yml

@@ -0,0 +1,19 @@
+sudo: true
+language: ruby
+rvm:
+  - '2.2'
+  - '2.1'
+  - '2.0'
+cache:
+  - bundler
+  - apt
+before_install:
+  - sudo apt-get install -qq texlive texlive-xetex texlive-latex-extra texlive-generic-extra
+  - gem install bundler -v 1.10.6
+script:
+  - bundle exec cucumber --backtrace --verbose
+  - bundle exec rake test_with_coveralls 
+addons:
+  apt:
+    packages:
+      - texlive-full

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in indoctrinatr-tools.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Indoctrinatr Development Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# ![Indoctrinatr](assets/images/logo.png)
+
+## About
+
+[Indoctrinatr Tools](https://github.com/dkd/indoctrinatr-tools) is a set of commandline tools to kick-start and develop [Indoctrinatr](https://github.com/dkd/indoctrinatr) Template Packs. Indoctrinatr in itself is an Open Source Software project by [dkd Internet Service GmbH](https://dkd.de/), Frankfurt (Germany), which renders [eRuby](https://en.wikipedia.org/wiki/ERuby) (more specifically: [Erubis](http://www.kuwata-lab.com/erubis/)) enriched [XeTeX](http://tug.org/xetex/) templates to PDF documents.
+
+## Installation
+
+Rubygem: [![Gem Version](https://badge.fury.io/rb/indoctrinatr-tools.svg)](http://badge.fury.io/rb/indoctrinatr-tools) Branch: master [![Travis CI Status: master](https://travis-ci.org/dkd/indoctrinatr-tools.svg?branch=master)](https://travis-ci.org/dkd/indoctrinatr-tools) Branch: development  [![Travis CI Status: development](https://travis-ci.org/dkd/indoctrinatr-tools.svg?branch=development)](https://travis-ci.org/dkd/indoctrinatr-tools) Coverage: [![Coverage Status](https://coveralls.io/repos/dkd/indoctrinatr-tools/badge.svg?branch=development&service=github)](https://coveralls.io/github/dkd/indoctrinatr-tools?branch=development)
+
+1.  Install XeTeX:
+
+    Mac OS X: [MacTeX](https://tug.org/mactex/)
+ 
+    Debian/Ubuntu:
+    
+    ```shell
+    apt-get install texlive texlive-xetex texlive-latex-extra texlive-generic-extra
+    ```
+
+2. We distribute Indoctrinatr Tools as a Rubygem. Please run:
+
+    ```shell
+    gem install indoctrinatr-tools
+    ```
+   After installation verify if you have a working `indoctrinatr` shell command.
+
+### LaTeX Requirements
+
+* for the template documentation
+  * `dirtree`
+  * `datetime2`
+
+## Usage
+
+Replace `project_name` with the name of your Template Pack:
+
+Command | Description
+---|---
+`indoctrinatr new project_name` | Creates a scaffold for a new Template Pack
+`indoctrinatr parse project_name` | Parses a XeTex file with ERB and default values
+`indoctrinatr pdf project_name` | Compiles PDF with default values
+`indoctrinatr doc project_name` | Creates a technical documentation of your template pack
+`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
+
+## Build
+
+If you want to build the Rubygem yourself, run `rake build` to build and `rake install` to build and install the Indoctrinatr Tools gem.
+
+## Feedback
+
+What you think of Indoctrinatr and Indoctrinatr Tools? Drop us a line (<opensource@dkd.de>) and tell us how you use Indoctrinatr. You can also open a [GitHub Issue](https://github.com/dkd/indoctrinatr-tools/issues) if you experience any problems.
+
+## Contributing
+
+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.
+
+## License
+
+Indoctrinatr and Indoctrinatr Tools are licensed under the terms and conditions of the [MIT License](http://en.wikipedia.org/wiki/MIT_License).
+
+## Credits
+
+[![dkd](assets/images/dkd_logo.png)](https://dkd.de/)
+
+* Luka Lüdicke
+* Nicolai Reuschling (development)
+* Søren Schaffstein (idea, product management)

data/Rakefile

@@ -0,0 +1,32 @@
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+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`
+end

data/bin/indoctrinatr

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'indoctrinatr/tools/version'
+require 'indoctrinatr/tools/template_pack_demo'
+require 'indoctrinatr/tools/template_pack_scaffold'
+require 'indoctrinatr/tools/template_pack_packer'
+require 'indoctrinatr/tools/template_pack_default_values_parser'
+require 'indoctrinatr/tools/template_pack_default_values_compiler'
+require 'indoctrinatr/tools/template_pack_documentation'
+
+include GLI::App
+include Indoctrinatr::Tools
+
+program_desc 'Create and manage Template Packs for Indoctrinatr'
+version Indoctrinatr::Tools::VERSION
+config_file '.indoctrinatr.rc'
+
+desc 'Display current version'
+command :version do |c|
+  c.action do
+    puts Indoctrinatr::Tools::VERSION
+  end
+end
+
+desc 'Display the suggested workflow'
+command :workflow do |c|
+  c.action do
+    puts 'The workflow for a project (e.g. demo) typically looks like this:
+
+1. Run in shell: indoctrinatr new demo
+   Creates a new Indoctrinatr Template Pack in the folder demo
+
+2. Edit demo.tex.erb and configuration.yaml according to needs
+
+3. Run in shell: indoctrinatr parse demo
+   Parses tex file demo_with_default_values.tex with ERB and default values from configuration.yaml
+
+4. Run in shell: indoctrinatr pdf demo
+   Compiles PDF from demo_with_default_values.tex
+
+5. Run in shell: indoctrinatr pack demo
+   Creates demo.zip with all required file for upload to Indoctrinatr server
+
+'
+  end
+end
+
+desc 'Create, compile and pack a demo project'
+command :demo do |c|
+  c.action do
+    Indoctrinatr::Tools::TemplatePackDemo.new('demo').call
+  end
+end
+
+desc 'Create a scaffold for a new Template Pack'
+arg_name 'template-pack-name'
+command :new do |c|
+  c.action do |_, _, args|
+    template_pack_name = args.join '_'
+    Indoctrinatr::Tools::TemplatePackScaffold.new(template_pack_name).call
+  end
+end
+
+desc 'Parse XeTeX file with ERB and default values of Template Pack'
+arg_name 'template_pack_name'
+command :parse do |c|
+  c.action do |_, _, args|
+    template_pack_name = args.join '_'
+    Indoctrinatr::Tools::TemplatePackDefaultValuesParser.new(template_pack_name).call
+  end
+end
+
+desc 'Compile PDF with default values'
+arg_name 'template_pack_name'
+command :pdf do |c|
+  c.action do |_, _, args|
+    template_pack_name = args.join '_'
+    TemplatePackDefaultValuesParser.new(template_pack_name).call
+    Indoctrinatr::Tools::TemplatePackDefaultValuesCompiler.new(template_pack_name).call
+  end
+end
+
+desc 'Create a documentation from a given source folder'
+arg_name 'template_pack_name'
+command :doc do |c|
+  c.action do |_, _, args|
+    template_pack_name = args.join '_'
+    TemplatePackDefaultValuesParser.new(template_pack_name).call # hierarchy - these files are needed. Unfortunately GLI::App does not offer to run other commands
+    TemplatePackDefaultValuesCompiler.new(template_pack_name).call
+    Indoctrinatr::Tools::TemplatePackDocumentation.new(template_pack_name).call
+  end
+end
+
+desc 'Create a Template Pack from a given source folder'
+arg_name 'template_pack_name'
+command :pack do |c|
+  c.action do |_, _, args|
+    template_pack_name = args.join '_'
+    Indoctrinatr::Tools::TemplatePackPacker.new(template_pack_name).call
+  end
+end
+
+desc 'Display instructions for bash completion'
+command :bashcompletion do |c|
+  c.action do
+    puts 'Add this to your .bashrc (and open up a new shell):
+
+complete -F get_indoctrinatr_targets indoctrinatr
+function get_indoctrinatr_targets()
+{
+    if [ -z $2 ] ; then
+        COMPREPLY=(`indoctrinatr help -c`)
+    else
+        COMPREPLY=(`indoctrinatr help -c $2`)
+    fi
+}
+
+'
+  end
+end
+
+# thanks to http://devopsbox.es/posts/2013/10-31-the-cleanest-gli-bash-zsh-tab-completion.html
+desc 'Display instructions for zsh completion'
+command :zshcompletion do |c|
+  c.action do
+    puts 'Add this to your .zshrc (and open up a new shell):
+
+if [[ -n ${ZSH_VERSION-} ]]; then
+  autoload -U +X bashcompinit && bashcompinit
+fi
+
+complete -F get_indoctrinatr_commands indoctrinatr
+function get_indoctrinatr_commands()
+{
+  local binary="indoctrinatr"
+  help_params=${COMP_WORDS[@]:1}
+  clean_params=${help_params//-*([^ ])?( )}
+  COMPREPLY=(`$binary help -c $clean_params`)
+}
+
+'
+  end
+end
+
+exit run(ARGV)

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format=progress

data/features/autocompletion_support.feature

@@ -0,0 +1,9 @@
+Feature: Checking autocompletion
+  Scenario: Running the 'bashcompletion' command
+    When I successfully run `indoctrinatr bashcompletion`
+    Then the output should contain "get_indoctrinatr_targets()"
+
+  Scenario: Running the 'zshcompletion' command
+    When I successfully run `indoctrinatr zshcompletion`
+    Then the output should contain "autoload -U +X bashcompinit && bashcompinit"
+     And the output should contain "get_indoctrinatr_commands()"

data/features/demo.feature

@@ -0,0 +1,17 @@
+Feature: Running the "demo" command
+
+  Background:
+    Given the default aruba exit timeout is 20 seconds
+
+  Scenario:
+     When I successfully run `indoctrinatr demo`
+     Then a file named "demo_with_default_values.pdf" should exist
+      And a directory named "demo" should exist
+      And a directory named "demo/assets" should exist
+      And the following files should exist:
+        | demo/configuration.yaml               |
+        | demo/demo.tex.erb                     |
+        | demo/demo_with_default_values.tex     |
+        | demo/demo_technical_documentation.pdf |
+        | demo_with_default_values.pdf          |
+        | demo.zip                              |

data/features/documentation.feature

@@ -0,0 +1,11 @@
+Feature: Running the 'doc' command
+
+  Background:
+    Given the default aruba exit timeout is 20 seconds
+
+  Scenario: creating documentation for given project
+    Given I do not have a 'demo' project
+    When I successfully run `indoctrinatr new demo`
+    And I successfully run `indoctrinatr doc demo`
+    Then the output should match /A documentation for 'demo' has been successfully generated/
+    Then a file named "demo/demo_technical_documentation.pdf" should exist