Graduate iojs out of keg-only

bcomnes · bcomnes · commit 4e9cdfc3cc5a · 2015-02-20T11:32:02.000-08:00
This PR - takes iojs out of keg-only - conflicts node and iojs - patches iojs’s installed npm - does not patch node’s installed npm - Added NPM install code to language/javascript.rb - Added npm caveats to iojs and node formula based off of python caveats. - incorporated 1580f8b change Signed-off-by: Bret Comnes <bcomnes@gmail.com>
diff --git a/Library/Formula/iojs.rb b/Library/Formula/iojs.rb
@@ -1,4 +1,8 @@
+require "language/javascript"
+
 class Iojs < Formula
+  include Language::JS
+
   homepage "https://iojs.org/"
   url "https://iojs.org/dist/v1.3.0/iojs-v1.3.0.tar.xz"
   sha256 "0c20c0d26d8c8e8814f02fd20fb5e57098f747692cddfd7453ffae973ebcebda"
@@ -9,29 +13,73 @@ class Iojs < Formula
     sha1 "cdcc1f499cc7ea2b17ebf0311a49a46352ba4ba4" => :mountain_lion
   end
 
-  keg_only "iojs conflicts with node (which is currently more established)"
+  conflicts_with "node", :because => "node and iojs both install a binary/link named node"
 
   option "with-debug", "Build with debugger hooks"
   option "with-icu4c", "Build with Intl (icu4c) support"
+  option "without-npm", "npm will not be installed"
+  option "without-completion", "npm bash completion will not be installed"
 
   depends_on "pkg-config" => :build
   depends_on "icu4c" => :optional
   depends_on :python => :build
 
