yaml_structure_checker 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b1ce6fcb49b5f7a073c2f0192e764bd31cd2548913fc142417f2177201049e
-  data.tar.gz: a21da4ba0ac21d7739ddaa274f7aad1a8fcf2a55dcf79376b64f4971e75a5bec
+  metadata.gz: 1c38cb26e3b2a6f824f9389805104bcddd59bc303d9293d687a9263eebf5f7ff
+  data.tar.gz: c0d8317b0de539c992d4e7a2819fff410ee490576002451285f59e5adcbc8e52
 SHA512:
-  metadata.gz: 3253e65b6567752fec9a7bd2bfeb014a89f81c52e2790bfa9f0bafa50e3f3bca3dbcf4bc6eaae6bb1ec9b0a1a6cdfccbed01ea3c74a91f3510bb34a1968b906d
-  data.tar.gz: 0e945ec8fc8b7bd4a308355b8873a46ee751fa954363ca51b8d8bc51b4cf62e7718721986b11576fb9c6608e6f808215edd6521e2788ed0f403b90a905e0d4d0
+  metadata.gz: 7af40b7d4a6bb86a6323e56afc2bd1f2b1d7c8fafd02c919de3764f761687ce6fc1b6368b7c6381ec2af31f9bb91fd0a949994acd2d771bd461d2ff91fc343f7
+  data.tar.gz: 2e5d869036f22461cc4367f7b676768823d0d65209e8d6d47ef52f47c907e48bcede840a3112ff307b2a277c0c77ba23964e3276e311e37c792242d6be19f4c2

data/Gemfile.lock

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

data/README.md

@@ -1,18 +1,74 @@
-# Yaml structure checker
+![thumbnail](yaml_structure_checker.png)
+
+# YAML structure checker
 
 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.
+
+It works powerfully in Rails, but of course it can be used in other applications as well.
+
+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
 
@@ -20,7 +76,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 Add the configuration file `config/yaml_structure_checker.yml`.
 
-Yaml structure checker loads `config/yaml_structure_checker.yml` by default.
+YAML structure checker loads `config/yaml_structure_checker.yml` by default.
 
 An example follows
 
@@ -49,13 +105,13 @@ skip_paths:
 
 ### Check yaml files
 
-Run the `yaml_structure_checker` command to check your Yaml files.
+Run the `yaml_structure_checker` command to check your YAML files.
 
 ```bash
 $ bundle exec yaml_structure_checker
 
 #################################
-#     Yaml Structure Check      #
+#     YAML Structure Check      #
 #################################
 
 Exclude paths:
@@ -75,7 +131,7 @@ Result: OK
 Result: OK
 
 #################################
-#  Yaml Structure Check Result  #
+#  YAML Structure Check Result  #
 #################################
 
 NG paths:
@@ -115,7 +171,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: Bundle install
         run: bundle install --path=vendor/bundle --jobs 4 --retry 3
-      - name: Yaml structure checker
+      - name: YAML structure checker
         run: bundle exec yaml_structure_checker
 ```
 
