react_native_util 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bac5388f9ceda5e72b4a54c717f742c5a56c07f0a7b7489a9cac567469cfe728
-  data.tar.gz: aea447d8cf31bb2d9feb5b4eb42ec8d869071ced5036f722049fabd38f17b00b
+  metadata.gz: 7f874dfbe6f26ca09e59e9392f1e6591d09148b6a34aba766a41feea3bb2957e
+  data.tar.gz: 6ccfddce4c25414ef398924bb426dc0191851fb40c1ad6477e19f1eb3970b6cf
 SHA512:
-  metadata.gz: e3f3375ad84f084472f36eeac3ae9a6ce2a0fda11a88bb32055a45940c7c39919daea4c5056b75650c130e509f964751e3ae70aeac0b445ef886eefad8f6fc1f
-  data.tar.gz: 89fcadbf7b2e9db331dd7bab9e3d066a1e06b4c2bd9117560ba79b58c5b871a1a658bf6bbe7bcd5ff6f3d60330d23202e71a79d94b78caa76a8491334aef9179
+  metadata.gz: 798ac753cc2ca53970ee8def6a65f24159a69b300e1259864ee59bc9d888aed2323d282bf053e7a78dd9d57f1f4f267d56b471ab0e0bb02ea365aff2ff4e9f13
+  data.tar.gz: bfd1a390de9180aed09a3a7da175a938a25743c99233937b499a21eab4c04961d6d35553f1676c44af4f3db3b89705f762dbb377c434b55ff8d602365a5dfaf4

data/README.md

@@ -13,9 +13,13 @@ Community utility CLI for React Native projects.
 
 _macOS required_
 
+It's not necessary to install yarn or react-native-cli separately when
+installing from the Homebrew tap with `brew install jdee/tap/react_native_util`.
+They will be installed as required dependencies. If they are not present when
+running from RubyGems, the react_pod command will fail.
 ```bash
-brew install yarn # Not necessary if installing from Homebrew tap
-npm install -g react-native-cli
+brew install yarn
+brew install react-native-cli
 ```
 
 ## Installation
