fir-cli 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e2c2eb4c08bfe43c5e1237dda28ad11f9899dce
-  data.tar.gz: edabc62959f3098a21ecf84861d7c7d39a170b65
+  metadata.gz: 2f3f4e92a079da9de49f324cdb3929c29d08de75
+  data.tar.gz: b533093fa321bd7761ccb02335c825a44314c8c0
 SHA512:
-  metadata.gz: 6c30e3dd5ff254e45401208381ec8d5d0ebd61cf7d56dcab5d353248454c95b4693f1a60ba280224d7585433ac3f81a7eb82a230004a49aa8c7efd0696006975
-  data.tar.gz: 5fb9eaf4199ab0d6c750f25704a2cf5b017691e46120b01a8e4604aa2b8506d23b9523287006cdc097add4c7d2dec91d440d86ee08e6a6e83f491946579f9908
+  metadata.gz: eb98e207db717384ab121ffca6485cb28b5526b01fef5fb187ba5bd660d9ff0dc3aa6ac458814a10a2183dcedc646f97219a5def3ac0728f61aecda7bada5cbe
+  data.tar.gz: 7ccb81cf640a3363e5c8983602252e8fb645269d0484294b725fd93dd5e93ccc8aa06aad52cc51d762654a327b9ca08dcdca18b9ab6d859a9b87d42c44ec8506

data/CHANGELOG

@@ -1,5 +1,8 @@
 ## 更新记录
 
+### fir-cli 1.3.6
+- 增加自定义 build 后 ipa, apk 的 name
+
 ### fir-cli 1.3.5
 - 修复转换 icon 的 bug
 

data/README.md

