easy_yaml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10552999bc43d17b5f8a67665b526a67d2a1cdebdbdabd3aadb808645abf2bc7
+  data.tar.gz: 87011bc93c2a9ced9ab79ebc99b0673275dc65b3bb62fede53527a2861e3b00e
+SHA512:
+  metadata.gz: 0c93c94a63cd3ce338238b960c1891599d6066caa988fa9f321f4c829f8b1600840482c67d240d02f6ec1cfb8fc5c09b5c15bd7a8a4a210d0bc68da0d05a3e9f
+  data.tar.gz: a09eca2e4194d13c067fbf8c086d923580f16f1fff2b69e4cde9032eeff81bda09abf74c0f6b8e09c93afbf5956c5a2e53712c47ae97b3b7eda8cedb46221f18

data/.github/workflows/greetings.yml

@@ -0,0 +1,15 @@
+name: Greetings
+
+on:
+  - pull_request
+  - issues
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        issue-message: "Thank you for creating your first issue on this repo! 🎉"
+        pr-message: "Thank you for creating your first pull request on this repo! 🎉"

data/.github/workflows/linter.yml

@@ -0,0 +1,24 @@
+on: [push]
+
+name: Linter
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6.x'
+
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Install dependencies
+        run: |
+          gem install rubocop rubocop-performance rubocop-rspec --no-document
+
+      - name: Run linter
+        run: |
+          rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,52 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/LineLength:
+  Max: 125
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+# Good: foo_37
+# Bad: bar42
+# Exception: s3
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+RSpec/NestedGroups:
+  Max: 4
+
+# 👍👍🏻👍🏼👍🏽👍🏾👍🏿
+Style/AsciiComments:
+  Enabled: false
+
+# Don’t require top-level class documentation comment
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at veganstraightedge@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easy_yaml.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    easy_yaml (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.3)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  easy_yaml!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Shane Becker
+
+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.

data/README.md

