lono 4.0.6 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f63015f7f02dd2c10b5a5fdb6e1ee6b39dbba2a76e72fd2dbffa60fa2a8361e
-  data.tar.gz: 72f5b4c8b8adfb43a52e9b10bc3786a103c8494bf05a2c16302cb3211c03a728
+  metadata.gz: 14ca2afc46780d2abc5bb0ecabaf53a685befb89abe63263fa02d847201582f4
+  data.tar.gz: b3ccb40f3ecc4902b769651c67ef1a76dfb330c0d547c3da686e2913857b048a
 SHA512:
-  metadata.gz: 75d69ff2904e89e0983876bd5210c29a163a91d92262555910b8db803a4a9530a97487abf97841516f62319c2b175991dfe856f6a9218267442392796d0bf1ce
-  data.tar.gz: 3897781b6b686829406821477af5e5bc0ef8e48fa16ec73337020ab96f5ea534f21c1a88c25487847352ec396301f64a61bc3f28f6b5b192ba806886f10ebbac
+  metadata.gz: 63bcc9ff8a025fba3666fb8bcd73fb1a7ffa5e9382dcdf2d407f4c7ea678fb63302887a3bddc8f527c13846100af26d91361f6a7f9bfc2583d4345635ab698de
+  data.tar.gz: ac98507f3f1a706602662f47af7055b6b983c6c373d8c78f13706dab323fbf8a33d35b16d87234de9674ca7e2c5464d2dcfe1cbd475f6d1ba19b6539ba81a7a1

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 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.
 
+## [4.1.0]
+- Merge pull request #36 from tongueroo/cli_markdown
+- fix current_region helper in variables, add s3_region setting
+- settings: fix edge cases, nil base, file is empty
+- simplify how to set s3 endpoint override so region doesnt have to also be set
+- use subshell for extract_scripts
+
 ## [4.0.6]
 - Update cli docs: generate, import, new, upload
 - fix thor description override when command not found

data/Gemfile

@@ -4,3 +4,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "codeclimate-test-reporter", group: :test, require: nil
+

data/Rakefile

@@ -6,7 +6,8 @@ task :default => :spec
 RSpec::Core::RakeTask.new
 
 require_relative "lib/lono"
+require "cli_markdown"
 desc "Generates cli reference docs as markdown"
 task :docs do
-  Lono::Markdown::Creator.create_all(Lono::CLI)
+  CliMarkdown::Creator.create_all(cli_class: Lono::CLI, cli_name: "lono")
 end

data/lib/lono.rb

@@ -33,7 +33,6 @@ module Lono
   autoload :Upgrade4, 'lono/upgrade4'
   autoload :Script, 'lono/script'
   autoload :UserData, 'lono/user_data'
-  autoload :Markdown, 'lono/markdown'
 
   extend Core
 end

data/lib/lono/command.rb

@@ -54,14 +54,28 @@ module Lono
 
       def alter_command_description(command)
         return unless command
+
+        # Add description to beginning of long_description
         long_desc = if command.long_description
             "#{command.description}\n\n#{command.long_description}"
           else
             command.description
           end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/lono-#{full_command}"
+          long_desc += "\n\nAlso available at: #{url}"
+        end
+
         command.long_description = long_desc
       end
       private :alter_command_description
+
+      def website
+        "http://lono.cloud"
+      end
     end
   end
 end

data/lib/lono/importer.rb

@@ -34,7 +34,7 @@ class Lono::Importer
 
   def show_params_file
     path = "config/params/base/#{template_name}.txt"
-    puts "Here are contents of the params #{path} file:"
+    puts "Here are contents of the params #{path.colorize(:green)} file:"
     puts IO.read("#{Lono.root}/#{path}")
   end
 

data/lib/lono/inspector/summary.rb

@@ -3,7 +3,6 @@ class Lono::Inspector::Summary < Lono::Inspector::Base
     puts "=> CloudFormation Template Summary:".colorize(:green)
     return if @options[:noop]
 