@@ -125,9 +181,15 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+Also, you can use Docker.
+
+```bash
+docker-compose run --rm app /bin/bash
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yaml_structure_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/yaml_structure_checker/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/yosipy/yaml_structure_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yosipy/yaml_structure_checker/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -135,4 +197,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the YamlStructureChecker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yaml_structure_checker/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the YAMLStructureChecker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yosipy/yaml_structure_checker/blob/master/CODE_OF_CONDUCT.md).

data/exe/yaml_structure_checker

@@ -7,4 +7,4 @@ if !ARGV.empty?
   settings_path = ARGV.first
 end
 
-YamlStructureChecker::Runner.invoke(settings_path)
+YAMLStructureChecker::Runner.invoke(settings_path)

data/lib/yaml_structure_checker/checker.rb

@@ -1,4 +1,4 @@
-module YamlStructureChecker
+module YAMLStructureChecker
   class Checker
     attr_accessor :ok_count,
                   :ng_count,
@@ -110,14 +110,14 @@ module YamlStructureChecker
 
     def print_start_title
       puts "#################################"
-      puts "#     Yaml Structure Check      #"
+      puts "#     YAML Structure Check      #"
       puts "#################################"
       puts "\n"
     end
 
     def print_result_title
       puts "#################################"
-      puts "#  Yaml Structure Check Result  #"
+      puts "#  YAML Structure Check Result  #"
       puts "#################################"
       puts "\n"
     end

data/lib/yaml_structure_checker/converter.rb

@@ -1,4 +1,4 @@
-module YamlStructureChecker
+module YAMLStructureChecker
   class Converter
     # [example]
     # args:

data/lib/yaml_structure_checker/errors.rb

@@ -1,4 +1,4 @@
-module YamlStructureChecker
+module YAMLStructureChecker
   module Errors
     class LoaderError < StandardError;end
     class StructureError < StandardError;end

data/lib/yaml_structure_checker/loader.rb

@@ -1,6 +1,6 @@
 require 'yaml'
 
-module YamlStructureChecker
+module YAMLStructureChecker
   class Loader
     attr_accessor :include_patterns,
                   :exclude_patterns,
@@ -12,7 +12,7 @@ module YamlStructureChecker
         begin
           Loader.yaml_safe_load_file(settings_path)
         rescue => e
-          puts "Not found YamlStructureChecker's settings file."
+          puts "Not found YAMLStructureChecker's settings file."
           raise e
         end
 
@@ -25,7 +25,7 @@ module YamlStructureChecker
     end
 
     def self.yaml_load_file(path)
-      if RUBY_VERSION > '3.1.0'
+      if Psych::VERSION > '4.0.0'
         YAML.load_file(path, aliases: true)
       else
         YAML.load_file(path)
@@ -33,7 +33,7 @@ module YamlStructureChecker
     end
 
     def self.yaml_safe_load_file(path)
-      if RUBY_VERSION > '3.1.0'
+      if Psych::VERSION > '4.0.0'
         YAML.safe_load_file(path)
       else
         YAML.load_file(path)
@@ -69,7 +69,7 @@ module YamlStructureChecker
     def exist_files?(paths)
       paths.each do |path|
         unless File.exist?(path)
-          raise YamlStructureChecker::Errors::LoaderError, "Not found '#{path}'"
+          raise YAMLStructureChecker::Errors::LoaderError, "Not found '#{path}'"
         end
       end
 

data/lib/yaml_structure_checker/runner.rb

@@ -1,6 +1,10 @@
-module YamlStructureChecker
+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"
+module YAMLStructureChecker
+  VERSION = "0.1.2"
 end

data/sig/yaml_structure_checker.rbs

@@ -1,4 +1,4 @@
-module YamlStructureChecker
+module YAMLStructureChecker
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

data/yaml_structure_checker.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/yaml_structure_checker/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "yaml_structure_checker"
+  spec.version = YAMLStructureChecker::VERSION
+  spec.authors = ["yosipy"]
+  spec.email = ["yosi.contact@gmail.com"]
+
+  spec.summary = "YAML structure checker in ruby"
+  spec.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."
+  spec.homepage = "https://github.com/yosipy/yaml_structure_checker"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = ""
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yosipy/yaml_structure_checker"
+  spec.metadata["changelog_uri"] = "https://github.com/yosipy/yaml_structure_checker/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = %w[yaml_structure_checker]
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+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.2
 platform: ruby
 authors:
 - yosipy
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2023-07-05 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:
@@ -25,7 +26,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - docker-compose.yml
@@ -38,6 +38,8 @@ files:
 - lib/yaml_structure_checker/runner.rb
 - lib/yaml_structure_checker/version.rb
 - sig/yaml_structure_checker.rbs
+- yaml_structure_checker.gemspec
+- yaml_structure_checker.png
 homepage: https://github.com/yosipy/yaml_structure_checker
 licenses:
 - MIT
@@ -45,7 +47,7 @@ metadata:
   homepage_uri: https://github.com/yosipy/yaml_structure_checker
   source_code_uri: https://github.com/yosipy/yaml_structure_checker
   changelog_uri: https://github.com/yosipy/yaml_structure_checker/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -60,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.1.4
+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: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2023 TODO: Write your name
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.