lono 7.1.0 → 7.2.0

data/lib/lono/finder/extension.rb

@@ -0,0 +1,11 @@
+module Lono::Finder
+  class Extension < Base
+    def type
+      "extension"
+    end
+
+    def detection_path
+      "lib/*/helpers"
+    end
+  end
+end

data/lib/lono/help/user_data.md

@@ -30,7 +30,6 @@ Running `lono user_data bootstrap` produces:
     aws s3 cp s3://mybucket/path/to/folder/development/scripts/scripts-93b8b29b.tgz /opt/
     cd /opt
     tar zxf /opt/scripts-93b8b29b.tgz
-    chmod -R a+x /opt/scripts
     chown -R ec2-user:ec2-user /opt/scripts
 
     SCRIPTS=/opt/scripts

data/lib/lono/jade.rb

@@ -2,10 +2,6 @@ module Lono
   class Jade
     include Circular
     extend Memoist
-    class_attribute :tracked
-    self.tracked = []
-    class_attribute :downloaded
-    self.downloaded = []
 
     delegate :source_type, to: :jadespec
 
@@ -18,7 +14,6 @@ module Lono
       @materialized = false
       @resolved = false
       @depends_ons = []
-      self.class.tracked << self
     end
 
     def repo
@@ -34,7 +29,9 @@ module Lono
 
     def dependencies
       @depends_ons.map do |registry|
-        Lono::Jade.new(registry.depends_on, registry.parent.type, registry)
+        jade = Lono::Jade.new(registry.depends_on, registry.parent.type, registry) # not same sig as register_configset?
+        Lono::Jade::Registry.tracked_configsets << jade
+        jade
       end
     end
 
@@ -56,7 +53,12 @@ module Lono
       return nil unless @jadespec
       if @jadespec.source_type == "materialized"
         # possible "duplicated" jade instances with same name but will uniq in final materialized Gemfile
-        self.class.downloaded << self
+        case @jadespec.lono_type
+        when "configset"
+          Lono::Jade::Registry.downloaded_configsets << self
+        when "extension"
+          Lono::Jade::Registry.downloaded_extensions << self
+        end
       end
       evaluate_meta_rb
       @jadespec
@@ -66,18 +68,23 @@ module Lono
     # Must return config to set @jadespec in materialize
     # Only allow download of Lono::Blueprint::Configset::Jade
     # Other configsets should be configured in project Gemfile.
+    #
+    # Cases:
+    #
+    #    1a) blueprint/configset top-level - download
+    #    1b) blueprint/configset depends_on - download
+    #    2a) configset top-level - dont download, will report to user with validate_all!
+    #    2b) configset depends_on - download
+    #    3) extension - download
+    #
     def download
       return if finder.find(@name, local_only: true) # no need to download because locally found
-      # 4 cases:
-      # 1a) blueprint/configset top-level - download
-      # 1b) blueprint/configset depends_on - download
-      # 2a) configset top-level - dont download, will report to user with validate_all!
-      # 2b) configset depends_on - download
-      return unless %w[blueprint/configset configset].include?(@type) # TODO: support materializing nested blueprints later
-      # only download jades that came from depends_on
-      return unless @registry.parent || @type == "blueprint/configset"
-      jade = Lono::Configset::Materializer::Jade.new(self)
-      jade.build
+      return unless %w[blueprint/configset configset extension].include?(@type)
+      # Comment out. Unsure if this complexity is worth it. Always download jades.
+      # Only download jades that came from depends_on
+      # return unless @registry.parent || %w[blueprint/configset extension].include?(@type)
+      materializer = Materializer.new(self)
+      materializer.build
     end
     memoize :download
 

data/lib/lono/jade/circular.rb

@@ -4,7 +4,7 @@ class Lono::Jade
       circular = circular_dependency?
       return unless circular
 
-      puts "ERROR: configset circular dependency detected".color(:red)
+      puts "ERROR: jade circular dependency detected".color(:red)
       puts "circular dependency: #{parent_names.join(" => ")}"
       exit 1
     end

