thot 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bc290fd549f5d8f74f3976bf295caf1948c4034c6b70b6d611481a9062d6192
-  data.tar.gz: af1047cf61a5570eb1fdb6981689bbc099fd0c01455401a6842d951b36f001f9
+  metadata.gz: 66b39148b6f0d21ab8174c953757815943eda80b28000caba1dbdd7821d12ef2
+  data.tar.gz: 5a904474b751660d49e77f1c835490b3c945dda97dc49f9d16c427db9664ecdf
 SHA512:
-  metadata.gz: b8d2156265be4a1f7521a2a05a9f928e1016e059c55451c4d7f7bc76022f7390888e8361ed6daee4111972b974c0eb06b9b2859767c28d9c8bfbdb15794ff5c0
-  data.tar.gz: cc24897736a165ee81c3e8f38ba81e5d1926768192ad08c938664e18145a2a16f00a57aa0bb3772745476a63d2c0a77b2623d1a03ba72d77c7c5c6380b036c61
+  metadata.gz: 42cb44934894d02699bcd17c3ba22c7d32b2b1effe5d4e19acdc1e6c9662c4fb623103742de2f54d375cbfbcac47086d17ffb4ca2b2771ea34cc13159be020f4
+  data.tar.gz: 77c8256484294a9e089a2b7320bdf02382600ffd62e26b4e8967843d91710ad3a23dca2d4cce7b127e49b2126ce0150544604455aaaea727cc975a3d85dc52dd

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 @@
-0.1.0
+1.0.1

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: example.rb [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,62 @@
+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
+       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)
       
-      
-      @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')
+      @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
@@ -39,8 +47,13 @@ module Thot
       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{|_token| eval("def #{_token}=(_value); raise ArgumentError::new('Not a String') unless _value.class == String; @hash_token['#{_token}'] = _value ;end")}
-      @list_token.each{|_token| eval("def #{_token}; @hash_token['#{_token}'] ;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
@@ -73,14 +86,31 @@ module Thot
     # the templater;proceed to templating
     # @return [String] the template output
     def output
-      _my_res = String::new('')
-      _my_res = @content
+      @result = @content
       @list_token.each{|_token|
-        _my_res.gsub!(/%%#{_token.to_s.upcase}%%/,@hash_token[_token.to_s])
+        self.filtering  @content.scan(/%%(#{_token.to_s.upcase}[\.\w+]+)%%/).flatten
+        @result.gsub!(/%%#{_token.to_s.upcase}%%/,@hash_token[_token.to_s])
       }
-      return _my_res
+      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
@@ -91,3 +121,6 @@ module Thot
   class NoTemplateFile < Exception; end
   
 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%% !! 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Romain GEORGES
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2022-10-17 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,12 @@ 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
 - thot.gemspec
 - ultragreen_roodi_coding_convention.yml
 homepage: https://github.com/Ultragreen/thot
@@ -148,7 +153,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Ultragreen/thot
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -163,8 +168,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.1.2
+signing_key: 
 specification_version: 4
 summary: THe Operative Templating
 test_files: []