synx 0.0.2

data/spec/dummy/dummy.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "self:dummy.xcodeproj">
+   </FileRef>
+</Workspace>

data/spec/dummy/dummy/AlreadySynced/Core Data.xcdatamodeld/.xccurrentversion

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>_XCCurrentVersionName</key>
+	<string>Core Data 3.xcdatamodel</string>
+</dict>
+</plist>

data/spec/dummy/dummy/AlreadySynced/Core Data.xcdatamodeld/Core Data 2.xcdatamodel/contents

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<model userDefinedModelVersionIdentifier="" type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="5064" systemVersion="13C64" minimumToolsVersion="Xcode 4.3" macOSVersion="Automatic" iOSVersion="Automatic">
+    <elements/>
+</model>

data/spec/dummy/dummy/AlreadySynced/Core Data.xcdatamodeld/Core Data 3.xcdatamodel/contents

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<model userDefinedModelVersionIdentifier="" type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="5064" systemVersion="13C64" minimumToolsVersion="Xcode 4.3" macOSVersion="Automatic" iOSVersion="Automatic">
+    <elements/>
+</model>

data/spec/dummy/dummy/AlreadySynced/Core Data.xcdatamodeld/Core Data 4.xcdatamodel/contents

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<model userDefinedModelVersionIdentifier="" type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="5064" systemVersion="13C64" minimumToolsVersion="Xcode 4.3" macOSVersion="Automatic" iOSVersion="Automatic">
+    <elements/>
+</model>

data/spec/dummy/dummy/AlreadySynced/Core Data.xcdatamodeld/Core Data.xcdatamodel/contents

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<model userDefinedModelVersionIdentifier="" type="com.apple.IDECoreDataModeler.DataModel" documentVersion="1.0" lastSavedToolsVersion="5064" systemVersion="13C64" minimumToolsVersion="Xcode 4.3" macOSVersion="Automatic" iOSVersion="Automatic">
+    <elements/>
+</model>

data/spec/dummy/dummy/AlreadySynced/FolderNotInXcodeProj/NSObject+abc.h

@@ -0,0 +1,13 @@
+//
+//  NSObject+abc.h
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface NSObject (abc)
+
+@end

data/spec/dummy/dummy/AlreadySynced/FolderNotInXcodeProj/NSObject+abc.m

@@ -0,0 +1,13 @@
+//
+//  NSObject+abc.m
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import "NSObject+abc.h"
+
+@implementation NSObject (abc)
+
+@end

data/spec/dummy/dummy/AlreadySynced/FolderNotInXcodeProj/Wowwww.h

@@ -0,0 +1,13 @@
+//
+//  Wowwww.h
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface Wowwww : NSObject
+
+@end

data/spec/dummy/dummy/AlreadySynced/FolderNotInXcodeProj/Wowwww.m

@@ -0,0 +1,13 @@
+//
+//  Wowwww.m
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import "Wowwww.h"
+
+@implementation Wowwww
+
+@end

data/spec/dummy/dummy/AlreadySynced/Woot.h

@@ -0,0 +1,13 @@
+//
+//  Woot.h
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface Woot : NSObject
+
+@end

data/spec/dummy/dummy/AlreadySynced/Woot.m

@@ -0,0 +1,13 @@
+//
+//  Woot.m
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import "Woot.h"
+
+@implementation Woot
+
+@end

data/spec/dummy/dummy/ManyFiles.h

@@ -0,0 +1,13 @@
+//
+//  ManyFiles.h
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface ManyFiles : NSObject
+
+@end

data/spec/dummy/dummy/ManyFiles.m

@@ -0,0 +1,13 @@
+//
+//  ManyFiles.m
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import "ManyFiles.h"
+
+@implementation ManyFiles
+
+@end

data/spec/dummy/dummy/Wow.h

@@ -0,0 +1,13 @@
+//
+//  Wow.h
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface Wow : NSObject
+
+@end

