dinomischus 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45e3b2434da2f959d4aed159cbdc8397b6f22074c1be58d0efee583288136f68
-  data.tar.gz: 3dd3a6a60a78071de80c31b9124ee23900f5c24b3088e7e1dd61790bc41b2d50
+  metadata.gz: cfd0e1ee82ce880dd2394d0a6aff156997e6a171a4d6d5639a2c5db55dcc1830
+  data.tar.gz: 0570a829c352e16539b8c677072faf1a696d230018253c442440afa4abb0b9ec
 SHA512:
-  metadata.gz: b7a092cf1aaa89ba600295e6e0eccff52b41760308acf097522d8bd6b9240768c78acd7cd0dec74f15b796065ca38dfd4f8d883e5912801e7a2e8fa461fb3b17
-  data.tar.gz: 784296a83738f6dc1cd4f34079092967c289598007c397e6230c05d64e46dcbaa3018af1abc414ec8bd5c52990bf3f4de7321951a016558600348279b8f02aef
+  metadata.gz: cf9e170535203f2ba3229243d0ab716979b6f9fe9bb5c54d3bd22ddf23d424ac800aa42abb3a91e54705e637049ebb9a94f6f598e3ff72b43841455c5868087c
+  data.tar.gz: dad059a8961cd486db025cb390e025dff0a241a3ba3687e59841886ddc75e9aead77baa513898a615544c20ca84e9e4299e8835dfcbe90dd58129f2ee33721d4

data/README.md

@@ -27,25 +27,97 @@ Or install it yourself as:
 ## Usage
 
 ### For Reading
+Suppose you have the following configuration file:
+```yaml:project_config.yml
+---
+- :key_path: "/home/vagrant/.crypt_config/project_key.yml"
+- :animal:
+    :value: |-
+      ?0thjXJj2wR4kzp3EidmJ+bgWtYXs7/DZpTlcDFiLjDbsSB2YWnZEB+ovMTNC
+      37kx
+    :desc: ''
+  :fruit:
+    :value: |-
+      ?wIGrSC/bf5om/rlfIlz7hAIOjaZFjIgw4ulguIKI7YpBrx4JOcmUo3cLH1vC
+      eDeW
+    :desc: This fruit color is yellow.
+```
+If you want to use this in the program, you can use it as follows.
+
 ```
 require 'dinomischus'
 
-# ex1
-hash = Dinomischus.load('project_name_config_index.yml')  # also project_name_config.yml
-p hash[:key]  # => decrypted-value
-p hash[:key]  # => raw-description
+# ex1 ( simple reading )
+hash = Dinomischus.load_file('config_project.yml')  
+# => {:animal=>"owl", 
+#     :fruit=>"Lemon"}
+p hash[:animal]  # => owl  
+p hash[:fruit]   # => Lemon
+
+# ex2 ( more specification )
+hash = Dinomischus.load_file('project_config.yml', true)
+# => {:animal=>{:value=>"owl", :desc=>""},
+#     :fruit=>{:value=>"Lemon", :desc=>"This fruit color is yellow."} }
+
+p hash[:fruit][:value]  # => Lemon
+p hash[:fruit][:desc]   # => This fruit color is yellow.
+```
+
+Even if there are multiple configuration files, they can be read at once.
+In that case, a separate file that defines the reading order is required. (Project_config_index.yml in the example)
+If the setting items are duplicated, the setting value of the file read later is given priority. By using this, it is possible to prepare a setting file for the default value and separate the setting file for the development environment and the setting file for the production environment.
 
-# ex2
-hash = Dinomischus.load('project_name_config_index.yml', true)  # also project_name_config.yml
-p hash[:key][:value]  # => decrypted-value
-p hash[:key][:desc]   # => raw-description
+```yaml:project_config_index.yml 
+---
+- :conf_path: "/path/to/config/project_config_default.yml"
+- :conf_path: "/path/to/config/project_config_product.yml"
 ```
+```yaml:project_config_default.yml
+---
+- :key_path: "/home/vagrant/.crypt_config/project_key.yml"
+- :animal:
+    :value: |-
+      ?0thjXJj2wR4kzp3EidmJ+bgWtYXs7/DZpTlcDFiLjDbsSB2YWnZEB+ovMTNC
+      37kx
+    :desc: ''
+  :fruit:
+    :value: |-
+      ?wIGrSC/bf5om/rlfIlz7hAIOjaZFjIgw4ulguIKI7YpBrx4JOcmUo3cLH1vC
+      eDeW
+    :desc: This fruit color is yellow.
+```
+```yaml:project_config_product.yml 
+---
+- :key_path: "/home/vagrant/.crypt_config/project_key.yml"
+- :fruit:
+    :value: banana
+    :desc: 黄色い果物
+  :furniture:
+    :value: chair
+    :desc:  座る物
+```
+
+After reading the above, it will be as follows.
 
-### Create Configure File. First Use
+```ruby
+require 'dinomischus'
+ 
+hash = Dinomischus.load_file('project_name_config_index.yml')
+# => {:animal=>"owl", 
+#     :fruit=>"banana",
+#     :furniture=>"chair"}
+```
+The setting value of ```:fruit``` changed to ```banana``` depending on the file read later.
+
+### For Write Setting
+
+
+#### Create Configure File. First Use
 設定ファイル作成(初回設定)
 
-When you execute the following command
+When you execute the following command from terminal.
 ```
+$ cd /path/to/project_root
 $ dinomischus
 ```
 
@@ -56,18 +128,128 @@ A menu will appear.
   2. Add or Update Crypted Value
   3. List Configs Simple
   4. List Configs Specify