+  resource "npm" do
+    url "https://registry.npmjs.org/npm/-/npm-2.3.0.tgz"
+    sha1 "3588ec5c18fb5ac41e5721b0ea8ece3a85ab8b4b"
+  end
+
   def install
     args = %W[--prefix=#{prefix} --without-npm]
     args << "--debug" if build.with? "debug"
     args << "--with-intl=system-icu" if build.with? "icu4c"
 
     system "./configure", *args
     system "make", "install"
+
+    if build.with? "npm"
+      resource("npm").stage npm_buildpath = buildpath/"npm_install"
+      install_npm npm_buildpath
+
+      if build.with? "completion"
+        install_npm_bash_completion npm_buildpath
+      end
+    end
   end
 
-  def caveats; <<-EOS.undent
-    iojs was installed without npm.
+  def post_install
+    return if build.without? "npm"
 
-    iojs currently requires a patched npm (i.e. not the npm installed by node).
-    EOS
+    npm_post_install libexec
+  end
+
+  def caveats
+    s = ""
+
+    if build.with? "npm"
+      s += <<-EOS.undent
+        npm has been installed. To update run
+          npm install -g npm@latest
+
+        You can install global npm packages with
+          npm install -g <package>
+
+        They will install into the global node_modiles directory
+          /usr/local/lib/node_modules
+
+        Do NOT use the npm update command with global modules.
+        The upstream-recommended way to update global modules is:
+          npm install -g <package>@latest
+      EOS
+    else
+      s += <<-EOS.undent
+        Homebrew has NOT installed npm. If you later install it, you should supplement
+        your NODE_PATH with the npm module folder:
+          #{HOMEBREW_PREFIX}/lib/node_modules
+      EOS
+    end
+
+    s
   end
 
   test do
@@ -41,5 +89,13 @@ def caveats; <<-EOS.undent
     output = `#{bin}/iojs #{path}`.strip
     assert_equal "hello", output
     assert_equal 0, $?.exitstatus
+
+    if build.with? "npm"
+      # make sure npm can find node
+      ENV.prepend_path "PATH", opt_bin
+      assert_equal which("node"), opt_bin/"node"
+      npm_test_install
+    end
   end
 end
+
diff --git a/Library/Formula/node.rb b/Library/Formula/node.rb
@@ -1,5 +1,9 @@
+require "language/javascript"
+
 # Note that x.even are stable releases, x.odd are devel releases
 class Node < Formula
+  include Language::JS
+
   homepage "https://nodejs.org/"
   url "https://nodejs.org/dist/v0.12.0/node-v0.12.0.tar.gz"
   sha256 "9700e23af4e9b3643af48cef5f2ad20a1331ff531a12154eef2bfb0bb1682e32"
@@ -12,6 +16,8 @@ class Node < Formula
     sha1 "8312e7ea6ffec58e39ec7cc1f8671847a9d7b4bf" => :mountain_lion
   end
 
+  conflicts_with "iojs", :because => "node and iojs both install a binary/link named node"
+
   option "with-debug", "Build with debugger hooks"
   option "without-npm", "npm will not be installed"
   option "without-completion", "npm bash completion will not be installed"
@@ -50,66 +56,38 @@ def install
     system "make", "install"
 
     if build.with? "npm"
-      resource("npm").stage buildpath/"npm_install"
-
-      # make sure npm can find node
-      ENV.prepend_path "PATH", bin
-      # make sure user prefix settings in $HOME are ignored
-      ENV["HOME"] = buildpath/"home"
-      # set log level temporarily for npm's `make install`
-      ENV["NPM_CONFIG_LOGLEVEL"] = "verbose"
-
-      cd buildpath/"npm_install" do
-        system "./configure", "--prefix=#{libexec}/npm"
-        system "make", "install"
-      end
+      resource("npm").stage npm_buildpath = buildpath/"npm_install"
+      install_npm npm_buildpath
 
       if build.with? "completion"
-        bash_completion.install \
-          buildpath/"npm_install/lib/utils/completion.sh" => "npm"
+        install_npm_bash_completion npm_buildpath
       end
     end
   end
 
   def post_install
     return if build.without? "npm"
 
-    node_modules = HOMEBREW_PREFIX/"lib/node_modules"
-    node_modules.mkpath
-    npm_exec = node_modules/"npm/bin/npm-cli.js"
-    # Kill npm but preserve all other modules across node updates/upgrades.
-    rm_rf node_modules/"npm"
-
-    cp_r libexec/"npm/lib/node_modules/npm", node_modules
-    # This symlink doesn't hop into homebrew_prefix/bin automatically so
-    # remove it and make our own. This is a small consequence of our bottle
-    # npm make install workaround. All other installs **do** symlink to
-    # homebrew_prefix/bin correctly. We ln rather than cp this because doing
-    # so mimics npm's normal install.
-    ln_sf npm_exec, "#{HOMEBREW_PREFIX}/bin/npm"
-
-    # Let's do the manpage dance. It's just a jump to the left.
-    # And then a step to the right, with your hand on rm_f.
-    ["man1", "man3", "man5", "man7"].each do |man|
-      # Dirs must exist first: https://github.com/Homebrew/homebrew/issues/35969
-      mkdir_p HOMEBREW_PREFIX/"share/man/#{man}"
-      rm_f Dir[HOMEBREW_PREFIX/"share/man/#{man}/{npm.,npm-,npmrc.}*"]
-      ln_sf Dir[libexec/"npm/share/man/#{man}/npm*"], HOMEBREW_PREFIX/"share/man/#{man}"
-    end
-
-    npm_root = node_modules/"npm"
-    npmrc = npm_root/"npmrc"
-    npmrc.atomic_write("prefix = #{HOMEBREW_PREFIX}\n")
+    npm_post_install libexec
   end
 
   def caveats
     s = ""
 
     if build.with? "npm"
       s += <<-EOS.undent
-        If you update npm itself, do NOT use the npm update command.
-        The upstream-recommended way to update npm is:
+        npm has been installed. To update run
           npm install -g npm@latest
+
+        You can install global npm packages with
+          npm install -g <package>
+
+        They will install into the global node_modiles directory
+          /usr/local/lib/node_modules
+
+        Do NOT use the npm update command with global modules.
+        The upstream-recommended way to update global modules is:
+          npm install -g <package>@latest
       EOS
     else
       s += <<-EOS.undent
@@ -146,9 +124,7 @@ def caveats
       # make sure npm can find node
       ENV.prepend_path "PATH", opt_bin
       assert_equal which("node"), opt_bin/"node"
-      assert (HOMEBREW_PREFIX/"bin/npm").exist?, "npm must exist"
-      assert (HOMEBREW_PREFIX/"bin/npm").executable?, "npm must be executable"
-      system "#{HOMEBREW_PREFIX}/bin/npm", "--verbose", "install", "npm@latest"
+      npm_test_install
     end
   end
 end
diff --git a/Library/Homebrew/language/javascript.rb b/Library/Homebrew/language/javascript.rb
@@ -0,0 +1,58 @@
+module Language
+  module JS
+    def install_npm(path)
+      # make sure npm can find node
+      ENV.prepend_path "PATH", bin
+      # make sure user prefix settings in $HOME are ignored
+      ENV["HOME"] = buildpath/"home"
+      # set log level temporarily for npm's `make install`
+      ENV["NPM_CONFIG_LOGLEVEL"] = "verbose"
+
+      cd path do
+        system "./configure", "--prefix=#{libexec}/npm"
+        system "make", "install"
+      end
+    end
+
+    def install_npm_bash_completion (path)
+      bash_completion.install \
+          path/"lib/utils/completion.sh" => "npm"
+    end
+
+    def npm_post_install(libexec)
+      node_modules = HOMEBREW_PREFIX/"lib/node_modules"
+      node_modules.mkpath
+      npm_exec = node_modules/"npm/bin/npm-cli.js"
+      # Kill npm but preserve all other modules across node updates/upgrades.
+      rm_rf node_modules/"npm"
+
+      cp_r libexec/"npm/lib/node_modules/npm", node_modules
+      # This symlink doesn't hop into homebrew_prefix/bin automatically so
+      # remove it and make our own. This is a small consequence of our bottle
+      # npm make install workaround. All other installs **do** symlink to
+      # homebrew_prefix/bin correctly. We ln rather than cp this because doing
+      # so mimics npm's normal install.
+      ln_sf npm_exec, "#{HOMEBREW_PREFIX}/bin/npm"
+
+      # Let's do the manpage dance. It's just a jump to the left.
+      # And then a step to the right, with your hand on rm_f.
+      ["man1", "man3", "man5", "man7"].each do |man|
+        # Dirs must exist first: https://github.com/Homebrew/homebrew/issues/35969
+        mkdir_p HOMEBREW_PREFIX/"share/man/#{man}"
+        rm_f Dir[HOMEBREW_PREFIX/"share/man/#{man}/{npm.,npm-,npmrc.}*"]
+        ln_sf Dir[libexec/"npm/share/man/#{man}/npm*"], HOMEBREW_PREFIX/"share/man/#{man}"
+      end
+
+      npm_root = node_modules/"npm"
+      npmrc = npm_root/"npmrc"
+      npmrc.atomic_write("prefix = #{HOMEBREW_PREFIX}\n")
+    end
+
+    def npm_test_install
+      assert (HOMEBREW_PREFIX/"bin/npm").exist?, "npm must exist"
+      assert (HOMEBREW_PREFIX/"bin/npm").executable?, "npm must be executable"
+      system "#{HOMEBREW_PREFIX}/bin/npm", "--verbose", "install", "npm@latest"
+      system "#{HOMEBREW_PREFIX}/bin/npm", "--verbose", "install", "buffertools"
+    end
+  end
+end
