cocoaseeds 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f3433a51f3e7393a8d018c462d0d62839830334
-  data.tar.gz: 5a4264434da64f6c04376056c8733ef61f3efe33
+  metadata.gz: 0d0c7b367ac3f9e070093e852bd6feaeebf37380
+  data.tar.gz: 2485e3e4561c01713cd5d89215c6c1637b7b711a
 SHA512:
-  metadata.gz: 7090d075190b340e8c71db3d5cec71a330f81000e9de3e562a1a2d1a653b5a405a458c580146e9be1f3bba4238bdab8ca2bc5aa972ed817a4ed6a0d6a3a71620
-  data.tar.gz: ebd2667fc734c4b2192aac7b67d824ff4725765b95e892d59d989809020d647be69a1dfaac2f615958b087eedf739e7116c7ff2add7155746a528509a106f6d8
+  metadata.gz: ec7d40fab0e7a5312f36d786634c453ef7ebdcd5368d6b505cb35f2f777c9f7eb23745db55f1169b24a33190c3f8e1ce995ff840b80753218704c1ad096c61a6
+  data.tar.gz: eb28719ea77e6bcea502a2b36f5952ede136a10d9dad717e91b1c57682f379335cbd8c4692471d8689775e35f8602719a33cddc9633786b5c42e99bb98a71720

data/lib/cocoaseeds/core.rb

@@ -1,12 +1,81 @@
 module Seeds
   class Core
+
+    # @return [String] project folder path
+    #
+    attr_reader :root_path
+
+    # @return [Boolean] whether display outputs
+    #
     attr_accessor :mute
 
-    attr_reader :root_path, :seedfile_path, :lockfile_path
-    attr_accessor :project, :seedfile, :lockfile
-    attr_reader :seeds, :locks, :targets
-    attr_reader :source_files, :file_references
+    # @return [String] Seedfile path
+    #
+    # @!visibility private
+    #
+    attr_reader :seedfile_path
+
+    # @return [String] Seedfile.lock path
+    #
+    # @!visibility private
+    #
+    attr_reader :lockfile_path
+
+    # @return [Xcodeproj::Project] Xcode project
+    #
+    # @!visibility private
+    #
+    attr_accessor :project
+
+    # @return [String] content of Seedfile
+    #
+    # @!visibility private
+    #
+    attr_accessor :seedfile
+
+    # @return [String] content of Seedfile.lock
+    #
+    # @!visibility private
+    #
+    attr_accessor :lockfile
+
+    # @return [Hash{Sting => Seeds::Seed}] seeds by seed name
+    #
+    # @!visibility private
+    #
+    attr_reader :seeds
 
+    # @return [Hash{Sting => Seeds::Seed}] locked dependencies by seed name
+    #
+    # @!visibility private
+    #
+    attr_reader :locks
+
+    # @return [Hash{Sting => String}] target name by seed name
+    #
+    # @!visibility private
+    #
+    attr_reader :targets
+
+    # @return [Hash{Sting => Seeds::Seed}] source file paths by seed name
+    #
+    # @!visibility private
+    #
+    attr_reader :source_files
+
+    # @return [Array<Xcodeproj::Project::Object::PBXFileReference>]
+    #         file references that will be added to project
+    #
+    # @!visibility private
+    #
+    attr_reader :file_references
+
+    # @param  [String] root_path
+    #         The path provided will be used for detecting Xcode project and
+    #         Seedfile.
+    #
+    # @see #root_path
+    #
     def initialize(root_path)
       @root_path = root_path
       @seedfile_path = File.join(root_path, "Seedfile")
@@ -18,6 +87,11 @@ module Seeds
       @file_references = []
     end
 
+    # Read Seedfile and install dependencies. An exception will be raised if
+    # there is no .xcodeproj file or Seedfile in the {#root_path}.
+    #
+    # @see #root_path
+    #
     def install
       self.prepare_requirements
       self.analyze_dependencies
@@ -35,6 +109,13 @@ module Seeds
       @file_references = []
     end
 
+    # Read Xcode project, Seedfile and lockfile. An exception will be raised if
+    # there is no .xcodeproj file or Seedfile in the {#root_path}.
+    #
+    # @see #root_path
+    #
+    # @!visibility private
+    #
     def prepare_requirements
       # .xcodeproj
       project_filename = Dir.glob("#{root_path}/*.xcodeproj")[0]
@@ -57,6 +138,12 @@ module Seeds
       end
     end
 
+    # Parses Seedfile.lockfile into {#lockfile}.
+    #
+    # @see #lockfile
+    #
+    # @!visibility private
+    #
     def analyze_dependencies
       say "Anaylizing dependencies"
 
@@ -72,28 +159,47 @@ module Seeds
       end
     end
 
+    # Executes {#seedfile} using `eval`
+    #
+    # @!visibility private
+    #
     def execute_seedfile
