Fourier improvements (tuist#2676)

* Move Fourier to projects

* Add command to lint the Swift code

* Add command to lint fourier's code

* Add command to format Swift's code

* Update git hook to run fourier

* Add tests

* Fix the fourier path

* Add command to test Tuist

.github/workflows/fourier.yml

@@ -34,7 +34,7 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Unit tests
         run: |
-          bundle exec rake test_fourier
+          ./fourier test fourier
   rubocop:
     name: Rubocop
     runs-on: ubuntu-latest

.github/workflows/meta-tuist.yml

@@ -43,10 +43,10 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Generate Xcode project
         run: |
-          ./bin/fourier generate tuist
+          ./fourier generate tuist
       - name: Build
         run: |
-          ./bin/fourier build tuist all
+          ./fourier build tuist all
   test:
     name: Test with Xcode ${{ matrix.xcode }}
     runs-on: macos-latest
@@ -72,7 +72,7 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Generate Xcode project
         run: |
-          ./bin/fourier generate tuist
+          ./fourier generate tuist
       - name: Test
         run: |
-          ./bin/fourier test tuist unit
+          ./fourier test tuist unit

.github/workflows/tuist.yml

@@ -51,7 +51,7 @@ jobs:
           bundle install --jobs 4 --retry 3
       - name: Run tests
         run: |
-          ./bin/fourier test tuist unit
+          ./fourier test tuist unit
   release_build:
     name: Release build with Xcode ${{ matrix.xcode }}
     runs-on: macOS-latest
@@ -127,4 +127,4 @@ jobs:
           bundle config path vendor/bundle
           bundle install --jobs 4 --retry 3
       - name: Run tests
-        run: ./bin/fourier test tuist acceptance features/${{ matrix.feature }}.feature
+        run: ./fourier test tuist acceptance features/${{ matrix.feature }}.feature

.shadowenv.d/fourier.lisp

@@ -1 +1 @@
-(env/prepend-to-pathlist "PATH" (expand-path "./bin"))
+(env/prepend-to-pathlist "PATH" (expand-path "."))

Gemfile

@@ -15,6 +15,8 @@ gem "rubyzip", "~> 2.3.0"
 gem "ruby-macho", "~> 1.4"
 gem "cli-ui", "~> 1.4"
 gem "thor", "~> 1.1"
+gem "octokit", "~> 4.20"
+gem "zeitwerk", "~> 2.4"
 
 group :test do
   gem "mocha", "~> 1.12"
@@ -31,7 +33,3 @@ end
 group :development, :test do
   gem "byebug", "~> 11.1"
 end
-
-gem "octokit", "~> 4.20"
-
-gem "zeitwerk", "~> 2.4"

Rakefile

@@ -19,16 +19,6 @@ require "json"
 require "zip"
 require "macho"
 
-desc("Runs the Fourier tests")
-Rake::TestTask.new do |t|
-  t.name = "test_fourier"
-  t.libs += [File.expand_path("./tools/fourier/test", __dir__)]
-  test_root = File.expand_path("./tools/fourier/test", __dir__)
-  t.test_files = FileList[File.join(test_root, "**", "*_test.rb")]
-  t.verbose = false
-  t.warning = false
-end
-
 desc("Updates swift-doc binary with the latest version available.")
 task :swift_doc_update do
   root_dir = File.expand_path(__dir__)
@@ -113,31 +103,6 @@ task :xcbeautify_update do
   File.write(File.join(root_dir, "vendor/.xcbeautify.version"), XCBEAUTIFY_VERSION)
 end
 
-desc("Formats the code style")
-task :style_correct do
-  system(code_style_path)
-end
-
-desc("Swift format check")
-task :swift_format do
-  Kernel.system(swiftformat_path, "--lint", ".") || abort
-end
-
-desc("Swift lint check")
-task :swift_lint do
-  Kernel.system(swiftlint_path) || abort
-end
-
-desc("Lints the Ruby code style")
-task :style_ruby do
-  system("bundle", "exec", "rubocop")
-end
-
-desc("Corrects the issues with the Ruby style")
-task :style_ruby_correct do
-  system("bundle", "exec", "rubocop", "-a")
-end
-
 desc("Builds and archive a release version of tuist and tuistenv for local testing.")
 task :local_package do
   package
@@ -233,18 +198,6 @@ task :benchmark do
   )
 end
 
