brew-npm 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2850b9951a49300b614825dacfff9a5424dc3295cc8473d3adb8bf64f1eddaa1
+  data.tar.gz: 1d9df669bce66f4dedef83a89abba92b35eb38eaddaa6e1099d5d2668853ecab
+SHA512:
+  metadata.gz: 4460702bdf8dadde0e8ebce7a9c7e43486127fc26f84aca76c3c6d5637e2fa792d8b3113d6d74830976be452e8ccb03ef0d766782f395416fb2c5a90f755a951
+  data.tar.gz: b8939506a5ba8efb0e091dade6bcaf30aa98e96d51c8ec2cdee58d0d0bf0ed564a8f087f5683c941f7d675ed53d6db7bb1728332f8ba2508fc9940a1bcc40d7a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/Gemfile.lock
+/vendor/bundle

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shuuuuuny+github@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in brew-npm.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 motoki-shun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# brew-npm
+
+`brew npm` allows you to install any npm packages as a homebrew formula.
+
+This project was forked from [sportngin/brew-gem](https://github.com/sportngin/brew-gem) and modified for npm.
+
+
+## Installation
+
+<!-- Via Rubygems:
+
+    gem install brew-npm
+    brew-npm install brew-npm -->
+
+Via Homebrew:
+
+    brew install shuuuuun/tap/brew-npm
+
+
+## Usage
+
+    brew npm install ${NPM_PACKAGE_NAME}
+
+To install a specific version:
+
+    brew npm install ${NPM_PACKAGE_NAME} ${VERSION}
+
+To upgrade:
+
+    brew npm upgrade ${NPM_PACKAGE_NAME}
+
+To uninstall:
+
+    brew npm uninstall ${NPM_PACKAGE_NAME}
+
+To check information:
+
+    brew npm info ${NPM_PACKAGE_NAME}
+
+Note:
+
+Installed packages are listed in `brew list` with prefix of `npm-`.
+
+
+## Philosophy
+
+This is not for installing development libraries, but for standalone binary tools that you want system wide.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shuuuuun/brew-npm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/shuuuuun/brew-npm/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Development
+
+- `bin/setup` to install dependencies.
+- `bin/console` for an interactive prompt that will allow you to experiment.
+- `exe/brew-npm` to exec CLI locally.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Code of Conduct
+
+Everyone interacting in the Brew::Npm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shuuuuun/brew-npm/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brew/npm"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brew-npm.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/brew/npm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brew-npm"
+  spec.version       = Brew::Npm::VERSION
+  spec.authors       = ["motoki-shun"]
+  spec.email         = ["shuuuuuny+github@gmail.com"]
+
+  spec.summary       = %q{Generate Homebrew formulas to install standalone npms.}
+  spec.description   = %q{This gem can be installed with "brew install brew-npm" and used to install gems with "brew npm install <npm>".}
+  spec.homepage      = "https://github.com/shuuuuun/brew-npm"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/shuuuuun/brew-npm"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/exe/brew-npm

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+BREW_NPM_HOME = File.expand_path("../..", __FILE__)
+$LOAD_PATH.unshift(File.join(BREW_NPM_HOME, "lib"))
+
+require "brew/npm"
+
+Brew::Npm::CLI.run(ARGV)

data/lib/brew/npm/cli.rb

@@ -0,0 +1,131 @@
+require "json"
+require "erb"
+require "tempfile"
+require "shellwords"
+
+module Brew::Npm::CLI
+  module_function
+
+  COMMANDS = {
+    "install"   => ("Install a brew npm, accepts an optional version argument\n" +
+                    "            (e.g. brew npm install <name> [version])"),
+    "upgrade"   => "Upgrade to the latest version of a brew npm",
+    "uninstall" => "Uninstall a brew npm",
+    "reinstall" => "Reinstall a brew npm",
+    "info"      => "Show information for an installed npm",
+    "formula"   => "Print out the generated formula for a npm",
+    "version"   => "Show version of brew-npm",
+    "help"      => "This message"
+  }
+
+  class Arguments
+    def initialize(args)
+      @args               = args
+      @args_without_flags = @args.reject {|a| a.start_with?("-") }
+    end
+
+    def command
+      @args_without_flags[0]
+    end
+
+    def npm
+      @args_without_flags[1]
+    end
+
+    def supplied_version
+      @args_without_flags[2]
+    end
+
+    def to_args
+      @args.reject {|a| a == npm || a == supplied_version }
+    end
+  end
+
+  def help_msg
+    (["Please specify a npm package name (e.g. brew npm command <name>)"] +
+      COMMANDS.map {|name, desc| "  #{name} - #{desc}"}).join("\n")
+  end
+
+  def fetch_version(name, version = nil)
+    npm_info = parse_json `npm info --json "#{name}"`
+    abort "Could not find a valid npm '#{name}'" if npm_info.nil?
+    version ||= npm_info["version"]
+    version
+  end
+
+  def parse_json(str)
+    JSON.parse(str)
+  rescue JSON::ParserError => err
+    STDERR.puts err
+    nil
+  end
+
+  def process_args(args)
+    arguments = Arguments.new(args)
+    command   = arguments.command
+    abort help_msg unless command
+    abort "unknown command: #{command}\n#{help_msg}" unless COMMANDS.keys.include?(command)
+
+    if command == 'help'
+      STDERR.puts help_msg
+      exit 0
+    end
+
+    if command == 'version'
+      STDERR.puts Brew::Npm::VERSION
+      exit 0
+    end
+
+    arguments
+  end
+
+  def homebrew_prefix
+    ENV["HOMEBREW_PREFIX"] || `brew --prefix`.chomp
+  end
+
+  def expand_formula(name, version)
+    klass           = "Npm" + name.capitalize.gsub(/[-_.\s@\/]([a-zA-Z0-9])/) { $1.upcase }.gsub('+', 'x')
+    sanitized_name  = sanitize_name(name)
+    user_npmrc      = "#{ENV['HOME']}/.npmrc"
+    template_file   = File.expand_path("../formula.rb.erb", __FILE__)
+    template        = ERB.new(File.read(template_file))
+    template.result(binding) # TODO: avoid binding. specify variables.
+  end
+
+  def with_temp_formula(name, version)
+    sanitized_name = sanitize_name(name)
+    filename = File.join Dir.tmpdir, "npm-#{sanitized_name}.rb"
+
+    open(filename, "w") do |f|
+      f.puts expand_formula(name, version)
+    end
+
+    yield filename
+  ensure
+    File.unlink filename
+  end
+
+  def run(args = ARGV)
+    arguments = process_args(args)
+    name      = arguments.npm
+    if name.nil?
+      STDERR.puts 'Package name is missing!'
+      STDERR.puts help_msg
+      exit 0
+    end
+    version   = fetch_version(name, arguments.supplied_version)
+    with_temp_formula(name, version) do |filename|
+      case arguments.command
+      when "formula"
+        $stdout.puts File.read(filename)
+      else
+        system "brew #{arguments.to_args.shelljoin} --formula #{filename}"
+        exit $?.exitstatus unless $?.success?
+      end
+    end
+  end
+
+  def sanitize_name(name)
+    name.gsub(%r{\A@}, '').gsub('/', '-') # for Scoped packages. https://docs.npmjs.com/cli/v8/using-npm/scope
+  end
+end

data/lib/brew/npm/formula.rb.erb

@@ -0,0 +1,77 @@
+# -*- ruby -*-
+
+require 'formula'
+require 'fileutils'
+require 'json'
+
+module NodeBin
+  def npm_bin
+    HOMEBREW_PREFIX/"bin/npm"
+  end
+end
+
+class NPMDownloadStrategy < AbstractDownloadStrategy
+  include NodeBin
+
+  def fetch
+    ohai "Fetching <%= name %> from npm source"
+    cache.cd do
+      ENV['NPM_CONFIG_CACHE'] = "#{cache}/npm_cache"
+      system "#{npm_bin}", "pack", "<%= name %>@#{npm_version}"
+    end
+  end
+
+  def cached_location
+    Pathname.new("#{cache}/<%= sanitized_name %>-#{npm_version}.tgz")
+  end
+
+  def cache
+    @cache ||= HOMEBREW_CACHE
+  end
+
+  def npm_version
+    return @version if defined?(@version) && @version
+    @version = @resource.version if defined?(@resource)
+    raise "Unable to determine version; did Homebrew change?" unless @version
+    @version
+  end
+
+  def clear_cache
+    cached_location.unlink if cached_location.exist?
+  end
+end
+
+class <%= klass %> < Formula
+  include NodeBin
+
+  url "<%= name %>", :using => NPMDownloadStrategy
+  version "<%= version %>"
+  depends_on "node"
+
+  def install
+    # Use /usr/local/bin at the front of the path instead of Homebrew shims,
+    # which mess with Ruby's own compiler config when building native extensions
+    if defined?(HOMEBREW_SHIMS_PATH)
+      ENV['PATH'] = ENV['PATH'].sub(HOMEBREW_SHIMS_PATH.to_s, '/usr/local/bin')
+    end
+
+    FileUtils.cd(prefix)
+
+    system "#{npm_bin}", "install", cached_download
+    raise "npm install '<%= name %>' failed with status #{$?.exitstatus}" unless $?.success?
+
+    bin.rmtree if bin.exist?
+    bin.mkpath
+
+    package_path = "#{prefix}/node_modules/<%= name %>"
+    package_json = JSON.parse(File.read(File.join(package_path, 'package.json'))) rescue nil
+    if package_json && package_json['bin']
+      bin_paths = package_json['bin'].is_a?(Hash) ? package_json['bin'] : { package_json['name'] => package_json['bin'] }
+      bin_paths.each do |name, relative_path|
+        FileUtils.symlink(File.join(package_path, relative_path), File.join(bin, name))
+      end
+    else
+      FileUtils.symlink(Dir.glob("#{package_path}/bin/*"), bin)
+    end
+  end
+end

data/lib/brew/npm/version.rb

@@ -0,0 +1,5 @@
+module Brew
+  module Npm
+    VERSION = "0.3.0"
+  end
+end

data/lib/brew/npm.rb

@@ -0,0 +1,9 @@
+require "brew/npm/version"
+require "brew/npm/cli"
+
+module Brew
+  module Npm
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: brew-npm
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- motoki-shun
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-22 00:00:00.000000000 Z
+dependencies: []
+description: This gem can be installed with "brew install brew-npm" and used to install
+  gems with "brew npm install <npm>".
+email:
+- shuuuuuny+github@gmail.com
+executables:
+- brew-npm
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brew-npm.gemspec
+- exe/brew-npm
+- lib/brew/npm.rb
+- lib/brew/npm/cli.rb
+- lib/brew/npm/formula.rb.erb
+- lib/brew/npm/version.rb
+homepage: https://github.com/shuuuuun/brew-npm
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/shuuuuun/brew-npm
+  source_code_uri: https://github.com/shuuuuun/brew-npm
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Generate Homebrew formulas to install standalone npms.
+test_files: []