cocoapods-tt 0.0.1

data/lib/cocoapods-tt/native/target.rb

@@ -0,0 +1,378 @@
+require 'cocoapods/target/build_settings'
+
+module Pod
+  # Model class which describes a Pods target.
+  #
+  # The Target class stores and provides the information necessary for
+  # working with a target in the Podfile and its dependent libraries.
+  # This class is used to represent both the targets and their libraries.
+  #
+  class Target
+    DEFAULT_VERSION = '1.0.0'.freeze
+    DEFAULT_NAME = 'Default'.freeze
+    DEFAULT_BUILD_CONFIGURATIONS = { 'Release' => :release, 'Debug' => :debug }.freeze
+
+    # @return [Sandbox] The sandbox where the Pods should be installed.
+    #
+    attr_reader :sandbox
+
+    # @return [Hash{String=>Symbol}] A hash representing the user build
+    #         configurations where each key corresponds to the name of a
+    #         configuration and its value to its type (`:debug` or `:release`).
+    #
+    attr_reader :user_build_configurations
+
+    # @return [Array<String>] The value for the ARCHS build setting.
+    #
+    attr_reader :archs
+
+    # @return [Platform] the platform of this target.
+    #
+    attr_reader :platform
+
+    # @return [BuildSettings] the build settings for this target.
+    #
+    attr_reader :build_settings
+
+    # @return [BuildType] the build type for this target.
+    #
+    attr_reader :build_type
+    private :build_type
+
+    # @return [Boolean] whether the target can be linked to app extensions only.
+    #
+    attr_reader :application_extension_api_only
+
+    # @return [Boolean] whether the target must be compiled with Swift's library
+    # evolution support, necessary for XCFrameworks.
+    #
+    attr_reader :build_library_for_distribution
+
+    # Initialize a new target
+    #
+    # @param [Sandbox] sandbox @see #sandbox
+    # @param [BuildType] build_type @see #build_type
+    # @param [Hash{String=>Symbol}] user_build_configurations @see #user_build_configurations
+    # @param [Array<String>] archs @see #archs
+    # @param [Platform] platform @see #platform
+    #
+    def initialize(sandbox, build_type, user_build_configurations, archs, platform)
+      @sandbox = sandbox
+      @user_build_configurations = user_build_configurations
+      @archs = archs
+      @platform = platform
+      @build_type = build_type
+
+      @application_extension_api_only = false
+      @build_library_for_distribution = false
+      @build_settings = create_build_settings
+    end
+
+    # @return [String] the name of the library.
+    #
+    def name
+      label
+    end
+
+    alias to_s name
+
+    # @return [String] the label for the target.
+    #
+    def label
+      DEFAULT_NAME
+    end
+
+    # @return [String] The version associated with this target
+    #
+    def version
+      DEFAULT_VERSION
+    end
+
+    # @return [Boolean] Whether the target uses Swift code
+    #
+    def uses_swift?
+      false
+    end
+
+    # @return [Boolean] whether the target is built dynamically
+    #
+    def build_as_dynamic?
+      build_type.dynamic?
+    end
+
+    # @return [Boolean] whether the target is built as a dynamic framework
+    #
+    def build_as_dynamic_framework?
+      build_type.dynamic_framework?
+    end
+
+    # @return [Boolean] whether the target is built as a dynamic library
+    #
+    def build_as_dynamic_library?
+      build_type.dynamic_library?
+    end
+
+    # @return [Boolean] whether the target is built as a framework
+    #
+    def build_as_framework?
+      build_type.framework?
+    end
+
+    # @return [Boolean] whether the target is built as a library
+    #
+    def build_as_library?
+      build_type.library?
+    end
+
+    # @return [Boolean] whether the target is built statically
+    #
+    def build_as_static?
+      build_type.static?
+    end
+
+    # @return [Boolean] whether the target is built as a static framework
+    #
+    def build_as_static_framework?
+      build_type.static_framework?
+    end
+
+    # @return [Boolean] whether the target is built as a static library
+    #
+    def build_as_static_library?
+      build_type.static_library?
+    end
+
+    # @deprecated Prefer {build_as_static_framework?}.
+    #
+    # @return [Boolean] Whether the target should build a static framework.
+    #
+    def static_framework?
+      build_as_static_framework?
+    end
+
+    # @return [String] the name to use for the source code module constructed
+    #         for this target, and which will be used to import the module in
+    #         implementation source files.
+    #
+    def product_module_name
+      c99ext_identifier(label)
+    end
+
+    # @return [String] the name of the product.
+    #
+    def product_name
+      if build_as_framework?
+        framework_name
+      else
+        static_library_name
+      end
+    end
+
+    # @return [String] the name of the product excluding the file extension or
+    #         a product type specific prefix, depends on #requires_frameworks?
+    #         and #product_module_name or #label.
+    #
+    def product_basename
+      if build_as_framework?
+        product_module_name
+      else
+        label
+      end
+    end
+
+    # @return [String] the name of the framework, depends on #label.
+    #
+    # @note This may not depend on #requires_frameworks? indirectly as it is
+    #       used for migration.
+    #
+    def framework_name
+      "#{product_module_name}.framework"
+    end
+
+    # @return [String] the name of the library, depends on #label.
+    #
+    # @note This may not depend on #requires_frameworks? indirectly as it is
+    #       used for migration.
+    #
+    def static_library_name
+      "lib#{label}.a"
+    end
+
+    # @return [Symbol] either :framework or :static_library, depends on
+    #         #build_as_framework?.
+    #
+    def product_type
+      build_as_framework? ? :framework : :static_library
+    end
+
+    # @return [String] A string suitable for debugging.
+    #
+    def inspect
+      "#<#{self.class} name=#{name}>"
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Framework support
+
+    # @deprecated Prefer {build_as_framework?}.
+    #
+    # @return [Boolean] whether the generated target needs to be implemented
+    #         as a framework
+    #
+    def requires_frameworks?
+      build_as_framework?
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Support files
+
+    # @return [Pathname] the folder where to store the support files of this
+    #         library.
+    #
+    def support_files_dir
+      sandbox.target_support_files_dir(name)
+    end
+
+    # @param  [String] variant
+    #         The variant of the xcconfig. Used to differentiate build
+    #         configurations.
+    #
+    # @return [Pathname] the absolute path of the xcconfig file.
+    #
+    def xcconfig_path(variant = nil)
+      if variant
+        support_files_dir + "#{label}.#{variant.to_s.gsub(File::SEPARATOR, '-').downcase}.xcconfig"
+      else
+        support_files_dir + "#{label}.xcconfig"
+      end
+    end
+
+    # @return [Pathname] the absolute path of the header file which contains
+    #         the exported foundation constants with framework version
+    #         information and all headers, which should been exported in the
+    #         module map.
+    #
+    def umbrella_header_path
+      module_map_path.parent + "#{label}-umbrella.h"
+    end
+
+    def umbrella_header_path_to_write
+      module_map_path_to_write.parent + "#{label}-umbrella.h"
+    end
+
+    # @return [Pathname] the absolute path of the LLVM module map file that
+    #         defines the module structure for the compiler.
+    #
+    def module_map_path
+      module_map_path_to_write
+    end
+
+    # @!private
+    #
+    # @return [Pathname] the absolute path of the module map file that
+    #         CocoaPods writes. This can be different from `module_map_path`
+    #         if the module map gets symlinked.
+    #
+    def module_map_path_to_write
+      basename = "#{label}.modulemap"
+      support_files_dir + basename
+    end
+
+    # @return [Pathname] the absolute path of the bridge support file.
+    #
+    def bridge_support_path
+      support_files_dir + "#{label}.bridgesupport"
+    end
+
+    # @return [Pathname] the absolute path of the Info.plist file.
+    #
+    def info_plist_path
+      support_files_dir + "#{label}-Info.plist"
+    end
+
+    # @return [Hash] additional entries for the generated Info.plist
+    #
+    def info_plist_entries
+      {}
+    end
+
+    # @return [Pathname] the path of the dummy source generated by CocoaPods
+    #
+    def dummy_source_path
+      support_files_dir + "#{label}-dummy.m"
+    end
+
+    # Mark the target as extension-only.
+    # Translates to APPLICATION_EXTENSION_API_ONLY = YES in the build settings.
+    #
+    def mark_application_extension_api_only
+      @application_extension_api_only = true
+    end
+
+    # Compiles the target with Swift's library evolution support, necessary to
+    # build XCFrameworks.
+    # Translates to BUILD_LIBRARY_FOR_DISTRIBUTION = YES in the build settings.
+    #
+    def mark_build_library_for_distribution
+      @build_library_for_distribution = true
+    end
+
+    # @return [Pathname] The absolute path of the prepare artifacts script.
+    #
+    # @deprecated
+    #
+    # @todo Remove in 2.0
+    #
+    def prepare_artifacts_script_path
+      support_files_dir + "#{label}-artifacts.sh"
+    end
+
+    # Returns an extension in the target that corresponds to the
+    # resource's input extension.
+    #
+    # @param [String] input_extension
+    #        The input extension to map to.
+    #
+    # @return [String] The output extension.
+    #
+    def self.output_extension_for_resource(input_extension)
+      case input_extension
+      when '.storyboard'        then '.storyboardc'
+      when '.xib'               then '.nib'
+      when '.xcdatamodel'       then '.mom'
+      when '.xcdatamodeld'      then '.momd'
+      when '.xcmappingmodel'    then '.cdm'
+      when '.xcassets'          then '.car'
+      else                      input_extension
+      end
+    end
+
+    def self.resource_extension_compilable?(input_extension)
+      output_extension_for_resource(input_extension) != input_extension && input_extension != '.xcassets'
+    end
+
+    #-------------------------------------------------------------------------#
+
+    private
+
+    # Transforms the given string into a valid +identifier+ after C99ext
+    # standard, so that it can be used in source code where escaping of
+    # ambiguous characters is not applicable.
+    #
+    # @param  [String] name
+    #         any name, which may contain leading numbers, spaces or invalid
+    #         characters.
+    #
+    # @return [String]
+    #
+    def c99ext_identifier(name)
+      name.gsub(/^([0-9])/, '_\1').gsub(/[^a-zA-Z0-9_]/, '_')
+    end
+
+    def create_build_settings
+      BuildSettings.new(self)
+    end
+  end
+end

