jets 5.0.14 → 6.0.0.beta1

data/lib/jets/command/base.rb

@@ -1,209 +0,0 @@
-# frozen_string_literal: true
-
-require "thor"
-require "erb"
-
-require "active_support/core_ext/string/filters"
-require "active_support/core_ext/string/inflections"
-
-require "jets/command/actions"
-
-module Jets
-  module Command
-    class Base < Thor
-      extend Memoist
-
-      class Error < Thor::Error # :nodoc:
-      end
-
-      class CorrectableError < Error # :nodoc:
-        attr_reader :key, :options
-
-        def initialize(message, key, options)
-          @key     = key
-          @options = options
-          super(message)
-        end
-
-        if defined?(DidYouMean::SpellChecker) && defined?(DidYouMean::Correctable)
-          include DidYouMean::Correctable
-
-          def corrections
-            @corrections ||= DidYouMean::SpellChecker.new(dictionary: options).correct(key)
-          end
-        end
-      end
-
-      include Actions
-      include AwsHelpers
-      include ApiHelpers
-
-      no_commands do
-        cattr_accessor :full_namespace
-      end
-
-      class << self
-        def long_desc(long_description, options = {})
-          options[:wrap] = false
-          super
-        end
-
-        def exit_on_failure? # :nodoc:
-          false
-        end
-
-        # Returns true when the app is a Jets engine.
-        def engine?
-          defined?(ENGINE_ROOT)
-        end
-
-        # Tries to get the description from a USAGE file one folder above the command
-        # root.
-        def desc(usage = nil, description = nil, options = {})
-          if usage
-            super
-          else
-            @desc ||= ERB.new(File.read(usage_path), trim_mode: "-").result(binding) if usage_path
-          end
-        end
-
-        # Convenience method to get the namespace from the class name. It's the
-        # same as Thor default except that the Command at the end of the class
-        # is removed.
-        def namespace(name = nil)
-          if name
-            super
-          else
-            @namespace ||= super.chomp("_command").sub(/:command:/, ":")
-          end
-        end
-
-        # Convenience method to hide this command from the available ones when
-        # running jets command.
-        def hide_command!
-          Jets::Command.hidden_commands << self
-        end
-
-        def inherited(base) # :nodoc:
-          super
-
-          if base.name && !base.name.end_with?("Base")
-            Jets::Command.subclasses << base
-          end
-        end
-
-        def perform(full_namespace, command, args, config) # :nodoc:
-          if Jets::Command::HELP_MAPPINGS.include?(args.first)
-            command, args = "help", []
-            self.full_namespace = full_namespace # store for help. clean:log => log
-          end
-
-          dispatch(command, args.dup, nil, config)
-        rescue Thor::InvocationError => e
-          puts e.message.color(:red) # message already has ERROR prefix
-          self.full_namespace = full_namespace # store for help. clean:log => log
-          dispatch("help", [], nil, config)
-          exit 1
-        end
-
-        def printing_commands
-          namespaced_commands
-        end
-
-        def executable
-          "jets #{full_namespace || command_name}"
-        end
-
-        # Use Jets' default banner.
-        def banner(*)
-          command_name = full_namespace ? full_namespace.split(':').last : command_name
-          command = commands[command_name]
-          options_arg = '[options]' unless command && command.options.empty?
-          output = "#{executable} #{arguments.map(&:usage).join(' ')} #{options_arg}".squish
-          "  #{output}" # add 2 more spaces in front
-        end
-
-        # Sets the base_name taking into account the current class namespace.
-        #
-        #   Jets::Command::TestCommand.base_name # => 'jets'
-        def base_name
-          @base_name ||= if base = name.to_s.split("::").first
-            base.underscore
-          end
-        end
-
-        # Return command name without namespaces.
-        #
-        #   Jets::Command::TestCommand.command_name # => 'test'
-        def command_name
-          @command_name ||= if command = name.to_s.split("::").last
-            command.chomp!("Command")
-            command.underscore
-          end
-        end
-
-        # Path to lookup a USAGE description in a file.
-        def usage_path
-          if default_command_root
-            path = File.join(default_command_root, "USAGE")
-            path if File.exist?(path)
-          end
-        end
-
-        # Default file root to place extra files a command might need, placed
-        # one folder above the command file.
-        #
-        # For a Jets::Command::TestCommand placed in <tt>jets/command/test_command.rb</tt>
-        # would return <tt>jets/test</tt>.
-        def default_command_root
-          path = File.expand_path(relative_command_path, __dir__)
-          path if File.exist?(path)
-        end
-
-        private
-          # Allow the command method to be called perform.
-          def create_command(meth)
-            if meth == "perform"
-              alias_method command_name, meth
-            else
-              # Prevent exception about command without usage.
-              # Some commands define their documentation differently.
-              @usage ||= ""
-              @desc  ||= ""
-
-              super
-            end
-          end
-
-          def command_root_namespace
-            (namespace.split(":") - %w(jets)).join(":")
-          end
-
-          def relative_command_path
-            File.join("../commands", *command_root_namespace.split(":"))
-          end
-
-          def namespaced_commands
-            commands.keys.map do |key|
-              if command_root_namespace.match?(/(\A|:)#{key}\z/)
-                command_root_namespace
-              else
-                "#{command_root_namespace}:#{key}"
-              end
-            end
-          end
-      end
-
-      def help
-        if full_namespace = self.class.full_namespace
-          command_name = full_namespace.split(':').last # clean:log => log
-          self.class.command_help(shell, command_name)
-        elsif command_name = self.class.command_name
-          self.class.command_help(shell, command_name)
-        else
-          super
-        end
-      end
-    end
-  end
-end

data/lib/jets/command/behavior.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support"
-
-module Jets
-  module Command
-    module Behavior # :nodoc:
-      extend ActiveSupport::Concern
-
-      class_methods do
-        # Remove the color from output.
-        def no_color!
-          Thor::Base.shell = Thor::Shell::Basic
-        end
-
-        # Track all command subclasses.
-        def subclasses
-          @subclasses ||= []
-        end
-
-        private
-          # Prints a list of generators.
-          def print_list(base, namespaces)
-            return if namespaces.empty?
-            puts "#{base.camelize}:"
-
-            namespaces.each do |namespace|
-              puts("  #{namespace}")
-            end
-
-            puts
-          end
-
-          # Receives namespaces in an array and tries to find matching generators
-          # in the load path.
-          def lookup(namespaces)
-            paths = namespaces_to_paths(namespaces)
-            paths.each do |raw_path|
-              lookup_paths.each do |base|
-                path = "#{base}/#{raw_path}_#{command_type}"
-
-                begin
-                  require path
-                  return
-                rescue LoadError => e
-                  raise unless /#{Regexp.escape(path)}$/.match?(e.message)
-                rescue Exception => e
-                  warn "[WARNING] Could not load #{command_type} #{path.inspect}. Error: #{e.message}.\n#{e.backtrace.join("\n")}"
-                end
-              end
-            end
-          end
-
-          # This will try to load any command in the load path to show in help.
-          def lookup!
-            $LOAD_PATH.each do |base|
-              Dir[File.join(base, *file_lookup_paths)].each do |path|
-                path = path.delete_prefix("#{base}/")
-                require path
-              rescue Exception
-                # No problem
-              end
-            end
-          end
-
-          # Convert namespaces to paths by replacing ":" for "/" and adding
-          # an extra lookup. For example, "jets:model" should be searched
-          # in both: "jets/model/model_generator" and "jets/model_generator".
-          def namespaces_to_paths(namespaces)
-            paths = []
-            namespaces.each do |namespace|
-              pieces = namespace.split(":")
-              path = pieces.join("/")
-              paths << "#{path}/#{pieces.last}"
-              paths << path
-            end
-            paths.uniq!
-            paths
-          end
-      end
-    end
-  end
-end

data/lib/jets/command/environment_argument.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support"
-require "active_support/core_ext/class/attribute"
-
-module Jets
-  module Command
-    module EnvironmentArgument # :nodoc:
-      extend ActiveSupport::Concern
-
-      included do
-        no_commands do
-          class_attribute :environment_desc, default: "Specifies the environment to run this #{self.command_name} under (test/development/production)."
-        end
-        class_option :environment, aliases: "-e", type: :string, desc: environment_desc
-      end
-
-      private
-        def extract_environment_option_from_argument(default_environment: Jets::Command.environment)
-          if options[:environment]
-            self.options = options.merge(environment: acceptable_environment(options[:environment]))
-          else
-            self.options = options.merge(environment: default_environment)
-          end
-          # JETS_ENV needs to be set before config/application is required.
-          ENV["JETS_ENV"] = options[:environment]
-        end
-
-        def acceptable_environment(env = nil)
-          if available_environments.include? env
-            env
-          else
-            %w( production development test ).detect { |e| /^#{env}/.match?(e) } || env
-          end
-        end
-
-        def available_environments
-          Dir["config/environments/*.rb"].map { |fname| File.basename(fname, ".*") }
-        end
-    end
-  end
-end

data/lib/jets/command/help/build.md

@@ -1,6 +0,0 @@
-Builds a zip file package to be uploaded to AWS Lambda. This allows you to build the project without deploying and inspect the zip file that gets deployed to AWS Lambda. The package contains:
-
-* your application code
-* generated shims
-
-If the application has no Ruby code and only uses Polymorphic functions, then gems are not bundled up.

data/lib/jets/command/help/call.md

@@ -1,48 +0,0 @@
-## Remote mode
-
-Invoke the lambda function on AWS.
-
-## Examples
-
-### Controller Examples
-
-    jets call controller '{"path": "/up", "httpMethod": "GET"}' --show-logs | jq
-
-You'll need to specify enough of the event payload so that the Jets shim handler can find the route and send it to the right controller action.
-
-    jets call controller '{"path":"/posts"}' --show-logs | jq .
-    jets call controller 'file://event.json' --show-logs | jq .
-
-## Job Examples
-
-    jets call hard_job-drive '{"test":1}'
-    jets call hard_job-drive '{"test":1}' | jq .
-    jets call hard_job-drive file://event.json | jq . # load event with a file
-
-
-The equivalent AWS Lambda CLI command:
-
-    aws lambda invoke --function-name demo-dev-hard_job-dig --payload '{"path":"/posts","test":1}' outfile.txt
-    cat outfile.txt | jq '.'
-
-Jets figures out what functions to call by evaluating the app code and finds if the class and method exists.  If you want to turn guess mode off and want to always explicitly provide the method name use the `--no-guess` option.  The function name will then have to match the lambda function without the namespace. Example:
-
-    jets call controller --no-guess
-
-If you want to call a function which runs too long time, you can set `read_timeout`.
-
-    jets call some_long_job-index --read_timeout 900
-
-And you can set `retry_limit`. If you don't want to retry you can set 0.
-
-    jets call some_long_job-index --retry_limit 0
-
-## Local mode
-
-Instead of calling AWS lambda remote, you can also have `jets call` use the code directly on your machine.  To enable this, use the `--local` flag. Example:
-
-    jets call hard_job-drive --local
-
-## Logs
-
-The `jets call` command can also print out the last 4KB of the lambda logs with the `--show-logs` option. The logging output is directed to stderr and the response output from the lambda function itself is directed to stdout so you can safely pipe the results of the call command to other tools like `jq`.

data/lib/jets/command/help/clean/build.md

@@ -1,5 +0,0 @@
-Removes the build files that jets creates. Essentially, deletes `/tmp/jets`. This will remove all build files for all jets projects. This is safe as jets uses `/tmp/jets` merely as a cache to speed up incrementally builds. Cleaning this out can clean up cruft in the `/tmp/jets` directory that builds over time.
-
-## Example
-
-    jets clean:build

data/lib/jets/command/help/clean/log.md

@@ -1,5 +0,0 @@
-Essentially removes the CloudWatch groups assocated with the app. Lambda requests re-create the log groups so this is pretty safe to do.
-
-## Example
-
-    jets log:clean

data/lib/jets/command/help/console.md

@@ -1,18 +0,0 @@
-## Example
-
-    $ jets console
-    >> Post.table_name
-    => "posts"
-    >> ActiveRecord::Base.connection.tables
-    => ["schema_migrations", "ar_internal_metadata", "posts"]
-    >> Jets.env
-    => "development"
-    >>
-
-## Use .env.development.remote
-
-To use the remote values also in the `jets console` you can use the `JETS_ENV_REMOTE=1` env variable. Example:
-
-    JETS_ENV_REMOTE=1 jets console
-
-More info at [Env Files](http://rubyonjets.com/docs/env-files/)

data/lib/jets/command/help/db/generate.md

@@ -1,8 +0,0 @@
-Generates migration in `db/migrate`
-
-## Examples
-
-    jets db:generate create_articles title:string user_id:integer
-    jets db:generate AddTitleBodyToPost title:string body:text published:boolean
-
-This task delegates to Rails `rails generate migration`.  For more examples, refer to the [Active Record Migrations Rails Guide](https://edgeguides.rubyonrails.org/active_record_migrations.html).

data/lib/jets/command/help/dbconsole.md

@@ -1,9 +0,0 @@
-This is like running the psql command with the `config/database.yml` values and set for you.
-
-## Example
-
-    $ jets dbconsole
-    psql (9.2.24)
-    Type "help" for help.
-
-    demo_dev=>

data/lib/jets/command/help/degenerate.md

@@ -1,16 +0,0 @@
-This piggy backs off of the [rails scaffold destroy](https://guides.rubyonrails.org/command_line.html#rails-destroy).
-
-## Example
-
-    $ jets degenerate scaffold post title:string body:text published:boolean
-          invoke  active_record
-          remove    db/migrate/20190225231821_create_posts.rb
-          remove    app/models/post.rb
-          invoke  resource_route
-          route    resources :posts
-          invoke  scaffold_controller
-          remove    app/controllers/posts_controller.rb
-          invoke    erb
-          invoke    helper
-          remove      app/helpers/posts_helper.rb
-    $

data/lib/jets/command/help/deploy.md

@@ -1,32 +0,0 @@
-This builds the project and deploys it AWS Lambda. The deployment is mainly handled by CloudFormation.  To check on the status of the deploy you can also check the CloudFormation console.
-
-![](http://rubyonjets.com/img/cli/deploy-cloudformation-status.png)
-
-## Example
-
-    $ jets deploy
-    Deploying stack demo-dev ...
-    => Compling assets in current project directory
-    => Copying current project directory to temporary build area: /tmp/jets/demo/app_root
-    => Tidying project: removing ignored files to reduce package size.
-    => Generating node shims in the handlers folder.
-    => Bundling: running bundle install in cache area: /tmp/jets/demo/cache.
-    => Setting up a vendored copy of ruby.
-    => Replacing compiled gems with AWS Lambda Linux compiled versions.
-    Creating zip file.
-    => cd /tmp/jets/demo/app_root && zip --symlinks -rq /tmp/jets/demo/code/code-temp.zip .
-    Building CloudFormation templates.
-    Deploying CloudFormation stack with jets app!
-    Uploading /tmp/jets/demo/code/code-7169d0ac.zip (88.8 MB) to S3
-    Time to upload code to s3: 1s
-    Deploying CloudFormation stack with jets app!
-    02:08:20AM UPDATE_IN_PROGRESS AWS::CloudFormation::Stack demo-dev User Initiated
-    02:08:23AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack ApiGateway
-    ...
-    02:08:48AM CREATE_IN_PROGRESS AWS::CloudFormation::Stack PostsController
-    02:10:03AM UPDATE_COMPLETE AWS::CloudFormation::Stack demo-dev
-    Stack success status: UPDATE_COMPLETE
-    Time took for stack deployment: 1m 46s.
-    Prewarming application.
-    API Gateway Endpoint: https://ewwnealfk0.execute-api.us-west-2.amazonaws.com/dev/
-    $

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

@@ -1 +0,0 @@
-Check if precompiled gems are available from Jets Pro.

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

@@ -1,28 +0,0 @@
-This piggy backs off of the [rails scaffold generator](https://guides.rubyonrails.org/command_line.html#rails-generate).
-
-## General options
-
-    -h, [--help]     # Print generator's options and usage
-    -p, [--pretend]  # Run but do not make any changes
-    -f, [--force]    # Overwrite files that already exist
-    -s, [--skip]     # Skip files that already exist
-    -q, [--quiet]    # Suppress status output
-
-Please choose a generator below.
-
-Jets:
-
-    application_record
-    controller
-    helper
-    job
-    migration
-    model
-    resource
-    scaffold
-    scaffold_controller
-    task
-
-ActiveRecord:
-
-    active_record:application_record

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

@@ -1,13 +0,0 @@
-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/command/help/import/rails.md

@@ -1,11 +0,0 @@
-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/command/help/new.md

@@ -1,41 +0,0 @@
-## Examples
-
-    $ jets new demo
-          create  app/controllers/application_controller.rb
-          create  app/helpers/application_helper.rb
-          create  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/command/help/rollback.md

@@ -1,5 +0,0 @@
-## Examples
-
-    jets rollback 8
-
-Use the [jets releases](/reference/jets-releases/) command to view release history.

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

@@ -1,15 +0,0 @@
-## Example
-
-    $ jets routes
-    +-------------------+--------+--------------------+--------------------+
-    |    As (Prefix)    |  Verb  | Path (URI Pattern) | Controller#action  |
-    +-------------------+--------+--------------------+--------------------+
-    | posts             | GET    | /posts             | posts#index        |
-    | posts             | POST   | /posts             | posts#create       |
-    | new_post          | GET    | /posts/new         | posts#new          |
-    | edit_post         | GET    | /posts/:id/edit    | posts#edit         |
-    | post              | GET    | /posts/:id         | posts#show         |
-    | post              | PUT    | /posts/:id         | posts#update       |
-    | post              | PATCH  | /posts/:id         | posts#update       |
-    | post              | DELETE | /posts/:id         | posts#destroy      |
-    +-------------------+--------+--------------------+--------------------+

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

@@ -1,40 +0,0 @@
-## 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
-
-
-Optionally pass in an argument on the command line:
-
-    Usage: jets runner file|Ruby code [args]
-
-The argument will be assigned to the `args` variable.
-
-Example:
-
-    $ jets runner 'puts "hello world with args: #{args}"' 123
-    hello world with args: 123
-
-
-Example with script.rb:
-
-```ruby
-puts "hello world with args: #{args}"
-```
-
-    $ jets runner file://script.rb 123
-    hello world with args: 123
-

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

@@ -1,15 +0,0 @@
-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