shopify-cli 1.0.5 → 1.1.0

data/vendor/gen/lib/gen/entry_point.rb

@@ -0,0 +1,10 @@
+require 'gen'
+
+module Gen
+  module EntryPoint
+    def self.call(args)
+      cmd, command_name, args = Gen::Resolver.call(args)
+      Gen::Executor.call(cmd, command_name, args)
+    end
+  end
+end

data/vendor/gen/lib/gen/generator.rb

@@ -0,0 +1,165 @@
+require 'gen'
+require 'fileutils'
+require 'open3'
+require 'pathname'
+require 'tmpdir'
+
+module Gen
+  class Generator
+    def self.run(project_name)
+      new(project_name).run
+    end
+
+    TEMPLATE_ROOT = File.expand_path('gen/template', Gen::ROOT)
+
+    VALID_PROJECT_NAME = /\A[a-z][a-z0-9]*\z/
+    private_constant :VALID_PROJECT_NAME
+
+    # false  -> delete file
+    # string -> rename file before applying template substitutions
+    VENDOR_TRANSLATIONS = {
+      'Gemfile' => false,
+      'exe/__app__-gems' => false,
+      'exe/__app__-vendor' => 'exe/__app__',
+      'dev-gems.yml' => false,
+      'dev-vendor.yml' => 'dev.yml',
+    }.freeze
+    private_constant :VENDOR_TRANSLATIONS
+
+    BUNDLER_TRANSLATIONS = {
+      'bin/update-deps' => false,
+      'exe/__app__-gems' => 'exe/__app__',
+      'exe/__app__-vendor' => false,
+      'dev-gems.yml' => 'dev.yml',
+      'dev-vendor.yml' => false,
+    }.freeze
+    private_constant :BUNDLER_TRANSLATIONS
+
+    def initialize(project_name)
+      raise(
+        CLI::Kit::Abort,
+        "project name must match {{bold:#{VALID_PROJECT_NAME}}} (but can be changed later)"
+      ) unless project_name =~ VALID_PROJECT_NAME
+      @project_name = project_name
+      @title_case_project_name = @project_name.sub(/^./, &:upcase)
+    end
+
+    def run
+      vendor = ask_vendor?
+      create_project_dir
+      if vendor
+        copy_files(translations: VENDOR_TRANSLATIONS)
+        update_deps
+      else
+        copy_files(translations: BUNDLER_TRANSLATIONS)
+      end
+    end
+
+    private
+
+    def ask_vendor?
+      return 'vendor' if ENV['DEPS'] == 'vendor'
+      return 'bundler' if ENV['DEPS'] == 'bundler'
+
+      vendor = nil
+      CLI::UI::Frame.open('Configuration') do
+        q = 'How would you like the application to consume {{command:cli-kit}} and {{command:cli-ui}}?'
+        vendor = CLI::UI::Prompt.ask(q) do |c|
+          c.option('Vendor  {{italic:(faster execution, more difficult to update deps)}}') { 'vendor' }
+          c.option('Bundler {{italic:(slower execution, easier dep management)}}') { 'bundler' }
+        end
+      end
+      vendor == 'vendor'
+    end
+
+    def create_project_dir
+      info(create: '')
+      FileUtils.mkdir(@project_name)
+    rescue Errno::EEXIST
+      error("directory already exists: #{@project_name}")
+    end
+
+    def copy_files(translations:)
+      each_template_file do |source_name|
+        target_name = translations.fetch(source_name, source_name)
+        next if target_name == false
+        target_name = apply_template_variables(target_name)
+
+        source = File.join(TEMPLATE_ROOT, source_name)
+        target = File.join(@project_name, target_name)
+
+        info(create: target_name)
+
+        if Dir.exist?(source)
+          FileUtils.mkdir(target)
+        else
+          content = apply_template_variables(File.read(source))
+          File.write(target, content)
+        end
+        File.chmod(File.stat(source).mode, target)
+      end
+    end
+
+    def update_deps
+      Dir.mktmpdir do |tmp|
+        clone(tmp, 'cli-ui')
+        clone(tmp, 'cli-kit')
+        info(run: 'bin/update-deps')
+        Dir.chdir(@project_name) do
+          system({ 'SOURCE_ROOT' => tmp }, 'bin/update-deps')
+        end
+      end
+    end
+
+    def clone(dir, repo)
+      info(clone: repo)
+      out, stat = Open3.capture2e('git', '-C', dir, 'clone', "https://github.com/shopify/#{repo}")
+      unless stat.success?
+        STDERR.puts(out)
+        error("git clone failed")
+      end
+    end
+
+    def each_template_file
+      return enum_for(:each_template_file) unless block_given?
+
+      root = Pathname.new(TEMPLATE_ROOT)
+      Dir.glob("#{TEMPLATE_ROOT}/**/*").each do |f|
+        el = Pathname.new(f)
+        yield(el.relative_path_from(root).to_s)
+      end
+    end
+
+    def apply_template_variables(s)
+      s
+        .gsub(/__app__/, @project_name)
+        .gsub(/__App__/, @title_case_project_name)
+        .gsub(/__cli-kit-version__/, cli_kit_version)
+        .gsub(/__cli-ui-version__/, cli_ui_version)
+    end
+
+    def cli_kit_version
+      require 'cli/kit/version'
+      CLI::Kit::VERSION.to_s
+    end
+
+    def cli_ui_version
+      require 'cli/ui/version'
+      CLI::UI::VERSION.to_s
+    end
+
+    def info(create: nil, clone: nil, run: nil)
+      if clone
+        puts(CLI::UI.fmt("\t{{bold:{{yellow:clone}}\t#{clone}}}"))
+      elsif create
+        puts(CLI::UI.fmt("\t{{bold:{{blue:create}}\t#{create}}}"))
+      elsif run
+        puts(CLI::UI.fmt("\t{{bold:{{green:run}}\t#{run}}}"))
+      end
+    end
+
+    def error(msg)
+      raise(CLI::Kit::Abort, msg)
+    end
+  end
+end

