xcake 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2b839d22a249b4fae07a652392b6bc8499de4b1
-  data.tar.gz: 01eac6b8e28fc5a4bc6f5e9df92cb85166cb3ce8
+  metadata.gz: e509a8efed67d3155d1db47740e1631b5fb7a73c
+  data.tar.gz: 5f0702df8872b852cb4ec92d249705bc80a4f20c
 SHA512:
-  metadata.gz: c45e6a6f99ef17ea41cda0d26e76918ec81e7c8f020ea84753aeaaae8c2398df494cc6467e7a158786245a32263442fbaeddf6970804a6b545b43f3348a14e21
-  data.tar.gz: 80c58dd710c0ef25a857561ee05fef9a402cef2182d19a1bc90e2040adacc3d8c6312eaa1608bcf0c0a695ab6a210b761eac21b68de3150976f6422378ffd1ac
+  metadata.gz: 094e5c504279977e1b462baa2c04c0b0d8009a3a6610b7066958c3d2cffc5802d8aef04e3e1c1557f0c4b0bf82b630cb317d7287ebc0445d6816478e4e6942c5
+  data.tar.gz: eaa90c7b973f4e12d28ceed589ece3a99a72166a4608a15c864a529267d6e6caba416f2bdea6ff761c8dbfbfff977d193772d1fcc83827b84f0ed9a8036bf729

data/.yardopts

@@ -1,3 +1,7 @@
+--markup markdown
+--private
 -
 "docs/Cakefile.md"
 "docs/Getting Started.md"
+"docs/Hooks.md"
+"docs/Xcode Project Support.md"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    xcake (0.4.8)
+    xcake (0.5.0)
       claide (~> 0.9.1)
       hooks (~> 0.4.1)
       tty (~> 0.3.2)
@@ -42,9 +42,9 @@ GEM
     minitest (5.8.3)
     necromancer (0.3.0)
     netrc (0.11.0)
-    pastel (0.5.2)
-      equatable (~> 0.5)
-      tty-screen (~> 0.4)
+    pastel (0.5.3)
+      equatable (~> 0.5.0)
+      tty-screen (~> 0.4.3)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)

data/README.md

