thot 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8633ef1b1cb491681966a9cb0439d1e3d8bb69766291623757b0f10fb13ed27
-  data.tar.gz: b7f7297728de329b92fcb064aeeff5d92249b29d9aeb5c430a0a4cf767a4829c
+  metadata.gz: 8f6c6ae92314f63db63bf820e0256e0592733b7d0c0d57187d50926baefb82e0
+  data.tar.gz: 27a167400f4ece2859aafb3f0b159aca3ab5193fc7087336c6fe3b084a7d10a0
 SHA512:
-  metadata.gz: cda6359c5666cf77c09bd903217a98120ed994a1bc3993409f4decc4781751b5fee290fcb8eb02afdc5cce2fe0de0cc7352be4364338640d59a920ac17ff4e32
-  data.tar.gz: 256758ca6758aedfdf49dbd70ac73e1b48933b6f037a89b974ec939fae91820c61676476d698633e1a34bc3ed500f3d5dea6ba864c3b2daa824f35723102d429
+  metadata.gz: 6a5102b7469e1ac351626ae1efc577aaf5249b0c4ce5f3d0d48136dc1be11bf9bca4cb4ce0ee4fbfb10e8aa03dfda05f7ebbdda90a3e4a44e9253c2f9b4212fe
+  data.tar.gz: 2e73db783b15bf08c1660ea387402a39ff44079cbd05b25feca19ae5db83d23a7a7e6f3467c9ff96094fe3d6a07be9c32afe3a2c3bcdc79e03e65a9782890e8d

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

@@ -48,6 +48,10 @@ It could generate an output.
 
 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>
@@ -106,9 +110,19 @@ 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 : in strict mode if the Tokens in template file don't match exactly the given token list, Thot raise an exception.  
@@ -126,7 +140,7 @@ return
    Hello Romain !!
 
 
-#### Strict mode false with accesor input and template_content
+###### Strict mode false with accesor input and template_content
 
 ```ruby
    require 'thot'
@@ -140,7 +154,7 @@ return
 
     Hello Romain !!
 
-#### Strict mode false with map input and template_content
+###### Strict mode false with map input and template_content
 
 ```ruby
    require 'thot'
@@ -154,7 +168,116 @@ 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
 

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.2.0
+1.2.1

data/thot.gemspec

@@ -22,15 +22,20 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "carioca", "~> 2.0"
+  spec.add_dependency "carioca", "~> 2.1"
   spec.add_dependency "inifile", "~> 3.0"
 
-  spec.add_development_dependency 'rake', '~> 12.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thot
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carioca
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: inifile
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     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
@@ -72,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
@@ -150,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
@@ -167,6 +209,9 @@ 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
@@ -187,7 +232,6 @@ files:
 - samples/.thot.env
 - samples/template.ttl
 - thot.gemspec
-- ultragreen_roodi_coding_convention.yml
 homepage: https://github.com/Ultragreen/thot
 licenses:
 - MIT

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