rubycfn 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0849cb139ac3748d7b632536c72f4cfdd24cbdb
-  data.tar.gz: a2dfc5d8d89ea55f7ca693ebd264f71f4b37efe7
+  metadata.gz: 7f56448eca7fe5adea74e68fd2b33d2e92919150
+  data.tar.gz: bf9b226d2110b922e81adcb5acc7ef6d67a51182
 SHA512:
-  metadata.gz: d84760f33c8903f332e4b78c969768bf550a7b25ae50c4df22f0cdf0b9572ba7439c1cfc6ffa8b19bc93b9e4f647c841d2b5d783b46c41c772d263186b78f908
-  data.tar.gz: 281ed98ef84978bc640d4ab7ffd475fa2c9d30777e81007aca22ee3dded7ffe53e36804abb744fd68f9d7492a5cff7b20b1f1f0317408a9c9bec2b8d445b7c43
+  metadata.gz: 0d01000310dc22988c4c9658c7900366d62d00f1f27d5181f1498ab8d59796160674b987eb32f922364a6cef4867ddbe554bbba4067df11cdc68f15ebc0befc0
+  data.tar.gz: 71b2895125dc7fc470e6b9166fa4021b0a9a15331992c8bcfa8952337288859394343d885c831b27607f79a4891cc5e44f55482f6c48e013eb16c7ed44a70cf4

data/CHANGELOG.md