@@ -56,35 +60,35 @@ git status
 
 _Typical command output:_
 ```
-2019-05-12T11:42:03-07:00 react_native_util react_pod v0.2.2
-[✔] yarn install success in 10.9 s
-2019-05-12T11:42:14-07:00  Darwin 18.5.0 x86_64
-2019-05-12T11:42:14-07:00  Ruby 2.6.3: ~/.rvm/rubies/ruby-2.6.3/bin/ruby
-2019-05-12T11:42:14-07:00  RubyGems 3.0.3: ~/.rvm/rubies/ruby-2.6.3/bin/gem
-2019-05-12T11:42:14-07:00  Bundler 1.17.2: ~/.rvm/gems/ruby-2.6.3/bin/bundle
-2019-05-12T11:42:14-07:00  react-native-cli: /usr/local/bin/react-native
-2019-05-12T11:42:14-07:00   react-native-cli: 2.0.1
-2019-05-12T11:42:14-07:00   react-native: 0.59.8
-2019-05-12T11:42:15-07:00  yarn 1.16.0: /usr/local/bin/yarn
-2019-05-12T11:42:15-07:00  cocoapods 1.6.1: ~/.rvm/gems/ruby-2.6.3/bin/pod
-2019-05-12T11:42:15-07:00  cocoapods-core: 1.6.1
-2019-05-12T11:42:15-07:00 package.json:
-2019-05-12T11:42:15-07:00  app name: "TestApp"
-2019-05-12T11:42:15-07:00 Found Xcode project at ~/github/jdee/react_native_util/examples/TestApp/ios/TestApp.xcodeproj
-2019-05-12T11:42:15-07:00 Dependencies:
-2019-05-12T11:42:15-07:00  react-native-webview
-2019-05-12T11:42:15-07:00 Unlinking dependencies
-[✔] react-native unlink react-native-webview success in 0.7 s
-2019-05-12T11:42:16-07:00 Removing Libraries from TestApp
-2019-05-12T11:42:16-07:00 Removing Libraries from TestAppTests
-2019-05-12T11:42:16-07:00 Removing Libraries group
-2019-05-12T11:42:16-07:00 Generating ios/Podfile
-2019-05-12T11:42:16-07:00 Linking dependencies
+2019-05-12T15:37:50-07:00 react_native_util react_pod v0.3.0
+[✔] yarn install success in 7.2 s
+2019-05-12T15:37:57-07:00  Darwin 18.5.0 x86_64
+2019-05-12T15:37:57-07:00  Ruby 2.6.3: ~/.rvm/rubies/ruby-2.6.3/bin/ruby
+2019-05-12T15:37:57-07:00  RubyGems 3.0.3: ~/.rvm/rubies/ruby-2.6.3/bin/gem
+2019-05-12T15:37:57-07:00  Bundler 1.17.2: ~/.rvm/gems/ruby-2.6.3/bin/bundle
+2019-05-12T15:37:57-07:00  react-native-cli: /usr/local/bin/react-native
+2019-05-12T15:37:57-07:00   react-native-cli: 2.0.1
+2019-05-12T15:37:57-07:00   react-native: 0.59.8
+2019-05-12T15:37:58-07:00  yarn 1.16.0: /usr/local/bin/yarn
+2019-05-12T15:37:58-07:00  cocoapods 1.6.1: ~/.rvm/gems/ruby-2.6.3/bin/pod
+2019-05-12T15:37:58-07:00  cocoapods-core: 1.6.1
+2019-05-12T15:37:58-07:00 package.json:
+2019-05-12T15:37:58-07:00  app name: "TestApp"
+2019-05-12T15:37:58-07:00 Found Xcode project at ~/github/jdee/react_native_util/examples/TestApp/ios/TestApp.xcodeproj
+2019-05-12T15:37:58-07:00 Dependencies:
+2019-05-12T15:37:58-07:00  react-native-webview
+2019-05-12T15:37:58-07:00 Unlinking dependencies
+[✔] react-native unlink react-native-webview success in 0.6 s
+2019-05-12T15:37:59-07:00 Removing Libraries from TestApp
+2019-05-12T15:37:59-07:00 Removing Libraries from TestAppTests
+2019-05-12T15:37:59-07:00 Removing Libraries group
+2019-05-12T15:37:59-07:00 Generating ios/Podfile
+2019-05-12T15:37:59-07:00 Linking dependencies
 [✔] react-native link react-native-webview success in 0.5 s
-2019-05-12T11:42:17-07:00 Generating Pods project and ios/TestApp.xcworkspace
-[✔] pod install success in 8.2 s
-2019-05-12T11:42:25-07:00 Conversion complete ✅
-2019-05-12T11:42:25-07:00 $ open ios/TestApp.xcworkspace
+2019-05-12T15:37:59-07:00 Generating Pods project and ios/TestApp.xcworkspace
+[✔] pod install success in 12.2 s
+2019-05-12T15:38:12-07:00 Conversion complete ✅
+2019-05-12T15:38:12-07:00 $ open ios/TestApp.xcworkspace
 ```
 
 ## Rake task
