kokonfig 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c36e71947f5454fda84c7be1b81debeb45ec5c4f5213d9c9b22cedb6a26fd0e2
+  data.tar.gz: 994c030f2e127b777e0f20309eef204dbc982f0b454a12a9405d0eba825ddfae
+SHA512:
+  metadata.gz: e6608f59a0afc5dbd0f79bb43adf50e2b2504c072da8f43166119473ceee80f5900296a54d5b61b029bd6ef0e5437895484b67735740d28734291faf8df8d92d
+  data.tar.gz: 44872212048b1ac1d5a3a360bc2d045444ad9e6cacdb2f6c644ec92516ab8901fe9d923995a8520dc04bc95805d7b8d832044f6c220ff11f34d1ba4980cf0eaf

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kokonfig.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    kokonfig (0.1.0)
+      erb (~> 2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    erb (2.2.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kokonfig!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Elcio Nakashima
+
+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,77 @@
+# Kokonfig
+
+Kokonfig is a command line utility that generates multiple versions of files based on ERB templates and data YAML files.
+
+Kokonfig can be used to generate config files for each environment in your application when each config mostly contains the same structure but values depend on the environment. It can also be useful when config files contain several repeated values.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kokonfig'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install kokonfig
+
+## Usage
+
+For each set of output files, you need to create an input YAML data file and an ERB template. For each version defined by these two files, Kokonfig will output one file. You just need to put the input files in default directories and run the following command:
+
+```
+kokonfig
+```
+
+### Config files
+
+The data file must be a YAML file containing a mapping and its root level keys will be the name of each output version. Inner keys will be values that can be used in the ERB template file.
+
+The data file name will define what will be the template file and output file names. Everything before the *.yml* extension is the base file name. The template file has to be named with that base file name concatenated with the extension *.erb*. The output files generated will be named with the base file name with each version string before the file extension. The example below will make this clear.
+
+Data files are read from *./config/kokonfig/data* and template files directory is at *./config/kokonfig/templates*. Output files are created in the current working directory. 
+
+### Example
+
+Create a data file *./config/kokonfig/data/result.txt.yml*:
+
+```
+production:
+  country: Australia
+  language: english  
+development:
+  country: Brazil
+  language: portuguese
+```
+
+Create a template file *./config/kokonfig/templates/result.txt.erb*:
+
+```
+In <%= country %> people speak <%= language %>!
+```
+
+After runnning *kokonfig* you should see two files in your current working directory named *result.production.txt* and *result.development.txt*. The file *result.production.txt* should contain:
+
+```
+In Australia people speak english!
+```
+
+## 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/elciok/kokonfig.
+
+
+## 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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kokonfig"
+
+# 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/exe/kokonfig

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'kokonfig'
+Kokonfig::CLI.start

data/kokonfig.gemspec

@@ -0,0 +1,39 @@
+require_relative 'lib/kokonfig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kokonfig"
+  spec.version       = Kokonfig::VERSION
+  spec.authors       = ["Elcio Nakashima"]
+  spec.email         = ["elciok@gmail.com"]
+
+  spec.summary       = %q{Kokonfig is a command line utility that generates multiple versions of files based on ERB templates and data YAML files.}
+  spec.description   = <<~DESCRIPTION
+    Kokonfig is a command line utility that generates multiple versions of files based on ERB templates and data YAML files.
+
+    Kokonfig can be used to generate config files for each environment in your application, when each config mostly contains the same structure but values depend on the environment. It can also be useful when config files contain several repeated values.
+  DESCRIPTION
+  spec.homepage      = "https://github.com/elciok/kokonfig"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/elciok/kokonfig"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.add_dependency "erb", "~> 2.2"
+  # spec.add_dependency "fileutils", "~> 1.4"
+  # spec.add_dependency "ostruct", "~> 0.3"
+  # spec.add_dependency "pathname", "~> 0.1"
+  # spec.add_dependency "yaml", "~> 0.1"
+
+  # 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"]
+end

data/lib/kokonfig.rb

@@ -0,0 +1,10 @@
+require "kokonfig/version"
+require "kokonfig/objectifier"
+require "kokonfig/template"
+require "kokonfig/data_file"
+require "kokonfig/cli"
+
+module Kokonfig
+  class Error < StandardError; end
+
+end

data/lib/kokonfig/cli.rb

@@ -0,0 +1,19 @@
+module Kokonfig
+  CONFIG_DIR = "config/kokonfig"
+  DATA_DIR = "data"
+  TEMPLATES_DIR = "templates"
+
+  module CLI
+    def self.start
+      current_dir = Rails.root rescue Dir.pwd
+      data_dir = File.join(current_dir, CONFIG_DIR, DATA_DIR)
+      templates_dir = File.join(current_dir, CONFIG_DIR, TEMPLATES_DIR)
+      output_dir = current_dir
+
+      Dir.glob("#{data_dir}/**/*.yml").each do |data_file_path|
+        data_file = Kokonfig::DataFile.new(data_file_path, data_dir, templates_dir)
+        data_file.generate_files(output_dir)
+      end
+    end
+  end
+end

data/lib/kokonfig/data_file.rb

@@ -0,0 +1,63 @@
+require 'yaml'
+require 'pathname'
+require 'fileutils'
+
+module Kokonfig
+  class DataFile
+    def initialize(data_file_path, data_dir, templates_dir)
+      @path = data_file_path
+      @data_dir = data_dir
+      @templates_dir = templates_dir
+    end
+
+    def template_path
+      path_parts = []
+      path_parts << @templates_dir
+
+      path_parts << base_result_relative_path if base_result_relative_path.to_s != "."
+
+      template_file_name = "#{base_result_file}.erb"
+      path_parts << template_file_name
+
+      File.join(*path_parts)
+    end
+
+    def result_file(version)
+      path_parts = []
+      path_parts << base_result_relative_path if base_result_relative_path.to_s != "."
+
+      result_base_file_extension = File.extname(base_result_file)
+      result_base_file_name = File.basename(base_result_file, result_base_file_extension)
+      result_file_name = "#{result_base_file_name}.#{version}#{result_base_file_extension}"
+      path_parts << result_file_name
+
+      File.join(*path_parts)
+    end
+
+    def base_result_file
+      @base_result_file or @base_result_file = File.basename(@path, ".yml")
+    end
+
+    def base_result_relative_path
+      @base_result_relative_path or @base_result_relative_path = Pathname.new(@path).relative_path_from(@data_dir).dirname
+    end
+
+    def generate_files(output_dir)
+      template = Kokonfig::Template.from_file(self.template_path)
+
+      data_per_version = YAML.load_file(@path)      
+      data_per_version.each do |version, data|
+        data = data.merge({version: version})
+        rendered_data = template.apply(data)
+
+        FileUtils.mkdir_p(File.join(output_dir, self.base_result_relative_path))
+
+        output_path = File.join(output_dir, self.result_file(version))
+        File.open(output_path, 'w+') do |result_file|
+          result_file.write(rendered_data)
+        end
+      end
+    end
+
+  end
+end

data/lib/kokonfig/objectifier.rb

@@ -0,0 +1,18 @@
+require "ostruct"
+
+module Kokonfig::Objectifier
+  def self.objectify(input)
+    result = input
+    if input.is_a? Hash
+      input.each do |key, value|
+        input[key] = Kokonfig::Objectifier.objectify(value)
+      end
+      result = OpenStruct.new(input)
+    elsif input.is_a? Array
+      input.each_with_index do |value, index|
+        input[index] = Kokonfig::Objectifier.objectify(value)
+      end
+    end
+    result
+  end
+end

data/lib/kokonfig/template.rb

@@ -0,0 +1,21 @@
+require "erb"
+
+module Kokonfig
+  class Template
+
+    def initialize(templateString)
+      @template = templateString
+    end
+
+    def self.from_file(path)
+      template = File.read(path)
+      Kokonfig::Template.new(template)
+    end
+
+    def apply(data)
+      object = Kokonfig::Objectifier.objectify(data)
+      ERB.new(@template, nil, '-').result(object.instance_eval { binding })
+    end
+
+  end
+end

data/lib/kokonfig/version.rb

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: kokonfig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elcio Nakashima
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: |
+  Kokonfig is a command line utility that generates multiple versions of files based on ERB templates and data YAML files.
+
+  Kokonfig can be used to generate config files for each environment in your application, when each config mostly contains the same structure but values depend on the environment. It can also be useful when config files contain several repeated values.
+email:
+- elciok@gmail.com
+executables:
+- kokonfig
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/kokonfig
+- kokonfig.gemspec
+- lib/kokonfig.rb
+- lib/kokonfig/cli.rb
+- lib/kokonfig/data_file.rb
+- lib/kokonfig/objectifier.rb
+- lib/kokonfig/template.rb
+- lib/kokonfig/version.rb
+homepage: https://github.com/elciok/kokonfig
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/elciok/kokonfig
+  source_code_uri: https://github.com/elciok/kokonfig
+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.1.4
+signing_key: 
+specification_version: 4
+summary: Kokonfig is a command line utility that generates multiple versions of files
+  based on ERB templates and data YAML files.
+test_files: []