kubes 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbdaabc58ed6ae8e1c2941431c61a3e7edf7708b7782f1d456b4bcf2b01ef777
-  data.tar.gz: '04290becf20d593ba00d214dd2e790eac5501e3e8f5e3b62d636b3e882b7a5e1'
+  metadata.gz: f4943b1a730b2ab6d80a6de3128d6a55182a02f75c6ed176ab5bdc2eef9e080a
+  data.tar.gz: 0d30261fa44bb60fa61bc9d38ada888469caa27b42e09c19e59edbbed52ab190
 SHA512:
-  metadata.gz: 302a4a216bc5007de836e335cc38e4fcd8d4c4db8d873f4333d862f84dbcfd32c302ba72c8123392f2a1679ca419be15ef660818f2b75a06b05cb0250a469198
-  data.tar.gz: dbbf8a825b893490963db61c6b08d2adf45ef62be0bad19d44235b1b822077ebb4e8728d45d119dddfb6f33e39ecb3d69ccb89ceda938275b8371306ca72efaa
+  metadata.gz: 3a17f532fa0b257a92b79fd1975c6d83ba0d7fc6f4d56c7e01f0937d9f64b16bae2e3637364acc258027f0c3fe434f1732221dedc8461587c45a9fcaea4c873b
+  data.tar.gz: 91e88038fcdfd9925567936c2a665d097ac739d2ebb17191526357bbd227336ffe57c389e946f44b6ce78ed27022901f2c78ee64f2aacdcbeda490a51d35e35a

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.4.6]
+- #32 custom helpers support
+
 ## [0.4.5]
 - #31 kubes AWS helpers
 

data/docs/_docs/helpers/custom.md

@@ -0,0 +1,40 @@
+---
+title: Custom Helpers
+---
+
+Kubes ships with several built-in helpers. On top of this, you can define your own custom helpers.  This allows you to define new methods and customize Kubes further.
+
+## Example
+
+You define custom helpers in the `.kubes/helpers` folder.
+
+.kubes/helpers/my_helpers.rb
+
+```ruby
+module MyHelpers
+  def database_endpoint
+    case Kubes.env
+    when "dev"
+      "dev-db.cbuqdmc3nqvb.us-west-2.rds.amazonaws.com"
+    when "prod"
+      "prod-db.cbuqdmc3nqvb.us-west-2.rds.amazonaws.com"
+    end
+  end
+end
+```
+
+The `database_endpoint` will be available to use in the `.kubes/resources` YAML files. IE:
+
+.kubes/helpers/resources/shared/config_map.yaml
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: demo
+  labels:
+    app: demo
+data:
+  DATABASE_ENDPOINT: <%= database_endpoint %>
+```
+

data/docs/_includes/sidebar.html

@@ -99,6 +99,7 @@
       </li>
       <li><a href="{% link _docs/helpers.md %}">Helpers</a>
         <ul>
+          <li><a href="{% link _docs/helpers/custom.md %}">Custom</a></li>
           <li><a href="{% link _docs/helpers/aws.md %}">AWS</a>
             <ul>
               {% assign docs = site.docs | where: "categories","helpers-aws" %}

data/lib/kubes/autoloader.rb

@@ -14,8 +14,17 @@ module Kubes
         loader = Zeitwerk::Loader.new
         loader.inflector = Inflector.new
         loader.push_dir(File.dirname(__dir__)) # lib
+
+        helpers = "#{kubes_root}/.kubes/helpers"
+        loader.push_dir(helpers) if File.exist?(helpers) # project helpers
+
         loader.setup
       end
+
+      # Autoloader runs so early that Kubes.root is not available, so we must declare it here
+      def kubes_root
+        ENV['KUBES_ROOT'] || '.'
+      end
     end
   end
 end

data/lib/kubes/compiler/shared/custom_helpers.rb

@@ -0,0 +1,17 @@
+module Kubes::Compiler::Shared
+  module CustomHelpers
+    # Load custom helper methods from project
+    @@custom_helpers_loaded = false
+    def load_custom_helpers
+      return if @@custom_helpers_loaded
+      paths = Dir.glob("#{Kubes.root}/.kubes/helpers/**/*.rb")
+      paths.sort_by! { |p| p.size } # so namespaces are loaded first
+      paths.each do |path|
+        filename = path.sub(%r{.*.kubes/helpers/},'').sub('.rb','')
+        module_name = filename.camelize
+        self.class.send :include, module_name.constantize
+      end
+      @@custom_helpers_loaded = true
+    end
+  end
+end

data/lib/kubes/compiler/strategy/base.rb

@@ -2,6 +2,7 @@ class Kubes::Compiler::Strategy
   class Base
     include Kubes::Logging
     include Kubes::Compiler::Util::SaveFile
+    include Kubes::Compiler::Shared::CustomHelpers
 
     def initialize(options={})
       @options = options

data/lib/kubes/compiler/strategy/dsl.rb

@@ -3,6 +3,7 @@ class Kubes::Compiler::Strategy
     include Kubes::Compiler::Util::Normalize
 
     def run
+      load_custom_helpers
       dsl = dsl_class.new(@options) # Deployment, Service, etc
       data = dsl.run
       Result.new(@save_file, data)

data/lib/kubes/compiler/strategy/erb.rb

@@ -4,10 +4,12 @@ class Kubes::Compiler::Strategy
   class Erb < Base
     extend Kubes::Compiler::Dsl::Core::Fields
     include Kubes::Compiler::Dsl::Core::Helpers
+    include Kubes::Compiler::Shared::CustomHelpers
     include Kubes::Compiler::Shared::Helpers
     include Kubes::Compiler::Layering
 
     def run
+      load_custom_helpers
       @data = {}
 
       render_files(pre_layers)

data/lib/kubes/version.rb

@@ -1,3 +1,3 @@
 module Kubes
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubes
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Tung Nguyen
@@ -303,6 +303,7 @@ files:
 - docs/_docs/helpers/aws/iam-role.md
 - docs/_docs/helpers/aws/secrets.md
 - docs/_docs/helpers/aws/ssm.md
+- docs/_docs/helpers/custom.md
 - docs/_docs/helpers/google.md
 - docs/_docs/helpers/google/secrets.md
 - docs/_docs/helpers/google/service-account.md
@@ -557,6 +558,7 @@ files:
 - lib/kubes/compiler/dsl/syntax/service.rb
 - lib/kubes/compiler/dsl/syntax/service_account.rb
 - lib/kubes/compiler/layering.rb
+- lib/kubes/compiler/shared/custom_helpers.rb
 - lib/kubes/compiler/shared/helpers.rb
 - lib/kubes/compiler/strategy.rb
 - lib/kubes/compiler/strategy/base.rb