xcake 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d105e4dd053c0ea4a00174991bd3aeefa41ca6b5
-  data.tar.gz: 1c7b55a7928dba8ce250ed5e61c7e409cc907e08
+  metadata.gz: 9b945c7078bf81c6b95c3886e01b6ab16c7191c3
+  data.tar.gz: 198fd535fffe2e5d0390873f97900cf8e871a526
 SHA512:
-  metadata.gz: 1435609910e57567ae62827810cfcaae216dbbbc6c5d1db1d0d9ddd7067ca7c429bb62ed6d5d69fb8c7f1628ba04e7aede1622734804dbf501c302534b48410d
-  data.tar.gz: 51725a1c11c2c5805029a3e2c13ea5bbbff70031a8de4fd079ccdb9163730744f4bb8978eb7fab309e36c1c9e20e21e371a88392fecdd15fb9baa073ad9bff0c
+  metadata.gz: 8141f00c32e800da77194b0866f21e2438596874c280063b5baaadf25d3b2db3e84bef3e8c276bf43beec0ed245090107effe878c9a38ffc51b66e7eee6abe90
+  data.tar.gz: 5f148d62c9c34f2510c301f31f64a32771f1528da1b405dd6888a814910e69adf5e65c4bbb91cc42ec1945176ad4c61f3d37db204145c8aa7045fedf9f8da300

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xcake (0.1.4)
+    xcake (0.1.6)
       claide
       xcodeproj (~> 0.28)
 
@@ -16,12 +16,13 @@ GEM
       tzinfo (~> 1.1)
     claide (0.9.1)
     colored (1.2)
-    coveralls (0.8.3)
+    coveralls (0.8.10)
       json (~> 1.8)
       rest-client (>= 1.6.8, < 2)
-      simplecov (~> 0.10.0)
+      simplecov (~> 0.11.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
+      tins (~> 1.6.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
     domain_name (0.5.25)
@@ -38,20 +39,20 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    simplecov (0.10.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.1)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)

data/docs/Cakefile.md

@@ -1,13 +1,12 @@
-<!-- TODO: Maybe split into files ? -->
 #Cakefile Syntax Reference
 
 The `Cakefile` contains a lightweight DSL which provides the instructions on how to generate
 a project file. We adopt the convention over configuration and thus it can be very simple:
 
 ```ruby
-Project.new do |c|
-    c.application_for :ios, 8.0 do |t|
-        t.name = "MyApp"
+Project.new do |project|
+    project.application_for :ios, 8.0 do |target|
+        target.name = "MyApp"
     end
 end
 ```
@@ -15,17 +14,17 @@ end
 and here is much more complicated one:
 
 ```ruby
-Project.new do |c|
+Project.new do |project|
 
-    c.debug_configuration :staging
-    c.debug_configuration :debug
-    c.release_configuration :release
+    project.debug_configuration :staging
+    project.debug_configuration :debug
+    project.release_configuration :release
 
-    c.application_for :ios, 8.0 do |t|
-      t.name = "test"
-      t.all_configurations.supported_devices = :iphone_only
+    project.application_for :ios, 8.0 do |target|
+      target.name = "test"
+      target.all_configurations.supported_devices = :iphone_only
 
-      c.unit_tests_for(t)
+      project.unit_tests_for(target)
     end
 end
 ```
@@ -38,21 +37,21 @@ readable, efficient and concise.
 To create a project we must write the following:
 
 ```ruby
-Project.new do |c|
+Project.new do |project|
 end
 ```
 By default Xcake will create a project named "Project" but we can change the name
 by passing a String argument with the name we would like it to be called:
 
 ```ruby
-Project.new "Workspace" do |c|
+Project.new "Workspace" do |project|
 end
 ```
 We can also customize the structure of the project between the first and second lines, like so:
 
 ```ruby
-Project.new "Workspace" do |c|
-  c.debug_configuration :debug
+Project.new "Workspace" do |project|
+  project.debug_configuration :debug
 end
 ```
 There are two main ways you can customize a Project, Targets and Configurations.
@@ -70,16 +69,16 @@ A project can specify any application targets such as iOS or Mac Apps.
 iOS App:
 
 ```ruby
-Project.new "Workspace" do |c|
-  c.application_for :ios, 8.0
+Project.new "Workspace" do |project|
+  project.application_for :ios, 8.0
 end
 ```
 
 Mac App:
 
 ```ruby
-Project.new "Workspace" do |c|
-  c.application_for :mac, 8.0
+Project.new "Workspace" do |project|
+  project.application_for :mac, 8.0
 end
 ```
 
@@ -88,9 +87,9 @@ end
 We can also specify a testing targets for other targets as well
 
 ```ruby
-Project.new "Workspace" do |c|
-  c.application_for :mac, 8.0 do |t|
-    c.unit_tests_for(t)
+Project.new "Workspace" do |project|
+  project.application_for :mac, 8.0 do |target|
+    project.unit_tests_for(target)
   end
 end
 ```
@@ -101,9 +100,9 @@ If these aren't enough for you then you can specify a target
 and manually set up it's properties.
 
 ```ruby
-Project.new "Workspace" do |c|
-  c.target do |t|
-    t.name = "Target"
+Project.new "Workspace" do |project|
+  project.target do |target|
+    target.name = "Target"
   end
 end
 ```
@@ -112,10 +111,10 @@ end
 
 #### Name
 
-Sets the name of the project
+Sets the name of the target
 
 ```ruby
-t.name = "Target"
+target.name = "Target"
 ```
 
 #### Type
@@ -124,7 +123,7 @@ Sets the type of the target, Can be `:application`, `:dynamic_library`,
 `:framework` or `:static_library`.
 
 ```ruby
-t.type = :application
+target.type = :application
 ```
 
 #### Platform
@@ -132,7 +131,7 @@ t.type = :application
 Sets the platform of the target. Can be `:ios` or `:osx`
 
 ```ruby
-t.platform = :ios
+target.platform = :ios
 ```
 
 #### Deployment Target
@@ -140,7 +139,7 @@ t.platform = :ios
 Sets the deployment target for the platform.
 
 ```ruby
-t.deployment_target = 8.0
+target.deployment_target = 8.0
 ```
 
 #### Language
@@ -148,19 +147,86 @@ t.deployment_target = 8.0
 Sets the primary language of the target, can be `:objc` or `:swift`.
 
 ```ruby
-t.language = :swift
+target.language = :swift
 ```
 
 ## Configurations
 
+Configurations are an abstraction of build settings and scheme settings. Depending
+on the target Xcake will create a scheme per target and per configuration.
+
+Xcake allows you define a hierarchy of build settings like you would in Xcode
+for the Project and the Targets.
+
 ### Debug Configurations
 
+For configurations used for internal testing we create a debug configuration,
+this comes with sensible defaults optimized for debugging (i.e Assertions enabled).
+
+```ruby
+project.debug_configuration :staging
+```
+
 ### Release Configurations
 
+For configurations used for release we create a release configuration,
+this comes with sensible defaults optimized for releasing (i.e Compiler optimizations enabled).
+
+```ruby
+project.release_configuration :release
+```
+
 ### All Configurations
 
+We can apply a particular shared setting across all of our configurations.
+Xcake provides a simply way of doing this via an "all" configuration.
+
+```ruby
+project.all_configurations.supported_devices = :iphone_only
+```
+
 ### Configuration Hiearchy
 
+Xcake allows you to manage the configurations for the project and the target but
+it also has its own hiearchy of settings, which are in the following order
+(One at the top of the list are overwritten by ones at the bottom):
+
+- Default Settings
+  These are the sensible defaults xcake provides for the configuration.
+
+- All Settings
+  These are any settings set via the "All" configuration
+
+- Custom Settings
+  These are the settings set directly on the configuration.
+
 ###Properties
 
+#### Name
+
+Sets the name of the configuration
+
+```ruby
+configuration.name = "Release"
+```
+
 #### Build Settings
+
+A hash of all the build settings for a configuration
+
+```ruby
+configuration.build_settings["ENABLE_BITCODE"] = false
+```
+
+###Build Settings Shortcuts
+
+Xcake also provides some shortcuts for some more common build settings.
+
+#### Supported Devices
+
+Allows you specify the devices an iOS App can run on, can be `:iphone_only`,
+`:ipad_only` or `:universal`
+
+```ruby
+configuration.supported_devices = :iphone_only
+```

data/lib/xcake/version.rb

@@ -1,3 +1,3 @@
 module Xcake
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcake
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - James Campbell