data/vendor/gen/template/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/.bundle

data/vendor/gen/template/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'cli-kit', '~> __cli-kit-version__'
+gem 'cli-ui', '~> __cli-ui-version__'
+
+group :test do
+  gem 'mocha', '~> 1.5.0', require: false
+  gem 'minitest', '>= 5.0.0', require: false
+  gem 'minitest-reporters', require: false
+end

data/vendor/gen/template/README.md

@@ -0,0 +1 @@
+# __app__

data/vendor/gen/template/bin/testunit

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+root = File.expand_path('../..', __FILE__)
+TEST_ROOT = root + '/test'
+
+$LOAD_PATH.unshift(TEST_ROOT)
+
+def test_files
+  Dir.glob(TEST_ROOT + "/**/*_test.rb")
+end
+
+if ARGV.empty?
+  test_files.each { |f| require(f) }
+  exit 0
+end
+
+# A list of files is presumed to be specified
+ARGV.each do |a|
+  require a.sub(%r{^test/}, '')
+end

data/vendor/gen/template/bin/update-deps

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../../vendor/deps/cli-ui/lib", __FILE__))
+require 'open3'
+require 'fileutils'
+
+def fmt(tag, msg)
+  # Not really CLI::UI.fmt compatible: no nesting support, for example.
+  # While we could pull in CLI::UI here, it makes it more difficult to
+  # bootstrap a new project and to fix a broken vendor.
+  fmt_msg = msg
+    .gsub(/{{yellow:(.*?)}}/,     "\x1b[33m\\1\x1b[31m")
+    .gsub(/{{green:(.*?)}}/,      "\x1b[32m\\1\x1b[31m")
+    .gsub(/{{blue:(.*?)}}/,       "\x1b[34m\\1\x1b[31m")
+    .gsub(/{{bold_blue:(.*?)}}/,  "\x1b[1;34m\\1\x1b[0;31m")
+    .gsub(/{{bold_green:(.*?)}}/, "\x1b[1;32m\\1\x1b[0;31m")
+  "\x1b[1;31m[#{tag}] \x1b[0;31m#{fmt_msg}\x1b[0m"
+end
+
+def bail(msg)
+  STDERR.puts(fmt("ERROR", msg))
+  exit(1)
+end
+
+def warn(msg)
+  STDERR.puts(fmt("WARNING", msg))
+end
+
+def source_path
+  File.expand_path(ENV.fetch('SOURCE_ROOT', File.expand_path('../../..', __FILE__)))
+end
+
+deps = %w(cli-ui cli-kit)
+
+deps.each do |dep|
+  path = File.expand_path(dep, source_path)
+
+  unless Dir.exist?(path)
+    bail(
+      "dependency is not checked out: {{yellow:#{dep}}}.\n" \
+      "  This repo {{bold_blue:(github.com/shopify/#{dep})}} must be cloned at" \
+      " {{bold_blue:#{path}}} for this script to succeed.\n" \
+      "  Currently, SOURCE_ROOT is set to {{bold_blue:#{source_path}}}.\n" \
+      "  Alternatively, you can set {{bold_blue:SOURCE_ROOT}} to a directory containing {{yellow:#{dep}}}.\n" \
+      "  {{bold_blue:SOURCE_ROOT}} defaults to {{bold_blue:../}}."
+    )
+  end
+
+  head_sha = nil
+  dirty = false
+
+  Dir.chdir(path) do
+    _, _, stat = Open3.capture3('git fetch origin master')
+    bail("couldn't git fetch in dependency: {{yellow:#{dep}}}") unless stat.success?
+
+    head_sha, stat = Open3.capture2('git rev-parse HEAD')
+    bail("couldn't determine HEAD: {{yellow:#{dep}}}") unless stat.success?
+    head_sha.chomp!
+
+    fetch_head_sha, stat = Open3.capture2('git rev-parse FETCH_HEAD')
+    bail("couldn't determine FETCH_HEAD: {{yellow:#{dep}}}") unless stat.success?
+    fetch_head_sha.chomp!
+
+    git_status, stat = Open3.capture2('git status --porcelain')
+    bail("couldn't determine git status: {{yellow:#{dep}}}") unless stat.success?
+
+    if head_sha != fetch_head_sha
+      warn(
+        "Copying files from {{yellow:#{path}}} to satisfy dependency {{yellow:#{dep}}}.\n" \
+        "  However, the repo at {{yellow:#{path}}} isn't up to date.\n" \
+        "  The checked-out revision is {{yellow:#{head_sha[0..8]}}}, and "\
+        "{{yellow:origin/master}} is {{yellow:#{fetch_head_sha[0..8]}}}.\n" \
+        "  Unless you know what you're doing, you should {{green:cd}} to that" \
+        " repo and {{green:git pull}}, then run this again."
+      )
+    end
+
+    unless git_status.chomp.empty?
+      dirty = true
+      warn("importing uncommitted changes from dependency: {{yellow:#{dep}}}")
+    end
+  end
+
+  depdir = File.expand_path("../../vendor/deps/#{dep}", __FILE__)
+  FileUtils.rm_rf(depdir)
+  FileUtils.mkdir_p(depdir)
+  dstlib = File.expand_path('lib', depdir)
+  srclib = File.expand_path('lib', path)
+
+  FileUtils.cp_r(srclib, dstlib)
+
+  rev = head_sha
+  rev << " (dirty)" if dirty
+  rev << "\n"
+
+  File.write("#{depdir}/REVISION", rev)
+end