data/spec/dummy/dummy/Wow.m

@@ -0,0 +1,13 @@
+//
+//  Wow.m
+//  dummy
+//
+//  Created by Mark Larsen on 5/9/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import "Wow.h"
+
+@implementation Wow
+
+@end

data/spec/dummy/dummy/dummy-Prefix.pch

@@ -0,0 +1,9 @@
+//
+//  Prefix header
+//
+//  The contents of this file are implicitly included at the beginning of every source file.
+//
+
+#ifdef __OBJC__
+    #import <Foundation/Foundation.h>
+#endif

data/spec/dummy/dummy/dummy.h

@@ -0,0 +1,13 @@
+//
+//  dummy.h
+//  dummy
+//
+//  Created by Mark Larsen on 4/27/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface dummy : NSObject
+
+@end

data/spec/dummy/dummy/dummy.m

@@ -0,0 +1,13 @@
+//
+//  dummy.m
+//  dummy
+//
+//  Created by Mark Larsen on 4/27/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import "dummy.h"
+
+@implementation dummy
+
+@end

data/spec/dummy/dummyTests/dummyTests-Info.plist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleExecutable</key>
+	<string>${EXECUTABLE_NAME}</string>
+	<key>CFBundleIdentifier</key>
+	<string>marklarr.${PRODUCT_NAME:rfc1034identifier}</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>

data/spec/dummy/dummyTests/dummyTests-prefix.pch

@@ -0,0 +1,15 @@
+//
+//  dummyTests-prefix.pch
+//  dummy
+//
+//  Created by Mark Larsen on 5/13/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#ifndef dummy_dummyTests_prefix_pch
+#define dummy_dummyTests_prefix_pch
+
+// Include any system framework and library headers here that should be included in all compilation units.
+// You will also need to set the Prefix Header build setting of one or more of your targets to reference this file.
+
+#endif

data/spec/dummy/dummyTests/dummyTests.m

@@ -0,0 +1,34 @@
+//
+//  dummyTests.m
+//  dummyTests
+//
+//  Created by Mark Larsen on 4/27/14.
+//  Copyright (c) 2014 marklarr. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+
+@interface dummyTests : XCTestCase
+
+@end
+
+@implementation dummyTests
+
+- (void)setUp
+{
+    [super setUp];
+    // Put setup code here. This method is called before the invocation of each test method in the class.
+}
+
+- (void)tearDown
+{
+    // Put teardown code here. This method is called after the invocation of each test method in the class.
+    [super tearDown];
+}
+
+- (void)testExample
+{
+    XCTFail(@"No implementation for \"%s\"", __PRETTY_FUNCTION__);
+}
+
+@end

data/spec/dummy/dummyTests/en.lproj/InfoPlist.strings

@@ -0,0 +1,2 @@
+/* Localized versions of Info.plist keys */
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'synx'
+require 'pry'
+require 'coveralls'
+
+Coveralls.wear!
+
+RSpec.configure do |config|
+end

data/spec/synx/expected_file_structure.yml

@@ -0,0 +1,44 @@
+dummy:
+  Resources:
+    image.png:
+  data.json:
+  image-not-in-xcodeproj.png:
+  AlreadySynced:
+    Core Data.xcdatamodeld:
+      Core Data.xcdatamodel:
+        contents:
+      Core Data 2.xcdatamodel:
+        contents:
+      Core Data 3.xcdatamodel:
+        contents:
+      Core Data 4.xcdatamodel:
+        contents:
+    FolderNotInXcodeProj:
+      AnotherFileNotInXcodeProj.h:
+    NSObject+abc.h:
+    NSObject+abc.m:
+    Woot.h:
+    Woot.m:
+    stuff.xml:
+  GroupThatDoubleReferencesFile:
+    ManyFiles.h:
+    ManyFiles.m:
+  Supporting Files:
+    dummy-Prefix.pch:
+  dummy.h:
+  dummy.m:
+  FileNotInXcodeProj.h:
+  SuchGroup:
+    Wow.h:
+    Wow.m:
+    VeryChildGroup:
+      Wowwww.h:
+      Wowwww.m:
+dummyTests:
+  Other Files:
+    en.lproj:
+      InfoPlist.strings:
+  Supporting Files:
+    dummyTests-Prefix.pch:
+    dummyTests-Info.plist:
+  dummyTests.m:

data/spec/synx/expected_group_structure.yml

@@ -0,0 +1,37 @@
+dummy:
+  Resources:
+    image.png:
+  AlreadySynced:
+    Core Data.xcdatamodeld:
+      Core Data.xcdatamodel:
+        contents:
+      Core Data 2.xcdatamodel:
+        contents:
+      Core Data 3.xcdatamodel:
+        contents:
+      Core Data 4.xcdatamodel:
+        contents:
+    NSObject+abc.h:
+    NSObject+abc.m:
+    Woot.h:
+    Woot.m:
+  GroupThatDoubleReferencesFile:
+    ManyFiles.h:
+    ManyFiles.m:
+  Supporting Files:
+    dummy-Prefix.pch:
+  dummy.h:
+  dummy.m:
+  SuchGroup:
+    Wow.h:
+    Wow.m:
+    VeryChildGroup:
+      Wowwww.h:
+      Wowwww.m:
+dummyTests:
+  Other Files:
+    InfoPlist.strings:
+  Supporting Files:
+    dummyTests-Prefix.pch:
+    dummyTests-Info.plist:
+  dummyTests.m:

data/spec/synx/project_spec.rb

@@ -0,0 +1,218 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+
+class Hash
+  # Return a hash that includes everything but the given keys. This is useful for
+  # limiting a set of parameters to everything but a few known toggles:
+  #
+  #   @person.update_attributes(params[:person].except(:admin))
+  #
+  # If the receiver responds to +convert_key+, the method is called on each of the
+  # arguments. This allows +except+ to play nice with hashes with indifferent access
+  # for instance:
+  #
+  #   {:a => 1}.with_indifferent_access.except(:a)  # => {}
+  #   {:a => 1}.with_indifferent_access.except("a") # => {}
+  #
+  def except(*keys)
+    dup.except!(*keys)
+  end
+
+  # Replaces the hash without the given keys.
+  def except!(*keys)
+    keys.each { |key| delete(key) }
+    self
+  end
+end
+
+describe Synx::Project do
+
+  DUMMY_SYNX_PATH = File.join(File.dirname(__FILE__), '..', 'dummy')
+  DUMMY_SYNX_TEST_PATH = File.join(File.dirname(__FILE__), '..', 'test_dummy')
+  DUMMY_SYNX_TEST_PROJECT_PATH = File.join(DUMMY_SYNX_TEST_PATH, 'dummy.xcodeproj')
+
+  before(:all) do
+    FileUtils.rm_rf(DUMMY_SYNX_TEST_PATH)
+    FileUtils.cp_r(DUMMY_SYNX_PATH, DUMMY_SYNX_TEST_PATH)
+    DUMMY_SYNX_TEST_PROJECT = Synx::Project.open(DUMMY_SYNX_TEST_PROJECT_PATH)
+  end
+
+  describe "#sync" do
+
+    def verify_group_structure(group, expected_structure)
+      expected_structure.each do |object_name, object_children|
+        failure_message = "expected group `#{group.basename}` to have child `#{object_name}`"
+        object = group.children.detect { |child| child.basename == object_name }
+        expect(group).to_not be_nil, failure_message
+
+        if object.instance_of?(Xcodeproj::Project::Object::PBXGroup)
+          object_children ||= {}
+          failure_message = "Expected #{object_name} to have #{object_children.count} children, found #{object.children.count}"
+          expect(object_children.count).to eq(object.children.count), failure_message
+          verify_group_structure(object, object_children) if object_children.count > 0
+        end
+      end
+    end
+
+    def verify_file_structure(dir_pathname, expected_structure)
+      expected_structure.each do |entry_name, entry_entries|
+        entry_pathname = dir_pathname + entry_name
+        expect(File.exist?(entry_pathname) || Dir.exists?(entry_pathname)).to be(true), "Expected #{entry_pathname} to exist"
+
+        if File.directory?(entry_pathname)
+          entry_entries ||= {}
+          # '.' and '..' show up in entries, so add 2
+          failure_message = "Expected #{entry_pathname} to have #{entry_entries.count} children, found #{entry_pathname.entries.count - 2}"
+          expect(entry_entries.count + 2).to eq(entry_pathname.entries.count), failure_message
+          verify_file_structure(entry_pathname, entry_entries) if entry_entries.count > 0
+        end
+      end
+    end
+
+    def expected_file_structure
+      YAML::load_file(File.join(File.dirname(__FILE__), "expected_file_structure.yml"))
+    end
+
+    def expected_group_structure
+      YAML::load_file(File.join(File.dirname(__FILE__), "expected_group_structure.yml"))
+    end
+
+    describe "with no additional options" do
+
+      before(:all) do
+        DUMMY_SYNX_TEST_PROJECT.sync
+      end
+
+      it "should have the correct physical file structure" do
+        verify_file_structure(Pathname(DUMMY_SYNX_TEST_PROJECT_PATH).parent, expected_file_structure)
+      end
+
+      it "should not have modified the Xcode group structure, except for fixing double file references" do
+        verify_group_structure(DUMMY_SYNX_TEST_PROJECT.main_group, expected_group_structure)
+      end
+
+      it "should have updated the pch and info.plist build setting paths" do
+        # dummy target
+        DUMMY_SYNX_TEST_PROJECT.targets.first.each_build_settings do |bs|
+          expect(bs["GCC_PREFIX_HEADER"]).to eq("dummy/Supporting Files/dummy-Prefix.pch")
+          expect(bs["INFOPLIST_FILE"]).to be_nil
+        end
+
+        # dummyTests target
+        DUMMY_SYNX_TEST_PROJECT.targets.last.each_build_settings do |bs|
+          expect(bs["GCC_PREFIX_HEADER"]).to eq("dummyTests/Supporting Files/dummyTests-Prefix.pch")
+          expect(bs["INFOPLIST_FILE"]).to eq("dummyTests/Supporting Files/dummyTests-Info.plist")
+        end
+      end
+    end
+
+    describe "with the prune option toggled" do
+
+      before(:all) do
+        DUMMY_SYNX_TEST_PROJECT.sync(:prune => true)
+      end
+
+      it "should remove unreferenced images and source files if the prune option is toggled" do
+        expected_file_structure_with_removals = expected_file_structure
+        expected_file_structure_with_removals["dummy"].except!("image-not-in-xcodeproj.png")
+        expected_file_structure_with_removals["dummy"].except!("FileNotInXcodeProj.h")
+        expected_file_structure_with_removals["dummy"]["AlreadySynced"]["FolderNotInXcodeProj"].except!("AnotherFileNotInXcodeProj.h")
+        verify_file_structure(Pathname(DUMMY_SYNX_TEST_PROJECT_PATH).parent, expected_file_structure_with_removals)
+      end
+
+      it "should not have modified the Xcode group structure, except for fixing double file references" do
+        verify_group_structure(DUMMY_SYNX_TEST_PROJECT.main_group, expected_group_structure)
+      end
+    end
+
+    describe "with the no_default_exclusions option toggled" do
+
+      before(:all) do
+        DUMMY_SYNX_TEST_PROJECT.sync(:no_default_exclusions => true)
+      end
+
+      it "should have an empty array for default exclusions" do
+        expect(DUMMY_SYNX_TEST_PROJECT.group_exclusions.count).to eq(0)
+      end
+    end
+
+    describe "with group_exclusions provided as options" do
+
+      before(:all) do
+        DUMMY_SYNX_TEST_PROJECT.sync(:group_exclusions => %W(/dummy /dummy/SuchGroup/VeryChildGroup))
+      end
+
+      it "should add the group exclusions to the array" do
+        expect(DUMMY_SYNX_TEST_PROJECT.group_exclusions.sort).to eq(%W(/Libraries /Products /Frameworks /dummy /dummy/SuchGroup/VeryChildGroup).sort)
+      end
+    end
+
+  end
+
+  describe "group_exclusions=" do
+
+    it "should raise an IndexError if any of the groups do not exist" do
+      expect { DUMMY_SYNX_TEST_PROJECT.group_exclusions = %W(/dummy /dummy/DoesntExist) }.to raise_error(IndexError)
+    end
+
+    it "should be fine if the groups all exist" do
+      group_exclusions = %W(/dummy /dummy/GroupThatDoubleReferencesFile /dummy/SuchGroup/VeryChildGroup)
+      DUMMY_SYNX_TEST_PROJECT.group_exclusions = group_exclusions
+
+      expect(DUMMY_SYNX_TEST_PROJECT.group_exclusions).to eq(group_exclusions)
+    end
+  end
+
+  describe "#root_pathname" do
+
+    it "should return the pathname to the directory that the .pbxproj file is inside" do
+      expected = Pathname(File.join(File.dirname(__FILE__), '..', 'test_dummy'))
+      DUMMY_SYNX_TEST_PROJECT.send(:root_pathname).realpath.should eq(expected.realpath)
+    end
+  end
+
+  describe "#work_root_pathname" do
+
+    before(:each) { DUMMY_SYNX_TEST_PROJECT.instance_variable_set("@work_root_pathname", nil) }
+
+    it "should return the pathname to the directory synxchronize will do its work in" do
+      expected = Pathname(Synx::Project.const_get(:SYNXRONIZE_DIR)) + "test_dummy"
+      DUMMY_SYNX_TEST_PROJECT.send(:work_root_pathname).realpath.should eq(expected.realpath)
+    end
+
+    it "should start fresh by removing any existing directory at work_root_pathname" do
+      Pathname.any_instance.stub(:exist?).and_return(true)
+      expect(FileUtils).to receive(:rm_rf)
+
+      DUMMY_SYNX_TEST_PROJECT.send(:work_root_pathname)
+    end
+
+    it "should create a directory at work_root_pathname" do
+      expect_any_instance_of(Pathname).to receive(:mkpath)
+      DUMMY_SYNX_TEST_PROJECT.send(:work_root_pathname)
+    end
+
+    it "should be an idempotent operation but return the same value through memoization" do
+      pathname = DUMMY_SYNX_TEST_PROJECT.send(:work_root_pathname)
+      expect(FileUtils).to_not receive(:rm_rf)
+      expect_any_instance_of(Pathname).to_not receive(:exist?)
+      expect_any_instance_of(Pathname).to_not receive(:mkpath)
+      expect(DUMMY_SYNX_TEST_PROJECT.send(:work_root_pathname)).to be(pathname)
+    end
+  end
+
+  describe "#pathname_to_work_pathname" do
+
+    it "should return the path in work_root_pathname that is relatively equivalent to root_pathname" do
+      pathname = DUMMY_SYNX_TEST_PROJECT.send(:root_pathname) + "some" + "path" + "to" + "thing"
+
+      value = DUMMY_SYNX_TEST_PROJECT.send(:pathname_to_work_pathname, pathname)
+      expected = DUMMY_SYNX_TEST_PROJECT.send(:work_root_pathname) + "some" + "path" + "to" + "thing"
+
+      expect(value).to eq(expected)
+    end
+  end
+end