shopify-cli 0.9.0

data/lib/shopify-cli/helpers.rb

@@ -0,0 +1,5 @@
+module ShopifyCli
+  module Helpers
+    autoload :Haikunator, 'shopify-cli/helpers/haikunator'
+  end
+end

data/lib/shopify-cli/helpers/haikunator.rb

@@ -0,0 +1,92 @@
+# Copyright (c) 2015 Usman Bashir
+#
+# MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require "securerandom"
+
+module ShopifyCli
+  module Helpers
+    module Haikunator
+      class << self
+        def title
+          build(0, ' ')
+        end
+
+        def haikunate(token_range = 9999, delimiter = "-")
+          build(token_range, delimiter)
+        end
+
+        def name
+          first = nouns[random_seed % nouns.length]
+          last = adjectives[random_seed % adjectives.length]
+          [first, last]
+        end
+
+        private
+
+        def build(token_range, delimiter)
+          sections = [
+            adjectives[random_seed % adjectives.length],
+            nouns[random_seed % nouns.length],
+            token(token_range),
+          ]
+
+          sections.compact.join(delimiter)
+        end
+
+        def random_seed
+          SecureRandom.random_number(4096)
+        end
+
+        def token(range)
+          SecureRandom.random_number(range) if range > 0
+        end
+
+        def adjectives
+          %w(
+            autumn hidden bitter misty silent empty dry dark summer
+            icy delicate quiet white cool spring winter patient
+            twilight dawn crimson wispy weathered blue billowing
+            broken cold damp falling frosty green long late lingering
+            bold little morning muddy old red rough still small
+            sparkling throbbing shy wandering withered wild black
+            young holy solitary fragrant aged snowy proud floral
+            restless divine polished ancient purple lively nameless
+          )
+        end
+
+        def nouns
+          %w(
+            waterfall river breeze moon rain wind sea morning
+            snow lake sunset pine shadow leaf dawn glitter forest
+            hill cloud meadow sun glade bird brook butterfly
+            bush dew dust field fire flower firefly feather grass
+            haze mountain night pond darkness snowflake silence
+            sound sky shape surf thunder violet water wildflower
+            wave water resonance sun wood dream cherry tree fog
+            frost voice paper frog smoke star
+          )
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/heroku.rb

@@ -0,0 +1,97 @@
+module ShopifyCli
+  class Heroku
+    DOWNLOAD_URLS = {
+      linux: 'https://cli-assets.heroku.com/heroku-linux-x64.tar.gz',
+      mac: 'https://cli-assets.heroku.com/heroku-darwin-x64.tar.gz',
+      windows: 'https://cli-assets.heroku.com/heroku-win32-x64.tar.gz',
+    }
+
+    def initialize(ctx)
+      @ctx = ctx
+    end
+
+    def app
+      return nil unless (app = git_remote)
+      app = app.split('/').last
+      app = app.split('.').first
+      app
+    end
+
+    def authenticate
+      result = @ctx.system(heroku_command, 'login')
+      @ctx.abort(@ctx.message('core.heroku.error.authentication')) unless result.success?
+    end
+
+    def create_new_app
+      output, status = @ctx.capture2e(heroku_command, 'create')
+      @ctx.abort(@ctx.message('core.heroku.error.creation')) unless status.success?
+      @ctx.puts(output)
+    end
+
+    def deploy(branch_to_deploy)
+      result = @ctx.system('git', 'push', '-u', 'heroku', "#{branch_to_deploy}:master")
+      @ctx.abort(@ctx.message('core.heroku.error.deploy')) unless result.success?
+    end
+
+    def download
+      return if installed?
+
+      result = @ctx.system('curl', '-o', download_path, DOWNLOAD_URLS[@ctx.os], chdir: ShopifyCli::CACHE_DIR)
+      @ctx.abort(@ctx.message('core.heroku.error.download')) unless result.success?
+      @ctx.abort(@ctx.message('core.heroku.error.download')) unless File.exist?(download_path)
+    end
+
+    def install
+      return if installed?
+
+      result = @ctx.system('tar', '-xf', download_path, chdir: ShopifyCli::CACHE_DIR)
+      @ctx.abort(@ctx.message('core.heroku.error.install')) unless result.success?
+
+      @ctx.rm(download_path)
+    end
+
+    def select_existing_app(app_name)
+      result = @ctx.system(heroku_command, 'git:remote', '-a', app_name)
+
+      msg = @ctx.message('core.heroku.error.could_not_select_app', app_name)
+      @ctx.abort(msg) unless result.success?
+    end
+
+    def whoami
+      output, status = @ctx.capture2e(heroku_command, 'whoami')
+      return output.strip if status.success?
+      nil
+    end
+
+    private
+
+    def download_filename
+      URI.parse(DOWNLOAD_URLS[@ctx.os]).path.split('/').last
+    end
+
+    def download_path
+      File.join(ShopifyCli::CACHE_DIR, download_filename)
+    end
+
+    def git_remote
+      output, status = @ctx.capture2e('git', 'remote', 'get-url', 'heroku')
+      status.success? ? output : nil
+    end
+
+    def heroku_command
+      local_path = File.join(ShopifyCli::CACHE_DIR, 'heroku', 'bin', 'heroku').to_s
+      if File.exist?(local_path)
+        local_path
+      else
+        'heroku'
+      end
+    end
+
+    def installed?
+      _output, status = @ctx.capture2e(heroku_command, '--version')
+      status.success?
+    rescue
+      false
+    end
+  end
+end