-    puts "Parameters:"
     print_parameters_summary
 
     puts "Resources:"
@@ -12,10 +11,10 @@ class Lono::Inspector::Summary < Lono::Inspector::Base
 
   def print_parameters_summary
     if parameters.empty?
-      puts "  There are no parameters"
+      puts "There are no parameters in this template."
     else
-      print_parameters("Required", required_parameters)
-      print_parameters("Optional", optional_parameters)
+      print_parameters("Required Parameters", required_parameters)
+      print_parameters("Optional Parameters", optional_parameters)
     end
   end
 

data/lib/lono/setting.rb

@@ -58,7 +58,7 @@ module Lono
       return Hash.new({}) unless File.exist?(path)
 
       content = RenderMePretty.result(path)
-      data = YAML.load(content)
+      data = YAML.load(content) || {}
       # If key is is accidentally set to nil it screws up the merge_base later.
       # So ensure that all keys with nil value are set to {}
       data.each do |lono_env, _setting|
@@ -69,7 +69,7 @@ module Lono
 
     # automatically add base settings to the rest of the environments
     def merge_base(all_envs)
-      base = all_envs["base"]
+      base = all_envs["base"] || {}
       all_envs.each do |lono_env, env_settings|
         all_envs[lono_env] = base.merge(env_settings) unless lono_env == "base"
       end

data/lib/lono/template/aws_service.rb

@@ -5,11 +5,16 @@ module Lono::Template::AwsService
     return @s3 if @s3
 
     options = {}
-    # example: endpoint: 'https://s3.us-west-2.amazonaws.com'
-    options[:endpoint] = ENV['S3_ENDPOINT'] if ENV['S3_ENDPOINT']
     # allow override of region for s3 client to avoid warning:
     # S3 client configured for "us-east-1" but the bucket "xxx" is in "us-west-2"; Please configure the proper region to avoid multiple unnecessary redirects and signing attempts
-    options[:region] = ENV['S3_REGION'] if ENV['S3_REGION']
+    # Example: endpoint: 'https://s3.us-west-2.amazonaws.com'
+    settings = Lono::Setting.new.data
+    endpoint = settings["s3_endpoint"]
+    endpoint = ENV['S3_ENDPOINT'] if ENV['S3_ENDPOINT']
+    options[:endpoint] = endpoint if endpoint
+    if options[:endpoint]
+      options[:region] = options[:endpoint].split('.')[1]
+    end
     @s3 = Aws::S3::Client.new(options)
   end
 end

data/lib/lono/template/helper.rb

@@ -1,3 +1,5 @@
+require "aws-sdk-core"
+
 # This is included into Lono::Template::Context.
 # It has access to the original thor CLI options via @options.
 #
@@ -27,10 +29,12 @@ module Lono::Template::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
+(
+  cd #{to}
+  tar zxf #{to}/#{scripts_name}
+  chmod -R a+x #{to}/scripts
+  chown -R #{user}:#{user} #{to}/scripts
+)
 BASH_CODE
   end
 

data/lib/lono/version.rb

@@ -1,3 +1,3 @@
 module Lono
-  VERSION = "4.0.6"
+  VERSION = "4.1.0"
 end

data/lono.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |gem|
   # until https://github.com/futurechimp/plissken/pull/6 gets merged
 
   gem.add_development_dependency "byebug"
+  gem.add_development_dependency "cli_markdown"
   gem.add_development_dependency "guard-bundler"
   gem.add_development_dependency "guard-rspec"
   gem.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lono
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 4.1.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -220,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
@@ -347,11 +361,6 @@ files:
 - lib/lono/inspector/base.rb
 - lib/lono/inspector/graph.rb
 - lib/lono/inspector/summary.rb
