aws-must 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e420dcf4c1ad2882e09cf1b188333d3c84474df7
-  data.tar.gz: 2e7da5a2e698cb5d2a28bdced3b0d2a8d12bb618
+  metadata.gz: 4df0abe6aafa2e3145f9995eee51a1b4f4a6bf9c
+  data.tar.gz: daa5ad0f99ff4a785fd664cba698cda7e79d540c
 SHA512:
-  metadata.gz: f898429506e61f6229983f1eccb9a4352550dec71588e73154ef6e52970fe35d47dff655f1198c3f238105202b79e7336699f30675953dd1f6b49c26236ed16d
-  data.tar.gz: 35dccbaff7ec723c1494de0891a4b788e90d5f7dde03f971a3d57d805c205e214224ce5acd5ba66403a4c639a34e584c0d88af438dad9cbe56c0cec3fb3750c4
+  metadata.gz: 48346e91b649bd279a2966bb6dde84a6ee11bd251e181e8b96bb7cd628519aba8f58dfe8a3f9b370268a02c2302f16261ec1ce9d94da30976f1bed367f0817b2
+  data.tar.gz: 5710ab165795472d962d85f28b3bdbf148f1a17cf9146f6fef18a5da67c9b26e3191e830fd6a1ce5e3d9c2fbeeec2cd615a68773674ab898eb30d6472c8d81ca

data/README.md

@@ -1,4 +1,4 @@
-# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.12$
+# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.13$
 
 `aws-must` is a tool, which allows separating infrastructure
 configuration and Amazon related syntax in CloudFormation JSON
@@ -103,26 +103,25 @@ template `./mustache/root.mustache` issue the command
 
 	aws-must.rb gen yaml_file
 
