load_file 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 370bdebd061e99a284e045ac276ebbf6525957656b133873acb19aa2206fcf6f
+  data.tar.gz: 1fdc0d2148d432bc65b61bcaa5e002e7e74eecc3bb0eb90721c6cceb0f7cfc70
+SHA512:
+  metadata.gz: 87067068f85f261224bb1b19f0b164aa1f1c3f8a15f32c42253df95d43e71e3017fc714e5146731624050598c86b08b8c2ef7386dba2798c5e9cd90b65ac4c6e
+  data.tar.gz: b8208625d5c588b40e6a24c36627a755726c0d45ee9e4e7bc353a7da70e5234519f930729ce9a579d0d67bcad0c4af123b6a46b0db532c46910d8c02d75eee51

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/.travis.yml

@@ -0,0 +1,6 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## 1.0.0
+
+1.0.0 includes:
+
+- LoadFile.load
+- LoadFile.load!
+- LoadFile.load_files
+- LoadFile.load_files!
+- LoadFile.overload
+- LoadFile.overload!
+- LoadFile.overload_files
+- LoadFile.overload_files!
+
+to load / overload file(s) into desired constant.
+
+## 0.0.0
+
+Init devyml gem.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in devyml.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    load_file (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  load_file!
+  pry
+  rake
+  rspec
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Juanito Fatas
+
+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,41 @@
+# LoadFile
+
+Load/Overload YAML/JSON file(s) into desired constant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "load_file"
+```
+
+## Usage
+
+```ruby
+LoadFile.load(file: "examples/.travis.yml", constant: :TravisConfig)
+
+# now you can access TravisConfig for configs in examples/.travis.yml
+TravisConfig
+=> {"sudo"=>false, "language"=>"ruby", "cache"=>"bundler", "rvm"=>["2.5.1"]}
+
+LoadFile.load(file: "examples/app.json", constant: :HerokuApp)
+
+# now you can access HerokuApp for configs in examples/app.json
+HerokuApp
+=> {"name"=>"Small Sharp Tool",
+  ...
+  "environments"=>{"test"=>{"scripts"=>{"test"=>"bundle exec rake test"}}}}
+```
+
+### What if I want to override existing constant?
+
+Use `overload` APIs.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JuanitoFatas/devyml.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/hack

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "load_file"
+
+# 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.
+
+require "pry"
+Pry.start

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/examples/.travis.yml

@@ -0,0 +1,6 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1

data/examples/app.json

@@ -0,0 +1,58 @@
+{
+  "name": "Small Sharp Tool",
+  "description": "This app does one little thing, and does it well.",
+  "keywords": [
+    "productivity",
+    "HTML5",
+    "scalpel"
+  ],
+  "website": "https://small-sharp-tool.com/",
+  "repository": "https://github.com/jane-doe/small-sharp-tool",
+  "logo": "https://small-sharp-tool.com/logo.svg",
+  "success_url": "/welcome",
+  "scripts": {
+    "postdeploy": "bundle exec rake bootstrap"
+  },
+  "env": {
+    "SECRET_TOKEN": {
+      "description": "A secret key for verifying the integrity of signed cookies.",
+      "generator": "secret"
+    },
+    "WEB_CONCURRENCY": {
+      "description": "The number of processes to run.",
+      "value": "5"
+    }
+  },
+  "formation": {
+    "web": {
+      "quantity": 2,
+      "size": "Performance-M"
+    }
+  },
+  "image": "heroku/ruby",
+  "addons": [
+    "openredis",
+    {
+      "plan": "mongolab:shared-single-small",
+      "as": "MONGO"
+    },
+    {
+      "plan": "heroku-postgresql",
+      "options": {
+        "version": "9.5"
+      }
+    }
+  ],
+  "buildpacks": [
+    {
+      "url": "https://github.com/stomita/heroku-buildpack-phantomjs"
+    }
+  ],
+  "environments": {
+    "test": {
+      "scripts": {
+        "test": "bundle exec rake test"
+      }
+    }
+  }
+}

data/lib/load_file.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+require "load_file/version"
+require "load_file/loader"
+
+# Module to load file(s) into constant
+module LoadFile
+  # Loads file into constant.
+  #
+  # @param [String, Pathname, File] path to load the file from
+  # @param [String, Symbol] constant name to load into
+  # @return [Hash] loaded file content
+  # @return [NilClass] nil when file not exists
+  def self.load(file:, constant:)
+    ignore_file_not_exists do
+      reader = Loader.new(file, constant)
+      reader.set_constant
+    end
+  end
+
+  # Loads file into constant.
+  #
+  # @param [String, Pathname, File] path to load the file from
+  # @param [String, Symbol] constant name to load into
+  # @return [Hash] loaded file content, raises an error when file not exists
+  # @return [NilClass] nil when file not exists
+  def self.load!(file:, constant:)
+    reader = Loader.new(file, constant)
+    reader.set_constant
+  end
+
+  # Loads files into constant.
+  # Any file not exists will be ignored and not raise error.
+  #
+  # @param [Array<String>] list of files to load
+  # @param [String, Symbol] constant name to load into
+  # @return [Hash] last loaded file content
+  # @return [NilClass] nil when last file not exists
+  def self.load_files(files:, constant:)
+    files.each { |file| load(file: file, constant: constant) }
+  end
+
+  # Loads files into constant.
+  #
+  # @param [Array<String>] list of files to load
+  # @param [String, Symbol] constant name to load into
+  # @return [Hash] last loaded file content, raises an error when any file not exists
+  def self.load_files!(files:, constant:)
+    files.each { |file| load!(file: file, constant: constant) }
+  end
+
+  # Overload a `file` into `constant`.
+  # Same as `load`, but will override existing values in `constant`.
+  #
+  # @param [String, Pathname, File] path to overload the file from
+  # @param [String, Symbol] constant name to overload into
+  # @return [Hash] overloaded file content
+  # @return [NilClass] nil when file not exists
+  def self.overload(file:, constant:)
+    ignore_file_not_exists do
+      reader = Loader.new(file, constant)
+      reader.set_constant!
+    end
+  end
+
+  # Overload a `file` into `constant`.
+  # Same as `load!`, but will override existing values in `constant`.
+  #
+  # @param [String, Pathname, File] path to overload the file from
+  # @param [String, Symbol] constant name to overload into
+  # @return [Hash] overloaded file content, raises an error when file not exists
+  # @return [NilClass] nil when file not exists
+  def self.overload!(file:, constant:)
+    reader = Loader.new(file, constant)
+    reader.set_constant!
+  end
+
+  # Overload files into constant.
+  # Any file not exists will be ignored and not raise error.
+  # Same as `load_files`, but will override existing values in `constant`.
+  #
+  # @param [Array<String>] list of files to overload
+  # @param [String, Symbol] constant name to overload into
+  # @return [Hash] last overloaded file content
+  # @return [NilClass] nil when last file not exists
+  def self.overload_files(files:, constant:)
+    files.each { |file| overload(file: file, constant: constant) }
+  end
+
+  # Overload files into constant.
+  # Any file not exists will raise error.
+  # Same as `load_files!`, but will override existing values in `constant`.
+  #
+  # @param [Array<String>] list of files to overload
+  # @param [String, Symbol] constant name to overload into
+  # @return [Hash] last overloaded file content, raises an error when any file not exists
+  def self.overload_files!(files:, constant:)
+    files.each { |file| overload!(file: file, constant: constant) }
+  end
+
+  # @private
+  def self.ignore_file_not_exists
+    yield
+  rescue Errno::ENOENT
+  end
+end

data/lib/load_file/loader.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require_relative "parser"
+
+module LoadFile
+  # A class to load `file` into Hash, find or create constant by `constant_name`.
+  #
+  # @return [Hash] parsed YAML or JSON content
+  class Loader < Hash
+    def initialize(file, constant_name)
+      @file = file
+      @constant = find_or_define(constant_name)
+
+      update parsed_content
+    end
+
+    # Set `values` into `constant` if not exists.
+    def set_constant
+      each { |key, value| constant[key] ||= value }
+    end
+
+    # Override `values` into `constant`.
+    def set_constant!
+      each { |key, value| constant[key] = value }
+    end
+
+    private
+
+    attr_reader :file, :constant
+
+    def find_or_define(constant_name)
+      if Object.const_defined?(constant_name)
+        Object.const_get(constant_name)
+      else
+        Object.const_set(constant_name, {})
+      end
+    end
+
+    def parsed_content
+      case File.extname(file)
+      when ".yml", ".yaml"
+        Parser.yaml(content)
+      when ".json"
+        Parser.json(content)
+      else
+        raise_parser_error("don't know how to parse #{file}")
+      end
+    rescue Parser::ParserError
+      raise_parser_error("#{file} format is invalid")
+    end
+
+    def raise_parser_error(message)
+      raise Parser::ParserError, message
+    end
+
+    def content
+      IO.read(file)
+    end
+  end
+end

data/lib/load_file/parser.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require "yaml"
+require "json"
+
+module LoadFile
+  class Parser
+    ParserError = Class.new(StandardError)
+
+    def self.yaml(content)
+      if present?(content)
+        YAML.safe_load(content, [Regexp, Symbol])
+      else
+        {}
+      end
+    rescue Psych::SyntaxError
+      raise ParserError
+    end
+
+    def self.json(content)
+      if present?(content)
+        JSON.parse(content)
+      else
+        {}
+      end
+    rescue JSON::ParserError
+      raise ParserError
+    end
+
+    def self.present?(string)
+      string && !string.empty?
+    end
+  end
+end

data/lib/load_file/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module LoadFile
+  VERSION = "1.0.0"
+end

data/load_file.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "load_file/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "load_file"
+  spec.version       = LoadFile::VERSION
+  spec.authors       = ["Juanito Fatas"]
+  spec.email         = ["me@juanitofatas.com"]
+
+  spec.summary       = %q{A Ruby gem to load file into desired constant.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/juanitofatas/load_file"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) 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", "~> 1.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: load_file
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juanito Fatas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: A Ruby gem to load file into desired constant.
+email:
+- me@juanitofatas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hack
+- bin/setup
+- examples/.travis.yml
+- examples/app.json
+- lib/load_file.rb
+- lib/load_file/loader.rb
+- lib/load_file/parser.rb
+- lib/load_file/version.rb
+- load_file.gemspec
+homepage: https://github.com/juanitofatas/load_file
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to load file into desired constant.
+test_files: []