data/lib/lono/{configset/materializer/jade.rb → jade/materializer.rb}

@@ -1,7 +1,7 @@
 require "bundler"
 
-module Lono::Configset::Materializer
-  class Jade
+class Lono::Jade
+  class Materializer
     extend Memoist
 
     def initialize(jade)
@@ -9,7 +9,7 @@ module Lono::Configset::Materializer
     end
 
     def build
-      GemsBuilder.new(@jade).build
+      Materializer::GemsBuilder.new(@jade).build
     end
   end
 end

data/lib/lono/{configset → jade}/materializer/final.rb

@@ -1,4 +1,4 @@
-module Lono::Configset::Materializer
+class Lono::Jade::Materializer
   class Final
     def build(jades)
       return if jades.empty?

data/lib/lono/{configset → jade}/materializer/gems_builder.rb

@@ -1,12 +1,12 @@
 require 'open3'
 
-module Lono::Configset::Materializer
+class Lono::Jade::Materializer
   class GemsBuilder
     extend Memoist
 
     def initialize(*jades)
       @jades = jades.flatten
-      @build_root = "#{Lono.root}/tmp/configsets"
+      @build_root = "#{Lono.root}/tmp/jades"
     end
 
     def build
@@ -51,7 +51,7 @@ module Lono::Configset::Materializer
         puts stdout
         puts stderr
         if stderr.include?("correct access rights")
-          puts "Are you sure you have access to the git repo?".color(:yellow)
+          puts "Are you sure you have access to the git repo and the repo exists?".color(:yellow)
         end
         exit 1
       end

data/lib/lono/{configset → jade}/materializer/source.rb

@@ -1,4 +1,4 @@
-module Lono::Configset::Materializer
+class Lono::Jade::Materializer
   class Source
     def initialize(lono_settings=nil)
       @lono_settings = lono_settings || Lono::Setting.new.data

data/lib/lono/jade/registry.rb

@@ -0,0 +1,55 @@
+class Lono::Jade
+  class Registry
+    attr_reader :args, :options
+    attr_accessor :caller_line, :parent, :depends_on
+    def initialize(args, options)
+      @args, @options = args, options
+    end
+
+    def name
+      @args.first
+    end
+
+    def gem_options
+      options = @options.dup
+      # Delete special options that is not supported by bundler Gemfile
+      options.delete(:repo)
+      options.delete(:resource) # configset
+      options.delete(:vars) # configset
+      options
+    end
+
+    # configset
+    def resource
+      @options[:resource]
+    end
+
+    def resource=(v)
+      @options[:resource] = v
+    end
+
+    def vars
+      options[:vars] || {}
+    end
+
+    class_attribute :tracked_configsets, default: []
+    class_attribute :downloaded_configsets, default: []
+    class_attribute :tracked_extensions, default: []
+    class_attribute :downloaded_extensions, default: []
+
+    class << self
+      def register_configset(args, options)
+        registry = new(args, options)
+        jade = Lono::Jade.new(registry.name, 'configset', registry)
+        self.tracked_configsets << jade
+        registry
+      end
+
+      def register_extension(args, options)
+        registry = new(args, options)
+        self.tracked_extensions << registry
+        registry
+      end
+    end
+  end
+end

data/lib/lono/template/context.rb

@@ -9,8 +9,7 @@ class Lono::Template
 
     def initialize(options={})
       super
-      load_variables
-      load_project_helpers
+      load_context
     end
 
     # Take a hash and makes them instance variables in the current scope.

data/lib/lono/template/context/loader.rb

@@ -1,6 +1,20 @@
 class Lono::Template::Context
   module Loader
+    include LoadFiles
+
     private
+    # Not using Lono::Template::Context because that works differently.
+    # That is used to load a context object that is passed to RenderMePretty's context.
+    # So that we can load context for params files and erb templates.
+    #
+    # In this case builder is actually the dsl context.
+    # We want to load variables and helpers into this builder context directly.
+    # This loads additional context. It looks very similar to Lono::Template::Context
+    def load_context
+      load_variables
+      load_helpers
+    end
+
     # Variables in base.rb are overridden by their environment specific variables
     # file.  Example, file LONO_ENV=development:
     #
