cocoaseeds 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e95ed489fa91a2ccf7aeb3d41a13b76f1229d5e0
-  data.tar.gz: 5c89d2aa1dbbe4eee515de0ac961fdd92c127cc7
+  metadata.gz: b7b7c7e9ba1648abcf345126718302e6e7e18d5a
+  data.tar.gz: 1be8ba937ae30e52329fa3d574812a6157082486
 SHA512:
-  metadata.gz: 52b966f5c6389236681eaf531e68513f76962b5f920700cdec8681cb70a794e2cfedbae3d1643194a45fffe37036d29a2ab4ed94ef80241f2d4a97db01df7bf6
-  data.tar.gz: b467c0df4ed89cae27ef5d2e4465a5604f42392116990362740376a4b1d8bca543b1009574f689ddeafa1aa8731f528dd23839de516630dc773ebafd293df1e8
+  metadata.gz: c1130b8aeecc8701e208ad470c8da79ca17659a1022a58db0695819bbb29fb9ffb42a9c23237b75e77fe6260b95e2ed1eb5611558f894caca54bc0de1414b0d3
+  data.tar.gz: dd5279c4d9f457e24fbd94842338624490d447cda07c64390c96884da04e5be0c85e4e70b6264cca26b676ab752c9bb04b73ae7a1c42034b7e92905ac03059f2

data/README.md

@@ -21,59 +21,105 @@ Why?
 Installation
 ------------
 
