frebby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9887b888bece3f3120b9640d910f4baae8ed2de3
-  data.tar.gz: e244028a95008565e9a5b02fb8309f2825cb1561
+  metadata.gz: 97043fa483d88a805f61f08f9e514d424833a515
+  data.tar.gz: ecfad287eea03a9a05a2ef3ff55f47c497a37592
 SHA512:
-  metadata.gz: 9647df78942991006f7d8763b9a18c1d1acd4320d5aada28c5e51fe7b778a35ddf5d7ae825614cdac0dbea55b6602ee19fe9ae1f072578f5a212bd68eac48985
-  data.tar.gz: d11c7a9b550d31769392409c88846f3cfd25f4dc2e6b313c50367ffc6e9972b6a4f065d2547a8eafc5cbb63f881548cca3513d8012a200334c2cb0f2ae74bef8
+  metadata.gz: 3bc7fb6746daa275c3d0034520220c90b075474071deafa9184a235cca030d6e5ddd56d7f272a1b4b051a6a7d3c42985de2bc13f76b740f5788532f993e55f51
+  data.tar.gz: 89fa4c9184fe09b6824c380734f71edeffba2d9d6c62113e905392455df03ae9e02070e14f9ec5dc09fcb96c95653d37b578ff454dcd29f5712733e77b26ab99

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,232 @@
+# frebby
+
+[![Gem](https://img.shields.io/gem/v/frebby.svg?style=plastic)][gem]
+[![Travis](https://img.shields.io/travis/oclaussen/frebby.svg?style=plastic)][travis]
+
+[gem]: https://rubygems.org/gems/frebby
+[travis]: http://travis-ci.org/oclaussen/frebby
+
+
+## What is this?
+
+`frebby` is a very, very simple Ruby script that generates JSON out of a Ruby
+based configuration language. It is intended as an alternative to the numerous
+attempts to write a more human-readable language for tool configuration (YAML,
+TOML, HCL, to name a few).
+
+In contrast to these other languages, `frebby` is not a full blown parser.
+Instead it takes a bunch of Ruby code, `eval`s it  and turns it into JSON. The
+result can then be fed to basically anything that can read JSON.
+
+## Why should I use this?
+
+Everyone has a different opinion on how powerful a configuration language should
+be. Some people prefer a very strict and foolproof language while others prefer
+full blown programming languages. For most, the answer is somewhere in the
+middle. This tool is aimed at those who sit quite far in the programming
+language camp and who feel YAML and HCL are lacking in possibilities.
+
+### The Good
+
+* Use all the power of a full programming language for tools that usually
+  wouldn't support this (Ansible, Terraform, Packer, ...)
+
+* Keep all your infrastructure defined in one consistent language
+
+* Works with anything that expects configuration files in JSON format
+  (or YAML, or HCL, since these are just supersets of JSON)
+
+* No dependencies (except Ruby, of course)
+
+### The Bad
+
+* You need Ruby installed, and some level of Ruby knowledge will help also
+
+* It is another tool in you build chain and adds some level of complexity
+
+* There are some very good arguments for keeping the configuration for your
+  infrastructure as simple and obvious as possible. Using a turing complete
+  configuration language to set up the most critical parts of your
+  infrastructure just asks for trouble. With great power and so on.
+
+### The Ugly
+
+* Due to the way frebby uses (abuses?) the Ruby programming language, there
+  are some quirks where it will not immediately work the way you would expect.
+  See the relevant [examples](examples/04_quirks) details.
+
+## How do I use this?
+
+### Installation & Usage
+
+At its core, frebby is just a very simple ruby script without dependencies. In
+theory, it is enough to just download the [main file](bin/frebby) and put it
+anywhere in your `$PATH`. However, this won't get you the additional customization
+options. Instead there are more convenient options available:
+
+Usually you will want to install frebby directly from rubygems:
+
+```bash
+gem install frebby
+```
+
+Once installed, usage is pretty simple: The `frebby` command simply takes any
+number of configuration files as input, either as arguments or from stdin,
+and output JSON on stdout. There are no other arguments or configurations
+to worry about.
+
+```bash
+frebby /path/to/config/file.rb /path/to/other/config.rb > /new/json/config.json
+
+# alternatively:
+frebby < /path/to/config/file.rb > /new/json/config.json
+```
+
+Aternatively, if you don't want to install Ruby locally, you can use frebby
+out of Docker:
+
+```bash
+docker pull oclaussen/frebby
+docker run --rm -i oclaussen/frebby < /path/to/config/file.rb
+```
+
+Remember that you need to either pass your config files to the docker container
+via stdin or mount your working directory, so that frebby can find them.
+
+### Configuration syntax
+
+Configuration for frebby is written in Ruby. The basic syntax looks like the
+love child of HCL and Chef's recipe DSL and should be immediately familiar
+to anyhone who has worked with either of them.
+
+```ruby
+# Basic types (strings, numbers, lists, hashes) can be used just like
+# in Ruby:
+
+some_number 5
+
+some_string <<EOF
+This is
+a very long
+text
+EOF
+
+# Nested objects are created like this:
+
+some_object 'some_nested_object' do
+  some_key 'some value'
+  some_other_key 'some other value'
+end
+
+# Lists of objects are created by repeated blocks:
+
+some_list do
+  some_key 'some value'
+end
+
+some_list do
+  some_other_key 'some_other_value'
+end
+```
+
+This example will produce the following JSON output (minus formatting):
+
+```json
+{
+  "some_number": 5,
+  "some_string": "This is\na very long\ntext\n",
+  "some_object": {
+    "some_nested_object": {
+      "some_key": "some value",
+      "some_other_key": "some other value"
+    }
+  },
+  "some_list": [
+    {
+      "some_key": "some value"
+    },
+    {
+      "some_other_key": "some other value"
+    }
+  ]
+}
+```
+
+For some more detailed examples, see the [examples](examples).
+
+### Customization
+
+It is also possible to exert a little more control over how frebby translates
+to JSON.
+
+```ruby
+# There are a bunch of customization functions available, that will act whenever
+# frebby tries to transform a key, value or the whole end result
+
+# Every translation goes through all registered customization functions, and
+# will apply the first one that returns a non-null result.
+
+require 'frebby/hooks'
+
+::Frebby.customize_key do |key, **_data|
+  'new_key' if %w[some_key some_other_key].include?(key)
+end
+
+::Frebby.customize_value do |value, **_data|
+  value.sub('value', 'thing') if value.is_a? String
+end
+
+::Frebby.customize_result do |result, **_data|
+  result['copied_field'] = result['copy_this']
+  result
+end
+
+some_object do
+  some_key 'some value'
+  some_completely_other_key 'some completely other value'
+
+  some_nested_object do
+    some_other_key 'some other value'
+  end
+end
+
+copy_this 'this value should be copied'
+```
+
+This example will produce the following JSON output:
+
+```json
+{
+  "some_object": {
+    "new_key": "some thing",
+    "some_completely_other_key": "some completely other thing",
+    "some_nested_object": {
+      "new_key": "some other thing"
+    }
+  },
+  "copy_this": "this thing should be copied",
+  "copied_field": "this thing should be copied"
+}
+```
+
+frebby also offers some more convenience functions that take care of common use
+cases. There are also some useful presets for existing tools. Again, take a look
+at the [examples](examples) for some inspiration.
+
+## License & Authors
+
+```text
+Copyright 2018 Ole Claussen
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop)
+RSpec::Core::RakeTask.new(:rspec)
+
+task default: %i[clean rubocop rspec]
+task all: %i[clean rubocop rspec build]

data/frebby.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name           = 'frebby'
+  spec.version        = '1.0.1'
+  spec.author         = 'Ole Claussen'
+  spec.email          = 'claussen.ole@gmail.com'
+  spec.license        = 'Apache-2.0'
+  spec.summary        = 'vs. JSON'
+  spec.description    = <<~DESCRIPTION
+    `frebby` is a very, very simple Ruby script that generates JSON out of a Ruby
+    based configuration language. It is intended as an alternative to the numerous
+    attempts to write a more human-readable language for tool configuration (YAML,
+    TOML, HCL, to name a few).
+  DESCRIPTION
+  spec.homepage       = 'https://github.com/oclaussen/frebby'
+
+  spec.require_paths  = ['lib']
+  spec.bindir         = 'bin'
+  spec.executables    = ['frebby']
+  spec.files          = Dir['lib/**/*.rb'] + 
+                        Dir['bin/*'] +
+                        Dir['*.gemspec'] + 
+                        %w[LICENSE README.md Gemfile Rakefile]
+
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frebby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ole Claussen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-10 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -63,7 +63,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
 - bin/frebby
+- frebby.gemspec
 - lib/frebby/hooks.rb
 - lib/frebby/presets/ansible.rb
 - lib/frebby/presets/packer.rb