xcres 0.4.0

data/lib/xcres/builder/resources_builder.rb

@@ -0,0 +1,184 @@
+require 'xcres/builder/file_builder'
+require 'xcres/helper/file_helper'
+
+class XCRes::ResourcesBuilder < XCRes::FileBuilder
+
+  include XCRes::FileHelper
+
+  BANNER = <<EOS
+// generated by xcres
+//
+// DO NOT EDIT. This file is machine-generated and constantly overwritten.
+// See https://github.com/mrackwitz/xcres for more info.
+//
+EOS
+
+  COMPILER_KEYWORDS = %w{
+    auto break case char const continue default do double else enum extern float
+    for goto if inline int long register restrict return short signed sizeof
+    static struct switch typedef union unsigned void volatile while
+  }
+
+  # @return [String]
+  #         the name of the constant in the generated file(s)
+  attr_accessor :resources_constant_name
+
+  # @return [Bool]
+  #         whether the generated resources constant should contain inline
+  #         documentation for each key, true by default
+  attr_accessor :documented
+  alias :documented? :documented
+
+  # @return [Hash{String => {String => String}}]
+  #         the sections, which will been written to the built files
+  attr_reader :sections
+
+  # Initialize a new instance
+  #
+  def initialize
+    @sections = {}
+    self.documented = true
+  end
+
+  # Extract resource name from #output_path, if not customized
+  #
+  # @return [String]
+  #
+  def resources_constant_name
+    @resources_constant_name ||= basename_without_ext output_path
+  end
+
+  def add_section name, items, options = {}
+    raise ArgumentError.new 'No items given!' if items.nil?
+
+    transformed_items = {}
+
+    for key, value in items
+      transformed_key = transform_key key, options
+
+      # Skip invalid key names
+      if transformed_key.length == 0
+        logger.warn "Skip invalid key: '%s'. (Was transformed to empty text)", key
+        next
+      end
+
+      # Skip compiler keywords
+      if COMPILER_KEYWORDS.include? transformed_key
+        logger.warn "Skip invalid key: '%s'. (Was transformed to keyword '%s')", key, transformed_key
+        next
+      end
+
+      transformed_items[transformed_key] = value
+    end
+
+    @sections[name] = transformed_items
+  end
+
+  def build
+    super
+
+    # Build file contents and write them to disk
+    write_file_eventually "#{output_path}.h", (build_contents do |h_file|
+      build_header_contents h_file
+    end)
+
+    write_file_eventually "#{output_path}.m", (build_contents do |m_file|
+      build_impl_contents m_file
+    end)
+  end
+
+  protected
+
+    def transform_key key, options
+      # Split the key into components
+      components = key.underscore.split /[_\/ ]/
+
+      # Build the new key incremental
+      result = ''
+
+      for component in components
+        # Ignore empty components
+        next unless component.length > 0
+
+        # Ignore components which are already contained in the key, if enabled
+        if options[:shorten_keys]
+          next unless result.downcase.scan(component).blank?
+        end
+
+        # Clean component from non alphanumeric characters
+        clean_component = component.gsub /[^a-zA-Z0-9]/, ''
+
+        # Skip if empty
+        next unless clean_component.length > 0
+
+        if result.length == 0
+          result += clean_component
+        else
+          result += clean_component[0].upcase + clean_component[1..-1]
+        end
+      end
+
+      result
+    end
+
+    def build_header_contents h_file
+      h_file.writeln BANNER
+      h_file.writeln
+      h_file.writeln '#import <Foundation/Foundation.h>'
+      h_file.writeln
+      h_file.writeln 'extern const struct %s {' % resources_constant_name
+      h_file.section do |struct|
+        enumerate_sections do |section_key, enumerate_keys|
+          struct.writeln 'struct %s {' % section_key
+          struct.section do |section_struct|
+            enumerate_keys.call do |key, value, comment|
+              if documented?
+                section_struct.writeln '/// %s' % (comment || value) #unless comment.nil?
+              end
+              section_struct.writeln '__unsafe_unretained NSString *%s;' % key
+            end
+          end
+          struct.writeln '} %s;' % section_key
+        end
+      end
+      h_file.writeln '} %s;' % resources_constant_name
+    end
+
+    def build_impl_contents m_file
+      m_file.writeln BANNER
+      m_file.writeln
+      m_file.writeln '#import "R.h"'
+      m_file.writeln
+      m_file.writeln 'const struct %s %s = {' % [resources_constant_name, resources_constant_name]
+      m_file.section do |struct|
+        enumerate_sections do |section_key, enumerate_keys|
+          struct.writeln '.%s = {' % section_key
+          struct.section do |section_struct|
+            enumerate_keys.call do |key, value|
+              section_struct.writeln '.%s = @"%s",' % [key, value]
+            end
+          end
+          struct.writeln '},'
+        end
+      end
+      m_file.writeln '};'
+    end
+
+    def enumerate_sections
+      # Iterate sections ordered by key
+      for section_key, section_content in @sections.sort
+        # Pass section key and block to yield the keys ordered
+        proc = Proc.new do |&block|
+          for key, value in section_content.sort
+            if value.is_a? Hash
+              block.call key, value[:value], value[:comment]
+            else
+              block.call key, value, nil
+            end
+          end
+        end
+        yield section_key, proc
+      end
+    end
+
+end

data/lib/xcres/builder/string_builder.rb

@@ -0,0 +1,31 @@
+class XCRes::StringBuilder
+
+  attr_accessor :indentation_string
+  attr_accessor :result
+
+  def initialize
+    self.indentation_string = '    '
+    self.result = ''
+  end
+
+  def << input
+    # Only indent string inputs on nested / delegating string builders
+    input = self.indentation_string + input unless result.is_a? String
+
+    self.result << input
+  end
+
+  alias write :<<
+
+  def writeln input=''
+    self << input + "\n"
+  end
+
+  def section &block
+    builder = self.class.new
+    builder.indentation_string = self.indentation_string
+    builder.result = self
+    block.call builder
+  end
+
+end

data/lib/xcres/command/build_command.rb

@@ -0,0 +1,83 @@
+require 'xcres/command/project_command'
+require 'xcres/helper/file_helper'
+require 'xcres/builder/resources_builder'
+require 'xcres/analyzer/aggregate_analyzer'
+require 'xcres/analyzer/resources_aggregate_analyzer'
+require 'xcres/analyzer/strings_analyzer'
+
+# The +BuildCommand+ builds the resources index files.
+#
+class XCRes::BuildCommand < XCRes::ProjectCommand
+
+  include XCRes::FileHelper
+
+  inherit_parameters!
+  parameter '[OUTPUT_PATH]', 'Path where to write to', attribute_name: :output_path
+
+  def execute
+    super
+
+    # Derive the name for the resources constant file
+    self.resources_constant_name ||= derive_resources_constant_name
+
+    # Locate output path
+    self.output_path = locate_output_path
+
+    build do |builder|
+      analyzer = XCRes::AggregateAnalyzer.new(target)
+      analyzer.exclude_file_patterns = exclude_file_patterns
+      analyzer.logger = logger
+      analyzer.add_with_class(XCRes::ResourcesAggregateAnalyzer, shorten_keys: true)
+      analyzer.add_with_class(XCRes::StringsAnalyzer, default_language: default_language)
+      sections = analyzer.analyze
+
+      sections.each do |section|
+        builder.add_section section.name, section.items, section.options
+      end
+    end
+
+    success 'Successfully updated: %s', "#{output_path}.h"
+  end
+
+  def derive_resources_constant_name
+    # Fall back to `basename OUTPUT_PATH` or 'R' if both are not given
+    if output_path != nil && !File.directory?(output_path)
+      basename_without_ext(output_path)
+    else
+      'R'
+    end
+  end
+
+  def output_dir
+    if output_path.nil?
+      # Use project dir, if no output path was set
+      Pathname(xcodeproj_file_path) + '..'
+    else
+      path = Pathname(output_path)
+      if path.directory?
+        path
+      else
+        path + '..'
+      end
+    end
+  end
+
+  def locate_output_path
+    output_dir.realdirpath + resources_constant_name
+  end
+
+  def build
+    # Prepare builder
+    builder = XCRes::ResourcesBuilder.new
+    builder.output_path = output_path
+    builder.logger = logger
+    builder.documented = documented?
+    builder.resources_constant_name = resources_constant_name
+
+    yield builder
+
+    # Write the files, if needed
+    builder.build
+  end
+
+end

data/lib/xcres/command/command.rb