-- lib/lono/markdown.rb
-- lib/lono/markdown/creator.rb
-- lib/lono/markdown/index.rb
-- lib/lono/markdown/page.rb
-- lib/lono/markdown/shell.rb
 - lib/lono/new.rb
 - lib/lono/new/helper.rb
 - lib/lono/new/message.rb
@@ -437,7 +446,6 @@ files:
 - spec/lib/lono/cli_spec.rb
 - spec/lib/lono/completion_spec.rb
 - spec/lib/lono/inspect_spec.rb
-- spec/lib/lono/markdown_spec.rb
 - spec/lib/lono/param/generator_spec.rb
 - spec/lib/lono/param_spec.rb
 - spec/lib/lono/setting_spec.rb
@@ -511,7 +519,6 @@ test_files:
 - spec/lib/lono/cli_spec.rb
 - spec/lib/lono/completion_spec.rb
 - spec/lib/lono/inspect_spec.rb
-- spec/lib/lono/markdown_spec.rb
 - spec/lib/lono/param/generator_spec.rb
 - spec/lib/lono/param_spec.rb
 - spec/lib/lono/setting_spec.rb

data/lib/lono/markdown.rb

@@ -1,8 +0,0 @@
-require 'thor'
-
-module Lono::Markdown
-  autoload :Creator, 'lono/markdown/creator'
-  autoload :Index, 'lono/markdown/index'
-  autoload :Page, 'lono/markdown/page'
-  autoload :Shell, 'lono/markdown/shell'
-end

data/lib/lono/markdown/creator.rb

@@ -1,65 +0,0 @@
-require "active_support/core_ext/object"
-
-module Lono::Markdown
-  class Creator
-    cattr_accessor :mute
-
-    def self.create_all(command_class,  parent_command_name=nil)
-      clean unless parent_command_name
-      new(command_class, parent_command_name).create_all
-    end
-
-    def self.clean
-      FileUtils.rm_rf("docs/_reference")
-      FileUtils.rm_f("docs/reference.md")
-    end
-
-    # command_class is top-level CLI class.
-    def initialize(command_class, parent_command_name)
-      @command_class = command_class
-      @parent_command_name = parent_command_name
-    end
-
-    def create_all
-      create_index unless @parent_command_name
-
-      @command_class.commands.keys.each do |command_name|
-        page = Page.new(@command_class, command_name, @parent_command_name)
-        create_page(page)
-
-        if subcommand?(command_name)
-          subcommand_class = subcommand_class(command_name)
-          parent_command_name = command_name
-
-          say "Creating subcommands pages for #{parent_command_name}..."
-          Creator.create_all(subcommand_class, parent_command_name)
-        end
-      end
-    end
-
-    def create_page(page)
-      say "Creating #{page.path}..."
-      FileUtils.mkdir_p(File.dirname(page.path))
-      IO.write(page.path, page.doc)
-    end
-
-    def create_index
-      page = Index.new(@command_class)
-      FileUtils.mkdir_p(File.dirname(page.path))
-      say "Creating #{page.path}"
-      IO.write(page.path, page.doc)
-    end
-
-    def subcommand?(command_name)
-      @command_class.subcommands.include?(command_name)
-    end
-
-    def subcommand_class(command_name)
-      @command_class.subcommand_classes[command_name]
-    end
-
-    def say(text)
-      puts text unless self.class.mute
-    end
-  end
-end

data/lib/lono/markdown/index.rb

@@ -1,36 +0,0 @@
-module Lono::Markdown
-  class Index
-    def initialize(command_class)
-      @command_class = command_class
-    end
-
-    def path
-      "docs/reference.md"
-    end
-
-    def command_list
-      @command_class.commands.keys.sort.map.each do |command_name|
-        page = Page.new(@command_class, command_name)
-        link = page.path.sub("docs/", "")
-        # Example: [lono cfn]({% link _reference/lono-cfn.md %})
-        "* [lono #{command_name}]({% link #{link} %})"
-      end.join("\n")
-    end
-
-    def summary
-      <<-EOL
-Lono is a CloudFormation framework tool that helps you manage your templates. Lono handles the entire CloudFormation lifecycle. It starts with helping you develop your templates and helps you all the way to the infrastructure provisioning step.
-EOL
-    end
-
-    def doc
-      <<-EOL
----
-title: CLI Reference
----
-#{summary}
-#{command_list}
-EOL
-    end
-  end
-end

