yml2h 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6be9f9bcb989cdbf7bb2ba92cb7179ea3df2af3e5b54af2d2c6de92479088ecc
+  data.tar.gz: 8c4ee2028d7f1dc16dc7f06ec51a132fd4fec45ba4c8b44e0cbd44ede7498d0b
+SHA512:
+  metadata.gz: b9958cceef3e79bac85cb1efc6694721f1f72f5fc6a258babeb5ecaef0787a7fa34fb61b3bef5fee49b03744e1e67cf9f4fe998e37c5fbbfa81cacd9b98e007c
+  data.tar.gz: 4ed77e767fa0007a620f1a01a314ebcad47a0669910d54eb8a71d76342afc41dbf2655476f84bdafddefdf603270b72ec6cbd4b3b8b56d9f51a668abc2cea9ed

data/README.md

@@ -0,0 +1,40 @@
+# Yml2h
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yml2h`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yml2h'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yml2h
+
+## Usage
+
+TODO: Write usage instructions 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/[USERNAME]/yml2h.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/examples/compile_erb/meta.yml.erb

@@ -0,0 +1,5 @@
+---
+:meta:
+  :created_at: !ruby/object:DateTime <%= @meta[:created_at] %>
+  :updated_at: !ruby/object:DateTime <%= @meta[:updated_at] %>
+  :uuid: <%= @meta[:uuid] %>

data/examples/compile_erb/users.yml.erb

@@ -0,0 +1,17 @@
+---
+:users: <% @users.each do |user| %>
+  - :name: <%= user[:name] %>
+    :email: <%= user[:email] %>
+    :tos_acceptance: <%= user[:tos_acceptance] %>
+    :address:
+      :street: <%= user[:address][:street] %>
+    :profile:
+      :introduction: <%= user[:profile][:introduction] %>
+      :hobbies: <% user[:profile][:hobbies].each do |hobby| %>
+        - <%= hobby %>
+      <% end %>
+    :meta:
+      :created_at: !ruby/object:DateTime <%= user[:meta][:created_at] %>
+      :updated_at: !ruby/object:DateTime <%= user[:meta][:updated_at] %>
+      :uuid: <%= user[:meta][:uuid] %>
+<% end %>

data/examples/compile_yml/meta.yml

@@ -0,0 +1,5 @@
+---
+:meta:
+  :created_at: 2019-09-01 00:00:00.000000000 +00:00
+  :updated_at: 2019-09-01 00:00:00.000000000 +00:00
+  :uuid: "f0000000-f000-f000-f000-f00000000000"

data/examples/compile_yml/users.yml

@@ -0,0 +1,15 @@
+---
+:users:
+  - :name: "Mario Lopez"
+    :email: "lil@mr.e"
+    :tos_acceptance: true
+    :address:
+      :street: "foosgonewild"
+    :profile:
+      :introduction: "foosgonewild.com/shop"
+      :hobbies:
+        - stuntin'
+    :meta:
+      :created_at: 2019-09-01 00:00:00.000000000 +00:00
+      :updated_at: 2019-09-01 00:00:00.000000000 +00:00
+      :uuid: "f0000000-f000-f000-f000-f00000000000"

data/examples/fixture_team_hash.yml.erb

@@ -0,0 +1,30 @@
+# A team "fixture", using ERB+ivars to get dynamically-generated values
+---
+:name: <%= @name %>
+:rank: <%= @rank %>
+:users: <% @users.each do |user| %>
+  - :name: <%= user[:name] %>
+    :email: <%= user[:email] %>
+    :tos_acceptance: <%= user[:tos_acceptance] %>
+    :address:
+      :street: <%= user[:address][:street] %>
+    :profile:
+      :introduction: <%= user[:profile][:introduction] %>
+      :hobbies: <% user[:profile][:hobbies].each do |hobby| %>
+        - <%= hobby %>
+      <% end %>
+    :meta:
+      :created_at: !ruby/object:DateTime <%= user[:meta][:created_at] %>
+      :updated_at: !ruby/object:DateTime <%= user[:meta][:updated_at] %>
+      :uuid: <%= user[:meta][:uuid] %>
+<% end %>
+:budget:
+  :amount: <%= @budget[:amount] %>
+  :meta:
+    :created_at: !ruby/object:DateTime <%= @budget[:meta][:created_at] %>
+    :updated_at: !ruby/object:DateTime <%= @budget[:meta][:updated_at] %>
+    :uuid: <%= @budget[:meta][:uuid] %>
+:meta:
+  :created_at: !ruby/object:DateTime <%= @meta[:created_at] %>
+  :updated_at: !ruby/object:DateTime <%= @meta[:updated_at] %>
+  :uuid: <%= @meta[:uuid] %>

data/examples/fixture_team_ostruct.yml.erb

@@ -0,0 +1,31 @@
+# A team "fixture", using ERB+ivars to get dynamically-generated values to ouput a ruby OpenStruct
+--- !ruby/object:OpenStruct
+table:
+  :name: <%= @name %>
+  :rank: <%= @rank %>
+  :users: <% @users.each do |user| %>
+    - :name: <%= user[:name] %>
+      :email: <%= user[:email] %>
+      :tos_acceptance: <%= user[:tos_acceptance] %>
+      :address:
+        :street: <%= user[:address][:street] %>
+      :profile:
+        :introduction: <%= user[:profile][:introduction] %>
+        :hobbies: <% user[:profile][:hobbies].each do |hobby| %>
+          - <%= hobby %>
+        <% end %>
+      :meta:
+        :created_at: !ruby/object:DateTime <%= user[:meta][:created_at] %>
+        :updated_at: !ruby/object:DateTime <%= user[:meta][:updated_at] %>
+        :uuid: <%= user[:meta][:uuid] %>
+  <% end %>
+  :budget:
+    :amount: <%= @budget[:amount] %>
+    :meta:
+      :created_at: !ruby/object:DateTime <%= @budget[:meta][:created_at] %>
+      :updated_at: !ruby/object:DateTime <%= @budget[:meta][:updated_at] %>
+      :uuid: <%= @budget[:meta][:uuid] %>
+  :meta:
+    :created_at: !ruby/object:DateTime <%= @meta[:created_at] %>
+    :updated_at: !ruby/object:DateTime <%= @meta[:updated_at] %>
+    :uuid: <%= @meta[:uuid] %>

data/examples/team_hash.yml

@@ -0,0 +1,28 @@
+# An example "Team", as a plain ruby hash
+---
+:name: "Foos"
+:rank: 1
+:users:
+  - :name: "Mario Lopez"
+    :email: "lil@mr.e"
+    :tos_acceptance: true
+    :address:
+      :street: "foosgonewild"
+    :profile:
+      :introduction: "foosgonewild.com/shop"
+      :hobbies:
+        - stuntin'
+    :meta:
+      :created_at: 2019-09-01 00:00:00.000000000 +00:00
+      :updated_at: 2019-09-01 00:00:00.000000000 +00:00
+      :uuid: "f0000000-f000-f000-f000-f00000000000"
+:budget:
+  :amount: 1000000
+  :meta:
+    :created_at: 2019-09-01 00:00:00.000000000 +00:00
+    :updated_at: 2019-09-01 00:00:00.000000000 +00:00
+    :uuid: "f0000000-f000-f000-f000-f00000000000"
+:meta:
+  :created_at: 2019-09-01 00:00:00.000000000 +00:00
+  :updated_at: 2019-09-01 00:00:00.000000000 +00:00
+  :uuid: "f0000000-f000-f000-f000-f00000000000"

data/examples/team_ostruct.yml

@@ -0,0 +1,29 @@
+# An example Team as an OpenStruct, with ERB tags (no variables)
+--- !ruby/object:OpenStruct
+table:
+  :name: "Foos"
+  :rank: 1
+  :users:
+    - :name: "Mario Lopez"
+      :email: "lil@mr.e"
+      :tos_acceptance: true
+      :address:
+        :street: "foosgonewild"
+      :profile:
+        :introduction: "foosgonewild.com/shop"
+        :hobbies:
+          - stuntin'
+      :meta:
+        :created_at: <%= DateTime.parse("2019-09-01") %>
+        :updated_at: <%= DateTime.parse("2019-09-01") %>
+        :uuid: "f0000000-f000-f000-f000-f00000000000"
+  :budget:
+    :amount: 1000000
+    :meta:
+      :created_at: <%= DateTime.parse("2019-09-01") %>
+      :updated_at: <%= DateTime.parse("2019-09-01") %>
+      :uuid: "f0000000-f000-f000-f000-f00000000000"
+  :meta:
+    :created_at: <%= DateTime.parse("2019-09-01") %>
+    :updated_at: <%= DateTime.parse("2019-09-01") %>
+    :uuid: "f0000000-f000-f000-f000-f00000000000"

data/lib/yml2h.rb

@@ -0,0 +1,89 @@
+require_relative "yml2h/version"
+require "erb"
+require "fileutils"
+require "ostruct"
+require "yaml"
+
+module Yml2h
+  module Write
+    attr_writer :output_file
+    def write_to_yaml!(path = nil)
+      destination = path || @output_file || "anonymous.yml"
+      write_to_yaml(self, Pathname.new(destination))
+    end
+
+    # NOTE: When a hash is extended with Write, #write_to_yaml becomes available as a private method.
+    module_function
+
+    # @param object [Object] A ruby object which can be written to YAML
+    # @param path [String] An absolute path which the YAML will be written to
+    def write_to_yaml(hash, path)
+      File.open(path, "w") { |f| f.write(hash.to_yaml) }
+    end
+  end
+
+  module Read
+    attr_writer :input_file
+    def read_from_yaml!(path = nil, permitted_classes: nil)
+      input = path || @input_file || "anonymous.yml"
+      read_from_yaml(input, permitted_classes: permitted_classes)
+    end
+
+    module_function
+
+    # @param path [String, Pathname] An absolute path to parseable YAML contents
+    # @param permitted_classes [Array<Object>] Keyword arg; Additive list of classes to permit when loading a file
+    def read_from_yaml(path, permitted_classes: nil)
+      raw = ERB.new(Pathname.new(path).read).result(binding)
+      permitted_classes ||= [Symbol, Struct, OpenStruct, Time, Date, DateTime]
+      YAML.safe_load(raw, permitted_classes: permitted_classes)
+    rescue ArgumentError => e
+      # TODO: Remove after ruby 2.5 support dropped (currently only here for AWS compat)
+      fail e unless e.message.match?(/unknown keyword: permitted_classes/)
+      YAML.safe_load(raw, permitted_classes)
+    end
+  end
+
+  module Compile
+    attr_writer :input_dir
+    def compile_from_dir!(dir = nil, extension: false, **options)
+      source = dir || @input_dir || `pwd`.chomp
+      compile_from_dir(Pathname.new(source), extension: extension, **options).to_h
+    end
+
+    module_function
+
+    # @param dir [String, Pathname] An absolute path to a directory which will have YAML files
+    # @param extension [Boolean] Whether or not to keep the file extension in the compiled result
+    # @param options @see Read#read_from_yaml
+    # @return [Array<Array<String, Object>>] Set of arrays where idx0 is the file name (extension optionally truncated), idx1 the attributes
+    def compile_from_dir(dir, extension: false, **options)
+      include_fixtures = singleton_class.included_modules.include?(Read)
+      file_extensions = %w[yml yaml]
+      file_extensions += %w[yml.erb yaml.erb] if include_fixtures
+
+      Dir.glob("#{dir}/*.{#{file_extensions.join(",")}}").map do |filename|
+        definition = filename
+
+        # Drop final "/" and extension unless specified
+        unless extension
+          # Drop extension
+          definition = definition.gsub(/\.(yml|yaml)(\.erb)?\z/i, "")
+          # Capture final "/" onwards
+          definition = definition.match(/\/\w+\z/i).to_s
+          # Drop "/"
+          definition = definition.sub("/", "")
+        end
+
+        # If we have access to Read#read_from_yaml!, use it here for injecting our current binding
+        as_object = if include_fixtures
+          read_from_yaml!(filename, **options)
+        else
+          Read.read_from_yaml(filename, **options)
+        end
+
+        [definition, as_object]
+      end
+    end
+  end
+end

data/lib/yml2h/version.rb

@@ -0,0 +1,3 @@
+module Yml2h
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: yml2h
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Trevor James
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  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-byebug
+  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: 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: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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: 
+email: trevor@osrs-stat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- examples/compile_erb/meta.yml.erb
+- examples/compile_erb/users.yml.erb
+- examples/compile_yml/meta.yml
+- examples/compile_yml/users.yml
+- examples/fixture_team_hash.yml.erb
+- examples/fixture_team_ostruct.yml.erb
+- examples/team_hash.yml
+- examples/team_ostruct.yml
+- lib/yml2h.rb
+- lib/yml2h/version.rb
+homepage: https://github.com/fire-pls/yml2h
+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.5.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.4
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: Convert Ruby hashes to YAML & vice-versa
+test_files: []