react_native_util 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6db3f0bd398429fdfe2b21315c6fbf4c0e269d1c2194d3b4c0db07339ae03921
-  data.tar.gz: '08a734aa93a6bb080eb7fd63f932165a5fd3a4652f847cf2b5d74c03ee557df5'
+  metadata.gz: ec7faa11d4e1299c289b1fb7f155068749610da6c8c82c38a832bf71931a1c06
+  data.tar.gz: 4e84dd8004655ba30919db3fcf9af3fdb06b7e15bacd0bf77b9169abdc6afcd6
 SHA512:
-  metadata.gz: c20af6ddf47bf1f33d6a2239b1495744aa51b494b7c0e17ac0d02f0bf5972a45f527f81d20e230b539206cb4e1cf913fcd66f4eecdc3d3271eabc0f21ec3a2b2
-  data.tar.gz: 8052d6b6998484502602087f15dc62d1b8eda7ad6f74e6f8868ea7490be2cd4e4dcfa6e793bc81be62d47fd3784a9e06c472096337652f5330b102ccc81959e6
+  metadata.gz: b7da0570c0270088031c9666b1ef8b2b34e41bb08df9b3f8b7442612ddea5e450832d04380d2a739e77263b450782a263561b20fb90b50459b075be8a902bf8c
+  data.tar.gz: 8ee1632015a0c50e1e1722772c0bb67239d030f8cd0300decd14ec56162c5571adfe67fa3f0a26d753e4efb27a97ce11cf312445edbf0070498418463f39c29c

data/README.md

@@ -72,6 +72,35 @@ rn -h
 rn react_pod -h
 ```
 
+## react_pod command
+
+Converts a React Native Xcode project to use the React pod from node_modules
+instead of the projects in the Libraries group. This makes it easier to manage
+native dependencies while preserving compatibility with `react-native link`.
+The command looks for your app's package.json in the current directory and
+expects your Xcode project to be located under the ios subdirectory and have
+the name specified for your app in package.json. If a Podfile is found in the
+ios subdirectory, the conversion will fail.
+
+The React.xcodeproj in the Libraries group of a project created by
+`react-native init` automatically starts the Metro packager via a Run Script
+build phase. When the react_pod command removes the Libraries group from your
+app project, it adds an equivalent build phase to your app project so that the
+packager will automatically be started when necessary by Xcode.
+
+Use the `-u` or `--update` option to update the packager script after
+updating React Native, in case the packager script on the React.xcodeproj changes
+after it's removed from your project.
+
+### Options
+
+|option|description|env. var.|
+|------|-----------|---------|
+|-h, --help|Print command help||
+|-t, --trace|Print a stack trace in case of error||
+|-u, --update|Update a previously converted project||
+|--[no-]repo-update|Don't update the local podspec repo|REACT_NATIVE_UTIL_REPO_UPDATE|
+
 ## Try it out
 
 Convert examples/TestApp.
@@ -99,7 +128,7 @@ git status
 
 _Typical command output:_
 ```
-2019-05-14T12:30:50-07:00 react_native_util react_pod v0.4.0
+2019-05-14T12:30:50-07:00 react_native_util react_pod v0.5.0
 2019-05-14T12:30:52-07:00  Darwin 18.5.0 x86_64
 2019-05-14T12:30:52-07:00  Ruby 2.3.7: ~/.rvm/rubies/ruby-2.3.7/bin/ruby
 2019-05-14T12:30:52-07:00  RubyGems 3.0.3: ~/.rvm/rubies/ruby-2.3.7/bin/gem
@@ -151,6 +180,7 @@ require 'react_native_util/rake'
 ReactNativeUtil::Rake::ReactPodTask.new(
   :react_pod,                         # task name
   'Convert project to use React pod', # description
+  'Update project',                   # description for :update task
   chdir: '/path/to/rn/project',       # path to project package.json
   repo_update: true                   # optionally disable pod repo update
 )
@@ -161,6 +191,16 @@ Override `chdir` at the command line:
 rake react_pod[/path/to/another/rn/project]
 ```
 
+Convert project:
+```bash
+rake react_pod
+```
+
+Update converted project:
+```bash
+rake react_pod:update
+```
+
 ## Ruby script
 
 ```Ruby
@@ -168,7 +208,13 @@ require 'react_native_util/converter'
 
 Dir.chdir '/path/to/rn/project' do
   begin
-    ReactNativeUtil::Converter.new(repo_update: true).convert_to_react_pod!
+    converter = ReactNativeUtil::Converter.new(repo_update: true)
+
+    # Convert a project to use the React pod
+    converter.convert_to_react_pod!
+
+    # Update a converted project
+    converter.update_project!
   rescue ReactNativeUtil::BaseException => e
     puts "Error from #convert_to_react_pod!: #{e.message}"
   end

data/lib/react_native_util/cli.rb

@@ -17,22 +17,45 @@ for more information.
 DESC
 
       command :react_pod do |c|
