shopify-cli 2.2.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0c4574b0b307dbe68a4cfe4d47e76a4825dbc2bb208b2fd891e0192e3158690
-  data.tar.gz: c365c04166d24b723c4b5d8e0612e722fec4e765f2efcc4a638d534ab60a645c
+  metadata.gz: 60163978b05868670c0b5535cc49060ba5f55c9e127d6f97232970751caeb4d8
+  data.tar.gz: b3993bcef0bd4d5488f4b4d7f3e8b6f219a0322279159a512a12cc3986f2e63a
 SHA512:
-  metadata.gz: baecd34e68711439ab4986652a21d00dc7c8443ef92497cf516e535cb91b979280293a3d86936a5b4260984739b28adab3ece18fdedfa35087d8ed1ee7411f2c
-  data.tar.gz: c55111c54115aeb15b5c9cd29e48c1b42c2dbe89a79a509e74c3f2fdea0830ad693e9983ca00ad40468ed9c132c7202e0ca01681dc94866f191773c982811f14
+  metadata.gz: cd65b86469afbc40117f58257840588dea0fd07141e899ac9273e0eee9da4bcaef119c4df14921777d3ae88932fd053771392154658704294b59afd9656b00f8
+  data.tar.gz: 2d199c2d96954b9d2c666fc4822f845f1a176115eb90a28078af42ceaf0cf691b3b2e21896485afe4c42b2ec43e7c5af576ba18a86188bf01a22f7ff32ffb8f0

data/.github/CODEOWNERS

@@ -1,4 +1,5 @@
 *       @shopify/core-build-learn
+*       @shopify/development-lifecycle
 
 /lib/project_types/script/ @shopify/scripts-experience
 /test/project_types/script/ @shopify/scripts-experience

data/.github/ISSUE_TEMPLATE.md

@@ -24,10 +24,6 @@ Tip: include an error message (in a `<details></details>` tag) if your issue is
 1.
 1.
 