-  8. Ruby Command List
-  9. End 
------------> Select Menu [1-4,8,9]:
+  c. Clear Screen
+  h. Ruby Command List
+  z. End 
+-----------> Select Menu [1-4,c,h,z]: 
+```
+
+Select 1 when the menu appears.
+
+```text
+-----------> Select Menu [1-4,c,h,z]: 1
+  
+****** Make Template ******
+  
+Input Your Config Prefix Name : ____
+
+```
+You will be asked for the first character string for identification of the configuration file. Please enter any characters. (Here prj)
+(If there is a file that already exists with the identification character set once, the file creation process is skipped.)
+
+```text
+Input Your Config Prefix Name : prj
+Make File Default Value is ... 
+  Key    File Place [/path/to/home/yourid/.crypt_config/prj_key.yml]
+  Config File Place [/path/to/current directory/config/prj_config.yml]
+  Define File Place [/path/to/current directory/config/prj_config_index.yml]
+ 
+Press Enter Key to Next Step... 
+```
+Check the created file and press the enter key.
+* Create the ```.crypt_config``` and ```config``` directories if they do not exist.
+
+```text
+Done! 
+Next Step is Add Crypt Config|Plain Config to /path/to/カレントディレクトリ/config/prj_config.yml .  
+Add Config Value then You Select Menu No.2 .
+-----------> Select Menu [1-4,c,h,z]: 
 ```
 
-1 テンプレート作成
-2 暗号化設定追加
-3 設定ファイルの設定値一覧
-4 設定ファイルの設定値一覧（説明付き）
-8 プログラム中にファイルを読む際のサンプル
-9 プログラム終了
+This completes the template creation.
+You can copy the completed file as appropriate, or change the save destination to change the configuration to your liking.
+If you change the directory, the path of each file is described at the beginning of the configuration file, so change that as well.
+
+#### Addition of setting encryption value.
+Call the menu from the ```dinomischus``` command .
+
+```bash
+$ cd /path/to/project_root
+$ dinomischus
+****** Welcome Egoistic Config ******
+  1. Make Template
+  2. Add or Update Crypted Value
+  3. List Configs Simple
+  4. List Configs Specify
+  c. Clear Screen
+  h. Ruby Command List
+  z. End 
+-----------> Select Menu [1-4,c,h,z]: 
+```
+Select 2 when the menu appears.
+
+```text
+-----------> Select Menu [1-4,c,h,z]: 2
+ 
+****** Crypted Value Setting ******"
+  Input Your Config Path : config/prj_config.yml
+  Input Your Key   : email
+  Input Your Value : myValue1@example.com
+  Input Your Description : Sample e-mail address for settings. It doesn't exist.
+ 
+Done! 
+```
+
+After entering the setting file path you want to edit, enter the value you want to set for each item that appears. The encryption of the setting value is over. If all goes well, you should have a configuration file like the one below.
+
+```yaml:config/prj_config_index.yml
+---
+- :conf_path: "/home/vagrant/config/prj_config.yml"
+```
+```yaml:config/prj_config.yml
+---
+- :key_path: "/home/vagrant/.crypt_config/prj_key.yml"
+- :dummy:
+    :value: ''
+    :desc: ''
+  :email:
+    :value: |-
+      ?Afo3Ccn307HZgQgBRwmyUQtCqDus3063wz1h9CIpRMIWdpRC07yfd2TG5jKa
+      OrQiDDMfySjQIhWfL1Gt0UJ8tngSiUJT4gfgvjN7/+LHpdk=
+    :desc: Sample e-mail address for settings. It doesn't exist.
+```
+※  If you are concerned about dummy, delete it with a text editor.
+   ```{:dummy => {:value: '', :desc:''}}``` 
+
+```yaml:~/.crypt_config/prj_key.yml
+---
+:key:
+  :type: sha256
+  :value: eUIZzgKKnsJCoLcRX5pXXg
+```
+
+### Description of each file
+#### Definition file（```*_config_index.yml```)
+Defines the reading order of the configuration files.
+
+* The reading order is from top to bottom.
+* If the setting items are duplicated, they will be overwritten with the values read later.
+* Two or more files can be defined.
+
+#### Setting file (```*_config.yml```)
+The link to the key file (key_path) and the text of the setting value are saved.
+
+* {Setting item => {value: "setting value", desc: "description"}} It is one set in the form of.
+* If the first character of the setting value is "?", Attempts to decrypt with the password described in key_path.
+* The encrypted setting value is encrypted twice. (The first time is the encrypted character string and salt of the set value, and the second time is the encrypted character string and salt. Combine the ruts into one encrypted string. Due to this effect, even if the setting value is the same, it will be a completely different setting value each time it is encrypted.)
+* If you want to set the setting value in plain text, edit it directly using a text editor.
+
+#### Key file（```*_key.yml```）
+Stores the password used for encryption / decryption.
 
+* The encryption method is sha256.
+* It will be created automatically when the template is created, but ** before encryption ** you can change it to any character string with a text editor. Hmm. (If you change the password after encrypting it, it will fail when decrypting.)
+* ```type:``` is a preliminary item for future specification expansion. Currently, "sha256" is an option.
 
 ## Development
 

data/lib/dinomischus/menu.rb

@@ -59,7 +59,7 @@ module Dinomischus
         puts  "  Config File Place [#{conf_path}]"
         puts  "  Define File Place [#{def_path}]"
         puts  " "
-        print "Press Any Key to Next Step... "
+        print "Press Enter Key to Next Step... "
         ans = gets.chomp
         break 
       }

data/lib/dinomischus/version.rb

@@ -1,3 +1,3 @@
 module Dinomischus
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dinomischus
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kuroko Sin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-03 00:00:00.000000000 Z
+date: 2020-10-04 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -18,7 +18,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".README.md.swp"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md