vendor 0.1.5 → 0.1.6

data/CHANGELOG.md

@@ -5,6 +5,12 @@ Bug Fixes:
   - Improvements to the Plist converter
   - Fixes for projects that have Aggregate Targets
   - Use the correct PList converter on OSX
+  
+## 0.1.6 (February 25, 2013)
+
+Features:
+
+  - Added support for static frameworks
 
 ## 0.1.4 (January 13, 2012)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vendor (0.1.5)
+    vendor (0.1.6)
       highline
       json
       rake

data/LICENSE

@@ -1,4 +1,4 @@
-Portions Copyright (c) Chad Fowler, Rich Kilmer, Jim Weirich and others.
+Copyright (c) Keith Pitt.
 
 MIT License
 

data/Readme.markdown

@@ -114,7 +114,8 @@ Vendor::Spec.new do |s|
   s.source         "https://github.com/keithpitt/DKBenchmark"
   s.docs           "https://github.com/keithpitt/DKBenchmark/wiki"
 
-  s.files          [ "DKBenchmark.h", "DKBenchmark.m" ]
+  s.files          [ "DKBenchmark.h", "DKBenchmark.m", "static-lib.a" ]
+  s.resources      [ "images/loading.png", "images/loading@2x.png" ]
 
   s.build_setting  :other_linker_flags, [ "-ObjC", "+lsdd" ]
   s.build_setting  "CLANG_WARN_OBJCPP_ARC_ABI", false

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/lib/vendor/cli/app.rb

@@ -73,31 +73,27 @@ module Vendor
       desc "install", "Install the libraries defined in your Vendorfile to the current project"
       def install
         vendorfile = File.expand_path("Vendorfile")
-
+        
         unless File.exist?(vendorfile)
           Vendor.ui.error "Could not find Vendorfile"
           exit 1
         end
-
-        projects = Dir["*.xcodeproj"]
-
-        if projects.length > 1
-          Vendor.ui.error "Mutiple projects found #{projects.join(', ')}. I don't know how to deal with this yet."
-          exit 1
-        end
-
-        project = Vendor::XCode::Project.new(projects.first)
+        
+        project_paths = Dir["*.xcodeproj"]
 
         loader = Vendor::VendorFile::Loader.new
         loader.load vendorfile
-        loader.install project
-
-        if project.dirty?
-          project.save
-          Vendor.ui.success "Finished installing into #{project.name}"
-        else
-          Vendor.ui.info "No changes were made to #{project.name}"
+        
+        project_paths.each do |project_path|
+          Vendor.ui.info "Examining #{project_path}"
+          
+          loader.libraries_to_install do |library,targets|
+            library.download
+            Vendor::XCode::Project.new(project_path).install(library,targets)
+          end
+          
         end
+
       end
 
       desc "init", "Generate a simple Vendorfile, placed in the current directory"

data/lib/vendor/spec.rb

@@ -1,34 +1,19 @@
 module Vendor
 
+ 
   class Spec
 