@@ -27,20 +41,12 @@ class Lono::Template::Context
     end
 
     # Load custom helper methods from project
-    def load_project_helpers
-      Dir.glob("#{Lono.config.helpers_path}/**/*.rb").each do |path|
-        filename = path.sub("#{Lono.config.helpers_path}/",'').sub('.rb','')
-        module_name = filename.camelize
+    def load_helpers
+      load_project_helpers # project helpers will override extension helpers
+    end
 
-        # Prepend a period so require works LONO_ROOT is set to a relative path
-        # without a period.
-        #
-        # Example: LONO_ROOT=tmp/lono_project
-        first_char = path[0..0]
-        path = "./#{path}" unless %w[. /].include?(first_char)
-        require path
-        self.class.send :include, module_name.constantize
-      end
+    def load_project_helpers
+      load_files(Lono.config.helpers_path)
     end
   end
 end

data/lib/lono/template/context/loader/load_files.rb

@@ -0,0 +1,24 @@
+module Lono::Template::Context::Loader
+  module LoadFiles
+    # Load custom helper methods from project
+    def load_files(root)
+      paths = Dir.glob("#{root}/**/*.rb")
+      paths.sort_by! { |p| p.size } # so namespaces are loaded first
+      paths.each do |path|
+        # lib = gem extensions
+        # app = project extensions
+        filename = path.sub(%r{.*/lib/},'').sub(%r{.*/app/helpers/},'').sub('.rb','')
+        module_name = filename.camelize
+
+        # Prepend a period so require works LONO_ROOT is set to a relative path without a period.
+        #
+        # Example: LONO_ROOT=tmp/lono_project
+        first_char = path[0..0]
+        path = "./#{path}" unless %w[. /].include?(first_char)
+
+        require path
+        self.class.send :include, module_name.constantize
+      end
+    end
+  end
+end

data/lib/lono/template/helper.rb

@@ -7,44 +7,6 @@ require "aws-sdk-core"
 #
 #   Lono::Template::Context.new(blueprint, @options)
 module Lono::Template::Helper
-  # Bash code that is meant to included in user-data
-  def extract_scripts(options={})
-    settings = setting.data["extract_scripts"] || {}
-    options = settings.merge(options)
-    # defaults also here in case they are removed from settings
-    to = options[:to] || "/opt"
-    user = options[:as] || "ec2-user"
-
-    if Dir.glob("#{Lono.config.scripts_path}/*").empty?
-      puts "WARN: you are using the extract_scripts helper method but you do not have any app/scripts.".color(:yellow)
-      calling_line = caller[0].split(':')[0..1].join(':')
-      puts "Called from: #{calling_line}"
-      return ""
-    end
-
-    <<-BASH_CODE
-# Generated from the lono extract_scripts helper.
-# Downloads scripts from s3, extract them, and setup.
-mkdir -p #{to}
-aws s3 cp #{scripts_s3_path} #{to}/
-(
-  cd #{to}
-  tar zxf #{to}/#{scripts_name}
-  chmod -R a+x #{to}/scripts
-  chown -R #{user}:#{user} #{to}/scripts
-)
-BASH_CODE
-  end
-
-  def scripts_name
-    File.basename(scripts_s3_path)
-  end
-
-  def scripts_s3_path
-    upload = Lono::Script::Upload.new(@options)
-    upload.s3_dest
-  end
-
   def template_s3_path(template_name)
     # high jacking Upload for useful s3_https_url method
     template_path = "output/#{@blueprint}/templates/#{template_name}.yml"
@@ -188,8 +150,4 @@ private
 
     path # original path if this point is reached
   end
-
-  def setting
-    @setting ||= Lono::Setting.new
-  end
 end

data/lib/lono/template/strategy/common/helpers.rb