-## Reduced test case
-
-The best way to get your bug fixed is to provide a [reduced test case](https://developer.mozilla.org/en-US/docs/Mozilla/QA/Reducing_testcases).
-
 
 
 ## Specifications

data/.github/workflows/shopify.yml

@@ -0,0 +1,104 @@
+name: Shopify
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: shopify-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Tests with Ruby ${{ matrix.version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - 3.0.2
+          - 2.6.6
+          - 2.7.1
+        os:
+          - macos-10.15
+          - macos-11
+          - ubuntu-20.04
+          - ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set Git configuration
+        run: |
+          git config --global user.email "development-lifecycle@shopify.com"
+          git config --global user.name "Development Lifecycle"
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - name: Install Dependencies
+        run: bundle install
+
+      - name: Run Tests
+        run: bundle exec rake test
+  acceptance_tests:
+    name: Acceptance Tests with Ruby ${{ matrix.version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - 3.0.2
+          - 2.6.6
+          - 2.7.1
+        os:
+          - macos-10.15
+          - macos-11
+          - ubuntu-20.04
+          - ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set Git configuration
+        run: |
+          git config --global user.email "development-lifecycle@shopify.com"
+          git config --global user.name "Development Lifecycle"
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "14.9.0"
+
+      - name: Install Dependencies
+        run: bundle install
+
+      - name: Run Tests
+        run: bundle exec cucumber
+  rubocop:
+    name: Rubocop
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version:
+          - 3.0.2
+        os:
+          - macos-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+          bundler-cache: true
+
+      - name: Install Dependencies
+        run: bundle install
+
+      - name: Rubocop
+        run: bundle exec rake rubocop

data/.gitignore

@@ -19,3 +19,5 @@ packaging/debian/shopify-cli
 packaging/debian/shopify-cli.deb
 packaging/rpm/build
 packaging/rpm/shopify-cli.spec
+.byebug_history
+ext/shopify-extensions/shopify-extensions

data/.rubocop.yml

@@ -11,8 +11,8 @@ inherit_gem:
 Minitest:
   Enabled: true
   Include:
-    - '**/test/**/*'
-    - '**/*_test.rb'
+    - "**/test/**/*"
+    - "**/*_test.rb"
 
 Minitest/AssertInDelta: # (new in 0.10)
   Enabled: true
@@ -43,15 +43,15 @@ Minitest/UnspecifiedException: # (new in 0.10)
 
 AllCops:
   Exclude:
-    - 'vendor/**/*'
-    - 'docs/**/*'
-    - 'packaging/**/*'
+    - "vendor/**/*"
+    - "docs/**/*"
+    - "packaging/**/*"
   TargetRubyVersion: 2.4
 
 Layout/EmptyLines:
   Exclude:
     # Need extra line so comment at top isnt registered to the Dev namespace
-    - 'lib/dev/helpers/chruby_reset.rb'
+    - "lib/dev/helpers/chruby_reset.rb"
 
 Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
@@ -59,10 +59,10 @@ Layout/EmptyLineBetweenDefs:
 # Changing this could effect the way the content is rendered.
 Layout/HeredocIndentation:
   Exclude:
-    - 'lib/project_types/node/messages/messages.rb'
-    - 'lib/project_types/rails/messages/messages.rb'
-    - 'lib/project_types/script/messages/messages.rb'
-    - 'lib/shopify-cli/messages/messages.rb'
+    - "lib/project_types/node/messages/messages.rb"
+    - "lib/project_types/rails/messages/messages.rb"
+    - "lib/project_types/script/messages/messages.rb"
+    - "lib/shopify_cli/messages/messages.rb"
 
 # allow String.new to create mutable strings
 Style/EmptyLiteral:
@@ -71,7 +71,7 @@ Style/EmptyLiteral:
 # allow String.new to create mutable strings
 Style/HashSyntax:
   Exclude:
-    - 'Rakefile'
+    - "Rakefile"
 
 # allow using %r{} for regexes
 Style/RegexpLiteral:
@@ -97,6 +97,6 @@ Style/MethodCallWithArgsParentheses:
 
 Layout/TrailingWhitespace:
   Exclude:
-    - 'ext/shopify-cli/extconf.rb' # unsure if safe to remove
-    - 'lib/project_types/extension/messages/messages.rb' # unsure if safe to remove
-    - 'test/project_types/extension/extension_test_helpers/stubs/argo_script.rb' # unsure if save to remove
+    - "ext/shopify-cli/extconf.rb" # unsure if safe to remove
+    - "lib/project_types/extension/messages/messages.rb" # unsure if safe to remove
+    - "test/project_types/extension/extension_test_helpers/stubs/argo_script.rb" # unsure if save to remove

data/.rubocop_todo.yml

@@ -14,11 +14,11 @@ Minitest/MultipleAssertions:
 # Cop supports --auto-correct.
 Style/PerlBackrefs:
   Exclude:
-    - 'lib/docgen/markdown.rb'
+    - "lib/docgen/markdown.rb"
 
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/RedundantBegin:
   Exclude:
-    - 'lib/shopify-cli/shopifolk.rb'
-    - 'test/shopify-cli/tunnel_test.rb'
+    - "lib/shopify_cli/shopifolk.rb"
+    - "test/shopify_cli/tunnel_test.rb"

data/CHANGELOG.md

@@ -1,6 +1,29 @@
 Unreleased
 ------
 
+Version 2.5.0
+------
+
+* [#1553](https://github.com/Shopify/shopify-cli/pull/1553): Add support for PHP app projects
+
+Version 2.4.0
+------
+
+* [#1488](https://github.com/Shopify/shopify-cli/pull/1488): Update Theme-Check to 1.4
+* [#1507](https://github.com/Shopify/shopify-cli/pull/1507): Limit the generated name for themes to 50 characters
+
+Version 2.3.0
+------
+
+* [#1386](https://github.com/Shopify/shopify-cli/pull/1386): Update Theme-Check to 1.2
+* [#1457](https://github.com/Shopify/shopify-cli/pull/1457): Fix uploading of binary theme files under Windows
+* [#1480](https://github.com/Shopify/shopify-cli/pull/1480): Fix customers pages not working with `theme serve`
+* [#1479](https://github.com/Shopify/shopify-cli/pull/1479): Add theme push & pull option to ignore files per command
+
+Version 2.2.2
+------
+* [1382](https://github.com/Shopify/shopify-cli/pull/1382): Client side module upload for Scripts
+
 Version 2.2.1
 ------
 

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing
+
+This documents includes guidelines for contributors.
+
+## Testing
+
+The project employs a diverse suite tests that help ensure it works as intended and prevents regressions as it continues to grow and evolve.
+
+### Unit Tests
+Most of the internal components the project uses have unit tests to thoroughly test them. Here dependencies of components are mocked or stubbed appropriately to ensure tests are reliable, test only one component and are fast!
+
+### Acceptance Tests
+
+Acceptance tests run the built `shopify` command line against a wide range of fixtures and verify its output and results. They are the slowest to run however provide the most coverage. The idea is to test a few complete scenarios for each major feature.
+
+Those are written in [Cucumber](https://cucumber.io/) and Ruby and can be found in the [`features/`](/features) directory. They can be executed by running
+
+```bash
+bundle exec cucumber
+bundle exec cucumber features/theme.feature:3 # A specific test
+```
+
+> **Note** that we currently don't have an approach for stubbing the interactions with the GraphQL APIs and that therefore we can't write acceptance tests for commands that interact with APIs.

data/Dockerfile

@@ -0,0 +1,19 @@
+# This is a Docker image to test the CLI in UNIX environments other than macOS
+# Build the image: docker build . -t shopify-cli
+# Run tests: docker run -t --rm --volume "$(pwd):/usr/src/app" shopify-cli bundle exec rake test
+FROM cimg/ruby:2.7.1-node
+
+RUN git config --global user.email "development-lifecycle@shopify.com"
+RUN git config --global user.name "Development Lifecycle"
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+RUN bundle config --global frozen 1
+
+WORKDIR /usr/src/app
+
+COPY Gemfile Gemfile.lock ./
+COPY shopify-cli.gemspec  shopify-cli.gemspec
+COPY lib/shopify_cli/version.rb  lib/shopify_cli/version.rb
+COPY . .
+
+RUN bundle install

data/Gemfile

@@ -24,4 +24,5 @@ group :test do
   gem "webmock", require: false
   gem "timecop", require: false
   gem "rack", require: false
+  gem "cucumber", "~> 7.0", require: false
 end

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    shopify-cli (2.2.1)
-      listen (~> 3.5)
-      theme-check (~> 1.1)
+    shopify-cli (2.5.0)
+      listen (~> 3.7.0)
+      theme-check (~> 1.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     ast (2.4.2)
@@ -16,15 +16,50 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     crack (0.4.4)
+    cucumber (7.0.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-create-meta (~> 6.0, >= 6.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-html-formatter (~> 16.0, >= 16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-wire (~> 6.0, >= 6.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      mime-types (~> 3.3, >= 3.3.1)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-core (10.0.1)
+      cucumber-gherkin (~> 20.0, >= 20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      cucumber-tag-expressions (~> 3.0, >= 3.0.1)
+    cucumber-create-meta (6.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-cucumber-expressions (12.1.3)
+    cucumber-gherkin (20.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-html-formatter (16.0.1)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    cucumber-messages (17.1.0)
+    cucumber-tag-expressions (3.0.1)
+    cucumber-wire (6.1.1)
+      cucumber-core (~> 10.0, >= 10.0.1)
+      cucumber-cucumber-expressions (~> 12.1, >= 12.1.2)
+      cucumber-messages (~> 17.0, >= 17.0.1)
+    diff-lcs (1.4.4)
     fakefs (1.2.2)
     ffi (1.15.3)
     hashdiff (1.0.1)
     liquid (5.0.1)
-    listen (3.5.1)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     method_source (1.0.0)
-    mini_portile2 (2.5.3)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    mini_portile2 (2.6.1)
     minitest (5.14.2)
     minitest-fail-fast (0.1.0)
       minitest (~> 5)
@@ -34,11 +69,10 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     mocha (1.11.2)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    multi_test (0.1.2)
+    nokogiri (1.12.4)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    nokogumbo (2.0.5)
-      nokogiri (~> 1.8, >= 1.8.4)
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
@@ -76,9 +110,11 @@ GEM
     rubocop-shopify (2.0.1)
       rubocop (~> 1.11)
     ruby-progressbar (1.11.0)
-    theme-check (1.1.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    theme-check (1.4.0)
       liquid (>= 5.0.1)
-      nokogumbo
+      nokogiri (>= 1.12)
     timecop (0.9.2)
     unicode-display_width (2.0.0)
     webmock (3.9.3)
@@ -90,8 +126,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.1.4)
+  bundler (~> 2.2.2)
   byebug
+  cucumber (~> 7.0)
   fakefs (>= 1.0)
   minitest (>= 5.0.0)
   minitest-fail-fast

data/RELEASING.md

@@ -13,7 +13,7 @@
    $ git checkout -b release_X_Y_Z
    ```
 
-1. Update the version of Shopify CLI in `lib/shopify-cli/version.rb`
+1. Update the version of Shopify CLI in `lib/shopify_cli/version.rb`
 
 1. Update the version of Shopify CLI at the top of `Gemfile.lock` (failing to do so causes the CI build to fail)
 

data/Rakefile

@@ -2,6 +2,7 @@ require_relative "bin/load_shopify"
 require "rake/testtask"
 require "rubocop/rake_task"
 require "bundler/gem_tasks"
+require "shellwords"
 
 Rake::TestTask.new do |t|
   t.libs += %w(test)
@@ -10,6 +11,33 @@ Rake::TestTask.new do |t|
   t.warning = false
 end
 
+desc "A set of tasks that run in Linux environments"
+namespace :linux do
+  desc "Runs the test suite in a Linux Docker environment"
+  task :test do
+    system("docker", "build", __dir__, "-t", "shopify-cli") || abort
+    system(
+      "docker", "run",
+      "-t", "--rm",
+      "--volume", "#{Shellwords.escape(__dir__)}:/usr/src/app",
+      "shopify-cli",
+      "bundle", "exec", "rake", "test"
+    ) || abort
+  end
+
+  desc "Runs the acceptance tests suite in a Linux Docker environment"
+  task :features do
+    system("docker", "build", __dir__, "-t", "shopify-cli") || abort
+    system(
+      "docker", "run",
+      "-t", "--rm",
+      "--volume", "#{Shellwords.escape(__dir__)}:/usr/src/app",
+      "shopify-cli",
+      "bundle", "exec", "cucumber"
+    ) || abort
+  end
+end
+
 RuboCop::RakeTask.new
 
 task(default: [:test, :rubocop])
@@ -23,20 +51,20 @@ namespace :rdoc do
   repo = "https://github.com/Shopify/shopify-cli.wiki.git"
   intermediate = "markdown_intermediate"
   file_to_doc = [
-    "lib/shopify-cli/admin_api.rb",
-    "lib/shopify-cli/context.rb",
-    "lib/shopify-cli/db.rb",
-    "lib/shopify-cli/git.rb",
-    "lib/shopify-cli/heroku.rb",
-    "lib/shopify-cli/js_deps.rb",
-    "lib/shopify-cli/lazy_delegator.rb",
-    "lib/shopify-cli/method_object.rb",
-    "lib/shopify-cli/partners_api.rb",
-    "lib/shopify-cli/process_supervision.rb",
-    "lib/shopify-cli/project.rb",
-    "lib/shopify-cli/result.rb",
-    "lib/shopify-cli/transform_data_structure.rb",
-    "lib/shopify-cli/tunnel.rb",
+    "lib/shopify_cli/admin_api.rb",
+    "lib/shopify_cli/context.rb",
+    "lib/shopify_cli/db.rb",
+    "lib/shopify_cli/git.rb",
+    "lib/shopify_cli/heroku.rb",
+    "lib/shopify_cli/js_deps.rb",
+    "lib/shopify_cli/lazy_delegator.rb",
+    "lib/shopify_cli/method_object.rb",
+    "lib/shopify_cli/partners_api.rb",
+    "lib/shopify_cli/process_supervision.rb",
+    "lib/shopify_cli/project.rb",
+    "lib/shopify_cli/result.rb",
+    "lib/shopify_cli/transform_data_structure.rb",
+    "lib/shopify_cli/tunnel.rb",
   ]
 
   task all: [:markdown, :wiki, :cleanup]
@@ -76,25 +104,63 @@ desc("Generate markdown documentation and update the wiki")
 task(rdoc: "rdoc:all")
 
 namespace :package do
-  require "shopify-cli/packager"
+  require "shopify_cli/packager"
 
   task all: [:debian, :rpm, :homebrew]
 
   desc("Builds a Debian package of the CLI")
   task :debian do
-    ShopifyCli::Packager.new.build_debian
+    ShopifyCLI::Packager.new.build_debian
   end
 
   desc("Builds an RPM package of the CLI")
   task :rpm do
-    ShopifyCli::Packager.new.build_rpm
+    ShopifyCLI::Packager.new.build_rpm
   end
 
   desc("Builds a Homebrew package of the CLI")
   task :homebrew do
-    ShopifyCli::Packager.new.build_homebrew
+    ShopifyCLI::Packager.new.build_homebrew
   end
 end
 
 desc("Builds all distribution packages of the CLI")
 task(package: "package:all")
+
+namespace :extensions do
+  task :update do
+    version = ENV.fetch("VERSION").strip
+    error("Invalid version") unless /^v\d+\.\d+\.\d+/.match(version)
+    File.write(Paths.extension("version"), version)
+  end
+
+  task :symlink do
+    source = Paths.root("..", "shopify-cli-extensions", "shopify-extensions")
+    error("Unable to find shopify-extensions executable: #{executable}") unless File.executable?(source)
+    target = Paths.extension("shopify-extensions")
+    File.delete(target) if File.exist?(target)
+    File.symlink(source, target)
+  end
+
+  task :install do
+    target = Paths.extension("shopify-extensions")
+    require_relative Paths.extension("shopify_extensions.rb")
+    File.delete(target) if File.exist?(target)
+    ShopifyExtensions.install(target: target)
+  end
+
+  module Paths
+    def self.extension(*args)
+      root("ext", "shopify-extensions", *args)
+    end
+
+    def self.root(*args)
+      Pathname(File.dirname(__FILE__)).join(*args).to_s
+    end
+  end
+end
+
+def error(message, output: STDERR, code: 1)
+  output.puts(message)
+  exit(code)
+end

data/bin/shopify

@@ -9,7 +9,7 @@ module Kernel
     original_require(name)
   rescue LoadError => e
     # Special case for readline.so, which fails harmlessly on Windows
-    raise if (name == "readline.so") && ShopifyCli::Context.new.windows?
+    raise if (name == "readline.so") && ShopifyCLI::Context.new.windows?
     # Special case for psych (yaml), which rescues this itself
     raise if name == "#{RUBY_VERSION[/\d+\.\d+/]}/psych.so"
     STDERR.puts "[Note] You cannot use gems with Shopify CLI."
@@ -29,6 +29,6 @@ end
 
 require_relative "./load_shopify"
 
-exit(ShopifyCli::ErrorHandler.call do
-  ShopifyCli::Core::EntryPoint.call(ARGV.dup)
+exit(ShopifyCLI::ErrorHandler.call do
+  ShopifyCLI::Core::EntryPoint.call(ARGV.dup)
 end)

data/dev.yml

@@ -4,13 +4,19 @@ type:
 
 up:
   - ruby: 2.7.1
+  - homebrew:
+      - dpkg:
+          version: 1.20.9
+      - rpm:
+          version: 4.16.1.3
   - bundler
   - node:
       version: 14.9.0
       yarn: true
+  - docker
 
 test:
-  desc: 'Run tests.'
+  desc: "Run tests."
   run: |
     if [ "$#" -eq 1 ] && [[ -f $1 ]];
     then
@@ -18,3 +24,7 @@ test:
     else
       bundle exec rake test $@
     fi
+
+commands:
+  style:
+    run: bundle exec rubocop .

data/ext/shopify-extensions/extconf.rb

@@ -0,0 +1,21 @@
+require_relative "./shopify_extensions"
+
+installation_dir = ENV.fetch("SHOPIFY_CLI_EXTENSIONS_INSTALLATION_DIR", __dir__)
+
+File.write(File.expand_path("Makefile", installation_dir), <<~MAKEFILE)
+  .PHONY: clean
+
+  clean: ;
+
+  install: ;
+MAKEFILE
+
+begin
+  ShopifyExtensions.install(
+    target: File.expand_path("shopify-extensions", installation_dir)
+  )
+rescue ShopifyExtensions::InstallationError => error
+  STDERR.puts(error.message)
+rescue => error
+  STDERR.puts("Unable to install shopify-extensions: #{error}")
+end