jets 0.2.0 → 0.5.0

data/Rakefile

@@ -4,3 +4,9 @@ require "rspec/core/rake_task"
 task :default => :spec
 
 RSpec::Core::RakeTask.new
+
+require_relative "lib/jets"
+desc "Generates cli reference docs as markdown"
+task :docs do
+  Jets::Commands::Markdown::Creator.create_all
+end

data/buildspec.yml

@@ -0,0 +1,18 @@
+version: 0.2
+
+phases:
+  build:
+    commands:
+      - echo Build started on `date`
+      # sync vendor
+      - git submodule sync
+      - git submodule update --init
+      - /usr/local/bin/dynamodb-local &
+      - bundle install
+      - bundle exec rspec # unit tests
+      # uncomment integration test for now
+      # - bash -eux .codebuild/integration.sh # test with newman and postman
+
+artifacts:
+  files:
+    - README.md

data/exe/jets

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# traps: INT - ^C
+['INT', 'TERM', 'QUIT'].each do |signal|
+  trap(signal) do
+    puts ""
+    sleep 0.1
+    exit
+  end
+end
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "jets"
+Jets::CLI.start

data/jets.gemspec

@@ -13,8 +13,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/tongueroo/jets"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|docs)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
@@ -22,13 +25,38 @@ Gem::Specification.new do |spec|
   spec.add_dependency "hashie"
   spec.add_dependency "colorize"
   spec.add_dependency "activesupport"
+  spec.add_dependency "actionview"
+  spec.add_dependency "actionpack"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "railties" # ActiveRecord database_tasks.rb require this
+  # TODO: only load the database adapters that the app uses, so generate this
+  # in the app's Gemfile
+  spec.add_dependency "dotenv"
+
+  spec.add_dependency "recursive-open-struct"
+  spec.add_dependency "aws-sdk-s3"
+  spec.add_dependency "aws-sdk-cloudformation"
+  spec.add_dependency "aws-sdk-dynamodb"
+  spec.add_dependency "aws-sdk-lambda"
+  spec.add_dependency "kramdown"
+  spec.add_dependency "memoist"
+  spec.add_dependency "text-table"
+  spec.add_dependency "rack"
+  spec.add_dependency "json"
+  # there are development dependencies because we want to lazy load them
+  # in the app. but we want to have them so we can run specs.
+  spec.add_dependency "pg", "=0.21"
+
+  spec.add_dependency "gems" # lambdagem dependency
 
-  spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+
   # ruby_dep-1.5.0 requires ruby version >= 2.2.5, which is incompatible with the current version, ruby 2.2.2p95
   # spec.add_development_dependency "guard"
   # spec.add_development_dependency "guard-bundler"
   # spec.add_development_dependency "guard-rspec"
+  # spec.add_development_dependency "codeclimate-test-reporter", group: :test, require: nil
 end

data/lib/jets.rb

@@ -1,18 +1,66 @@
 $:.unshift(File.expand_path("../", __FILE__))
 require "jets/version"
+require "jets/pascalize"
 require "active_support/core_ext/string"
+require "active_support/ordered_hash"
 require "colorize"
-require 'pp'
+require "fileutils"
+require "pp" # TODO: remove pp after debugging
+require "memoist"
 
 module Jets
-  autoload :Util, "jets/util"
-  autoload :Command, "jets/command"
   autoload :CLI, "jets/cli"
-  autoload :Build, 'jets/build'
-  autoload :Process, 'jets/process'
-  autoload :BaseController, 'jets/base_controller'
-  autoload :Project, 'jets/project'
+  autoload :Commands, "jets/commands"
+
+  autoload :AwsServices, "jets/aws_services"
+  autoload :Builders, 'jets/builders'
+  autoload :Call, "jets/call"
   autoload :Cfn, 'jets/cfn'
