jets 0.2.0 → 0.5.0

data/lib/jets/commands/help/process/rule.md

@@ -0,0 +1,5 @@
+The node shim spawns out to this command.
+
+## Example
+
+    $ jets process:rule file://config_change.json '{"context":"data"}' "handlers/rules/game_rule.protect"

data/lib/jets/commands/help/routes.md

@@ -0,0 +1,3 @@
+## Example
+
+    $ jets routes

data/lib/jets/commands/help/server.md

@@ -0,0 +1,6 @@
+The local server for mimics API Gateway and provides a way to test your app locally without deploying to AWS.
+
+## Examples
+
+    $ jets server
+    $ jets server --host 0.0.0.0

data/lib/jets/commands/help/status.md

@@ -0,0 +1 @@
+Essentially the events of the CloudFormation stack update. If the CloudFormation stack is currently updating, this will tail the events logs.

data/lib/jets/commands/help/url.md

@@ -0,0 +1,5 @@
+Provides the app url if routes have been configured.
+
+## Example
+
+    $ jets url

data/lib/jets/commands/main.rb

@@ -0,0 +1,111 @@
+require "thor"
+
+module Jets::Commands
+  class Main < Base
+
+    class_option :noop, type: :boolean
+
+    desc "build", "Builds and packages project for AWS Lambda"
+    long_desc Help.text(:build)
+    option :templates_only, type: :boolean, default: false, desc: "provide a way to skip building the code and only build the CloudFormation templates"
+    def build
+      Build.new(options).run
+    end
+
+    desc "deploy [environment]", "Builds and deploys project to AWS Lambda"
+    long_desc Help.text(:deploy)
+    option :capabilities, type: :array, desc: "iam capabilities. Ex: CAPABILITY_IAM, CAPABILITY_NAMED_IAM"
+    option :iam, type: :boolean, desc: "Shortcut for common IAM capabilities: CAPABILITY_IAM, CAPABILITY_NAMED_IAM"
+    # Note the environment is here to trick the Thor parser to allowing an
+    # environment parameter. It is not actually set here.  It is set earlier
+    # in cli.rb: set_jets_env_for_deploy_command!
+    def deploy(environment=nil)
+      Jets::Timing.clear # must happen outside Deploy#run
+      Deploy.new(options).run
+      Jets::Timing.report
+    end
+
+    desc "delete", "Delete the Jets project and all its resources"
+    long_desc Help.text(:delete)
+    option :sure, type: :boolean, desc: "Skip are you sure prompt."
+    option :wait, type: :boolean, default: true, desc: "Wait for stack deletion to complete."
+    def delete
+      Delete.new(options).run
+    end
+
+    desc "server", "Runs a local server that mimics API Gateway for development"
+    long_desc Help.text(:server)
+    option :port, default: "8888", desc: "use PORT"
+    option :host, default: "127.0.0.1", desc: "listen on HOST"
+    def server
+      # shell out to shotgun for automatic reloading
+      o = options
+      command = "bundle exec shotgun --port #{o[:port]} --host #{o[:host]}"
+      puts "=> #{command}".colorize(:green)
+      puts Jets::Booter.message
+      system(command)
+    end
+
+    desc "routes", "Print out your application routes"
+    long_desc Help.text(:routes)
+    def routes
+      puts Jets::Router.routes_help
+    end
+
+    desc "console", "REPL console with Jets environment loaded"
+    long_desc Help.text(:console)
+    def console
+      Console.run
+    end
+
+    desc "dbconsole", "Starts DB REPL console"
+    long_desc Help.text(:dbconsole)
+    def dbconsole
+      Dbconsole.start(*args)
+    end
+
+    # Command is called 'call' because invoke is a Thor keyword.
+    desc "call [function] [event]", "Call a lambda function on AWS or locally"
+    long_desc Help.text(:call)
+    option :invocation_type, default: "RequestResponse", desc: "RequestResponse, Event, or DryRun"
+    option :log_type, default: "Tail", desc: "Works if invocation_type set to RequestResponse"
+    option :qualifier, desc: "Lambda function version or alias name"
+    option :show_log, type: :boolean, desc: "Shows last 4KB of log in the x-amz-log-result header"
+    option :lambda_proxy, type: :boolean, default: true, desc: "Enables automatic Lambda proxy transformation of the event payload"
+    option :guess, type: :boolean, default: true, desc: "Enables guess mode. Uses inference to allows use of all dashes to specify functions. Smart mode verifies that the function exists in the code base."
+    option :local, type: :boolean, desc: "Enables local mode. Instead of invoke the AWS Lambda function, the method gets called locally with current app code. With local mode guess mode is always used."
+    def call(function_name, payload='')
+      Call.new(function_name, payload, options).run
+    end
+
+    desc "generate [type] [args]", "Generates things like scaffolds"
+    long_desc Help.text(:generate)
+    def generate(generator, *args)
+      Jets::Generator.invoke(generator, *args)
+    end
+
+    desc "status", "Shows the current status of the Jets app."
+    long_desc Help.text(:status)
+    def status
+      Jets::Cfn::Status.new(options).run
+    end
+
+    desc "url", "App url if routes are defined"
+    long_desc Help.text(:url)
+    def url
+      Jets::Commands::Url.new(options).display
+    end
+
+    desc "version", "Prints Jets version"
+    long_desc Help.text(:version)
+    def version
+      puts Jets.version
+    end
+
+    long_desc Help.text(:new)
+    Jets::Commands::New.cli_options.each do |args|
+      option *args
+    end
+    register(Jets::Commands::New, "new", "new", "Creates a starter skeleton jets project")
+  end
+end

