cocoapods-ybin 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0956fbf69eeb9ae7c39bc7f954a4fbdeb3b30ce0ebb8cb16c8fdf9b7fe00e233'
-  data.tar.gz: 8e43d906a2418b1f42bdc147312cbefa4ae4cb34e968d0db1f96f49cf2d83fbc
+  metadata.gz: e40278d03a980ab09c6e027ecc4b32f3d56fccf7263c4e32dda65c3665f2c8a3
+  data.tar.gz: 3cc644f8bfb358c543e7ab6cf1ab571fc522856e3c15185365d83ab73f7c9330
 SHA512:
-  metadata.gz: 26e76f4cc63e0156a16ee35503906378cd04e3960bd0905ec2c594f975217ad749c691bd13c17761f5ccd6a0985a6dd8c1ec675e0b050a8dc27d550619d85750
-  data.tar.gz: 6257cfdb02d6b936280258955596922d4923de54936cc0a5b0ba252643001d434d68e529b1661da0a2a3bf971c76a1c1fcd4ae3ea55c28422d0d1deaa289885e
+  metadata.gz: 5a4b1537ab50147be6a0e6df71f22260714b59619b46ffbc0980b9cf24aab53f98c1cdc32abe1d0e9d030da9fff669e1925d8ac21412edcfc54bcd19c629a5d2
+  data.tar.gz: 11a6ba2e42caef75685fbca58731eb85a5f3e26f7976c02bf6ac3b503cf077540130bb7a0d38c0d3d7ce1dfd944f460adf788fe56fbb31600f10cfe4c9293d28

data/README.md