@@ -2,8 +2,11 @@
 All notable changes to Rubycfn will be documented in this file.
 This project uses [Semantic Versioning](http://semver.org/).
 
-## 0.2.2 (Next Release)
+## 0.3.1 (Next Release)
 
+## 0.3.0
+  * Removed non-AWS code. For non-AWS resources pin to 0.2.1 -- [@dennisvink][@dennisvink]
+ 
 ## 0.2.1
   * Fixed bug in VPC compound resource. Resource names are now camel cased -- [@dennisvink][@dennisvink]
   * Updated README.md -- [@dennisvink][@dennisvink]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubycfn (0.2.1)
+    rubycfn (0.3.0)
       activesupport (~> 5.1.5)
       dotenv (~> 2.4.0)
       json (~> 2.1.0)
@@ -11,25 +11,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.6)
+    activesupport (5.1.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     awesome_print (1.8.0)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     docile (1.3.1)
     dotenv (2.4.0)
     equatable (0.5.0)
-    ffi (1.9.25)
+    ffi (1.10.0)
     formatador (0.2.5)
     given_core (3.8.0)
       sorcerer (>= 0.3.7)
-    guard (2.14.2)
+    guard (2.15.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -43,8 +43,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hitimes (1.3.0)
-    i18n (1.1.1)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     launchy (2.4.3)
@@ -54,7 +53,7 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
-    method_source (0.9.0)
+    method_source (0.9.2)
     minitest (5.11.3)
     neatjson (0.8.4)
     necromancer (0.4.0)
@@ -65,14 +64,14 @@ GEM
     pastel (0.7.2)
       equatable (~> 0.5.0)
       tty-color (~> 0.4.0)
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.3)
     rake (10.5.0)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -85,7 +84,7 @@ GEM
     rspec-given (3.8.0)
       given_core (= 3.8.0)
       rspec (>= 2.14.0)
-    rspec-its (1.2.0)
+    rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
     rspec-mocks (3.8.0)
@@ -102,10 +101,9 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     sorcerer (1.0.2)
-    thor (0.20.0)
+    thor (0.20.3)
     thread_safe (0.3.6)
-    timers (4.1.2)
-      hitimes
+    timers (4.3.0)
     tty-color (0.4.3)
     tty-cursor (0.5.0)
     tty-prompt (0.16.1)

data/README.md

@@ -1,7 +1,7 @@
 # RubyCfn
 
 [RubyCfn](https://rubycfn.com/) is a light-weight tiny CloudFormation, Deployment Manager and ARM DSL to make expressing
-cloud vendor templates as Ruby code a bit more pleasing to the eye.
+AWS templates as Ruby code a bit more pleasing to the eye.
 
 ## Quick start
 
@@ -10,7 +10,7 @@ Install Rubycfn:
 
 Starting a new Rubycfn project:
 `rubycfn`
-$ rubycfn
+```$ rubycfn
 __________ ____ __________________.___._________ _____________________
 \______   \    |   \______   \__  |   |\_   ___ \\_   _____/\______   \
  |       _/    |   /|    |  _//   |   |/    \  \/ |    __)   |    |  _/
@@ -20,6 +20,7 @@ __________ ____ __________________.___._________ _____________________
 Project name? example
 Account ID? 1234567890
 Select region EU (Frankfurt)
+```
 
 Installing project dependencies:
 `bundle`
@@ -45,7 +46,7 @@ Standardisation is key to keep your engineering team agile. Time spent on projec
 
 ## Overview of Rubycfn
 
-RubyCfn is an abstraction layer around several Cloud templates such as CloudFormation (AWS), Deployment Manager (GCP) and ARM (Azure). Rubycfn projects are set up for easy grouping of resources that have a mutual cohesion, and structured in such a way to make it easy for developers to quickly find what they need. Rubycfn is a so-called ‘DSL’ on top of these template formats and presents templates as code that is friendly to the eye and easy to read and understand. In addition of being an alternate representation of a template, Rubycfn allows you to combine template generation with programming logic making it far more versatile than what the respective cloud providers offer in their templates. Last but not least Rubycfn enforces code quality by testing the generated templates against unit tests, checking if the expected resources and their configuration matches with what was actually generated, and by LINTing the templates and the underlying code that generates the templates.
+RubyCfn is an abstraction layer around several Cloud templates such as CloudFormation (AWS). Rubycfn projects are set up for easy grouping of resources that have a mutual cohesion, and structured in such a way to make it easy for developers to quickly find what they need. Rubycfn is a so-called ‘DSL’ on top of these template formats and presents templates as code that is friendly to the eye and easy to read and understand. In addition of being an alternate representation of a template, Rubycfn allows you to combine template generation with programming logic making it far more versatile than what AWS offers in their templates. Last but not least Rubycfn enforces code quality by testing the generated templates against unit tests, checking if the expected resources and their configuration matches with what was actually generated, and by LINTing the templates and the underlying code that generates the templates.
 
 Out of the box Rubycfn comes with a CI/CD pipeline. It’s a serverless pipeline running on Amazon Web Services (AWS), which you can fully configure using the complimentary `buildspec.yml`.  The CI/CD pipeline is linked to a Github repository, and a change in this repository triggers the CI/CD pipeline to execute the steps you’ve defined in the buildspec.yml.
 
@@ -56,7 +57,7 @@ Typically a commit to your application GIT repository triggers the build process
 - Application (unit) tests are ran
 - The build artifact is stored (versioned), so you can use it as input for your delivery pipeline
 - The artifact may or may not include the application code. A part of the build process could - for example - also be that the application is dockerized and pushed to a docker registry.
-- The resulting artifact is the complete recipe to deploy the application and associated resources to AWS, GCP or Azure.
+- The resulting artifact is the complete recipe to deploy the application and associated resources to AWS
 
 ## Example code
 
@@ -259,9 +260,10 @@ First the flat files:
 `.env` and `.env.test` are files where you store environment variables that you may want to use in your project code. The difference between the .env and the .env.test file is that the .env file is the “global” environment variable file, whereas the .env.test file is an environment-specific environment variable file, that can override values you’ve specified in your .env file (or add new environment variables, for that matter). You’d typically have a .env.test, .env.acceptance and a .env.production file for things like instance sizing.
 
 Example:
-$ cat .env.test
+```$ cat .env.test
 # ENV vars for test environment
 APPLICATION_INSTANCE_CLASS="t2.micro"
+```
 
 To make use of - for example - .env.production as source, you can either override the ENVIRONMENT variable in the .env file, setting it to production, or you can invoke rake as: `ENVIRONMENT="production" rake`.
 
@@ -272,6 +274,7 @@ The `Rakefile` contain the tasks that are performed when you type the `rake` com
 `cfn2rubycfn` is a small helper script that converts AWS CloudFormation scripts to Rubycfn code. This allows you to migrate your existing projects over to Rubycfn quickly. It exports the converted CloudFormation script to `generated.rb`, a ready to use module for your stacks.
 
 Example:
+```
 $ cat sample.json
 {
   "AWSTemplateFormatVersion": "2010-09-09",
@@ -300,6 +303,7 @@ module ConvertedStack
     end
   end
 end
+```
 
 The `format.vim` file is used by the CloudFormation conversion script to reindent the file after conversion. You can make changes to the file to reflect your preferred style of code indentation.
 
@@ -308,16 +312,18 @@ Onto the subdirectories:
 The `build` directory is where all the compiled templates end up.
 
 Example:
+```
 $ ls -al build/
 total 24
 drwxr-xr-x   4 binx  staff   128 Oct 17 16:27 .
 drwxr-xr-x  16 binx  staff   512 Oct 17 16:27 ..
--rw-r--r--   1 binx  staff  3197 Oct 17 16:27 test-gcp-demostack.json
 -rw-r--r--   1 binx  staff  4152 Oct 17 16:27 test-aws-demostack.json
+```
 
 The `spec` directory is where your unit tests live. These are not your application unit tests. A Rubycfn project lives in another universe than your application code. These unit tests test your expectations of the generated templates against reality. Such tests typically check for the existence and absence of particular resources, and values of properties. The tests are always executed when you run the `rake` command or the `rake spec` command. By default a project comes with unit tests that amongst other things check for the generation of the CI/CD pipeline and if it’s been configured correctly.
 
 Example:
+```
       context "Codebuild Service Role" do
         let(:code_build_service_role) { resources["CodeBuildDemoServiceRole"] }
         subject { code_build_service_role }
@@ -347,6 +353,7 @@ Example:
           end
         end
       end
+```
 
 The `config` directory contains your buildspec.yml, which contain all the instructions for the build pipeline. It’s also possible to source the buildspec.yml from another source, such as the application repository.
 
@@ -354,6 +361,7 @@ And finally, the `lib` directory contains all the relevant project code. The `li
 
 There are two directories under `lib`, namely `shared_concerns` and `stacks`. Concerns in this context simply mean Modules. Rubycfn relies on the ActiveConcern gem which makes modularisation of code very easy. The `shared_concerns` directory contains modules that can be used by several stacks. By default it has a `global_variables` module containing the following:
 
+```
 module Concerns
   module GlobalVariables
     extend ActiveSupport::Concern
@@ -366,12 +374,13 @@ module Concerns
     end
   end
 end
-
+```
 This module exposes a variable `environment`, which defaults to `test` if not set. It sources the value from the ENVIRONMENT environment variable. This variable can be used throughout your project at any place you see fit.
 
 The `stacks` directory is a container for all stacks that you want to generate. There is no limitation to the amount of stacks that it supports. By default, it comes with a single stack for your project:
 
 Example `lib/stacks/demo_stack.rb`:
+```
 module DemoStack
   extend ActiveSupport::Concern
   include Rubycfn
@@ -381,7 +390,7 @@ module DemoStack
     include DemoStack::CICD
   end
 end
-
+```
 Our stack file consists of two modules: Main and CICD. When compiling the code, the combined result of the Main and CICD module will be written to the DemoStack json file in the build/ directory. Modularising stacks allows for separation of code by cohesion or any other logic you deem appropriate.
 
 The stacks directory also contains a directory that is named the same, minus the .rb extension: `lib/stacks/demo_stack/`
@@ -389,63 +398,26 @@ The stacks directory also contains a directory that is named the same, minus the
 All the stack modules live inside this directory. The modules that make up the stack are the actual implementation of the resources, parameters and outputs.
 
 An example of such a module:
+```
 module DemoStack
   module Main
     extend ActiveSupport::Concern
     included do
-      import(
-        path: "cloudsql.jinja"
-      )
 
       resource :api_gateway_rest_api,
         type: "AWS::ApiGateway::RestApi" do |r|
         r.property(:name) { "#{environment}-webhook" }
       end
-
-      resource "cloudsql",
-        type: "GCP::cloudsql.jinja" do |r|
-        r.property("database") do
-          {
-            "name": "#{environment}"
-          }
-        end
-        r.property("dbUser") do
-          {
-            "password": "test123_"
-          }
-        end
-        r.property("failover") { true }
-        r.property("readReplicas") { 1 }
-      end
     end
   end
 end
-
-When compiling the project, Rubycfn will recognise the resources for the different Cloud providers and write them to separate template files. When building a cloud agnostic solution, you implement the resources for the respective vendors. To decide which resources are deployed to which cloud provider, and to be able to switch them quickly, you can wrap the resources with `if` statements, but a better solution is to utilise the `amount` property for resources:
-
-      variable :cloudsql_vendor,
-               default: "GCP",
-               value: ENV["CLOUDSQL_VENDOR"]
-
-      resource "cloudsql",
-        amount: cloudsql_vendor == "GCP" ? 1 : 0,
-        type: "GCP::cloudsql.jinja" do |r|
-            ...
-      end
-
-      resource "cloudsql",
-        amount: cloudsql_vendor == "ARM" ? 1 : 0,
-        type: "ARM::MSSQL" do |r|
-			...
-      end
-
-By implementing resources in the above way you can switch particular resources to another cloud vendor by simply updating the environment variable in your CI/CD pipeline, while still being able to use the same variables and the same ecosystem.
+```
 
 ## License
 
 MIT License
 
-Copyright (c) 2018 Dennis Vink
+Copyright (c) 2019 Dennis Vink
 
 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

data/format.vim

@@ -0,0 +1,3 @@
+gg=G
+:retab
+ZZ

data/lib/rubycfn/version.rb

@@ -1,4 +1,4 @@
 # Rubycfn version
 module Rubycfn
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/rubycfn.rb

@@ -14,8 +14,6 @@ require "rubycfn/version"
 @mappings = {}
 @conditions = {}
 @AWSresources = {}
-@GCPresources = []
-@MSFresources = {}
 @imports = []
 @resource_name = ""
 @variables = {}
@@ -274,10 +272,6 @@ module Rubycfn
       end
     end
 
-    def self.import(gcp_import)
-      TOPLEVEL_BINDING.eval("@imports.push(#{gcp_import})")
-    end
-
     def self.depends_on(resources)
       case resources
         when String
@@ -338,24 +332,15 @@ module Rubycfn
             TOPLEVEL_BINDING.eval("@resource_name = ''")
           end
 
-          if arguments[:cloud] == "AWS"
-            res = {
-              "#{name.to_s}#{i == 0 ? "" : resource_postpend}": {
-                DependsOn: TOPLEVEL_BINDING.eval("@depends_on"),
-                Properties: TOPLEVEL_BINDING.eval("@properties"),
-                Type: arguments[:type],
-                Condition: arguments[:condition]
-              }
-            }
-            TOPLEVEL_BINDING.eval("@AWSresources = @AWSresources.deep_merge(#{res})")
-          elsif arguments[:cloud] == "GCP"
-            res = {
-              "name": "#{name.to_s}",
-              "type": "#{arguments[:type].to_s.gsub(/GCP::/, "")}",
-              "properties": TOPLEVEL_BINDING.eval("@properties")
+          res = {
+            "#{name.to_s}#{i == 0 ? "" : resource_postpend}": {
+              DependsOn: TOPLEVEL_BINDING.eval("@depends_on"),
+              Properties: TOPLEVEL_BINDING.eval("@properties"),
+              Type: arguments[:type],
+              Condition: arguments[:condition]
             }
-            TOPLEVEL_BINDING.eval("@GCPresources.push(#{res})")
-          end
+          }
+          TOPLEVEL_BINDING.eval("@AWSresources = @AWSresources.deep_merge(#{res})")
         end
         TOPLEVEL_BINDING.eval("@depends_on = []")
         TOPLEVEL_BINDING.eval("@properties = {}")
@@ -383,15 +368,6 @@ module Rubycfn
         TOPLEVEL_BINDING.eval("@depends_on = []")
         TOPLEVEL_BINDING.eval("@description = ''")
         JSON.pretty_generate(skeleton.recursive_compact)
-      when "GCP"
-        gcp_skeleton = {}
-        gcp_skeleton = JSON.parse(gcp_skeleton.to_json)
-        gcp_skeleton.merge!(imports: TOPLEVEL_BINDING.eval("@imports"))
-        gcp_skeleton.merge!(resources: sort_json(TOPLEVEL_BINDING.eval("@GCPresources")))
-        TOPLEVEL_BINDING.eval("@variables = @outputs = @properties = @mappings = @parameters = {}")
-        TOPLEVEL_BINDING.eval("@imports = @GCPresources = @depends_on = []")
-        TOPLEVEL_BINDING.eval("@description = ''")
-        JSON.pretty_generate(gcp_skeleton.recursive_compact)
       end
     end
   end

data/templates/compile.rb.erb

@@ -7,8 +7,6 @@ stacks = {}
 
 Module.constants.select do |mod|
   if mod =~ /Stack$/
-    send("include", Object.const_get("SharedConcerns"))
-    google_stacks[mod.to_sym] = send("include", Object.const_get(mod)).render_template("GCP")
     send("include", Object.const_get("SharedConcerns"))
     stacks[mod.to_sym] = send("include", Object.const_get(mod)).render_template("AWS")
   end
@@ -18,8 +16,3 @@ stacks.each do |stack_name, stack|
   puts "- Saved #{stack_name} to build/#{ENV["ENVIRONMENT"]}-#{stack_name.downcase}.json"
   File.open("build/#{ENV["ENVIRONMENT"]}-#{stack_name.downcase}.json", "w") { |f| f.write(stack) }
 end
-
-google_stacks.each do |stack_name, stack|
-  puts "- Saved #{stack_name} to build/#{ENV["ENVIRONMENT"]}-gcp-#{stack_name.downcase}.json"
-  File.open("build/#{ENV["ENVIRONMENT"]}-gcp-#{stack_name.downcase}.json", "w") { |f| f.write(stack) }
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycfn
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Dennis Vink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neatjson
@@ -263,6 +263,7 @@ files:
 - README.md
 - Rakefile
 - bin/rubycfn
+- format.vim
 - lib/cli_methods.rb
 - lib/compound.rb
 - lib/compound/resources.rb