data/lib/jets/commands/markdown.rb

@@ -0,0 +1,8 @@
+module Jets::Commands
+  module Markdown
+    autoload :Creator, 'jets/commands/markdown/creator'
+    autoload :Index, 'jets/commands/markdown/index'
+    autoload :Page, 'jets/commands/markdown/page'
+    autoload :Shell, 'jets/commands/markdown/shell'
+  end
+end

data/lib/jets/commands/markdown/creator.rb

@@ -0,0 +1,58 @@
+module Jets::Commands::Markdown
+  class Creator
+    cattr_accessor :mute
+
+    def self.create_all
+      clean
+      new.create_all
+    end
+
+    def self.clean
+      FileUtils.rm_rf("docs/_reference")
+      FileUtils.rm_f("docs/reference.md")
+    end
+
+    def cli_classes
+      Jets::Commands::Base.namespaced_commands.map do |full_command|
+        # IE of full_command: dynamodb:generate
+        Jets::CLI.new([full_command]).lookup(full_command)
+      end.uniq
+    end
+
+    def create_all
+      create_index
+
+      cli_classes.each do |cli_class|
+        # cli_class examples:
+        #   Jets::Commands::Main
+        #   Jets::Commands::Db
+        #   Jets::Commands::Dynamodb::Migrate
+        cli_class.commands.each do |command|
+          command_name = command.first
+
+          page = Page.new(cli_class: cli_class, command_name: command_name)
+          create_page(page)
+        end
+      end
+    end
+
+    def create_page(page)
+      puts "Creating page: #{page.path}..."
+      FileUtils.mkdir_p(File.dirname(page.path))
+      IO.write(page.path, page.doc)
+    end
+
+    def create_index
+      create_include_reference
+      page = Index.new
+      FileUtils.mkdir_p(File.dirname(page.path))
+      puts "Creating index: #{page.path}"
+      IO.write(page.path, page.doc)
+    end
+
+    def create_include_reference
+      path = "docs/_includes/reference.md"
+      IO.write(path, "Generic tool description. Please edit #{path} with a description.") unless File.exist?(path)
+    end
+  end
+end

data/lib/jets/commands/markdown/index.rb

@@ -0,0 +1,27 @@
+module Jets::Commands::Markdown
+  class Index
+    def path
+      "docs/reference.md"
+    end
+
+    def command_list
+      commands = Jets::Commands::Base.namespaced_commands.sort.reject {|c| c.include?('help') }
+      commands.map do |full_command|
+        # Example: [jets deploy]({% link _reference/jets-deploy.md %})
+        link = full_command.gsub(':','-')
+        "* [jets #{full_command}]({% link _reference/jets-#{link}.md %})"
+      end.join("\n")
+    end
+
+    def doc
+      <<-EOL
+---
+title: CLI Reference
+---
+{% include reference.md %}
+
+#{command_list}
+EOL
+    end
+  end
+end

data/lib/jets/commands/markdown/page.rb