@@ -1,4 +1,4 @@
-fir.im-cli
+✈ fir.im-cli
 ---
 
 ![Build Status Images](https://travis-ci.org/FIRHQ/fir-cli.svg)
@@ -7,43 +7,29 @@ fir.im-cli
 [![Gem Version](https://badge.fury.io/rb/fir-cli.svg)](http://badge.fury.io/rb/fir-cli)
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/FIRHQ/fir-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
-> fir.im-cli 可以通过指令查看, 上传, 编译应用
+fir.im-cli 可以通过指令查看, 上传, 编译 ios/android 应用.
 
-## 使用入门
-### 从安装入手
+## 安装
 
-fir.im-cli 使用 Ruby 构建，只要安装相应 ruby gem 即可:
+### OSX 安装
 
-```shell
-$ sudo gem install fir-cli
-```
-
-如果是 OS X 系统, 需要提前安装好 osx command line tools:
+在安装前需要确保 **osx command line tools** 已经被提前安装好:
 
-```shell
+```sh
 $ xcode-select --install
 ```
 
-如果出现无法安装的现象, 请先更换 Ruby 的淘宝源(由于国内网络原因, 你懂的), 并升级下系统自带的 gem
-
-```shell
-sudo gem sources --remove https://rubygems.org/
-sudo gem sources -a https://ruby.taobao.org/
-sudo gem sources -l
-*** CURRENT SOURCES ***
-
-https://ruby.taobao.org
-# 请确保只有 ruby.taobao.org, 如果有其他的源, 请 remove 掉
+fir.im-cli 使用 Ruby 构建, 无需编译, 只要安装相应 ruby gem 即可(如果出现相关权限不足的错误, 请在命令行前加上 `sudo`):
 
-sudo gem update --system
-sudo gem install fir-cli
+```sh
+$ gem install fir-cli
 ```
 
 **注意: 如果你的系统是 mac OSX 10.11 以后的版本, 由于10.11引入了 `rootless`, 无法直接安装 fir-cli, 有以下三种解决办法:**
 
 1\. 使用 [RVM](https://rvm.io/) 安装 Ruby, 再安装 fir-cli(推荐)
 
-```shell
+```sh
 # Install RVM:
 $ \curl -sSL https://get.rvm.io | bash -s stable --ruby
 
@@ -52,21 +38,48 @@ $ gem install fir-cli
 
 2\. 指定 fir-cli 中 bin 文件的 PATH
 
-```shell
-$ export PATH=/usr/local/bin:$PATH;sudo gem install -n /usr/local/bin fir-cli
+```sh
+$ export PATH=/usr/local/bin:$PATH;gem install -n /usr/local/bin fir-cli
 ```
 
 3\. 重写 Ruby Gem 的 bindir
 
-```shell
+```sh
 $ echo 'gem: --bindir /usr/local/bin' >> ~/.gemrc
-$ sudo gem install fir-cli
+$ gem install fir-cli
 ```
 
-安装后，你可以在命令行执行指令
+### Linux 安装
+
+需要提前安装好 Ruby 版本 > 1.9.3
+
+```sh
+$ gem install fir-cli
+```
 
-```shell
-$ fir
+**注意: 如果出现 `ERROR:  While executing gem ... (Gem::RemoteFetcher::FetchError)` 的错误, 请先更换 Ruby 的淘宝源(由于国内网络原因, 你懂的), 并升级下系统自带的 gem**
+
+```sh
+$ gem sources --remove https://rubygems.org/
+$ gem sources -a https://ruby.taobao.org/
+$ gem sources -l
+*** CURRENT SOURCES ***
+
+https://ruby.taobao.org
+# 请确保只有 ruby.taobao.org, 如果有其他的源, 请 remove 掉
+
+gem update --system
+gem install fir-cli
+```
+
+## 使用说明
+
+### fir help 使用说明
+
+`fir help` 命令不仅可以运行在 `fir` 主命令上, 还可以运行在相应子命令上查看相关的帮助
+
+```sh
+$ fir help
 Commands:
   fir build_apk BUILD_DIR                       # Build Android app (alias: `ba`).
   fir build_ipa BUILD_DIR [options] [settings]  # Build iOS app (alias: `bi`).
@@ -75,7 +88,7 @@ Commands:
   fir login                                     # Login fir.im (aliases: `l`).
   fir mapping MAPPING_FILE_PATH                 # Upload app mapping file to BugHD.com (aliases: `m`).
   fir me                                        # Show current user info if user is logined.
-  fir publish APP_FILE_PATH                     # Publish iOS/Android app to fir.im, support ipa/apk file (aliases: `p`).
+  fir publish APP_FILE_PATH                     # Publish iOS/Android app to fir.im, support ipa/apk file (aliases: `...
   fir upgrade                                   # Upgrade fir-cli and quit (aliases: `u`).
   fir version                                   # Show fir-cli version number and quit (aliases: `v`).
 
@@ -86,167 +99,136 @@ Options:
                                    # Default: true
   -q, [--quiet], [--no-quiet]      # Silence commands
   -h, [--help], [--no-help]        # Show this help message and quit
-
-
-Options:
-  -T, [--token=TOKEN]              # User's API Token at FIR.im
-  -L, [--logfile=LOGFILE]          # Path to writable logfile
-  -V, [--verbose], [--no-verbose]  # Show verbose
-                                   # Default: true
-  -q, [--quiet], [--no-quiet]      # Silence commands
-  -h, [--help], [--no-help]        # Show this help message and quit
 ```
-
-### 参数说明
+#### 全局参数说明
 
 - `alias <short command>` 意味着可以用 alias 别名来代替该指令, 例如 `fir b`
-- `-T` 用户在 fir.im 上的 api_token, `publish` 需要使用此参数
+- `-T` 用户在 fir.im 上的 api_token
 - `-L` 指定 fir-cli 的输出 log, 默认为 STDOUT
 - `-V` Verbose, 默认为输出所有信息( INFO 和 ERROR), 如果设置 `--no-verbose`, 则只输出 ERROR 信息
 - `-q` 静默模式, 默认关闭
-- `-h` 查看帮助
+- `-h` 查看相关命令帮助
 
-### 发布一个应用
+### fir publish 使用说明
 
-输入下面的指令便可轻松发布应用, 支持 ipa 和 apk 文件
+fir publish 命令可以轻松发布应用到 fir.im, 支持 ipa 和 apk 文件.
 
-```shell
-$ fir p path/to/application -T YOUR_FIR_TOKEN
+```sh
+$ fir publish path/to/application -T YOUR_FIR_TOKEN
 ```
 
-如果在此之前, 已经使用 `fir login` 命令登录过, 则可省略 `-T` 参数
-
-```shell
-I, [2015-08-26T10:08:35.447209 #6774]  INFO -- : Publishing app.......
-I, [2015-08-26T10:08:35.447334 #6774]  INFO -- : ✈ -------------------------------------------- ✈
-I, [2015-08-26T10:08:35.514378 #6774]  INFO -- : Fetching xxxx@fir.im uploading info......
-I, [2015-08-26T10:08:35.692616 #6774]  INFO -- : Uploading app......
-I, [2015-08-26T10:08:36.920226 #6774]  INFO -- : Updating devices info......
-I, [2015-08-26T10:08:37.075149 #6774]  INFO -- : ✈ -------------------------------------------- ✈
-I, [2015-08-26T10:08:37.075238 #6774]  INFO -- : Fetch app info from fir.im
-I, [2015-08-26T10:08:37.235071 #6774]  INFO -- : Published succeed: http://fir.im/xxxx
-I, [2015-08-26T10:08:37.235155 #6774]  INFO -- :
-```
+如果需要上传 changelog, 自定义 short 地址, 上传符号表, 生成二维码等功能, 可以使用 `fir publish -h`查看相应的帮助
 
-### 方便一点
+### fir login 使用说明
 
-如果觉得每次都输入 `-T` 很不方便, 那么可使用 `login` 命令
+如果觉得每次上传都输入 `-T` 很不方便, 那么可使用 `login` 命令
 
-```shell
-$ fir l
+```sh
+$ fir login
 ```
 
-这时系统会提示输入用户 token, 用户 token 可在 **[这里](http://fir.im/user/info)** 查看
+这时系统会提示输入用户 API token, 用户的 API token 可在 **[fir.im 应用管理页](http://fir.im/apps)** 的右上角查看
 
-```shell
+```sh
 Please enter your fir.im API Token:
 I, [2015-08-26T10:10:28.235295 #6833]  INFO -- : Login succeed, previous user's email: xxx@xxx.com
 I, [2015-08-26T10:10:28.245083 #6833]  INFO -- : Login succeed, current  user's email: xxx@xxx.com
 I, [2015-08-26T10:10:28.245152 #6833]  INFO -- :
 ```
 
-### 编译并获得 ipa
-> 该指令 `build_ipa` 对 `xcodebuild` 原生指令进行了封装, 将常用的参数名简化, 支持全部的自带参数及设置, 同时输出符号表 .dSYM 文件.
+### fir build 使用说明
 
-```
-$ fir build_ipa path/to/project -o path/to/output
-I, [2015-08-26T10:11:12.105103 #7167]  INFO -- : Building......
-I, [2015-08-26T10:11:12.105175 #7167]  INFO -- : ✈ -------------------------------------------- ✈
-I, [2015-08-26T10:11:18.500887 #7167]  INFO -- : Build settings from command line:
+该指令分为两个不同的指令, `build_ipa` 和 `build_apk`, 可以编译 ipa 及 apk 应用并上传到 fir.im
+
+#### 编译 ipa
 
-..........
+`build_ipa` 对 `xcodebuild` 原生指令进行了封装, 将常用的参数名简化, 支持全部的自带参数及设置, 同时输出符号表 dSYM 文件.
 
-I, [2015-08-26T10:11:18.535498 #7167]  INFO -- : Build Success
-I, [2015-08-26T10:11:18.535704 #7167]  INFO -- :
+编译 project
+
+```
+$ fir build_ipa path/to/project -o path/to/output
 ```
 
-### 复杂一点
+编译 workspace
 
-```shell
-$ fir bi path/to/workspace -o path/to/output -w -C Release -t allTargets GCC_PREPROCESSOR_DEFINITIONS="FOO=bar"
+```sh
+$ fir build_ipa path/to/workspace -o path/to/output -w -C Release -t allTargets GCC_PREPROCESSOR_DEFINITIONS="FOO=bar"
 ```
 
 该指令在指向的目录中，找到第一个 workspace 文件，对其进行编译。使用 `Release` 设置，编译策略为 `allTargets`，同时设置了预编译参数 `FOO`。
 
-### 编译用 CocoaPods 做依赖管理的 .ipa包
+编译用 CocoaPods 做依赖管理的 .ipa 包
 
-```shell
-$ fir bi path/to/workspace -w -S <scheme name>
+```sh
+$ fir build_ipa path/to/workspace -w -S <scheme name>
 ```
 
-### 编译用 Gradle 打包 apk
+#### 编译用 Gradle 打包 apk
 
-```shell
-$ fir ba path/to/project
+```sh
+$ fir build_apk path/to/project
 ```
 
-### 一步, 从源代码到 fir.im
-> 只需要输入 -p -T
+#### 编译并且上传至 fir.im
 
-```shell
-$ fir build_ipa path/to/project -o path/to/output -p -T YOUR_FIR_TOKEN
-I, [2015-08-26T10:11:59.687221 #7273]  INFO -- : Building......
-I, [2015-08-26T10:11:59.687301 #7273]  INFO -- : ✈ -------------------------------------------- ✈
-I, [2015-08-26T10:12:00.868774 #7273]  INFO -- : Build settings from command line:
+只需要输入 `-p -T` 即可
 
-..........
-
-I, [2015-08-26T10:12:00.893819 #7273]  INFO -- : Build Success
-I, [2015-08-26T10:12:00.894051 #7273]  INFO -- :
-I, [2015-08-26T10:12:01.026832 #7273]  INFO -- : Publishing app.......
-I, [2015-08-26T10:12:01.026905 #7273]  INFO -- : ✈ -------------------------------------------- ✈
-I, [2015-08-26T10:12:01.098759 #7273]  INFO -- : Fetching im.fir.OnlyiPad@fir.im uploading info......
-I, [2015-08-26T10:12:01.249832 #7273]  INFO -- : Uploading app......
-I, [2015-08-26T10:12:01.859718 #7273]  INFO -- : Updating devices info......
-I, [2015-08-26T10:12:02.015517 #7273]  INFO -- : ✈ -------------------------------------------- ✈
-I, [2015-08-26T10:12:02.015588 #7273]  INFO -- : Fetch app info from fir.im
-I, [2015-08-26T10:12:02.210391 #7273]  INFO -- : Published succeed: http://fir.im/xxxx
-I, [2015-08-26T10:12:02.210459 #7273]  INFO -- :
-I, [2015-08-26T10:12:02.210520 #7273]  INFO -- :
+```sh
+$ fir build_ipa/build_apk path/to/project -o path/to/output -p -T YOUR_FIR_TOKEN -c YOUR_CHANGELOG
 ```
 
-### 上传符号表
+如果需要更详细的使用说明, 可以使用 `fir build_ipa/build_apk -h`查看相应的帮助
+
+### fir mapping 使用说明
 
-有以下三种方式上传符号表至 [BugHD.com](http://bughd.com) 所对应的项目, 目前已经支持 dSYM 和 txt 两种格式的符号表文件上传
+该指令可以上传符号表至 [BugHD.com](http://bughd.com) 所对应的项目, 目前已经支持 dSYM 和 txt 两种格式的符号表文件上传, 有以下三种方法上传:
 
 > 指定 version 和 build 上传:
 
-```shell
+```sh
 $ fir m <mapping file path> -P <bughd project id> -v <app version> -b <app build> -T <your api token>
 ```
 
 > 在 publish 的时候自动上传:
 
-```shell
+```sh
 $ fir p <app file path> -m <mapping file path> -P <bughd project id> -T <your api token>
 ```
 > 在 build_ipa 的时候自动上传:
 
-```shell
+```sh
 $ fir b <project dir> -P <bughd project id> -M -p -T <your api token>
 ```
 
-## 需要帮助?
+如果需要更详细的使用说明, 可以使用 `fir mapping -h`查看相应的帮助
 
-输入以下指令获取全面功能介绍
+### fir me 使用说明
 
-```shell
-$ fir -h
-$ fir publish -h
-```
+该指令可以查看当前使用者
 
-如果还有疑问随时发邮件至 [fir-cli](mailto: dev@fir.im)
+```sh
+$ fir me
+I, [2015-11-02T03:03:04.933645 #29886]  INFO -- : Login succeed, current user's email: xxxx
+I, [2015-11-02T03:03:04.933756 #29886]  INFO -- : Login succeed, current user's name:  xxxx
+I, [2015-11-02T03:03:04.933787 #29886]  INFO -- :
+```
 
-## 永远使用最新功能
+### fir upgrade 使用说明
 
-下面的指令会自动更新 fir-cli
+该指令用于升级最新版本的 fir-cli
 
-```shell
+```sh
 $ fir upgrade
 ```
 
-随时更新以使用最新功能
-
 ## 提交反馈
 
-[使用 github issue 即可](https://github.com/FIRHQ/fir-cli/issues)
+直接使用 Github 的 [Issue](https://github.com/FIRHQ/fir-cli/issues) 即可.
+
+## 捐赠支持
+
+如果你觉得 fir-cli 对你有所帮助, 欢迎打赏支持作者:smile:
+
+![](http://7rf35s.com1.z0.glb.clouddn.com/coffee.png)
+

data/fir-cli.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
     /_/   /___/_/ |_|      \____/_____/___/
 
   ## 更新记录
-  ### fir-cli 1.3.5
-  - 修复转换 icon 的 bug
+  ### fir-cli 1.3.6
+  - 增加 -n 参数自定义 build 后 ipa, apk 的 name
   - 详细更新记录, 请查看: https://github.com/FIRHQ/fir-cli/blob/master/CHANGELOG
   - [fir-cli](https://github.com/FIRHQ/fir-cli) 已经开源
   - 欢迎 fork, issue 和 pull request

data/lib/fir/cli.rb

@@ -30,6 +30,7 @@ module FIR
     method_option :output,        type: :string,  aliases: '-o', desc: 'IPA output path, the default is: BUILD_DIR/fir_build_ipa'
     method_option :publish,       type: :boolean, aliases: '-p', desc: 'true/false if publish to fir.im'
     method_option :short,         type: :string,  aliases: '-s', desc: 'Set custom short link if publish to fir.im'
+    method_option :name,          type: :string,  aliases: '-n', desc: 'Set custom ipa name when builded'
     method_option :changelog,     type: :string,  aliases: '-c', desc: 'Set changelog if publish to fir.im'
     method_option :qrcode,        type: :boolean, aliases: '-Q', desc: 'Generate qrcode'
     method_option :mapping,       type: :boolean, aliases: '-M', desc: 'true/false if upload app mapping file to BugHD.com'
@@ -54,6 +55,7 @@ module FIR
     method_option :output,    type: :string,  aliases: '-o', desc: 'APK output path, the default is: BUILD_DIR/build/outputs/apk'
     method_option :publish,   type: :boolean, aliases: '-p', desc: 'true/false if publish to fir.im'
     method_option :short,     type: :string,  aliases: '-s', desc: 'Set custom short link if publish to fir.im'
+    method_option :name,      type: :string,  aliases: '-n', desc: 'Set custom apk name when builded'
     method_option :changelog, type: :string,  aliases: '-c', desc: 'Set changelog if publish to fir.im'
     method_option :qrcode,    type: :boolean, aliases: '-Q', desc: 'Generate qrcode'
     def build_apk(*args)

data/lib/fir/util/build_apk.rb

@@ -40,7 +40,12 @@ module FIR
       check_no_output_apk
 
       apk_info = FIR.apk_info(@builded_apk)
-      apk_name = "#{apk_info[:name]}-#{apk_info[:version]}-Build-#{apk_info[:build]}"
+
+      if @name.blank?
+        apk_name = "#{apk_info[:name]}-#{apk_info[:version]}-Build-#{apk_info[:build]}"
+      else
+        apk_name = @name
+      end
 
       FileUtils.cp(@builded_apk, "#{@output_path}/#{apk_name}.apk")
     end

data/lib/fir/util/build_common.rb

@@ -9,6 +9,7 @@ module FIR
       @token         = options[:token] || current_token
       @changelog     = options[:changelog].to_s
       @short         = options[:short].to_s
+      @name          = options[:name].to_s
       @proj          = options[:proj].to_s
       @export_qrcode = options[:qrcode]
     end

data/lib/fir/util/build_ipa.rb

@@ -75,9 +75,14 @@ module FIR
 
     def rename_ipa_and_dsym
       ipa_info  = FIR.ipa_info(@temp_ipa)
-      ipa_name  = "#{ipa_info[:name]}-#{ipa_info[:version]}-build-#{ipa_info[:build]}"
       dsym_name = "#{@output_path}/#{ipa_info[:name]}.app.dSYM"
 
+      if @name.blank?
+        ipa_name = "#{ipa_info[:name]}-#{ipa_info[:version]}-build-#{ipa_info[:build]}"
+      else
+        ipa_name = @name
+      end
+
       @builded_app_path = "#{@output_path}/#{ipa_name}.ipa"
 
       FileUtils.mv(@temp_ipa, @builded_app_path, force: true)

data/lib/fir/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module FIR
-  VERSION = '1.3.5'
+  VERSION = '1.3.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fir-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - NaixSpirit
@@ -149,6 +149,7 @@ files:
 - ".travis.yml"
 - CHANGELOG
 - Gemfile
+- Home.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -198,9 +199,9 @@ metadata: {}
 post_install_message: "\n        ______________        ________    ____\n       /
   ____/  _/ __ \\      / ____/ /   /  _/\n      / /_   / // /_/ /_____/ /   / /    /
   /\n     / __/ _/ // _, _/_____/ /___/ /____/ /\n    /_/   /___/_/ |_|      \\____/_____/___/\n\n
-  \ ## 更新记录\n  ### fir-cli 1.3.5\n  - 修复转换 icon 的 bug\n  - 详细更新记录, 请查看: https://github.com/FIRHQ/fir-cli/blob/master/CHANGELOG\n
-  \ - [fir-cli](https://github.com/FIRHQ/fir-cli) 已经开源\n  - 欢迎 fork, issue 和 pull
-  request\n  "
+  \ ## 更新记录\n  ### fir-cli 1.3.6\n  - 增加 -n 参数自定义 build 后 ipa, apk 的 name\n  - 详细更新记录,
+  请查看: https://github.com/FIRHQ/fir-cli/blob/master/CHANGELOG\n  - [fir-cli](https://github.com/FIRHQ/fir-cli)
+  已经开源\n  - 欢迎 fork, issue 和 pull request\n  "
 rdoc_options: []
 require_paths:
 - lib