extended_yaml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75375be6f35d137f2c0cc92fcd0a69b8c706ab0f4152566d0b6dc037d0b66204
+  data.tar.gz: 6ea26f239f8a148d5e07c0e20f6e30e734834ffe37953be1e79041b47fd21257
+SHA512:
+  metadata.gz: 8df1afcc6db22d7a5ce02f67c71839d2e62648af49f0df3532fcec88965506e7a758df286d507720097de766f38f378b060ba1eba350b59ef01729dcbb21b91b
+  data.tar.gz: 91592326390e18c981cf25cd668c63a9727c8b3b9ce067ef9006e112d845fcf6c034e324baf3dc5c1a42070c628c6cf9b89d1ce639a244e78735d169ba2becdd

data/README.md

@@ -0,0 +1,77 @@
+Extended YAML
+==================================================
+
+[![Gem Version](https://badge.fury.io/rb/extended_yaml.svg)](https://badge.fury.io/rb/extended_yaml)
+
+---
+
+ExtendedYAML adds a couple of additional features to the standard YAML 
+library:
+
+1. Each YAML file can extend (inherit from) other YAML files by specifying
+   `extends: other_file` 
+2. YAML files are parsed for ERB tags.
+
+It is a simpler reimplementation of [yaml_extend][1].
+
+
+Installation
+--------------------------------------------------
+
+
+    $ gem install extended_yaml
+
+
+
+Usage
+--------------------------------------------------
+
+Given this [simple.yml](examples/simple.yml) file:
+
+```yaml
+extends: subdir/production.yml
+
+settings:
+  host: localhost
+  port: 80
+```
+
+which uses `extends` to load this
+[subdir/production.yml](examples/subdir/production.yml) file.
+
+```yaml
+settings:
+  host: example.com
+```
+
+We can now load the extended YAML file likw this:
+
+```ruby
+# Load an extended YAML
+require 'extended_yaml'
+
+p ExtendedYAML.load 'examples/simple.yml'
+#=> {"settings"=>{"host"=>"example.com", "port"=>80}}
+```
+
+Notes
+--------------------------------------------------
+
+1. Arrays will be merged.
+2. Nested hashes will be merged.
+3. Other types of values will be overridden based on which loaded file was
+   the last to define them.
+4. ERB tags will be evaluated in all YAML files.
+5. The `extends` option can use either a single file string, or an array. 
+   Extensions are optional.
+6. If you need to use a key that is named differently, provide it using the
+   `key` keyword argument:
+   ```ruby
+   ExtendedYAML.load 'examples/simple.yml, key: 'include'
+   ```
+
+See the [examples/master.yml](examples/master.yml) file for additional
+information.
+
+
+[1]: https://github.com/magynhard/yaml_extend

data/lib/extended_yaml.rb

@@ -0,0 +1,57 @@
+require 'extended_yaml/deep_merge'
+require 'erb'
+require 'yaml'
+
+class ExtendedYAML
+  using DeepMerge
+  attr_reader :file, :key
+
+  # @param [String] file path to YAML file
+  # @param [String] key YAML key to use for loading files
+  # @return [Hash, Array] the parsed YAML
+  def self.load(file, key: 'extends')
+    new(file, key: key).result
+  end
+
+  def initialize(file, key: 'extends')
+    @file, @key = file, key
+  end
+
+  # @return [Hash, Array] the parsed YAML
+  def result
+    data = ::YAML.load evaluate
+    resolve_extends data
+  end
+
+  # @return [String] the YAML string, with evaluated and ERB
+  def evaluate
+    ERB.new(File.read file).result
+  end
+
+private
+
+  def extension
+    @extension ||= File.extname file
+  end
+
+  def base_dir
+    @base_dir ||= File.dirname file
+  end
+
+  # @param [Hash] data structure, possibly with 'extends' array
+  # @return [Hash] the merged data
+  def resolve_extends(data)
+    extra_files = data.delete key
+    return data unless extra_files
+
+    extra_files = [extra_files] unless extra_files.is_a? Array
+
+    extra_files.each do |extra_file|
+      extra_file = extra_file + extension unless extra_file.end_with? extension
+      path = File.expand_path extra_file, base_dir
+      data.deep_merge! self.class.new(path).result
+    end
+
+    data
+  end
+end

data/lib/extended_yaml/deep_merge.rb

@@ -0,0 +1,24 @@
+class ExtendedYAML
+  # Hash refinement to allow deep merging of other hashes.
+  module DeepMerge
+    refine Hash do
+      def deep_merge(other_hash, &block)
+        dup.deep_merge! other_hash, &block
+      end
+
+      def deep_merge!(other_hash, &block)
+        merge!(other_hash) do |key, this_val, other_val|
+          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+            this_val.deep_merge(other_val, &block)
+          elsif this_val.is_a? Array and other_val.is_a? Array
+            this_val + other_val
+          # elsif block_given?
+          #   block.call(key, this_val, other_val)
+          else
+            other_val
+          end
+        end
+      end
+    end
+  end
+end

data/lib/extended_yaml/version.rb

@@ -0,0 +1,3 @@
+class ExtendedYAML
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: extended_yaml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-25 00:00:00.000000000 Z
+dependencies: []
+description: Load YAML files that deep merge other YAML files
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/extended_yaml.rb
+- lib/extended_yaml/deep_merge.rb
+- lib/extended_yaml/version.rb
+homepage: https://github.com/dannyben/extended_yaml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Load YAML files that merge other YAML files
+test_files: []