+  autoload :Controller, 'jets/controller'
+  autoload :Erb, "jets/erb"
+  autoload :Generator, "jets/generator"
+  autoload :Job, 'jets/job'
+  autoload :Lambda, 'jets/lambda'
+  autoload :Naming, 'jets/naming'
+  autoload :PolyFun, 'jets/poly_fun'
+  autoload :Processors, 'jets/processors'
+  autoload :Route, "jets/route"
+  autoload :Router, "jets/router"
+  autoload :Rule, 'jets/rule'
+  autoload :Server, "jets/server"
+
+  autoload :Application, "jets/application"
+  autoload :Booter, 'jets/booter'
+  autoload :Core, "jets/core"
+  autoload :Dotenv, 'jets/dotenv'
+  autoload :Klass, 'jets/klass'
+  autoload :Util, "jets/util"
+  autoload :Timing, "jets/timing"
+  autoload :Preheat, "jets/preheat"
+  extend Core # root, logger, etc
+
+  autoload :RubyServer, "jets/ruby_server"
+end
+
+$:.unshift(File.expand_path("../../vendor/lambdagem/lib", __FILE__))
+require "lambdagem"
+require "gems" # lambdagem dependency
+
+
+# lazy loaded dependencies: depends what project. Mainly determined by Gemfile
+# and config files.
+if File.exist?("#{Jets.root}config/dynamodb.yml")
+  $:.unshift(File.expand_path("../../vendor/dynomite/lib", __FILE__))
+  require "dynomite"
+end
 
-  extend Util
+# https://makandracards.com/makandra/42521-detecting-if-a-ruby-gem-is-loaded
+# TODO: move require "pg" into loader class and abstract to support more gems
+if File.exist?("#{Jets.root}config/database.yml")
+  require "active_record"
+  # Note: think this is only needed for specs
+  # Apps require pg in their own Gemfile via bundler
+  exists = File.exist?("/var/task/bundled/gems/ruby/2.5.0/gems/pg-0.21.0/lib/pg_ext.so")
+  # Jets.logger.info("pg_ext.so exists #{exists.inspect}")
+  require "pg" if Gem.loaded_specs.has_key?('pg')
 end

data/lib/jets/application.rb

@@ -0,0 +1,121 @@
+require "active_support/ordered_options"
+
+class Jets::Application
+  extend Memoist
+  # Middleware used for development only
+  autoload :Middleware, "jets/application/middleware"
+  include Middleware
+
+  def configure(&block)
+    instance_eval(&block) if block
+  end
+
+  def setup!
+    load_configs # load config object so following methods can use it
+    setup_auto_load_paths
+    load_routes
+  end
+
+  def config
+    config = ActiveSupport::OrderedOptions.new
+    config.prewarm = ActiveSupport::OrderedOptions.new
+    config.lambdagems = ActiveSupport::OrderedOptions.new
+    config.lambdagems.sources = [
+      'https://gems.lambdagems.com'
+    ]
+    config
+  end
+  memoize :config
+
+  def setup_auto_load_paths
+    autoload_paths = config.autoload_paths + config.extra_autoload_paths
+    autoload_paths = autoload_paths.uniq.map { |p| "#{Jets.root}#{p}" }
+    # internal_autoload_paths are last
+    autoload_paths += internal_autoload_paths
+    ActiveSupport::Dependencies.autoload_paths += autoload_paths
+  end
+
+  def internal_autoload_paths
+    internal = File.expand_path("../internal", __FILE__)
+    paths = %w[
+      app/controllers
+      app/models
+      app/jobs
+    ]
+    paths.map { |path| "#{internal}/#{path}" }
+  end
+
+  def load_configs
+    # The Jets default/application.rb is loaded.
+    require File.expand_path("../default/application.rb", __FILE__)
+    # Then project config/application.rb is loaded.
+    app_config = "#{Jets.root}config/application.rb"
+    require app_config if File.exist?(app_config)
+    # Normalize config and setup some shortcuts
+    set_aliases!
+    normalize_env_vars!
+    load_db_config
+  end
+
+  # Use the shorter name in stack names, but use the full name when it
+  # comes to checking for the env.
+  #
+  # Example:
+  #
+  #   Jets.env: 'development'
+  #   Jets.config.project_namespace: 'demo-dev'
+  ENV_MAP = {
+    development: 'dev',
+    production: 'prod',
+    staging: 'stag',
+  }
+  def set_aliases!
+    # env_extra can be also be set with JETS_ENV_EXTRA.
+    # JETS_ENV_EXTRA higher precedence than config.env_extra
+    config.env_extra = ENV['JETS_ENV_EXTRA'] if ENV['JETS_ENV_EXTRA']
+    # IE: With env_extra: project-dev-1
+    #     Without env_extra: project-dev
+    config.short_env = ENV_MAP[Jets.env.to_sym] || Jets.env
+    config.project_namespace = [config.project_name, config.short_env, config.env_extra].compact.join('-')
+    # table_namespace does not have the env_extra, more common case desired.
+    config.table_namespace = [config.project_name, config.short_env].compact.join('-')
+  end
+
+  # It is pretty easy to attempt to set environment variables without
+  # the correct AWS Environment.Variables path struture.
+  # Auto-fix it for convenience.
+  def normalize_env_vars!
+    environment = config.function.environment
+    if environment and !environment.to_h.key?(:variables)
+      config.function.environment = {
+        variables: environment.to_h
+      }
+    end
+  end
+
+  def load_db_config
+    config.database = {}
+
+    database_yml = "#{Jets.root}config/database.yml"
+    if File.exist?(database_yml)
+      text = Jets::Erb.result(database_yml)
+      db_config = YAML.load(text)
+      config.database = db_config
+    end
+  end
+
+  # Naming it routes because config/routes.rb requires
+  #
+  #   Jets.application.routes.draw do
+  #
+  # for scaffolding to work.
+  def routes
+    @router ||= Jets::Router.new
+  end
+
+  def load_routes
+    routes_file = "#{Jets.root}config/routes.rb"
+    require routes_file if File.exist?(routes_file)
+  end
+
+end