-        c.syntax = "#{NAME} react_pod [OPTIONS]"
+        c.syntax = "#{NAME} react_pod [OPTIONS]\n    rn react_pod [OPTIONS]"
         c.summary = 'Convert a React Native app to use the React pod from node_modules.'
         c.description = <<DESC
-[Work in progress] Converts a project created with <%= color 'react-native init', BOLD %> to use
-CocoaPods with the React pod from node_modules. This preserves compatibility
-with <%= color 'react-native link', BOLD %>. A converted project will still start the Metro packager
-automatically via a Run Script build phase in the Xcode project. This is an
-alternative to performing manual surgery on a project in Xcode.
+Converts a React Native Xcode project to use the React pod from node_modules
+instead of the projects in the Libraries group. This makes it easier to manage
+native dependencies while preserving compatibility with <%= color 'react-native link', BOLD %>.
+The command looks for your app's package.json in the current directory and
+expects your Xcode project to be located under the ios subdirectory and have
+the name specified for your app in package.json. If a Podfile is found in the
+ios subdirectory, the conversion will fail.
+
+The React.xcodeproj in the Libraries group of a project created by
+<%= color 'react-native init', BOLD %> automatically starts the Metro packager via a Run Script
+build phase. When the react_pod command removes the Libraries group from your
+app project, it adds an equivalent build phase to your app project so that the
+packager will automatically be started when necessary by Xcode.
+
+Use the <%= color '-u', BOLD %> or <%= color '--update', BOLD %> option to update the packager script after
+updating React Native, in case the packager script on the React.xcodeproj changes
+after it's removed from your project.
 DESC
 
+        c.option '-u', '--update', 'Update a previously converted project (default: convert)'
         c.option '--[no-]repo-update', 'Update the local podspec repo (default: update; env. var. REACT_NATIVE_UTIL_REPO_UPDATE)'
 
+        c.examples = {
+          'Convert an app project' => 'rn react_pod',
+          'Convert an app project without updating the podspec repo' => 'rn react_pod --no-repo-update',
+          'Update a converted project' => 'rn react_pod -u'
+        }
+
         c.action do |_args, opts|
           begin
             converter = Converter.new repo_update: opts.repo_update
-            converter.convert_to_react_pod!
+            if opts.update
+              converter.update_project!
+            else
+              converter.convert_to_react_pod!
+            end
             exit 0
           rescue ExecutionError => e
             # Generic command failure.

data/lib/react_native_util/converter.rb

@@ -55,27 +55,11 @@ module ReactNativeUtil
     # @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!
-
-      report_configuration!
-
-      raise ConversionError, "macOS required." unless mac?
-
-      load_package_json!
-      log 'package.json:'
-      log " app name: #{app_name.inspect}"
-
-      # 1. Detect project. TODO: Add an option to override.
-      @xcodeproj_path = File.expand_path "ios/#{app_name}.xcodeproj"
-      load_xcodeproj!
-      log "Found Xcode project at #{xcodeproj_path}"
+      startup!
 
       if project.libraries_group.nil?
         log "Libraries group not found in #{xcodeproj_path}. No conversion necessary."
-        exit 0
+        return
       end
 
       if File.exist? podfile_path
@@ -85,19 +69,17 @@ module ReactNativeUtil
         exit 1
       end
 
-      project.validate_app_target!
-
       # Not used at the moment
       # load_react_podspec!
 
-      # 2. Detect native dependencies in Libraries group.
+      # 1. Detect native dependencies in Libraries group.
       log 'Dependencies:'
       project.dependencies.each { |d| log " #{d}" }
 
       # Save for after Libraries removed.
       deps_to_add = project.dependencies
 
-      # 3. Run react-native unlink for each one.
+      # 2. Run react-native unlink for each one.
       log 'Unlinking dependencies'
       project.dependencies.each do |dep|
         run_command_with_spinner! 'react-native', 'unlink', dep, log: File.join(Dir.tmpdir, "react-native-unlink-#{dep}.log")
@@ -107,23 +89,23 @@ module ReactNativeUtil
       load_xcodeproj!
       load_react_project!
 
-      # 4. Add Start Packager script
+      # 3. Add Start Packager script
       project.add_packager_script_from react_project
 
-      # 5. Generate boilerplate Podfile.
+      # 4. Generate boilerplate Podfile.
       generate_podfile!
 
-      # 6. Remove Libraries group from Xcode project.
+      # 5. Remove Libraries group from Xcode project.
       project.remove_libraries_group
       project.save
 
-      # 7. Run react-native link for each dependency (adds to Podfile).
+      # 6. Run react-native link for each dependency (adds to Podfile).
       log 'Linking dependencies'
       deps_to_add.each do |dep|
         run_command_with_spinner! 'react-native', 'link', dep, log: File.join(Dir.tmpdir, "react-native-link-#{dep}.log")
       end
 
-      # 8. pod install
+      # 7. pod install
       log "Generating Pods project and ios/#{app_name}.xcworkspace"
       command = %w[pod install]
       command << '--repo-update' if options[:repo_update]
@@ -131,10 +113,76 @@ module ReactNativeUtil
 
       log 'Conversion complete ✅'
 
