rubycfn 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29062bf33bd5efb1396cbeceb1377db608577eaf
-  data.tar.gz: ce1c38eb6a9160a03ecc284fa17e6b80f2cdef8c
+  metadata.gz: c09925e14474150813c8cc1fc68f659c2fd9b4f6
+  data.tar.gz: 147d961011de3e4452b273cd9d7192fa14bfa50a
 SHA512:
-  metadata.gz: bcc956f265c0d06d16d1b2b53e06273c9abec57005ee83a2c50b13ce0016e4ee83a44452b49b3e7dc46f5b0081d5c365547d624f53efc01ebe8773cfdb93e5df
-  data.tar.gz: c7edb919f6eebee33003ea1ad8aa780e9d52e83708c7421828148fa20eb523d1855cc4f6317526e3257afc3542fb8136f984fcf36470ddb4a0101ac4dbe633e1
+  metadata.gz: a2d9cc012275a915b20b7ceaaf952d40d741d74b1efb5b22f5d84c62d448e000f9ad021607a53a12ed4e94d252331ece33cb6725fb3ce0af9a90e3c85b8d5fad
+  data.tar.gz: 4f4fd5565902584c1568bb5ed8198783a2f3ba6befe96a3a20d9de65206ddf2c6b4ccc46f261ec1d9fafb65d3fea5e26e2aa19c2cd3ad68bb260508c9293d985

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    rubycfn (0.1.0)
+    rubycfn (0.1.1)
       activesupport (~> 5.1.5)
+      dotenv (~> 2.4.0)
       json (~> 2.1.0)
       neatjson (~> 0.8.4)
+      tty-prompt (~> 0.16.0)
 
 GEM
   remote: https://rubygems.org/
@@ -21,6 +23,8 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     docile (1.3.1)
+    dotenv (2.4.0)
+    equatable (0.5.0)
     ffi (1.9.25)
     formatador (0.2.5)
     given_core (3.8.0)
@@ -39,6 +43,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
+    hitimes (1.3.0)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
@@ -52,10 +57,14 @@ GEM
     method_source (0.9.0)
     minitest (5.11.3)
     neatjson (0.8.4)
+    necromancer (0.4.0)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    pastel (0.7.2)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -95,8 +104,24 @@ GEM
     sorcerer (1.0.2)
     thor (0.20.0)
     thread_safe (0.3.6)
