Class: Homebrew::FormulaCreator

Inherits:
Object
  • Object
show all
Defined in:
brew/Library/Homebrew/formula_creator.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#desc ⇒ Object (readonly)

Returns the value of attribute desc.



8
9
10
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 8

def desc
  @desc
end

#homepage ⇒ Object (readonly)

Returns the value of attribute homepage.



8
9
10
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 8

def homepage
  @homepage
end

#mode ⇒ Object

Returns the value of attribute mode.



9
10
11
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 9

def mode
  @mode
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 9

def name
  @name
end

#path ⇒ Object

Returns the value of attribute path.



9
10
11
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 9

def path
  @path
end

#sha256 ⇒ Object (readonly)

Returns the value of attribute sha256.



8
9
10
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 8

def sha256
  @sha256
end

#tap ⇒ Object

Returns the value of attribute tap.



9
10
11
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 9

def tap
  @tap
end

#url ⇒ Object

Returns the value of attribute url.



8
9
10
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 8

def url
  @url
end

#version ⇒ Object

Returns the value of attribute version.



9
10
11
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 9

def version
  @version
end

Instance Method Details

#fetch? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 43

def fetch?
  !Homebrew.args.no_fetch?
end

#generate! ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 51

def generate!
  raise "#{path} already exists" if path.exist?

  if version.nil? || version.null?
    opoo "Version cannot be determined from URL."
    puts "You'll need to add an explicit 'version' to the formula."
  elsif fetch?
    unless head?
      r = Resource.new
      r.url(url)
      r.version(version)
      r.owner = self
      @sha256 = r.fetch.sha256 if r.download_strategy == CurlDownloadStrategy
    end

    if @user && @name
      begin
        metadata = GitHub.repository(@user, @name)
        @desc = metadata["description"]
        @homepage = metadata["homepage"]
      rescue GitHub::HTTPNotFoundError        # If there was no repository found assume the network connection is at
        # fault rather than the input URL.

        nil
      end
    end
  end

  path.write ERB.new(template, trim_mode: ">").result(binding)
end

#head? ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 47

def head?
  @head || Homebrew.args.HEAD?
end

#template ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 82

def template
  <<~ERB
    # Documentation: https://docs.brew.sh/Formula-Cookbook
    #                https://rubydoc.brew.sh/Formula
    # PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST!
    class #{Formulary.class_s(name)} < Formula
    <% if mode == :python %>
      include Language::Python::Virtualenv

    <% end %>
      desc "#{desc}"
      homepage "#{homepage}"
    <% if head? %>
      head "#{url}"
    <% else %>
      url "#{url}"
    <% unless version.nil? or version.detected_from_url? %>
      version "#{version}"
    <% end %>
      sha256 "#{sha256}"
    <% end %>

    <% if mode == :cmake %>
      depends_on "cmake" => :build
    <% elsif mode == :go %>
      depends_on "go" => :build
    <% elsif mode == :meson %>
      depends_on "meson" => :build
      depends_on "ninja" => :build
    <% elsif mode == :perl %>
      uses_from_macos "perl"
    <% elsif mode == :python %>
      depends_on "python"
    <% elsif mode == :rust %>
      depends_on "rust" => :build
    <% elsif mode.nil? %>
      # depends_on "cmake" => :build
    <% end %>

    <% if mode == :perl || mode == :python %>
      # Additional dependency
      # resource "" do
      #   url ""
      #   sha256 ""
      # end

    <% end %>
      def install
        # ENV.deparallelize  # if your formula fails when building in parallel
    <% if mode == :cmake %>
        system "cmake", ".", *std_cmake_args
    <% elsif mode == :autotools %>
        # Remove unrecognized options if warned by configure
        system "./configure", "--disable-debug",
                              "--disable-dependency-tracking",
                              "--disable-silent-rules",
                              "--prefix=\#{prefix}"
    <% elsif mode == :go %>
        system "go", "build", "-o", "\#{bin}/\#{name}"
    <% elsif mode == :meson %>
        mkdir "build" do
          system "meson", "--prefix=\#{prefix}", ".."
          system "ninja", "-v"
          system "ninja", "install", "-v"
        end
    <% elsif mode == :perl %>
        ENV.prepend_create_path "PERL5LIB", libexec/"lib/perl5"
        ENV.prepend_path "PERL5LIB", libexec/"lib"

        # Stage additional dependency (Makefile.PL style)
        # resource("").stage do
        #   system "perl", "Makefile.PL", "INSTALL_BASE=\#{libexec}"
        #   system "make"
        #   system "make", "install"
        # end

        # Stage additional dependency (Build.PL style)
        # resource("").stage do
        #   system "perl", "Build.PL", "--install_base", libexec
        #   system "./Build"
        #   system "./Build", "install"
        # end

        bin.install name
        bin.env_script_all_files(libexec/"bin", :PERL5LIB => ENV["PERL5LIB"])
    <% elsif mode == :python %>
        virtualenv_install_with_resources
    <% elsif mode == :rust %>
        system "cargo", "install", "--locked", "--root", prefix, "--path", "."
    <% else %>
        # Remove unrecognized options if warned by configure
        system "./configure", "--disable-debug",
                              "--disable-dependency-tracking",
                              "--disable-silent-rules",
                              "--prefix=\#{prefix}"
        # system "cmake", ".", *std_cmake_args
    <% end %>
    <% if mode == :autotools || mode == :cmake %>
        system "make", "install" # if this fails, try separate make/make install steps
    <% end %>
      end

      test do
        # `test do` will create, run in and delete a temporary directory.
        #
        # This test will fail and we won't accept that! For Homebrew/homebrew-core
        # this will need to be a test that verifies the functionality of the
        # software. Run the test with `brew test #{name}`. Options passed
        # to `brew install` such as `--HEAD` also need to be provided to `brew test`.
        #
        # The installed folder is not in the path, so use the entire path to any
        # executables being tested: `system "\#{bin}/program", "do", "something"`.
        system "false"
      end
    end
  ERB
end

#update_path ⇒ Object 



37
38
39
40
41
 
# File 'brew/Library/Homebrew/formula_creator.rb', line 37

def update_path
  return if @name.nil? || @tap.nil?

  @path = Formulary.path "#{@tap}/#{@name}"
end