@@ -23,7 +23,6 @@ Get in contact with the developer on Twitter: [@jcampbell_05](https://twitter.co
     <a href="#features">Features</a> &bull;
     <a href="#installation">Installation</a> &bull;
     <a href="#need-help">Need help?</a> &bull;
-    <a href="#roadmap">Roadmap</a> &bull;
     <a href="http://www.rubydoc.info/gems/xcake/file/docs/Getting%20Started.md">Documentation</a>
 </p>
 
@@ -38,24 +37,22 @@ Store a simple description of your project in a text file, your `Cakefile`, to e
 You define a project like this:
 
 ```ruby
-Project.new do |c|
-    c.application_for :ios, 8.0 do |t|
-        t.name = "MyApp"
-    end
+application_for :ios, 8.0 do |target|
+  target.name = "MyApp"
 end
 ```
 
 To generate the xcode project, just run:
 
 ```sh
-xcake
+xcake bake
 ```
 
               |  xcake
 --------------------------|------------------------------------------------------------
 :sparkles: | Flexibly configure and create xcode project from one easy to read `Cakefile`
 :ship: | Generate from any computer, including a CI-server
-:thought_balloon: | Never remember any difficult commands, just `xcake`
+:thought_balloon: | Never remember any difficult commands, just `xcake bake`
 :page_with_curl: | Store **everything** but the project in git. Never again manually fix any corruptions or merge issues with the project.
 :rocket: | Saves you **hours** when working with xcode projects
 :anchor: | Confidence that the project file is exactly the same during Continuous Delivery
@@ -81,22 +78,18 @@ System Requirements: `xcake` requires Mac OS X or Linux with Ruby 2.0.0 or above
 
 ## Available commands
 
-Usually you'll use xcake by running the command
-
-    xcake
-
-## Need help?
-Please submit an issue on GitHub and provide information about your setup
+Xcake can create an example cakefile when you run:
 
-## Roadmap
+    xcake init
 
-:white_check_mark: Create WatchOS applications.
+Usually you'll use xcake by running the command
 
-:white_medium_square: Create tvOS applications.
+    xcake bake
 
-:white_medium_square: Generate library targets.
+Xcake will then generate a Xcode project based on your Cakefile
 
-:white_medium_square: Generate extensions.
+## Need help?
+Please submit an issue on GitHub and provide information about your setup
 
 ## License
 This project is licensed under the terms of the MIT license. See the LICENSE file.

data/bin/console

@@ -6,8 +6,5 @@ require "bundler/setup"
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/docs/Cakefile.md

@@ -4,29 +4,24 @@ The `Cakefile` contains a lightweight DSL which provides the instructions on how
 a project file. We adopt the convention over configuration and thus it can be very simple:
 
 ```ruby
-Project.new do |project|
-    project.application_for :ios, 8.0 do |target|
-        target.name = "MyApp"
-    end
-end
+  application_for :ios, 8.0 do |target|
+      target.name = "MyApp"
+  end
 ```
 
 and here is much more complicated one:
 
 ```ruby
-Project.new do |project|
+  debug_configuration :staging
+  debug_configuration :debug
+  release_configuration :release
 
-    project.debug_configuration :staging
-    project.debug_configuration :debug
-    project.release_configuration :release
+  application_for :ios, 8.0 do |target|
+    target.name = "test"
+    target.all_configurations.supported_devices = :iphone_only
 
-    project.application_for :ios, 8.0 do |target|
-      target.name = "test"
-      target.all_configurations.supported_devices = :iphone_only
-
-      project.unit_tests_for(target)
-    end
-end
+    unit_tests_for target
+  end
 ```
 
 As you can see, it is super easy to read; The goal of Xcake is to keep everything
@@ -34,27 +29,8 @@ readable, efficient and concise.
 
 ## Project
 
-To create a project we must write the following:
-
-```ruby
-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 |project|
-end
-```
-We can also customize the structure of the project between the first and second lines, like so:
-
-```ruby
-Project.new "Workspace" do |project|
-  project.debug_configuration :debug
-end
-```
-There are two main ways you can customize a Project, Targets and Configurations.
+A project is automatically created from a `Cakefile` below is all of the ways
+you can customize this project.
 
 ###Properties
 
@@ -63,7 +39,7 @@ There are two main ways you can customize a Project, Targets and Configurations.
 Sets the class prefix for the project
 
 ```ruby
-project.class_prefix = "XC"
+class_prefix = "XC"
 ```
 
 #### Organization
@@ -71,7 +47,7 @@ project.class_prefix = "XC"
 Sets the organization for the project.
 
 ```ruby
-project.organization = "Xcake Productions"
+organization = "Xcake Productions"
 ```
 
 ## Targets
@@ -87,17 +63,13 @@ A project can specify any application targets such as iOS or Mac Apps.
 iOS App:
 
 ```ruby
-Project.new "Workspace" do |project|
-  project.application_for :ios, 8.0
-end
+application_for :ios, 8.0
 ```
 
 Mac App:
 
 ```ruby
-Project.new "Workspace" do |project|
-  project.application_for :mac, 8.0
-end
+application_for :mac, 8.0
 ```
 
 ###Tests
@@ -105,10 +77,8 @@ end
 We can also specify a testing targets for other targets as well:
 
 ```ruby
-Project.new "Workspace" do |project|
-  project.application_for :mac, 8.0 do |target|
-    project.unit_tests_for(target)
-  end
+application_for :mac, 8.0 do |target|
+  unit_tests_for target
 end
 ```
 
@@ -117,10 +87,8 @@ end
 To create watch applications we can simply use the `watch_app_for` method:
 
 ```ruby
-Project.new "Workspace" do |project|
-  project.application_for :mac, 8.0 do |target|
-    project.watch_app_for target, 2.0
-  end
+application_for :mac, 8.0 do |target|
+    watch_app_for target, 2.0
 end
 ```
 
@@ -130,10 +98,8 @@ 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 |project|
-  project.target do |target|
+target do |target|
     target.name = "Target"
-  end
 end
 ```
 
@@ -180,6 +146,32 @@ Sets the primary language of the target, can be `:objc` or `:swift`.
 target.language = :swift
 ```
 
+#### Include Files
+
+Sets the files to be included for a target, files and groups will be added
+to the project to match the file system.
+
+[See Here](https://guides.cocoapods.org/syntax/podspec.html#group_file_patterns)
+for file patterns
+
+```ruby
+target.include_files = "DifferentAppFolder/*.*"
+target.include_files << "OtherFolder/*.*"
+```
+
+#### Exclude Files
+
+Sets the files to be excluded for a target, if no target uses these files they
+will be excluded from the project
+
+[See Here](https://guides.cocoapods.org/syntax/podspec.html#group_file_patterns)
+for file patterns
+
+```ruby
+target.exclude_files = "FolderToIgnore/*.*"
+target.exclude_files << "OtherFolderToIgnore/*.*"
+```
+
 ## Configurations
 
 Configurations are an abstraction of build settings and scheme settings. Depending
@@ -194,7 +186,15 @@ 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
+debug_configuration :staging
+```
+
+We can modify settings for each configuration easily.
+
+```ruby
+debug_configuration :staging do |configuration|
+  configuration.settings["KEY"] = "VALUE"
+end
 ```
 
 ### Release Configurations
@@ -203,7 +203,15 @@ 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
+release_configuration :release
+```
+
+We can modify settings for each configuration easily.
+
+```ruby
+release_configuration :release do |configuration|
+  configuration.settings["KEY"] = "VALUE"
+end
 ```
 
 ### All Configurations
@@ -212,7 +220,25 @@ 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
+all_configurations.supported_devices = :iphone_only
+```
+
+### Targets
+
+To modify settings for certain target, then its as simple as prefixing the
+target we want to modify the configuration for.
+
+```ruby
+
+target.all_configurations.supported_devices = :iphone_only
+
+debug_configuration :staging do |configuration|
+  configuration.settings["KEY"] = "VALUE"
+end
+
+target.release_configuration :release do |configuration|
+  configuration.settings["KEY"] = "VALUE"
+end
 ```
 
 ### Configuration Hiearchy

data/docs/Getting Started.md

@@ -14,34 +14,18 @@ so we're going to need some command line magic:
 So we should have a folder called "MyProject" with a textfile named "Cakefile" inside of it,
 Xcake will look for this textfile, so make sure to keep it's name the same.
 
-This is all great but there are still no signs of a Project; Don't worry we still need to
-write some code to describe what the project should look like. So our first step is declaring
-we want to create a new project.
-
-So now in your textfile, type the following:
-
-```ruby
-Project.new do |c|
-end
-```
-
-This code is quite clearly telling xcake to create a new project; So lets see what happens.
-If we go to our folder and run `xcake` we should now have our xcode project. *phew* that was easy!
-
-If we open it however it's not quite ready to use, it's still lacking any targets to actually build.
+Now, If we run `xcake bake` we should now have our xcode project. *phew* that was easy! If we open it however it's not quite ready to use, it's still lacking any targets to actually build.
 So let's fix that :)
 
 We're going to create an app for iOS 9.0 called `MyApp`, hopefully the syntax should be easy to grasp:
 
 ```ruby
-Project.new do |c|
-  c.application_for :ios, 9.0 do |t|
-    t.name = "MyApp"
-  end
+application_for :ios, 9.0 do |target|
+  target.name = "MyApp"
 end
 ```
 
-Now if we run `xcake` again, we get the same project file but now with a target. In addition to this
+Now if we run `xcake bake` again, we get the same project file but now with a target. In addition to this
 xcake has created a `debug` and `release` build configuration as well as two schemes for our target
 and these build configurations.
 
@@ -52,18 +36,14 @@ be a `debug` configuration so that the default build settings are optimised for
 So lets add it, configurations are defined project-wide so we do it like this:
 
 ```ruby
-Project.new do |c|
-
-  c.debug_configuration :staging
-
-  c.application_for :ios, 9.0 do |t|
-    t.name = "MyApp"
-  end
+debug_configuration :staging
 
+application_for :ios, 9.0 do |target|
+  target.name = "MyApp"
 end
 ```
 
-Again we run `xcake` and voilla! Pretty easy but now if we open up our project
+Again we run `xcake bake` and voilla! Pretty easy but now if we open up our project
 our `debug` and `release` configurations are gone. Xcake operates an opt-out system, Xcode projects won't open
 without any configurations so Xcake provides these configurations as a sensible default. But as soon as we
 provide our own configurations we are opting out of these defaults.
@@ -72,16 +52,12 @@ Xcake does this to force us to make sure we have everything setup as we need it,
 its just an extra couple of lines:
 
 ```ruby
-Project.new do |c|
-
-  c.debug_configuration :staging
-  c.debug_configuration :debug
-  c.release_configuration :release
-
-  c.application_for :ios, 9.0 do |t|
-    t.name = "MyApp"
-  end
+debug_configuration :staging
+debug_configuration :debug
+release_configuration :release
 
+application_for :ios, 9.0 do |target|
+  target.name = "MyApp"
 end
 ```
 

data/docs/Xcode Project Support.md

@@ -23,7 +23,7 @@ This document describes the level of support Xcake has for the various aspects o
 - Set platform
 - Set deployment target
 - Specify device (Universal, iPad Only or iPhone Only)
-- Specifying Files and Assets to include for Target
+- Specifying Files and Assets to include or exclude for Target
 - Specifying Frameworks to include for Target
 - Specify build settings via configurations
 - Simple methods for creating iOS, Mac and WatchOS Applications.

data/lib/xcake/command/bake.rb

@@ -0,0 +1,28 @@
+module Xcake
+  class Command
+    class Bake < Command
+      self.summary = "Makes the Xcode project from a Cakefile"
+      self.description = "Makes the Xcode project from a Cakefile"
+
+      def run
+        file_path = "#{Dir.pwd}/Cakefile"
+
+        unless File.exist?(file_path)
+          raise Xcake::Informative, "Couldn't find Cakefile"
+        end
+
+        puts "Reading Cakefile..."
+        file_contents = File.read(file_path)
+
+        project = Project.new
+        project.instance_eval(file_contents)
+
+        resolver = ProjectStructureResolver.new
+        project.accept(resolver)
+
+        generator = Generator::Project.new
+        project.accept(generator)
+      end
+    end
+  end
+end

data/lib/xcake/command/init.rb

@@ -0,0 +1,16 @@
+module Xcake
+  class Command
+    class Init < Command
+      self.summary = "Initilises an example Cakefile for creating a project"
+      self.description = "Initilises an example Cakefile for creating a project"
+
+      def run
+        cakefile_path = "#{File.dirname(__FILE__)}/../resources/Cakefile"
+        cakefile_contents = File.read(cakefile_path)
+        File.write("Cakefile", cakefile_contents)
+
+        puts "Open Cakefile to edit and run xcake bake to get your xcode project"
+      end
+    end
+  end
+end

data/lib/xcake/command.rb

@@ -3,26 +3,13 @@ require "claide"
 module Xcake
   class Command < CLAide::Command
 
+    require "xcake/command/init"
+    require "xcake/command/bake"
+
+    self.abstract_command = true
     self.command = "xcake"
     self.version = VERSION
     self.description = "Create and maintain Xcode project files easily."
-
-    def run
-      file_path = "#{Dir.pwd}/Cakefile"
-
-      unless File.exist?(file_path)
-        raise Xcake::Informative, "Couldn't find Cakefile"
-      end
-
-      puts "Reading Cakefile..."
-      file_contents = File.read(file_path)
-      cakefile = eval(file_contents)
-
-      resolver = ProjectStructureResolver.new
-      cakefile.accept(resolver)
-
-      generator = Generator::Project.new
-      cakefile.accept(generator)
-    end
+    self.plugin_prefixes = %w(claide xcake)
   end
 end

data/lib/xcake/resources/Cakefile

@@ -0,0 +1,53 @@
+# Replace this with your class prefix for Objective-C files.
+class_prefix = "APP"
+
+# By default Xcake defaults to creating the standard Debug and Release
+# configurations, uncomment these lines to add your own.
+#
+#debug_configuration :Staging
+#debug_configuration :Debug
+#release_configuration :Release
+
+# Change these to the platform you wish to support (ios, osx) and the
+# version of that platform (8.0, 9.0, 10.10, 10.11)
+#
+application_for :ios, 8.0 do |target|
+
+    #Update these with the details of your app
+    target.name = "YourApp"
+    target.all_configurations.product_bundle_identifier = "com.yourcompany.yourapp"
+
+    # Uncomment to target iPhone devices only
+    #
+    # File patterns can be seen here https://guides.cocoapods.org/syntax/podspec.html#group_file_patterns
+    #
+    #target.all_configurations.supported_devices = :iphone_only
+
+    # Uncomment this to include additional files
+    #
+    #target.include_files << "FolderToInclude/*.*"
+
+    # Uncomment this to exclude additional files
+    #
+    # File patterns can be seen here https://guides.cocoapods.org/syntax/podspec.html#group_file_patterns
+    #
+    #target.exclude_files << "ExcludeToInclude/*.*"
+
+    # Uncomment to set your own build settings
+    #
+    #target.all_configurations.settings["ENABLE_BITCODE"] = "NO"
+    #target.all_configurations.settings["GCC_PREFIX_HEADER"] = "APP-Prefix-Header.pch"
+    #target.all_configurations.settings["SWIFT_OBJC_BRIDGING_HEADER"] = "APP-Bridging-Header.h"
+
+    # Uncomment to define your own preprocessor macros
+    #
+    #target.all_configurations.preprocessor_definitions["API_ENDPOINT"] = "https://example.org".to_obj_c
+
+    # Comment to remove Unit Tests for your app
+    #
+    unit_tests_for target
+
+    # Uncomment to create a Watch App for your application.
+    #
+    #watch_app_for target, 2.0
+end

data/lib/xcake/version.rb

@@ -1,3 +1,3 @@
 module Xcake
-  VERSION = "0.4.8"
+  VERSION = "0.5.0"
 end

data/lib/xcake.rb

@@ -1,4 +1,3 @@
-
 require "xcake/core_ext/string"
 
 require "xcake/visitable"
@@ -6,7 +5,9 @@ require "xcake/visitor"
 require "xcake/version"
 
 require "xcake/informative"
+
 require "xcake/command"
+
 require "xcake/configuration"
 require "xcake/configuration/sugar"
 require "xcake/configuration/proxies/preproccessor_definitions_setting_proxy"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcake
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.5.0
 platform: ruby
 authors:
 - James Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,6 +184,8 @@ files:
 - lib/fastlane_plugin.rb
 - lib/xcake.rb
 - lib/xcake/command.rb
+- lib/xcake/command/bake.rb
+- lib/xcake/command/init.rb
 - lib/xcake/configurable.rb
 - lib/xcake/configuration.rb
 - lib/xcake/configuration/proxies/preproccessor_definitions_setting_proxy.rb
@@ -207,6 +209,7 @@ files:
 - lib/xcake/project/hooks.rb
 - lib/xcake/project/sugar.rb
 - lib/xcake/project_structure_resolver.rb
+- lib/xcake/resources/Cakefile
 - lib/xcake/target.rb
 - lib/xcake/version.rb
 - lib/xcake/visitable.rb
@@ -235,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: DSL for Xcode Projects.