aws-ec2 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c555a3e325c610710e0db4ab6839ae08a29020f96c06b740c5283b383d4c34a5
-  data.tar.gz: 3deb2d4cf2bbf39fb48dea6050ed1be67d2b3dcb4b68298bde8ad2bfc4ed8517
+  metadata.gz: 7eed22f3840f438dbfab2212334abcd8e4337e850f234bd7392e42e95fd0c6e7
+  data.tar.gz: 4d8cb388ffe2b1cbe1e5efdfd28e4d363443b8b4eba97b5f1843220310bbb439
 SHA512:
-  metadata.gz: 81e3a1e2e6186fb146aa3377afab79430170853bb579c3782a877be38592a33dd0c4980d7bc68c7f992be5b4e4f31e85537b989459fe80b49395c9bcebf3bdaa
-  data.tar.gz: 51dacb024e89a664e3c0b642a21220a67108a264f35d39d41ff25f9f9ece4acfec906e9f3ac01300238efc38b3ec9061ba3f4aba04af03ec40cc8009c7604f7e
+  metadata.gz: bfb928c51a9c89ded35ab43752a188e99bb5bd1f6f0cd784a20f977a36e4e9e1c9e1134a2379f761d77420342c2b78746bc4b8c162d9946c9a98ad1017c6a811
+  data.tar.gz: 2561e05ead626c13ca00b65f2760c7e34f8b63daafc02145c75e414d275c6d4706ac67f77f410e636a5593ba9a3f9d01f9e42af7e0097b11c1eb6f0cbae440bc

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.8.1]
+- reorganize template helpers into core and update readme
+
 ## [0.8.0]
 - aws-ec2 upload_scripts command
 - rename aws-ec2 compile to aws-ec2 compile_scripts

data/README.md

@@ -23,10 +23,7 @@ config | Access to the variables set in config/[AWS_EC2_ENV].yml.
 latest_ami | Returns an AMI id by searching the ami name pattern and sorting in reverse older.  Example: `latest_ami("ruby-2.5.0_*")`
 search_ami | Returns a collection of AMI image objects based on a search pattern. The query searches on the AMI name.
 
-The template helpers defined in:
-
-* [aws_ec2/template_helper.rb](lib/aws_ec2/template_helper.rb).
-* [aws_ec2/template_helper](lib/aws_ec2/template_helper).
+For a full list of all the template helpers checkout: [aws_ec2/template_helper](lib/aws_ec2/template_helper).
 
 You can also define your own custom helpers in the `app/helpers` folder as ruby modules with the naming convention `'*_helper.rb`.  Example, the module FooHelper  should be defined in `app/helpers/foo_helper.rb`.  The custom helpers are first class citizens and have access to the same variables and methods as built in helpers.
 

data/lib/aws_ec2/script/upload.rb

@@ -5,12 +5,13 @@ class AwsEc2::Script
   class Upload < AwsEc2::Base
     def initialize(options={})
       @options = options
+      @compile = @options[:compile] ? @options[:compile] : true
     end
 
     def upload
-      compiler.compile if @options[:compile]
+      compiler.compile if @compile
       sync_scripts_to_s3
-      compiler.clean if @options[:compile] and !ENV['AWS_EC2_KEEP']
+      compiler.clean if @compile and !ENV['AWS_EC2_KEEP']
     end
 
     def sync_scripts_to_s3

data/lib/aws_ec2/template_helper.rb

@@ -1,5 +1,3 @@
-require "base64"
-require "erb"
 require "active_support/all"
 
 module AwsEc2
@@ -15,99 +13,5 @@ module AwsEc2
         include const_get(class_name)
       end
     end
-
-    def user_data(name, base64=true)
-      # allow user to specify the path also
-      if File.exist?(name)
-        name = File.basename(name) # normalize name, change path to name
-      end
-      name = File.basename(name, '.sh')
-      path = "#{AwsEc2.root}/app/user-data/#{name}.sh"
-      result = erb_result(path)
-      result = append_scripts(result)
-
-      # save the unencoded user-data script for easy debugging
-      temp_path = "/tmp/aws-ec2/user-data.txt"
-      FileUtils.mkdir_p(File.dirname(temp_path))
-      IO.write(temp_path, result)
-
-      base64 ? Base64.encode64(result).strip : result
-    end
-
-    # provides access to config/* settings as variables
-    #   AWS_EC2_ENV=development => config/development.yml
-    #   AWS_EC2_ENV=production => config/production.yml
-    def config
-      AwsEc2.config
-    end
-
-    # pretty timestamp that is useful for ami ids.
-    # the timestamp is generated once and cached.
-    def timestamp
-      @timestamp ||= Time.now.strftime("%Y-%m-%d-%H-%M-%S")
-    end
-
-  private
-    def append_scripts(user_data)
-      # assuming user-data script is a bash script for simplicity
-      script = AwsEc2::Script.new(@options)
-      user_data += script.auto_terminate if @options[:auto_terminate]
-      user_data += script.create_ami if @options[:ami_name]
-      user_data
-    end
-
-    # Load custom helper methods from the project repo
-    def load_custom_helpers
-      Dir.glob("#{AwsEc2.root}/app/helpers/**/*_helper.rb").each do |path|
-        filename = path.sub(%r{.*/},'').sub('.rb','')
-        module_name = filename.classify
-
-        require path
-        self.class.send :include, module_name.constantize
-      end
-
-    end
-
-    def erb_result(path)
-      load_custom_helpers
-      template = IO.read(path)
-
-      # Allow a way to bypass the custom ERB error handling in case
-      # the error is in the lambdagem code.
-      if ENV['DEBUG']
-        return ERB.new(template, nil, "-").result(binding)
-      end
-
-      begin
-        ERB.new(template, nil, "-").result(binding)
-      rescue Exception => e
-        puts e
-
-        # how to know where ERB stopped? - https://www.ruby-forum.com/topic/182051
-        # syntax errors have the (erb):xxx info in e.message
-        # undefined variables have (erb):xxx info in e.backtrac
-        error_info = e.message.split("\n").grep(/\(erb\)/)[0]
-        error_info ||= e.backtrace.grep(/\(erb\)/)[0]
-        raise unless error_info # unable to find the (erb):xxx: error line
-        line = error_info.split(':')[1].to_i
-        puts "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{path.sub(/^\.\//, '')}"
-
-        template_lines = template.split("\n")
-        context = 5 # lines of context
-        top, bottom = [line-context-1, 0].max, line+context-1
-        spacing = template_lines.size.to_s.size
-        template_lines[top..bottom].each_with_index do |line_content, index|
-          line_number = top+index+1
-          if line_number == line
-            printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
-          else
-            printf("%#{spacing}d %s\n", line_number, line_content)
-          end
-        end
-
-        puts "\nIf the this error does not make sense and the error is not in the ERB template. Run the command again with DEBUG=1 to show the full lambdagem backtrace"
-        exit 1 unless ENV['TEST']
-      end
-    end
   end
 end