data/lib/shopify-cli/js_deps.rb

@@ -0,0 +1,110 @@
+require 'shopify_cli'
+
+module ShopifyCli
+  ##
+  # ShopifyCli::JsDeps ensures that all JavaScript dependencies are installed for projects.
+  #
+  class JsDeps
+    include SmartProperties
+
+    property! :ctx, accepts: ShopifyCli::Context
+    property! :system, accepts: JsSystem, default: -> { JsSystem.new(ctx: ctx) }
+
+    ##
+    # Proxy to instance method ShopifyCli::JsDeps.new.install.
+    #
+    # #### Parameters
+    # - `ctx`: running context from your command
+    # - `verbose`: whether to run the installation tools in silent mode
+    #
+    # #### Example
+    #
+    #   ShopifyCli::JsDeps.install(ctx)
+    #
+    def self.install(ctx, verbose = false)
+      new(ctx: ctx).install(verbose)
+    end
+
+    ##
+    # Installs all of a project's JavaScript dependencies using Yarn or NPM, based on the project's settings.
+    #
+    # #### Parameters
+    # - `verbose`: whether to run the installation tools in silent mode
+    #
+    # #### Example
+    #
+    #   # context is the running context for the command
+    #   ShopifyCli::JsDeps.new(context).install(true)
+    #
+    def install(verbose = false)
+      title = ctx.message('core.js_deps.installing', @system.package_manager)
+      success = ctx.message('core.js_deps.installed')
+      failure = ctx.message('core.js_deps.error.install_error', @system.package_manager)
+
+      CLI::UI::Frame.open(title, success_text: success, failure_text: failure) do
+        @system.call(
+          yarn: -> { yarn(verbose) },
+          npm: -> { npm(verbose) }
+        )
+      end
+    end
+
+    private
+
+    def yarn(verbose = false)
+      cmd = %w(yarn install)
+      cmd << '--silent' unless verbose
+
+      run_install_command(cmd)
+    end
+
+    def npm(verbose = false)
+      cmd = %w(npm install --no-audit --no-optional)
+      cmd << '--quiet' unless verbose
+
+      run_install_command(cmd)
+    end
+
+    def run_install_command(cmd)
+      deps = parse_dependencies
+      errors = nil
+
+      spinner_title = ctx.message('core.js_deps.installing_deps', deps.size)
+      success = CLI::UI::Spinner.spin(spinner_title, auto_debrief: false) do |spinner|
+        _, errors, status = CLI::Kit::System.capture3(*cmd, env: @ctx.env, chdir: ctx.root)
+        update_spinner_title_and_status(spinner, status, deps)
+      end
+
+      errors.lines.each { |e| ctx.puts e } unless success || errors.nil?
+      success
+    end
+
+    def update_spinner_title_and_status(spinner, status, deps)
+      if status.success?
+        spinner.update_title(ctx.message('core.js_deps.installed_deps', deps.size))
+      else
+        spinner.update_title(ctx.message('core.js_deps.error.install_spinner_error', deps.size))
+        CLI::UI::Spinner::TASK_FAILED
+      end
+    end
+
+    def parse_dependencies
+      package_json = File.join(ctx.root, 'package.json')
+      pkg = begin
+              JSON.parse(File.read(package_json))
+            rescue Errno::ENOENT, Errno::ENOTDIR
+              ctx.abort(ctx.message('core.js_deps.error.missing_package', package_json))
+            end
+
+      %w(dependencies devDependencies).map do |key|
+        pkg.fetch(key, []).keys
+      end.flatten
+    rescue JSON::ParserError
+      ctx.puts(
+        ctx.message('core.js_deps.error.invalid_package', File.read(File.join(path, 'package.json'))),
+        error: true
+      )
+      raise ShopifyCli::AbortSilent
+    end
+  end
+end