@@ -0,0 +1,44 @@
+module Lono::Template::Strategy::Common
+  module Helpers
+    # Bash code that is meant to included in user-data
+    def extract_scripts(options={})
+      settings = setting.data["extract_scripts"] || {}
+      options = settings.merge(options)
+      # defaults also here in case they are removed from settings
+      to = options[:to] || "/opt"
+      user = options[:as] || "ec2-user"
+
+      if Dir.glob("#{Lono.config.scripts_path}/*").empty?
+        puts "WARN: you are using the extract_scripts helper method but you do not have any app/scripts.".color(:yellow)
+        calling_line = caller[0].split(':')[0..1].join(':')
+        puts "Called from: #{calling_line}"
+        return ""
+      end
+
+      <<~BASH_CODE
+        # Generated from the lono extract_scripts helper.
+        # Downloads scripts from s3, extract them, and setup.
+        mkdir -p #{to}
+        aws s3 cp #{scripts_s3_path} #{to}/
+        (
+          cd #{to}
+          tar zxf #{to}/#{scripts_name}
+          chown -R #{user}:#{user} #{to}/scripts
+        )
+      BASH_CODE
+    end
+
+    def scripts_name
+      File.basename(scripts_s3_path)
+    end
+
+    def scripts_s3_path
+      upload = Lono::Script::Upload.new(@options)
+      upload.s3_dest
+    end
+
+    def setting
+      @setting ||= Lono::Setting.new
+    end
+  end
+end

data/lib/lono/template/strategy/dsl.rb

@@ -1,18 +1,13 @@
 module Lono::Template::Strategy
   class Dsl < Base
     attr_reader :results
-    def initialize(options={})
-      super
-    end
-
     def run
       puts "Generating CloudFormation templates for blueprint #{@blueprint.color(:green)}:" unless @options[:quiet]
-      template_path = "#{Lono.config.templates_path}/#{@template}.rb"
-      build_template(template_path)
+      build_template
     end
 
-    def build_template(path)
-      builder = Builder.new(path, @blueprint, @options)
+    def build_template
+      builder = Builder.new(@options)
       builder.build
     end
   end

data/lib/lono/template/strategy/dsl/builder.rb

@@ -6,22 +6,29 @@ class Lono::Template::Strategy::Dsl
     include Syntax
     extend Memoist
 
-    def initialize(path, blueprint, options={})
-      @path, @blueprint, @options = path, blueprint, options
-      @template = @path.sub("#{Lono.config.templates_path}/",'').sub(/\.rb$/,'')
+    def initialize(options={})
+      @options = options
+      @stack, @blueprint, @template, @param = Lono::Conventions.new(options).values
+      @template_path = "#{Lono.config.templates_path}/#{@template}.rb"
       @parameters = [] # registry
       @cfn = {}
     end
 
     def build
-      load_context
-      evaluate_template_path(@path) # modifies @cfn
+      load_extensions # load_extensions before project helpers
+      load_context # variables and project helpers
+      evaluate_template_path(@template_path) # modifies @cfn
       finalize
       to_yaml
       write_output
       @cfn
     end
 
+    # load_extensions and evaluate extend_with methods earlier than load_context so project helpers can override extensions
+    def load_extensions # evaluates extend_with
+      Lono::Extensions::Preparer.new(@options).run
+    end
+
     def finalize
       o = @options.merge(parameters: @parameters)
       @cfn = Finalizer.new(@cfn, o).run
@@ -46,17 +53,5 @@ class Lono::Template::Strategy::Dsl
         puts "  #{pretty_path}"
       end
     end
-
-    # Not using Lono::Template::Context because that works differently.
-    # That is used to load a context object that is passed to RenderMePretty's context.
-    # So that we can load context for params files and erb templates.
-    #
-    # In this case builder is actually the dsl context.
-    # We want to load variables and helpers into this builder context directly.
-    # This loads additional context. It looks very similar to Lono::Template::Context
-    def load_context
-      load_variables
-      load_project_helpers
-    end
   end
 end