ppdbiu 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c727c44039051d12f0a349cc983b522b525e1f7
-  data.tar.gz: 78336fec9f13ce58d13a78d60f65dde6d9c2f002
+  metadata.gz: 1bf2fb64138440028dd5af7b24ae707bc7919a37
+  data.tar.gz: 1d65e05fa93b506282fa14e23d375883aba920e1
 SHA512:
-  metadata.gz: 4fe3ff68034b6dd4916085103f3f013cbea9b0780c198276f50bcf906e50b56e863b73ad72e1d640994d0fc9826875394e497c9af7671709e6deda9a09fe8247
-  data.tar.gz: 948d9d6c780785efa141dd4914635a98fb0ec6f089d1daaf43e056ee2e348ea6678ed48700c197d097187d83b8cad878a5d0de1258221262d2ce81b206371abc
+  metadata.gz: 72d7d5af51267a7dffd406b9bc7e9016b874534404b848465e228df05258409c3ed61cbba08bc7ffdabf7f873c6dd4536f25b4112b1c5b7575c0c6f493df6c9f
+  data.tar.gz: ba1703988b5253ccd3a08084b693d98f22bd83ac59c9f54e572bfebc683ce6f29b917209813ae29a9ea9d98baca11d9cce02dbeb0b7d9a6be716431475d7bccb

data/.gitignore

@@ -10,8 +10,6 @@
 /test/version_tmp/
 /tmp/
 /test/Pods