+      @current_target_name = nil
+
+      # Sets `@current_target_name` and executes code block.
+      #
+      # @param [String] names The name of target.
+      #
+      # @!scope method
+      # @!visibility private
+      #
       def target(*names, &code)
         names.each do |name|
           name = name.to_s  # use string instead of symbol
-          @current_target_name = name
-
           target = self.project.target_named(name)
           if not target
             raise Seeds::Exception.new\
               "#{self.project.path.basename} doesn't have a target `#{name}`"
           end
 
+          @current_target_name = name
           code.call()
         end
+        @current_target_name = nil
       end
 
+      # Creates a new instance of {#Seeds::Seed::GitHub} and adds to {#seeds}.
+      #
+      # @see #Seeds::Seed::GitHub
+      #
+      # @!scope method
+      # @!visibility private
+      #
       def github(repo, tag, options={})
         if not @current_target_name  # apply to all targets
           target *self.project.targets.map(&:name) do
             send(__callee__, repo, tag, options)
           end
-          @current_target_name = nil
         else
           seed = Seeds::Seed::GitHub.new
           seed.url = "https://github.com/#{repo}"
@@ -104,15 +210,18 @@ module Seeds
             seed.files = [seed.files]
           end
           self.seeds[seed.name] = seed
-          self.targets[@current_target_name] ||= []
-          self.targets[@current_target_name] << seed
+          self.targets[seed.name] ||= []
+          self.targets[seed.name] << @current_target_name.to_s
         end
       end
 
       eval seedfile
-      @current_target_name = nil
     end
 
+    # Removes disused seeds.
+    #
+    # @!visibility private
+    #
     def remove_seeds
       removings = self.locks.keys - self.seeds.keys
       removings.each do |name|
@@ -122,6 +231,10 @@ module Seeds
       end
     end
 
+    # Installs new seeds or updates existing seeds.
+    #
+    # @!visibility private
+    #
     def install_seeds
       self.seeds.sort.each do |name, seed|
         dirname = File.join(self.root_path, "Seeds", name)
@@ -159,6 +272,13 @@ module Seeds
       end
     end
 
+    # Adds source files to the group 'Seeds' and save its reference to
+    # {#file_references} and removes disused sources files,
+    #
+    # @see #file_references
+    #
+    # @!visibility private
+    #
     def configure_project
       say "Configuring #{self.project.path.basename}"
 
@@ -197,35 +317,59 @@ module Seeds
       end
     end
 
+    # Adds file references to the 'Sources Build Phase'.
+    #
+    # @!visibility private
+    #
     def configure_phase
-      self.targets.each do |target_name, seeds|
-        target = self.project.target_named(target_name)
+      self.project.targets.each do |target|
         phase = target.sources_build_phase
-        if not phase
-          raise Seeds::Exception.new\
-            "Target `#{target}` doesn't have build phase 'Compile Sources'."
-        end
+        next if not phase
 
-        # remove zombie file references
-        phase.files_references.each do |file_reference|
+        # remove zombie build files
+        phase.files_references.each do |file|
           begin
-            file_reference.real_path
+            file.real_path
           rescue
-            phase.remove_file_reference(file_reference)
+            phase.files.each do |build_file|
+              phase.files.delete(build_file) if build_file.file_ref == file
+            end
+          end
+        end
+
+        removings = [] # name of seeds going to be removed from the target
+        addings = [] # name of seeds going to be added to the target
+
+        self.targets.keys.sort.each do |seed_name|
+          target_names = self.targets[seed_name]
+          if not target_names.include?(target.name)
+            removings << seed_name if not removings.include?(seed_name)
+          else
+            addings << seed_name if not addings.include?(seed_name)
           end
         end
 
-        # add file references to sources build phase
-        seed_names = seeds.map { |seed| seed.name }
         self.file_references.each do |file|
-          if not phase.include?(file) and seed_names.include?(file.parent.name)
-            uuid = Digest::MD5.hexdigest("#{target_name}:#{file.name}").upcase
+          removings.each do |seed_names|
+            next if not seed_names.include?(file.parent.name)
+            phase.files.each do |build_file|
+              phase.files.delete(build_file) if build_file.file_ref == file
+            end
+          end
+
+          addings.each do |seed_names|
+            next if not seed_names.include?(file.parent.name)
+            uuid = Digest::MD5.hexdigest("#{target.name}:#{file.name}").upcase
             phase.add_file_reference_with_uuid(file, uuid, true)
           end
         end
       end
     end
 
+    # Writes Seedfile.lock file.
+    #
+    # @!visibility private
+    #
     def build_lockfile
       if self.seeds.length > 0
         tree = { "SEEDS" => [] }
@@ -236,6 +380,10 @@ module Seeds
       end
     end
 
+    # Prints a message if {#mute} is `false`.
+    #
+    # @see #mute
+    #
     def say(*strings)
       puts strings.join(" ") if not @mute
     end

data/lib/cocoaseeds/seed.rb

@@ -1,14 +1,33 @@
 module Seeds
   class Seed