@@ -0,0 +1,58 @@
+require 'clamp'
+require 'xcres/logger'
+
+# Base class for commands
+#
+class XCRes::Command < Clamp::Command
+
+  option ['--silent'], :flag, 'Show nothing'
+  option ['--[no-]ansi'], :flag, 'Show output without ANSI codes', default: true
+  option ['-v', '--verbose'], :flag, 'Show more debugging information'
+
+  # Run the command, with the specified arguments.
+  #
+  # This calls {#parse} to process the command-line arguments,
+  # then delegates to {#execute}.
+  #
+  # @param [Array<String>] arguments command-line arguments
+  #
+  def run(arguments)
+    super
+  rescue Clamp::HelpWanted => e
+    raise e # Clamp will handle this for us
+  rescue StandardError => error
+    fail error
+    exit 1
+  end
+
+  def execute
+    # Configure logger
+    configure_logger
+  end
+
+  #----------------------------------------------------------------------------#
+
+  # @!group Logger
+
+  # Lazy-instantiate a logger
+  #
+  def logger
+    @logger ||= XCRes::Logger.new
+  end
+
+  # Delegate log level methods to the logger
+  #
+  delegate :inform, :log, :success, :warn, :fail, to: :logger
+
+  # Checks the configured option to configure the logger
+  #
+  def configure_logger
+    logger.silent = silent?
+    logger.colored = ansi?
+    if verbose?
+      logger.verbose = verbose?
+      log 'Verbose mode is enabled.'
+    end
+  end
+
+end

data/lib/xcres/command/install_command.rb