data/vendor/gen/template/dev-gems.yml

@@ -0,0 +1,3 @@
+up:
+  - ruby: 2.5.0
+  - bundler

data/vendor/gen/template/dev-vendor.yml

@@ -0,0 +1,4 @@
+up:
+  - ruby: 2.5.0
+
+build: bin/update-deps

data/vendor/gen/template/exe/__app__-gems

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+unshift_path = ->(path) {
+  p = File.expand_path("../../#{path}", __FILE__)
+  $LOAD_PATH.unshift(p) unless $LOAD_PATH.include?(p)
+}
+unshift_path.call('lib')
+
+require 'bundler/setup'
+require '__app__'
+
+exit(__App__::ErrorHandler.call do
+  __App__::EntryPoint.call(ARGV.dup)
+end)

data/vendor/gen/template/exe/__app__-vendor

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby --disable-gems
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+unshift_path = ->(path) {
+  p = File.expand_path("../../#{path}", __FILE__)
+  $LOAD_PATH.unshift(p) unless $LOAD_PATH.include?(p)
+}
+unshift_path.call('vendor/deps/cli-ui/lib')
+unshift_path.call('vendor/deps/cli-kit/lib')
+unshift_path.call('lib')
+
+require '__app__'
+
+exit(__App__::ErrorHandler.call do
+  __App__::EntryPoint.call(ARGV.dup)
+end)