-/test/*.xcworkspace
-/test/*.xcodeproj
 
 # Used by dotenv library to load environment variables.
 # .env

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ppdbiu (0.2.2)
+    ppdbiu (0.2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -205,4 +205,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/LICENSE

@@ -1,21 +1,13 @@
-MIT License
+Copyright 2018 ppdai.com
 
-Copyright (c) 2017 坤坤同学
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+    http://www.apache.org/licenses/LICENSE-2.0
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,34 +1,44 @@
-# Ppdbiu
+### 项目简介
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ppdbiu`. To experiment with that code, run `bin/console` for an interactive prompt.
+ppdbiu 是一个使用 Ruby 编写的iOS远程依赖配置安装工具，用来获取服务端配置的CocoaPods依赖，并自动安装。 从而解决Podfile中频繁修改依赖组件，或者组件的版本。 特别适合项目发展到一定程度形成组件化，Podfile中依赖的组件越多，越适合使用ppdbiu。
 
-TODO: Delete this and the text above, and describe your gem
+### 为什么有这个项目
 
-## Installation
+拍拍贷财富App经过几年的迭代发展，目前已经完全进入组件化开发的方式，项目中已经有将近上百个组件，如果这些组件的依赖都写到Podfile中，里面将有将近上百条类似`Pod 'xxxx'`的内容存在，而且在多人同时修改的情况也容易形成冲突。为此我们开发了移动应用管理系统，用来线上管理应用、管理组件、管理应用版本对组件的依赖。线上系统中配置的依赖需要能够在执行`pod install`的时候自动被安装，此项目就是为了解决这个问题而产生的，它是整个移动应用管理系统中很重要的一部分。
 
-Add this line to your application's Gemfile:
+### 安装
+
+将下面这行代码添加到您应用目录下的Gemfile中
 
 ```ruby
 gem 'ppdbiu'
 ```
 
-And then execute:
+然后执行:
 
     $ bundle
 
-Or install it yourself as:
+或者用下面的命令进行安装:
 
     $ gem install ppdbiu
 
-## Usage
+### 使用
+
+1. 在Podfile中引入依赖 `require 'ppdbiu'`
+
+2. 删除所有可以通过服务端配置的依赖代码如： pod 'xxxxx'
+
+3. 添加`makeup_pods(url, params, method, ignores)`来获取依赖并进行依赖安装， 参数中含义解释如下：
 
-- 在Podfile中引入依赖 `require 'ppdbiu'`
+    - url： 为获取json依赖内容的地址，通过url接口请求得到Podfile中的依赖，来安装依赖内容
 
-- 删除所有的pod 'xxxxx'
+    - params为url的请求参数
 
-- 添加`makeup_pods(url, params, method, ignores)`， 其中url为获取json依赖内容的地址，通过url接口请求得到Podfile中的依赖，来安装依赖内容, params为url的请求参数, method为网络请求的方式，支持GET和POST, ignores为忽略依赖的数组，在执行依赖安装的过程中会判断依赖名称是否在忽略的数组中，忽略数组一般用来调试本地组件或者指定git地址使用，放弃从配置中安装依赖，再在Podfile中添加本地组件或者git地址。
+    - method为网络请求的方式，支持GET和POST
 
-- json内容格式如下：
+    - ignores为忽略依赖的数组，在执行依赖安装的过程中会判断依赖名称是否在忽略的数组中，忽略数组一般用来调试本地组件或者指定git地址使用，放弃从配置中安装依赖，再在Podfile中添加本地组件或者git地址。
+
+4. 服务端配置返回的json内容格式如下：
 
 ```json
 {
@@ -37,65 +47,130 @@ Or install it yourself as:
     "resultMessage": "响应成功",
     "content": [
         {
-            "dependencyName": "PPDBLUtils",
-            "componentVersion": "~> 1.2.0"
+            "dependencyName": "AFNetworking",
+            "componentVersion": "~> 3.2.0"
+        },
+        {
+            "dependencyName": "YYModel",
+            "componentVersion": "1.0.4"
         },
         {
-            "dependencyName": "PPDBLRouter",
-            "componentVersion": "1.1.0"
+            "dependencyName": "YYText",
+            "componentVersion": "1.0.5"
         },
         {
-            "dependencyName": "PPDBLOpenSSL",
-            "gitUrl": "http://xxxx.com/wireless/PPDBLOpenSSL.git"
+            "dependencyName": "Masonry",
+            "gitUrl": "https://github.com/SnapKit/Masonry.git"
         },
         {
-            "dependencyName": "PPDBLCore",
-            "gitUrl": "http://xxxx.com/wireless/PPDBLCore.git",
+            "dependencyName": "MBProgressHUD",
+            "gitUrl": "https://github.com/jdg/MBProgressHUD.git",
             "componentBranch": "master"
         },
         {
-            "dependencyName": "PPDBLWebViewJSBridge",
-            "gitUrl": "http://xxxx.com/wireless/PPDBLWebViewJSBridge.git",
-            "tag": "1.1.0"
+            "dependencyName": "UICKeyChainStore",
+            "gitUrl": "https://github.com/kishikawakatsumi/UICKeyChainStore.git",
+            "tag": "v2.1.1"
         }
-    ],
-    "pageNo": 1,
-    "pageSize": 10,
-    "totalCount": 5,
-    "totalPageCount": 1
+    ]
 }
 ```
 
+5. 依赖安装过程优先安装指定`componentVersion`的版本，如果返回的有`componentVersion`字段，会安装此字段设置的版本进行安装，否则安装giturl、tag，componentBranch等信息进行依赖安装
+
 实例：
 
 ```ruby
-source 'http://git.ppdaicorp.com/wireless/Specs.git'
+source 'http://github.com/CocoaPods/Specs.git'
 
 platform :ios, "8.0"
 inhibit_all_warnings!
+workspace 'Demo.xcworkspace'
+
+target 'Demo' do
+  project 'Demo/Demo.xcodeproj'
 
-target 'CityLoan' do
   require 'ppdbiu'
 
-  # 不包含忽略数组
-  makeup_pods('http://mplatform.ppdaicorp.com/dep/list', {'applicationVersionId' => '4', 'pageSize' => '99999'}, 'POST')
-  # 包含忽略数组
-  # makeup_pods('http://mplatform.ppdaicorp.com/dep/list', {'applicationVersionId' => '4', 'pageSize' => '99999'}, 'POST', ['PPDBLNetworking', 'PPDBLUtils'])
+  # 包含忽略依赖数组，如['YYText']
+  makeup_pods('https://raw.githubusercontent.com/wanyakun/resources/master/dependency.json', {'applicationVersionId' => '4', 'pageSize' => '99999'}, 'GET', ['YYText'])
+  pod 'YYText', :git => 'https://github.com/ibireme/YYText.git'
 
+  # 不包含忽略数字键
+  # makeup_pods('https://raw.githubusercontent.com/wanyakun/resources/master/dependency.json', {'applicationVersionId' => '4', 'pageSize' => '99999'}, 'GET')
 end
+```
+
+### 项目结构
 
+整个项目结构如下：
+
+```
+ppdbiu/
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE
+├── README.md
+├── Rakefile
+├── bin
+│   ├── console
+│   └── setup
+├── lib
+│   ├── ppdbiu
+│   │   └── version.rb
+│   └── ppdbiu.rb
+├── ppdbiu.gemspec
+└── test
+    ├── Demo
+    │   ├── Demo
+    │   │   ├── AppDelegate.h
+    │   │   ├── AppDelegate.m
+    │   │   ├── Assets.xcassets
+    │   │   │   ├── AppIcon.appiconset
+    │   │   │   │   └── Contents.json
+    │   │   │   └── Contents.json
+    │   │   ├── Base.lproj
+    │   │   │   ├── LaunchScreen.storyboard
+    │   │   │   └── Main.storyboard
+    │   │   ├── Info.plist
+    │   │   ├── ViewController.h
+    │   │   ├── ViewController.m
+    │   │   └── main.m
+    │   ├── Demo.xcodeproj
+    │   │   ├── project.pbxproj
+    │   │   └── xcuserdata
+    │   │       └── wanyakun.xcuserdatad
+    │   │           └── xcschemes
+    │   │               └── xcschememanagement.plist
+    │   └── DemoTests
+    │       ├── DemoTests.m
+    │       └── Info.plist
+    ├── Demo.xcworkspace
+    │   ├── contents.xcworkspacedata
+    │   ├── xcshareddata
+    │   │   └── IDEWorkspaceChecks.plist
+    │   └── xcuserdata
+    │       └── wanyakun.xcuserdatad
+    │           └── UserInterfaceState.xcuserstate
+    ├── Gemfile
+    ├── Gemfile.lock
+    ├── Podfile
+    ├── Podfile.lock
+    └── dependency.json
 ```
 
-## Development
+项目编译使用到Ruby 2.3.0, 并使用Rake进行构建、打包和发布。
+
+### 开发
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+克隆代码后进入项目目录，执行`bin/setup`来安装依赖。
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+想要在本机安装此gem，可以执行`bundle exec rake install`。如果想要发布一个新版本，先更新`version.rb`里的版本号，然后执行`bundle exec rake release`，这个操作将为这个版本创建一个git tag，并且推送git提交和tags，而且会推送`.gem`文件到[rubygems.org](https://rubygems.org)。
 
-## Contributing
+### 联系
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/wanyakun/ppdbiu.
+我们的邮箱地址： wanyakun@ppdai.com, 欢迎来信联系。
 
-## License
+### 开源许可协议
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Apache License 2.0

data/lib/ppdbiu.rb

@@ -1,7 +1,30 @@
+#
+# Copyright 2018 ppdai.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# limitations under the License.
+#
+
 require "ppdbiu/version"
 
 module Pod
   class Podfile
+
+    # 从url获取依赖并进行依赖安装
+    #
+    # @param url 获取依赖配置的请求url
+    # @param params 获取依赖配置的请求参数
+    # @param method 获取依赖配置的请求方式
+    # @param ignores 依赖安装忽略列表，默认为空
+    #
     def makeup_pods(url, params, method, ignores = [])
       UI.title "makeup pods dependency from #{url}"
       file = "dependency.json"
@@ -21,6 +44,13 @@ module Pod
       end
     end
 
+    # 安装依赖，在安装依赖的过程中判断是否在ignores中，
+    # 如果在ignores中则忽略不进行依赖安装，
+    # 如果不在ignores，判断是否有componentVersion，优先是用版本进行安装，否则进行url、tag、commit等配置进行安装依赖
+    #
+    # @param dependencies 依赖列表
+    # @param ignores 忽略列表
+    #
     def ppd_pod(dependencies, ignores)
       dependencies.each { |value|
         componentName = value.fetch("dependencyName", nil)
@@ -62,6 +92,12 @@ module Pod
       }
     end
 
+    # 处理获取依赖的网络请求
+    #
+    # @param url 请求的url
+    # @param paras 请求的参数
+    # @param method 请求的方式
+    #
     def peform_request(url, params, method)
       require 'rest'
       require 'json'
@@ -76,6 +112,22 @@ module Pod
       end
     end
 
+    # 处理网络请求返回来的内容
+    #
+    # @param response 应返回json数据结构，如下：
+    #
+    # {
+    #   "result": 0,
+    #   "codeMsg": "",
+    #   "resultMessage": "响应成功",
+    #   "content": [
+    #     {
+    #       "dependencyName": "AFNetworking",
+    #       "componentVersion": "~> 3.2.0"
+    #     }
+    #      ]
+    #   }
+    #
     def handleResponse(url, response)
       if response.ok?
         body = JSON.parse(response.body)

data/lib/ppdbiu/version.rb

@@ -1,3 +1,18 @@
+#
+# Copyright 2018 ppdai.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# limitations under the License.
+#
+
 module Ppdbiu
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ppdbiu
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - wanyakun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,7 +91,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 wanyakun
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.