data/lib/shopify-cli/js_system.rb

@@ -0,0 +1,98 @@
+require 'shopify_cli'
+
+module ShopifyCli
+  ##
+  # ShopifyCli::JsSystem allows conditional system calls of npm or yarn commands.
+  #
+  class JsSystem
+    include SmartProperties
+
+    YARN_CORE_COMMAND = 'yarn'
+    NPM_CORE_COMMAND = 'npm'
+
+    class << self
+      ##
+      # Proxy to instance method `ShopifyCli::JsSystem.new.yarn?`
+      #
+      # #### Parameters
+      # - `ctx`: running context from your command
+      #
+      # #### Example
+      #
+      #   ShopifyCli::JsSystem.yarn?(ctx)
+      #
+      def yarn?(ctx)
+        JsSystem.new(ctx: ctx).yarn?
+      end
+
+      ##
+      # Proxy to instance method `ShopifyCli::JsSystem.new.call`
+      #
+      # #### Parameters
+      # - `ctx`: running context from your command
+      # - `yarn`: The proc, array, or string command to run if yarn is available
+      # - `npm`: The proc, array, or string command to run if npm is available
+      #
+      # #### Example
+      #
+      #   ShopifyCli::JsSystem.call(ctx, yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
+      #
+      def call(ctx, yarn:, npm:)
+        JsSystem.new(ctx: ctx).call(yarn: yarn, npm: npm)
+      end
+    end
+
+    property :ctx, accepts: ShopifyCli::Context
+
+    ##
+    # Returns the name of the JS package manager being used
+    #
+    # #### Example
+    #
+    #   ShopifyCli::JsSystem.new(ctx: ctx).package_manager
+    #
+    def package_manager
+      yarn? ? YARN_CORE_COMMAND : NPM_CORE_COMMAND
+    end
+
+    ##
+    # Returns true if yarn is available and false otherwise
+    #
+    # #### Example
+    #
+    #   ShopifyCli::JsSystem.new(ctx: ctx).yarn?
+    #
+    def yarn?
+      @has_yarn ||= begin
+        _, status = CLI::Kit::System.capture2('which', 'yarn')
+        File.exist?(File.join(ctx.root, 'yarn.lock')) && status.success?
+      end
+    end
+
+    ##
+    # Runs a command with the proper JS package manager depending on the result of `yarn?`
+    #
+    # #### Parameters
+    # - `ctx`: running context from your command
+    # - `yarn`: The proc, array, or string command to run if yarn is available
+    # - `npm`: The proc, array, or string command to run if npm is available
+    #
+    # #### Example
+    #
+    #   ShopifyCli::JsSystem.new(ctx: ctx).call(yarn: ['install', '--silent'], npm: ['install', '--no-audit'])
+    #
+    def call(yarn:, npm:)
+      yarn? ? call_command(yarn, YARN_CORE_COMMAND) : call_command(npm, NPM_CORE_COMMAND)
+    end
+
+    private
+
+    def call_command(command, core_command)
+      if command.is_a?(String) || command.is_a?(Array)
+        CLI::Kit::System.system(core_command, *command, chdir: ctx.root).success?
+      else
+        command.call
+      end
+    end
+  end
+end