data/lib/cocoapods-tt/native/user_interface/error_report.rb

@@ -0,0 +1,204 @@
+# encoding: UTF-8
+
+require 'rbconfig'
+require 'cgi'
+require 'gh_inspector'
+
+module Pod
+  module UserInterface
+    module ErrorReport
+      class << self
+        def report(exception)
+          <<-EOS
+
+#{'――― MARKDOWN TEMPLATE ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――'.reversed}
+
+### Command
+
+```
+#{original_command}
+```
+
+#{report_instructions}
+
+#{stack}
+### Plugins
+
+```
+#{plugins_string}
+```
+#{markdown_podfile}
+### Error
+
+```
+#{exception.class} - #{exception.message.force_encoding('UTF-8')}
+#{exception.backtrace.join("\n") if exception.backtrace}
+```
+
+#{'――― TEMPLATE END ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――'.reversed}
+
+#{'[!] Oh no, an error occurred.'.red}
+#{error_from_podfile(exception)}
+#{'Search for existing GitHub issues similar to yours:'.yellow}
+#{issues_url(exception)}
+
+#{'If none exists, create a ticket, with the template displayed above, on:'.yellow}
+https://github.com/CocoaPods/CocoaPods/issues/new
+
+#{'Be sure to first read the contributing guide for details on how to properly submit a ticket:'.yellow}
+https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md
+
+Don't forget to anonymize any private data!
+
+EOS
+        end
+
+        def report_instructions
+          <<-EOS
+### Report
+
+* What did you do?
+
+* What did you expect to happen?
+
+* What happened instead?
+EOS
+        end
+
+        def stack
+          parts = {
+            'CocoaPods' => Pod::VERSION,
+            'Ruby' => RUBY_DESCRIPTION,
+            'RubyGems' => Gem::VERSION,
+            'Host' => host_information,
+            'Xcode' => xcode_information,
+            'Git' => git_information,
+            'Ruby lib dir' => RbConfig::CONFIG['libdir'],
+            'Repositories' => repo_information,
+          }
+          justification = parts.keys.map(&:size).max
+
+          str = <<-EOS
+### Stack
+
+```
+EOS
+          parts.each do |name, value|
+            str << name.rjust(justification)
+            str << ' : '
+            str << Array(value).join("\n" << (' ' * (justification + 3)))
+            str << "\n"
+          end
+
+          str << "```\n"
+        end
+
+        def plugins_string
+          plugins = installed_plugins
+          max_name_length = plugins.keys.map(&:length).max
+          plugins.map do |name, version|
+            "#{name.ljust(max_name_length)} : #{version}"
+          end.sort.join("\n")
+        end
+
+        def markdown_podfile
+          return '' unless Config.instance.podfile_path && Config.instance.podfile_path.exist?
+          <<-EOS
+
+### Podfile
+
+```ruby
+#{Config.instance.podfile_path.read.strip}
+```
+EOS
+        end
+
+        def search_for_exceptions(exception)
+          inspector = GhInspector::Inspector.new 'cocoapods', 'cocoapods'
+          message_delegate = UserInterface::InspectorReporter.new
+          inspector.search_exception exception, message_delegate
+        rescue => e
+          warn "Searching for inspections failed: #{e}"
+          nil
+        end
+
+        private
+
+        def `(other)
+          super
+        rescue Errno::ENOENT => e
+          "Unable to find an executable (#{e})"
+        end
+
+        def pathless_exception_message(message)
+          message.gsub(/- \(.*\):/, '-')
+        end
+
+        def error_from_podfile(error)
+          if error.message =~ /Podfile:(\d*)/
+            "\nIt appears to have originated from your Podfile at line #{Regexp.last_match[1]}.\n"
+          end
+        end
+
+        def remove_color(string)
+          string.gsub(/\e\[(\d+)m/, '')
+        end
+
+        def issues_url(exception)
+          message = remove_color(pathless_exception_message(exception.message))
+          'https://github.com/CocoaPods/CocoaPods/search?q=' \
+          "#{CGI.escape(message)}&type=Issues"
+        end
+
+        def host_information
+          product, version, build = `sw_vers`.strip.split("\n").map { |line| line.split(':').last.strip }
+          "#{product} #{version} (#{build})"
+        end
+
+        def xcode_information
+          version, build = `xcodebuild -version`.strip.split("\n").map { |line| line.split(' ').last }
+          "#{version} (#{build})"
+        end
+
+        def git_information
+          `git --version`.strip.split("\n").first
+        end
+
+        def installed_plugins
+          CLAide::Command::PluginManager.specifications.
+            reduce({}) { |hash, s| hash.tap { |h| h[s.name] = s.version.to_s } }
+        end
+
+        def repo_information
+          Config.instance.sources_manager.all.map do |source|
+            repo = source.repo
+            if source.is_a?(Pod::CDNSource)
+              "#{repo.basename} - CDN - #{source.url}"
+            elsif source.git?
+              sha = git_hash(source)
+              "#{repo.basename} - git - #{source.url} @ #{sha}"
+            else
+              "#{repo.basename} - #{source.type}"
+            end
+          end
+        end
+
+        def original_command
+          "#{$PROGRAM_NAME} #{ARGV.join(' ')}"
+        end
+
+        private
+
+        # @param [Source] source
+        #        a git source
+        #
+        # @return [String] the current git SHA
+        def git_hash(source)
+          Dir.chdir(source.repo) do
+            `git rev-parse HEAD 2>&1`
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods-tt/native/user_interface/inspector_reporter.rb

@@ -0,0 +1,102 @@
+require 'addressable'
+require 'uri'
+
+module Pod
+  module UserInterface
+    # Redirects GH-issues delegate callbacks to CocoaPods UI methods.
+    #
+    class InspectorReporter
+      # Called just as the investigation has begun.
+      # Lets the user know that it's looking for an issue.
+      #
+      # @param [GhInspector::Inspector] inspector
+      #        The current inspector
+      #
+      # @return [void]
+      #
+      def inspector_started_query(_, inspector)
+        UI.puts "Looking for related issues on #{inspector.repo_owner}/#{inspector.repo_name}..."
+      end
+
+      # Called once the inspector has received a report with more than one issue,
+      # showing the top 3 issues, and offering a link to see more.
+      #
+      # @param [GhInspector::InspectionReport] report
+      #        Report a list of the issues
+      #
+      # @return [void]
+      #
+      def inspector_successfully_received_report(report, _)
+        report.issues[0..2].each { |issue| print_issue_full(issue) }
+
+        if report.issues.count > 3
+          UI.puts "and #{report.total_results - 3} more at:"
+          UI.puts report.url
+        end
+      end
+
+      # Called once the report has been received, but when there are no issues found.
+      #
+      # @param [GhInspector::Inspector] inspector
+      #        The current inspector
+      #
+      # @return [void]
+      #
+      def inspector_received_empty_report(_, inspector)
+        UI.puts 'Found no similar issues. To create a new issue, please visit:'
+        UI.puts "https://github.com/#{inspector.repo_owner}/#{inspector.repo_name}/issues/new"
+      end
+
+      # Called when there have been networking issues in creating the report.
+      #
+      # @param [Error] error
+      #        The error returned during networking
+      #
+      # @param [String] query
+      #        The original search query
+      #
+      # @param [GhInspector::Inspector] inspector
+      #        The current inspector
+      #
+      # @return [void]
+      #
+      def inspector_could_not_create_report(error, query, inspector)
+        safe_query = Addressable::URI.escape query
+        UI.puts 'Could not access the GitHub API, you may have better luck via the website.'
+        UI.puts "https://github.com/#{inspector.repo_owner}/#{inspector.repo_name}/search?q=#{safe_query}&type=Issues&utf8=✓"
+        UI.puts "Error: #{error.name}"
+      end
+
+      private
+
+      def print_issue_full(issue)
+        safe_url = Addressable::URI.escape issue.html_url
+        UI.puts " - #{issue.title}"
+        UI.puts "   #{safe_url} [#{issue.state}] [#{issue.comments} comment#{issue.comments == 1 ? '' : 's'}]"
+        UI.puts "   #{pretty_date(issue.updated_at)}"
+        UI.puts ''
+      end
+
+      # Taken from https://stackoverflow.com/questions/195740/how-do-you-do-relative-time-in-rails
+      def pretty_date(date_string)
+        date = Time.parse(date_string)
+        a = (Time.now - date).to_i
+
+        case a
+        when 0 then 'just now'
+        when 1 then 'a second ago'
+        when 2..59 then a.to_s + ' seconds ago'
+        when 60..119 then 'a minute ago' # 120 = 2 minutes
+        when 120..3540 then (a / 60).to_i.to_s + ' minutes ago'
+        when 3541..7100 then 'an hour ago' # 3600 = 1 hour
+        when 7101..82_800 then ((a + 99) / 3600).to_i.to_s + ' hours ago'
+        when 82_801..172_000 then 'a day ago' # 86400 = 1 day
+        when 172_001..518_400 then ((a + 800) / (60 * 60 * 24)).to_i.to_s + ' days ago'
+        when 518_400..1_036_800 then 'a week ago'
+        when 1_036_801..4_147_204 then ((a + 180_000) / (60 * 60 * 24 * 7)).to_i.to_s + ' weeks ago'
+        else date.strftime('%d %b %Y')
+        end
+      end
+    end
+  end
+end