-The path of Mustache templates can be changed using `-t` option, or by
-giving the name of a gem with a `-g` option. For example, to use the
-latest version of
-[aws-must-templates](https://github.com/jarjuk/aws-must-templates),
-use the command
+The location where to search Mustache templates can be set with `-m`
+option.The option accepts list of directory paths (ending with `/`
+character) or Gem names.  For example, to override templates in Gem
+[aws-must-templates](https://github.com/jarjuk/aws-must-templates)
+with templates in directory `mydir` use the command
 
-	aws-must.rb gen yaml_file -g aws-must-templates
+	aws-must.rb gen yaml_file -m mydir/ aws-must-templates
 
-The version constraint for the gem can be specified followed by a
-comma -character. For example, to use version specification `~>0.0.1`,
-issue the command
+A version constraint for the Gem can be specified followed by a comma
+-character. For example, to use version specification `~>0.0.1`, issue
+the command
 
-	aws-must.rb gen yaml_file -g 'aws-must-templates,~>0.0.1'
+	aws-must.rb gen yaml_file -m 'aws-must-templates,~>0.0.1'
 
 To extract documentation for the templates
 
 	aws-must.rb doc 
 
-The documentation command supports the same `-t` and `-g` options, as
-the `gen` -command.
+The `doc` -command supports also `-m` option.
 
 Documentation is extracted from lines surrounded by **+++start+++**
 and **+++close+++** tags, or by **+++fold-on+++** and
@@ -147,7 +146,6 @@ To dump YAML `yaml_file` in JSON format
 
 Add the following lines to `Rakefile`
 
-
 	spec = Gem::Specification.find_by_name 'aws-must'
 	load "#{spec.gem_dir}/lib/tasks/demo.rake"
 

data/bin/aws-must.rb

@@ -53,12 +53,14 @@ class App < Thor
 
   # ------------------------------------------------------------------
   add_shared_option :template_gem, :aliases => "-g", :type => :string,
-  :desc => "Mustache template Gem name (optionally with version constraint e.g. 'aws-must-templates,~>0.0.1')"
+  :desc => "Mustache template Gem name (optionally with version constraint e.g. 'aws-must-templates,~>0.0.1') (DEPRECATED)"
 
   add_shared_option :template_path, :aliases => "-t", :type =>
-  :string, :default => "mustache", 
-  :desc => "Directory holding mustache templates"
+  :string, :desc => "Directory holding mustache templates (DEPRECATED)"
 
+  add_shared_option :mustaches, :aliases => "-m", :type =>
+  :array, :default =>  [ "mustache/"], 
+  :desc => "Array of directory paths (ending with slash '/' char e.g. 'mustache/') of Gem names (optionally with version constraint e.g. 'aws-must-templates,~>0.0.1') holding mustache templates"
 
   # ------------------------------------------------------------------
   # action 'doc'
@@ -66,6 +68,7 @@ class App < Thor
   desc "doc", "Extract template documentation"
 
   shared_options :template_path
+  shared_options :mustaches
   shared_options :template_gem
 
   option :fold_on, :aliases => "-n", :type => :string, 
@@ -108,7 +111,7 @@ LONGDESC
 
   def doc( template_name=DEAFAULT_TEMPLATE )
 
-    @logger.info( "#{__FILE__}.#{__method__} starting" )
+    @logger.info( "#{__method__} starting" )
 
     
     my_options = option_adjust_common( options )
@@ -174,6 +177,7 @@ LONGDESC
   desc "gen <yaml_file> [<template_name>]", "Generate CloudFormation JSON template"
 
   shared_options :template_path
+  shared_options :mustaches
   shared_options :template_gem
 
   long_desc <<-LONGDESC
@@ -201,33 +205,90 @@ LONGDESC
 
     def option_adjust_common( options ) 
 
-      raise "No optios give" unless options
-      ret = options
-      ret = option_template_gem_to_template_path( options )  if options[:template_gem]
+      raise "No optios given" unless options
+
+      # options readonly - dup allows modification
+      options = options.dup
+
+      @logger.debug( "#{__method__}, options '#{options}'" )
+
+      options = option_template_gem_to_template_path( options )  if options[:template_gem]
+      options = option_template_path( options )  if options[:template_path]
+
+      warn <<-EOS   unless options[:mustaches] && options[:mustaches].any?
+
+      Deprecation!!
+
+           Use option -m to define location of templates
+
+           Options -g and -t deprecated
+      EOS
+
+      options = option_mustaches_to_template_paths( options )  if options[:mustaches]
       
-      return ret
+      return options
     end
 
+    # set `options[:template_path]` to an array of local directory
+    # paths parsed from list of options[:mustaches]
+    def option_mustaches_to_template_paths( options ) 
+
+      # init, NB: plural
+      options[:template_paths] = []
+
+      options[:mustaches].each do |mustache_def|
+        if mustache_def[-1] == '/' then
+          # directory with last char removed
+          options[:template_paths] << mustache_def[0..-1]
+        else
+          # gemname 
+          options[:template_paths] << gem_name_to_template_path( mustache_def )
+        end
+          
+      end
+      return options
+    end
 
+    # overrides -m option
+    def option_template_path( options ) 
+      # overrides -m option
+      options[:mustaches] = []
+      return options
+    end
+
+    # set 'options[:template_path]' to mustache directory withing
+    # `options[:template_gem]` Gem
     def option_template_gem_to_template_path( options ) 
 
+      # overrides -m option
+      options[:mustaches] = []
+
+      options[:template_path] = gem_name_to_template_path( options[:template_gem] )
+      
+      return options
+
+    end
+
+    # map 'gem_name_and_spec' to path of mustache templates
+    def gem_name_to_template_path( gem_name_and_spec ) 
+
       # The version requirements are optional.
       # You can also specify multiple version requirements, just append more at the end
-      gem_spec = options[:template_gem].split(',')
+      gem_spec = gem_name_and_spec.split(',')
       gem_name, *gem_ver_reqs = gem_spec[0], gem_spec[1]
+      @logger.debug( "#{__method__}, gem_name=#{gem_name}, *gem_ver_reqs=#{gem_ver_reqs}" )
       gdep = Gem::Dependency.new(gem_name, *gem_ver_reqs)
       # find latest that satisifies
       found_gspec = gdep.matching_specs.sort_by(&:version).last
+      @logger.debug( "#{__method__}, found_gspec=#{found_gspec}" )
       # instead of using Gem::Dependency, you can also do:
       # Gem::Specification.find_all_by_name(gem_name, *gem_ver_reqs)
 
       if found_gspec
-        # unfreeze options
-        @logger.debug( "#{__FILE__}.#{__method__}, Requirement '#{gdep}' already satisfied by #{found_gspec.name}-#{found_gspec.version}" )
-        @logger.debug( "#{__FILE__}.#{__method__}, old-options=#{options}" )
-        options = options.dup
-        options[:template_path] = "#{found_gspec.gem_dir}/mustache"
-        @logger.debug( "#{__FILE__}.#{__method__}, new-options=#{options}" )
+        @logger.debug( "#{__method__}, Requirement '#{gdep}' already satisfied by #{found_gspec.name}-#{found_gspec.version}" )
+        @logger.debug( "#{__method__}, old-options=#{options}" )
+        template_path = "#{found_gspec.gem_dir}/mustache"
+        @logger.debug( "#{__method__}, template_path=#{template_path}" )
       else
         #puts "Requirement '#{gdep}' not satisfied; installing..."
         # ver_args = gdep.requirements_list.map{|s| ['-v', s] }.flatten
@@ -236,7 +297,7 @@ LONGDESC
         raise "Could not find gem '#{gdep}' - try 'gem install #{gdep}'"
       end
       
-      return options
+      return template_path
 
     end
     

data/lib/aws-must/template.rb

@@ -12,10 +12,6 @@ module AwsMust
     # ------------------------------------------------------------------
     # Attributes
 
-    # static
-    @@template_path = nil            # directory where templates stored
-    @@template_extension = "mustache"# type part in filename
-
     # instance 
     attr_writer :partials            # f: partial-name --> template string
     attr_writer :templates           # f: template-name --> template string
@@ -25,10 +21,18 @@ module AwsMust
     
     def initialize( options={} )
       @logger = getLogger( PROGNAME, options )
-      @logger.info( "#{__FILE__}.#{__method__} created" )
-      @logger.debug( "#{__FILE__}.#{__method__}, options='#{options}" )
+      @logger.info( "#{__method__} created" )
+      @logger.debug( "#{__method__}, options='#{options}" )
+
+      @template_extension = "mustache"# type part in filename
+
       # for mustache templates
-      @@template_path = options[:template_path] if options[:template_path]
+      if options[:template_paths] && options[:template_paths].any? then
+        @template_paths = options[:template_paths]
+      else
+        @template_paths = ( options[:template_path].respond_to?(:each) ? options[:template_path] : [ options[:template_path]  ] )
+      end
+
     end
 
     # ------------------------------------------------------------------
@@ -51,56 +55,82 @@ module AwsMust
 
     # method used by mustache framework - delegate to 'get_partial'
     def partial(name)
-      @logger.debug( "#{__FILE__}.#{__method__} name=#{name}" )
-      # File.read("#{template_path}/#{name}.#{template_extension}")
+      @logger.debug( "#{__method__} name=#{name}" )
       get_partial( name )
     end
 
     # cache @partials - for easier extension
     def get_partial( name ) 
-      @logger.debug( "#{__FILE__}.#{__method__} name=#{name}" )
+      @logger.debug( "#{__method__} name=#{name}" )
       return @partials[name] if @partials && @partials[name]
 
-      partial_file = "#{@@template_path}/#{name}.#{template_extension}"
-      @logger.info( "#{__FILE__}.#{__method__} read partial_file=#{partial_file}" )
+      partial_file = get_template_filepath( name )
+      @logger.info( "#{__method__} read partial_file=#{partial_file}" )
       File.read( partial_file )
     end
 
     # hide @templates - for easier extension
     def get_template( name ) 
 
-      @logger.debug( "#{__FILE__}.#{__method__} name=#{name}" )
-      return @templates[name] if @templates && @templates[name]
+      template_file = get_template_filepath( name )
+      @logger.info( "#{__method__} read template_file=#{template_file}" )
+      File.read( template_file )
 
-      if !  File.exists?( @@template_path ) then
-        raise <<-eos
+    end # def get_template( name ) 
+
+
+    # return path to an existing template file name 
+    private
+
+    def get_template_filepath( name ) 
+
+      @template_paths.each do |directory| 
+
+        template_path = get_template_filepath_in_directory( directory, name ) 
+        
+        return template_path if File.exists?( template_path ) 
+
+      end # each 
 
 
-          No such directory '#{@@template_path}'.
+      # could not find 
+      
+      raise <<-eos
+
+          No such template '#{name}' found in directories #{@template_paths.join(", ")}
  
-          Use opition -t to point to an existing directory.
+          Use opition -g list directories or Gems, where file '#{name}.#{@template_extension}' can be located.
         
         eos
-      end
 
-      template_path = "#{@@template_path}/#{name}.#{@@template_extension}"
-      @logger.info( "#{__FILE__}.#{__method__} read template_path=#{template_path}" )
 
-      if !  File.exists?( template_path ) then
+    end
+
+    # return path to 'template_file' in an existing 'directory'
+    def get_template_filepath_in_directory( directory, template_file ) 
+      @logger.debug( "#{__method__} directory=#{directory}, template_file=#{template_file}" )
+
+      if ! File.exists?( directory ) then
         raise <<-eos
 
-          No such file  '#{template_path}'.
+          No such directory '#{directory}'.
  
-          Use opition -t to point to a directory, which contains file '#{name}.#{@@template_extension}'
-
+          Option -g should list
+          - existing paths OR
+          - Gems which includes 'mustache' directory
         
         eos
+
       end
 
+      template_path = "#{directory}/#{template_file}.#{@template_extension}"
+      @logger.info( "#{__method__} read template_path=#{template_path}" )
+      
+      return template_path
 
-      File.read( template_path )
     end
 
+
   end # class
 
 end # module

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-must
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - jarjuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2015-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '0.18'
 description: |
   aws-must is a tool, which allows separating infrastructure
   configuration and Amazon related syntax using YAML and Mustache templates