shopify-cli 1.0.1 → 1.1.0

data/lib/shopify-cli/commands.rb

@@ -18,6 +18,7 @@ module ShopifyCli
       @core_commands.include?(cmd)
     end
 
+    register :Config, 'config', 'shopify-cli/commands/config', true
     register :Connect, 'connect', 'shopify-cli/commands/connect', true
     register :Create, 'create', 'shopify-cli/commands/create', true
     register :Help, 'help', 'shopify-cli/commands/help', true

data/lib/shopify-cli/commands/config.rb

@@ -0,0 +1,44 @@
+require 'shopify_cli'
+
+module ShopifyCli
+  module Commands
+    class Config < ShopifyCli::Command
+      hidden_feature(feature_set: :debug)
+
+      subcommand :Feature, 'feature'
+
+      def call(*)
+        @ctx.puts(self.class.help)
+      end
+
+      def self.help
+        ShopifyCli::Context.message('core.config.help', ShopifyCli::TOOL_NAME)
+      end
+
+      class Feature < ShopifyCli::SubCommand
+        options do |parser, flags|
+          parser.on('--enable') { flags[:action] = 'enable' }
+          parser.on('--disable') { flags[:action] = 'disable' }
+          parser.on('--status') { flags[:action] = 'status' }
+        end
+
+        def call(args, _name)
+          feature_name = args.shift
+          return @ctx.puts(@ctx.message('core.config.help', ShopifyCli::TOOL_NAME)) if feature_name.nil?
+          is_enabled = ShopifyCli::Feature.enabled?(feature_name)
+          if options.flags[:action] == 'disable' && is_enabled
+            ShopifyCli::Feature.disable(feature_name)
+            @ctx.puts(@ctx.message('core.config.feature.disabled', is_enabled))
+          elsif options.flags[:action] == 'enable' && !is_enabled
+            ShopifyCli::Feature.enable(feature_name)
+            @ctx.puts(@ctx.message('core.config.feature.enabled', feature_name))
+          elsif is_enabled
+            @ctx.puts(@ctx.message('core.config.feature.is_enabled', feature_name))
+          else
+            @ctx.puts(@ctx.message('core.config.feature.is_disabled', feature_name))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shopify-cli/commands/connect.rb

@@ -6,27 +6,20 @@ module ShopifyCli
       def call(*)
         project_type = ask_project_type unless Project.has_current?
 
-        if Project.has_current? && Project.current
+        if Project.has_current? && Project.current && Project.current.env
           @ctx.puts @ctx.message('core.connect.already_connected_warning')
           prod_warning = @ctx.message('core.connect.production_warning')
           @ctx.puts prod_warning if [:rails, :node].include?(Project.current_project_type)
         end
 
-        env_data = begin
-          Resources::EnvFile.parse_external_env
-                   rescue Errno::ENOENT
-                     {}
-        end
-
-        org = fetch_org
-        id = org['id']
-        app = get_app(org['apps'])
-        shop = get_shop(org['stores'], id)
-
-        write_env(app, shop, env_data[:scopes], env_data[:extra])
-        write_cli_yml(project_type, id) unless Project.has_current?
+        org = ShopifyCli::Tasks::EnsureEnv.call(@ctx, regenerate: true)
+        write_cli_yml(project_type, org['id']) unless Project.has_current?
+        api_key = Project.current(force_reload: true).env['api_key']
+        @ctx.puts(@ctx.message('core.connect.connected', get_app(org['apps'], api_key).first["title"]))
+      end
 
-        @ctx.puts(@ctx.message('core.connect.connected', app.first['title']))
+      def get_app(apps, api_key)
+        apps.select { |app| app["apiKey"] == api_key }
       end
 
       def ask_project_type
@@ -37,60 +30,6 @@ module ShopifyCli
         end
       end
 
