templator 0.2 → 0.2.1

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/CHANGES

@@ -1,3 +1,7 @@
+= 0.2.1
+    * Fix gemspec errors
+= 0.2
+    * Refactor the Parameter DSL loading mechanism in order to display more comprehensible error messages.
 = 0.1.1 / 2012-02-03
     * Fix bug when doing recursive calls to include_file action,
       only the result of the last call was included in the generated file. 

data/lib/templator/version.rb

@@ -1,3 +1,3 @@
 module Templator
-  VERSION=0.2
+  VERSION="0.2.1"
 end

data/spec/data/file_to_include

@@ -0,0 +1,3 @@
+first line
+second line
+third line

data/spec/data/parameter_dir/parameter1

@@ -0,0 +1,4 @@
+export :parameter1 => "value1"
+group "group1" do
+    export :parameter2 => "value2"
+end

data/spec/data/parameter_dir/parameter2

@@ -0,0 +1 @@
+parameter 2

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+
+def parameter_dir_path
+  File.join(File.dirname(__FILE__), 'data', 'parameter_dir') 
+end
+
+def parameter_file_content(*paths)
+  content = paths.sort.inject("") { |c, path| c+= File.read(path)}
+end
+
+def in_file(filename, content)
+  File.open(filename, "w") do |f|
+    f.puts content
+  end
+end
+