-      # 9. Open workspace/build
+      # 8. Open workspace/build
       execute 'open', File.join('ios', "#{app_name}.xcworkspace")
 
-      # 10. TODO: SCM/git (add, commit - optional)
+      # 9. TODO: SCM/git (add, commit - optional)
+    end
+
+    def update_project!
+      startup!
+
+      unless project.libraries_group.nil?
+        raise ConversionError, "Libraries group present in #{xcodeproj_path}. Conversion necessary. Run rn react_pod without -u."
+      end
+
+      unless File.exist? podfile_path
+        raise ConversionError, "#{podfile_path} not found. Conversion necessary. Run rn react_pod without -u."
+      end
+
+      log "Updating project at #{xcodeproj_path}"
+
+      # Check/update the contents of the packager script in React.xcodeproj
+      load_react_project!
+
+      current_script_phase = project.packager_phase
+
+      # Not an error. User may have removed it.
+      log "Packager build phase not found in #{xcodeproj_path}. Not updating.".yellow and return if current_script_phase.nil?
+
+      new_script_phase = react_project.packager_phase
+      # Totally unexpected. Exception. TODO: This is not treated as an error on conversion. Probably should be.
+      raise ConversionError, "Packager build phase not found in #{react_project.path}." if new_script_phase.nil?
+
+      new_script = new_script_phase.shell_script.gsub %r{../scripts}, '../node_modules/react-native/scripts'
+
+      if new_script == current_script_phase.shell_script && new_script_phase.name == current_script_phase.name
+        log "#{current_script_phase.name} build phase up to date. ✅"
+        return
+      end
+
+      log 'Updating packager phase.'
+      log " Current name: #{current_script_phase.name}"
+      log " New name    : #{new_script_phase.name}"
+
+      current_script_phase.name = new_script_phase.name
+      current_script_phase.shell_script = new_script
+
+      project.save
+
+      log "Updated #{xcodeproj_path} ✅"
+    end
+
+    def startup!
+      validate_commands! REQUIRED_COMMANDS
+
+      # Make sure no uncommitted changes
+      check_repo_status!
+
+      report_configuration!
+
+      raise ConversionError, "macOS required." unless mac?
+
+      load_package_json!
+      log 'package.json:'
+      log " app name: #{app_name.inspect}"
+
+      # Detect project. TODO: Add an option to override.
+      @xcodeproj_path = File.expand_path "ios/#{app_name}.xcodeproj"
+      load_xcodeproj!
+      log "Found Xcode project at #{xcodeproj_path}"
+
+      project.validate_app_target!
     end
 
     # Read the contents of ./package.json into @package_json

data/lib/react_native_util/core_ext/io.rb

@@ -1,3 +1,4 @@
+require 'colored'
 require 'shellwords'
 require 'time'
 require_relative 'string'

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.4.0'
+  VERSION = '0.5.0'
   SUMMARY = 'Community utility CLI for React Native projects'
   DESCRIPTION = 'Converts a project created with react-native init to use CocoaPods with the ' \
                 'React pod from node_modules. This preserves compatibility with ' \

data/lib/react_native_util/rake/react_pod_task.rb

@@ -16,8 +16,9 @@ module ReactNativeUtil
       def initialize(
         name = :react_pod,
         description = 'Convert project to use React pod',
+        update_description = 'Update project',
         chdir: '.',
-        repo_update: boolean_env_var?(:REACT_NATIVE_UTIL_REPO_UPDATE)
+        repo_update: boolean_env_var?(:REACT_NATIVE_UTIL_REPO_UPDATE, default_value: true)
       )
         desc description
         task name, %i[path] do |_task, opts|
@@ -26,6 +27,14 @@ module ReactNativeUtil
             Converter.new(repo_update: repo_update).convert_to_react_pod!
           end
         end
+
+        desc update_description
+        task "#{name}:update", %i[path] do |_task, opts|
+          project_dir = opts[:path] || chdir
+          Dir.chdir project_dir do
+            Converter.new(repo_update: repo_update).update_project!
+          end
+        end
       end
     end
   end

data/lib/react_native_util/util.rb

@@ -1,4 +1,3 @@
-require 'colored'
 require 'tmpdir'
 require 'tty/platform'
 require 'tty/spinner'
@@ -18,15 +17,16 @@ module ReactNativeUtil
     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"
+
+      spinner.success "success in #{elapsed_from start_time} s"
     rescue ExecutionError
-      elapsed = Time.now - start_time
-      spinner.error "failure in #{format('%.1f', elapsed)} s"
+      spinner.error "failure in #{elapsed_from start_time} s"
       STDOUT.log "See #{log} for details." if log && log.kind_of?(String)
       raise
     end
@@ -51,6 +51,10 @@ module ReactNativeUtil
       nil
     end
 
+    def elapsed_from(time)
+      format('%.1f', Time.now - time)
+    end
+
     # Return a Boolean value associated with an environment variable.
     #
     # @param var [#to_s] The name of an environment variable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_native_util
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jimmy Dee