data/vendor/gen/template/lib/__app__.rb

@@ -0,0 +1,33 @@
+require 'cli/ui'
+require 'cli/kit'
+
+CLI::UI::StdoutRouter.enable
+
+module __App__
+  extend CLI::Kit::Autocall
+
+  TOOL_NAME = '__app__'
+  ROOT      = File.expand_path('../..', __FILE__)
+  LOG_FILE  = '/tmp/__app__.log'
+
+  autoload(:EntryPoint, '__app__/entry_point')
+  autoload(:Commands,   '__app__/commands')
+
+  autocall(:Config)  { CLI::Kit::Config.new(tool_name: TOOL_NAME) }
+  autocall(:Command) { CLI::Kit::BaseCommand }
+
+  autocall(:Executor) { CLI::Kit::Executor.new(log_file: LOG_FILE) }
+  autocall(:Resolver) do
+    CLI::Kit::Resolver.new(
+      tool_name: TOOL_NAME,
+      command_registry: __App__::Commands::Registry
+    )
+  end
+
+  autocall(:ErrorHandler) do
+    CLI::Kit::ErrorHandler.new(
+      log_file: LOG_FILE,
+      exception_reporter: nil
+    )
+  end
+end

data/vendor/gen/template/lib/__app__/commands.rb

@@ -0,0 +1,18 @@
+require '__app__'
+
+module __App__
+  module Commands
+    Registry = CLI::Kit::CommandRegistry.new(
+      default: 'help',
+      contextual_resolver: nil
+    )
+
+    def self.register(const, cmd, path)
+      autoload(const, path)
+      Registry.add(->() { const_get(const) }, cmd)
+    end
+
+    register :Example, 'example', '__app__/commands/example'
+    register :Help,    'help',    '__app__/commands/help'
+  end
+end

data/vendor/gen/template/lib/__app__/commands/example.rb

@@ -0,0 +1,19 @@
+require '__app__'
+
+module __App__
+  module Commands
+    class Example < __App__::Command
+      def call(_args, _name)
+        puts 'neato'
+
+        if rand < 0.05
+          raise(CLI::Kit::Abort, "you got unlucky!")
+        end
+      end
+
+      def self.help
+        "A dummy command.\nUsage: {{command:#{__App__::TOOL_NAME} example}}"
+      end
+    end
+  end
+end

data/vendor/gen/template/lib/__app__/commands/help.rb

@@ -0,0 +1,21 @@
+require '__app__'
+
+module __App__
+  module Commands
+    class Help < __App__::Command
+      def call(args, _name)
+        puts CLI::UI.fmt("{{bold:Available commands}}")
+        puts ""
+
+        __App__::Commands::Registry.resolved_commands.each do |name, klass|
+          next if name == 'help'
+          puts CLI::UI.fmt("{{command:#{__App__::TOOL_NAME} #{name}}}")
+          if help = klass.help
+            puts CLI::UI.fmt(help)
+          end
+          puts ""
+        end
+      end
+    end
+  end
+end