@@ -0,0 +1,125 @@
+module Jets::Commands::Markdown
+  class Page
+    attr_reader :cli_name
+    def initialize(cli_class:, command_name:)
+      @cli_class = cli_class # IE: Jets::Commands::Main
+      @command_name = command_name # IE: generate
+
+      @cli_name = "jets"
+      @command = @cli_class.commands[@command_name]
+    end
+
+    def usage
+      banner = @cli_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 full_command
+      [namespace, @command_name].compact.join(':')
+    end
+
+    def namespace
+      ns = @cli_class.to_s.sub('Jets::Commands::','').underscore.gsub('/','-')
+      ns == 'main' ? nil : ns
+    end
+
+    def description
+      @command.description
+    end
+
+    def options
+      shell = Shell.new
+      @cli_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 main 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 path
+      full_name = [cli_name, namespace, @command_name].compact.join('-')
+      "docs/_reference/#{full_name}.md"
+    end
+
+    def doc
+      <<-EOL
+#{front_matter}
+#{usage_markdown}
+#{long_desc_markdown}
+#{options_markdown}
+EOL
+    end
+
+    def front_matter
+      command = [cli_name, full_command].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/jets/commands/markdown/shell.rb

@@ -0,0 +1,11 @@
+require 'thor'
+
+module Jets::Commands::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/lib/jets/commands/new.rb

@@ -0,0 +1,110 @@
+module Jets::Commands
+  class New < Sequence
+    argument :project_name
+
+    # Ugly, but when the class_option is only defined in the Thor::Group class
+    # it doesnt show up with jets new help :(
+    # If anyone knows how to fix this let me know.
+    def self.cli_options
+      [
+        [:repo, desc: "GitHub repo to use. Format: user/repo"],
+        [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
+        [:api, type: :boolean, default: false, desc: "API mode."],
+        [:webpacker, type: :boolean, default: true, desc: "Install webpacker"],
+        [:bootstrap, type: :boolean, default: true, desc: "Install bootstrap css"], # same option in WebpackerTemplate
+        [:git, type: :boolean, default: true, desc: "Git initialize the project"],
+      ]
+    end
+
+    cli_options.each do |args|
+      class_option *args
+    end
+
+    def set_api_mode
+      # options is a frozen hash by Thor so cannot modify it.
+      # Also had trouble unfreezing it with .dup. So using instance variables instead
+      if options[:api]
+        @webpacker = false
+        @bootstrap = false
+      else
+        @webpacker = options[:webpacker]
+        @bootstrap = options[:bootstrap]
+      end
+    end
+
+    def create_project
+      options[:repo] ? clone_project : copy_project
+
+      destination_root = "#{Dir.pwd}/#{project_name}"
+      self.destination_root = destination_root
+      FileUtils.cd("#{Dir.pwd}/#{project_name}")
+    end
+
+    def make_bin_executable
+      chmod "bin", 0755 & ~File.umask, verbose: false
+    end
+
+    def bundle_install
+      Bundler.with_clean_env do
+        system("BUNDLE_IGNORE_CONFIG=1 bundle install")
+      end
+    end
+
+    def webpacker_install
+      return unless @webpacker
+
+      command = "jets webpacker:install"
+      command += " FORCE=1" if options[:force]
+      run(command)
+    end
+
+    # bootstrap is dependent on webpacker, options[:bootstrap] is used
+    # in webpacker_install.
+    def bootstrap_install
+      return unless @bootstrap
+
+      # Add jquery and popper plugin to handle Delete of CRUD
+      jquery =<<-JS
+const webpack = require('webpack')
+environment.plugins.prepend('Provide', new webpack.ProvidePlugin({
+  $: 'jquery',
+  jQuery: 'jquery',
+  Popper: ['popper.js', 'default']
+}))
+JS
+      after = "const { environment } = require('@rails/webpacker')\n"
+      insert_into_file("config/webpack/environment.js", jquery, after: after)
+
+      run("yarn add bootstrap@4.0.0-beta jquery popper.js")
+    end
+
+    def git_init
+      return if !options[:git]
+      return unless git_installed?
+      return if File.exist?(".git") # this is a clone repo
+
+      run("git init")
+      run("git add .")
+      run("git commit -m 'first commit'")
+    end
+
+    def user_message
+      puts <<-EOL
+#{"="*64}
+Congrats 🎉 You have successfully created a Jets project.
+
+Cd into the project directory:
+  cd #{project_name}
+
+To start a server and test locally:
+  jets server # localhost:8888 should have the Jets welcome page
+
+Scaffold example:
+  jets generate scaffold Post title:string body:text published:boolean
+
+To deploy to AWS Lambda:
+  jets deploy
+EOL
+    end
+  end
+end