data/lib/aws_ec2/template_helper/core.rb

@@ -0,0 +1,98 @@
+require "base64"
+require "erb"
+
+module AwsEc2::TemplateHelper::Core
+  def user_data(name, base64=true)
+    # allow user to specify the path also
+    if File.exist?(name)
+      name = File.basename(name) # normalize name, change path to name
+    end
+    name = File.basename(name, '.sh')
+    path = "#{AwsEc2.root}/app/user-data/#{name}.sh"
+    result = erb_result(path)
+    result = append_scripts(result)
+
+    # save the unencoded user-data script for easy debugging
+    temp_path = "/tmp/aws-ec2/user-data.txt"
+    FileUtils.mkdir_p(File.dirname(temp_path))
+    IO.write(temp_path, result)
+
+    base64 ? Base64.encode64(result).strip : result
+  end
+
+  # provides access to config/* settings as variables
+  #   AWS_EC2_ENV=development => config/development.yml
+  #   AWS_EC2_ENV=production => config/production.yml
+  def config
+    AwsEc2.config
+  end
+
+  # pretty timestamp that is useful for ami ids.
+  # the timestamp is generated once and cached.
+  def timestamp
+    @timestamp ||= Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+  end
+
+private
+  def append_scripts(user_data)
+    # assuming user-data script is a bash script for simplicity
+    script = AwsEc2::Script.new(@options)
+    user_data += script.auto_terminate if @options[:auto_terminate]
+    user_data += script.create_ami if @options[:ami_name]
+    user_data
+  end
+
+  # Load custom helper methods from the project repo
+  def load_custom_helpers
+    Dir.glob("#{AwsEc2.root}/app/helpers/**/*_helper.rb").each do |path|
+      filename = path.sub(%r{.*/},'').sub('.rb','')
+      module_name = filename.classify
+
+      require path
+      self.class.send :include, module_name.constantize
+    end
+
+  end
+
+  def erb_result(path)
+    load_custom_helpers
+    template = IO.read(path)
+
+    # Allow a way to bypass the custom ERB error handling in case
+    # the error is in the lambdagem code.
+    if ENV['DEBUG']
+      return ERB.new(template, nil, "-").result(binding)
+    end
+
+    begin
+      ERB.new(template, nil, "-").result(binding)
+    rescue Exception => e
+      puts e
+
+      # how to know where ERB stopped? - https://www.ruby-forum.com/topic/182051
+      # syntax errors have the (erb):xxx info in e.message
+      # undefined variables have (erb):xxx info in e.backtrac
+      error_info = e.message.split("\n").grep(/\(erb\)/)[0]
+      error_info ||= e.backtrace.grep(/\(erb\)/)[0]
+      raise unless error_info # unable to find the (erb):xxx: error line
+      line = error_info.split(':')[1].to_i
+      puts "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{path.sub(/^\.\//, '')}"
+
+      template_lines = template.split("\n")
+      context = 5 # lines of context
+      top, bottom = [line-context-1, 0].max, line+context-1
+      spacing = template_lines.size.to_s.size
+      template_lines[top..bottom].each_with_index do |line_content, index|
+        line_number = top+index+1
+        if line_number == line
+          printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
+        else
+          printf("%#{spacing}d %s\n", line_number, line_content)
+        end
+      end
+
+      puts "\nIf the this error does not make sense and the error is not in the ERB template. Run the command again with DEBUG=1 to show the full lambdagem backtrace"
+      exit 1 unless ENV['TEST']
+    end
+  end
+end

data/lib/aws_ec2/version.rb

@@ -1,3 +1,3 @@
 module AwsEc2
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-ec2
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Tung Nguyen
@@ -223,6 +223,7 @@ files:
 - lib/aws_ec2/scripts/auto_terminate.sh
 - lib/aws_ec2/template_helper.rb
 - lib/aws_ec2/template_helper/ami_helper.rb
+- lib/aws_ec2/template_helper/core.rb
 - lib/aws_ec2/template_helper/partial_helper.rb
 - lib/aws_ec2/version.rb
 - spec/fixtures/demo_project/config/test.yml