home brew 的研究

# Formula 脚本必须继承Formula类
class Git < Formula
  	# 用来描述你的工具的一句话
    desc "Distributed revision control system"
  	# 必须是https的正确地址，可通过brew home 查看，如果发布到正式的tap这个有检验
    homepage "https://git-scm.com"
  	# 下载链接，也是一个源码库
    url "https://mirrors.edge.kernel.org/pub/software/scm/git/git-2.39.1.tar.xz"
  	# 源码zip包对应的一个sha256，用来验证缓存的完整性和安全性
    sha256 "40a38a0847b30c371b35873b3afcf123885dd41ea3ecbbf510efa97f3ce5c161"
  	# 需要遵循的许可
    license "GPL-2.0-only"
  	# 可以直接通过--head 进行下载的，如果通过--head 就不会用url或者去下载
    head "https://github.com/git/git.git", branch: "master"
  	# 检查是否有新版本的block
    livecheck do
      url "https://www.kernel.org/pub/software/scm/git/"
      regex(/href=.*?git[._-]v?(\d+(?:\.\d+)+)\.t/i)
    end
  
  	# 已经编译好的可执行二进制文件对应的sha256, 如果有对应平台的bottle会直接采用
    bottle do
      sha256 arm64_ventura:  "2d9a37ed166b873b440d958901013b1e654bbd5ac727ccf1aedbf2775ef1d755"
      sha256 arm64_monterey: "64f0c9cc05c506988b61e178562347032d86e4140063a57ca96fedb9c7ca7456"
      sha256 arm64_big_sur:  "943e530d20cabe88ba728bf1e7c6a5872fa28701b42f6426372b813bd535922e"
      sha256 ventura:        "f927b7c352d1e202cc072ea0f5582f8c09c57c6a374daf5682eae6de21ea04d5"
      sha256 monterey:       "b9849b6591a22a1cc2326301b258299888c8fd03dbb479793bab971bf14aadc8"
      sha256 big_sur:        "7119f027abde700c0f3c7a012cceb7b0246a862735b3309f5ee70a63f7e69251"
      sha256 x86_64_linux:   "3c62fb80f565b24970423a4f882959377bbd8b67dc023ed8f47543faffe6fa36"
    end
  
  	# 依赖库，可指定具体场景时机使用
    depends_on "gettext"
    depends_on "pcre2"
  
  	# MacOS 提供的一些依赖库
    uses_from_macos "curl", since: :catalina # macOS < 10.15.6 has broken cert path logic
    uses_from_macos "expat"
    uses_from_macos "zlib", since: :high_sierra
  
  	# linux 系统的一些依赖
    on_linux do
      depends_on "linux-headers@5.15" => :build
      depends_on "openssl@1.1" # Uses CommonCrypto on macOS
    end
  
  	# 额外的一些下载资源，会被定义为resource
    resource "html" do
      url "https://mirrors.edge.kernel.org/pub/software/scm/git/git-htmldocs-2.39.1.tar.xz"
      sha256 "032de9396c907383c8236e094a038191d54822a212390c2ce2fcd749db90dfd0"
    end
  
    resource "man" do
      url "https://mirrors.edge.kernel.org/pub/software/scm/git/git-manpages-2.39.1.tar.xz"
      sha256 "b522a58e963fd5137f660802ec5a93283abfa3eaa0f069ebb6e7f00e529cc775"
    end
  
    resource "Net::SMTP::SSL" do
      url "https://cpan.metacpan.org/authors/id/R/RJ/RJBS/Net-SMTP-SSL-1.04.tar.gz"
      sha256 "7b29c45add19d3d5084b751f7ba89a8e40479a446ce21cfd9cc741e558332a00"
    end
  
  	# 安装方法， 定义了如何安装， 里面具体内容不做过多注释了~
    def install
      # If these things are installed, tell Git build system not to use them
      ENV["NO_FINK"] = "1"
      ENV["NO_DARWIN_PORTS"] = "1"
      ENV["PYTHON_PATH"] = which("python")
      ENV["PERL_PATH"] = which("perl")
      ENV["USE_LIBPCRE2"] = "1"
      ENV["INSTALL_SYMLINKS"] = "1"
      ENV["LIBPCREDIR"] = Formula["pcre2"].opt_prefix
      ENV["V"] = "1" # build verbosely
  
      perl_version = Utils.safe_popen_read("perl", "--version")[/v(\d+\.\d+)(?:\.\d+)?/, 1]
  
      if OS.mac?
        ENV["PERLLIB_EXTRA"] = %W[
          #{MacOS.active_developer_dir}
          /Library/Developer/CommandLineTools
          /Applications/Xcode.app/Contents/Developer
        ].uniq.map do |p|
          "#{p}/Library/Perl/#{perl_version}/darwin-thread-multi-2level"
        end.join(":")
      end
  
      # The git-gui and gitk tools are installed by a separate formula (git-gui)
      # to avoid a dependency on tcl-tk and to avoid using the broken system
      # tcl-tk (see https://github.com/Homebrew/homebrew-core/issues/36390)
      # This is done by setting the NO_TCLTK make variable.
      args = %W[
        prefix=#{prefix}
        sysconfdir=#{etc}
        CC=#{ENV.cc}
        CFLAGS=#{ENV.cflags}
        LDFLAGS=#{ENV.ldflags}
        NO_TCLTK=1
      ]
  
      args += if OS.mac?
        %w[NO_OPENSSL=1 APPLE_COMMON_CRYPTO=1]
      else
        openssl_prefix = Formula["openssl@1.1"].opt_prefix
  
        %W[NO_APPLE_COMMON_CRYPTO=1 OPENSSLDIR=#{openssl_prefix}]
      end
  		
  		# 调用系统的cmake 进行install安装
      system "make", "install", *args
  
      git_core = libexec/"git-core"
      rm git_core/"git-svn"
  
      # Install the macOS keychain credential helper
      if OS.mac?
        cd "contrib/credential/osxkeychain" do
          system "make", "CC=#{ENV.cc}",
                         "CFLAGS=#{ENV.cflags}",
                         "LDFLAGS=#{ENV.ldflags}"
          git_core.install "git-credential-osxkeychain"
          system "make", "clean"
        end
      end
  
      # Generate diff-highlight perl script executable
      cd "contrib/diff-highlight" do
        system "make"
      end
  
      # Install the netrc credential helper
      cd "contrib/credential/netrc" do
        system "make", "test"
        git_core.install "git-credential-netrc"
      end
  
      # Install git-subtree
      cd "contrib/subtree" do
        system "make", "CC=#{ENV.cc}",
                       "CFLAGS=#{ENV.cflags}",
                       "LDFLAGS=#{ENV.ldflags}"
        git_core.install "git-subtree"
      end
  
      # install the completion script first because it is inside "contrib"
      bash_completion.install "contrib/completion/git-completion.bash"
      bash_completion.install "contrib/completion/git-prompt.sh"
      zsh_completion.install "contrib/completion/git-completion.zsh" => "_git"
      cp "#{bash_completion}/git-completion.bash", zsh_completion
  
      (share/"git-core").install "contrib"
  
      # We could build the manpages ourselves, but the build process depends
      # on many other packages, and is somewhat crazy, this way is easier.
      man.install resource("man")
      (share/"doc/git-doc").install resource("html")
  
      # Make html docs world-readable
      chmod 0644, Dir["#{share}/doc/git-doc/**/*.{html,txt}"]
      chmod 0755, Dir["#{share}/doc/git-doc/{RelNotes,howto,technical}"]
  
      # git-send-email needs Net::SMTP::SSL or Net::SMTP >= 2.34
      resource("Net::SMTP::SSL").stage do
        (share/"perl5").install "lib/Net"
      end
  
      # This is only created when building against system Perl, but it isn't
      # purged by Homebrew's post-install cleaner because that doesn't check
      # "Library" directories. It is however pointless to keep around as it
      # only contains the perllocal.pod installation file.
      rm_rf prefix/"Library/Perl"
  
      # Set the macOS keychain credential helper by default
      # (as Apple's CLT's git also does this).
      if OS.mac?
        (buildpath/"gitconfig").write <<~EOS
          [credential]
          \thelper = osxkeychain
        EOS
        etc.install "gitconfig"
      end
    end
  
    def caveats
      <<~EOS
        The Tcl/Tk GUIs (e.g. gitk, git-gui) are now in the `git-gui` formula.
        Subversion interoperability (git-svn) is now in the `git-svn` formula.
      EOS
    end
  
		# 测试方法，如果要发布到官方的tap中，test测试必须通过
    test do
      system bin/"git", "init"
      %w[haunted house].each { |f| touch testpath/f }
      system bin/"git", "add", "haunted", "house"
      system bin/"git", "config", "user.name", "'A U Thor'"
      system bin/"git", "config", "user.email", "author@example.com"
      system bin/"git", "commit", "-a", "-m", "Initial Commit"
      assert_equal "haunted\nhouse", shell_output("#{bin}/git ls-files").strip
  
      # Check Net::SMTP or Net::SMTP::SSL works for git-send-email
      if OS.mac?
        %w[foo bar].each { |f| touch testpath/f }
        system bin/"git", "add", "foo", "bar"
        system bin/"git", "commit", "-a", "-m", "Second Commit"
        assert_match "Authentication Required", pipe_output(
          "#{bin}/git send-email --from=test@example.com --to=dev@null.com " \
          "--smtp-server=smtp.gmail.com --smtp-server-port=587 " \
          "--smtp-encryption=tls --confirm=never HEAD^ 2>&1",
        )
      end
    end
  end