-    ATTRIBUTES = [ :name, :version, :email, :files, :homepage,
-                   :description, :authors, :source, :docs ]
-
-    attr_reader :dependencies
-    attr_reader :frameworks
-    attr_reader :build_settings
-
-    BUILD_SETTING_NAMES = {
-      :other_linker_flags => "OTHER_LDFLAGS"
-    }
-
-    ATTRIBUTES.each do |attr|
-      class_eval %{
-        def #{attr}(*args)
-          if args.length == 1
-            self.#{attr} = args.first
-          else
-            @attributes[:#{attr}]
-          end
-        end
-
-        def #{attr}=(value)
-          @attributes[:#{attr}] = value
-        end
-      }
-    end
-
+    #
+    # Load the specified Vendor specification file. A vendor specification file is
+    # simply the Ruby code to generate a specificatio
+    # 
+    # @note the following method performs an `eval` with the source found within
+    #   the specificed file. This could contain any action native to ruby which
+    #   may lead to unintended or malicous effects.
+    # 
+    # @return [Vendor::Spec] the Vendor::Spec parse and evaluated fom the specified
+    #   file.
+    # 
     def self.load(file)
       # Before evaling we need to chdir into the location of the vendorspec. This is
       # so if the vendorfile does any system calls, they're expecting to be in the right
@@ -40,59 +25,263 @@ module Vendor
       spec
     end
 
+
+    
+    #
+    # Create a new specification
+    # 
+    #     Vendor::Spec.new do |s|
+    #
+    #       s.name           "DKBenchmark"
+    #       s.version        "0.1"
+    #
+    #       s.authors        "keithpitt"
+    #       s.email          "me@keithpitt.com"
+    #       s.description    "Easy benchmarking in Objective-C using blocks"
+    #       s.files          [ "DKBenchmark.h", "DKBenchmark.m" ]
+    # 
+    #     end 
+    # 
+    # @param [Block] block the specified block given allows for additional
+    #   configuration of the Specificattion.
+    #
     def initialize(&block)
       @attributes = {}
+      @build_settings = []
+      @frameworks = []
+      @dependencies = []
       yield(self) if block_given?
     end
 
-    def build_setting(setting, value)
-      @build_settings ||= []
+    # @return [Hash] a hash that contains the attributes defined for the 
+    #   specification. These attributes should be set through the dynamic methods
+    #   defined for each attribute.
+    attr_reader :attributes
 
-      # If you pass in a symbol, it'll try and map it.
-      if setting.kind_of?(Symbol)
-        symbol = setting
-        setting = BUILD_SETTING_NAMES[symbol]
-        raise StandardError.new("No mapping for '#{symbol}' in #{BUILD_SETTING_NAMES.inspect}") unless setting
+    #
+    # @param [Block] block define a validation for the specified attribute to
+    #   ensure that it meets the criteria required for it to be saved properly
+    #   to the vendor specification
+    # 
+    def self.on_validate(&block)
+      (@validations ||= []) << block
+    end
+  
+    # 
+    # Perform a validation on an instance of a Vendor::Spec. This is intended
+    # to be called from the instance itself through the #validate! method.
+    # 
+    # @see Spec#validate!
+    # 
+    def self.validate(spec_instance)
+      @validations.each do |validation|
+        validation.call(spec_instance)
       end
+    end
+    
+    #
+    # Validate the instance. If the vendor specification is considered invalid
+    # an exception will be raised that describes the nature of the validation.
+    # 
+    # @return [void]
+    def validate!
+      self.class.validate(self)
+    end
+  
+    #
+    # Define various attributes of a vendor specification. This method is to be
+    # used internally within the class as a DSL to define various methods and
+    # validations.
+    # 
+    # @param [String,Symbol] name the name of the attribute that will have various
+    #   getters, setters, and validators generated.
+    # 
+    # @param [Hash,Symbol] options additional parameters that allow additional
+    #   configuration of the properties
+    # 
+    def self.attribute(name,options = {})
 
-      # YES/NO Mappings
-      if value === true
-        value = "YES"
-      elsif value === false
-        value = "NO"
+      options = { options => nil } unless options.is_a? Hash
+
+      # Define a traditional setter for the attribute
+      
+      define_method "#{name}=" do |value|
+        @attributes[name] = value
       end
 
-      @build_settings << [ setting, value ]
+      # Define a getter or a setter (depending if the method has been called with
+      # arguments or not)
+
+      define_method "#{name}" do |*args|
+
+        if args.length == 1
+          @attributes[name] = args.first
+        else
+          @attributes[name]
+        end
+        
+      end
+
+      # Define validations for the properties which are marked as required
+
+      if options.key?(:required)
+
+        on_validate do |instance|
+          value = instance.send(name)
+          
+          if value.respond_to?(:empty?) ? value.empty? : !value
+            raise StandardError.new("Specification is missing the `#{name}` option")
+          end
+        end
+        
+      end
+      
     end
 
+    
+    # @attribute 
+    # The name of the vendor specification
+    attribute :name, :required
+    
+    # @attribute
+    # The version of this release
+    attribute :version, :required
+
+    # @attribute
+    # The source files to include in this release of the vendor specification
+    attribute :files, :required
+
+    # @attribute
+    # The resource files to include in this release of the vendor specification
+    attribute :resources
+ 
+    # @attribute
+    # Specifying a build target specific flag for the source files
+    attribute :per_file_flag
+    
+    # @attribute
+    # A description to give users context about this particular vendor specification
+    attribute :description
+
+    # @attribute
+    # The authors responsible for this project
+    attribute :authors
+
+    # @attribute
+    # The email that a user could use to contact with support issues
+    attribute :email, :required
+
+    # @attribute
+    # The homepage where a user could find more information about the project
+    attribute :homepage
+
+    # @attribute
+    # The location where a user could find the original source code
+    attribute :source
+
+    # @attribute
+    # The location where a user could find the documentation about the vendor
+    # specification.
+    attribute :docs
+ 
+    # @see build_setting
+    attr_reader :build_settings
+   
+    #
+    # Add additional build configuration information required for the specification
+    # to build and run succesfully on the installed system.
+    # 
+    # @note currently all build settings that are added here will be uniquely 
+    #   appended to the existing build settings of the target configuration that 
+    # 
+    # @param [String,Symbol] setting the target configuration setting name
+    # 
+    # @note The settings can be specified as their environment variable string 
+    #   (e.g. "GCC_PRECOMPILE_PREFIX_HEADER"). Some of the common properties can 
+    #   be referenced by symbolic names (e.g. :precompile_prefix_headers). The
+    #   current list of supported symbolic names is available in the Xcoder gem.
+    # 
+    # @see https://github.com/rayh/xcoder/blob/master/lib/xcode/configuration.rb
+    # 
+    # @example Specifying build configuration
+    # 
+    #     Vendor::Spec.new do |spec|
+    #       spec.build_setting 'GCC_PRECOMPILE_PREFIX_HEADER', 'YES'
+    #       spec.build_settings :user_header_search_paths, '/custom/header/search/path'
+    #     end
+    # 
+    # @param [String,Symbol,Array] value will be appended to the existing values
+    #   for the given configuration.
+    # 
+    # @return [void]
+    # 
+    def build_setting(setting, value)
+      @build_settings << [ setting, value ]
+    end
+    
+    
+    # @see #framework
+    attr_reader :frameworks
+  
+    #
+    # Load any additional system frameworks or system libraries required by the project.
+    # 
+    # @param [String] name of the System framework
+    # 
+    # @note Frameworks can be specifiedy with or without the framework file
+    #   extension. Also it is assumed that all frameworks specified are system
+    #   frameworks and can be found alongside the other system frameworks.
+    # 
+    # @example Specifying framework with or without the framework extension
+    # 
+    #     Vendor::Spec.new do |spec|
+    #       spec.framework 'CoreGraphics.framework'
+    #       spec.framework 'UIKit'
+    #     end
+    # 
+    # @note Dynamic system libraries must be specified with the `dylib` file
+    #   extension. It is assumed that the all system libraries can be found
+    #   in the `/user/lib` folder.
+    # 
+    # @example Specifying dynamic library
+    # 
+    #     Vendor::Spec.new do |spec|
+    #       spec.framework 'libz.dylib'
+    #     end
+    # 
+    # @return [void] 
+    # 
     def framework(name)
-      @frameworks ||= []
       @frameworks << name
     end
 
+    # @see #dependency
+    attr_reader :dependencies
+
+    #
+    # Specify any additional dependencies for the vendor specification.
+    # 
+    # @param [String] name is the name of the required library
+    # @param [String] version the required version by this specification
+    # 
+    # @return [void]
+    # 
     def dependency(name, version = nil)
-      @dependencies ||= []
       @dependencies << [ name, version ]
     end
-
-    def validate!
-      [ :name, :version, :email, :files ].each do |key|
-        value = self.send(key)
-
-        if value.respond_to?(:empty?) ? value.empty? : !value
-          raise StandardError.new("Specification is missing the `#{key}` option")
-        end
-      end
-    end
-
+    
+    #
+    # @return a JSON representation of the vendor specification which will be
+    #   packaged and shipped with the other files.
+    # 
     def to_json
-      [ ATTRIBUTES, :dependencies, :frameworks, :build_settings ].flatten.inject({}) do |hash, attr|
+      [ @attributes.keys, :dependencies, :frameworks, :build_settings ].flatten.inject({}) do |hash, attr|
         val = self.send(attr)
         hash[attr] = val unless val.nil?
         hash
       end.to_json
     end
-
+    
   end
 
 end

data/lib/vendor/vendor_file/library/base.rb

@@ -35,44 +35,6 @@ module Vendor
           # Do nothing by default, leave that up to the implementation
         end
 
-        # This method sucks. What we should be doing is passing a library to the Xcode project class
-        # to install. We shouldn't be interacting with it like this. Really, VendorFile::Library should
-        # extend Xcode::Library or something. That was its a little more modular.
-        def install(project, options = {})
-          # If the cache doesn't exist, download it
-          download unless cache_exists?
-
-          Vendor.ui.info %{Installing #{display_name}}
-
-          # Combine the local targets, with those targets specified in the options. Also
-          # for sanity reasons, flatten and uniqify them.
-          if @targets || options[:targets]
-            install_targets = [ @targets, options[:targets] ].compact.flatten.uniq
-          end
-
-          # The destination in the XCode project
-          destination = "Vendor/#{name}"
-
-          # Remove the group, and recreate
-          project.remove_group destination
-
-          # Install the files back into the project
-          files.each do |file|
-            project.add_file :targets => install_targets, :path => destination,
-                             :file => file, :source_tree => @source_tree
-          end
-
-          # Add frameworks
-          frameworks.each do |framework|
-            project.add_framework framework, :targets => install_targets
-          end
-
-          # Add compiler flags
-          build_settings.each do |build_setting|
-            project.add_build_setting build_setting[0], build_setting[1], :targets => install_targets, :from => self
-          end
-        end
-
         def dependencies
           # If the cache doesn't exist, download it
           download unless cache_exists?
@@ -119,32 +81,11 @@ module Vendor
         end
 
         def files
-          # If the cache doesn't exist, download it
-          download unless cache_exists?
+          install_files_for_files_in 'files'
+        end
 
-          # Calculate the files we need to add. There are 3 different types
-          # of installation:
-          # 1) Installation from a manifest (a built lib)
-          # 2) Loading the .vendorspec and seeing what files needed to be added
-          # 3) Try to be smart and try and find files to install
-          install_files = if manifest
-                            manifest['files'].map do |file|
-                              File.join(cache_path, "data", file)
-                            end
-                          elsif vendor_spec
-                            vendor_spec.files.map do |file|
-                              File.join(cache_path, file)
-                            end
-                          else
-                            location = [ cache_path, self.require, "**/*.*" ].compact
-                            Dir[ File.join *location ]
-                          end
-
-          # Remove files that are within folders with a ".", such as ".bundle"
-          # and ".frameworks"
-          install_files.reject do |file|
-            file.gsub(cache_path, "") =~ /\/?[^\/]+\.[^\/]+\//
-          end
+        def resources
+          install_files_for_files_in 'resources'
         end
 
         def version
@@ -157,6 +98,21 @@ module Vendor
           end
         end
 
+        def per_file_flag
+          # If the cache doesn't exist, download it
+          download unless cache_exists?
+
+          # Find the build settings
+          per_file_flag = if manifest
+            manifest['per_file_flag']
+          elsif vendor_spec
+            vendor_spec.per_file_flag
+          end
+
+          per_file_flag
+        end
+
+
         def version_matches_any?(other_versions)
           # If we have an equality matcher, we need sort through
           # the versions, and try and find the best match
@@ -235,6 +191,30 @@ module Vendor
             end
           end
 
+          def install_files_for_files_in section
+            # If the cache doesn't exist, download it
+            download unless cache_exists?
+
+            # Calculate the files we need to add. There are 3 different types
+            # of installation:
+            # 1) Installation from a manifest (a built lib)
+            # 2) Loading the .vendorspec and seeing what files needed to be added
+            # 3) Try to be smart and try and find files to install
+            install_files = if manifest
+                              Array(manifest[section]).map do |file|
+                                File.join(cache_path, "data", file)
+                              end
+                            elsif vendor_spec
+                              Array(vendor_spec.send(section)).map do |file|
+                                File.join(cache_path, file)
+                              end
+                            else
+                              location = [ cache_path, self.require, "**/*.*" ].compact
+                              Dir[ File.join *location ]
+                            end
+
+          end
+
       end
 
     end