@@ -0,0 +1,173 @@
+require 'xcres/command/project_command'
+require 'xcres/command/build_command'
+
+# The +InstallCommand+ integrates a build phase to the Xcode project,
+# so that on each build the resources index will be rebuild, if needed.
+#
+class XCRes::InstallCommand < XCRes::ProjectCommand
+
+  BUILD_PHASE_NAME = 'Build Resource-Index'
+
+  inherit_parameters!
+
+  # Execute the command
+  #
+  # @return [void]
+  #
+  def execute
+    super
+
+    # Locate the parent group, where the built files will been added to
+    parent_group = find_parent_group
+
+    # Locate the output path
+    output_path = parent_group.real_path + 'Resources/R'
+
+    inform 'Execute build first:'
+    build(output_path)
+
+    integrate!(output_path, parent_group)
+
+    success 'Successfully integrated into %s', project_path
+  end
+
+  # Find parent group, where the built files will been added to.
+  # It will return the first group, which was found of the following list.
+  #   * 'Supporting Files' group
+  #   * target-specific group
+  #   * main group
+  #
+  # @raise [ArgumentError]
+  #        if no main group exists, which means that the project is invalid
+  #
+  # @return [PBXGroup]
+  #
+  def find_parent_group
+    # Get main group and ensure that it exists
+    main_group = project.main_group
+    raise ArgumentError, "Didn't found main group" if main_group.nil?
+
+    # Get target-specific group, if the default project layout is in use
+    src_group = main_group.groups.find { |g| g.path == target.name }
+    if src_group != nil
+      log "Found target group, will use its path as base output path."
+    else
+      log "Didn't found target group, expected a group with path '#{target.name}'."
+    end
+
+    # Find 'Supporting Files' group
+    groups = main_group.recursive_children_groups
+    support_files_group = groups.find { |g| g.name == 'Supporting Files' }
+    warn "Didn't found support files group" if support_files_group.nil?
+
+    support_files_group || src_group || main_group
+  end
+
+  # Trigger a build for the current project
+  #
+  # @param [Pathname] output_path
+  #        the argument OUTPUT_PATH for the build subcommand
+  #
+  # @return [void]
+  #
+  def build(output_path)
+    build_cmd = XCRes::BuildCommand.new("#{invocation_path} build", context, attribute_values)
+    build_cmd.logger.indentation = '    '
+    build_cmd.run([project_path.to_s, output_path.relative_path_from(Pathname.pwd).to_s])
+  end
+
+  # Integrate the build phase and add the built files to the project
+  #
+  # @param [Pathname] output_path
+  #        the argument OUTPUT_PATH for the build subcommand
+  #
+  # @param [PBXGroup] parent_group
+  #        the group where to integrate
+  #
+  # @return [void]
+  #
+  def integrate!(output_path, parent_group)
+    # Find or create shell script build phase
+    build_phase = target.shell_script_build_phases.find do |bp|
+      bp.name == BUILD_PHASE_NAME
+    end
+    build_phase ||= target.new_shell_script_build_phase(BUILD_PHASE_NAME)
+
+    # Remove build phase to re-insert before compile sources
+    target.build_phases.delete(build_phase)
+    index = target.build_phases.index(target.source_build_phase)
+    target.build_phases.insert(index, build_phase)
+
+    # Set shell script
+    script_output_path = output_path.relative_path_from(src_root_path)
+    build_phase.shell_script = "xcres --no-ansi build $PROJECT_FILE_PATH $SRCROOT/#{script_output_path}\n"
+
+    # Find or create 'Resources' group in 'Supporting Files'
+    res_group = parent_group.groups.find { |g| g.name == 'Resources' }
+    res_group ||= parent_group.new_group('Resources', Pathname('Resources'))
+
+    # Find or create references to resources index files
+    h_file = res_group.find_file_by_path('R.h') || res_group.new_file('R.h')
+    m_file = res_group.find_file_by_path('R.m') || res_group.new_file('R.m')
+
+    # Add .m file to source build phase, if it doesn't not already exist there
+    target.source_build_phase.add_file_reference(m_file, true)
+
+    # Add .h file to prefix header
+    prefix_headers.each do |path|
+      realpath = src_root_path + path
+      next unless File.exist?(realpath)
+      File.open(realpath, 'a+') do |f|
+        import_snippet = "#import \"#{h_file.path}\"\n"
+        unless f.readlines.include?(import_snippet)
+          f.write "\n#{import_snippet}"
+        end
+      end
+    end
+
+    project.save()
+  end
+
+  # Return a relative path to the project
+  #
+  # @return [Pathname]
+  #
+  def project_path
+    project.path.relative_path_from(Pathname.pwd)
+  end
+
+  # Return the path, which would be represented by the value of the
+  # build setting `$SRCROOT`.
+  #
+  # @return [Pathname]
+  #
+  def src_root_path
+    project_path.realpath + '..'
+  end
+
+  # Return a hash of attribute values
+  #
+  # @return [Hash{Clamp::Attribute::Definition => #to_s}]
+  #
+  def attribute_values
+    attribute_values = {}
+    self.class.recognised_options.each do |attribute|
+      if attribute.of(self).defined?
+        attribute_values[attribute] = attribute.of(self).get
+      end
+    end
+    attribute_values
+  end
+
+  # Discover prefix header by build settings of the application target
+  #
+  # @return [Set<Pathname>]
+  #         the relative paths to the .pch files
+  #
+  def prefix_headers
+    @prefix_headers ||= target.build_configurations.map do |config|
+      Pathname(config.build_settings['GCC_PREFIX_HEADER'])
+    end.flatten.to_set
+  end
+
+end

data/lib/xcres/command/main_command.rb

@@ -0,0 +1,14 @@
+require 'xcodeproj'
+require 'xcres/logger'
+require 'xcres/command/command'
+require 'xcres/command/build_command'
+require 'xcres/command/install_command'
+require 'xcres/command/version_command'
+
+class XCRes::MainCommand < XCRes::Command
+
+  subcommand 'build', 'Build the resources index files', XCRes::BuildCommand
+  subcommand 'install', 'Install a build phase into the project', XCRes::InstallCommand
+  subcommand 'version', 'Show the gem version', XCRes::VersionCommand
+
+end

data/lib/xcres/command/project_command.rb

