credman 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6388da4cf0f1f8567e5a14e214e1ed7db9143307d836286050a91fbeeaf03f16
-  data.tar.gz: 3a8b0e4e839371279e819463c659898556f81d171ba980da006b459f4e7812f4
+  metadata.gz: 7091148f095fc916aa4cf688580c55738c3e5729a151b0cd13641f56f6555800
+  data.tar.gz: f491e43c418467b63854fe11a796e0bd53a23d32e2bfee1451584a27045b63d7
 SHA512:
-  metadata.gz: 605cb0d66f1a5c7889325e80ae3de4f604ab6958a0c08ceef401f35db8b6378d949030d4f58502ce91fe699563a206ffb7dac418315732d544b0d2eecf3cb262
-  data.tar.gz: 9cd6975ad0f9a1ebdfa69fac1807a27217a0a0fce7c6ebf66ee07c804e4a38e18631c6a0def1732fc4d5d61a817fb65edd62f48a225f875400795ca6b2d2d209
+  metadata.gz: 5847672f5ff43eccece5a745b247348384feaf4df52d15e84d6a4b37bd50eac8793272abe2231ffe93542be4fde2c6c4db8e23d6851459c4cea63a59230d95ea
+  data.tar.gz: 835d72fe2686d7aa562c28bbe956d1d867833d0bfb1d1df52b7fa6127a22b3186e48dd756d8bc606a91a99da28994607d7e39a8e418e4868653e0549c3f85f34

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "activesupport-6" do
+  gem "activesupport", "~> 6.0.0"
+end
+
+appraise "activesupport-6-1" do
+  gem "activesupport", "~> 6.1.0"
+end
+
+appraise "activesupport-7" do
+  gem "activesupport", "~> 7.0.0"
+end
+
+appraise "activesupport-master" do
+  gem "activesupport", github: "rails/rails", branch: "main"
+end

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.0.6] - 2022-09-19
+
+- Cover all commands by specs (PR #11)
+- Small refactoring with extracting common methods into Credman::Base class (PR #11)
+- default `default_diff_branch` changed to `origin/main` (PR #11)
+- `version` command added (PR #13)
+
+## [0.0.5] - 2022-09-06
+
+- Introduce config with `default_diff_branch` and `available_environments` options (PR #9)
+- Setup Github actions (PR #6)
+- small fixes related to linters and specs (PR #6)
+
 ## [0.0.4] - 2022-09-06
 
 - fix: list command failure when root key exists (PR #2)

data/Gemfile

@@ -4,7 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in credman.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "standard", "~> 1.13"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    credman (0.0.4)
+    credman (0.0.6)
       activesupport (>= 6.0)
       dry-cli (~> 0.7)
       hash_diff (~> 1.0)
@@ -11,16 +11,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3.1)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     dry-cli (0.7.0)
-    hash_diff (1.1.0)
+    hash_diff (1.1.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
@@ -66,6 +70,7 @@ GEM
     standard (1.13.0)
       rubocop (= 1.31.2)
       rubocop-performance (= 1.14.3)
+    thor (1.2.1)
     tty-color (0.6.0)
     tty-command (0.10.1)
       pastel (~> 0.8)
@@ -74,9 +79,12 @@ GEM
     unicode-display_width (2.2.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
+  appraisal
   credman!
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -1,6 +1,20 @@
+[![Gem Version](https://badge.fury.io/rb/credman.svg)](https://badge.fury.io/rb/credman)
+
 # Credman
 
-Handy console command for developers to manage Rails credentials.
+Handy console tool for developers to manage Rails credentials.
+
+## Motivation
+
+Rails credentials is a nice tool to store encrypted credentials directly in your repo. Starting with Rails 6.0 it brings multi environment credentials feature that allows us to split credentials into separate files.
+
+But it also brought a lot of pain for developers:
+- Each enviroment credentials file must have a complete list of all keys. It's easy to forget to add a key into one of the environments (see [set](#credman-set) and [delete](#credman-delete) command)
+- You have to manually open each environment file. It's ok for one file but not for 3 or more. It also brings mistakes you might miss until deploy to production. (see [set](#credman-set) and [delete](#credman-delete) command)
+- Merge conflicts become a hell since files are encrypted (see [conflicts](#credman-conflicts) command)
+- You can't easily see what keys were added/changed/deleted in the current branch (see [diff](#credman-diff) command)
+
+This gem is designed to solve all these problems and make life easier for developers who use multi environment credentials.
 
 ## Installation
 
@@ -25,12 +39,51 @@ or
 bundle exec credman usage
 ```
 
+<details>
+  <summary>Output</summary>
+
+```
+Commands:
+  credman conflicts                # Help to resolve merge conflicts for credentials
+  credman delete KEYS              # Delete keys for given environments
+  credman diff [BRANCH]            # Show credentials diff between given branch (heroku by default) and current changes
+  credman get KEYS                 # Find keys in credentials files for each environment
+  credman list                     # List of all keys for each environment
+  credman set KEY VALUE            # Set a value to the key provided for given environments
+```
+
+</details>
+
 Details of any command:
 
 ```
 bundle exec credman set -h
 ```
 
+<details>
+  <summary>Output</summary>
+
+```
+Command:
+  credman set
+
+Usage:
+  credman set KEY VALUE
+
+Description:
+  Set a value to the key provided for given environments
+
+Arguments:
+  KEY                               # REQUIRED
+  VALUE                             # REQUIRED
+
+Options:
+  --environments=VALUE1,VALUE2,.., -e VALUE  # filter for environments, default: []
+  --help, -h
+```
+
+</details>
+
 ### credman list
 List all your keys for all environments.
 
@@ -38,48 +91,138 @@ List all your keys for all environments.
 bundle exec credman list
 ```
 
+<details>
+  <summary>Output</summary>
+
+```
+development:
+	aws.api_key:	123
+	...
+test:
+	aws.api_key:	nil
+	...
+production:
+	aws.api_key:	nil
+	...
+```
+</details>
+
 ### credman get
 Getting a particular key's values.
 
 ```
-bundle exec credman get google.maps.api_key github.private_key
+bundle exec credman get google.recaptcha.secret circle_ci.token
 ```
 
+<details>
+  <summary>Output</summary>
+
+```
+development:
+	google.recaptcha.secret:	nil
+	circle_ci.token:	<secret>
+test:
+	google.recaptcha.secret:	nil
+	circle_ci.token:	nil
+production:
+	google.recaptcha.secret:	<secret>
+	circle_ci.token:	<secret>
+```
+</details>
+
 ### credman set
 
 Add/change a value for a particular key. `-e` attribute is mandatory for this command.
 
 
 ```
-bundle exec credman set new_service.super_key new_secret_value -e development,test,staging,production
+bundle exec credman set new_service.super_key new_secret_value -e development,test,production
 ```
 
+<details>
+  <summary>Output</summary>
+
+```
+development:
+	new_service.super_key:	ADDED: new_secret_value
+test:
+	new_service.super_key:	ADDED: new_secret_value
+production:
+	new_service.super_key:	ADDED: new_secret_value
+```
+</details>
+
 ### credman delete
 
 Delete for keys. `-e` attribute is mandatory for this command.
 
 ```
-bundle exec credman delete new_service.super_key new_service.another_key -e development,test,staging,production
+bundle exec credman delete new_service.super_key new_service.another_key -e development,test,production
+```
+
+<details>
+  <summary>Output</summary>
+
+```
+development:
+	new_service.super_key:	✅ deleted
+	new_service.another_key:	❌ key not found, can't delete
+test:
+	new_service.super_key:	✅ deleted
+	new_service.another_key:	❌ key not found, can't delete
+production:
+	new_service.super_key:	✅ deleted
+	new_service.another_key:	❌ key not found, can't delete
 ```
+</details>
 
 ### credman diff
 
-Shows all keys changed compared with `heroku` branch by default. You can specify any branch from origin you want to. For example `bin/earl diff my_branch`
+Shows all keys changed compared with `main` branch by default.
+You can set the default branch by adding `config/credman.yml` file with `default_diff_branch: your_branch`
+You can specify any branch from origin you want to. For example `credman diff my_branch`
+
+```
+bundle exec credman diff
+```
+
+<details>
+  <summary>Output</summary>
 
 ```
-> bundle exec credman diff
 development:
 	new_service.super_key:	 ADDED: "new_secret_value"
 test:
 	new_service.super_key:	 ADDED: "new_secret_value"
-staging:
-	new_service.super_key:	 ADDED: "new_secret_value"
 production:
 	new_service.super_key:	 ADDED: "new_secret_value"
 ```
+</details>
 
 ### credman conflicts
-Run it if you have merge conflicts in `configs/credentials/*.yml.enc`. That interactive tool will help you resolve the conflict.
+
+Run it if you have merge conflicts in `configs/credentials/*.yml.enc`.
+That interactive tool will help you resolve the conflict.
+In most of cases it will just automagically resolve the conflicts.
+In case of a key was changed in both branches it will ask you to choose the correct value.
+
+```
+bundle exec credman conflicts
+```
+
+<details>
+  <summary>Output</summary>
+
+```
+development:
+        ❗️ The key another_key changed in both branches, their: "another_value", our: "conflicting_value"
+Which one should we use? Please type `their` or `our` to apply particular change or enter to abort.
+> their
+✅ another_key set as "another_value"
+✅ Merged config for rspec has been saved
+          resolves conflict with user input
+```
+</details>
 
 ## Development
 

data/config/credman.yml

@@ -0,0 +1,5 @@
+default_diff_branch: origin/main
+available_environments:
+  - development
+  - test
+  - production

data/credman.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.executables = 'credman'
+  spec.executables = "credman"
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 6.0"
@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "pastel", "~> 0.8"
   spec.add_dependency "hash_diff", "~> 1.0"
 
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "standard", "~> 1.13"
+  spec.add_development_dependency "appraisal"
 end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/activesupport_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_6.gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: ..
+  specs:
+    credman (0.0.5)
+      activesupport (>= 6.0)
+      dry-cli (~> 0.7)
+      hash_diff (~> 1.0)
+      pastel (~> 0.8)
+      tty-command (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.5.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    dry-cli (0.7.0)
+    hash_diff (1.1.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tty-color (0.6.0)
+    tty-command (0.10.1)
+      pastel (~> 0.8)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 6.0.0)
+  appraisal
+  credman!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.13)
+
+BUNDLED WITH
+   2.2.29

data/gemfiles/activesupport_6_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_6_1.gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: ..
+  specs:
+    credman (0.0.5)
+      activesupport (>= 6.0)
+      dry-cli (~> 0.7)
+      hash_diff (~> 1.0)
+      pastel (~> 0.8)
+      tty-command (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.5.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    dry-cli (0.7.0)
+    hash_diff (1.1.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    thor (1.2.1)
+    tty-color (0.6.0)
+    tty-command (0.10.1)
+      pastel (~> 0.8)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 6.1.0)
+  appraisal
+  credman!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.13)
+
+BUNDLED WITH
+   2.2.29

data/gemfiles/activesupport_7.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 7.0.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_7.gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: ..
+  specs:
+    credman (0.0.5)
+      activesupport (>= 6.0)
+      dry-cli (~> 0.7)
+      hash_diff (~> 1.0)
+      pastel (~> 0.8)
+      tty-command (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    dry-cli (0.7.0)
+    hash_diff (1.1.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    thor (1.2.1)
+    tty-color (0.6.0)
+    tty-command (0.10.1)
+      pastel (~> 0.8)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 7.0.0)
+  appraisal
+  credman!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.13)
+
+BUNDLED WITH
+   2.2.29

data/gemfiles/activesupport_master.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", github: "rails/rails", branch: "main"
+
+gemspec path: "../"

data/gemfiles/activesupport_master.gemfile.lock

@@ -0,0 +1,103 @@
+GIT
+  remote: https://github.com/rails/rails.git
+  revision: 9a439f633205af0800f34af32f2122150faa2767
+  branch: main
+  specs:
+    activesupport (7.1.0.alpha)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+
+PATH
+  remote: ..
+  specs:
+    credman (0.0.5)
+      activesupport (>= 6.0)
+      dry-cli (~> 0.7)
+      hash_diff (~> 1.0)
+      pastel (~> 0.8)
+      tty-command (~> 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.2.5)
+    diff-lcs (1.5.0)
+    dry-cli (0.7.0)
+    hash_diff (1.1.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.16.1)
+      rubocop (= 1.35.1)
+      rubocop-performance (= 1.14.3)
+    thor (1.2.1)
+    tty-color (0.6.0)
+    tty-command (0.10.1)
+      pastel (~> 0.8)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport!
+  appraisal
+  credman!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.13)
+
+BUNDLED WITH
+   2.2.29

data/lib/credman/base.rb

@@ -1,9 +1,7 @@
 module Credman
   class Base
-    AVAILABLE_ENVIRONMENTS = %i[development test staging production].freeze
-
     def initialize(environment_list)
-      @environment_list = environment_list.map(&:to_sym).keep_if { |env| env.to_sym.in?(AVAILABLE_ENVIRONMENTS) }
+      @environment_list = environment_list.keep_if { |env| env.in?(Credman.config.available_environments) }
       abort pastel.red("No valid environments specified. Valid example: `-e development,test`") if @environment_list.empty?
     end
 
@@ -37,15 +35,35 @@ module Credman
       config.dig(*dig_keys)&.key?(keys_path.last)
     end
 
+    def rewrite_config_for(environment, new_config)
+      # removes "---\n" in the very beginning
+      config_as_string = new_config.deep_stringify_keys.to_yaml[4..]
+
+      encrypted_configuration(environment).write(config_as_string)
+    end
+
+    def key_for(environment)
+      ENV["RAILS_MASTER_KEY"] || Pathname.new("config/credentials/#{environment}.key").binread.strip
+    end
+
+    def decript(key, content)
+      ActiveSupport::MessageEncryptor.new([key].pack("H*"), cipher: "aes-128-gcm")
+        .decrypt_and_verify(content)
+    end
+
     private
 
     def config_for(environment)
+      encrypted_configuration(environment).config
+    end
+
+    def encrypted_configuration(environment)
       ActiveSupport::EncryptedConfiguration.new(
         config_path: "config/credentials/#{environment}.yml.enc",
         key_path: "config/credentials/#{environment}.key",
         env_key: "RAILS_MASTER_KEY",
         raise_if_missing_key: true
-      ).config
+      )
     end
   end
 end

data/lib/credman/commands.rb

@@ -9,7 +9,7 @@ module Credman
         option :environments,
           aliases: ["e"],
           type: :array,
-          default: Credman::Base::AVAILABLE_ENVIRONMENTS,
+          default: Credman.config.available_environments,
           desc: "filter for environments"
 
         def call(keys:, environments:, **)
@@ -23,7 +23,7 @@ module Credman
         option :environments,
           aliases: ["e"],
           type: :array,
-          default: Credman::Base::AVAILABLE_ENVIRONMENTS,
+          default: Credman.config.available_environments,
           desc: "filter for environments"
 
         def call(environments:, **)
@@ -67,12 +67,12 @@ module Credman
       class Diff < Dry::CLI::Command
         desc "Show credentials diff between given branch (heroku by default) and current changes"
 
-        argument :branch, type: :string, default: "heroku", required: false
+        argument :branch, type: :string, default: Credman.config.default_diff_branch, required: false
 
         option :environments,
           aliases: ["e"],
           type: :array,
-          default: Credman::Base::AVAILABLE_ENVIRONMENTS,
+          default: Credman.config.available_environments,
           desc: "filter for environments"
 
         def call(branch:, environments:, **)
@@ -86,13 +86,21 @@ module Credman
         option :environments,
           aliases: ["e"],
           type: :array,
-          default: Credman::Base::AVAILABLE_ENVIRONMENTS,
+          default: Credman.config.available_environments,
           desc: "filter for environments"
 
         def call(environments:, **)
           Credman::Conflicts.new(environments).perform
         end
       end
+
+      class Version < Dry::CLI::Command
+        desc "Print current version"
+
+        def call(*)
+          puts Credman::VERSION
+        end
+      end
     end
   end
 end

data/lib/credman/configuration.rb

@@ -0,0 +1,42 @@
+require "yaml"
+
+module Credman
+  class Configuration
+    include Singleton
+
+    attr_writer :settings_list
+
+    def self.add_setting(name, default_value = nil)
+      attr_accessor name
+      instance.send("#{name}=", default_value)
+      instance.settings_list = instance.settings_list.push(name.to_sym)
+    end
+
+    def self.reset
+      load __FILE__
+      self
+    end
+
+    def settings_list
+      @settings_list ||= []
+    end
+
+    def setting_exists?(setting_name)
+      settings_list.include?(setting_name)
+    end
+
+    def load_from_yml(config_path = "config/credman.yml")
+      return unless File.exist?(config_path)
+
+      settings = YAML.load_file(config_path)
+      return unless settings
+
+      settings.each do |setting_name, setting_value|
+        send("#{setting_name}=", setting_value) if setting_exists?(setting_name.to_sym)
+      end
+    end
+
+    add_setting :default_diff_branch, "origin/main"
+    add_setting :available_environments, %w[development test production]
+  end
+end

data/lib/credman/conflicts.rb

@@ -20,9 +20,7 @@ module Credman
         @merged_config = our_config.deep_merge(their_config)
         deep_print_diff(HashDiff.diff(their_config, our_config))
 
-        # removes "---\n" in the very beginning
-        merged_config_as_string = @merged_config.deep_stringify_keys.to_yaml[4..]
-        rewrite_config_for(env, merged_config_as_string)
+        rewrite_config_for(env, @merged_config)
         puts "✅ Merged config for #{env} has been saved"
       end
     end
@@ -33,19 +31,8 @@ module Credman
       deserialize(decript(key_for(environment), encripted_file_content)).deep_symbolize_keys
     end
 
-    def key_for(environment)
-      Pathname.new("config/credentials/#{environment}.key").binread.strip
-    end
-
-    def decript(key, content)
-      ActiveSupport::MessageEncryptor.new([key].pack("H*"), cipher: "aes-128-gcm")
-        .decrypt_and_verify(content)
-    end
-
     def deserialize(raw_config)
-      # rubocop:disable Security/YAMLLoad
-      YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(raw_config) : YAML.load(raw_config)
-      # rubocop:enable Security/YAMLLoad
+      YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(raw_config) : YAML.safe_load(raw_config)
     end
 
     def deep_print_diff(diff, key_path = [])
@@ -107,14 +94,5 @@ module Credman
         deep_set!(obj[key], keys.slice(1..-1), value)
       end
     end
-
-    def rewrite_config_for(environment, new_config)
-      ActiveSupport::EncryptedFile.new(
-        content_path: "config/credentials/#{environment}.yml.enc",
-        key_path: "config/credentials/#{environment}.key",
-        env_key: "RAILS_MASTER_KEY",
-        raise_if_missing_key: true
-      ).write(new_config)
-    end
   end
 end

data/lib/credman/delete.rb

@@ -20,23 +20,10 @@ module Credman
           end
         end
 
-        if is_updated
-          # removes "---\n" in the very beginning
-          config_as_string = updated_config.deep_stringify_keys.to_yaml[4..]
-          rewrite_config_for(env, config_as_string)
-        end
+        rewrite_config_for(env, updated_config) if is_updated
       end
     end
 
-    def rewrite_config_for(environment, new_config)
-      ActiveSupport::EncryptedConfiguration.new(
-        config_path: "config/credentials/#{environment}.yml.enc",
-        key_path: "config/credentials/#{environment}.key",
-        env_key: "RAILS_MASTER_KEY",
-        raise_if_missing_key: true
-      ).write(new_config)
-    end
-
     def deep_delete!(obj, keys)
       key = keys.first
       if keys.length == 1

data/lib/credman/diff.rb

@@ -8,11 +8,11 @@ module Credman
       configs.each do |env, config|
         puts pastel.green("#{env}:")
 
-        result = cmd.run!("echo `git show origin/#{branch_to_compare}:config/credentials/#{env}.yml.enc`")
+        result = cmd.run!("echo `git show #{branch_to_compare}:config/credentials/#{env}.yml.enc`")
         encripted_file_content = result.out.strip
 
         if encripted_file_content.blank?
-          puts "❗️ Can not find #{env} credentials file in origin/#{branch_to_compare} branch"
+          puts "❗️ Can not find #{env} credentials file in #{branch_to_compare} branch"
           next
         end
         branch_config = config_to_compare_for(env, encripted_file_content)
@@ -27,19 +27,8 @@ module Credman
       deserialize(decript(key_for(environment), encripted_file_content)).deep_symbolize_keys
     end
 
-    def key_for(environment)
-      Pathname.new("config/credentials/#{environment}.key").binread.strip
-    end
-
-    def decript(key, content)
-      ActiveSupport::MessageEncryptor.new([key].pack("H*"), cipher: "aes-128-gcm")
-        .decrypt_and_verify(content)
-    end
-
     def deserialize(raw_config)
-      # rubocop:disable Security/YAMLLoad
-      YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(raw_config) : YAML.load(raw_config)
-      # rubocop:enable Security/YAMLLoad
+      YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(raw_config) : YAML.safe_load(raw_config)
     end
 
     def deep_print_diff(diff, key_path = [])

data/lib/credman/set.rb

@@ -3,6 +3,7 @@ module Credman
     def perform(key, new_value)
       key_with_path = key.split(".").map(&:to_sym)
       new_value = normalize_new_value(new_value)
+      abort pastel.red("Invalid key") if key.blank?
 
       configs.each do |env, config|
         puts pastel.green("#{env}:")
@@ -25,22 +26,11 @@ module Credman
         if update_config
           updated_config = config.dup
           deep_set!(updated_config, key_with_path, new_value)
-          # removes "---\n" in the very beginning
-          config_as_string = updated_config.deep_stringify_keys.to_yaml[4..]
-          rewrite_config_for(env, config_as_string)
+          rewrite_config_for(env, updated_config)
         end
       end
     end
 
-    def rewrite_config_for(environment, new_config)
-      ActiveSupport::EncryptedConfiguration.new(
-        config_path: "config/credentials/#{environment}.yml.enc",
-        key_path: "config/credentials/#{environment}.key",
-        env_key: "RAILS_MASTER_KEY",
-        raise_if_missing_key: true
-      ).write(new_config)
-    end
-
     def deep_set!(obj, keys, value)
       key = keys.first
       if keys.length == 1

data/lib/credman/version.rb

@@ -1,3 +1,3 @@
 module Credman
-  VERSION = "0.0.4".freeze
+  VERSION = "0.0.6".freeze
 end

data/lib/credman.rb

@@ -5,6 +5,15 @@ require "dry/cli"
 require "pastel"
 require "hash_diff"
 
+require_relative "credman/configuration"
+module Credman
+  def self.configuration
+    Credman::Configuration.instance
+  end
+  singleton_class.send(:alias_method, :config, :configuration)
+end
+Credman.configuration.load_from_yml
+
 require_relative "credman/base"
 require_relative "credman/commands"
 require_relative "credman/get"
@@ -26,6 +35,7 @@ module Credman
       register "delete", Delete
       register "diff", Diff
       register "conflicts", Conflicts
+      register "version", Version, aliases: ["v", "-v", "--version"]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: credman
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Sergey Andronov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The tool what you miss for managing Rails credentials
 email:
 - dev@uscreen.tv
@@ -118,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".vscode/settings.json"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -128,10 +157,22 @@ files:
 - bin/credman
 - bin/rspec
 - bin/setup
+- config/credentials/.gitkeep
+- config/credman.yml
 - credman.gemspec
+- gemfiles/.bundle/config
+- gemfiles/activesupport_6.gemfile
+- gemfiles/activesupport_6.gemfile.lock
+- gemfiles/activesupport_6_1.gemfile
+- gemfiles/activesupport_6_1.gemfile.lock
+- gemfiles/activesupport_7.gemfile
+- gemfiles/activesupport_7.gemfile.lock
+- gemfiles/activesupport_master.gemfile
+- gemfiles/activesupport_master.gemfile.lock
 - lib/credman.rb
 - lib/credman/base.rb
 - lib/credman/commands.rb
+- lib/credman/configuration.rb
 - lib/credman/conflicts.rb
 - lib/credman/delete.rb
 - lib/credman/diff.rb