indoctrinatr-tools 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 946f82d2025797573ceeedd251de1548a4a098b1
-  data.tar.gz: c1fb29ef98597a90ae8068c93f6aab58aac47f20
+  metadata.gz: 6f608e2b3dd38aeff4ad0e7847b9db6be4e031d1
+  data.tar.gz: 1fd96a823d47002366b4db2c232c389db18c7a61
 SHA512:
-  metadata.gz: 89779066419330bf6d47c20f06aa496bb60a08d1f7d5c53134a13fa565aaa3624468ba2f51698b61c0c1f36c4ca8c0eec3518820c1d11a472d4702dd284f32eb
-  data.tar.gz: 643cb0340284d5d995f1b2d58de983ed2d11b3fb2f82a8f8b65d6673bf2cf0761036cd9a73428c55278747aea39161b6e0307e30cd31f6b6b97bc52ac3804751
+  metadata.gz: 099f97738d115567f79c905981d254783f9010ff043f5ed2b4cd6154b6087601c7ba8dea7898e57444a584eddfea1b9cf8aaf7476318afcc70b385f3f1ad8d37
+  data.tar.gz: 2f5161a411a8a14e20f623e9fcd7516d21e429da0b0364f68537315ea6edbb5a04d802b74b9780f535c2552ad9ec6fa47520ee663a7dbab02e0ba44a85f400ae

data/.travis.yml

@@ -9,7 +9,7 @@ cache:
   - apt
 before_install:
   - sudo apt-get update && sudo wget https://github.com/scottkosty/install-tl-ubuntu/raw/master/install-tl-ubuntu && sudo chmod +x ./install-tl-ubuntu && sudo ./install-tl-ubuntu