+    timers (4.1.2)
+      hitimes
+    tty-color (0.4.2)
+    tty-cursor (0.5.0)
+    tty-prompt (0.16.1)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.0)
+      timers (~> 4.0)
+      tty-cursor (~> 0.5.0)
+      tty-reader (~> 0.3.0)
+    tty-reader (0.3.0)
+      tty-cursor (~> 0.5.0)
+      tty-screen (~> 0.6.4)
+      wisper (~> 2.0.0)
+    tty-screen (0.6.4)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    wisper (2.0.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -12,10 +12,14 @@ or, create a Gemfile with this content:
 ```
 source "https://rubygems.org"
 
-gem "rubycfn", "~> 0.1.0"
+gem "rubycfn", "~> 0.1.1"
 
 ```
 
+## Starting a new project
+
+Typing `rubycfn` at the prompt and answering its questions generates a new sample project.
+
 ## Example code
 
 You can find stack examples at [https://github.com/dennisvink/rubycfn-example](https://github.com/dennisvink/rubycfn-example/)

data/bin/rubycfn

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require "erb"
+require 'fileutils'
+require 'ostruct'
+require "tty-prompt"
+require "rubycfn/version"
+
+require_relative "../lib/cli_methods"
+
+path = File.expand_path(File.dirname(File.dirname(__FILE__)))
+puts rubycfn_banner(Rubycfn::VERSION)
+prompt = TTY::Prompt.new
+
+project_name = prompt.ask('Project name?', default: 'example') do |q|
+  q.validate(/^([a-z0-9]*)$/, 'Invalid project name')
+end
+
+project_path = project_name + '-rubycfn'
+
+account_id = prompt.ask('AWS Account ID?', default: '1234567890') do |q|
+  q.validate(/^([0-9]*)$/, 'Invalid account id')
+end
+
+region = prompt.select(
+  "Select AWS region", aws_regions
+)
+
+dotenv = render('.env', {
+  :project_name => project_name,
+  :account_id => account_id,
+  :region => region
+}, path)
+
+dotenv_test = render('.env.test', { project_name: project_name }, path)
+gemfile = render('Gemfile', { version: Rubycfn::VERSION }, path)
+rakefile = render('Rakefile', {}, path)
+main = render('main.rb', {}, path)
+compile = render('compile.rb', {}, path)
+global_variables = render('global_variables.rb', {}, path)
+project_stack = render('project_stack.rb', { name: project_name.capitalize }, path)
+project_concern = render('project_concern.rb', { name: project_name.capitalize }, path)
+
+# Create directory structure
+FileUtils.mkdir_p project_path + '/lib/stacks/' + project_name + '_stack'
+rubycfn_structure(project_path).each do |dir|
+  FileUtils.mkdir_p dir
+end
+
+File.open("#{project_path}/.env", 'w') { |file| file.write(dotenv) }
+File.open("#{project_path}/.env.test", 'w') { |file| file.write(dotenv_test) }
+File.open("#{project_path}/Gemfile", 'w') { |file| file.write(gemfile) }
+File.open("#{project_path}/Rakefile", 'w') { |file| file.write(rakefile) }
+File.open("#{project_path}/lib/main.rb", 'w') { |file| file.write(main) }
+File.open("#{project_path}/lib/compile.rb", 'w') { |file| file.write(compile) }
+File.open("#{project_path}/lib/shared_concerns/global_variables.rb", 'w') { |file| file.write(global_variables) }
+File.open("#{project_path}/lib/stacks/#{project_name}_stack.rb", 'w') { |file| file.write(project_stack) }
+File.open("#{project_path}/lib/stacks/#{project_name}_stack/example.rb", 'w') { |file| file.write(project_concern) }
+

data/lib/cli_methods.rb

@@ -0,0 +1,45 @@
+def render(file, vars, path)
+  template = File.read("#{path}/templates/#{file}.erb")
+  ERB.new(template).result(OpenStruct.new(vars).instance_eval { binding })
+end
+
+def aws_regions
+  [
+    { name: "US East (N. Virginia)", value: "us-east-1" },
+    { name: "US East (Ohio)", value: "us-east-2" },
+    { name: "US West (N. California)", value: "us-west-1" },
+    { name: "US West (Oregon)", value: "us-west-2" },
+    { name: "Canada (Central)", value: "ca-central-1" },
+    { name: "EU (Frankfurt)", value: "eu-central-1" },
+    { name: "EU (Ireland)", value: "eu-west-1" },
+    { name: "EU (London)", value: "eu-west-2" },
+    { name: "EU (Paris)", value: "eu-west-3" },
+    { name: "Asia Pacific (Tokyo)", value: "ap-northeast-1" },
+    { name: "Asia Pacific (Seoul)", value: "ap-northeast-2" },
+    { name: "Asia Pacific (Osaka-Local)", value: "ap-northeast-3" },
+    { name: "Asia Pacific (Singapore)", value: "ap-southeast-1" },
+    { name: "Asia Pacific (Sydney)", value: "ap-southeast-2" },
+    { name: "Asia Pacific (Mumbai)", value: "ap-south-1" },
+    { name: "South America (São Paulo)", value: "sa-east-1" }
+  ]
+end
+
+def rubycfn_banner(version)
+  [
+    "__________ ____ __________________.___._________ _____________________ ",
+    "\\______   \\    |   \\______   \\__  |   |\\_   ___ \\\\_   _____/\\______   \\",
+    " |       _/    |   /|    |  _//   |   |/    \\  \\/ |    __)   |    |  _/",
+    " |    |   \\    |  / |    |   \\\\____   |\\     \\____|     \\    |    |   \\",
+    " |____|_  /______/  |______  // ______| \\______  /\\___  /    |______  /",
+    "        \\/                 \\/ \\/               \\/     \\/            \\/ [v#{version}]"
+  ].join("\n")
+end
+
+def rubycfn_structure(project_name)
+  [
+    project_name,
+    project_name + '/build',
+    project_name + '/lib/stacks',
+    project_name + '/lib/shared_concerns'
+  ]
+end

data/lib/rubycfn/version.rb

@@ -1,4 +1,4 @@
 # Rubycfn version
 module Rubycfn
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/rubycfn.gemspec

@@ -14,12 +14,15 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.2.0"
   spec.license       = "MIT"
   spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(/(?:test|spec|features)/)
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "neatjson", "~> 0.8.4"
   spec.add_runtime_dependency "json", "~> 2.1.0"
   spec.add_runtime_dependency "activesupport", "~> 5.1.5"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.16.0"
+  spec.add_runtime_dependency "dotenv", "~> 2.4.0"
 
   spec.add_development_dependency "awesome_print", "~> 1.2"
   spec.add_development_dependency "bundler", "~> 1.7"

data/templates/.env.erb

@@ -0,0 +1,4 @@
+AWS_ACCOUNT_ID="<%= account_id %>"
+AWS_REGION="<%= region %>"
+PROJECT_NAME="<%= project_name %>"
+ENVIRONMENT="test"

data/templates/.env.test.erb

@@ -0,0 +1,2 @@
+# ENV vars for test environment
+SOME_ENV_VAR="my-awesome-s3-bucket-for-<%= project_name %>-test"

data/templates/Gemfile.erb

@@ -0,0 +1,3 @@
+source 'https://rubygems.org' do
+  gem 'rubycfn', '~> <%= version %>'
+end

data/templates/Rakefile.erb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+desc "Compile CloudFormation"
+task :compile do
+  require_relative "lib/main"
+  require_relative "lib/compile"
+end
+
+task default: [:compile]

data/templates/compile.rb.erb

@@ -0,0 +1,16 @@
+require 'fileutils'
+
+FileUtils.mkdir_p 'build'
+
+stacks = {}
+Module.constants.select do |mod|
+  if mod =~ /Stack$/
+    send("include", Object.const_get("SharedConcerns"))
+    stacks[mod.to_sym] = send("include", Object.const_get(mod)).render_template
+  end
+end
+
+stacks.each do |stack_name, stack|
+  puts "- Saved #{stack_name} to build/#{stack_name.downcase}.json"
+  File.open("build/#{stack_name.downcase}.json", "w") { |f| f.write(stack) }
+end

data/templates/global_variables.rb.erb

@@ -0,0 +1,12 @@
+module Concerns
+  module GlobalVariables
+    extend ActiveSupport::Concern
+
+    included do
+      variable :environment,
+               default: "test",
+               global: true,
+               value: ENV["ENVIRONMENT"]
+    end
+  end
+end

data/templates/main.rb.erb

@@ -0,0 +1,30 @@
+require "rubycfn"
+require "dotenv"
+
+Dotenv.load(".env")
+Dotenv.load(".env.private")
+Dotenv.load(".env.#{ENV["ENVIRONMENT"]}")
+
+# Include all group concerns
+Dir[File.expand_path('../shared_concerns/', __FILE__) + '/*.rb'].sort.each do |file|
+  require file
+end
+
+# SharedConcerns module is injected in each stack
+module SharedConcerns
+  extend ActiveSupport::Concern
+  include Rubycfn
+
+  included do
+    include Concerns::GlobalVariables
+  end
+end
+
+# Include all stack concerns
+Dir[File.expand_path('../stacks/', __FILE__) + '/*.rb'].sort.each do |file|
+  subdir = File.basename(file, ".rb") 
+  Dir[File.expand_path('../stacks/', __FILE__) + "/#{subdir}/*.rb"].sort.each do |subfile|
+    require subfile
+  end
+  require file
+end

data/templates/project_concern.rb.erb

@@ -0,0 +1,42 @@
+module <%= name %>Stack
+  module Main
+    extend ActiveSupport::Concern
+
+    included do
+      # Example stack parameter
+      #parameter :example_stack_parameter_name,
+      #          default: "example_value"
+
+      # Example variable
+      variable :example_variable,
+               required: false,
+               value: ENV["SOME_ENV_VAR"],
+               default: "default_value"
+
+      # Example resource, custom name
+      resource :my_example_s3_bucket,
+               type: "AWS::S3::Bucket" do |r|
+        #r.depends_on "SomeLogicalResourceName"
+        r.property(:name) { example_variable }
+      end
+
+      # Example resource, dynamically generated name
+      resource :my_example_s3_bucket,
+               type: "AWS::S3::Bucket"
+
+      # Multiple resources of the same type
+      resource :my_sqs_queue,
+               amount: 3,
+               type: "AWS::SQS::Queue"
+
+      queue_names = %w(MyFirstQueue MySecondQueue)
+
+      # Multiple resources with index, starts at 0
+      resource :sqs_with_index,
+               amount: 2,
+               type: "AWS::SQS::Queue" do |r, index|
+         r.property(:queue_name) { queue_names[index] }
+      end
+    end
+  end
+end

data/templates/project_stack.rb.erb

@@ -0,0 +1,8 @@
+module <%= name %>Stack
+  extend ActiveSupport::Concern
+  include Rubycfn
+
+  included do
+    include <%= name %>Stack::Main
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycfn
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dennis Vink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neatjson
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.1.5
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -223,7 +251,8 @@ dependencies:
 description: RubyCFN is a light-weight CloudFormation DSL
 email:
 - dennis@drvink.com
-executables: []
+executables:
+- rubycfn
 extensions: []
 extra_rdoc_files: []
 files:
@@ -232,11 +261,22 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- bin/rubycfn
+- lib/cli_methods.rb
 - lib/rubycfn.rb
 - lib/rubycfn/version.rb
 - rubycfn.gemspec
 - spec/lib/rubycfn_spec.rb
 - spec/spec_helper.rb
+- templates/.env.erb
+- templates/.env.test.erb
+- templates/Gemfile.erb
+- templates/Rakefile.erb
+- templates/compile.rb.erb
+- templates/global_variables.rb.erb
+- templates/main.rb.erb
+- templates/project_concern.rb.erb
+- templates/project_stack.rb.erb
 homepage: https://github.com/dennisvink/rubycfn
 licenses:
 - MIT
@@ -265,3 +305,4 @@ test_files:
 - rubycfn.gemspec
 - spec/lib/rubycfn_spec.rb
 - spec/spec_helper.rb
+- templates/.env.test.erb