jets 4.0.10 → 5.0.0.beta1

data/lib/jets/command/aws_helpers.rb

@@ -0,0 +1,26 @@
+module Jets
+  module Command
+    module AwsHelpers # :nodoc:
+      extend ActiveSupport::Concern
+
+      include Jets::AwsServices
+
+      def first_run?
+        return false if ENV['JETS_TEMPLATES']
+        !stack_exists?(Jets::Names.parent_stack_name)
+      end
+
+      def find_stack(stack_name)
+        resp = cfn.describe_stacks(stack_name: stack_name)
+        resp.stacks.first
+      rescue Aws::CloudFormation::Errors::ValidationError => e
+        # example: Stack with id demo-dev does not exist
+        if e.message =~ /Stack with/ && e.message =~ /does not exist/
+          nil
+        else
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/jets/command/base.rb

@@ -0,0 +1,204 @@
+# 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)
+        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

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

@@ -0,0 +1,42 @@
+# 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/call.md

@@ -0,0 +1,48 @@
+## 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/{commands → command}/help/deploy.md

@@ -5,7 +5,7 @@ This builds the project and deploys it AWS Lambda. The deployment is mainly hand
 ## Example
 
     $ jets deploy
-    Deploying to Lambda demo-dev environment...
+    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.

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

@@ -0,0 +1,21 @@
+Show logs from Lambda function CloudWatch log group.
+
+This defaults to the controller Lambda function in the `one_lambda_for_all_controllers` mode.  Example:
+
+    ❯ jets logs
+    Showing logs for /aws/lambda/demo-dev-controller
+
+If you want to follow the logs use the `-f` flag.
+
+    ❯ jets logs
+    Tailing logs for /aws/lambda/demo-dev-controller
+
+If you want to see the production logs:
+
+    ❯ JETS_ENV=production jets logs -f
+    Tailing logs for /aws/lambda/demo-prod-controller
+
+If you want to see logs for a job, specify the job and method.
+
+    ❯ jets logs -f -n hard_job-dig
+    Tailing logs for /aws/lambda/demo-dev-hard_job-dig

data/lib/jets/{commands → command}/help/new.md

@@ -1,10 +1,9 @@
 ## Examples
 
     $ jets new demo
-    Creating a new Jets project called demo.
-          create  demo/app/controllers/application_controller.rb
-          create  demo/app/helpers/application_helper.rb
-          create  demo/app/jobs/application_job.rb
+          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.

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

@@ -0,0 +1,6 @@
+## Examples
+
+    ❯ jets projects
+    api
+    backend
+    demo

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

@@ -0,0 +1,37 @@
+## Examples
+
+    $ jets releases
+    Releases for stack: demo-dev
+    +---------+-----------------+--------------+---------+
+    | Version |     Status      | Released At  | Message |
+    +---------+-----------------+--------------+---------+
+    | 27      | UPDATE_COMPLETE | 10 hours ago | Deploy  |
+    | 26      | UPDATE_COMPLETE | 11 hours ago | Deploy  |
+    | 25      | UPDATE_COMPLETE | 11 hours ago | Deploy  |
+    | 24      | UPDATE_COMPLETE | 11 hours ago | Deploy  |
+    | 23      | DELETE_COMPLETE | 14 hours ago | Deleted |
+    | 22      | UPDATE_COMPLETE | 14 hours ago | Deploy  |
+    | 21      | UPDATE_COMPLETE | 14 hours ago | Deploy  |
+    | 20      | UPDATE_COMPLETE | 14 hours ago | Deploy  |
+    | 19      | DELETE_COMPLETE | 14 hours ago | Deleted |
+    | 18      | UPDATE_COMPLETE | 14 hours ago | Deploy  |
+    | 17      | UPDATE_COMPLETE | 17 hours ago | Deploy  |
+    | 16      | UPDATE_COMPLETE | 18 hours ago | Deploy  |
+    | 15      | UPDATE_COMPLETE | 18 hours ago | Deploy  |
+    | 14      | DELETE_COMPLETE | 18 hours ago | Deleted |
+    | 13      | UPDATE_COMPLETE | 19 hours ago | Deploy  |
+    | 12      | UPDATE_COMPLETE | 19 hours ago | Deploy  |
+    | 11      | UPDATE_COMPLETE | 19 hours ago | Deploy  |
+    | 10      | DELETE_COMPLETE | 19 hours ago | Deleted |
+    | 9       | UPDATE_COMPLETE | 21 hours ago | Deploy  |
+    | 8       | UPDATE_COMPLETE | 21 hours ago | Deploy  |
+    | 7       | DELETE_COMPLETE | 21 hours ago | Deleted |
+    | 6       | UPDATE_COMPLETE | 21 hours ago | Deploy  |
+    | 5       | DELETE_COMPLETE | 22 hours ago | Deleted |
+    | 4       | UPDATE_COMPLETE | 22 hours ago | Deploy  |
+    | 3       | UPDATE_COMPLETE | 22 hours ago | Deploy  |
+    +---------+-----------------+--------------+---------+
+
+The shown releases are paginated. If you need to see more releases you can use the `--page` option.
+
+    $ jets releases --page 2

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

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

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

@@ -0,0 +1,15 @@
+## 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/stacks.md

@@ -0,0 +1,6 @@
+## Examples
+
+    ❯ jets stacks
+    Stacks for project: demo
+    demo-dev
+    demo-prod

data/lib/jets/command/help.rb

@@ -0,0 +1,17 @@
+module Jets::Command
+  class Help
+    class << self
+      def text(namespaced_command)
+        file = namespaced_command.to_s.gsub(':','/')
+        path = File.expand_path("../help/#{file}.md", __FILE__)
+        return IO.read(path) if File.exist?(path)
+
+        # Also look up for a help folder within the current command folder
+        called_from = caller.first.split(':').first
+        unnamespaced_command = namespaced_command.to_s.split(':').last
+        path = File.expand_path("../help/#{unnamespaced_command}.md", called_from)
+        return IO.read(path) if File.exist?(path)
+      end
+    end
+  end
+end

data/lib/jets/command/helpers/editor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support/encrypted_file"
+
+module Jets
+  module Command
+    module Helpers
+      module Editor
+        private
+          def ensure_editor_available(command:)
+            if ENV["EDITOR"].to_s.empty?
+              say "No $EDITOR to open file in. Assign one like this:"
+              say ""
+              say %(EDITOR="mate --wait" #{command})
+              say ""
+              say "For editors that fork and exit immediately, it's important to pass a wait flag,"
+              say "otherwise the credentials will be saved immediately with no chance to edit."
+
+              false
+            else
+              true
+            end
+          end
+
+          def catch_editing_exceptions
+            yield
+          rescue Interrupt
+            say "Aborted changing file: nothing saved."
+          rescue ActiveSupport::EncryptedFile::MissingKeyError => error
+            say error.message
+          end
+      end
+    end
+  end
+end