-    attr_accessor :name, :version, :url, :files
 
+    # @return [String] the name of the seed
+    #
+    attr_accessor :name
+
+    # @return [String] the version of the seed
+    #
+    attr_accessor :version
+
+    # @return [String] the url of the seed
+    #
+    attr_accessor :url
+
+    # @return [Array<String>] the source file patterns of the seed
+    #
+    attr_accessor :files
+
+    # @return [String] lockfile-formatted string
+    #
+    # @example JLToast (1.2.2)
+    #
     def to_s
       "#{self.name} (#{self.version})"
     end
 
     class GitHub < Seed
       def to_s
-        "#{self.name} (#{self.version}) #{files}"
+        "#{self.name} (#{self.version})"
       end
     end
   end

data/lib/cocoaseeds/version.rb

@@ -1,3 +1,3 @@
 module Seeds
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/cocoaseeds/xcodehelper.rb

@@ -2,6 +2,10 @@ module Xcodeproj
 
   class Project
 
+    # Creates a new object with given UUID.
+    #
+    # @param [String] uuid UUID of the object.
+    #
     def new_with_uuid(klass, uuid)
       if klass.is_a?(String)
         klass = Object.const_get(klass)
@@ -11,10 +15,17 @@ module Xcodeproj
       object
     end
 
+    # Creates a new group with given UUID.
+    #
+    # @param [String] uuid UUID of the object.
+    #
     def new_group_with_uuid(name, uuid, path = nil, source_tree = :group)
       main_group.new_group_with_uuid(name, uuid, path, source_tree)
     end
 
+    # @param [String] name The name of target.
+    # @return the target with given name
+    #
     def target_named(name)
       self.targets.each do |target|
         if target.name == name.to_s
@@ -31,6 +42,11 @@ end
 module Xcodeproj::Project::Object
 
   class PBXGroup
+
+    # Creates a new group with given UUID.
+    #
+    # @param [String] uuid UUID of the object.
+    #
     def new_group_with_uuid(name, uuid, path = nil, source_tree = :group)
       group = project.new_with_uuid(PBXGroup, uuid)
       children << group
@@ -40,6 +56,11 @@ module Xcodeproj::Project::Object
       group
     end
 
+
+    # Creates a file reference with given UUID.
+    #
+    # @param [String] uuid UUID of the object.
+    #
     def new_reference_with_uuid(path, uuid, source_tree = :group)
       # customize `FileReferencesFactory.new_file_reference`
       path = Pathname.new(path)
@@ -62,6 +83,9 @@ module Xcodeproj::Project::Object
   end
 
   class PBXNativeTarget
+
+    # @return 'Sources Build Phase' or `nil`
+    #
     def sources_build_phase()
       self.build_phases.each do |phase|
         if phase.kind_of?(Xcodeproj::Project::Object::PBXSourcesBuildPhase)
@@ -73,6 +97,11 @@ module Xcodeproj::Project::Object
   end
 
   class PBXSourcesBuildPhase
+
+    # Adds the file reference with given UUID.
+    #
+    # @param [String] uuid UUID of the object.
+    #
     def add_file_reference_with_uuid(file_ref, uuid, avoid_duplicates = false)
       if avoid_duplicates && existing = build_file(file_ref)
         existing
@@ -84,18 +113,15 @@ module Xcodeproj::Project::Object
       end
     end
 
+    # @return whether the file names match the pattern.
+    # @param [Regexp] pattern The pattern of file name.
+    #
     def include_filename?(pattern)
-      filenames = self.file_display_names
-      if filenames.length == 0 and pattern
-        return false
+      self.file_display_names.each do |filename|
+        return true if filename.match pattern
       end
-      filenames.each do |filename|
-        if not filename.match pattern
-          return false
-        end
-      end
-      return true
+      false
     end
-  end
 
+  end
 end

data/lib/cocoaseeds.rb

@@ -6,7 +6,7 @@ require 'yaml'
 
 module Seeds
   require 'cocoaseeds/version'
-  require_relative 'cocoaseeds/xcodehelper'
+  require 'cocoaseeds/xcodehelper'
 
   autoload :Command,   'cocoaseeds/command'
   autoload :Core,      'cocoaseeds/core'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoaseeds
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Suyeol Jeon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj
@@ -16,29 +16,32 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: '0.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: '0.24'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.7
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.7
-description: Git Submodule Alternative for Cocoa.
+        version: '0.7'
+description: |-
+  Git Submodule Alternative for Cocoa.
+
+  iOS 7 projects are not available to use Swift librariesfrom CocoaPods or Carthage. CocoaSeeds just downloads thesource code and add to your Xcode project. No staticlibraries, no dynamic frameworks at all. It can be usedwith CocoaPods and Carthage.
 email: devxoul@gmail.com
 executables:
 - seed
@@ -80,3 +83,4 @@ signing_key:
 specification_version: 4
 summary: Git Submodule Alternative for Cocoa.
 test_files: []
+has_rdoc: