react_native_util 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44ea8dd51fe614a4e2783d13f25c4d9b3a07fe363817b0beae8e625419c5bfa2
-  data.tar.gz: 9cda19321bfb85e2ef98a45ec0c0837d72f54da09e4e9a85d094a1d6a6d19a4e
+  metadata.gz: ee275507e4938a754820b5f6f57ad9ea84c7a3776994678014466610ceed3eb8
+  data.tar.gz: 18b76367f8df90fd0cf53616e36f4935b88d2abc50dcb360e824517c28ec228c
 SHA512:
-  metadata.gz: 37d07a4d245c1eba1d5a359b254aee5f7c62c69b3c19884d3481d4c8546e1c34f293e89c68248ae91b087ce2c2ac74c0e136ebedbdb25cf4e43ed7a1843310bb
-  data.tar.gz: 165f4085612334cb8d1d89c1be685ededdac5f64ba176933d420b38a4ffe9a8475aaec18e690e2b3fdd2c2c201ea681de0dd640aac621a276c16276fa62cfe64
+  metadata.gz: f99663e838c47561e06e62ce2ad252461ad8e9d7ab99c3e416542bee174dd39205feb89c71cac49dfb0899dfc2e519593d99c595cee1afb73f00619e3edfb099
+  data.tar.gz: 498a37155945ca93d42c8de8dab9f7c77aea8eeec275b84e7e7bb1f92acc2bf980b0d4a34cdfb2a059a794c6b4820ec56e7f9d36b41e4de0e3b30640ee772ec2

data/README.md

@@ -62,3 +62,37 @@ Now do the conversion:
 rn react_pod
 git status
 ```
+
+_Typical command output:_
+```
+2019-05-11T12:06:17-07:00 react_native_util react_pod v0.2.0
+2019-05-11T12:06:17-07:00  Darwin 18.5.0 x86_64
+2019-05-11T12:06:17-07:00  Ruby 2.6.3: ~/.rvm/rubies/ruby-2.6.3/bin/ruby
+2019-05-11T12:06:17-07:00  RubyGems 3.0.3: ~/.rvm/rubies/ruby-2.6.3/bin/gem
+2019-05-11T12:06:17-07:00  Bundler 2.0.1: ~/.rvm/gems/ruby-2.6.3/bin/bundle
+2019-05-11T12:06:17-07:00  react-native-cli: /usr/local/bin/react-native
+2019-05-11T12:06:17-07:00   react-native-cli: 2.0.1
+2019-05-11T12:06:17-07:00   react-native: 0.59.8
+2019-05-11T12:06:18-07:00  yarn 1.16.0: /usr/local/bin/yarn
+2019-05-11T12:06:18-07:00  cocoapods 1.6.1: ~/.rvm/gems/ruby-2.6.3/bin/pod
+2019-05-11T12:06:18-07:00  cocoapods-core: 1.6.1
+2019-05-11T12:06:18-07:00 package.json:
+2019-05-11T12:06:18-07:00  app name: "TestApp"
+2019-05-11T12:06:18-07:00 Found Xcode project at ~/sandbox/TestApp/ios/TestApp.xcodeproj
+2019-05-11T12:06:18-07:00 Installing NPM dependencies with yarn
+[✔] yarn success in 0.8 s
+2019-05-11T12:06:19-07:00 Dependencies:
+2019-05-11T12:06:19-07:00  react-native-webview
+2019-05-11T12:06:19-07:00 Unlinking dependencies
+[✔] react-native unlink react-native-webview success in 0.5 s
+2019-05-11T12:06:20-07:00 Removing Libraries from TestApp
+2019-05-11T12:06:20-07:00 Removing Libraries from TestAppTests
+2019-05-11T12:06:20-07:00 Removing Libraries group
+2019-05-11T12:06:20-07:00 Generating ios/Podfile
+2019-05-11T12:06:20-07:00 Linking dependencies
+[✔] react-native link react-native-webview success in 0.5 s
+2019-05-11T12:06:20-07:00 Generating Pods project and ios/TestApp.xcworkspace
+[✔] pod install success in 7.4 s
+2019-05-11T12:06:28-07:00 Conversion complete ✅
+2019-05-11T12:06:28-07:00 $ open ios/TestApp.xcworkspace
+```

data/lib/react_native_util/cli.rb

@@ -1,4 +1,6 @@
+require 'cocoapods-core'
 require 'commander'
+require 'rubygems'
 require_relative 'converter'
 require_relative 'metadata'
 
@@ -22,15 +24,64 @@ module ReactNativeUtil
 
         c.action do |_args, opts|
           begin
+            report_configuration
             converter = Converter.new repo_update: opts.repo_update
             converter.convert_to_react_pod!
+            exit 0
+          rescue ExecutionError => e
+            # Generic command failure.
+            log e.message.red.bold
+            exit(-1)
           rescue ConversionError => e
-            log "Conversion failed: #{e.message}"
+            log "Conversion failed: #{e.message}".red.bold
+            exit(-1)
           end
         end
       end
 
       run!
     end
+
+    def report_configuration
+      log "#{NAME} react_pod v#{VERSION}".bold
+
+      log ' Installed from Homebrew' if ENV['REACT_NATIVE_UTIL_INSTALLED_FROM_HOMEBREW']
+
+      log " #{`uname -msr`}"
+
+      log " Ruby #{RUBY_VERSION}: #{RbConfig.ruby}"
+      log " RubyGems #{Gem::VERSION}: #{`which gem`}"
+      log " Bundler #{Bundler::VERSION}: #{`which bundle`}" if defined?(Bundler)
+
+      log_command_path 'react-native', 'react-native-cli', include_version: false
+      unless `which react-native`.empty?
+        react_native_info = `react-native --version`
+        react_native_info.split("\n").each { |l| log "  #{l}" }
+      end
+
+      log_command_path 'yarn'
+      log_command_path 'pod', 'cocoapods'
+
+      log " cocoapods-core: #{Pod::CORE_VERSION}"
+    rescue Errno::ENOENT
+      # On Windows, e.g., which and uname may not work.
+      log 'Conversion failed: macOS required.'.red.bold
+      exit(-1)
+    end
+
+    def log_command_path(command, package = command, include_version: true)
+      path = `which #{command}`
+      if path.empty?
+        log " #{package}: #{'not found'.red.bold}"
+        return
+      end
+
+      if include_version
+        version = `#{command} --version`.chomp
+        log " #{package} #{version}: #{path}"
+      else
+        log " #{package}: #{path}"
+      end
+    end
   end
 end

data/lib/react_native_util/converter.rb

@@ -1,5 +1,6 @@
 require 'erb'
 require 'json'
+require 'tmpdir'
 require 'tty/platform'
 require 'xcodeproj'
 require_relative 'util'
@@ -75,9 +76,16 @@ module ReactNativeUtil
         exit 0
       end
 
-      # Don't run yarn until we're sure we're proceeding,
+      if File.exist? podfile_path
+        log "Podfile already present at #{File.expand_path podfile_path}.".red.bold
+        log "A future release of #{NAME} may support integration with an existing Podfile."
+        log 'This release can only convert apps that do not currently use a Podfile.'
+        exit 1
+      end
+
+      # Don't run yarn until we're sure we're proceeding.
       log 'Installing NPM dependencies with yarn'
-      execute 'yarn'
+      run_command_with_spinner! 'yarn', log: File.join(Dir.tmpdir, 'yarn.log')
 
       # Unused, but should be there and parseable
       load_react_podspec!
@@ -90,8 +98,9 @@ module ReactNativeUtil
       deps_to_add = dependencies
 
       # 3. Run react-native unlink for each one.
+      log 'Unlinking dependencies'
       dependencies.each do |dep|
-        execute 'react-native', 'unlink', 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
@@ -113,14 +122,18 @@ module ReactNativeUtil
       generate_podfile!
 
       # 6. Run react-native link for each dependency.