@@ -112,6 +116,10 @@ ReactNativeUtil::Rake::ReactPodTask.new(
 require 'react_native_util/converter'
 
 Dir.chdir '/path/to/rn/project' do
-  ReactNativeUtil::Converter.new(repo_update: true).convert_to_react_pod!
+  begin
+    ReactNativeUtil::Converter.new(repo_update: true).convert_to_react_pod!
+  rescue ReactNativeUtil::BaseException => e
+    puts "Error from #convert_to_react_pod!: #{e.message}"
+  end
 end
 ```

data/lib/assets/templates/Podfile.erb

@@ -11,6 +11,9 @@ target '<%= app_name %>' do
     ]
   pod 'yoga', path: '../node_modules/react-native/ReactCommon/yoga'
   pod 'Folly', podspec: '../node_modules/react-native/third-party-podspecs/Folly.podspec'
+
+  # --- react-native link adds pods below this line. ---
+
 end
 
 <% if test_target %>

data/lib/react_native_util/converter.rb

@@ -2,49 +2,29 @@ require 'cocoapods-core'
 require 'erb'
 require 'json'
 require 'rubygems'
-require 'tmpdir'
-require 'tty/platform'
-require 'xcodeproj'
-require_relative 'util'
+require_relative 'project'
 
 module ReactNativeUtil
   # Class to perform conversion operations.
   class Converter
     include Util
 
-    # [Array<String>] Xcode projects from react-native that may be in the Libraries group
-    DEFAULT_DEPENDENCIES = %w[
-      ART
-      React
-      RCTActionSheet
-      RCTAnimation
-      RCTBlob
-      RCTCameraRoll
-      RCTGeolocation
-      RCTImage
-      RCTLinking
-      RCTNetwork
-      RCTPushNotification
-      RCTSettings
-      RCTTest
-      RCTText
-      RCTVibration
-      RCTWebSocket
-    ]
-
     # [String] Path to the Podfile template
     PODFILE_TEMPLATE_PATH = File.expand_path '../assets/templates/Podfile.erb', __dir__
 
+    REQUIRED_COMMANDS = [:yarn, 'react-native' => 'react-native-cli']
+
     # [Hash] Contents of ./package.json
     attr_reader :package_json
 
     # [String] Full path to Xcode project
     attr_reader :xcodeproj_path
 
-    # [Xcodeproj::Project] Contents of the project at xcodproj_path
-    attr_reader :xcodeproj
+    # [Project] Contents of the project at xcodeproj_path
+    attr_reader :project
 
     attr_reader :options
+    attr_reader :react_project
     attr_reader :react_podspec
 
     def initialize(repo_update: nil)
@@ -56,9 +36,27 @@ module ReactNativeUtil
       end
     end
 
-    # Convert project to use React pod
-    # @raise ConversionError on failure
+    # Convert project to use React pod. Expects the app's package.json in the
+    # current directory.
+    #
+    #     require 'react_native_util/converter'
+    #
+    #     Dir.chdir '/path/to/rn/project' do
+    #       begin
+    #         ReactNativeUtil::Converter.new(repo_update: true).convert_to_react_pod!
+    #       rescue ReactNativeUtil::BaseException => e
+    #         # All exceptions generated by this gem inherit from
+    #         # ReactNativeUtil::BaseException.
+    #         puts "Error from #convert_to_react_pod!: #{e.message}"
+    #       end
+    #     end
+    #
+    # @raise ConversionError on conversion failure
+    # @raise ExecutionError on generic command failure
+    # @raise Errno::ENOENT if a required command is not present
     def convert_to_react_pod!
+      validate_commands! REQUIRED_COMMANDS
+
       # Make sure no uncommitted changes
       check_repo_status!
 
@@ -75,7 +73,7 @@ module ReactNativeUtil
       load_xcodeproj!
       log "Found Xcode project at #{xcodeproj_path}"
 
-      if libraries_group.nil?
+      if project.libraries_group.nil?
         log "Libraries group not found in #{xcodeproj_path}. No conversion necessary."
         exit 0
       end
@@ -87,35 +85,37 @@ module ReactNativeUtil
         exit 1
       end
 
+      project.validate_app_target!
+
       load_react_podspec!
 
       # 2. Detect native dependencies in Libraries group.
       log 'Dependencies:'
-      dependencies.each { |d| log " #{d}" }
+      project.dependencies.each { |d| log " #{d}" }
 
       # Save for after Libraries removed.
-      deps_to_add = dependencies
+      deps_to_add = project.dependencies
 
       # 3. Run react-native unlink for each one.
       log 'Unlinking dependencies'
-      dependencies.each do |dep|
+      project.dependencies.each do |dep|
         run_command_with_spinner! 'react-native', 'unlink', dep, log: File.join(Dir.tmpdir, "react-native-unlink-#{dep}.log")
       end
 
       # reload after react-native unlink
       load_xcodeproj!
+      load_react_project!
 
       # 4a. Add Start Packager script
-      validate_app_target!
-      add_packager_script
+      project.add_packager_script_from react_project
 
       # Make a note of pod subspecs to replace Libraries group
       load_subspecs_from_libraries
 
       # 4b. Remove Libraries group from Xcode project.
-      remove_libraries_group_from_project!
+      project.remove_libraries_group
 
-      xcodeproj.save
+      project.save
 
       # 5. Generate boilerplate Podfile.
       generate_podfile!
@@ -207,8 +207,9 @@ module ReactNativeUtil
     # Load the project at @xcodeproj_path into @xcodeproj
     # @raise ConversionError on failure
     def load_xcodeproj!
-      @xcodeproj = nil # in case of exception on reopen
-      @xcodeproj = Xcodeproj::Project.open xcodeproj_path
+      @project = nil # in case of exception on reopen
+      @project = Project.open xcodeproj_path
+      @project.app_name = app_name
     rescue Errno::ENOENT
       raise ConversionError, "Failed to open #{xcodeproj_path}. File not found."
     rescue Xcodeproj::PlainInformative => e
@@ -226,72 +227,9 @@ module ReactNativeUtil
       # rubocop: enable Security/Eval
     end
 
-    # A representation of the Libraries group (if any) from the Xcode project.
-    # @return the Libraries group
-    def libraries_group
-      xcodeproj['Libraries']
-    end
-
-    # Remove the Libraries group from the xcodeproj in memory.
-    # Resets @libraries_group to nil as well.
-    def remove_libraries_group_from_project!
-      # Remove links against these static libraries
-      xcodeproj.targets.reject { |t| t.name =~ /-tvOS/ }.each do |t|
-        remove_libraries_from_target t
-      end
-
-      log 'Removing Libraries group'
-      libraries_group.remove_from_project
-    end
-
-    def remove_libraries_from_target(target)
-      log "Removing Libraries from #{target.name}"
-      to_remove = target.frameworks_build_phase.files.select do |file|
-        path = file.file_ref.pretty_print
-        next false unless /^lib(.+)\.a$/.match?(path)
-
-        static_libs.include?(path)
-      end
-
-      to_remove.each { |f| target.frameworks_build_phase.remove_build_file f }
-    end
-
-    # A list of external dependencies from NPM requiring react-native link.
-    # @return [Array<String>] a list of NPM package names
-    def dependencies
-      return [] if libraries_group.nil?
-
-      dependency_paths.map do |path|
-        # Find the root above the ios/*.xcodeproj under node_modules
-        root = File.expand_path '../..', path
-        File.basename root
-      end
-    end
-
-    # Paths to Xcode projects in the Libraries group from external deps.
-    # @return [Array<String>] a list of absolute paths to Xcode projects
-    def dependency_paths
-      return [] if libraries_group.nil?
-
-      paths = libraries_group.children.reject { |c| DEFAULT_DEPENDENCIES.include?(c.name.sub(/\.xcodeproj$/, '')) }.map(&:path)
-      paths.map { |p| File.expand_path p, File.join(Dir.pwd, 'ios') }
-    end
-
-    def library_roots
-      libraries_group.children.map do |library|
-        File.basename(library.path).sub(/\.xcodeproj$/, '')
-      end
-    end
-
-    # All static libraries from the Libraries group
-    # @return [Array<String>] an array of filenames
-    def static_libs
-      library_roots.map { |root| "lib#{root}.a" }
-    end
-
     def load_subspecs_from_libraries
-      roots = library_roots - %w[React]
-      @subspecs_from_libraries = roots.select { |r| DEFAULT_DEPENDENCIES.include?(r) }.map do |root|
+      roots = project.library_roots - %w[React]
+      @subspecs_from_libraries = roots.select { |r| Project::DEFAULT_DEPENDENCIES.include?(r) }.map do |root|
         case root
         when 'RCTLinking'
           'RCTLinkingIOS'
@@ -308,18 +246,11 @@ module ReactNativeUtil
     end
 
     def app_target
-      xcodeproj.targets.find { |t| t.name == app_name }
+      project.app_target
     end
 
     def test_target
-      xcodeproj.targets.select(&:test_target_type?).reject { |t| t.name =~ /tvOS/ }.first
-    end
-
-    # Validate an assumption about the project. TODO: Provide override option.
-    # @raise ConversionError if an application target is not found with the same name as the project.
-    def validate_app_target!
-      raise ConversionError, "Unable to find target #{app_name} in #{xcodeproj_path}." if app_target.nil?
-      raise ConversionError, "Target #{app_name} is not an application target." unless app_target.product_type == 'com.apple.product-type.application'
+      project.test_target
     end
 
     def podfile_path
@@ -353,55 +284,11 @@ module ReactNativeUtil
       raise ConversionError, 'Uncommitted changes in repo. Please commit or stash before continuing.'
     end
 
-    # Adds the Start Packager script from the React.xcodeproj under node_modules
-    # to the main application target before deleting React.xcodeproj from the
-    # Libraries group. Adjusts paths in the script to account for the different
-    # project location. If React.xcodeproj cannot be opened, or if the relevant
-    # build phase is not found, a warning is logged, and this step is skipped.
-    #
-    # TODO: The build phase is added after all other build phases. Ideally it
-    # can be moved to the beginning. The packager is independent of the Xcode
-    # build process. It may be started at any time. Starting it early is an
-    # optimization that allows it to load while the build is in progress.
-    # Currently it's possible to simply drag the build phase in Xcode to a
-    # higher position after running the react_pod command.
-    def add_packager_script
-      old_packager_phase = packager_phase_from_react_project
-      unless old_packager_phase
-        log 'Could not find packager build phase in React.xcodeproj. Skipping.'.yellow
-        return
-      end
-
-      # location of project is different relative to packager script
-      script = old_packager_phase.shell_script.gsub(%r{../scripts}, '../node_modules/react-native/scripts')
-
-      phase = app_target.new_shell_script_build_phase old_packager_phase.name
-      phase.shell_script = script
-    end
-
-    # Returns a Project object with the contents of the React.xcodeproj project
-    # from node_modules.
-    # @return [Xcodeproj::Project] a Project object with the contents of React.xcodeproj from node_modules
+    # Load the contents of the React.xcodeproj project from node_modules.
     # @raise Xcodeproj::PlainInformative in case of most failures
-    def react_project!
-      return @react_project if @react_project
-
-      path = libraries_group.children.find { |c| c.path =~ /React.xcodeproj/ }.real_path
-      @react_project = Xcodeproj::Project.open path
-    end
-
-    # Returns the original Start Packager build phase from the React.xcodeproj
-    # under node_modules. This contains the original script.
-    # @return the packager build phase if found
-    # @return nil if not found or React.xcodeproj cannot be opened
-    def packager_phase_from_react_project
-      react_project!.targets.first.build_phases.find { |p| p.name =~ /packager/i }
-    rescue Errno::ENOENT
-      log 'Could not open React.xcodeproj. File not found.'
-      nil
-    rescue Xcodeproj::PlainInformative => e
-      log "Could not open React.xcodeproj. #{e.message}"
-      nil
+    def load_react_project!
+      path = project.libraries_group.children.find { |c| c.path =~ /React.xcodeproj/ }.real_path
+      @react_project = Project.open path
     end
   end
 end

data/lib/react_native_util/exceptions.rb

@@ -1,13 +1,13 @@
 module ReactNativeUtil
   # Base class for exceptions from this gem
-  class ReactNativeUtilException < RuntimeError
+  class BaseException < RuntimeError
   end
 
   # Exception raised when command execution fails
-  class ExecutionError < ReactNativeUtilException
+  class ExecutionError < BaseException
   end
 
   # Generic conversion error
-  class ConversionError < ReactNativeUtilException
+  class ConversionError < BaseException
   end
 end

data/lib/react_native_util/metadata.rb

@@ -1,7 +1,7 @@
 # Conversion tools for React Native projects
 module ReactNativeUtil
   NAME = 'react_native_util'
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
   SUMMARY = 'Community utility CLI for React Native projects'
   DESCRIPTION = 'Automatically modifies a project created with react-native ' \
     'init to use the React pod from node_modules.'

data/lib/react_native_util/project.rb

@@ -0,0 +1,141 @@
+require 'xcodeproj'
+require_relative 'util'
+
+module ReactNativeUtil
+  class Project < Xcodeproj::Project
+    include Util
+
+    # [Array<String>] Xcode projects from react-native that may be in the Libraries group
+    DEFAULT_DEPENDENCIES = %w[
+      ART
+      React
+      RCTActionSheet
+      RCTAnimation
+      RCTBlob
+      RCTCameraRoll
+      RCTGeolocation
+      RCTImage
+      RCTLinking
+      RCTNetwork
+      RCTPushNotification
+      RCTSettings
+      RCTTest
+      RCTText
+      RCTVibration
+      RCTWebSocket
+    ]
+
+    attr_accessor :app_name
+
+    def app_target
+      targets.find { |t| t.name == app_name }
+    end
+
+    def test_target
+      targets.select(&:test_target_type?).reject { |t| t.name =~ /tvOS/ }.first
+    end
+
+    # Validate an assumption about the project. TODO: Provide override option.
+    # @raise ConversionError if an application target is not found with the same name as the project.
+    def validate_app_target!
+      raise ConversionError, "Unable to find target #{app_name} in #{path}." if app_target.nil?
+      raise ConversionError, "Target #{app_name} is not an application target." unless app_target.product_type == 'com.apple.product-type.application'
+    end
+
+    # A representation of the Libraries group (if any) from the Xcode project.
+    # @return the Libraries group
+    def libraries_group
+      self['Libraries']
+    end
+
+    # Remove the Libraries group from the xcodeproj in memory.
+    def remove_libraries_group
+      # Remove links against these static libraries
+      targets.reject { |t| t.name =~ /-tvOS/ }.each do |t|
+        remove_libraries_from_target t
+      end
+
+      log 'Removing Libraries group'
+      libraries_group.remove_from_project
+    end
+
+    def remove_libraries_from_target(target)
+      log "Removing Libraries from #{target.name}"
+      to_remove = target.frameworks_build_phase.files.select do |file|
+        path = file.file_ref.pretty_print
+        next false unless /^lib(.+)\.a$/.match?(path)
+
+        static_libs.include?(path)
+      end
+
+      to_remove.each { |f| target.frameworks_build_phase.remove_build_file f }
+    end
+
+    # A list of external dependencies from NPM requiring react-native link.
+    # @return [Array<String>] a list of NPM package names
+    def dependencies
+      return [] if libraries_group.nil?
+
+      dependency_paths.map do |path|
+        # Find the root above the ios/*.xcodeproj under node_modules
+        root = File.expand_path '../..', path
+        File.basename root
+      end
+    end
+
+    # Paths to Xcode projects in the Libraries group from external deps.
+    # @return [Array<String>] a list of absolute paths to Xcode projects
+    def dependency_paths
+      return [] if libraries_group.nil?
+
+      paths = libraries_group.children.reject { |c| DEFAULT_DEPENDENCIES.include?(c.name.sub(/\.xcodeproj$/, '')) }.map(&:path)
+      paths.map { |p| File.expand_path p, File.join(Dir.pwd, 'ios') }
+    end
+
+    def library_roots
+      libraries_group.children.map do |library|
+        File.basename(library.path).sub(/\.xcodeproj$/, '')
+      end
+    end
+
+    # Adds the Start Packager script from the React.xcodeproj under node_modules
+    # to the main application target before deleting React.xcodeproj from the
+    # Libraries group. Adjusts paths in the script to account for the different
+    # project location. If the relevant build phase is not found, a warning is
+    # logged, and this step is skipped.
+    #
+    # TODO: The build phase is added after all other build phases. Ideally it
+    # can be moved to the beginning. The packager is independent of the Xcode
+    # build process. It may be started at any time. Starting it early is an
+    # optimization that allows it to load while the build is in progress.
+    # Currently it's possible to simply drag the build phase in Xcode to a
+    # higher position after running the react_pod command.
+    def add_packager_script_from(react_project)
+      old_packager_phase = react_project.packager_phase
+      unless old_packager_phase
+        log 'Could not find packager build phase in React.xcodeproj. Skipping.'.yellow
+        return
+      end
+
+      # location of project is different relative to packager script
+      script = old_packager_phase.shell_script.gsub(%r{../scripts}, '../node_modules/react-native/scripts')
+
+      phase = app_target.new_shell_script_build_phase old_packager_phase.name
+      phase.shell_script = script
+    end
+
+    # All static libraries from the Libraries group
+    # @return [Array<String>] an array of filenames
+    def static_libs
+      library_roots.map { |root| "lib#{root}.a" }
+    end
+
+    # Returns the original Start Packager build phase (from the React.xcodeproj
+    # under node_modules). This contains the original script.
+    # @return the packager build phase if found
+    # @return nil if not found
+    def packager_phase
+      targets.first.build_phases.find { |p| p.name =~ /packager/i }
+    end
+  end
+end

data/lib/react_native_util/util.rb

@@ -1,4 +1,6 @@
 require 'colored'
+require 'tmpdir'
+require 'tty/platform'
 require 'tty/spinner'
 require_relative 'core_ext/io'
 require_relative 'core_ext/regexp'
@@ -90,5 +92,58 @@ module ReactNativeUtil
     def log(message)
       STDOUT.log message
     end
+
+    # Determine if a specific command is available.
+    #
+    # @param command [#to_s] A command to check for
+    # @return true if found, false otherwise
+    def have_command?(command)
+      # May be shell-dependent, OS-dependent
+      # Kernel#system does not raise Errno::ENOENT when running under the Bundler
+      !`which #{command}`.empty?
+    end
+
+    # Validate one or more commands. If the specified command is not
+    # available in the PATH (via which), a ConversionError is raised noting
+    # the package to be installed (from Homebrew, e.g.).
+    #
+    # When package names to be installed differ from command names, a Hash
+    # may be used. For example:
+    #    validate_commands! [:yarn, 'react-native' => 'react-native-cli']
+    #
+    # @param commands [Array, Hash, #to_s] one or more commands to be validated.
+    # @raise ConversionError if any command not found
+    def validate_commands!(commands)
+      errors = []
+
+      case commands
+      when Array
+        # Validate each command in the array, accumulating error messages
+        # if necessary.
+        commands.each do |c|
+          begin
+            validate_commands! c
+          rescue ConversionError => e
+            errors += e.message.split("\n")
+          end
+        end
+      when Hash
+        # Each key represents a command to check. The value is the package to
+        # install if missing.
+        commands.each do |key, value|
+          next if have_command?(key)
+
+          errors << "#{key} command not found. Please install #{value} to continue."
+        end
+      else
+        # commands is a single command to be validated. The package name is the
+        # same. Usually a symbol or a string, but only has to respond to #to_s.
+        errors << "#{commands} command not found. Please install #{commands} to continue." unless have_command? commands
+      end
+
+      return if errors.empty?
+
+      raise ConversionError, errors.join("\n")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_native_util
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Jimmy Dee
@@ -229,6 +229,7 @@ files:
 - lib/react_native_util/core_ext/string.rb
 - lib/react_native_util/exceptions.rb
 - lib/react_native_util/metadata.rb
+- lib/react_native_util/project.rb
 - lib/react_native_util/rake/react_pod_task.rb
 - lib/react_native_util/util.rb
 homepage: https://github.com/jdee/react_native_util