load_file 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370bdebd061e99a284e045ac276ebbf6525957656b133873acb19aa2206fcf6f
-  data.tar.gz: 1fdc0d2148d432bc65b61bcaa5e002e7e74eecc3bb0eb90721c6cceb0f7cfc70
+  metadata.gz: 763d76493f7cb8621d494224c8d5e398dc9162e0b5d4f79ce848dc85a54ded9d
+  data.tar.gz: 978f14a25d1e48357cf46b6700bd7fbe10f41302ba9e51efdf31a16445d4ed59
 SHA512:
-  metadata.gz: 87067068f85f261224bb1b19f0b164aa1f1c3f8a15f32c42253df95d43e71e3017fc714e5146731624050598c86b08b8c2ef7386dba2798c5e9cd90b65ac4c6e
-  data.tar.gz: b8208625d5c588b40e6a24c36627a755726c0d45ee9e4e7bc353a7da70e5234519f930729ce9a579d0d67bcad0c4af123b6a46b0db532c46910d8c02d75eee51
+  metadata.gz: ab5f12d5a81dc50355ab08280efa961155c5b7cbf32da8233e6ca61ae2cb94fd10a4e52f78ca2abee0d2fb7b99fe3320381c2f4e0e0b561b599609e27721fe00
+  data.tar.gz: 84c6c5d28f16bfd5c298f58024b9c1368276070792cf601ae4432f19a01954778fc299652e11aaa4b5482a2399618b2265baa76e22570541fab5c9c6265292b6

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Unreleased
+
+## 1.1.0
+
+- Adds support to (over)load file(s) into namespaced constant
+- documentation fixes
+
 ## 1.0.0
 
 1.0.0 includes:

data/README.md

@@ -1,5 +1,14 @@
 # LoadFile
 
+[![Gem Version](https://badge.fury.io/rb/os_name.svg)][gem]
+[![Build Status](https://travis-ci.org/JuanitoFatas/load_file.svg?branch=master)][travis]
+[![inch-ci.org doc badge](https://inch-ci.org/github/juanitofatas/load_file.svg?branch=master)][docinfo]
+
+[gem]: https://rubygems.org/gems/load_file
+[travis]: https://travis-ci.org/JuanitoFatas/load_file
+[docs]: https://inch-ci.org/github/juanitofatas/load_file
+[docinfo]: https://www.rubydoc.info/github/JuanitoFatas/load_file/master
+
 Load/Overload YAML/JSON file(s) into desired constant.
 
 ## Installation
@@ -28,13 +37,25 @@ HerokuApp
   "environments"=>{"test"=>{"scripts"=>{"test"=>"bundle exec rake test"}}}}
 ```
 
+You can also load into a namespaced constant:
+
+```ruby
+LoadFile.load(file: "examples/app.json", constant: :App, namespace: Heroku)
+
+# Heroku::App will be the hash loaded from examples/app.json
+```
+
+The caveat here is the keyword argument `namespace` must be a ruby object.
+
+Or should I introduce `constantize`? Please let me know.
+
 ### 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/JuanitoFatas/loadfile.
 
 ## License
 

data/lib/load_file.rb

@@ -6,58 +6,63 @@ require "load_file/loader"
 module LoadFile
   # Loads file into constant.
   #
-  # @param [String, Pathname, File] path to load the file from
-  # @param [String, Symbol] constant name to load into
+  # @param file [String, Pathname, File] path to load the file from
+  # @param constant [String, Symbol] constant name to load into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @return [Hash] loaded file content
   # @return [NilClass] nil when file not exists
-  def self.load(file:, constant:)
+  def self.load(file:, constant:, namespace: Object)
     ignore_file_not_exists do
-      reader = Loader.new(file, constant)
-      reader.set_constant
+      loader = Loader.new(file, constant, namespace: namespace)
+      loader.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
+  # @param file [String, Pathname, File] path to load the file from
+  # @param constant [String, Symbol] constant name to load into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @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
+  def self.load!(file:, constant:, namespace: Object)
+    loader = Loader.new(file, constant, namespace: namespace)
+    loader.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
+  # @param files [Array<String>] list of files to load
+  # @param constant [String, Symbol] constant name to load into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @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) }
+  def self.load_files(files:, constant:, namespace: Object)
+    files.each { |file| load(file: file, constant: constant, namespace: namespace) }
   end
 
   # Loads files into constant.
   #
-  # @param [Array<String>] list of files to load
-  # @param [String, Symbol] constant name to load into
+  # @param files [Array<String>] list of files to load
+  # @param constant [String, Symbol] constant name to load into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @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) }
+  def self.load_files!(files:, constant:, namespace: Object)
+    files.each { |file| load!(file: file, constant: constant, namespace: namespace) }
   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
+  # @param file [String, Pathname, File] path to overload the file from
+  # @param constant [String, Symbol] constant name to overload into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @return [Hash] overloaded file content
   # @return [NilClass] nil when file not exists
-  def self.overload(file:, constant:)
+  def self.overload(file:, constant:, namespace: Object)
     ignore_file_not_exists do
-      reader = Loader.new(file, constant)
+      reader = Loader.new(file, constant, namespace: namespace)
       reader.set_constant!
     end
   end
@@ -65,12 +70,13 @@ module LoadFile
   # 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
+  # @param file [String, Pathname, File] path to overload the file from
+  # @param constant [String, Symbol] constant name to overload into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @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)
+  def self.overload!(file:, constant:, namespace: Object)
+    reader = Loader.new(file, constant, namespace: namespace)
     reader.set_constant!
   end
 
@@ -78,23 +84,25 @@ module LoadFile
   # 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
+  # @param files [Array<String>] list of files to overload
+  # @param constant [String, Symbol] constant name to overload into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @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) }
+  def self.overload_files(files:, constant:, namespace: Object)
+    files.each { |file| overload(file: file, constant: constant, namespace: namespace) }
   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
+  # @param files [Array<String>] list of files to overload
+  # @param constant [String, Symbol] constant name to overload into
+  # @param namespace [Object] namespace to find/load the constant, defaults to Object
   # @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) }
+  def self.overload_files!(files:, constant:, namespace: Object)
+    files.each { |file| overload!(file: file, constant: constant, namespace: namespace) }
   end
 
   # @private

data/lib/load_file/loader.rb

@@ -6,8 +6,9 @@ module LoadFile
   #
   # @return [Hash] parsed YAML or JSON content
   class Loader < Hash
-    def initialize(file, constant_name)
+    def initialize(file, constant_name, namespace: Object)
       @file = file
+      @namespace = namespace
       @constant = find_or_define(constant_name)
 
       update parsed_content
@@ -25,13 +26,13 @@ module LoadFile
 
     private
 
-    attr_reader :file, :constant
+    attr_reader :file, :constant, :namespace
 
     def find_or_define(constant_name)
-      if Object.const_defined?(constant_name)
-        Object.const_get(constant_name)
+      if namespace.const_defined?(constant_name)
+        namespace.const_get(constant_name)
       else
-        Object.const_set(constant_name, {})
+        namespace.const_set(constant_name, {})
       end
     end
 

data/lib/load_file/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: load_file
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Juanito Fatas