-      def fetch_org
-        orgs = PartnersAPI::Organizations.fetch_with_app(@ctx)
-        org_id = if orgs.count == 1
-          orgs.first["id"]
-        else
-          CLI::UI::Prompt.ask(@ctx.message('core.connect.organization_select')) do |handler|
-            orgs.each do |org|
-              handler.option(
-                ctx.message('core.partners_api.org_name_and_id', org['businessName'], org['id'])
-              ) { org["id"] }
-            end
-          end
-        end
-        org = orgs.find { |o| o["id"] == org_id }
-        org
-      end
-
-      def get_app(apps)
-        app_id = if apps.count == 1
-          apps.first["id"]
-        else
-          CLI::UI::Prompt.ask(@ctx.message('core.connect.app_select')) do |handler|
-            apps.each { |app| handler.option(app["title"]) { app["id"] } }
-          end
-        end
-        apps.select { |app| app["id"] == app_id }
-      end
-
-      def get_shop(shops, id)
-        if shops.count == 1
-          shop = shops.first["shopDomain"]
-        elsif shops.count == 0
-          @ctx.puts(@ctx.message('core.connect.no_development_stores', id))
-        else
-          shop = CLI::UI::Prompt.ask(@ctx.message('core.connect.development_store_select')) do |handler|
-            shops.each { |s| handler.option(s["shopName"]) { s["shopDomain"] } }
-          end
-        end
-        shop
-      end
-
-      def write_env(app, shop, scopes, extra)
-        scopes = 'write_products,write_customers,write_draft_orders' if scopes.nil?
-        extra = {} if extra.nil?
-
-        Resources::EnvFile.new(
-          api_key: app.first["apiKey"],
-          secret: app.first["apiSecretKeys"].first["secret"],
-          shop: shop,
-          scopes: scopes,
-          extra: extra,
-        ).write(@ctx)
-      end
-
       def write_cli_yml(project_type, org_id)
         ShopifyCli::Project.write(
           @ctx,

data/lib/shopify-cli/commands/create.rb

@@ -28,11 +28,11 @@ module ShopifyCli
       def self.all_visible_type
         ProjectType
           .load_all
-          .select { |type| !type.hidden }
+          .select { |type| !type.hidden? }
       end
 
       def self.help
-        project_types = all_visible_type.map(&:project_type).join(" | ")
+        project_types = all_visible_type.map(&:project_type).sort.join(" | ")
         ShopifyCli::Context.message('core.create.help', ShopifyCli::TOOL_NAME, project_types)
       end
 

data/lib/shopify-cli/commands/help.rb

@@ -47,7 +47,7 @@ module ShopifyCli
 
       def core_commands
         resolved_commands
-          .select { |_name, c| !c.hidden }
+          .select { |_name, c| !c.hidden? }
           .select { |name, _c| Commands.core_command?(name) }
       end
 

data/lib/shopify-cli/commands/system.rb

@@ -4,7 +4,7 @@ require 'rbconfig'
 module ShopifyCli
   module Commands
     class System < ShopifyCli::Command
-      hidden_command
+      hidden_feature(feature_set: :debug)
 
       def call(args, _name)
         show_all_details = false
@@ -36,11 +36,13 @@ module ShopifyCli
         cli_constants_extra = %w(
           PROJECT_TYPES_DIR
           TEMP_DIR
-          CACHE_DIR
-          TOOL_CONFIG_PATH
-          LOG_FILE
-          DEBUG_LOG_FILE
         )
+        cli_path_methods = [
+          :cache_dir,
+          :tool_config_path,
+          :log_file,
+          :debug_log_file,
+        ]
 
         cli_constants += cli_constants_extra if show_all_details
 
@@ -48,6 +50,12 @@ module ShopifyCli
         cli_constants.each do |s|
           @ctx.puts("  " + @ctx.message('core.system.const', s, ShopifyCli.const_get(s.to_sym)) + "\n")
         end
+
+        if show_all_details
+          cli_path_methods.each do |m|
+            @ctx.puts("  " + @ctx.message('core.system.const', m.upcase, ShopifyCli.send(m)) + "\n")
+          end
+        end
       end
 
       def display_cli_ruby(_show_all_details)
@@ -60,13 +68,14 @@ module ShopifyCli
       end
 
       def display_utility_commands(_show_all_details)
-        commands = %w(git curl tar unzip)
+        commands = %w(git curl tar)
 
         @ctx.puts("\n" + @ctx.message('core.system.command_header'))
         commands.each do |s|
-          output, status = @ctx.capture2e('which', s)
-          if status.success?
-            @ctx.puts("  " + @ctx.message('core.system.command_with_path', s, output))
+          cmd_path = @ctx.which(s)
+
+          if !cmd_path.nil?
+            @ctx.puts("  " + @ctx.message('core.system.command_with_path', s, cmd_path))
           else
             @ctx.puts("  " + @ctx.message('core.system.command_not_found', s))
           end
@@ -74,7 +83,7 @@ module ShopifyCli
       end
 
       def display_ngrok
-        ngrok_location = File.join(ShopifyCli::CACHE_DIR, 'ngrok')
+        ngrok_location = File.join(ShopifyCli.cache_dir, @ctx.windows? ? 'ngrok.exe' : 'ngrok')
         if File.exist?(ngrok_location)
           @ctx.puts("  " + @ctx.message('core.system.ngrok_available', ngrok_location))
         else
@@ -94,11 +103,11 @@ module ShopifyCli
       def display_project(project_type, commands)
         @ctx.puts("\n" + @ctx.message('core.system.project.header', project_type))
         commands.each do |s|
-          output, status = @ctx.capture2e('which', s)
-          if status.success?
+          cmd_path = @ctx.which(s)
+          if !cmd_path.nil?
             version_output, _ = @ctx.capture2e(s, '--version')
             version = version_output.match(/(\d+\.[^\s]+)/)[0]
-            @ctx.puts("  " + @ctx.message('core.system.project.command_with_path', s, output.strip, version.strip))
+            @ctx.puts("  " + @ctx.message('core.system.project.command_with_path', s, cmd_path.strip, version.strip))
           else
             @ctx.puts("  " + @ctx.message('core.system.project.command_not_found', s))
           end

data/lib/shopify-cli/context.rb

@@ -56,6 +56,7 @@ module ShopifyCli
       host = uname
       return :mac if /darwin/.match(host)
       return :linux if /linux/.match(host)
+      return :windows if /mingw32/.match(host)
     end
 
     # will return true if the cli is running on an apple computer.
@@ -68,6 +69,11 @@ module ShopifyCli
       os == :linux
     end
 
+    # will return true if the cli is running on Windows
+    def windows?
+      os == :windows
+    end
+
     # will return true if the cli is being run from an installation, and not a
     # development instance. The gem installation will not have a 'test' directory.
     # See `#development?` for checking for development environment.
@@ -146,10 +152,19 @@ module ShopifyCli
     # #### Parameters
     # * `path` - the file path to a directory, relative to the context root to remove from the FS
     #
-    def exist?(path)
+    def dir_exist?(path)
       Dir.exist?(ctx_path(path))
     end
 
+    # checks if a file exists, the filepath is relative to the command root unless absolute
+    #
+    # #### Parameters
+    # * `path` - the file path to a file, relative to the context root to remove from the FS
+    #
+    def file_exist?(path)
+      File.exist?(ctx_path(path))
+    end
+
     # will recursively copy a directory from the FS, the filepath is relative to the command
     # root unless absolute
     #
@@ -409,6 +424,28 @@ module ShopifyCli
       end
     end
 
+    # Checks if the given command exists in the system
+    #
+    # #### Parameters
+    # - `cmd`: The command to test
+    #
+    # #### Returns
+    # The path of the executable if it is found
+    #
+    # @todo This is currently a duplicate of CLI::Kit::System.which() - we should make that method public when we make
+    #       Kit changes and make this a wrapper instead.
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(File.expand_path(path), "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+
+      nil
+    end
+
     private
 
     def ctx_path(fname)

data/lib/shopify-cli/core.rb

@@ -4,6 +4,5 @@ module ShopifyCli
     autoload :Executor, 'shopify-cli/core/executor'
     autoload :HelpResolver, 'shopify-cli/core/help_resolver'
     autoload :Monorail, 'shopify-cli/core/monorail'
-    autoload :Update, 'shopify-cli/core/update'
   end
 end

data/lib/shopify-cli/core/entry_point.rb

@@ -35,7 +35,7 @@ module ShopifyCli
           task_registry = ShopifyCli::Tasks::Registry
 
           command, command_name, args = ShopifyCli::Resolver.call(args)
-          executor = ShopifyCli::Core::Executor.new(ctx, task_registry, log_file: ShopifyCli::LOG_FILE)
+          executor = ShopifyCli::Core::Executor.new(ctx, task_registry, log_file: ShopifyCli.log_file)
           ShopifyCli::Core::Monorail.log(command_name, args) do
             executor.call(command, command_name, args)
           end

data/lib/shopify-cli/core/executor.rb

@@ -3,16 +3,14 @@ require 'shopify_cli'
 module ShopifyCli
   module Core
     class Executor < CLI::Kit::Executor
-      def initialize(ctx, task_registry, *args)
+      def initialize(ctx, task_registry, *args, **kwargs)
         @ctx = ctx || ShopifyCli::Context.new
         @task_registry = task_registry || ShopifyCli::Tasks::TaskRegistry.new
-        super(*args)
+        super(*args, **kwargs)
       end
 
       def call(command, command_name, args)
-        command.prerequisite_tasks.each do |task, _|
-          @task_registry[task]&.call(@ctx)
-        end
+        command.task_registry = @task_registry
         command.ctx = @ctx
         super
       end

data/lib/shopify-cli/core/monorail.rb

@@ -99,7 +99,7 @@ module ShopifyCli
               success: err.nil?,
               error_message: err,
               uname: RbConfig::CONFIG["host"],
-              cli_version: ShopifyCli::Git.sha(dir: ShopifyCli::ROOT),
+              cli_version: ShopifyCli::VERSION,
               ruby_version: RUBY_VERSION,
             }.tap do |payload|
               payload[:metadata] = JSON.dump(metadata) unless metadata.empty?

data/lib/shopify-cli/db.rb

@@ -14,7 +14,7 @@ module ShopifyCli
 
     attr_reader :db # :nodoc:
 
-    def initialize(path: File.join(ShopifyCli::CACHE_DIR, ".db.pstore")) # :nodoc:
+    def initialize(path: File.join(ShopifyCli.cache_dir, ".db.pstore")) # :nodoc:
       @db = PStore.new(path)
     end
 

data/lib/shopify-cli/feature.rb

@@ -0,0 +1,97 @@
+module ShopifyCli
+  ##
+  # ShopifyCli::Feature contains the logic to hide and show features across the CLI
+  # These features can be either commands or project types currently.
+  #
+  # Feature flags will persist between runs so if the flag is enabled or disabled,
+  # it will still be in that same state on the next cli invocation.
+  class Feature
+    SECTION = 'features'
+
+    ##
+    # ShopifyCli::Feature::Set is included on commands and projects to allow you to hide
+    # and enable projects and commands based on feature flags.
+    module Set
+      ##
+      # will hide a feature, either a project_type or a command
+      #
+      # #### Parameters
+      #
+      # * `feature_set` - either a single, or array of symbols that represent feature sets
+      #
+      # #### Example
+      #
+      #    module ShopifyCli
+      #      module Commands
+      #        class Config < ShopifyCli::Command
+      #          hidden_feature(feature_set: :basic)
+      #          ....
+      #
+      def hidden_feature(feature_set: [])
+        @feature_hidden = true
+        @hidden_feature_set = Array(feature_set).compact
+      end
+
+      ##
+      # will return if the feature has been hidden or not
+      #
+      # #### Returns
+      #
+      # * `is_hidden` - returns true if the feature has been hidden and false otherwise
+      #
+      # #### Example
+      #
+      #     ShopifyCli::Commands::Config.hidden?
+      #
+      def hidden?
+        enabled = (@hidden_feature_set || []).any? do |feature|
+          Feature.enabled?(feature)
+        end
+        @feature_hidden && !enabled
+      end
+    end
+
+    class << self
+      ##
+      # will enable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be enabled
+      def enable(feature)
+        set(feature, true)
+      end
+
+      ##
+      # will disable a feature in the CLI.
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing the flag to be disabled
+      def disable(feature)
+        set(feature, false)
+      end
+
+      ##
+      # will check if the feature has been enabled
+      #
+      # #### Parameters
+      #
+      # * `feature` - a symbol representing a flag that the status should be requested
+      #
+      # #### Returns
+      #
+      # * `is_enabled` - will be true if the feature has been enabled.
+      def enabled?(feature)
+        return false if feature.nil?
+        ShopifyCli::Config.get_bool(SECTION, feature.to_s)
+      end
+
+      private
+
+      def set(feature, value)
+        ShopifyCli::Config.set(SECTION, feature.to_s, value)
+      end
+    end
+  end
+end