@@ -0,0 +1,109 @@
+# EasyYAML
+
+EasyYAML is a simple way to read and load YAML from a file.
+It makes some opinionated assumptions, each of which you can override.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'easy_yaml'
+```
+
+And then execute from the command line:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install easy_yaml
+```
+
+## Usage
+
+The simplest way to use EasyYAML is:
+
+```ruby
+EasyYAML.load('path/to/file.yml')
+```
+
+EasyYAML makes a few opinionated assumptions.
+You can override any of these with your own configuration.
+
+`EasyYAML.load` always returns a `Hash`.
+
+### Required argument
+
+**`path`**
+`EasyYAML.load` requires a `path` argument as a `String`.
+
+Example:
+
+```ruby
+EasyYAML.load 'config/database.yml'
+```
+
+### Optional arguments
+
+**`allow_aliases`** (defaults to `true`)
+
+By default, EasyYAML assumes that when you're loading a YAML file, you control and trust that YAML file and want to allow following and expanding any YAML aliases in the file.
+
+If you don't want to allow aliases in the YAML, you can disable them by passing `allow_aliases: false`.
+
+Example:
+
+```ruby
+EasyYAML.load 'config/database.yml', allow_aliases: false
+```
+
+**`allow_erb`** (defaults to `true`)
+
+By default, EasyYAML assumes that when you're loading a YAML file, you control and trust that YAML file and want to allow embedding ERB in the YAML and evaluating it.
+
+If you don't want to evaluate ERB in the YAML, you can disable it by passing `allow_erb: false`.
+
+Example:
+
+```ruby
+EasyYAML.load 'config/database.yml', allow_erb: false
+```
+
+**`relative_to_rails_root`** (defaults to `true`)
+
+By default, EasyYAML assumes that when you're loading a YAML file that you're doing this from within a Rails app. EasyYAML then prefixes the `path` that you pass into `EasyYAML.load` with `Rails.root`. So, your `path` argument only needs to be a string of the path starting at the root of your Rails app.
+
+If you are running EasyYAML outside of a Rails app or if you don't want to load the YAML relative to the Rails app root, you can disable the path prefix by passing `relative_to_rails_root: false`.
+
+Example:
+
+```ruby
+EasyYAML.load '../../../config/database.yml', relative_to_rails_root: false
+```
+
+## Authors
+
+- [Shane Becker @veganstraightedge](https://github.com/veganstraightedge)
+- Add yourself here…
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hoverinc/easy_yaml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EasyYAML project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hoverinc/easy_yaml/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'easy_yaml'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easy_yaml.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_yaml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'easy_yaml'
+  spec.version       = EasyYAML::VERSION
+  spec.authors       = ['Shane Becker']
+  spec.email         = ['veganstraightedge@gmail.com']
+
+  spec.summary       = 'A simple way to safely load a YAML file'
+  spec.description   = <<~DESCRIPTION.tr("\n", ' ')
+    EasyYAML reads a file from a path and uses YAML.safe_load to
+    safely load its contents and optionally works with Rails.root
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/hoverinc/easy_yaml'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hoverinc/easy_yaml'
+  spec.metadata['changelog_uri']   = 'https://github.com/hoverinc/hyperion/blob/master/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/easy_yaml.rb

@@ -0,0 +1,15 @@
+require 'easy_yaml/version'
+require 'easy_yaml/yaml_loader'
+
+module EasyYAML
+  class << self
+    def load path, allow_aliases: true, allow_erb: true, relative_to_rails_root: true
+      loaded_yaml = EasyYAML::YAMLLoader.new path,
+                                             allow_aliases:          allow_aliases,
+                                             allow_erb:              allow_erb,
+                                             relative_to_rails_root: relative_to_rails_root
+
+      loaded_yaml.to_h
+    end
+  end
+end

data/lib/easy_yaml/version.rb

@@ -0,0 +1,3 @@
+module EasyYAML
+  VERSION = '0.1.0'.freeze
+end

data/lib/easy_yaml/yaml_loader.rb

@@ -0,0 +1,49 @@
+require 'yaml'
+require 'erb'
+
+module EasyYAML
+  class YAMLLoader
+    def initialize path, allow_aliases: true, allow_erb: true, relative_to_rails_root: true
+      @path                   = path
+      @allow_aliases          = allow_aliases
+      @allow_erb              = allow_erb
+      @relative_to_rails_root = relative_to_rails_root
+    end
+
+    def to_h
+      safe_load
+    end
+
+    private
+
+    def normalized_path
+      @path.tr('\\', '/').split('/')
+    end
+
+    def prefix_path
+      ::Rails.root if @relative_to_rails_root && defined?(::Rails)
+    end
+
+    def yaml_file_path
+      File.join [prefix_path, normalized_path].compact
+    end
+
+    def file_path
+      Pathname.new File.expand_path(yaml_file_path, __dir__)
+    end
+
+    def yaml_file
+      File.read file_path
+    end
+
+    def erb_parsed_yaml
+      return yaml_file unless @allow_erb
+
+      ERB.new(yaml_file).result
+    end
+
+    def safe_load
+      YAML.safe_load(erb_parsed_yaml, aliases: @allow_aliases)
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: easy_yaml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shane Becker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 'EasyYAML reads a file from a path and uses YAML.safe_load to safely
+  load its contents and optionally works with Rails.root '
+email:
+- veganstraightedge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/greetings.yml"
+- ".github/workflows/linter.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_yaml.gemspec
+- lib/easy_yaml.rb
+- lib/easy_yaml/version.rb
+- lib/easy_yaml/yaml_loader.rb
+homepage: https://github.com/hoverinc/easy_yaml
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hoverinc/easy_yaml
+  source_code_uri: https://github.com/hoverinc/easy_yaml
+  changelog_uri: https://github.com/hoverinc/hyperion/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A simple way to safely load a YAML file
+test_files: []