thot 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57ada5bc80f13298187297034ec1b9c754cdf0cd2313bd5a2674f8bc8ad2f165
-  data.tar.gz: '0961751bbb5709516c88958ee50fee4e62c0802a9ce7b0d58c72bf1a2d544b1a'
+  metadata.gz: 8f6c6ae92314f63db63bf820e0256e0592733b7d0c0d57187d50926baefb82e0
+  data.tar.gz: 27a167400f4ece2859aafb3f0b159aca3ab5193fc7087336c6fe3b084a7d10a0
 SHA512:
-  metadata.gz: bb39588c702fbc6ba92ffb46cc16dff45401f18bd8e82c68e10639f242b0ff571b3119b0ba3be83b83f212dffd6b354cfa1519a13603bba0a32e50e3da1d379f
-  data.tar.gz: a6533192e004e53ea6a9f456a60f11b72fa4e57ff7c9840a19b7e75f7846fa9a8477560f0655f5d2c1ad5d9f3898e4c05c5a52e23124a3f4b9e808a519117782
+  metadata.gz: 6a5102b7469e1ac351626ae1efc577aaf5249b0c4ce5f3d0d48136dc1be11bf9bca4cb4ce0ee4fbfb10e8aa03dfda05f7ebbdda90a3e4a44e9253c2f9b4212fe
+  data.tar.gz: 2e73db783b15bf08c1660ea387402a39ff44079cbd05b25feca19ae5db83d23a7a7e6f3467c9ff96094fe3d6a07be9c32afe3a2c3bcdc79e03e65a9782890e8d

data/.github/workflows/ruby.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/Gemfile

@@ -2,4 +2,3 @@ source "https://rubygems.org"
 
 gemspec
 
-

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Pierre Alphonse
+Copyright (c) 2022 Romain GEORGES
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,6 +2,26 @@
 
 Thot is THe Operative Templating : the simpliest solution for Ruby and command to templatize
 