data/lib/lono/markdown/page.rb

@@ -1,169 +0,0 @@
-module Lono::Markdown
-  class Page
-    def initialize(command_class, command_name, parent_command_name=nil)
-      @command_class = command_class
-      @command_name = command_name
-      @parent_command_name = parent_command_name
-      @command = @command_class.commands[@command_name]
-    end
-
-    def usage
-      banner = @command_class.send(:banner, @command) # banner is protected method
-      invoking_command = File.basename($0) # could be rspec, etc
-      banner.sub(invoking_command, cli_name)
-    end
-
-    def description
-      @command.description
-    end
-
-    def options
-      shell = Shell.new
-      @command_class.send(:class_options_help, shell, nil => @command.options.values)
-      text = shell.stdout.string
-      return "" if text.empty? # there are no options
-
-      lines = text.split("\n")[1..-1] # remove first line wihth "Options: "
-      lines.map! do |line|
-        # remove 2 leading spaces
-        line.sub(/^  /, '')
-      end
-      lines.join("\n")
-    end
-
-    # Use command's long description as many description
-    def long_description
-      text = @command.long_description
-      return "" if text.nil? # empty description
-
-      lines = text.split("\n")
-      lines.map do |line|
-        # In the CLI help, we use 2 spaces to designate commands
-        # In Markdown we need 4 spaces.
-        line.sub(/^  \b/, '    ')
-      end.join("\n")
-    end
-
-    def cli_name
-      "lono"
-    end
-
-    def path
-      full_name = if @parent_command_name
-        "#{cli_name}-#{@parent_command_name}-#{@command_name}"
-      else
-        "#{cli_name}-#{@command_name}"
-      end
-      "docs/_reference/#{full_name}.md"
-    end
-
-    def subcommand?
-      @command_class.subcommands.include?(@command_name)
-    end
-
-    def subcommand_class
-      @command_class.subcommand_classes[@command_name]
-    end
-
-    # Note:
-    # printable_commands are in the form:
-    #  [
-    #    [command_form,command_comment],
-    #    [command_form,command_comment],
-    #  ]
-    #
-    # It is useful to grab the command form printable_commands as it shows
-    # the proper form.
-    def subcommand_list
-      return '' unless subcommand?
-
-      invoking_command = File.basename($0) # could be rspec, etc
-      command_list = subcommand_class.printable_commands
-        .sort_by { |a| a[0] }
-        .map { |a| a[0].sub!(invoking_command, cli_name); a } # replace with proper comand
-        .reject { |a| a[0].include?("help [COMMAND]") } # filter out help
-
-      # dress up with markdown
-      text = command_list.map do |a|
-        command, comment = a[0], a[1].sub(/^# /,'')
-        subcommand_name = command.split(' ')[2]
-        full_command_path = "#{cli_name}-#{@command_name}-#{subcommand_name}"
-        full_command_name = "#{cli_name} #{@command_name} #{subcommand_name}"
-        link = "_reference/#{full_command_path}.md"
-
-        # "* [#{command}]({% link #{link} %})"
-        # Example: [lono cfn delete STACK]({% link _reference/lono-cfn-delete.md %})
-        "* [#{full_command_name}]({% link #{link} %}) - #{comment}"
-      end.join("\n")
-
-      <<-EOL
-## Subcommands
-
-#{text}
-EOL
-    end
-
-    def doc
-      <<-EOL
-#{front_matter}
-#{usage_markdown}
-#{long_desc_markdown}
-#{subcommand_list}
-#{options_markdown}
-EOL
-    end
-
-    def front_matter
-      command = [cli_name, @parent_command_name, @command_name].compact.join(' ')
-      <<-EOL
----
-title: #{command}
-reference: true
----
-EOL
-    end
-
-    def usage_markdown
-      <<-EOL
-## Usage
-
-    #{usage}
-EOL
-    end
-
-    def desc_markdown
-      <<-EOL
-## Description
-
-#{description}
-EOL
-    end
-
-    # If the Thor long_description is empty then use the description.
-    def long_desc_markdown
-      return desc_markdown if long_description.empty?
-
-      <<-EOL
-## Description
-
-#{description}
-
-#{long_description}
-EOL
-    end
-
-    # handles blank options
-    def options_markdown
-      return '' if options.empty?
-
-      <<-EOL
-## Options
-
-```
-#{options}
-```
-EOL
-    end
-
-  end
-end

data/lib/lono/markdown/shell.rb

@@ -1,11 +0,0 @@
-require 'thor'
-
-module Lono::Markdown
-  # Override stdout as an @io object so we can grab the text written normally
-  # outputted to the shell.
-  class Shell < Thor::Shell::Basic
-    def stdout
-      @io ||= StringIO.new
-    end
-  end
-end

data/spec/lib/lono/markdown_spec.rb

@@ -1,87 +0,0 @@
-describe Lono::Markdown::Page do
-  let(:page) { Lono::Markdown::Page.new(cli_class, command, parent_command_name) }
-  let(:cli_class) { Lono::CLI }
-  let(:parent_command_name) { nil }
-
-  context "MarkdownMaker.create_all" do
-    it "docs command" do
-      out = execute("rake docs")
-      expect(out).to include("Creating")
-    end
-
-    it "generates all docs pages" do
-      Lono::Markdown::Creator.mute = true
-      Lono::Markdown::Creator.create_all(cli_class)
-    end
-  end
-
-  context "generate" do
-    let(:command) { "generate" }
-
-    it "#usage" do
-      expect(page.usage).to eq "lono generate"
-    end
-
-    it "#desc_markdown" do
-      expect(page.desc_markdown).to include "# Description"
-    end
-
-    it "#options_markdown" do
-      expect(page.options_markdown).to include("--clean")
-      # [--clean], [--no-clean]  # remove all output files before generating
-      #                          # Default: true
-      # [--quiet], [--no-quiet]  # silence the output
-    end
-
-    it "#doc" do
-      expect(page.doc).to include("# Description")
-      # puts page.doc # uncomment to see generated page for debugging
-    end
-  end
-
-  # subcommand
-  context "cfn" do
-    let(:command) { "cfn" }
-
-    it "#usage" do
-      expect(page.usage).to eq "lono cfn SUBCOMMAND"
-    end
-
-    it "#desc_markdown" do
-      puts page.desc_markdown
-      expect(page.desc_markdown).to include "# Description"
-    end
-
-    # Think it is better to hide subcommand options_markdown at the top-level.
-    # User will see the optoins once they click into the subcommand.
-    it "#options_markdown" do
-      expect(page.options_markdown).to include("")
-    end
-
-    it "#subcommand_list" do
-      expect(page.doc).to include("# Subcommands")
-      # puts page.subcommand_list # uncomment to see generated list for debugging
-    end
-
-    it "#doc" do
-      expect(page.doc).to include("# Description")
-      # puts page.doc # uncomment to see generated page for debugging
-    end
-  end
-
-  ################
-  # rest are edge cases
-  context "summary" do
-    let(:command) { "summary" }
-
-    # empty options_markdown
-    it "#options_markdown" do
-      expect(page.options_markdown).to eq ""
-    end
-
-    it "#doc" do
-      expect(page.doc).to include("# Description")
-      # puts page.doc # uncomment to see generated page for debugging
-    end
-  end
-end