+      log 'Linking dependencies'
       deps_to_add.each do |dep|
-        execute 'react-native', 'link', dep
+        run_command_with_spinner! 'react-native', 'link', dep, log: File.join(Dir.tmpdir, "react-native-link-#{dep}.log")
       end
 
       # 7. pod install
-      command = %w[pod install --silent]
+      log "Generating Pods project and ios/#{app_name}.xcworkspace"
+      command = %w[pod install]
       command << '--repo-update' if options[:repo_update]
-      execute(*command, chdir: 'ios')
+      run_command_with_spinner!(*command, chdir: 'ios', log: File.join(Dir.tmpdir, 'pod-install.log'))
+
+      log 'Conversion complete ✅'
 
       # 8. SCM/git (add, commit - optional)
 
@@ -253,10 +266,15 @@ module ReactNativeUtil
       raise ConversionError, "Target #{app_name} is not an application target." unless app_target.product_type == 'com.apple.product-type.application'
     end
 
+    def podfile_path
+      'ios/Podfile'
+    end
+
     # Generate a Podfile from a template.
     def generate_podfile!
+      log "Generating #{podfile_path}"
       podfile_contents = ERB.new(File.read(PODFILE_TEMPLATE_PATH)).result binding
-      File.open 'ios/Podfile', 'w' do |file|
+      File.open podfile_path, 'w' do |file|
         file.write podfile_contents
       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.1.3'
+  VERSION = '0.2.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/util.rb

@@ -1,4 +1,5 @@
 require 'colored'
+require 'tty/spinner'
 require_relative 'core_ext/io'
 require_relative 'core_ext/regexp'
 require_relative 'exceptions'
@@ -6,8 +7,27 @@ require_relative 'exceptions'
 module ReactNativeUtil
   # Module with utility methods
   module Util
-    # [TTY::Platform] Object with platform information
-    attr_reader :platform
+    # Executes a command with no output to the terminal. A spinner is displayed
+    # instead. Output may be directed to a file.
+    # @param command Variadic command to be executed
+    # @param log [String, Symbol, nil] Output for command (path, IO or a symbol such as :close)
+    # @param chdir [String, nil] Directory in which to execute the command
+    # @raise ExecutionError on failure
+    def run_command_with_spinner!(*command, log: nil, chdir: nil)
+      STDOUT.flush
+      STDERR.flush
+      spinner = TTY::Spinner.new "[:spinner] #{command.shelljoin}", format: :flip
+      spinner.auto_spin
+      start_time = Time.now
+      execute(*command, log: nil, output: log, chdir: chdir)
+      elapsed = Time.now - start_time
+      spinner.success "success in #{format('%.1f', elapsed)} s"
+    rescue ExecutionError
+      elapsed = Time.now - start_time
+      spinner.error "failure in #{format('%.1f', elapsed)} s"
+      STDOUT.log "See #{log} for details." if log && log.kind_of?(String)
+      raise
+    end
 
     # Execute the specified command. If output is non-nil, generate a log
     # at that location. Main log (open) is log.
@@ -24,7 +44,7 @@ module ReactNativeUtil
       options = chdir.nil? ? {} : { chdir: chdir }
       system(*command, options.merge(%i[err out] => output))
 
-      raise ExecutionError unless $?.success?
+      raise ExecutionError, "#{command.shelljoin}: #{$?}" unless $?.success?
 
       nil
     end
@@ -53,12 +73,16 @@ module ReactNativeUtil
       value.to_f
     end
 
+    # [TTY::Platform] Object with platform information
+    def platform
+      @platform ||= TTY::Platform.new
+    end
+
     # Convenience method to determine if running on a Mac.
     # @return true if running on a Mac
     # @return false otherwise
     def mac?
-      @platform ||= TTY::Platform.new
-      @platform.mac?
+      platform.mac?
     end
 
     # Wrapper for STDOUT.log

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_native_util
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jimmy Dee
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement