signature_generator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f7bf9f84d0258e6fc0eaac70bf19a65a1c3093f
-  data.tar.gz: 902bc3dab4a1809e7c090c9033058c40b63e52c7
+  metadata.gz: 3c8de23633f2e0983ed395fe8b16d78a0ec1bdd8
+  data.tar.gz: 48f34f59ea6369118415fc4a009791c5a7b76e75
 SHA512:
-  metadata.gz: 2290c0db425a9b29f1914d8dfc5a3ad86f9fc4c5b573372e173d06a3b8df55cfe91c1da50ff13069b9ce32e792d33feea40cfe0427d3d72944c35afbd5faa59a
-  data.tar.gz: 20f1e4f3bbf1067ae0438dc2ef8dc4424b58fefccd148920b234da2b2314ef1b6f5c80d08e6697a59a0d8eaf5daec2e0e86fcb5ba819da8c89e1dbf559e2d7fb
+  metadata.gz: 0a0230c4e62a5d992df66f5c00866aa3a0535cc39d0de29c838d0bec9809463aeece7d39b4321dc77a03f22eb023010398b986c81ca520ae67e9cced52b025a1
+  data.tar.gz: c07e76de765c3cbb43b02df6bf85ed22f12ae96e090ce4a4ce32e93e595d7ea09b2eae97bd01aac50f01e285978de4cfb743cd051f98b06e56c1fb847d860f77

data/README.md

@@ -3,9 +3,12 @@
 [![Build Status](https://travis-ci.org/lbriais/signature_generator.svg)](https://travis-ci.org/lbriais/signature_generator)
 [![Gem Version](https://badge.fury.io/rb/signature_generator.svg)](http://badge.fury.io/rb/signature_generator)
 
+The goal of this Ruby Gem is to provide a simple script to manage company email staff signatures consistently
+by providing a simple ERB-based templating mechanism to generate actual employee signature. 
 
-This gem provides the `sg` executable to generate signature files from templates.
-Variables used in the template, can be provided at run-time either by:
+
+This gem provides the `sg` executable to generate signature file from template.
+Any undefined variable used in the ERB template has to be provided at run-time either by:
 
 * Providing values on command line
 * Providing values in config file

data/exe/sg

@@ -34,6 +34,9 @@ module SignatureGenerator
         slop.on :f, :'template-file', 'Specify the signature template file. Default is STDIN.', argument: true, as: String
         slop.on :o, :'output-file', 'Specify the output file for the signature. Default is STDOUT.', argument: true, as: String
         slop.on :force, 'Force overwriting output file.', argument: false
+        slop.on :'max-retry',
+                "Number of times retrying is allowed when prompted for values. Default is #{SignatureGenerator::Processor::MAX_RETRY}.",
+                argument: true, as: Integer
         slop.on :var=, 'Define variables in the form name=value', argument: true, as: Array
         slop.on :n, :'no-minify', 'Will not minify the resulting html signature. By default will do', argument: false
       end
@@ -43,7 +46,7 @@ module SignatureGenerator
       # Your code here.
       content = template_io.read
       logger.debug content
-      processor = SignatureGenerator::Processor.new context
+      processor = SignatureGenerator::Processor.new context: context, max_retry: config['max-retry']
       signature = processor.transform content
       logger.debug signature
       unless config[:'no-minify']
@@ -61,17 +64,18 @@ module SignatureGenerator
     def check_config
       # Check the config and raise an exception if incorrect.
       config[:var] ||=[]
+      # Context setup
       @context = {}
       config[:var].each do |definition|
         valid = false
-        definition.match(/^\s*(?<var_name>[a-z][a-z0-9_]*)\s*=\s*(?<var_value>.+)\s*$/) do |md|
+        definition.match(/^\s*(?<var_name>[a-z][a-z0-9_]*[!\?]?)\s*=\s*(?<var_value>.+)\s*$/) do |md|
           logger.warning "Overwriting existing variable '#{md['var_name']}' !" if context[md['var_name']]
           context[md['var_name'].to_sym] = md['var_value']
           valid = true
         end
         raise SignatureGenerator::Error, 'Invalid property specified !' unless valid
       end
-
+      # Input definition
       @template_io = case config[:'template-file']
                        when NilClass
                          logger.debug 'Template from STDIN'
@@ -83,6 +87,7 @@ module SignatureGenerator
                          logger.debug "Template from file '#{file}'"
                          io
                      end
+      # Output definition
       @output_io = case config[:'output-file']
                      when NilClass
                        logger.debug 'Signature to STDOUT'

data/lib/signature_generator/processor.rb

@@ -9,9 +9,11 @@ module SignatureGenerator
     MAX_RETRY = 3
 
     attr_reader :results, :context
+    attr_accessor :max_retry
 
-    def initialize(context={})
+    def initialize(context: {}, max_retry: MAX_RETRY)
       self.context = context
+      self.max_retry = max_retry
     end
 
     def transform(template, context = self.context)
@@ -24,7 +26,7 @@ module SignatureGenerator
         counters[missing_var] += 1
         debug_msg = "Variable not provided: #{missing_var} (attempt ##{counters[missing_var]})"
         logger.debug debug_msg
-        if counters[missing_var] > MAX_RETRY
+        if counters[missing_var] > max_retry
           logger.error 'Maximum retry number exceeded. Aborting !'
           raise e
         end

data/lib/signature_generator/version.rb

@@ -1,3 +1,3 @@
 module SignatureGenerator
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signature_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler