yaml_structure_checker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b1ce6fcb49b5f7a073c2f0192e764bd31cd2548913fc142417f2177201049e
-  data.tar.gz: a21da4ba0ac21d7739ddaa274f7aad1a8fcf2a55dcf79376b64f4971e75a5bec
+  metadata.gz: 290a787b965f0af918bc85af4433e1d1cb3f42673198d21293208d67579b13b9
+  data.tar.gz: 997bc0826d6c7a144180ecf4e050913606f385f37d55baf298c4181fb0984f74
 SHA512:
-  metadata.gz: 3253e65b6567752fec9a7bd2bfeb014a89f81c52e2790bfa9f0bafa50e3f3bca3dbcf4bc6eaae6bb1ec9b0a1a6cdfccbed01ea3c74a91f3510bb34a1968b906d
-  data.tar.gz: 0e945ec8fc8b7bd4a308355b8873a46ee751fa954363ca51b8d8bc51b4cf62e7718721986b11576fb9c6608e6f808215edd6521e2788ed0f403b90a905e0d4d0
+  metadata.gz: 706749f393d395878b24c8e2111a8ab4ad01a3ca429112fe7f2afbde5f6f036b5b15d863e6b4baf7f7159eff521d7963e284c21c670d61179b9a2340d59c21f1
+  data.tar.gz: 4115d35138dc3ffda4acd8c0ac266747bbb3707c7d7edd8acaf28d080671cc64c6a4b0a1d29745de886762cb048a09da3a22c62348ebed5f8c1a51c5ea8fd73b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yaml_structure_checker (0.1.0)
+    yaml_structure_checker (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -23,6 +23,7 @@ GEM
     rspec-support (3.12.0)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -2,17 +2,69 @@
 
 This Gem can detect that the keys in the yaml file do not match for each environment.
 
+This prevents cases where errors occur only in the production environment.
+
+The following is an example
+
+```yaml
+# This file is OK.
+development: &default
+  db:
+    username: username
+    password: password
+
+test:
+  <<: *default
+
+integration:
+  <<: *default
+
+production:
+  <<: *default
+  db:
+    username: <%= ENV['DATABASE_UERNAME'] %>
+    password: <%= ENV['DATABASE_PASSWORD'] %>
+```
+
+```yaml
+# This file is NG. Raises an exception.
+development: &default
+  db:
+    username: username
+    password: password
+
+test:
+  <<: *default
+
+integration:
+  <<: *default
+
+production:
+  <<: *default
+  db:
+    username: <%= ENV['DATABASE_UERNAME'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>
+```
+
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'yaml_structure_checker'
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+And then execute:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+$ bundle
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Or install it yourself as:
+
+```bash
+$ gem install yaml_structure_checker
+```
 
 ## Usage
 

data/lib/yaml_structure_checker/runner.rb

@@ -1,6 +1,10 @@
 module YamlStructureChecker
   class Runner
-    def self.invoke(settings_path='config/yaml_structure_checker.yml')
+    def self.invoke(settings_path)
+      if settings_path.nil?
+        settings_path='config/yaml_structure_checker.yml'
+      end
+
       Checker.new.test_yamls(settings_path)
     end
   end

data/lib/yaml_structure_checker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YamlStructureChecker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: yaml_structure_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - yosipy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies: []
-description:
+description: This Gem can detect that the keys in the yaml file do not match for each
+  environment. This prevents cases where errors occur only in the production environment.
 email:
 - yosi.contact@gmail.com
 executables:
@@ -63,6 +64,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: This Gem verifies that the structure of the Yaml file is consistent for each
-  environment.
+summary: Yaml structure checker in ruby
 test_files: []