templator 0.1

data/spec/templator/parameters_spec.rb

@@ -0,0 +1,27 @@
+require 'templator/parameters'
+require 'spec_helper'
+
+module Templator
+
+  describe Parameters do
+
+
+    describe "#load_files" do
+
+
+      context "parameter files that contain only simple parameter definitions" do
+
+        it "should load the given file and return a Parameters instance" do
+          path = File.join(parameter_dir_path, 'parameter1')
+
+          parameters = Parameters.load_files(path)
+
+          parameters.should be_kind_of Parameters
+
+          parameters.get(:parameter1).should == 'value1'
+          parameters.get("group1.parameter2").should == 'value2'
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,256 @@
+--- !ruby/object:Gem::Specification 
+name: templator
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Christophe Arguel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        - 3
+        version: 0.7.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 14
+        - 6
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id005
+description: "Templator\n\
+  =========\n\n\
+  Description\n\
+  -----------\n\
+  Templator is a command line tool allowing to generate text documents from templates written \n\
+  in the [ERB](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html) 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 expected values.\n\n\
+  Templator is developped in Ruby. It requires Ruby 1.8.7 and higher, or any version of the 1.9 branch.\n\n\
+  Installation\n\
+  ------------\n\n\
+  To quickly install Templator, use the following command:\n\n    gem install templator\n\n\
+  Usage\n\
+  -----\n\n\
+  The following command allows to display the online help:\n\n    $ templator help\n\n\
+  Two tasks are available from the command line:\n\n * __gen__ \n\n\
+  This task is responsible for the transformation of a given template to a target document, \n\
+  taking into account any provided parameter files.\n\n\
+  Here is the most simple command line invokation.\n    \n    $ templator gen path/to/template path/to/target\n\n\
+  Files 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\n\
+  When parameter files are passed, Templator firstly parses these files with respect to the Parameter DSL (see below).\n\
+  Files are parsed in the same order that they are provided by the __-p__ switch. \n\
+  All parameters exported from these files are then visible by the template.\n\n\
+  The __-c__ switch allows to define a default context from which Templator will try to\n\
+  resolve parameter names that are not fully qualified in the template. More details are provided\n\
+  at the end of this document.\n\n\n * __get_param__\n\n\
+  This 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\n\
+  Parameter DSL\n\
+  -------------\n\n\
+  The set of parameters is expressed in a Ruby DSL that provides following methods:\n\n * __export__\n\n\
+  This method allows to define new parameters and make them visible from a template during\n\
+  the generation process. Following example shows how to define the parameter 'my_parameter' with\n\
+  the value 'my_value'\n\n    export \"my_parameter\" => \"my_value\"\n\n\
+  It 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\n\
+  It is worth noting that parameter names can be a Ruby Symbol:\n\n    export :my_parameter => \"my_value\"\n\n\
+  More 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\n\
+  Last but not least, you can use the value of previously defined parameters to build a \n\
+  more complex parameter:\n\n    export :parameter1 => 1\n    export :parameter2 => 2\n    export :sum => parameter1 + parameter2\n\n\
+  Each time the Parameter DSL parser encounters an exported parameter, it defines \n\
+  a method with the same name. In the previous example, the value of :parameter1\n\
+  and :parameter2 is gotten by invoking the corresponding methods, parameter1 et parameter2. \n\n * __group__\n\n\
+  The group method allows to define a subset of parameters.\n\n    group :my_group {\n        export :my_parameter => \"my_value\"\n    }\n\n\
+  Nested group is also possible:\n\n    group :top {\n        group :inner {\n            ...\n        }\n    }\n\n\
+  Value of parameters defined in other groups must be retrieved with \n\
+  the fully qualified name of the parameter in dot notation.\n\n    group :foo_group {\n        export :foo => \"foo\"\n    }\n\n    group :bar_group {\n        export :bar => \"bar\"\n    }\n\n    group :foobar_group {\n        export :foobar => foo_group.foo + bar_group.bar\n    }\n\n\
+  A group can de defined multiple times. The resulting group is a merge of all\n\
+  definitions taking into account the order of the parsing:\n\n    #file1\n    group :my_group {\n        export :parameter1 => 1\n        export :parameter2 => 2\n    }\n\n    #file2\n    group :my_group {\n        export :parameter1 => 0.99999\n        export :parameter3 => 3\n    }\n\n\
+  Assuming that file1 and file2 are parsed in this order, the resulting group \n\
+  is semantically equivalent to this one:\n\n    group :my_group {\n        export :parameter1 => 0.99999\n        export :parameter2 => 2\n        export :parameter3 => 3\n    }\n\n * __include_group__\n\n\
+  The include_group method is an interesting way to share some common parameters between different groups.\n\
+  It allows to mix the parameters of a group in another one.\n\
+  It is conceptually equivalent to the well known Ruby include method.\n\n\
+  Consider the following example:\n\n    group :mixin {\n        export :mixme => \"some value\"\n    }\n\n    group :my_group {\n        include_group :mixin\n        export :another_parameter => \"another_value\"\n    }\n\n\
+  Thus, the resulting group is equivalent to :\n\n    group :my_group {\n        export :mixme => \"some value\"\n        export :another_parameter => \"another_value\"\n    }\n\n\
+  Template Actions\n\
+  ----------------\n\n\
+  As said before, the template language used by Templator is ERB.\n\n\
+  In addition to the features provided by ERB, the following extra methods can be invoked from a template:\n\n * __param__\n\n\
+  This method allows to retrieve the value of a parameter. \n\n\
+  Here is a concrete example:\n\n\
+  File _parameters.txt_:\n\n    group :my_group {\n        export my_parameter => \"my_value\"\n    }\n    ...\n\n\
+  File _template.txt_:\n\n    The value of the parameter \"my_parameter\" defined in the group \"my_group\" is <%= param \"my_group.my_parameter\" %>\n\n\
+  Command line invokation from the shell:\n\n    $ templator gen template.txt output -p parameters.txt\n\n\
+  The 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\n\
+  This method tests if a parameter is defined. \n\
+  Consider 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\n\
+  This method parses the content of the given file as an ERB template, \n\
+  and appends the resulting text into the output stream of the source template.\n\n\
+  This is a convenient method to spread a template on multiple files.\n\n\
+  Here is an example that dynamically generates the name of the template to\n\
+  include according to the value of a parameter:\n\n    blah blah blah\n    <%= include_file \"#{param :my_parameter}.txt\"\n\n\
+  The path of the template to include is interpreted relatively from the path\n\
+  of the source template. \n\n\
+  Contextual resolution of parameter names\n\n\
+  Context\n\
+  -------\n\n\
+  A context is defined with the __-c__ switch. It is eventually\n\
+  used by the __param__ and __param_exists?__ methods to resolve\n\
+  the provided parameter names.\n\
+  Whenever the resolution of a parameter name fails, \n\
+  if a context is defined, it is prepended to the parameter name \n\
+  and a new resolution is tried with the resulting name. In this case,\n\
+  you must ensure that the context matches a valid fully qualified group name.\n\n\
+  Context is a convenient way to generate different documents from the same template,\n\
+  assuming that a group of parameters is defined for each expected documents.\n\n\
+  Here is a concrete example where the objective is to generate a Debian /etc/network/interfaces \n\
+  file for three different hosts.\n\n\
+  File _hosts.txt_:\n\n    group :host_a {\n        export :address => \"192.168.121.1\"\n        export :netmask => \"255.255.255.0\"\n        export :gateway => \"192.168.121.254\"\n    }\n\n    group :host_b {\n        export :address => \"192.168.122.1\"\n        export :netmask => \"255.255.255.0\"\n        export :gateway => \"192.168.122.254\"\n    }\n\n    group :host_c {\n        export :address => \"192.168.123.1\"\n        export :netmask => \"255.255.255.0\"\n        export :gateway => \"192.168.123.254\"\n    }\n\n\
+  File _interfaces.txt_:\n\n    iface eth0 inet static\n        address <%= param :address %>\n        netmask <%= param :netmask %>\n        gateway <%= param :gateway %>\n\n\
+  Command 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\n\
+  Copyright\n\
+  ---------\n\n\
+  Copyright \xC2\xA9 2011 Christophe Arguel. See LICENSE for details.\n"
+email: christophe.arguel@free.fr
+executables: 
+- templator
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- LICENSE
+- README.md
+- TODO
+files: 
+- Gemfile.lock
+- CHANGES
+- Gemfile
+- Rakefile
+- LICENSE
+- TODO
+- README.md
+- lib/templator/parameters.rb
+- lib/templator/parameter_code_loader.rb
+- lib/templator/actions.rb
+- lib/templator/parameter_dsl.rb
+- spec/templator/parameter_dsl_spec.rb
+- spec/templator/parameter_code_loader_spec.rb
+- spec/templator/actions_spec.rb
+- spec/templator/parameters_spec.rb
+- bin/templator
+homepage: https://github.com/carguel/templator
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A command line tool allowing to generate text documents from ERB template
+test_files: 
+- spec/templator/parameter_dsl_spec.rb
+- spec/templator/parameter_code_loader_spec.rb
+- spec/templator/actions_spec.rb
+- spec/templator/parameters_spec.rb