data/lib/jets/application/middleware.rb

@@ -0,0 +1,23 @@
+module Jets::Application::Middleware
+  def call(env)
+    # Only require when necessary because middleware is only used for development
+    # Requring here instead of top of file because Jets::Application::Middleware
+    # gets autoloaded when Jets::Application gets autoloaded.
+    # Trying to keep the config.ru interface clean:
+    #
+    #   require "jets"
+    #   run Jets.application
+    require "jets/server/webpacker_setup" if Jets.webpacker? # makes "use Webpacker::DevServerProxy" works
+    triplet = assemble_app.call(env)
+  end
+
+  def assemble_app
+    Rack::Builder.new do
+      map("/") do
+        use Jets::Server::TimingMiddleware
+        use Webpacker::DevServerProxy if Jets.webpacker?
+        run Jets::Server
+      end
+    end
+  end
+end

data/lib/jets/aws_services.rb

@@ -0,0 +1,71 @@
+require "aws-sdk-s3"
+require "aws-sdk-cloudformation"
+require "aws-sdk-lambda"
+
+module Jets::AwsServices
+  def s3
+    @s3 ||= Aws::S3::Client.new
+  end
+
+  def s3_resource
+    @s3_resource ||= Aws::S3::Resource.new
+  end
+
+  def cfn
+    @cfn ||= Aws::CloudFormation::Client.new
+  end
+
+  def lambda
+    @lambda ||= Aws::Lambda::Client.new
+  end
+
+  def stack_exists?(stack_name)
+    return false if ENV['TEST']
+
+    exist = nil
+    begin
+      # When the stack does not exist an exception is raised. Example:
+      # Aws::CloudFormation::Errors::ValidationError: Stack with id blah does not exist
+      resp = cfn.describe_stacks(stack_name: stack_name)
+      exist = true
+    rescue Aws::CloudFormation::Errors::ValidationError => e
+      if e.message =~ /does not exist/
+        exist = false
+      elsif e.message.include?("'stackName' failed to satisfy constraint")
+        # Example of e.message when describe_stack with invalid stack name
+        # "1 validation error detected: Value 'instance_and_route53' at 'stackName' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/._+]*"
+        puts "Invalid stack name: #{stack_name}"
+        puts "Full error message: #{e.message}"
+        exit 1
+      else
+        raise # re-raise exception  because unsure what other errors can happen
+      end
+    end
+    exist
+  end
+
+  # All CloudFormation states listed here: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html
+  #
+  # Returns resp so we can use it to grab data about the stack without calling api again.
+  def stack_in_progress?(stack_name)
+    return true if !stack_exists?(stack_name)
+
+    # Assumes stack exists
+    resp = cfn.describe_stacks(stack_name: stack_name)
+    status = resp.stacks[0].stack_status
+    if status =~ /_IN_PROGRESS$/
+      puts "The '#{stack_name}' stack status is #{status}. " \
+           "Please wait until the stack is ready and try again.".colorize(:red)
+      exit 0
+    elsif resp.stacks[0].outputs.empty?
+      # This Happens when the miminal stack fails at the very beginning.
+      # There is no s3 bucket at all.  User should delete the stack.
+      puts "The minimal stack failed to create. Please delete the stack first and try again." \
+      "You can delete the CloudFormation stack or use the `jets delete` command"
+      exit 0
+    else
+      true
+    end
+  end
+
+end

