jets-fs 1.6.10

data/lib/jets/commands/help/dynamodb/migrate.md

@@ -0,0 +1,4 @@
+## Examples
+
+    jets dynamodb:migrate path/to/migration
+    jets dynamodb:migrate db/migrate/posts_migration.rb

data/lib/jets/commands/help/gems/check.md

@@ -0,0 +1,8 @@
+You can configure additional gem sources in config/application.rb:
+
+    # Sources for check for pre-compiled Lambda gems. Checks the list in order.
+    Jets.application.configure do
+      config.gems.sources = [
+        "https://gems2.lambdagems.com"
+      ]
+    end

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

@@ -0,0 +1,22 @@
+This piggy backs off of the [rails scaffold generator](https://guides.rubyonrails.org/command_line.html#rails-generate).
+
+## Example
+
+    $ jets generate scaffold Post title:string body:text published:boolean
+          invoke  active_record
+          create    db/migrate/20180817052529_create_posts.rb
+          create    app/models/post.rb
+          invoke  resource_route
+           route    resources :posts
+          invoke  scaffold_controller
+          create    app/controllers/posts_controller.rb
+          invoke    erb
+          create      app/views/posts
+          create      app/views/posts/index.html.erb
+          create      app/views/posts/edit.html.erb
+          create      app/views/posts/show.html.erb
+          create      app/views/posts/new.html.erb
+          create      app/views/posts/_form.html.erb
+          invoke    helper
+          create      app/helpers/posts_helper.rb
+    $

data/lib/jets/commands/help/import/rack.md

@@ -0,0 +1,13 @@
+Imports a generic Rack application into a Jets project and configures it for [Mega Mode](http://rubyonjets.com/docs/megamode/).
+
+Note, generic rack projects will likely need some adjustments to take into account API Gateway stages and logging. For more info refer to [Mega Mode Considerations](http://rubyonjets.com//megamode-details/).
+
+## Example
+
+    jets import:rack http://github.com/tongueroo/jets-mega-rails.git
+
+## More Examples
+
+    jets import:rack tongueroo/jets-mega-rails # expands to github
+    jets import:rack git@github.com:tongueroo/jets-mega-rails.git
+    jets import:rack /path/to/folder/jets-mega-rails

data/lib/jets/commands/help/import/rails.md

@@ -0,0 +1,11 @@
+Imports a Rails application into a Jets project and configures it for [Mega Mode](http://rubyonjets.com/docs/rails-support/).
+
+## Example
+
+    jets import:rails http://github.com/tongueroo/demo-rails.git
+
+## More Examples
+
+    jets import:rails tongueroo/demo-rails # expands to github
+    jets import:rails git@github.com:tongueroo/demo-rails.git
+    jets import:rails /path/to/folder/jets-examples-rails

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

@@ -0,0 +1,42 @@
+## Examples
+
+    $ jets new demo
+    Creating new project called demo.
+          create  demo/app/controllers/application_controller.rb
+          create  demo/app/helpers/application_helper.rb
+          create  demo/app/jobs/application_job.rb
+    ...
+    ================================================================
+    Congrats  You have successfully created a Jets project.
+
+    Cd into the project directory:
+      cd demo
+
+    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
+    $
+
+## Mode Option
+
+The `--mode` is a notable option. With it, you can generate different starter Jets projects. Examples:
+
+    jets new demo --mode html # default
+    jets new api --mode api
+    jets new cron --mode job
+
+* The html mode generates a starter app useful for html web application.
+* The api mode is useful for building an API.
+* The job mode creates a very lightweight project. It is useful when you just need to run a Lambda function.
+
+## Repo Option
+Use the `--repo` flag to clone an example project from GitHub instead.  With this flag, jets new command clones a jets project repo from GitHub:
+
+    $ jets new blog --repo tongueroo/tutorial
+    $ jets new todos --repo tongueroo/todos
+    $ jets new whatever --repo user/repo # any github repo

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

@@ -0,0 +1,16 @@
+## Example
+
+    $ jets routes
+    +--------+----------------+--------------------+
+    |  Verb  |      Path      | Controller#action  |
+    +--------+----------------+--------------------+
+    | GET    | posts          | posts#index        |
+    | GET    | posts/new      | posts#new          |
+    | GET    | posts/:id      | posts#show         |
+    | POST   | posts          | posts#create       |
+    | GET    | posts/:id/edit | posts#edit         |
+    | PUT    | posts/:id      | posts#update       |
+    | DELETE | posts/:id      | posts#delete       |
+    | ANY    | *catchall      | jets/public#show   |
+    +--------+----------------+--------------------+
+    $

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

@@ -0,0 +1,17 @@
+## Examples
+
+    $ jets runner 'puts "hi"'
+    hi
+    $ jets runner 'puts Jets.env'
+    development
+
+Using a script in a file.  Let's say you have a script:
+
+script.rb:
+
+```ruby
+puts "hello world: #{Jets.env}"
+```
+
+    $ jets runner file://script.rb
+    hello world: development

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

@@ -0,0 +1,15 @@
+The local server for mimics API Gateway and provides a way to test your app locally without deploying to AWS.
+
+## Examples
+
+    $ jets server
+    => bundle exec shotgun --port 8888 --host 127.0.0.1
+    Jets booting up in development mode!
+    == Shotgun/WEBrick on http://127.0.0.1:8888/
+    [2018-08-17 05:31:33] INFO  WEBrick 1.4.2
+    [2018-08-17 05:31:33] INFO  ruby 2.5.1 (2018-03-29) [x86_64-linux]
+    [2018-08-17 05:31:33] INFO  WEBrick::HTTPServer#start: pid=27433 port=8888
+
+Start up server binding to host `0.0.0.0`:
+
+    jets server --host 0.0.0.0

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

@@ -0,0 +1,14 @@
+The CloudFormation stack status info. Essentially the events of the CloudFormation stack since the last update. If the CloudFormation stack is currently updating, this will live tail the events logs.
+
+## Example
+
+    $ jets status
+    The current status for the stack demo-dev is UPDATE_COMPLETE
+    Stack events:
+    05:21:42AM UPDATE_IN_PROGRESS AWS::CloudFormation::Stack demo-dev User Initiated
+    05:21:45AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack ApiGateway
+    ...
+    05:23:22AM CREATE_COMPLETE AWS::CloudFormation::Stack JetsPreheatJob
+    05:23:25AM UPDATE_COMPLETE_CLEANUP_IN_PROGRESS AWS::CloudFormation::Stack demo-dev
+    05:23:25AM UPDATE_COMPLETE AWS::CloudFormation::Stack demo-dev
+    $

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

@@ -0,0 +1,5 @@
+Upgrades the Jets project structure to the latest version. This command is designed to be idempotent, so it should be safe to run this command multiple times.
+
+## Example
+
+    $ jets upgrade

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

@@ -0,0 +1,6 @@
+If routes have been configured and an API Gateway was created for the app, this provides the application's url.
+
+## Example
+
+    $ jets url
+    https://v9wa7vqcia.execute-api.us-west-2.amazonaws.com/dev

data/lib/jets/commands/import.rb

@@ -0,0 +1,18 @@
+module Jets::Commands
+  class Import < Jets::Commands::Base
+    autoload :Base, 'jets/commands/import/base'
+    autoload :Cheatsheet, 'jets/commands/import/cheatsheet'
+    autoload :Rack, 'jets/commands/import/rack'
+    autoload :Rail, 'jets/commands/import/rail'
+    autoload :Sequence, 'jets/commands/import/sequence'
+
+    Jets::Commands::Import::Base.cli_options.each do |args|
+      class_option(*args)
+    end
+    long_desc Help.text('import:rails')
+    register(Jets::Commands::Import::Rail, "rails", "rails", "Imports rails project in the rack subfolder")
+
+    long_desc Help.text('import:rack')
+    register(Jets::Commands::Import::Rack, "rack", "rack", "Imports rack project in the rack subfolder")
+  end
+end

data/lib/jets/commands/import/base.rb

@@ -0,0 +1,49 @@
+class Jets::Commands::Import
+  class Base < Sequence
+    # 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
+      [
+        [:submodule, type: :boolean, default: false, desc: "Imports the project as a submodule"],
+      ]
+    end
+    cli_options.each { |args| class_option(*args) }
+
+    # Since setup is public it will automatically run in the subclasses
+    def setup
+      start_message
+      create_rack_folder
+      configure_ruby
+      create_rackup_wrappers
+    end
+
+  private
+    def start_message
+      puts "Importing app into the rack folder..."
+    end
+
+    def create_rack_folder
+      repo? ? clone_project : copy_project
+    end
+
+    def configure_ruby
+      gsub_file 'rack/Gemfile', /^ruby(.*)/, '# ruby\1' # comment out ruby declaration
+      create_file "rack/.ruby-version", RUBY_VERSION, force: true
+    end
+
+    def create_rackup_wrappers
+      path = File.expand_path("../../builders/rackup_wrappers", File.dirname(__FILE__))
+      Dir.glob("#{path}/*").each do |p|
+        FileUtils.cp(p, "#{rack_folder}/bin/")
+      end
+      chmod "#{rack_folder}/bin/rackup", 0755
+    end
+
+    def bundle_install
+      Bundler.with_clean_env do
+        run "cd rack && bundle install"
+      end
+    end
+  end
+end

data/lib/jets/commands/import/cheatsheet.rb

@@ -0,0 +1,35 @@
+class Jets::Commands::Import
+  class Cheatsheet
+    def self.create(rack_repo_url)
+      new(rack_repo_url).create
+    end
+
+    def initialize(rack_repo_url)
+      @rack_repo_url = rack_repo_url
+    end
+
+    def create
+      path = File.expand_path("./templates/", File.dirname(__FILE__)) + "/submodules-cheatsheet.md"
+      basename = File.basename(path)
+      dest = "#{Jets.root}/#{basename}"
+      cheatsheet = Jets::Erb.result(path, cheatsheet_vars)
+      FileUtils.mkdir_p(File.dirname(dest))
+      IO.write(dest, cheatsheet)
+      puts "Created #{basename} to help with using submodules."
+    end
+
+    def cheatsheet_vars
+      import_command = ARGV[0]
+      {
+        import_command: import_command,
+        rack_repo_url: @rack_repo_url,
+        jets_project_repo_url: jets_project_repo_url,
+      }
+    end
+
+    def jets_project_repo_url
+      # Thanks: https://stackoverflow.com/questions/4089430/how-can-i-determine-the-url-that-a-local-git-repository-was-originally-cloned-fr/4089452
+      `git config --get remote.origin.url`.strip rescue 'https://github.com/user/repo'
+    end
+  end
+end

data/lib/jets/commands/import/rack.rb

@@ -0,0 +1,16 @@
+class Jets::Commands::Import
+  class Rack < Base
+    def install
+      bundle_install
+    end
+
+    def finish_message
+      puts <<~EOL
+        #{"="*30}
+        Congrats! The Rack project from #{@source} has been imported to the rack folder.
+
+        Note, generic rack projects will likely need some adjustments to take into account API Gateway stages and logging. For more info refer to [Mega Mode Considerations](http://rubyonjets.com//megamode-details/).
+      EOL
+    end
+  end
+end

data/lib/jets/commands/import/rail.rb

@@ -0,0 +1,74 @@
+class Jets::Commands::Import
+  class Rail < Base
+    # We add jets-rails gem even though it's only activated within the megamode
+    # rackup wrapper script so user can check run bundle install and determine early
+    # if dependencies are met. The jets-rails gem is also added as part of the deploy
+    # process but we add it here also so the user gets earlier possible errors and
+    # can fix before they hit the deploy phase.
+    def configure_gemfile
+      append_to_file 'rack/Gemfile' do
+        %Q|gem "jets-rails"\n|
+      end
+    end
+
+    def install
+      bundle_install
+    end
+
+    def configure_routes
+      # comment out current catchall route
+      comment_lines("config/routes.rb", 'any[ (][\'"]\*', verbose: true) # any "*catchall", to: ...
+
+      # Add catchall route for rack
+      insert_into_file "config/routes.rb", :before => /^end/ do
+        <<-CODE
+  # Enables Mega Mode Rails integration
+  any "*catchall", to: "jets/rack#process"
+CODE
+      end
+    end
+
+    def reconfigure_database_yml
+      Jets::Turbo::DatabaseYaml.new.reconfigure
+    end
+
+    def finish_message
+      puts <<~EOL
+        #{"="*30}
+        Congrats! The Rails project from #{@source} has been imported to the rack folder.  Here are some next steps:
+
+        # Local Testing
+
+        Check out the config/routes.rb file and noticed how a new catchall route has been added.  It looks something like this:
+
+            any "*catchall", to: "jets/rack#process"
+
+        The catchall route passes any route not handled by the Jets app as a request onto the Rails app.  You can modified the route to selectively route what you want.
+
+        Please double check that rack/config/database.yml is appropriately configured, it likely needs to be updated.
+
+        Test the application locally. Test that the Rails app in the rack subfolder works independently.  You can start the application up with:
+
+            cd rack # cd into the imported Rails project
+            bundle exec rackup
+
+        The rack server starts up on http://localhost:9292
+
+        Once tested, stop that server with CTRL-C.
+
+        Then you can start the jets server from the main jets project:
+
+            cd .. # back to the main jets projet
+            jets server # starts both jets and rack servers
+
+        The jets server starts up on http://localhost:8888  You can stop both servers with CTRL-C.
+
+        # Deploy
+
+        When you are ready deploy to AWS Lambda with:
+
+            jets deploy
+        EOL
+    end
+  end
+end

data/lib/jets/commands/import/sequence.rb

@@ -0,0 +1,90 @@
+require 'bundler'
+require 'fileutils'
+require 'thor'
+
+class Jets::Commands::Import
+  class Sequence < Thor::Group
+    include Thor::Actions
+    argument :source
+
+  private
+    def clone_project
+      if File.exist?(rack_folder)
+        abort "The folder #{rack_folder} already exists.  Please remove it first if you want to import a project."
+      end
+
+      check_git_installed
+      if @options[:submodule]
+        git_submodule
+      else
+        git_clone
+      end
+    end
+
+    def git_submodule
+      puts "Adding project as a submodule"
+      run "git submodule add --force #{repo_url} #{rack_folder}"
+      Cheatsheet.create(repo_url)
+    end
+
+    def git_clone
+      command = "git clone #{repo_url} #{rack_folder}"
+      # Thor's run already puts out the command, so no need to puts
+      run command
+      run "rm -rf #{Jets.root}rack/.git"
+    end
+
+    def copy_project
+      puts "Creating rack folder"
+      template_path = File.expand_path(@source)
+      set_source_paths(template_path)
+      begin
+        directory ".", rack_folder, exclude_pattern: %r{.git}
+      rescue Thor::Error => e
+        puts e.message.color(:red)
+        exit 1
+      end
+    end
+
+    def set_source_paths(*paths)
+      # Using string with instance_eval because block doesnt have access to
+      # path at runtime.
+      self.class.instance_eval %{
+        def self.source_paths
+          #{paths.flatten.inspect}
+        end
+      }
+    end
+
+    # normalize repo_url
+    def repo_url
+      if repo?
+        @source # leave as is, user has provided full github url
+      else
+        # Defaults to GitHub
+        "https://github.com/#{@source}"
+      end
+    end
+
+    def repo?
+      @source.include?('github.com') ||
+      @source.include?('bitbucket.org') ||
+      @source.include?('gitlab.com')
+    end
+
+    def check_git_installed
+      return unless repo_url.include?('http') || repo_url.include?('git@')
+      unless git_installed?
+        abort "Unable to detect git installation on your system.  Git needs to be installed in order to clone the project."
+      end
+    end
+
+    def git_installed?
+      system("type git > /dev/null 2>&1")
+    end
+
+    def rack_folder
+      "#{Jets.root}/rack"
+    end
+  end
+end