@@ -0,0 +1,111 @@
+require 'xcres/command/command'
+require 'xcodeproj'
+
+# The +ProjectCommand+ is the base class for commands,
+# which analyze or modify Xcode projects.
+#
+class XCRes::ProjectCommand < XCRes::Command
+
+  option ['--[no-]documented'], :flag, 'Add documentation to the generated files', default: true
+  #option ['-d', '--dry-run'], :flag, 'Does nothing on the file system'
+
+  option ['-t', '--target'], 'TARGET', 'Application target to use', attribute_name: :target_name
+  option ['-x', '--exclude'], 'FILE_PATTERN', 'File pattern which should be excluded (default: ["InfoPlist.strings"])', multivalued: true, attribute_name: :exclude_file_patterns, default: ['InfoPlist.strings']
+  option ['-n', '--name'], 'NAME', 'Name of the resources constant (default: `basename OUTPUT_PATH`)', attribute_name: :resources_constant_name
+  option ['-l', '--language'], 'LANGUAGE', 'Default language to build the keys', attribute_name: :default_language do |language|
+    raise ArgumentError.new 'Expected a two-letter code conforming ISO 639-1 as LANGUAGE' unless String(language).length == 2
+    language
+  end
+
+  # Define parameter in an inheritable way
+  #
+  def self.inherit_parameters!
+    parameter '[XCODEPROJ]', 'Xcode project file to inspect (automatically located on base of the current directory if not given)', attribute_name: :xcodeproj_file_path
+  end
+
+
+  def execute
+    super
+
+    # Try to discover Xcode project at given path.
+    self.xcodeproj_file_path = find_xcodeproj
+  end
+
+
+  #----------------------------------------------------------------------------#
+
+  # @!group Xcode Project
+
+  # Opens the Xcode project, if not already opened
+  #
+  # @return [Xcodeproj::Project]
+  #         the Xcode project
+  #
+  def project
+    @project ||= Xcodeproj::Project.open(xcodeproj_file_path)
+  end
+
+  # Find the application target to use
+  #
+  # @return [PBXNativeTarget]
+  #
+  def target
+    if target_name != nil
+      application_targets.find { |t| t.name == target }
+    else
+      if application_targets.count == 1
+        application_targets.first
+      else
+        raise ArgumentError.new 'Multiple application target in project. ' \
+          'Please select one by specifying the option `--target TARGET`.'
+      end
+    end
+  end
+
+  # Find all application targets in the project
+  #
+  # @return [Array<PBXNativeTarget>]
+  #
+  def application_targets
+    @application_targets ||= project.targets.select do |target|
+      target.is_a?(Xcodeproj::Project::Object::PBXNativeTarget) \
+        && target.product_type == Xcodeproj::Constants::PRODUCT_TYPE_UTI[:application]
+    end
+  end
+
+  def find_xcodeproj
+    path = discover_xcodeproj_file_path!
+
+    if !Dir.exist?(path) || !File.exist?(path + '/project.pbxproj')
+      raise ArgumentError.new 'XCODEPROJ at %s was not found or is not a ' \
+        'valid Xcode project.' % path
+    end
+
+    success 'Use %s as XCODEPROJ.', path
+
+    return path
+  end
+
+  def discover_xcodeproj_file_path!
+    if xcodeproj_file_path.nil?
+      warn 'Argument XCODEPROJ is not set. Use the current directory.'
+      discover_xcodeproj_file_path_in_dir! '.'
+    elsif Dir.exist?(xcodeproj_file_path) && !File.fnmatch('*.xcodeproj', xcodeproj_file_path)
+      warn 'Argument XCODEPROJ is a directory. ' \
+           'Try to locate the Xcode project in this directory.'
+      discover_xcodeproj_file_path_in_dir! xcodeproj_file_path
+    else
+      xcodeproj_file_path
+    end
+  end
+
+  def discover_xcodeproj_file_path_in_dir! dir
+    xcodeproj_file_paths = Dir[dir + '/*.xcodeproj']
+    if xcodeproj_file_paths.count == 0
+      raise ArgumentError.new 'Argument XCODEPROJ was not given and no ' \
+                              '*.xcodeproj was found in current directory.'
+    end
+    xcodeproj_file_paths.first
+  end
+
+end

data/lib/xcres/command/version_command.rb

@@ -0,0 +1,12 @@
+require 'xcres/command/command'
+
+# The +VersionCommand+ prints the gem version.
+#
+class XCRes::VersionCommand < XCRes::Command
+
+  def execute
+    super
+    inform XCRes::VERSION
+  end
+
+end

data/lib/xcres/helper/file_helper.rb

@@ -0,0 +1,16 @@
+module XCRes
+  module FileHelper
+
+    # Return the basename without its extname
+    # e.g: 'dir/test.jpg' => 'test'
+    #
+    # @param  [String] file_path
+    #
+    # @return [String]
+    #
+    def basename_without_ext file_path
+      File.basename file_path, File.extname(file_path)
+    end
+
+  end
+end