data/lib/jets/booter.rb

@@ -0,0 +1,95 @@
+class Jets::Booter
+  class << self
+    @booted = false
+    def boot!
+      return if @booted
+
+      stdout_to_stderr
+      confirm_jets_project!
+      require_bundle_gems
+      Jets::Dotenv.load!
+      Jets.application # triggers application.setup! # autoload_paths, routes, etc
+      setup_db
+
+      @booted = true
+    end
+
+    # Override for Lambda processing.
+    # $stdout = $stderr might seem weird but we want puts to write to stderr which
+    # is set in the node shim to write to stderr.  This directs the output to
+    # Lambda logs.
+    # Printing to stdout managles up the payload returned from Lambda function.
+    # This is not desired when returning payload to API Gateway eventually.
+    def stdout_to_stderr
+      $stdout.sync = true
+      $stderr.sync = true
+      $stdout = $stderr
+    end
+
+    # require_bundle_gems called when environment boots up via Jets.boot.  It
+    # also useful for when to loading Rake tasks in
+    # Jets::Commands::RakeTasks.load!
+    #
+    # For example, some gems like webpacker that load rake tasks are specified
+    # with a git based source:
+    #
+    #   gem "webpacker", git: "https://github.com/tongueroo/webpacker.git"
+    #
+    # This results in the user having to specific bundle exec in front of
+    # jets for those rake tasks to show up in jets help.
+    #
+    # Instead, when the user is within the project folder, jets automatically
+    # requires bundler for the user. So the rake tasks show up when calling
+    # jets help.
+    #
+    # When the user calls jets help from outside the project folder, bundler
+    # is not used and the load errors get rescued gracefully.  This is done in
+    # Jets::Commands::RakeTasks.load!  In the case when there are in another
+    # project with another Gemfile, the load errors will still be rescued.
+    def require_bundle_gems
+      # NOTE: Dont think ENV['BUNDLE_GEMFILE'] is quite working right.  We still need
+      # to be in the project directory.  Leaving logic in here for when it gets fix.
+      if ENV['BUNDLE_GEMFILE'] || File.exist?("Gemfile")
+        require "bundler/setup"
+        Bundler.require(*bundler_groups)
+      end
+    end
+
+    # Only connects connect to database for ActiveRecord and when
+    # config/database.yml exists.
+    # Dynomite handles connecting to the clients lazily.
+    def setup_db
+      return unless File.exist?("#{Jets.root}config/database.yml")
+
+      db_configs = Jets.application.config.database
+      # DatabaseTasks.database_configuration for db:create db:migrate tasks
+      # Documented in DatabaseTasks that this is the right way to set it when
+      # using ActiveRecord rake tasks outside of Rails.
+      ActiveRecord::Tasks::DatabaseTasks.database_configuration = db_configs
+
+      current_config = db_configs[Jets.env]
+      if current_config.empty?
+        abort("ERROR: config/database.yml exists but no environment section configured for #{Jets.env}")
+      end
+      # Using ActiveRecord rake tasks outside of Rails, so we need to set up the
+      # db connection ourselves
+      ActiveRecord::Base.establish_connection(current_config)
+    end
+
+    def bundler_groups
+      [:default, Jets.env.to_sym]
+    end
+
+    # Cannot call this for the jets new
+    def confirm_jets_project!
+      unless File.exist?("#{Jets.root}config/application.rb")
+        puts "It does not look like you are running this command within a jets project.  Please confirm that you are in a jets project and try again.".colorize(:red)
+        exit
+      end
+    end
+
+    def message
+      "Jets booting up in #{Jets.env.colorize(:green)} mode!"
+    end
+  end
+end