+You can get CocoaSeeds from [RubyGems](https://rubygems.org).
+
 ```bash
 $ [sudo] gem install cocoaseeds
 ```
 
 
-Seedfile
---------
+Using CocoaSeeds
+----------------
 
-You have to write a **Seedfile** in the same directory with **.xcodeproj**.
+### 1. Write Seedfile
 
-<pre>
-MyProject/
-|-- MyProject/
-|   |-- AppDelegate.swift
-|   `-- ...
-|-- MyProject.xcodeproj
-|-- <b><i>Seedfile</i></b>
-`-- ...
-</pre>
+*Seedfile* is a ruby script that demonstrates dependencies. You can specify third party libraries from GitHub repository with simple expressions. CocoaSeeds currently supports GitHub only, but supporting many other sources are in our future roadmap.
 
+Let's make an empty file named **Seedfile** in the same directory with your Xcode project file. Then open it with your preferred editor.
+
+Here is a sample Seedfile:
 
 **Seedfile**
 
 ```ruby
-# seeds for all targets
 github "Alamofire/Alamofire", "1.2.1", :files => "Source/*.{swift,h}"
-github "devxoul/JLToast", "1.2.2", :files => "JLToast/*.{swift,h}"
-github "devxoul/SwipeBack", "1.0.4"  # files default: */**.{h,m,mm,swift}
+github "devxoul/JLToast", "1.2.5", :files => "JLToast/*.{swift,h}"
+github "devxoul/SwipeBack", "1.0.4"
 github "Masonry/SnapKit", "0.10.0", :files => "Source/*.{swift,h}"
 
-# seeds for specific target
 target :MyAppTest do
   github "Quick/Quick", "v0.3.1", :files => "Quick/**.{swift,h}"
   github "Quick/Nimble", "v0.4.2", :files => "Nimble/**.{swift,h}"
 end
 ```
 
-Using CocoaSeeds
-----------------
+Can you guess what each lines do? Seedfile has only basic information about third party libraries. Let's look at the single line. Each expressions are made with sections: source, tag and files.
+
+```ruby
+github "devxoul/JLToast", "1.2.5", :files => "JLToast/*.{swift,h}"
+~~~~~~~~~~~~~~~~~~~~~~~~  ~~~~~~~  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+       (Source)            (Tag)              (Files)
+```
+
+| Section | Example                           | Required | Default               |
+|---------|-----------------------------------|:--------:|:---------------------:|
+| Source  | `github "devxoul/SwipeBack"`      | Required | -                     |
+| Tag     | `1.0.4`                           | Required | -                     |
+| Files   | `:files => "JLToast/*.{swift,h}"` | Optional | `*/**.{h,m,mm,swift}` |
+
+Looking for using branches instead of tags? See the [Branch support](#branch-support) section.
+
+
+#### Specifying targets
+
+Third party libraries can be added specific targets by using target block. For example, you'd like to add some testing libraries such as Quick and Nimble to your test target, you can specify it in Seedfile:
+
+```ruby
+target :MyAppTest do
+  github "Quick/Quick", "v0.3.1", :files => "Quick/**.{swift,h}"
+  github "Quick/Nimble", "v0.4.2", :files => "Nimble/**.{swift,h}"
+end
+```
+
+Source files in the target block will only be added to target.
+
+
+### 2. Install dependencies
+
+After you done with Seedfile, it's time to add those third party libraries into your project. This is pretty simple. Just open the terminal, cd to your project directory and execute `seed install` command.
 
 ```bash
 $ seed install
 ```
 
-Then all the source files will be automatically added to your Xcode project with group named 'Seeds'.
+Then all the source files will be automatically downloaded and added to your Xcode project with group named 'Seeds'.
 
 ![Seeds-in-Xcode](https://cloud.githubusercontent.com/assets/931655/7502414/cbe45ecc-f476-11e4-9564-450e8887a054.png)
 
 
-Resolving Filename Conflicts (Beta)
------------------------------------
+### 3. Enjoy
+
+Build your project and enjoy!
+
+
+Beta Features
+-------------
 
-Since CocoaSeeds uses including source files directly than linking dynamic frameworks, it is important to make sure that all source file names are different. CocoaSeeds provides a way to do this:
+There are some beta features in CocoaSeeds which mean 'seemed to work but not fully tested in real world'. Please take care of using those features. (Don't be worry. I'm using these in my company project.)
+
+
+#### Branch support
+
+CocoaSeeds originally supports git tags only. For some reasons, such as using experimental feature branches like `swift-2.0`, you can use branches instead of tags. What you need to do is just replacing the tag with branch name. Anything else is same.
+
+```ruby
+github 'devxoul/SwiftyImage', 'swift-2.0', :files => 'SwiftyImage/SwiftyImage.swift'
+```
+
+
+#### Resolving filename conflicts
+
+Since CocoaSeeds uses including source files directly than linking dynamic frameworks, it is important to make sure that all sources have different file names. CocoaSeeds provides a way to do this:
 
 **Seedfile**
 
@@ -84,9 +130,9 @@ github "thoughtbot/Argo", "v1.0.3", :files => "Argo/*/*.swift"
 github "thoughtbot/Runes", "v2.0.0", :files => "Source/*.swift"
 </pre>
 
-Then all of source files installed via CocoasSeeds will have file names with seed name as prefix.
+Then all of source files installed via CocoasSeeds will have names with the seed names as prefix.
 
-| Before (filename) | After (seedname_filename) |
+| Before *(filename)* | After *(seedname_filename)* |
 |---|---|
 | `Seeds/Alamofire/Alamofire.swift` | `Seeds/Alamofire/Alamofire_Alamofire.swift` |
 | `Seeds/Argo/Operators/Operators.swift` | `Seeds/Argo/Operators/Argo_Operators.swift` |
@@ -96,10 +142,14 @@ Then all of source files installed via CocoasSeeds will have file names with see
 FAQ
 ---
 
-Yes, you can add **Seeds** folder to **.gitignore**.
+* Are you using this in your real-world project? (Does Apple allows the apps to be submitted on AppStore using CocoaSeeds?)
+    * Of course I am. I'm developing the social media service that 1.6 million users are using. It's on AppStore without any complaints from Apple.
+
+* Can I ignore **Seeds** folder in VCS *(version control system)*?
+    * Yes, you can make **Seeds** folder to be ignored.
 
 
 License
 -------
 
-CocoaSeeds is under MIT license. See the LICENSE file for more info.
+**CocoaSeeds** is under MIT license. See the LICENSE file for more info.

data/lib/cocoaseeds/core.rb

@@ -258,17 +258,22 @@ module Seeds
     def install_seeds
       self.seeds.sort.each do |name, seed|
         dirname = File.join(self.root_path, "Seeds", name)
+
+        if lock = self.locks[name]
+          old_version = lock.version
+        end
+
         if File.exist?(dirname)
           tag = `cd #{dirname} && git describe --tags --abbrev=0 2>&1`
           tag.strip!
-          if tag == seed.version
+          if tag == seed.version and (not old_version or tag == old_version)
             say "Using #{name} (#{seed.version})"
             `cd #{dirname} 2>&1 &&\
              git reset HEAD --hard 2>&1 &&\
              git checkout . 2>&1 &&\
              git clean -fd 2>&1`
           else
-            say "Installing #{name} #{seed.version} (was #{tag})".green
+            say "Installing #{name} #{seed.version} (was #{old_version})".green
             `cd #{dirname} 2>&1 &&\
              git reset HEAD --hard 2>&1 &&\
              git checkout . 2>&1 &&\

data/lib/cocoaseeds/version.rb

@@ -1,3 +1,3 @@
 module Seeds
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoaseeds
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Suyeol Jeon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj