shopify-cli 0.9.0

data/lib/shopify-cli/version.rb

@@ -0,0 +1,3 @@
+module ShopifyCli
+  VERSION = '0.9.0'
+end

data/lib/shopify_cli.rb

@@ -0,0 +1,132 @@
+# Make sure we are using UTF 8 encoding
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+Thread.report_on_exception = false
+
+# Contains backports from newer rubies to make our lives easier
+# require_relative 'support/ruby_backports'
+
+# See bin/load_shopify.rb
+ENV['PATH'] = ENV['PATH'].split(':').select { |p| p.start_with?('/', '~') }.join(':') unless defined?($original_env)
+
+# Load vendor and CLI UI/Kit.
+# Nothing else should be loaded at this point and nothing else should be added to the load path on boot
+vendor_path = File.expand_path("../../vendor/lib", __FILE__)
+$LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
+
+deps = %w(cli-ui cli-kit smart_properties)
+deps.each do |dep|
+  vendor_path = File.expand_path("../../vendor/deps/#{dep}/lib", __FILE__)
+  $LOAD_PATH.unshift(vendor_path) unless $LOAD_PATH.include?(vendor_path)
+end
+
+require 'cli/ui'
+require 'cli/kit'
+require 'smart_properties'
+require_relative 'shopify-cli/version'
+
+# Enable stdout routing. At this point all calls to STDOUT (and STDERR) will go through this class.
+# See https://github.com/Shopify/cli-ui/blob/master/lib/cli/ui/stdout_router.rb for more info
+CLI::UI::StdoutRouter.enable
+
+# The main file to load for `shopify-app-cli`
+# Contains all high level constants, exit management, exception management,
+# autoloads for commands, tasks, helpers, etc
+#
+# It is recommended to read through CLI Kit (https://github.com/shopify/cli-kit) and a CLI Kit example
+# (https://github.com/Shopify/cli-kit-example) to fully understand how shopify-app-cli functions
+module ShopifyCli
+  extend CLI::Kit::Autocall
+
+  TOOL_NAME         = 'shopify'
+  TOOL_FULL_NAME    = 'Shopify CLI'
+  ROOT              = File.expand_path('../..', __FILE__)
+  PROJECT_TYPES_DIR = File.join(ROOT, 'lib', 'project_types')
+  TEMP_DIR          = File.join(ROOT, '.tmp')
+  CACHE_DIR         = File.join(File.expand_path(ENV.fetch('XDG_CACHE_HOME', '~/.cache')), TOOL_NAME)
+  TOOL_CONFIG_PATH  = File.join(File.expand_path(ENV.fetch('XDG_CONFIG_HOME', '~/.config')), TOOL_NAME)
+  LOG_FILE          = File.join(TOOL_CONFIG_PATH, 'logs', 'log.log')
+  DEBUG_LOG_FILE    = File.join(TOOL_CONFIG_PATH, 'logs', 'debug.log')
+
+  # programmer emoji if default install location, else wrench emoji
+  EMOJI    = ROOT == '/opt/shopify' ? "\u{1f469}\u{200d}\u{1f4bb}" : "\u{1f527}"
+  # shrug or boom emoji
+  FAILMOJI = ROOT == '/opt/shopify' ? "\u{1f937}" : "\u{1f4a5}"
+
+  # Exit management in `shopify-app-cli` follows the management set out by CLI Kit.
+  # https://github.com/Shopify/cli-kit/blob/master/lib/cli/kit.rb
+  # That is to say, we differentiate between exit success (0), exit failure (1), and exit bug (not 1)
+  #
+  # These should *never* be called outside of the entrypoint and its delegations.
+  EXIT_FAILURE_BUT_NOT_BUG = CLI::Kit::EXIT_FAILURE_BUT_NOT_BUG
+  EXIT_BUG                 = CLI::Kit::EXIT_BUG
+  EXIT_SUCCESS             = CLI::Kit::EXIT_SUCCESS
+
+  # `shopify-app-cli` uses CLI Kit's exception management
+  # These are documented here: https://github.com/Shopify/cli-kit/blob/master/lib/cli/kit.rb
+  #
+  # You should never subclass these exceptions, but instead rescue another exception and re-raise.
+  # AbortSilent and BugSilent should never have messages. They are mostly used when we output explanations
+  # and need to exit
+  GenericAbort = CLI::Kit::GenericAbort
+  Abort        = CLI::Kit::Abort
+  Bug          = CLI::Kit::Bug
+  BugSilent    = CLI::Kit::BugSilent
+  AbortSilent  = CLI::Kit::AbortSilent
+
+  # The rest of this file outlines classes and modules required by the shopify-app-cli
+  # application and CLI kit framework.
+  # To understand how this works, read https://github.com/Shopify/cli-kit/blob/master/lib/cli/kit.rb
+
+  # ShopifyCli::Config
+  autocall(:Config)   { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
+  # ShopifyCli::Logger
+  autocall(:Logger)   { CLI::Kit::Logger.new(debug_log_file: DEBUG_LOG_FILE) }
+  # ShopifyCli::Resolver
+  autocall(:Resolver) do
+    ShopifyCli::Core::HelpResolver.new(
+      tool_name: TOOL_NAME,
+      command_registry: ShopifyCli::Commands::Registry
+    )
+  end
+  # ShopifyCli::ErrorHandler
+  autocall(:ErrorHandler) do
+    CLI::Kit::ErrorHandler.new(
+      log_file: ShopifyCli::LOG_FILE,
+      exception_reporter: nil,
+    )
+  end
+
+  autoload :AdminAPI, 'shopify-cli/admin_api'
+  autoload :API, 'shopify-cli/api'
+  autoload :Command, 'shopify-cli/command'
+  autoload :Commands, 'shopify-cli/commands'
+  autoload :Context, 'shopify-cli/context'
+  autoload :Core, 'shopify-cli/core'
+  autoload :DB, 'shopify-cli/db'
+  autoload :Form, 'shopify-cli/form'
+  autoload :Git, 'shopify-cli/git'
+  autoload :Helpers, 'shopify-cli/helpers'
+  autoload :Heroku, 'shopify-cli/heroku'
+  autoload :JsDeps, 'shopify-cli/js_deps'
+  autoload :JsSystem, 'shopify-cli/js_system'
+  autoload :Log, 'shopify-cli/log'
+  autoload :OAuth, 'shopify-cli/oauth'
+  autoload :Options, 'shopify-cli/options'
+  autoload :PartnersAPI, 'shopify-cli/partners_api'
+  autoload :ProcessSupervision, 'shopify-cli/process_supervision'
+  autoload :Project, 'shopify-cli/project'
+  autoload :ProjectType, 'shopify-cli/project_type'
+  autoload :Resources, 'shopify-cli/resources'
+  autoload :SubCommand, 'shopify-cli/sub_command'
+  autoload :Task, 'shopify-cli/task'
+  autoload :Tasks, 'shopify-cli/tasks'
+  autoload :Tunnel, 'shopify-cli/tunnel'
+
+  require 'shopify-cli/messages/messages'
+  Context.load_messages(ShopifyCli::Messages::MESSAGES)
+end
+
+# Make sure the cache dir always exists
+FileUtils.mkdir_p(ShopifyCli::CACHE_DIR)

data/shopify-cli.gemspec

@@ -0,0 +1,40 @@
+require_relative 'lib/shopify-cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "shopify-cli"
+  spec.version = ShopifyCli::VERSION
+  spec.authors = ["Shopify"]
+  # need to change the email that ends with `shopify.com`
+  spec.email = ["developers@jadedpixel.com"]
+  spec.license = 'Nonstandard'
+
+  spec.summary = "Shopify CLI helps you build Shopify apps faster."
+  spec.description = <<~HERE
+    Shopify CLI helps you build Shopify apps faster. It quickly scaffolds Node.js
+    and Ruby on Rails embedded apps. It also automates many common tasks in the
+    development process and lets you quickly add popular features, such as billing
+    and webhooks.
+  HERE
+  spec.homepage = "https://shopify.github.io/shopify-app-cli/"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Shopify/shopify-app-cli"
+  spec.metadata["changelog_uri"] = "https://github.com/Shopify/shopify-app-cli/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features|packaging)/}) }
+  end
+  spec.bindir = "bin"
+  # spec.executables = spec.files.grep(%r{^bin/}) { |f| f.sub('bin/', '') }
+  spec.require_paths = ["lib", "vendor"]
+  spec.extensions = ["ext/shopify-cli/extconf.rb"]
+
+  spec.add_development_dependency('bundler', '~> 1.17')
+  spec.add_development_dependency('rake', '~> 12.3', '>= 12.3.3')
+  spec.add_development_dependency('minitest', '~> 5.0')
+end

data/shopify.fish

@@ -0,0 +1,12 @@
+#!/usr/bin/env fish
+# vi: ft=fish
+
+# If we're not already in a shim environment but still tried to set up a shim, print out the re-installation warning
+type -t shopify > /dev/null 2>&1
+if [ $status != "0" ]
+  echo "This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
+
+Please visit this page for complete instructions:
+  https://shopify.github.io/shopify-app-cli/migrate/
+"
+end

data/shopify.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+# If we're not already in a shim environment but still tried to set up a shim, print out the re-installation warning
+typeset -f shopify > /dev/null 2>&1
+if [ "$?" != "0" ]; then
+  echo "This version of Shopify App CLI is no longer supported. You’ll need to migrate to the new CLI version to continue.
+
+Please visit this page for complete instructions:
+  https://shopify.github.io/shopify-app-cli/migrate/
+"
+fi

data/vendor/deps/cli-kit/REVISION

@@ -0,0 +1 @@
+fc25a17dff9d3130bb705659c002282ef7827932

data/vendor/deps/cli-kit/lib/cli/kit.rb

@@ -0,0 +1,60 @@
+require 'cli/ui'
+require 'cli/kit/ruby_backports/enumerable'
+
+module CLI
+  module Kit
+    autoload :Autocall,        'cli/kit/autocall'
+    autoload :BaseCommand,     'cli/kit/base_command'
+    autoload :CommandRegistry, 'cli/kit/command_registry'
+    autoload :Config,          'cli/kit/config'
+    autoload :ErrorHandler,    'cli/kit/error_handler'
+    autoload :Executor,        'cli/kit/executor'
+    autoload :Ini,             'cli/kit/ini'
+    autoload :Levenshtein,     'cli/kit/levenshtein'
+    autoload :Logger,          'cli/kit/logger'
+    autoload :Resolver,        'cli/kit/resolver'
+    autoload :Support,         'cli/kit/support'
+    autoload :System,          'cli/kit/system'
+    autoload :Util,            'cli/kit/util'
+
+    EXIT_FAILURE_BUT_NOT_BUG = 30
+    EXIT_BUG                 = 1
+    EXIT_SUCCESS             = 0
+
+    # Abort, Bug, AbortSilent, and BugSilent are four ways of immediately bailing
+    # on command-line execution when an unrecoverable error occurs.
+    #
+    # Note that these don't inherit from StandardError, and so are not caught by
+    # a bare `rescue => e`.
+    #
+    # * Abort prints its message in red and exits 1;
+    # * Bug additionally submits the exception to Bugsnag;
+    # * AbortSilent and BugSilent do the same as above, but do not print
+    #     messages before exiting.
+    #
+    # Treat these like panic() in Go:
+    #   * Don't rescue them. Use a different Exception class if you plan to recover;
+    #   * Provide a useful message, since it will be presented in brief to the
+    #       user, and will be useful for debugging.
+    #   * Avoid using it if it does actually make sense to recover from an error.
+    #
+    # Additionally:
+    #   * Do not subclass these.
+    #   * Only use AbortSilent or BugSilent if you prefer to print a more
+    #       contextualized error than Abort or Bug would present to the user.
+    #   * In general, don't attach a message to AbortSilent or BugSilent.
+    #   * Never raise GenericAbort directly.
+    #   * Think carefully about whether Abort or Bug is more appropriate. Is this
+    #       a bug in the tool? Or is it just user error, transient network
+    #       failure, etc.?
+    #   * One case where it's ok to rescue (cli-kit internals or tests aside):
+    #       1. rescue Abort or Bug
+    #       2. Print a contextualized error message
+    #       3. Re-raise AbortSilent or BugSilent respectively.
+    GenericAbort = Class.new(Exception)
+    Abort        = Class.new(GenericAbort)
+    Bug          = Class.new(GenericAbort)
+    BugSilent    = Class.new(GenericAbort)
+    AbortSilent  = Class.new(GenericAbort)
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/autocall.rb

@@ -0,0 +1,21 @@
+require 'cli/kit'
+
+module CLI
+  module Kit
+    module Autocall
+      def autocall(const, &block)
+        @autocalls ||= {}
+        @autocalls[const] = block
+      end
+
+      def const_missing(const)
+        block = begin
+          @autocalls.fetch(const)
+        rescue KeyError
+          return super
+        end
+        const_set(const, block.call)
+      end
+    end
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/base_command.rb

@@ -0,0 +1,49 @@
+require 'cli/kit'
+
+module CLI
+  module Kit
+    class BaseCommand
+      def self.defined?
+        true
+      end
+
+      def self.statsd_increment(_metric, **_kwargs)
+        nil
+      end
+
+      def self.statsd_time(_metric, **_kwargs)
+        yield
+      end
+
+      def self.call(args, command_name)
+        cmd = new
+        stats_tags = cmd.stats_tags(args, command_name)
+        begin
+          statsd_increment("cli.command.invoked", tags: stats_tags)
+          statsd_time("cli.command.time", tags: stats_tags) do
+            cmd.call(args, command_name)
+          end
+          statsd_increment("cli.command.success", tags: stats_tags)
+        rescue Exception => e # rubocop:disable Lint/RescueException
+          statsd_increment("cli.command.exception", tags: stats_tags + ["exception:#{e.class}"])
+          raise e
+        end
+      end
+
+      def stats_tags(args, command_name)
+        tags = ["task:#{self.class}"]
+        tags << "command:#{command_name}" if command_name
+        tags << "subcommand:#{args.first}" if args&.first && has_subcommands?
+        tags
+      end
+
+      def call(_args, _command_name)
+        raise NotImplementedError
+      end
+
+      def has_subcommands?
+        false
+      end
+    end
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/command_registry.rb

@@ -0,0 +1,94 @@
+require 'cli/kit'
+
+module CLI
+  module Kit
+    class CommandRegistry
+      attr_reader :commands, :aliases
+
+      module NullContextualResolver
+        def self.command_names
+          []
+        end
+
+        def self.aliases
+          {}
+        end
+
+        def self.command_class(_name)
+          nil
+        end
+      end
+
+      def initialize(default:, contextual_resolver: nil)
+        @commands = {}
+        @aliases  = {}
+        @default = default
+        @contextual_resolver = contextual_resolver || NullContextualResolver
+      end
+
+      def resolved_commands
+        @commands.each_with_object({}) do |(k, v), a|
+          a[k] = resolve_class(v)
+        end
+      end
+
+      def add(const, name)
+        commands[name] = const
+      end
+
+      def lookup_command(name)
+        name = @default if name.to_s.empty?
+        resolve_command(name)
+      end
+
+      def add_alias(from, to)
+        aliases[from] = to unless aliases[from]
+      end
+
+      def command_names
+        @contextual_resolver.command_names + commands.keys
+      end
+
+      def exist?(name)
+        !resolve_command(name).first.nil?
+      end
+
+      private
+
+      def resolve_alias(name)
+        aliases[name] || @contextual_resolver.aliases.fetch(name, name)
+      end
+
+      def resolve_command(name)
+        name = resolve_alias(name)
+        resolve_global_command(name) || \
+          resolve_contextual_command(name) || \
+          [nil, name]
+      end
+
+      def resolve_global_command(name)
+        klass = resolve_class(commands.fetch(name, nil))
+        return nil unless klass&.defined?
+        [klass, name]
+      rescue NameError
+        nil
+      end
+
+      def resolve_contextual_command(name)
+        found = @contextual_resolver.command_names.include?(name)
+        return nil unless found
+        [@contextual_resolver.command_class(name), name]
+      end
+
+      def resolve_class(class_or_proc)
+        if class_or_proc.is_a?(Class)
+          class_or_proc
+        elsif class_or_proc.respond_to?(:call)
+          class_or_proc.call
+        else
+          class_or_proc
+        end
+      end
+    end
+  end
+end

data/vendor/deps/cli-kit/lib/cli/kit/config.rb

@@ -0,0 +1,133 @@
+require 'cli/kit'
+require 'fileutils'
+
+module CLI
+  module Kit
+    class Config
+      XDG_CONFIG_HOME = 'XDG_CONFIG_HOME'
+
+      def initialize(tool_name:)
+        @tool_name = tool_name
+      end
+
+      # Returns the config corresponding to `name` from the config file
+      # `false` is returned if it doesn't exist
+      #
+      # #### Parameters
+      # `section` : the section of the config value you are looking for
+      # `name` : the name of the config value you are looking for
+      #
+      # #### Returns
+      # `value` : the value of the config variable (false if none)
+      #
+      # #### Example Usage
+      # `config.get('name.of.config')`
+      #
+      def get(section, name, default: false)
+        all_configs.dig("[#{section}]", name) || default
+      end
+
+      # Coalesce and enforce the value of a config to a boolean
+      def get_bool(section, name, default: false)
+        case get(section, name, default: default).to_s
+        when "true"
+          true
+        when "false"
+          false
+        else
+          raise CLI::Kit::Abort, "Invalid config: #{section}.#{name} is expected to be true or false"
+        end
+      end
+
+      # Sets the config value in the config file
+      #
+      # #### Parameters
+      # `section` : the section of the config you are setting
+      # `name` : the name of the config you are setting
+      # `value` : the value of the config you are setting
+      #
+      # #### Example Usage
+      # `config.set('section', 'name.of.config', 'value')`
+      #
+      def set(section, name, value)
+        all_configs["[#{section}]"] ||= {}
+        all_configs["[#{section}]"][name] = value.nil? ? nil : value.to_s
+        write_config
+      end
+
+      # Unsets a config value in the config file
+      #
+      # #### Parameters
+      # `section` : the section of the config you are deleting
+      # `name` : the name of the config you are deleting
+      #
+      # #### Example Usage
+      # `config.unset('section', 'name.of.config')`
+      #
+      def unset(section, name)
+        set(section, name, nil)
+      end
+
+      # Gets the hash for the entire section
+      #
+      # #### Parameters
+      # `section` : the section of the config you are getting
+      #
+      # #### Example Usage
+      # `config.get_section('section')`
+      #
+      def get_section(section)
+        (all_configs["[#{section}]"] || {}).dup
+      end
+
+      # Returns a path from config in expanded form
+      # e.g. shopify corresponds to ~/src/shopify, but is expanded to /Users/name/src/shopify
+      #
+      # #### Example Usage
+      # `config.get_path('srcpath', 'shopify')`
+      #
+      # #### Returns
+      # `path` : the expanded path to the corrsponding value
+      #
+      def get_path(section, name = nil)
+        v = get(section, name)
+        false == v ? v : File.expand_path(v)
+      end
+
+      def to_s
+        ini.to_s
+      end
+
+      # The path on disk at which the configuration is stored:
+      #   `$XDG_CONFIG_HOME/<toolname>/config`
+      # if ENV['XDG_CONFIG_HOME'] is not set, we default to ~/.config, e.g.:
+      #   ~/.config/tool/config
+      #
+      def file
+        config_home = ENV.fetch(XDG_CONFIG_HOME, '~/.config')
+        File.expand_path(File.join(@tool_name, 'config'), config_home)
+      end
+
+      private
+
+      def all_configs
+        ini.ini
+      end
+
+      def ini
+        @ini ||= CLI::Kit::Ini
+          .new(file, default_section: "[global]", convert_types: false)
+          .tap(&:parse)
+      end
+
+      def write_config
+        all_configs.each do |section, sub_config|
+          all_configs[section] = sub_config.reject { |_, value| value.nil? }
+          all_configs.delete(section) if all_configs[section].empty?
+        end
+        FileUtils.mkdir_p(File.dirname(file))
+        File.write(file, to_s)
+      end
+    end
+  end
+end