thot 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a6bb1b17f33806eecd83ba7697b0e66a311772fdf0b368cfc307bddf6c74ee3
-  data.tar.gz: 12cba548403a8cf9ab2edee54a7a8f4567bd612367b798a3138468c185462b59
+  metadata.gz: 57ada5bc80f13298187297034ec1b9c754cdf0cd2313bd5a2674f8bc8ad2f165
+  data.tar.gz: '0961751bbb5709516c88958ee50fee4e62c0802a9ce7b0d58c72bf1a2d544b1a'
 SHA512:
-  metadata.gz: 73592234300f96931e105eab69a0dfa71b6817e23e12736485c1529b8105af86fe8765a585b80b2ca950a206661e78f8d625433de8c98b9d054b97cb94ac43e4
-  data.tar.gz: 22236a2db50ad40e55761e24068788a8b17f6356bff00050b6b40263f708c3015979a35e6e4e9c3c4b54341f9a7d4df2088c2b8836dc04822c3051dbc7e5cd39
+  metadata.gz: bb39588c702fbc6ba92ffb46cc16dff45401f18bd8e82c68e10639f242b0ff571b3119b0ba3be83b83f212dffd6b354cfa1519a13603bba0a32e50e3da1d379f
+  data.tar.gz: a6533192e004e53ea6a9f456a60f11b72fa4e57ff7c9840a19b7e75f7846fa9a8477560f0655f5d2c1ad5d9f3898e4c05c5a52e23124a3f4b9e808a519117782

data/README.md

@@ -18,9 +18,150 @@ Or install it yourself as:
 
     $ gem install thot
 
+
+## Principe
+
+Thot is a simple templating tool, with :
+- 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
+
+- with data :  <pre>{name: 'Romain'}</pre>
+- and template content : "Hello %%NAME%% !"
+
+Thot simply generate :
+   'Hello Romain !'
+
+### 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%% !"
+
+Thot generate :
+   "Hello Romain GEORGES your nickname is : Ruydiaz !"
+
+
+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.  
+
+
 ## Usage
 
-TODO: Write usage instructions here
+Thot is already a library for you usage and a CLI. 
+
+###  Ruby Library usage
+
+you could use Thot in your Ruby code :
+
+#### Strict mode and accessor input
+
+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
+   require 'thot'
+   include Thot
+   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
+
+```ruby
+   require 'thot'
+   include Thot
+   template = Template::new list_token: [:name, :surname] , template_content: 'Hello %%NAME !!'
+   template.name = 'Romain'
+   puts template.output
+````
+
+return
+
+    Hello Romain !!
+
+#### 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.map {name: 'Romain', surname: 'Georges' }
+   puts template.output
+````
+
+return
+
+   Hello Romain !!
+
+
+
+###   CLI usage
+
+Thot come with a CLI for templating :
+- reading from STDIN or list files arguments
+- getting values from variables file by argument [MANDATORY]  --env-var-file FILENAME
+- display output on STDOUT
+- verbose mode on STDERR if -v options.
+
+Note : CLI work only strict mode false, you could have unused keys in datas. 
+
+#### Pre-requisites
+
+* a file 'template.txt' with : "Hello %%NAME%% !!"
+* a variables file with lines, like :
+```
+    key=value
+    key = value
+      key = value
+    # comments and other lines are ignored
+```
+
+sample, env.test: 
+
+```
+    name=Romain
+```
+
+In the same path
+
+#### STDIN from echo
+
+```
+    $ echo "Hello %%NAME%% !!" |thot -e env.test
+```
+
+#### STDIN from input
+
+```
+    $ thot -e env.test < template.txt
+```
+
+#### Files list 
+
+```
+    $ thot -e env.test template1.txt template2.txt
+```
+
+#### Typical usage
+
+```
+    $ thot -e env.test < template.txt > output.txt
+```
+
+###
+
 
 ## Development
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/exe/thot

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+
+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
+
+
+
+
+
+
+

data/lib/thot/cli.rb

@@ -0,0 +1,63 @@
+module Thot
+  class CLI
+
+    def initialize(options: , list_templates_file: nil )
+      @list_templates_file = list_templates_file
+      @options = options
+      getting_data
+      getting_content
+    end
+
+
+    def generate
+      template =  Template::new(list_token: @data.keys, template_content: @content, strict: false)
+      template.map @data
+      STDERR.puts "Generating output" if @options[:verbose]
+      puts template.output
+    end
+
+     private
+
+     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])
+       else
+         raise "Environment variables file argument missing, (--env-var-file) "
+       end
+     end
+
+     def getting_content
+        @content = ""
+       if @list_templates_file.empty?
+         STDERR.puts "Reading content from STDIN" if @options[:verbose]
+         @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
+       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
+     end
+
+  end
+end

data/lib/thot.rb

@@ -17,16 +17,24 @@ module Thot
     attr_reader :content
     
     # constructor : generate the pseudo accessor for template Class from token list
-    def initialize(template_file: , list_token: , strict: true)
+    def initialize(template_file: nil, list_token: , strict: true, template_content: nil)
       
       @result = ""
-      @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('No template file found')
+      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
@@ -65,7 +73,6 @@ module Thot
         raise ArgumentError::new("#{item} : Not a String") unless val.class == String
         _data[item.to_s.downcase] = val
       }
-      raise InvalidTokenList::new("Token list malformation") unless _data.keys.sort == @list_token.map{|_token| _token.to_s }.sort
       @hash_token = _data
     end
     
@@ -81,7 +88,7 @@ module Thot
       @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])
+        @result.gsub!(/%%#{_token.to_s.upcase}%%/,@hash_token[_token.to_s]) if @hash_token.include? _token.to_s
       }
       return @result
     end

data/samples/.env.prod

@@ -0,0 +1,3 @@
+# test
+name=romain
+surname = georges

data/samples/template.txt

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

data/samples/template2.txt

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Romain GEORGES
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-16 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -125,7 +125,8 @@ dependencies:
 description: the simpliest way to template in Ruby and command
 email:
 - gems@ultragreen.net
-executables: []
+executables:
+- thot
 extensions: []
 extra_rdoc_files: []
 files:
@@ -139,8 +140,13 @@ files:
 - VERSION
 - bin/console
 - bin/setup
+- exe/thot
 - lib/thot.rb
+- lib/thot/cli.rb
 - lib/thot/version.rb
+- samples/.env.prod
+- samples/template.txt
+- samples/template2.txt
 - thot.gemspec
 - ultragreen_roodi_coding_convention.yml
 homepage: https://github.com/Ultragreen/thot
@@ -148,7 +154,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Ultragreen/thot
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -163,8 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: THe Operative Templating
 test_files: []