data/lib/shopify-cli/messages/messages.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+module ShopifyCli
+  module Messages
+    MESSAGES = {
+      core: {
+        connect: {
+          help: <<~HELP,
+          Connect (or re-connect) an existing project to a Shopify partner organization and/or a store. Creates or updates the {{green:.env}} file, and creates the {{green:.shopify-cli.yml}} file.
+            Usage: {{command:%s connect}}
+          HELP
+
+          production_warning: <<~MESSAGE,
+          {{yellow:! Warning: if you have connected to an {{bold:app in production}}, running {{command:serve}} may update the app URL and cause an outage.
+          MESSAGE
+          already_connected_warning: "{{yellow:! This app appears to be already connected}}",
+          connected: "{{v}} Project now connected to {{green:%s}}",
+          project_type_select: "What type of project would you like to connect?",
+          organization_select: "To which partner organization does this project belong?",
+          app_select: "To which app does this project belong?",
+          no_development_stores: <<~MESSAGE,
+          No development stores available.
+          Visit {{underline:https://partners.shopify.com/%d/stores}} to create one
+          MESSAGE
+          development_store_select: "Which development store would you like to use?",
+          cli_yml_saved: ".shopify-cli.yml saved to project root",
+        },
+
+        context: {
+          open_url: <<~OPEN,
+          Please open this URL in your browser:
+          {{green:%s}}
+          OPEN
+        },
+
+        create: {
+          help: <<~HELP,
+          Create a new project.
+            Usage: {{command:%s create [ %s ]}}
+          HELP
+
+          error: {
+            invalid_app_type: "{{red:Error}}: invalid app type {{bold:%s}}",
+          },
+
+          project_type_select: "What type of project would you like to create?",
+        },
+
+        env_file: {
+          saving_header: "writing %s file...",
+          saving: "writing %s file",
+          saved: "%s saved to project root",
+        },
+
+        git: {
+          error: {
+            directory_exists: "Project directory already exists. Please create a project with a new name.",
+            no_branches_found: "Could not find any git branches",
+            repo_not_initiated: "Git repo is not initiated. Please run `git init` and make at least one commit.",
+            no_commits_made: "No git commits have been made. Please make at least one commit.",
+          },
+
+          cloning: "Cloning into %s...",
+          cloned: "Cloned into %s",
+        },
+
+        help: {
+          error: {
+            command_not_found: "Command %s not found.",
+          },
+
+          preamble: <<~MESSAGE,
+          Use {{command:%s help <command>}} to display detailed information about a specific command.
+
+          {{bold:Available core commands:}}
+
+          MESSAGE
+        },
+
+        heroku: {
+          error: {
+            authentication: "Could not authenticate with Heroku",
+            creation: "Heroku app could not be created",
+            deploy: "Could not deploy to Heroku",
+            download: "Heroku CLI could not be downloaded",
+            install: "Could not install Heroku CLI",
+            could_not_select_app: "Heroku app `%s` could not be selected",
+          },
+        },
+
+        js_deps: {
+          error: {
+            missing_package: "expected to have a file at: %s",
+            invalid_package: "{{info:%s}} was not valid JSON. Fix this then try again",
+            install_spinner_error: "Unable to install all %d dependencies",
+            install_error: 'An error occurred while installing dependencies',
+          },
+
+          installing: "Installing dependencies with %s...",
+          installed: "Dependencies installed",
+          npm_installing_deps: "Installing %d dependencies...",
+          npm_installed_deps: "%d npm dependencies installed",
+        },
+
+        logout: {
+          help: <<~HELP,
+          Log out of a currently authenticated partner organization and store, or clear invalid credentials
+            Usage: {{command:%s logout}}
+          HELP
+
+          success: "Logged out of partner organization and store",
+        },
+
+        monorail: {
+          consent_prompt: <<~MSG,
+            Would you like to enable anonymous usage reporting?
+            If you select “Yes”, we’ll collect data about which commands you use and which errors you encounter.
+            Sharing this anonymous data helps Shopify improve this tool.
+          MSG
+        },
+
+        oauth: {
+          error: {
+            timeout: "Timed out while waiting for response from Shopify",
+          },
+
+          location: {
+            admin: "development store",
+            partner: "Shopify Partners account",
+          },
+          authentication_required:
+            "{{i}} Authentication required. Login to the URL below with your %s credentials to continue.",
+
+          servlet: {
+            success_response: "Authenticated successfully. You may now close this page.",
+            invalid_request_response: "Invalid request: %s",
+            invalid_state_response: "Anti-forgery state token does not match the initial request.",
+            authenticated: "Authenticated successfully",
+            not_authenticated: "Failed to authenticate",
+          },
+        },
+
+        options: {
+          help_text: "Print help for command",
+        },
+
+        partners_api: {
+          org_name_and_id: "%s (%s)",
+          error: {
+            account_not_found: <<~MESSAGE,
+            {{x}} error: Your account was not found. Please sign up at https://partners.shopify.com/signup
+            For authentication issues, run {{command:%s logout}} to clear invalid credentials
+            MESSAGE
+          },
+        },
+
+        populate: {
+          options: {
+            header: "{{bold:{{cyan:%s}} options:}}",
+            count_help: "Number of resources to generate",
+          },
+          populating: "Populating %d %ss...",
+          completion_message: <<~COMPLETION_MESSAGE,
+          Successfully added %d %s to {{green:%s}}
+          {{*}} View all %ss at {{underline:%s%ss}}
+          COMPLETION_MESSAGE
+        },
+
+        project: {
+          error: {
+            not_in_project: <<~MESSAGE,
+            {{x}} You are not in a Shopify app project
+            {{yellow:{{*}}}}{{reset: Run}}{{cyan: shopify create}}{{reset: to create your app}}
+            MESSAGE
+            cli_yaml: {
+              not_hash: "{{x}} .shopify-cli.yml was not a proper YAML file. Expecting a hash.",
+              invalid: "{{x}} %s contains invalid YAML: %s",
+              not_found: "{{x}} %s not found",
+            },
+          },
+        },
+
+        project_type: {
+          error: {
+            cannot_override_core: "Can't register duplicate core command '%s' from %s",
+          },
+        },
+
+        system: {
+          help: <<~HELP,
+          Print details about the development system.
+            Usage: {{command:%s system [all]}}
+
+          {{cyan:all}}: displays more details about development system and environment
+
+          HELP
+
+          error: {
+            unknown_option: "{{x}} {{red:unknown option '%s'}}",
+          },
+
+          header: "{{bold:Shopify App CLI}}",
+          const: "%17s = %s",
+          ruby_header: <<~RUBY_MESSAGE,
+          {{bold:Ruby (via RbConfig)}}
+            %s
+          RUBY_MESSAGE
+          rb_config: "%-25s - RbConfig[\"%s\"]",
+          command_header: "{{bold:Commands}}",
+          command_with_path: "{{v}} %s, %s",
+          command_not_found: "{{x}} %s",
+          ngrok_available: "{{v}} ngrok, %s",
+          ngrok_not_available: "{{x}} ngrok NOT available",
+          project: {
+            header: "{{bold:In a {{cyan:%s}} project directory}}",
+            command_with_path: "{{v}} %s, %s, version %s",
+            command_not_found: "{{x}} %s",
+            env_header: "{{bold:Project environment}}",
+            env_not_set: "not set",
+            env: "%-18s = %s",
+            no_env: "{{x}} .env file not present",
+          },
+          environment_header: "{{bold:Environment}}",
+          env: "%-17s = %s",
+        },
+
+        tasks: {
+          ensure_env: {
+            api_key_question: "What is your Shopify API key?",
+            api_secret_key_question: "What is your Shopify API secret key?",
+            development_store_question: "What is your development store URL? (Example: my-dev-store.myshopify.com)",
+          },
+          ensure_dev_store: {
+            could_not_verify_store: "Couldn't verify your store %s",
+            convert_to_dev_store: <<~MESSAGE,
+              Do you want to convert %s to a development store?
+              Doing this will allow you to install your app, but the store will become {{bold:transfer-disabled}}.
+              Learn more: https://shopify.dev/tutorials/transfer-a-development-store-to-a-merchant#transfer-disabled-stores
+              MESSAGE
+            transfer_disabled: "{{v}} Transfer has been disabled on %s.",
+          },
+          update_dashboard_urls: {
+            updated: "{{v}} Whitelist URLS updated in Partners Dashboard}}",
+            update_error:
+              "{{x}} error: For authentication issues, run {{command:%s logout}} to clear invalid credentials",
+            update_prompt: "Do you want to update your application url?",
+          },
+        },
+
+        tunnel: {
+          error: {
+            stop: "ngrok tunnel could not be stopped. Try running {{command:killall -9 ngrok}}",
+            url_fetch_failure: "Unable to fetch external url",
+          },
+
+          stopped: "{{green:x}} ngrok tunnel stopped",
+          not_running: "{{green:x}} ngrok tunnel not running",
+          start_with_account: "{{v}} ngrok tunnel running at {{underline:%s}}, with account %s",
+          start: "{{v}} ngrok tunnel running at {{underline:%s}}",
+        },
+
+        version: {
+          help: <<~HELP,
+          Prints version number.
+            Usage: {{command:%s version}}
+          HELP
+        },
+
+        warning: {
+          development_version: <<~DEVELOPMENT,
+          {{*}} {{yellow:You are running a development version of the CLI at:}}
+              {{yellow:%s}}
+
+          DEVELOPMENT
+
+          shell_shim: <<~MESSAGE,
+          {{x}} 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:
+            {{underline:https://shopify.github.io/shopify-app-cli/migrate/}}
+
+          MESSAGE
+        },
+      },
+    }.freeze
+  end
+end