-def swiftformat_path
-  File.expand_path("bin/swiftformat", __dir__)
-end
-
-def swiftlint_path
-  File.expand_path("bin/swiftlint", __dir__)
-end
-
-def code_style_path
-  File.expand_path("script/code_style.sh", __dir__)
-end
-
 def decrypt_secrets
   Encrypted::Environment.load_from_ejson("secrets.ejson", private_key: ENV["SECRET_KEY"])
 end

bin/fourier → fourier

@@ -9,7 +9,7 @@ require "pathname"
 require "bundler/setup"
 
 # Load fourier's directory
-fourier_directory = File.expand_path("../tools/fourier/lib", __dir__)
+fourier_directory = File.expand_path("./projects/fourier/lib", __dir__)
 $LOAD_PATH.unshift(fourier_directory) unless $LOAD_PATH.include?(fourier_directory)
 
 # Load Fourier

hooks/pre-commit

@@ -1,3 +1,5 @@
 #!/bin/bash
 
-script/code_style.sh
+./fourier lint tuist
+./fourier lint fourier
+./fourier format tuist

tools/fourier/lib/fourier/cli.rb → projects/fourier/lib/fourier.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
+
+require "cli/ui"
+require "zeitwerk"
 require "thor"
 
+loader = Zeitwerk::Loader.new
+loader.push_dir(__dir__)
+loader.inflector.inflect("github_client" => "GitHubClient")
+loader.inflector.inflect("github" => "GitHub")
+loader.setup
+
 module Fourier
   class CLI < Thor
     desc "test", "Run tests"
@@ -18,6 +27,12 @@ class CLI < Thor
     desc "edit", "Edit Tuist's project manifest in Xcode"
     subcommand "edit", Commands::Edit
 
+    desc "lint", "Lint the project's code"
+    subcommand "lint", Commands::Lint
+
+    desc "format", "Format the project's code"
+    subcommand "format", Commands::Format
+
     desc "focus TARGET", "Edit Tuist's project focusing on the target TARGET"
     def focus(target)
       Services::Focus.call(target: target)

tools/fourier/lib/fourier/commands/build.rb → projects/fourier/lib/fourier/commands/build.rb

@@ -2,8 +2,6 @@
 module Fourier
   module Commands
     class Build < Base
-      autoload :Tuist, "fourier/commands/build/tuist"
-
       desc "tuist SUBCOMMAND ...ARGS", "Build Tuist"
       subcommand "tuist", Commands::Build::Tuist
     end

projects/fourier/lib/fourier/commands/format.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Fourier
+  module Commands
+    class Format < Base
+      desc "tuist", "Format the source code of the Tuist CLI"
+      option :fix, desc: "When passed, it fixes the issues", type: :boolean, default: false
+      def tuist
+        Services::Format::Tuist.call(fix: options[:fix])
+      end
+    end
+  end
+end

projects/fourier/lib/fourier/commands/lint.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Fourier
+  module Commands
+    class Lint < Base
+      desc "tuist", "Lint the source code of the Tuist CLI"
+      option :fix, desc: "When passed, it fixes the issues", type: :boolean, default: false
+      def tuist
+        Services::Lint::Tuist.call(fix: options[:fix])
+      end
+
+      desc "fourier", "Lint the source code of the Fourier CLI"
+      option :fix, desc: "When passed, it fixes the issues", type: :boolean, default: false
+      def fourier
+        Services::Lint::Fourier.call(fix: options[:fix])
+      end
+
+      desc "all", "Lint all the code in the repository"
+      option :fix, desc: "When passed, it fixes the issues", type: :boolean, default: false
+      def all
+        Services::Lint::Tuist.call(fix: options[:fix])
+        Services::Lint::Fourier.call(fix: options[:fix])
+      end
+    end
+  end
+end

tools/fourier/lib/fourier/commands/test.rb → projects/fourier/lib/fourier/commands/test.rb

@@ -2,10 +2,13 @@
 module Fourier
   module Commands
     class Test < Base
-      autoload :Tuist, "fourier/commands/test/tuist"
-
       desc "tuist SUBCOMMAND ...ARGS", "Run Tuist tests"
       subcommand "tuist", Commands::Test::Tuist
+
+      desc "fourier", "Run Fourier tests"
+      def fourier
+        Services::Test::Fourier.call
+      end
     end
   end
 end