-  - gem install bundler -v 1.12.3
+  - gem install bundler -v 1.10.6
 script:
   - bundle exec indoctrinatr demo
   - bundle exec rake test_with_coveralls

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# indoctrinatr-tools
+
+## v0.13.0 (2016-05-27)
+
+### features
+
+* support for trailing slashes in template pack name
+
+### changes
+
+* refactoring
+
+## v0.12.0 (2016-05-10)
+
+### features
+
+* added `check` command: This analyzes your template pack for major issues (#64232)
+* add `pdf_with_field_names` command (#64694). This creates an example where the field names are shown
+* add the example with fieldnames to technical documentation (#71536) - when it is successfully generated
+* add `keep-aux-files` option to pdf generation (#66118)
+* disable overwriting PDF examples for `doc` command (#71535)
+
+### changes
+
+* documentation doesn't break when description field is missing (#65001)
+* @longtabu@ for attributes list in documentation (#66081)
+* move examples after generation in `/doc` directory in template pack
+* show attributes list documentation as landscape
+* refactoring

data/bin/indoctrinatr

@@ -44,7 +44,10 @@ command :workflow do |c|
 5. Run in shell: indoctrinatr check demo
    Analyzes your Template Pack for potential errors
 
-6. Run in shell: indoctrinatr pack demo
+6. Run in shell: indoctrinatr doc demo
+   Creates a technical documentation for the Template Pack
+
+7. Run in shell: indoctrinatr pack demo
    Creates demo.zip with all required file for upload to Indoctrinatr server
 
 '
@@ -58,11 +61,17 @@ command :demo do |c|
   end
 end
 
+pre do |global_options, _, _, args|
+  # modify template_pack_name argument. This removes a trailing '/' that we get when users use tab completion
+  global_options['template_pack_name'] = File.split(args[0])[1] unless args.empty?
+  true # pre condition returns false when nothing is done
+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 '_'
+  c.action do |global_options, _, _|
+    template_pack_name = global_options['template_pack_name']
     TemplatePackScaffold.new(template_pack_name).call
   end
 end
@@ -70,8 +79,8 @@ 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 '_'
+  c.action do |global_options, _, _|
+    template_pack_name = global_options['template_pack_name']
     TemplatePackDefaultValuesParser.new(template_pack_name).call
   end
 end
@@ -81,8 +90,8 @@ arg_name 'template_pack_name'
 command :pdf do |c|
   c.desc 'Keep generated aux files'
   c.switch [:'keep-aux-files']
-  c.action do |_, options, args|
-    template_pack_name = args.join '_'
+  c.action do |global_options, options, _|
+    template_pack_name = global_options['template_pack_name']
     keep_aux_files = options[:'keep-aux-files']
     TemplatePackDefaultValuesParser.new(template_pack_name).call
     TemplatePackDefaultValuesCompiler.new(template_pack_name, keep_aux_files).call
@@ -94,8 +103,8 @@ arg_name 'template_pack_name'
 command :pdf_with_field_names do |c|
   c.desc 'Keep generated aux files'
   c.switch [:'keep-aux-files']
-  c.action do |_, options, args|
-    template_pack_name = args.join '_'
+  c.action do |global_options, options, _|
+    template_pack_name = global_options['template_pack_name']
     keep_aux_files = options[:'keep-aux-files']
     TemplatePackFieldnamesCreator.new(template_pack_name, keep_aux_files).call
   end
@@ -106,8 +115,8 @@ arg_name 'template_pack_name'
 command :doc do |c|
   c.desc 'Keep generated aux files'
   c.switch [:'keep-aux-files']
-  c.action do |_, options, args|
-    template_pack_name = args.join '_'
+  c.action do |global_options, options, _|
+    template_pack_name = global_options['template_pack_name']
     keep_aux_files = options[:'keep-aux-files']
     TemplatePackDocumentation.new(template_pack_name, keep_aux_files).call
   end
@@ -116,8 +125,8 @@ end
 desc 'Check for errors in the given source folder'
 arg_name 'template_pack_name'
 command :check do |c|
-  c.action do |_, _, args|
-    template_pack_name = args.join '_'
+  c.action do |global_options, _, _|
+    template_pack_name = global_options['template_pack_name']
     TemplatePackErrorChecker.new(template_pack_name).call
   end
 end
@@ -125,8 +134,8 @@ 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 '_'
+  c.action do |global_options, _, _|
+    template_pack_name = global_options['template_pack_name']
     TemplatePackPacker.new(template_pack_name).call
   end
 end

data/features/pdf.feature

@@ -2,10 +2,14 @@ Feature: Running the 'pdf' command
 
   Background:
     Given the default aruba exit timeout is 20 seconds
+    Given I have an Indoctrinatr project 'demo'
+    When  I successfully run `indoctrinatr parse demo`
 
   Scenario: for a given 'demo' project
-    Given I have an Indoctrinatr project 'demo'
-     When I successfully run `indoctrinatr parse demo`
       And I run `indoctrinatr pdf demo`
      Then a file named "demo/doc/examples/demo_with_default_values.pdf" should exist
-    # there is not (an easy) way to use the current timestamp. Therefore the template for the 'new' command should not be static
+
+  Scenario: for a given 'demo' project and usage with tab-completion
+      And I run `indoctrinatr pdf demo/`
+     Then a file named "demo/doc/examples/demo_with_default_values.pdf" should exist
+

data/features/pdf_with_timestamp.feature

@@ -0,0 +1,8 @@
+Feature: Running the 'pdf' command with timestamp in filename
+  Scenario: using the test fixture
+    Given I use the fixture named "test"
+     When I cd to "../"
+     When I run the Indoctrinatr command 'parse test'
+      And I run `indoctrinatr pdf test`
+    # String interpolation for "file named should exist" does not work. Therefore less strict regexp matching:
+     Then a file matching %r<test/doc/examples/\d{4}_hello_world\.pdf> should exist

data/features/version.feature

@@ -2,4 +2,4 @@ Feature: Running the "version" command
 
   Scenario:
     When I successfully run `indoctrinatr version`
-    Then the output should contain "0.12.0"
+    Then the output should contain "0.13.0"

data/indoctrinatr-tools.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler',   '~> 1.12'
+  spec.add_development_dependency 'bundler',   '~> 1.10'
   spec.add_development_dependency 'rake',      '~> 11.1'
   spec.add_development_dependency 'rspec',     '~> 3.4'
   spec.add_development_dependency 'cucumber',  '~> 2.3'

data/lib/indoctrinatr/tools/template_pack_default_values_compiler.rb

@@ -33,13 +33,14 @@ module Indoctrinatr
         make_pdf tex_with_default_values_file_path, pack_documentation_examples_dir_path, !@keep_aux_files
       end
 
-      def rename_if_necessary
+      def rename_if_necessary # rubocop:disable Metrics/AbcSize
         configuration = ConfigurationExtractor.new(template_pack_name).call # TODO: avoid repeated calling of the ConfigurationExtrator
         @default_values = DefaultValues.new configuration
         return if @default_values.customized_output_file_name == @default_values.default_file_name
 
-        FileUtils.rm @default_values.customized_output_file_name if File.exist? @default_values.customized_output_file_name
-        FileUtils.mv(@default_values.default_file_name, @default_values.customized_output_file_name)
+        custom_filepath = pack_documentation_examples_dir_path + @default_values.customized_output_file_name
+        FileUtils.rm custom_filepath if File.exist? custom_filepath
+        FileUtils.mv(pack_documentation_examples_dir_path + @default_values.default_file_name, custom_filepath)
       end
     end
   end

data/lib/indoctrinatr/tools/template_pack_scaffold.rb

@@ -23,7 +23,7 @@ module Indoctrinatr
       private
 
       def create_folder
-        fail 'Please specify a template pack name.' if template_pack_name.empty? # rubocop:disable Style/SignalException
+        fail 'Please specify a template pack name.' if template_pack_name.nil? || template_pack_name.empty? # rubocop:disable Style/SignalException
         fail "A folder with name '#{template_pack_name}' already exists." if Dir.exist? path_name # rubocop:disable Style/SignalException
 
         Dir.mkdir path_name

data/lib/indoctrinatr/tools/version.rb

@@ -1,5 +1,5 @@
 module Indoctrinatr
   module Tools
-    VERSION = '0.12.0'.freeze
+    VERSION = '0.13.0'.freeze
   end
 end

data/spec/fixtures/test/configuration.yaml

@@ -0,0 +1,26 @@
+template_name: Hello World Template
+output_file_name: '#{Time.now.year}_hello_world.pdf'
+textual_description: |
+  This is your first _Indoctrinatr_ template. You can use _Textile_ syntax here to *highlight* important information.
+
+    Edit this template as you like. Read more at https://github.com/dkd/indoctrinatr.
+fields:
+  -
+    name: variable1
+    label: Who is it?
+    presentation: text
+    default_value: "World"
+    description: "The first variable"
+  -
+    name: date
+    label: Date
+    presentation: date
+    default_value: '#{Time.now.year}-#{Time.now.month}-#{Time.now.day}'
+  -
+    name: variable2
+    label: Type of World
+    required: "true"
+    presentation: dropdown
+    default_value: "not enough"
+    available_options: "not enough, beautiful, your oyster, a template"
+    description: "The second variable. The description name can be very long and should adequately describe what the variable is for etc. pp."

data/spec/fixtures/test/test.tex.erb

@@ -0,0 +1,15 @@
+% This is the official Indoctrinatr "Hello World Template".
+\documentclass{article}
+
+\begin{document}
+	\section{Hello <%= variable1 -%>}
+	 
+	The <%= variable1 -%> is <%= variable2 -%>!
+ 
+	Today is \textbf{<%= date -%>}.
+	
+	% This is is the raw, unescaped input of \texttt{variable1}:
+	\begin{verbatim}
+		<%= raw_variable1 -%>
+	\end{verbatim}
+\end{document}

data/spec/indoctrinatr/tools/version_spec.rb

@@ -3,6 +3,6 @@ require 'indoctrinatr/tools/version'
 
 describe Indoctrinatr::Tools do
   it 'defines a VERSION constant' do
-    expect(Indoctrinatr::Tools::VERSION).to eq '0.12.0'
+    expect(Indoctrinatr::Tools::VERSION).to eq '0.13.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indoctrinatr-tools
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Nicolai Reuschling
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +208,7 @@ files:
 - ".rubocop.yml"
 - ".rvmrc"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -226,6 +227,7 @@ files:
 - 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
@@ -262,6 +264,8 @@ files:
 - lib/indoctrinatr/tools/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
@@ -289,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - LaTeX development enviroment
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: indoctrinatr-tools provides a set of command line tools for Indoctrinatr
@@ -306,12 +310,15 @@ test_files:
 - 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