data/templator.gemspec

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'templator/version'
+
+Gem::Specification.new do |s|
+  s.name = "templator"
+  s.version = Templator::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
+  s.author = "Christophe Arguel"
+  s.email = "christophe.arguel@free.fr"
+  s.homepage = "https://github.com/carguel/templator"
+  s.summary = "A command line tool allowing to generate text documents from ERB template"
+  s.description = <<-DESCRIPTION 
+  Templator is a command line tool allowing to generate text documents from templates written
+  in the ERB template language.
+
+  It also provides a Domain Specific Language, the Parameter DSL, to define a set of parameters
+  that can be referenced from template files in order to generate the target document
+  with the expected values.
+  DESCRIPTION
+
+  s.platform = Gem::Platform::RUBY
+  s.files = `git ls-files`.split("\n") - %w[.gitignore .travis.yml]
+  s.require_paths = ["lib"]
+  s.bindir = 'bin'
+  s.executables << 'templator'
+  s.extra_rdoc_files = ["CHANGES", "LICENSE", "README.md", "TODO"]
+  s.test_files = s.files.select { |p| p =~ /^spec\/.*_spec.rb/ } 
+
+  s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
+  s.add_development_dependency(%q<rake>, [">= 0.9"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
+  s.add_development_dependency(%q<yard>, ["~> 0.8.3"])
+  s.add_runtime_dependency(%q<thor>, ["~>0.16.0"])
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: templator
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.6
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,111 +90,12 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.14.6
-description: ! "Templator\n=========\n\nDescription\n-----------\nTemplator is a command
-  line tool allowing to generate text documents from templates written \nin the [ERB](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html)
-  template language.\n\nIt also provides a Domain Specific Language, the _Parameter
-  DSL_, to define a set of parameters\nthat can be referenced from template files
-  in order to generate the target document\nwith expected values.\n\nTemplator is
-  developped in Ruby. It requires Ruby 1.8.7 and higher, or any version of the 1.9
-  branch.\n\nInstallation\n------------\n\nTo quickly install Templator, use the following
-  command:\n\n    gem install templator\n\nUsage\n-----\n\nThe following command allows
-  to display the online help:\n\n    $ templator help\n\nTwo tasks are available from
-  the command line:\n\n * __gen__ \n\nThis task is responsible for the transformation
-  of a given template to a target document, \ntaking into account any provided parameter
-  files.\n\nHere is the most simple command line invokation.\n    \n    $ templator
-  gen path/to/template path/to/target\n\nFiles that define parameters can be passed
-  to Templator with the __-p__ switch:\n\n    $ templator gen path/to/template path/to/target
-  -p path/to/paramaters1 path/to/parameters2\n\nWhen parameter files are passed, Templator
-  firstly parses these files with respect to the Parameter DSL (see below).\nFiles
-  are parsed in the same order that they are provided by the __-p__ switch. \nAll
-  parameters exported from these files are then visible by the template.\n\nThe __-c__
-  switch allows to define a default context from which Templator will try to\nresolve
-  parameter names that are not fully qualified in the template. More details are provided\nat
-  the end of this document.\n\n\n * __get_param__\n\nThis task allows to get the value
-  of a parameter from the provided parameter files.\n\n    $ templator get_param 'my_parameter'
-  -p path/to/parameters \n\nParameter DSL\n-------------\n\nThe set of parameters
-  is expressed in a Ruby DSL that provides following methods:\n\n * __export__\n\nThis
-  method allows to define new parameters and make them visible from a template during\nthe
-  generation process. Following example shows how to define the parameter 'my_parameter'
-  with\nthe value 'my_value'\n\n    export \"my_parameter\" => \"my_value\"\n\nIt
-  is also possible to define several parameters in a single export line:\n\n    export
-  \"my_parameter\" => \"my_value\", \"my_other_parameter\" => \"my_other_value\"\n\n\nIt
-  is worth noting that parameter names can be a Ruby Symbol:\n\n    export :my_parameter
-  => \"my_value\"\n\nMore over, the parameter value can be any Ruby valid expression,
-  for example:\n\n    export :integer => 3\n    export :now => Time.now\n    export
-  :upper_parameter => \"my_value\".upcase\n\nLast but not least, you can use the value
-  of previously defined parameters to build a \nmore complex parameter:\n\n    export
-  :parameter1 => 1\n    export :parameter2 => 2\n    export :sum => parameter1 + parameter2\n\nEach
-  time the Parameter DSL parser encounters an exported parameter, it defines \na method
-  with the same name. In the previous example, the value of :parameter1\nand :parameter2
-  is gotten by invoking the corresponding methods, parameter1 et parameter2. \n\n
-  * __group__\n\nThe group method allows to define a subset of parameters.\n\n    group
-  :my_group do\n        export :my_parameter => \"my_value\"\n    end\n\nNested group
-  is also possible:\n\n    group :top do\n        group :inner do\n            ...\n
-  \       end\n    end\n\nValue of parameters defined in other groups must be retrieved
-  with \nthe fully qualified name of the parameter in dot notation.\n\n    group :foo_group
-  do\n        export :foo => \"foo\"\n    end\n\n    group :bar_group do\n        export
-  :bar => \"bar\"\n    end\n\n    group :foobar_group do\n        export :foobar =>
-  foo_group.foo + bar_group.bar\n    end\n\nA group can de defined multiple times.
-  The resulting group is a merge of all\ndefinitions taking into account the order
-  of the parsing:\n\n    #file1\n    group :my_group do\n        export :parameter1
-  => 1\n        export :parameter2 => 2\n    end\n\n    #file2\n    group :my_group
-  do\n        export :parameter1 => 0.99999\n        export :parameter3 => 3\n    end\n\nAssuming
-  that file1 and file2 are parsed in this order, the resulting group \nis semantically
-  equivalent to this one:\n\n    group :my_group do\n        export :parameter1 =>
-  0.99999\n        export :parameter2 => 2\n        export :parameter3 => 3\n    end\n\n
-  * __include_group__\n\nThe include_group method is an interesting way to share some
-  common parameters between different groups.\nIt allows to mix the parameters of
-  a group in another one.\nIt is conceptually equivalent to the well known Ruby include
-  method.\n\nConsider the following example:\n\n    group :mixin do\n        export
-  :mixme => \"some value\"\n    end\n\n    group :my_group do\n        include_group
-  :mixin\n        export :another_parameter => \"another_value\"\n    end\n\nThus,
-  the resulting group is equivalent to :\n\n    group :my_group do\n        export
-  :mixme => \"some value\"\n        export :another_parameter => \"another_value\"\n
-  \   end\n\nTemplate Actions\n----------------\n\nAs said before, the template language
-  used by Templator is ERB.\n\nIn addition to the features provided by ERB, the following
-  extra methods can be invoked from a template:\n\n * __param__\n\nThis method allows
-  to retrieve the value of parameters passed to Templator by the __-p__ swicth. \n\nHere
-  is a concrete example:\n\nFile _parameters.txt_:\n\n    group :my_group do\n        export
-  :my_parameter => \"my_value\"\n    end\n    ...\n\nFile _template.txt_:\n\n    The
-  value of the parameter \"my_parameter\" defined in the group \"my_group\" is <%=
-  param \"my_group.my_parameter\" %>\n\nCommand line invokation from the shell:\n\n
-  \   $ templator gen template.txt output -p parameters.txt\n\nThe resulting _output_
-  file should have the following content:\n\n    The value of the parameter \"my_parameter\"
-  defined in the group \"my_group\" is my_value\n\n * __param_exists?__\n\nThis method
-  tests if a parameter is defined. \nConsider the following template example:\n\n
-  \   <% if param_exists? \"my_group.my_parameter\" %>\n    The parameter \"my_parameter\"
-  is well defined in group \"my_group\".\n    <% else %>\n    There is no parameter
-  \"my_parameter\" defined in group \"my_group\".\n    <% end %>\n\n * __include_file__\n\n\nThis
-  method parses the content of the given file as an ERB template, \nand appends the
-  resulting text into the output stream of the source template.\n\nThis is a convenient
-  method to spread a template on multiple files.\n\nHere is an example that dynamically
-  generates the name of the template to\ninclude according to the value of a parameter:\n\n
-  \   blah blah blah\n    <%= include_file \"#{param :my_parameter}.txt\" %>\n\nThe
-  path of the template to include is interpreted relatively from the path\nof the
-  source template. \n\nContextual resolution of parameter names\n\nContext\n-------\n\nA
-  context is defined with the __-c__ switch. It is eventually\nused by the __param__
-  and __param_exists?__ methods to resolve\nthe provided parameter names.\nWhenever
-  the resolution of a parameter name fails, \nif a context is defined, it is prepended
-  to the parameter name \nand a new resolution is tried with the resulting name. In
-  this case,\nyou must ensure that the context matches a valid fully qualified group
-  name.\n\nContext is a convenient way to generate different documents from the same
-  template,\nassuming that a group of parameters is defined for each expected documents.\n\nHere
-  is a concrete example where the objective is to generate a Debian /etc/network/interfaces
-  \nfile for three different hosts.\n\nFile _hosts.txt_:\n\n    group :common_parameters
-  do\n        export :gateway => \"192.168.121.254\"\n    end\n\n    group :host_a
-  do\n        export :address => \"192.168.121.1\"\n        export :netmask => \"255.255.255.0\"\n
-  \       include_group :common_parameters\n    end\n\n    group :host_b do\n        export
-  :address => \"192.168.121.2\"\n        export :netmask => \"255.255.255.0\"\n        include_group
-  :common_parameters\n    end\n\n    group :host_c do\n        export :address =>
-  \"192.168.121.3\"\n        export :netmask => \"255.255.255.0\"\n        include_group
-  :common_parameters\n    end\n\nFile _interfaces.txt_:\n\n    iface eth0 inet static\n
-  \       address <%= param :address %>\n        netmask <%= param :netmask %>\n        gateway
-  <%= param :gateway %>\n\nCommand line execution from shell:\n\n    for host in host_a
-  host_b host_c\n    do\n        templator gen interfaces.txt interfaces.$host -p
-  hosts.txt -c $host\n    done\n\nCopyright\n---------\n\nCopyright © 2011 Christophe
-  Arguel. See LICENSE for details.\n"
+        version: 0.16.0
+description: ! "  Templator is a command line tool allowing to generate text documents
+  from templates written\n  in the ERB template language.\n\n  It also provides a
+  Domain Specific Language, the Parameter DSL, to define a set of parameters\n  that
+  can be referenced from template files in order to generate the target document\n
+  \ with the expected values.\n"
 email: christophe.arguel@free.fr
 executables:
 - templator
@@ -205,23 +106,29 @@ extra_rdoc_files:
 - README.md
 - TODO
 files:
-- TODO
+- .rspec
 - CHANGES
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
-- Gemfile.lock
 - Rakefile
-- Gemfile
-- lib/templator/version.rb
-- lib/templator/parameter_file_selector.rb
+- TODO
+- bin/templator
 - lib/templator/actions.rb
-- lib/templator/parameters.rb
 - lib/templator/parameter_dsl.rb
-- spec/templator/parameter_file_selector_spec.rb
+- lib/templator/parameter_file_selector.rb
+- lib/templator/parameters.rb
+- lib/templator/version.rb
+- spec/data/file_to_include
+- spec/data/parameter_dir/parameter1
+- spec/data/parameter_dir/parameter2
+- spec/spec_helper.rb
 - spec/templator/actions_spec.rb
 - spec/templator/parameter_dsl_spec.rb
+- spec/templator/parameter_file_selector_spec.rb
 - spec/templator/parameters_spec.rb
-- bin/templator
+- templator.gemspec
 homepage: https://github.com/carguel/templator
 licenses: []
 post_install_message: 
@@ -236,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3420970963505475500
+      hash: 4468909134283378695
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -250,7 +157,7 @@ signing_key:
 specification_version: 3
 summary: A command line tool allowing to generate text documents from ERB template
 test_files:
-- spec/templator/parameter_file_selector_spec.rb
 - spec/templator/actions_spec.rb
 - spec/templator/parameter_dsl_spec.rb
+- spec/templator/parameter_file_selector_spec.rb
 - spec/templator/parameters_spec.rb