tools/fourier/lib/fourier/constants.rb → projects/fourier/lib/fourier/constants.rb

@@ -2,6 +2,7 @@
 module Fourier
   module Constants
     ROOT_DIRECTORY = File.expand_path("../../../..", __dir__)
+    VENDOR_DIRECTORY = File.expand_path("../../vendor", __dir__)
     REPOSITORY = "tuist/tuist"
   end
 end

projects/fourier/lib/fourier/services/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Fourier
+  module Services
+    class Base
+      def self.call(*args, &block)
+        new(*args).call(&block)
+      end
+
+      def call
+        raise NotImplementedError
+      end
+
+      def root_directory
+        Fourier::Constants::ROOT_DIRECTORY
+      end
+
+      def fourier_directory
+        File.join(Fourier::Constants::ROOT_DIRECTORY, "projects/fourier")
+      end
+
+      def tuist_directory
+        File.join(Fourier::Constants::ROOT_DIRECTORY)
+      end
+
+      def vendor_path(path)
+        File.join(Fourier::Constants::VENDOR_DIRECTORY, path)
+      end
+    end
+  end
+end

tools/fourier/lib/fourier/services/build/tuist/all.rb → projects/fourier/lib/fourier/services/build/tuist/all.rb

@@ -5,7 +5,7 @@ module Build
       module Tuist
         class All < Base
           def call
-            Dir.chdir(Constants::ROOT_DIRECTORY) do
+            Dir.chdir(tuist_directory) do
               Utilities::System.tuist("build")
             end
           end

tools/fourier/lib/fourier/services/build/tuist/support.rb → projects/fourier/lib/fourier/services/build/tuist/support.rb

@@ -5,7 +5,7 @@ module Build
       module Tuist
         class Support < Base
           def call
-            Dir.chdir(Constants::ROOT_DIRECTORY) do
+            Dir.chdir(tuist_directory) do
               Utilities::System.tuist("build", "TuistSupport")
             end
           end

tools/fourier/lib/fourier/services/edit/tuist.rb → projects/fourier/lib/fourier/services/edit/tuist.rb

@@ -4,7 +4,7 @@ module Services
     module Edit
       class Tuist < Base
         def call
-          Dir.chdir(Constants::ROOT_DIRECTORY) do
+          Dir.chdir(tuist_directory) do
             Utilities::System.tuist("edit", "--only-current-directory")
           end
         end

tools/fourier/lib/fourier/services/focus.rb → projects/fourier/lib/fourier/services/focus.rb

@@ -9,7 +9,7 @@ def initialize(target:)
       end
 
       def call
-        Dir.chdir(Constants::ROOT_DIRECTORY) do
+        Dir.chdir(tuist_directory) do
           Utilities::System.tuist("focus", target)
         end
       end

projects/fourier/lib/fourier/services/format/tuist.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Fourier
+  module Services
+    module Format
+      class Tuist < Base
+        attr_reader :fix
+
+        def initialize(fix:)
+          @fix = fix
+        end
+
+        def call
+          Dir.chdir(tuist_directory) do
+            arguments = [vendor_path("swiftformat"), ".", "--quiet"]
+            unless fix
+              arguments << "--lint"
+            end
+            Fourier::Utilities::System.system(*arguments)
+          end
+        end
+      end
+    end
+  end
+end

tools/fourier/lib/fourier/services/generate/tuist.rb → projects/fourier/lib/fourier/services/generate/tuist.rb

@@ -10,7 +10,7 @@ def initialize(open: false)
         end
 
         def call
-          Dir.chdir(Constants::ROOT_DIRECTORY) do
+          Dir.chdir(tuist_directory) do
             arguments = ["generate"]
             arguments << "--open" if open
             Utilities::System.tuist(*arguments)

projects/fourier/lib/fourier/services/lint/fourier.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Fourier
+  module Services
+    module Lint
+      class Fourier < Base
+        attr_reader :fix
+
+        def initialize(fix:)
+          @fix = fix
+        end
+
+        def call
+          Dir.chdir(fourier_directory) do
+            gem_path = Gem.loaded_specs["rubocop"].full_gem_path
+            executable_path = File.join(gem_path, "exe/rubocop")
+            arguments = [executable_path]
+            arguments << "-A" if fix
+            Utilities::System.system(*arguments)
+          end
+        end
+      end
+    end
+  end
+end