@@ -1,15 +1,110 @@
 [![Gem Version](https://badge.fury.io/rb/cocoapods-ybin.svg)](https://badge.fury.io/rb/cocoapods-ybin)
 
-# cocoapods-ybin
+# 一、背景
 
-The binary library and source code mapping, to achieve breakpoints automatically jump into the corresponding source code for debugging the application.
+  随着项目业务的不断迭代和新增，每个业务线负责不同的功能模块，组件化势必是需要进行的工作。业界内，无论是哪种组件化方案，目的是一样的，分离业务和功能。
 
-## Installation
+  组件化虽好，但是组件化只是将不同的业务分离或者不同的功能分离和分层，实际上还是在一个代码池里每次 **build** 需要进行编译、汇编、链接等过程。每次编译的占用的时间还是挺奢侈的，在编译速度上并没有提升。**pod install** 来回切换二进制和源码也更是一件可行不可取的开发模式。
 
-    $ gem install cocoapods-ybin
+  **cocoapods-ybin** 解决二进制和源码之间的映射问题，无需来回切换源码，实现二进制断点可进入源码进行调试。实现原理是简单的，但区别于 **Android** 里的 **aar** 或 **jar** 内的 Class 文件。
 
-## Usage
+**cocoapods-ybin** 满足以下几个诉求考虑实现：
 
-    $ pod ybin --help
+- **小而好用、低成本接入**
+- **与二进制库的制作和存储无关，只需二进制库和源码存储位置即可映射**
+- **同时支持多项目并行开发**
+- **只存储一份源码**
+- **无需频繁的 clone 代码**
+
+# 二、先睹为快
+
+**cocoapods-ybin-demo** 示例效果视频，[示例代码地址](https://github.com/monetking/cocoapods-ybin-demo.git)
+
+<video id="video" width="756" height="426" controls="" preload="none" poster="https://img.58cdn.com.cn/dist/rn/course/ybin_demo_cover.png">
+      <source id="mp4" src="https://img.58cdn.com.cn/dist/rn/course/ybin_demo_small.mp4" type="video/mp4">
+      </video>
+
+# 三、安装
+
+## 3.1 直接安装
+
+```bash
+$ sudo gem install cocoapods-ybin
+```
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif1jwrswjj30v608owfm.jpg)
+
+## 3.2 使用 Gemfile 管理 pod 版本
+
+添加 **cocoapods-ybin** 到 Gemfile 文件
+
+```ruby
+gem 'cocoapods-ybin'
+```
+
+## 3.3 安装校验
+
+执行命令 **pod --help** 查看当前 pod 版本 **ybin** 是否安装成功。
+
+```bash
+$ pod --help
+```
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif1oynpxyj312e0u07bm.jpg)
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif1zrynuhj30s60f8gn8.jpg)
+
+# 四、使用教程
+
+
+打开示例项目 **ocoapods-ybin-demo** [示例代码](https://github.com/monetking/cocoapods-ybin-demo.git) 的 Podfile 目录。示例项目使用了 **Bundler** 对 pod 的版本进行了控制，实际项目根据所需选择是否采用，与本插件无关联，请酌情选择。
+
+## 4.1 执行二进制和源码映射指令
+
+```bash
+$ pod ybin link 二进制库名称
+```
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif1sqf7erj317r0u044q.jpg)
+
+## 4.2 查看已映射列表
+
+```bash
+$ pod ybin link --list
+```
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif21izjaxj30xq09k0uh.jpg)
+
+## 4.3 删除某个或多个源码映射
+
+```bash
+$ pod ybin link --remove 二进制库名称1 二进制库名称2
+```
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif22c9z9gj313a0dewgy.jpg)
+
+## 4.4 删除所有源码映射
+
+```bash
+$ pod ybin link --remove-all
+```
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif23vf5mzj30xq0fadhy.jpg)
+
+## 4.5 查询项目使用 Pod 管理的版本
+
+查询项目通过Pod管理的组件库版本号，一般都是 cat Podfile.lock 文件，目视解析版本及依赖版本。阅读起来非常不友好，使用插件 **--lib-version** 扩展即可快速查看 Pod 管理的版本。
+
+```bash
+$ pod ybin link --lib-version
+```
+
+![](https://tva1.sinaimg.cn/large/007S8ZIlly1gif25icgfjj30xq0cmtay.jpg)
+
+# 五、期待
+
+- 如果在使用过程中遇到Bug，希望您能Issues我，谢谢(或者尝试下载使用最新版本看看Bug修复没有)
+- 如果在使用过程中发现功能不够用，希望你能Issues我，非常想为这个工具增加更多好用的功能，谢谢
+- 如果你想为cocoapods-ybin输出代码，请拼命Pull Requests我
 
 

data/lib/cocoapods-ybin/command/ybin/link.rb

@@ -11,7 +11,7 @@ module Pod
         DESC
 
         self.arguments = [
-              CLAide::Argument.new('NAME', false)
+              CLAide::Argument.new('LIB_NAME', false)
         ]
         def self.options
           [
@@ -74,11 +74,11 @@ module Pod
         def linkLibSource
 
           if @names.nil?
-            UI.puts "[Error] 请输入需要映射的组件库. 示例: $ pod ybin foo\n".red
+            UI.puts "[Error] 请输入需要映射的组件库. 示例: $ pod ybin link foo\n".red
             return
           else
             if @names.count > 1
-              UI.puts "[Error] 不支持一次映射多个源码. 示例: $ pod ybin foo\n".red
+              UI.puts "[Error] 不支持一次映射多个源码. 示例: $ pod ybin link foo\n".red
               return
             end
           end
@@ -101,8 +101,16 @@ module Pod
           config = config_with_asker
           lib_path = config["libPath"]
           sourcePath = config["sourcePath"]
+          lib_name = source_lib_name(lib_path)
+
+          lib_real_path = ""
+          if Pathname.new(lib_path).extname == ".framework"
+            lib_real_path = "#{lib_path}/#{lib_name}"
+          elsif Pathname.new(lib_path).extname == ".a"
+            lib_real_path = lib_path
+          end
 
-          if lib_path == "" || !File.exist?(lib_path)
+          if lib_real_path == "" || !File.exist?(lib_real_path)
             UI.puts "\n[Error] 二进制文件不存在, 请检查文件位置!\n".red
             return
           end
@@ -112,23 +120,25 @@ module Pod
             return
           end
 
-          lib_name = source_lib_name(lib_path)
-          link_source_code(lib_path, sourcePath, lib_name)
+          link_source_code(lib_real_path, sourcePath, lib_name)
         end
 
         def link_source_code(lib_path, sourcePath, lib_name)
 
           comp_dir_path = `dwarfdump "#{lib_path}" | grep "AT_comp_dir" | head -1 | cut -d \\" -f2`
           if comp_dir_path == nil || comp_dir_path == ""
-            UI.puts "\n[Error] #{lib_name} 不支持映射源码库\n".red
+            UI.puts "\n[Error] #{lib_name} 不支持映射源码\n".red
             return
           end
 
           lib_debug_path = comp_dir_path.chomp.strip
-          if File.exist?(lib_debug_path) || File.directory?(lib_debug_path) || File.symlink?(lib_debug_path)
-            print "源码文件: #{lib_debug_path} 已存在，无法源码映射，防止误删请检查:"
-            UI.puts "\n1、源码已映射，无需重复映射 \n2、开发源码(无需映射，即可调试) \n3、其他重复文件, 请手动移动/移除\n".red
-
+          if File.exist?(lib_debug_path) || File.directory?(lib_debug_path)
+            if File.symlink?(lib_debug_path)
+              print "源码映射已存在, 无法重复映射，请删除后重新映射: #{lib_debug_path}"
+            else
+              print "源码映射目录已存在, 请检查 #{lib_debug_path} 目录(可能存在以下情况):"
+              UI.puts "\n1、开发源码(无需映射，即可调试) \n2、其他重复文件, 请手动移动/移除\n".red
+            end
           else
 
             begin
@@ -144,11 +154,7 @@ module Pod
             end
 
             FileUtils.rm_rf(lib_debug_path)
-            if Pathname.new(lib_path).extname == ".a"
-              `ln -s #{sourcePath} #{lib_debug_path}`
-            else
-              `ln -s #{sourcePath} #{lib_debug_path}/#{lib_name}`
-            end
+            File.symlink(sourcePath, lib_debug_path)
             check_linked(lib_path, lib_debug_path, lib_name)
           end
         end
@@ -178,7 +184,7 @@ module Pod
             if lib_linked_path.nil? || lib_linked_path == ""
               UI.puts "[Error] #{name} 的映射不存在, 无需移除".red
             else
-              if File.exist?(lib_linked_path)
+              if File.exist?(lib_linked_path) && File.symlink?(lib_linked_path)
                 FileUtils.rm_rf(lib_linked_path)
                 removeLinkedFileRecord(name)
                 UI.puts "#{name} 成功移除".green
@@ -200,7 +206,7 @@ module Pod
               records.each.with_index(0) do |record, index|
                 lib_linked_path = record["source_path"]
                 lib_name = record["lib_name"]
-                if File.exist?(lib_linked_path)
+                if File.exist?(lib_linked_path) && File.symlink?(lib_linked_path)
                   FileUtils.rm_rf(lib_linked_path)
                   removeLinkedFileRecord(lib_name)
                   UI.puts "#{lib_name} removing...".green
@@ -208,7 +214,7 @@ module Pod
               end
               UI.puts "\n已全部移除\n".green
             else
-              UI.puts "无记录\n".green
+              UI.puts "\n无记录\n".green
             end
           end
         end
@@ -220,13 +226,15 @@ module Pod
             records = JSON.parse(File.read(source_record_file_path))
             if records.count > 0
               records.each.with_index(1) do |record, index|
-                UI.puts "#{index}. #{record["lib_name"]}(#{record["lib_version"]}) ".green "Source: #{record["source_path"]}".yellow
+                lib_version_s = record["lib_version"]
+                lib_version_s = (lib_version_s == nil || lib_version_s == '') ? "" : "(#{lib_version_s})"
+                UI.puts "#{index}. #{record["lib_name"]} #{lib_version_s} ".green "Source: #{record["source_path"]}".yellow
               end
             else
-              UI.puts "无记录".green
+              UI.puts "\n无记录".green
             end
           else
-            UI.puts "无记录".green
+            UI.puts "\n无记录".green
           end
           print "\n"
         end
@@ -263,8 +271,13 @@ module Pod
         end
 
         def source_lib_name(filePath)
-          file_name = File.basename(filePath, ".a")
-          file_name = file_name[3..file_name.length]
+          file_name = ""
+          if Pathname.new(filePath).extname == ".framework"
+            file_name = File.basename(filePath, ".framework")
+          elsif Pathname.new(filePath).extname == ".a"
+            file_name = File.basename(filePath, ".a")
+            file_name = file_name[3..file_name.length]
+          end
           file_name
         end
 
@@ -350,7 +363,7 @@ module Pod
           end
           @lockfile ||= Lockfile.from_file(Pathname.new(podfile_lock))
 
-          UI.section "Analyzer Podfile" do
+          UI.section "ybin analyzer" do
             analyzer = Pod::Installer::Analyzer.new(config.sandbox, config.podfile, @lockfile)
             @analysis_result = analyzer.analyze
             @aggregate_targets = @analysis_result.targets
@@ -413,8 +426,8 @@ module Pod
 
         def template_source
           {
-            'libPath' => { question: '1/2 请输入映射源码的二进制库.a 的路径(如：/Users/xxx/Desktop/Workspace/xxx.a)' },
-            'sourcePath' => { question: '2/2 源码位置(注意版本是否匹配)' },
+            'libPath' => { question: '1/2 请输入静态二进制库的路径(如：/Users/xxx/Workspace/xxx.a 或 /Users/xxx/Workspace/xxx.framework)' },
+            'sourcePath' => { question: '2/2 源码路径(注意: 版本是否匹配)' },
           }
         end
 

data/lib/cocoapods-ybin/gem_version.rb

@@ -1,3 +1,3 @@
 module CocoapodsYbin
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-ybin
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - monetking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler