synx 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38ba9b910838a673bb8e0199f562abae2e140126
+  data.tar.gz: f9a300779af02f69433fa27e033cad0d293d97a6
+SHA512:
+  metadata.gz: 4d9fe16a2d37b84481703837be549b1c5a0ba4156d9968675d00ed69dc98917cbaef6ea5ec04db1076f6bb21555c03abf14e27fa99fd28024379fd2dbf4ce63d
+  data.tar.gz: c7ce4e21c6e7768e3ff765aa7a9332169593477a761ffa1d2234b0d8df69c6276752ba712a898e8d5f89fb525be7c92c8a86ee62ad0accfbfd61effce33d8e2f

data/.gitignore

@@ -0,0 +1,46 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+*.DS_Store
+
+
+# Spec
+spec/test_dummy/

data/.travis.yml

@@ -0,0 +1,20 @@
+language: objective-c
+script: bundle exec rspec
+
+# Sets Travis to run the Ruby specs on OS X machines which are required to
+# build the native extensions of Xcodeproj.
+
+env:
+  - RVM_RUBY_VERSION=system
+  - RVM_RUBY_VERSION=2.1.1
+
+before_install:
+  - curl http://curl.haxx.se/ca/cacert.pem -o /usr/local/share/cacert.pem
+  - source ~/.rvm/scripts/rvm
+  - if [[ $RVM_RUBY_VERSION != 'system' ]]; then rvm install $RVM_RUBY_VERSION; fi
+  - rvm use $RVM_RUBY_VERSION
+  - if [[ $RVM_RUBY_VERSION == 'system' ]]; then export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future; fi
+  - if [[ $RVM_RUBY_VERSION == 'system' ]]; then sudo gem install bundler --no-ri --no-rdoc; else gem install bundler --no-ri --no-rdoc; fi
+
+install:
+  - bundle install --without=documentation --path ./travis_bundle_dir

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in synx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Larsen
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,70 @@
+[![Gem Version](https://badge.fury.io/rb/synx.svg)](http://badge.fury.io/rb/synx)
+![Travis](https://travis-ci.org/venmo/synx.svg?branch=master)
+
+![synx logo](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx-logo.png?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC1sb2dvLnBuZyIsImV4cGlyZXMiOjE0MDE5MzExNDF9--6c8a22318eaafed2185cb16d39189dcadb75c742)
+
+A command-line tool that automagically reorganizes your Xcode project folder.
+
+![synx gif](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx.gif?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC5naWYiLCJleHBpcmVzIjoxNDAxODU2NzAyfQ%3D%3D--fc7d8546f3d4860df9024b1ee82ea13b86a2da88)
+
+##### Xcode
+
+![synx Xcode](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx-Xcode.jpg?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC1YY29kZS5qcGciLCJleHBpcmVzIjoxNDAxOTMxMDY5fQ%3D%3D--969e312f6ee33430855c495f25d9f5ff78fa9e96)
+
+##### Finder
+
+![synx finder before/after](https://raw.githubusercontent.com/venmo/synx/marklarr/dev/docs/images/synx-finder-before-after.png?token=760261__eyJzY29wZSI6IlJhd0Jsb2I6dmVubW8vc3lueC9tYXJrbGFyci9kZXYvZG9jcy9pbWFnZXMvc3lueC1maW5kZXItYmVmb3JlLWFmdGVyLnBuZyIsImV4cGlyZXMiOjE0MDE5MzEwOTd9--8cff7616e4af2f6f2eed624623092745184c0235)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'synx'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install synx
+
+## Usage
+
+### Basic
+
+**WARNING: Make sure that your project is backed up through source control before doing anything**
+
+Execute the command on your project to have it reorganize the files on the file system:
+
+     $ synx path/to/my/project.xcodeproj
+     
+It may have confused cocoapods. Pod install, if you use them:
+
+    $ pod
+    
+You're good to go!
+
+### Advanced
+
+Synx supports the following options:
+
+```
+  --prune, -p                   remove source files and image resources that are not referenced by the the xcode project
+  --no-default-exclusions       doesn't use the default exclusions of /Libraries, /Frameworks, and /Products
+  --exclusion, -e EXCLUSION     ignore an Xcode group while syncing
+```
+
+OCMock, for example, could have done:
+
+    $ synx -p -e=OCMock/Core -e=OCKMockTests Source/OCMock.xcodeproj
+
+if they wanted to not sync the `OCMock/Core` and `OCMockTests` groups, and also remove (`-p`) any image/source files found by Synx that weren't ever referenced by any groups in Xcode.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/synx/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/synx

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'clamp'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'synx')
+
+Clamp do
+
+  parameter "xcodeproj", "Path to the xcodeproj", :attribute_name => :xcodeproj_path
+  option ["--prune", "-p"], :flag, "remove source files and image resources that are not referenced by the the xcode project"
+  option "--no-default-exclusions", :flag, "doesn't use the default exclusions of /Libraries, /Frameworks, and /Products"
+  option ["--exclusion", "-e"], "EXCLUSION", "ignore an Xcode group while syncing", :multivalued => true
+
+  def execute
+    project = Synx::Project.open(xcodeproj_path)
+    project.sync(:prune => prune?, :no_default_exclusions => no_default_exclusions?, :group_exclusions => exclusion_list)
+  end
+
+end

data/lib/synx.rb

@@ -0,0 +1,13 @@
+require "synx/version"
+require "synx/project"
+require "synx/pbx_file_reference"
+require "synx/pbx_group"
+require "synx/abstract_object"
+require "synx/pbx_native_target"
+require "synx/pbx_variant_group"
+require "synx/tabber"
+
+require "colored"
+
+module Synx
+end

data/lib/synx/abstract_object.rb

@@ -0,0 +1,44 @@
+require 'xcodeproj'
+
+module Xcodeproj
+  class Project
+    module Object
+      class AbstractObject
+
+        def basename
+          name || path || Pathname(real_path).basename.to_s
+        end
+
+        def referring_groups
+          referrers.select { |ref| ref.instance_of?(Xcodeproj::Project::Object::PBXGroup) }
+        end
+
+        def work_pathname
+          # hierarchy path has a leading '/' that will break path concatenation
+          @work_pathname ||= project.work_root_pathname + hierarchy_path[1..-1]
+        end
+
+        def ensure_internal_consistency(group)
+          @removed_from_groups = []
+          if referring_groups.count > 1
+            # Files should only have one referring group -- this is an internal consistency issue if there is more than 1.
+            # Just remove all referring groups but the one we're syncing with
+
+            referring_groups.each do |rg|
+              unless rg == group
+                rg.remove_reference(self) unless rg == group
+                @removed_from_groups << rg.hierarchy_path
+              end
+            end
+
+          end
+        end
+
+        def sync(group)
+          raise NotImplementedError
+        end
+
+      end
+    end
+  end
+end

data/lib/synx/pbx_file_reference.rb

@@ -0,0 +1,70 @@
+require 'xcodeproj'
+
+module Xcodeproj
+  class Project
+    module Object
+      class PBXFileReference
+        
+        def sync(group)
+          if should_sync?
+            if should_move?
+              FileUtils.mv(real_path.to_s, group.work_pathname.to_s)
+              # TODO: move out to abstract_object
+              self.source_tree = "<group>"
+              self.path = real_path.basename.to_s
+            else
+              # Don't move this file around -- it's not even inside the structure. Just fix the relative reference
+              self.path = real_path.relative_path_from((project.work_pathname_to_pathname(group.work_pathname))).to_s
+            end
+            change_build_settings_reference
+
+            output
+          else
+            Synx::Tabber.puts "skipped #{basename}".red
+          end
+        end
+
+        def output
+          build_settings_ammended = "(build settings ammended: #{@setting_keys_changed.join(", ")})" if @setting_keys_changed.count > 0
+          removed_from_groups = "(had multiple parent groups, removed from groups: #{@removed_from_groups.join(", ")})" if @removed_from_groups.count > 0
+          str_output = "#{basename} #{build_settings_ammended} #{removed_from_groups}"
+          str_output = str_output.yellow if removed_from_groups || build_settings_ammended
+          Synx::Tabber.puts str_output
+        end
+
+        def should_sync?
+          # Don't sync files that don't exist or are Apple/Build stuff
+          real_path.exist? && !(real_path.to_s =~ /^\$\{(SDKROOT|DEVELOPER_DIR|BUILT_PRODUCTS_DIR)\}/)
+        end
+        private :should_sync?
+
+        def should_move?
+          # Don't move these files around -- they're not even inside the structure. Just fix the relative references.
+          !(real_path.to_s =~ /\.xcodeproj$/) && project.pathname_is_inside_root_pathname?(real_path)
+        end
+        private :should_move?
+
+        # Fixes things like pch, info.plist references being changed
+        def change_build_settings_reference
+          @setting_keys_changed = []
+          return unless basename =~ /\.(pch|plist)$/
+          
+          project.targets.each do |t|
+            t.each_build_settings do |bs|
+              ["INFOPLIST_FILE", "GCC_PREFIX_HEADER"].each do |setting_key|
+                setting_value = bs[setting_key]
+                if setting_value == real_path.relative_path_from(project.root_pathname).to_s
+                  bs[setting_key] = hierarchy_path[1..-1]
+                  @setting_keys_changed << setting_key
+                end
+              end if bs
+            end
+          end
+
+          @setting_keys_changed.uniq!
+        end
+
+      end
+    end
+  end
+end

data/lib/synx/pbx_group.rb

@@ -0,0 +1,126 @@
+require 'xcodeproj'
+
+module Xcodeproj
+  class Project
+    module Object
+      class PBXGroup
+        
+        def sync(group)
+          ensure_internal_consistency(group)
+          if excluded_from_sync?
+            Synx::Tabber.puts "#{basename}/ (excluded)".yellow
+          else
+            Synx::Tabber.puts "#{basename}/".green
+            Synx::Tabber.increase
+
+            squash_duplicate_file_references
+            work_pathname.mkpath
+            files.each { |pbx_file| pbx_file.sync(self) }
+            all_groups.each { |group| group.sync(self) }
+            sync_path
+
+            Synx::Tabber.decrease
+          end
+        end
+
+        def excluded_from_sync?
+          project.group_exclusions.include?(hierarchy_path)
+        end
+
+        def move_entries_not_in_xcodeproj
+          if excluded_from_sync?
+            Synx::Tabber.puts "#{basename}/ (excluded)".yellow
+          else
+            Synx::Tabber.puts "#{basename}/".green
+            Synx::Tabber.increase
+            Dir[real_path.to_s + "/*"].each do |entry|
+              entry_pathname = real_path + entry
+              unless has_entry?(entry_pathname)
+                handle_unused_entry(entry_pathname)
+              end
+            end
+            all_groups.each(&:move_entries_not_in_xcodeproj)
+            Synx::Tabber.decrease
+          end
+        end
+
+        def sync_path
+          self.path = basename
+          self.source_tree = "<group>"
+        end
+        private :sync_path
+
+        def has_entry?(entry_pathname)
+          %W(. ..).include?(entry_pathname.basename.to_s) || children.any? do |child|
+            child.real_path.cleanpath == entry_pathname.realpath.cleanpath
+          end
+        end
+        private :has_entry?
+
+        def all_groups
+          groups | version_groups | variant_groups
+        end
+
+        def variant_groups
+          children.select { |child| child.instance_of?(Xcodeproj::Project::Object::PBXVariantGroup) }
+        end
+        private :variant_groups
+
+        def handle_unused_entry(entry_pathname)
+          if entry_pathname.directory?
+            project.pathname_to_work_pathname(entry_pathname).mkdir
+            # recurse
+            Synx::Tabber.puts entry_pathname.basename.to_s.green
+            Synx::Tabber.increase
+            entry_pathname.children.each { |child| handle_unused_entry(child) }
+            Synx::Tabber.decrease
+          elsif entry_pathname.file?
+            handle_unused_file(entry_pathname)
+          end
+        end
+        private :handle_unused_entry
+
+        def handle_unused_file(file_pathname)
+          prune_file_extensions = %W(.h .m .xib .mm .c .png .jpg .jpeg)
+          is_file_to_prune = prune_file_extensions.include?(file_pathname.extname.downcase)
+
+          if is_file_to_prune && project.prune
+            Synx::Tabber.puts "#{file_pathname.basename} (removed source/image file that is not referenced by the Xcode project)".red
+            return
+          elsif !project.prune || !is_file_to_prune
+            FileUtils.mv(file_pathname.realpath, project.pathname_to_work_pathname(file_pathname.parent).realpath)
+            if is_file_to_prune
+              Synx::Tabber.puts "#{file_pathname.basename} (source/image file that is not referenced by the Xcode project)".yellow
+            else
+              Synx::Tabber.puts file_pathname.basename
+            end
+          end
+        end
+        private :handle_unused_file
+
+        def squash_duplicate_file_references
+          files.each { |f| f.ensure_internal_consistency(self) }
+
+          grouped_by_path = files.group_by do |file|
+            file.real_path.cleanpath
+          end
+
+          duplicates = grouped_by_path.select do |file_path, files|
+            files.count > 1
+          end
+
+          duplicates.each do |file_path, files|
+            file = files.last
+            # Removes all references (files array)
+            remove_reference(file)
+            # Adds just one back
+            self << file
+            Synx::Tabber.puts "#{file.basename} (removed duplicate reference)".red
+          end
+        end
+        private :squash_duplicate_file_references
+
+      end
+    end
+  end
+end