+![GitHub](https://img.shields.io/github/license/Ultragreen/thot)
+
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-brightgreen)](https://rubydoc.info/gems/thot)
+![GitHub issues](https://img.shields.io/github/issues/Ultragreen/thot)
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Ultragreen/thot)
+![GitHub top language](https://img.shields.io/github/languages/top/Ultragreen/thot)
+![GitHub milestones](https://img.shields.io/github/milestones/open/Ultragreen/thot)
+
+![Gem](https://img.shields.io/gem/dt/thot)
+[![Gem Version](https://badge.fury.io/rb/thot.svg)](https://badge.fury.io/rb/thot)
+![Twitter Follow](https://img.shields.io/twitter/follow/Ultragreen?style=social)
+![GitHub Org's stars](https://img.shields.io/github/stars/Ultragreen?style=social)
+![GitHub watchers](https://img.shields.io/github/watchers/Ultragreen/thot?style=social)
+
+<noscript><a href="https://liberapay.com/ruydiaz/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>
+
+
+![Thot logo](assets/images/logo_thot_full_large.png) 
+_The Operative Templating_
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,14 +42,20 @@ Or install it yourself as:
 ## Principe
 
 Thot is a simple templating tool, with :
-- a template including token, like : %%TOKEN_NAME%% => Token MUST be in uppercase
+- a template including token, like : **%%TOKEN_NAME%%** => Token MUST be in uppercase
 - a hash of data (symbols as keys) corresponding, like : <pre>{token_name: 'value'}</pre>  
 It could generate an output.
 
-### Usecase
+From versions upper than 1.2.0, Thot support token syntax like **{{TOKEN_NAME}}**
+
+### Global synoptic
+
+![synoptic](assets/images/description_thot.png) 
+
+### Simple usecase
 
 - with data :  <pre>{name: 'Romain'}</pre>
-- and template content : "Hello %%NAME%% !"
+- and template content : "Hello **%%NAME%%** !"
 
 Thot simply generate :
    'Hello Romain !'
@@ -37,31 +63,68 @@ Thot simply generate :
 ### Advanced usecase 
 
 - with data :  <pre>{firstname: 'romain', name: 'georges', nickname: 'zaidyur'}</pre>
-- and template content : "Hello %%FIRSTNAME.capitalize%% %%NAME.upcase%%  your nickname is : %%NICKNAME.reverse.capitalize%% !"
+- and template content : "Hello **%%FIRSTNAME.capitalize%%** **%%NAME.upcase%%**  your nickname is : **%%NICKNAME.reverse.capitalize%%** !"
 
 Thot generate :
    "Hello Romain GEORGES your nickname is : Ruydiaz !"
 
+This usecase use filters, see it in the following chapter. 
+**Note** : Your could monkey patch String or use Refinment for implementing our own filters.  
+
+
+### Thot templating Language (TTL) reference
+
+- Token cloud be construct with {{TOKEN}} or %%TOKEN%%.
+- Token must include filtering methods : Thot actually supports String to String piped filters
+  - Filters don't support parameters
+  - Filters must be stacked seperated by '.'
+  - Filters must be in lowercase
+  - Filters must be String instance methods returning a String (Modifier)
+- Token should have default value
+- Default values don't support multiline correctly.
+
+This is some examples of correct TTL syntaxes : 
+
+With %%TOKEN%% : 
+- filters alone : %%NAME.capitalize%% 
+- stacked filters alone : %%SURNAME.upcase.reverse%%
+- token only with default value : %%TOTO(default value)%%
+- token only : %%NAME%% 
+- with filters with default value : %%TOTO.downcase(default value static)%%
+- stacked filters with default value : %%SURNAME.upcase.reverse(default)%%
 
-Thot actually supports String to String piped filters :
-- filters must be stacked seperated by '.'
-- filters must be in lowercase
-- filters must be String instance methods returning a String (Modifier)
 
-Note : Your could monkey patch String or use Refinment for implementing our own filters.  
+with {{TOKEN}} :
+- filters alone: {{NAME.capitalize}} 
+- stacked filters alone : {{SURNAME.upcase.reverse}}
+- token only with default value : {{TOTO(default value)}}
+- token only : {{NAME}}
+- with filters with default value : {{TOTO.downcase(default value static)}}
+- stacked filters with default value : {{SURNAME.upcase.reverse(default)}}
+
 
 
 ## Usage
 
-Thot is already a library for you usage and a CLI. 
+Thot is a library for you usage AND a CLI tool. 
 
 ###  Ruby Library usage
 
+
+#### Thot::Template
+
+
+##### Synoptic
+
+![synoptic](assets/images/description_thot_template.png) 
+
 you could use Thot in your Ruby code :
 
-#### Strict mode and accessor input
+##### Examples 
+
+###### Strict mode and accessor input
 
-Note : Considering 'template.txt' with : 'Hello %%NAME !!'
+Note : Considering 'template.txt' with : 'Hello **%%NAME%%** !!'
 Note : in strict mode if the Tokens in template file don't match exactly the given token list, Thot raise an exception.  
 
 ```ruby
@@ -70,56 +133,179 @@ Note : in strict mode if the Tokens in template file don't match exactly the giv
    template = Template::new list_token: [:name] , template_file: './template.txt'
    template.name = 'Romain'
    puts template.output
-````
+```
 
 return
 
    Hello Romain !!
 
 
-#### Strict mode false with accesor input and template_content
+###### Strict mode false with accesor input and template_content
 
 ```ruby
    require 'thot'
    include Thot
-   template = Template::new list_token: [:name, :surname] , template_content: 'Hello %%NAME !!'
+   template = Template::new list_token: [:name, :surname] , template_content: 'Hello %%NAM%% !!'
    template.name = 'Romain'
    puts template.output
-````
+```
 
 return
 
     Hello Romain !!
 
-#### Strict mode false with map input and template_content
+###### Strict mode false with map input and template_content
 
 ```ruby
    require 'thot'
    include Thot
-   template = Template::new list_token: [:name, :surname] , template_content: 'Hello %%NAME !!'
+   template = Template::new list_token: [:name, :surname] , template_content: 'Hello %%NAME%% !!'
    template.map {name: 'Romain', surname: 'Georges' }
    puts template.output
-````
+```
 
 return
 
    Hello Romain !!
 
+#### Thot::Varfiles
+
+
+##### Synoptic
+
+![synoptic](assets/images/description_thot_varfiles.png) 
+
+##### Example 
+
+###### File format
+
+**Note** : format support is the same for .thot.env files AND given files.
+
+Varfiles support both INI and flat format, like :
+
+for flat : 
+
+```
+    key=value
+    key = value
+      key = value
+    # comments and other lines are ignored
+```
+
+for INI :
+
+```
+    key=value
+    key = value
+      key = value
+    # comments and other lines are ignored
+
+    [EVT]
+    key=value
+    key = value
+      key = value
+    # comments and other lines are ignored
+```
+
+**Note** : section are overrides of global values
 
+###### Sample files for examples
+
+./.thot.env file :
+
+```
+    key=first value
+    key2=first value 
+```
+
+
+Given file : "/path/to/myfile.ini"
+
+```
+    key=value
+   
+    [development]
+    key=dev value
+
+    [staging]
+    key=staging value
+    
+```
+###### For :developement evt, without changing dotfiles preloaded.
+
+
+
+```ruby
+   require 'thot'
+   include Thot
+   vars = Varfiles::new varfile: "/path/to/myfile.ini"
+   pp vars.data  
+```
+
+output 
+
+   {key: "dev value", key2: "first value"}
+
+###### For :staging evt, without changing dotfiles preloaded.
+
+
+
+```ruby
+   require 'thot'
+   include Thot
+   vars = Varfiles::new varfile: "/path/to/myfile.ini", environment: :staging
+   pp vars.data  
+```
+
+output 
+
+   {key: "staging value", key2: "first value"}
+
+
+###### For :staging evt, changing dotfiles.
+
+**Note** : default dotfiles priority is : ["~/.thot.env","./.thot.env"]
+
+
+
+```ruby
+   require 'thot'
+   include Thot
+   vars = Varfiles::new varfile: "/path/to/myfile.ini", environment: :staging, dotfiles: []
+   pp vars.data  
+```
+
+output 
+
+   {key: "staging value"}
 
 ###   CLI usage
 
-Thot come with a CLI for templating :
+Thot come with a CLI for templating, you could :
 - reading from STDIN or list files arguments
-- getting values from variables file by argument [MANDATORY]  --env-var-file FILENAME
+- getting values from variables file by argument   --env-var-file, -f FILENAME or from Thot Varfile, see after
 - display output on STDOUT
 - verbose mode on STDERR if -v options.
+- defining environment with --environment, -e ENV (efault environement is :development)
+- debug mode on STDERR if -d options (cumulative with verbose).
+
+Note : the Thot CLI look for ~/.thot.env file or ./.thot.env file
+
+This file support INI format or flat format, keys in INI format are used for environment override
+
+
+
+Note : CLI work only strict mode false, you could have unused keys in datas and undefined value for tokens (substitute by ''). 
+
+Order for variable priorities :
+- ~/.thot.env
+- ./.thot.env
+- file passed by --env-var-file
 
-Note : CLI work only strict mode false, you could have unused keys in datas. 
 
 #### Pre-requisites
 
-* a file 'template.txt' with : "Hello %%NAME%% !!"
+* a file 'template.ttl' with : "Hello **%%NAME%%** !!"
 * a variables file with lines, like :
 ```
     key=value
@@ -139,25 +325,19 @@ In the same path
 #### STDIN from echo
 
 ```
-    $ echo "Hello %%NAME%% !!" |thot -e env.test
+    $ echo "Hello %%NAME%% !!" |thot -f env.test
 ```
 
 #### STDIN from input
 
 ```
-    $ thot -e env.test < template.txt
-```
-
-#### Files list 
-
-```
-    $ thot -e env.test template1.txt template2.txt
+    $ thot -f env.test < template.ttl
 ```
 
 #### Typical usage
 
 ```
-    $ thot -e env.test < template.txt > output.txt
+    $ thot -f env.test < template.ttl > output.txt
 ```
 
 ###

data/Rakefile

@@ -32,3 +32,18 @@ namespace :yardoc do
     end
 end
 task :clobber => "yardoc:clobber"
+
+desc "Run CVE security audit over bundle"
+task :audit do
+  system('bundle audit')
+end
+
+desc "Run dead line of code detection"
+task :debride do
+  system('debride -w .debride_whitelist .')
+end
+
+desc "Run SBOM CycloneDX Xml format file"
+task :sbom do
+  system('cyclonedx-ruby -p .')
+end

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.1

data/exe/thot

@@ -1,30 +1,57 @@
 #!/usr/bin/env ruby
 
 
+require 'carioca'
+
+Carioca::Registry.configure do |spec|
+  spec.debug = false
+  spec.init_from_file = false
+  spec.output_mode = :mono
+  spec.output_emoji = true
+  spec.output_colors = true
+  spec.output_target = STDERR
+ end
+
 require 'optparse'
 require 'thot'
 require 'thot/cli'
 
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: thot [options]"
-  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    options[:verbose] = v
-  end
-  opts.on("-eFILENAME", "--env-var-file=FILENAME", "[MANDATORY] Environment variables file (key=value pairs by line)") do |file|
-    options[:env_var_file] = file
-  end
-end.parse!
-
-list_input = ARGV.dup
-ARGV.clear
-
-
-include Thot
-
-cli = CLI::new options: options,  list_templates_file: list_input
-cli.generate
+output  = Carioca::Registry::init.get_service name: :output
 
+options = {}
+options[:environment] = :development
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: thot [options]"
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      options[:verbose] = v
+    end
+    opts.on("-d", "--[no-]debug", "Run on debug") do |d|
+      options[:debug] = d
+    end
+    opts.on("-f FILENAME", "--env-var-file=FILENAME", "Environment variables file (key=value pairs by line)") do |file|
+      options[:env_var_file] = file
+    end
+    opts.on("-e ENVIRONMENT", "--environment=ENVIRONMENT", "Environment name") do |evt|
+      options[:environment] = evt
+    end
+  end.parse!
+
+  list_input = ARGV.dup
+  ARGV.clear
+
+  include Thot
+  cli = CLI::new options: options,  template_file: list_input.first
+  cli.generate
+rescue Interrupt => e
+  output.error "Execution interrupted"
+rescue SignalException => e
+  output.error "Execution interrupted"
+rescue Exception => e
+  output.error "Execution error : #{e.message}"
+rescue OptionParser::MissingArgument => e
+  output.error "incorrect usage : #{e.message}"
+end
 
 
 

data/lib/dependencies.rb

@@ -0,0 +1,11 @@
+
+# gems 
+require 'inifile'
+
+
+# internals
+require_relative 'thot/version'
+require_relative 'thot/tokenizer'
+require_relative 'thot/processor'
+require_relative 'thot/template'
+require_relative 'thot/varfiles'

data/lib/thot/cli.rb

@@ -1,9 +1,18 @@
+
+
+
 module Thot
-  class CLI
+  class CLI < Carioca::Container
+
+    inject service: :output
+
+    def initialize(options: , template_file: nil )
 
-    def initialize(options: , list_templates_file: nil )
-      @list_templates_file = list_templates_file
       @options = options
+      output.level = (@options[:debug])? :debug : :info
+      output.debug "Debugging mode activated" if @options[:debug]
+      @template_file = template_file
+      output.info "Assuming Environment : #{@options[:environment]}" if @options[:verbose]
       getting_data
       getting_content
     end
@@ -12,7 +21,7 @@ module Thot
     def generate
       template =  Template::new(list_token: @data.keys, template_content: @content, strict: false)
       template.map @data
-      STDERR.puts "Generating output" if @options[:verbose]
+      output.info "Generating output" if @options[:verbose]
       puts template.output
     end
 
@@ -20,43 +29,31 @@ module Thot
 
      def getting_data
        if @options[:env_var_file] then
-         STDERR.puts "Environment file given : #{@options[:env_var_file]}" if @options[:verbose]
-         @data = read_evt_file(@options[:env_var_file])
+        output.info "Environment file given : #{@options[:env_var_file]}" if @options[:verbose]
        else
-         raise "Environment variables file argument missing, (--env-var-file) "
+        output.info "Environment variables file argument missing, (--env-var-file) " if @options[:verbose]
        end
+       @data =  Varfiles::new(environment: @options[:environment], varfile: @options[:env_var_file]).data
      end
 
      def getting_content
         @content = ""
-       if @list_templates_file.empty?
-         STDERR.puts "Reading content from STDIN" if @options[:verbose]
+       if @template_file.nil?
+        output.info "Reading content from STDIN (CTRL+D to commit)" if STDIN.tty?
+        output.info "Getting content from STDIN" if @options[:verbose] and not STDIN.tty?
          @content = ARGF.readlines.join
        else
-         STDERR.puts "Reading content from file(s) : #{@list_templates_file}" if @options[:verbose]
-         @list_templates_file.each do |item|
-           if File::exist? item
-             @content.concat(File::readlines(item).join)
-           else
-             raise "file not found #{item}"
-           end
-         end
+        output.info "Reading content from file : #{@template_file}" if @options[:verbose]
+        if File::exist? @template_file
+         @content = File::readlines(@template_file).join
+        else
+         raise "file not found #{@template_file}"
+        end
        end
      end
 
      def read_evt_file(file)
-       res = {}
-       if File::exist? file
-         content =  File::readlines(file)
-       else
-         raise "Environment variables file not found #{file}"
-       end
-       content.each do |line|
-         next if line =~ /#/
-         key,value = line.split('=')
-         res[key.strip.to_sym] = value.strip if value
-       end
-       return res
+       return 
      end
 
   end

data/lib/thot/processor.rb

@@ -0,0 +1,24 @@
+module Thot
+    class Processor
+        attr_reader :value
+        attr_reader :rule
+
+        def initialize(value: , rule:)
+            @value = value
+            @rule  = rule
+        end
+
+        def result
+            if @value.nil? then
+                result = (@rule[:default])? @rule[:default] : ''
+            else
+                result = @value
+                @rule[:filters].each do |filter|
+                    result = result.send filter.to_sym if result.respond_to? filter.to_sym
+                end
+            end
+            return result
+        end
+
+    end
+end

data/lib/thot/rake/manage.rb

@@ -0,0 +1,20 @@
+require 'rake'
+require 'rubygems'
+require 'thot'
+
+$VERBOSE = nil
+if Gem::Specification.respond_to?(:find_by_name)
+  begin
+    spec = Gem::Specification.find_by_name('thot')
+    res = spec.lib_dirs_glob.split('/')
+  rescue LoadError
+    res = []
+  end
+else
+  spec = Gem.searcher.find('carioca')
+  res = Gem.searcher.lib_dirs_for(spec).split('/')
+end
+
+res.pop
+tasks_path = res.join('/').concat('/lib/thot/rake/tasks/')
+Dir["#{tasks_path}/*.task*"].each { |ext| load ext }

data/lib/thot/rake/tasks/template.task

@@ -0,0 +1,13 @@
+namespace :thot do
+
+    desc "templatize file from ENV vars : THOT_VARFILE, THOT_TEMPLATE "
+    task :templatize do 
+
+        if ENV.include? 'THOT_VARFILE' and ENV.include? 'THOT_VARFILE'
+            system("thot -f #{ENV['THOT_VARFILE']} #{ENV['THOT_TEMPLATE']}")
+        else
+            puts 'Please precise THOT_VARFILE and THOT_TEMPLATE environment variables'
+        end
+    end
+
+end

data/lib/thot/template.rb

@@ -0,0 +1,127 @@
+# Thot base module
+module Thot
+    class Error < StandardError; end
+    
+    
+    # KISS template Engine
+    class Template
+      
+      # getter of the list of token
+      attr_reader :list_token
+      # getter of the template file
+      attr_reader :template_file
+      # getter of the flat content of the template
+      attr_reader :content
+
+  
+   
+      
+      # constructor : generate the pseudo accessor for template Class from token list
+      def initialize(template_file: nil, list_token: , strict: true, template_content: nil)
+        @myput  = Carioca::Registry::init.get_service name: :output if defined?(Carioca::Injector)
+        @result = ""
+        if template_file
+          @template_file = template_file
+          raise NoTemplateFile::new('No template file found') unless File::exist?(@template_file)
+          begin
+            @content = IO::readlines(@template_file).join.chomp
+          rescue
+            raise NoTemplateFile::new('Template file read error')
+          end
+        elsif template_content
+          @content =  template_content
+        else
+          raise NoTemplateFile::new('No template file found or template content')
+        end
+          
+        @tokenizer = Tokenizer::new string: @content ; @tokenizer.detect
+        token_from_template = @tokenizer.tokens
+       
+
+       
+        begin
+          @list_token = list_token
+          @hash_token = Hash::new; @list_token.each{|_item| @hash_token[_item.to_s] = String::new('')}
+        rescue
+          raise InvalidTokenList::new("Token list malformation")
+        end
+        if strict
+          raise InvalidTokenList::new("Token list doesn't match the template") unless token_from_template.sort == @list_token.sort
+        end
+        if @myput then
+          if @myput.level == :debug then 
+            @myput.debug "Template :"
+              @content.split("\n").each  do |line|
+                @myput.debug "  #{line}"
+              end
+          end
+        end
+        @list_token.each do |_token|
+          self.instance_eval do
+            define_singleton_method(:"#{_token}=") {|_value| raise ArgumentError::new('Not a String') unless _value.class == String; @hash_token[__callee__.to_s.chomp('=')] = _value }
+            define_singleton_method(_token.to_sym) { return @hash_token[__callee__.to_s]  }
+          end
+        end
+        
+      end
+      
+      # generic accessor
+      # @param [Symbol] _token in the token list
+      # @param [String] _value a text value
+      # @raise [ArgumentError] if _valu is not a String
+      def token(_token,_value)
+        raise ArgumentError::new('Not a String') unless _value.class == String
+        @hash_token[_token.to_s] = _value
+      end
+      
+      # map a hash against templates token_list
+      # @param [Hash] _hash a hash data to map
+      def map(_hash)
+        _data = {}
+        _hash.each { |item,val|
+          raise ArgumentError::new("#{item} : Not a String") unless val.class == String
+          _data[item.to_s.downcase] = val
+        }
+        @hash_token = _data
+      end
+      
+      # collector for pseudo accessor to prevent bad mapping
+      # @raise [NotAToken] if caling an accessor not mapped in token list
+      def method_missing(_name,*_args)
+        raise NotAToken
+      end
+      
+      # the templater himself : proceed to templating
+      # @return [String] the template output
+      def output
+        @result = @content
+
+        @tokenizer.definitions.each do |item, rule|
+          @result.gsub!(item, Thot::Processor::new(value:  @hash_token[rule[:key].downcase], rule: rule).result)
+        end
+
+        if @myput then
+          if @myput.level == :debug then 
+            @myput.debug "Output :"
+              @result.split("\n").each  do |line|
+                @myput.debug "  #{line}"
+              end
+          end
+        end
+        return @result
+      end
+      
+    end
+    
+    # Exception for an invalid Token list
+    class InvalidTokenList < Exception; end
+      # Exception for an malformed token
+    class NotAToken < Exception; end
+    # Exception for an invalid template file
+    class NoTemplateFile < Exception; end
+    
+  end
+  
+  
+      
+  

data/lib/thot/tokenizer.rb

@@ -0,0 +1,39 @@
+module Thot 
+    class Tokenizer
+
+        attr_reader :string
+        attr_reader :tokens
+        attr_reader :definitions 
+    
+        def initialize(string: )
+            @string = string
+            @definitions = {}
+            @tokens = []
+        end
+    
+        def detect
+            detected = @string.scan(/%%[^\%]*%%/).concat @string.scan(/\{\{[^\}]*\}\}/)
+            detected.each  do |token|
+                key,*rest = token[2,(token.length - 4)].split('.')
+                filters = []; default = nil
+                if key =~ /(.*)\((.*)\)/ then
+                    key = $1
+                    default = $2
+                end
+                rest.each {|item|
+                     if item =~ /(.*)\((.*)\)/ then 
+                        filters.push $1  
+                            default = $2 
+    
+                    else
+                        filters.push item
+                     end
+                    }
+                @tokens.push key unless @tokens.include? key
+                @definitions[token] = {key: key, filters: filters , default: default }
+            end
+            @tokens.map!(&:downcase)
+            @tokens.map!(&:to_sym)
+        end
+    end
+end

data/lib/thot/varfiles.rb

@@ -0,0 +1,33 @@
+module Thot 
+    class Varfiles
+        
+        extend Carioca::Injector if defined?(Carioca::Injector)
+        attr_reader :data
+        inject service: :output if self.respond_to? :inject
+        
+        def initialize(varfile: nil, environment: nil, dotfiles: ["./.thot.env","~/.thot.env"])
+            @name = self.class
+            @data = {}
+            scanned_files = dotfiles
+            scanned_files.push varfile unless varfile.nil?
+            scanned_files.each do |file|
+                real_file = File.expand_path(file)
+                if File::exists? real_file then
+                    output.debug "Negociated files : #{real_file}, merging..." if self.respond_to?(:output)
+                    datafile = IniFile.load(real_file)
+                    @data.merge! datafile["global"]
+                    @data.merge! datafile[environment] if datafile.sections.include? environment.to_s
+                end
+            end
+            @data.transform_keys!(&:to_sym)
+            if self.respond_to?(:output) then
+                if output.level == :debug then 
+                    output.debug "merged data:"
+                    @data.each  do |key,val|
+                        output.debug "* #{key} = #{val}"
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/thot.rb

@@ -1,125 +1,3 @@
 # coding: utf-8
-require "thot/version"
+require_relative "dependencies"
 
-# Thot base module
-module Thot
-  class Error < StandardError; end
-  
-  
-  # KISS template Engine
-  class Template
-    
-    # getter of the list of token
-    attr_reader :list_token
-    # getter of the template file
-    attr_reader :template_file
-    # getter of the flat content of the template
-    attr_reader :content
-    
-    # constructor : generate the pseudo accessor for template Class from token list
-    def initialize(template_file: nil, list_token: , strict: true, template_content: nil)
-      
-      @result = ""
-      if template_file
-        @template_file = template_file
-        raise NoTemplateFile::new('No template file found') unless File::exist?(@template_file)
-        begin
-          @content = IO::readlines(@template_file).join.chomp
-        rescue
-          raise NoTemplateFile::new('Template file read error')
-        end
-      elsif template_content
-        @content =  template_content
-      else
-        raise NoTemplateFile::new('No template file found or template content')
-      end
-        
-      
-      token_from_template = @content.scan(/%%(\w+)%%/).flatten.uniq.map{ |item| item.downcase.to_sym}
-      begin
-        @list_token = list_token
-        @hash_token = Hash::new; @list_token.each{|_item| @hash_token[_item.to_s] = String::new('')}
-      rescue
-        raise InvalidTokenList::new("Token list malformation")
-      end
-      if strict
-        raise InvalidTokenList::new("Token list doesn't match the template") unless token_from_template.sort == @list_token.sort
-      else
-        raise InvalidTokenList::new("Token list doesn't match the template") unless (token_from_template.sort & @list_token.sort) == token_from_template.sort
-      end
-      @list_token.each do |_token|
-        self.instance_eval do
-          define_singleton_method(:"#{_token}=") {|_value| raise ArgumentError::new('Not a String') unless _value.class == String; @hash_token[__callee__.to_s.chomp('=')] = _value }
-          define_singleton_method(_token.to_sym) { return @hash_token[__callee__.to_s]  }
-        end
-      end
-      
-    end
-    
-    # generic accessor
-    # @param [Symbol] _token in the token list
-    # @param [String] _value a text value
-    # @raise [ArgumentError] if _valu is not a String
-    def token(_token,_value)
-      raise ArgumentError::new('Not a String') unless _value.class == String
-      @hash_token[_token.to_s] = _value
-    end
-    
-    # map a hash against templates token_list
-    # @param [Hash] _hash a hash data to map
-    def map(_hash)
-      _data = {}
-      _hash.each { |item,val|
-        raise ArgumentError::new("#{item} : Not a String") unless val.class == String
-        _data[item.to_s.downcase] = val
-      }
-      @hash_token = _data
-    end
-    
-    # collector for pseudo accessor to prevent bad mapping
-    # @raise [NotAToken] if caling an accessor not mapped in token list
-    def method_missing(_name,*_args)
-      raise NotAToken
-    end
-    
-    # the templater;proceed to templating
-    # @return [String] the template output
-    def output
-      @result = @content
-      @list_token.each{|_token|
-        self.filtering  @content.scan(/%%(#{_token.to_s.upcase}[\.\w+]+)%%/).flatten
-        @result.gsub!(/%%#{_token.to_s.upcase}%%/,@hash_token[_token.to_s]) if @hash_token.include? _token.to_s
-      }
-      return @result
-    end
-
-    private
-
-    def filtering(list)
-      @filtered_tokens = {}
-      list.each do |pipe|
-        token, *filters = pipe.split('.')
-        @filtered_tokens[pipe] = @hash_token[token.downcase]
-        filters.each do |filter|
-          @filtered_tokens[pipe] = @filtered_tokens[pipe].send filter.to_sym if @filtered_tokens[pipe].respond_to? filter.to_sym
-        end
-      end
-      @filtered_tokens.each do |item,value|
-        @result.gsub!(/%%#{item}%%/,value)
-      end
-    end
-    
-    
-  end
-  
-  # Exception for an invalid Token list
-  class InvalidTokenList < Exception; end
-    # Exception for an malformed token
-  class NotAToken < Exception; end
-  # Exception for an invalid template file
-  class NoTemplateFile < Exception; end
-  
-end
-
-
-    

data/samples/.thot.env

@@ -0,0 +1,5 @@
+var1 = global
+var2 = global
+
+[development]
+var1 = local

data/samples/template.ttl

@@ -0,0 +1,21 @@
+With %
+filters alone : %%NAME.capitalize%% %%SURNAME.upcase%%
+stacked filters alone : %%SURNAME.upcase.reverse%%
+no tokens
+empty with default value : %%TOTO(default value)%%
+only defined token : %%NAME%%
+empty with filters with default value : %%TOTO.downcase(default value static)%%
+empty : %%TOTO%%
+defined stacked filters with default value : %%SURNAME.upcase.reverse(default)%%
+empty stacked filters with default value : %%TOTO.upcase.reverse(default)%%
+
+with {
+filters alone: {{NAME.capitalize}} {{SURNAME.upcase}}
+stacked filters alone : {{SURNAME.upcase.reverse}}
+no tokens 
+empty with default value : {{TOTO(default value)}}
+only defined token : {{NAME}}
+empty with filters with default value : {{TOTO.downcase(default value static)}}
+empty : {{TOTO}}
+defined stacked filters with default value : {{SURNAME.upcase.reverse(default)}}
+empty stacked filters with default value : {{TOTO.upcase.reverse(default)}}

data/thot.gemspec

@@ -22,12 +22,20 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_dependency "carioca", "~> 2.1"
+  spec.add_dependency "inifile", "~> 3.0"
+
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.32'
+  spec.add_development_dependency 'rubocop', '~> 1.54'
   spec.add_development_dependency "roodi", "~> 5.0"
   spec.add_development_dependency 'code_statistics', '~> 0.2.13'
   spec.add_development_dependency "yard", "~> 0.9.27"
   spec.add_development_dependency "yard-rspec", "~> 0.1"
   spec.add_development_dependency'version', '~> 1.1'
+
+  spec.add_development_dependency "bundle-audit", "~> 0.1.0"
+
+  spec.add_development_dependency "cyclonedx-ruby", "~> 1.1"
+  spec.add_development_dependency "debride", "~> 1.12"
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: thot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: carioca
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.54'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.54'
 - !ruby/object:Gem::Dependency
   name: roodi
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +150,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: cyclonedx-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: debride
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
 description: the simpliest way to template in Ruby and command
 email:
 - gems@ultragreen.net
@@ -130,6 +200,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -138,17 +209,29 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- assets/images/description_thot.png
+- assets/images/description_thot_template.png
+- assets/images/description_thot_varfiles.png
+- assets/images/logo_thot_full_large.png
+- assets/images/logo_thot_light_large.png
+- assets/images/logo_thot_normal_large.png
 - bin/console
 - bin/setup
 - exe/thot
+- lib/dependencies.rb
 - lib/thot.rb
 - lib/thot/cli.rb
+- lib/thot/processor.rb
+- lib/thot/rake/manage.rb
+- lib/thot/rake/tasks/template.task
+- lib/thot/template.rb
+- lib/thot/tokenizer.rb
+- lib/thot/varfiles.rb
 - lib/thot/version.rb
 - samples/.env.prod
-- samples/template.txt
-- samples/template2.txt
+- samples/.thot.env
+- samples/template.ttl
 - thot.gemspec
-- ultragreen_roodi_coding_convention.yml
 homepage: https://github.com/Ultragreen/thot
 licenses:
 - MIT

data/samples/template.txt

@@ -1 +0,0 @@
-Hello %%NAME.capitalize%% %%SURNAME.upcase%% !! 

data/samples/template2.txt

@@ -1 +0,0 @@
-Hello %%NAME.capitalize%% %%SURNAME.upcase%% !! 

data/ultragreen_roodi_coding_convention.yml

@@ -1,24 +0,0 @@
-AssignmentInConditionalCheck:
-CaseMissingElseCheck:
-ClassLineCountCheck:             
-  line_count: 300 # including comments yard
-ClassNameCheck:                  
-  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
-#ClassVariableCheck:
-CyclomaticComplexityBlockCheck:  
-  complexity: 5
-CyclomaticComplexityMethodCheck: 
-  complexity: 10
-EmptyRescueBodyCheck:
-ForLoopCheck:
-MethodLineCountCheck:            
-  line_count: 30
-MethodNameCheck:                 
-  pattern: !ruby/regexp /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ 
-# MissingForeignKeyIndexCheck:
-ModuleLineCountCheck:            
-  line_count: 300
-ModuleNameCheck:          
-  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
-ParameterNumberCheck:            
-  parameter_count: 5