xcres 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a076ffc4975feacb4afd297104c8814613c542eb
+  data.tar.gz: 211c8641f12dd550e4e43d8f39e2b8c24efa938c
+SHA512:
+  metadata.gz: 3bd3346d7bbcd259fa698bba2dfad0c2081db342ba9d3fc7f85ced88717fa1d0775b3090f9d98800d705294cad8b44b1692cd2d7ffb586382b82a055eff6c52f
+  data.tar.gz: aa0d427e7b7d5f86174728b84e4f987a8bf635b80be0a5a98a28a114d347e348754312c47eb762d185096ab9fa2a52b3a1e08fd9e06528687edc750c12703865

data/.gitignore

@@ -0,0 +1,33 @@
+# General
+*.rbc
+*.gem
+.DS_Store
+
+# Yardoc
+.yardoc
+/doc
+
+# Specs
+tmp
+spec/reports
+test/tmp
+test/version_tmp
+
+# Examples
+DerivedData
+
+# IDEs
+xcuserdata
+*.xccheckout
+.idea/
+
+# RVM files
+/.rvmrc
+/.ruby-version
+/.ruby-gemset
+
+# RBENV files
+/.rbenv-version
+
+# Bundler files
+/.bundle

data/.travis.yml

@@ -0,0 +1,18 @@
+# Sets Travis to run the Ruby specs on OS X machines which are required to
+# use the native tools to read plists.
+#
+language: objective-c
+
+env:
+  - RVM_RUBY_VERSION=system
+
+before_install:
+  - 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 sudo gem install bundler --no-ri --no-rdoc; else gem install bundler --no-ri --no-rdoc; fi
+
+install:
+  - bundle install --without=documentation
+
+script: rake spec

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xcres.gemspec
+gemspec
+
+group 'development' do
+  gem 'clintegracon'
+end

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    xcres (0.4.0)
+      activesupport (>= 3.2.15, < 4)
+      clamp (~> 0.6.3)
+      colored (~> 1.2)
+      libxml-ruby
+      xcodeproj (~> 0.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (2.2.8)
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    ast (2.0.0)
+    bacon (1.2.0)
+    clamp (0.6.3)
+    clintegracon (0.5.2)
+      colored (~> 1.2)
+      diffy
+    coderay (1.1.0)
+    colored (1.2)
+    diffy (3.0.6)
+    i18n (0.6.11)
+    inch (0.4.10)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7)
+    libxml-ruby (2.7.0)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    mocha-on-bacon (0.2.2)
+      mocha (>= 0.13.0)
+    multi_json (1.10.1)
+    parser (2.2.0.pre.4)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    prettybacon (0.0.2)
+      bacon (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    psych (2.0.5)
+    rainbow (2.0.0)
+    rake (10.3.2)
+    rubocop (0.25.0)
+      parser (>= 2.2.0.pre.4, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.5.1)
+    slop (3.6.0)
+    sparkr (0.4.1)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    tins (1.3.2)
+    xcodeproj (0.18.0)
+      CFPropertyList (~> 2.2)
+      activesupport (~> 3.0)
+      colored (~> 1.2)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon (~> 1.1)
+  bundler (~> 1.3)
+  clintegracon
+  inch
+  mocha
+  mocha-on-bacon
+  prettybacon
+  psych
+  rake
+  rubocop
+  xcres!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Marius Rackwitz
+
+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,181 @@
+# xcres
+
+[![Twitter: @mrackwitz](https://img.shields.io/badge/contact-@mrackwitz-blue.svg?style=flat)](https://twitter.com/mrackwitz)
+[![Gem](https://img.shields.io/gem/v/xcres.svg?style=flat)](http://rubygems.org/gems/xcres)
+[![Build Status](https://img.shields.io/travis/mrackwitz/xcres/master.svg?style=flat)](https://travis-ci.org/mrackwitz/xcres)
+[![Inline Docs](http://inch-ci.org/github/mrackwitz/xcres.svg?branch=master&style=flat)](http://inch-ci.org/github/mrackwitz/xcres)
+
+`xcres` searches your Xcode project for resources and generates an index
+as struct constants. So you will never have to reference a resource, without
+knowing already at compile time if it exists or not.
+
+It includes **loose images**, **.bundles**, **asset catalogs** (.xcasset)
+and even **.strings** in the index.
+
+It gives you **code autocompletion** for resources and localized string keys,
+without the need of an Xcode plugin.
+
+Especially if your app is a bit more complex, this will greatly improve your
+workflow. It ensures a better quality and gives you more safety.
+You will see directly when a resource is missing, when you renamed it,
+or you moved it around.
+
+Furthermore it won't even bother you for trivial name changes like change
+capitalization or converting name scheme from *train-case* or *snake_case* to
+*camelCase* and vice versa.
+
+It will warn you in Xcode on build, if certain resources or string keys can't be
+references, because their name contain invalid chars, duplicates in the
+*camelCase* variant with another key, or would be equal to a protected compiler
+keyword.
+
+The generated index could look like below.
+
+While this is still **Objective-C**, `xcres` is compatible with **Swift**.
+All you need to do is to add an import to the generated header to your
+project's bridging header.
+
+```objc
+const struct R {
+    struct Images {
+        /// doge.jpeg
+        __unsafe_unretained NSString *doge;
+    } Images;
+    struct ImagesAssets {
+        /// AppIcon
+        __unsafe_unretained NSString *app;
+        /// LaunchImage
+        __unsafe_unretained NSString *launch;
+        /// DefaultAvatar
+        __unsafe_unretained NSString *defaultAvatar;
+    } ImagesAssets;
+    struct Strings {
+        /// Password wrong!
+        __unsafe_unretained NSString *errorTitleWrongPassword;
+        /// Please enter the correct password.
+        __unsafe_unretained NSString *errorMessageWrongPassword;
+    } Strings;
+} R;
+```
+
+
+## Installation
+
+`xcres` is built with Ruby and it will be installable with the default
+Ruby available on OS X. You can use a Ruby Version manager, if you know
+what you're doing.
+Using the default Ruby install will require you to use sudo when
+installing gems. (This is only an issue for the duration of the gem
+installation, though.)
+
+Install the gem on your machine:
+
+```bash
+$ [sudo] gem install xcres
+```
+
+Use the automatic integration to add a build phase to your project,
+by executing the following command:
+
+```bash
+$ xcres install
+```
+
+
+## Usage
+
+Reference your resources safely with the generated constants.
+
+### Asset Catalogs
+
+Assuming your asset catalog is named `Images.xcassets`.  
+`xcres` supports multiple bundles in one project.
+
+Instead of:
+
+```objc
+[UIImage imageNamed:@"PersonDefaultAvatar"]
+```
+
+Just write:
+
+```objc
+[UIImage imageNamed:R.ImagesAssets.personDefaultAvatar]
+```
+
+##### How to Add a New Resource
+
+1. Add it to your asset catalog.
+- Trigger a build. (**⌘ + B**)
+- The new key will be available under
+  `R.${catalogName}Assets.${keyName:camelCase}`
+  and is ready for use in your code now.
+
+
+### Loose Images
+
+Instead of:
+
+```objc
+[UIImage imageNamed:@"table_header_background_image"]
+```
+
+Just write:
+
+```objc
+[UIImage imageNamed:R.Images.tableHeaderBackgroundImage]
+```
+
+##### How to Add a New Loose Image
+
+1. Drop the image in your project.
+- Trigger a build. (**⌘ + B**)
+- The new key will be available under `R.Images.${keyName:camelCase}`
+  and is ready for use in your code now.
+
+
+### Strings
+
+Instead of:
+
+```objc
+NSLocalizedString(@"error_message_wrong_password", @"Message shown if a wrong password was entered.")
+```
+
+Just write:
+
+```objc
+NSLocalizedString(R.Strings.errorMessageWrongPassword, @"Message shown if a wrong password was entered.")
+```
+
+
+##### How to Add a New String
+
+With xcres your workflow for adding new strings will change slightly.
+
+1. Create a new string (at least) in your project's native development
+  language in one of the strings files included in your target.
+  (By default this will be `en.lproj/Localizable.strings`)
+- Trigger a build. (**⌘ + B**)
+- The new key will be available under `R.Strings.${keyName:camelCase}`
+  and is ready for use in your code now.
+
+
+## Known Issues & Tips
+
+One minor drawback is that `genstrings` will not be helpful anymore.
+But this tool is mostly useful in the first step, when bootstrapping
+your project, until you care about internationalization and want to
+provide translations.
+
+xcres generally assumes that you don't use natural language for keys,
+as this will led very fast to ambiguities. It will filter out unwanted
+chars when transforming your keys to camel case notation, but it will
+also warn you about those. It can be a help, if you want to migrate
+your project to non-natural language keys.
+
+
+## License
+
+xcres is available under MIT License.
+See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,58 @@
+#encoding: utf-8
+
+begin
+  require 'bundler/gem_tasks'
+  require 'rubocop/rake_task'
+
+  namespace :install do
+    desc 'Install the gem as current user (NOT RECOMMENDED)'
+    task :user => ['build'] do
+      sh "gem install #{Dir['pkg/*.gem'].sort.last} --user-install"
+    end
+  end
+
+  namespace :lint do
+    RuboCop::RakeTask.new do |task|
+      task.patterns = ['lib/**/*.rb']
+    end
+
+    desc 'Run inch to see documentation coverage'
+    task :doc do
+      sh 'bundle exec inch'
+    end
+  end
+
+  namespace :spec do
+
+    task :prepare do
+      verbose false
+      puts 'Prepare …'
+      sh 'mkdir -p tmp'
+      rm_rf 'tmp/*'
+    end
+
+    desc 'Run all integration specs'
+    task :integration => [:prepare] do
+      sh 'bundle exec bacon spec/integration.rb'
+    end
+
+    desc 'Run all unit specs'
+    task :unit, [:spec] do |t, args|
+      sh "bundle exec bacon #{specs(args[:spec] || '**/*')}"
+    end
+
+    def specs(dir)
+      FileList["spec/unit/#{dir}_spec.rb"].shuffle.join(' ')
+    end
+
+    desc 'Run all specs'
+    task :all => [
+      :unit,
+      :integration
+    ]
+
+  end
+
+  desc 'Run all specs'
+  task :spec => 'spec:all'
+end

data/bin/xcres

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if $PROGRAM_NAME == __FILE__
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+  require 'rubygems'
+  require 'bundler/setup'
+  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'xcres'
+
+XCRes::MainCommand.run

data/lib/xcres/analyzer/aggregate_analyzer.rb

@@ -0,0 +1,48 @@
+require 'xcres/analyzer/analyzer'
+
+module XCRes
+
+  # A +AggregateAnalyzer+ runs multiple +Analyzer+.
+  #
+  class AggregateAnalyzer < Analyzer
+
+    # @return [Array<Analyzer>]
+    #         an array of +Analyzer+.
+    attr_accessor :analyzers
+
+    def initialize(project=nil, options={})
+      super
+      self.analyzers = []
+    end
+
+    # Run all aggregated analyzers
+    #
+    # @return [Array<Hash>]
+    #         the built sections
+    #
+    def analyze
+      @sections = analyzers.map(&:analyze).flatten.compact
+    end
+
+    # Instantiate and add an analyzer by its class.
+    # All properties will be copied to the child analyzer.
+    #
+    # @param [Class] analyzer_class
+    #        the class of the analyzer to instantiate and add
+    #
+    # @param [Hash] options
+    #        options which will be passed on initialization
+    #
+    # @return [Analyzer]
+    #
+    def add_with_class(analyzer_class, options={})
+      analyzer = analyzer_class.new(target, self.options.merge(options))
+      analyzer.exclude_file_patterns = exclude_file_patterns
+      analyzer.logger = logger
+      self.analyzers << analyzer
+      analyzer
+    end
+
+  end
+
+end

data/lib/xcres/analyzer/analyzer.rb

@@ -0,0 +1,141 @@
+require 'xcodeproj'
+require 'xcres/helper/file_helper'
+require 'xcres/model/section'
+
+module XCRes
+
+  # An +Analyzer+ scans the project for references,
+  # which should be included in the output file.
+  #
+  class Analyzer
+    include XCRes::FileHelper
+
+    # @return [PBXNativeTarget]
+    #         the application target of the #project to analyze.
+    attr_reader :target
+
+    # @return [Array<Section>]
+    #         the built sections
+    attr_reader :sections
+
+    # @return [Hash]
+    #         the options passed to the sections
+    attr_accessor :options
+
+    # @return [Array<String>]
+    #         the exclude file patterns
+    attr_accessor :exclude_file_patterns
+
+    # @return [Logger]
+    #         the logger
+    attr_accessor :logger
+
+    delegate :inform, :log, :success, :warn, :fail, to: :logger
+
+    # Initialize a new analyzer
+    #
+    # @param [PBXNativeTarget] target
+    #        see +target+.
+    #
+    # @param [Hash] options
+    #        see subclasses.
+    #
+    def initialize(target=nil, options={})
+      @target = target
+      @sections = []
+      @exclude_file_patterns = []
+      @options = options
+    end
+
+    # Analyze the project
+    #
+    # @return [Array<Section>]
+    #         the built sections
+    #
+    def analyze
+      # Empty stub implementation
+    end
+
+    # Return the Xcode project to analyze
+    #
+    # @return [Xcodeproj::Project]
+    #
+    def project
+      target.project
+    end
+
+    # Create a new +Section+.
+    #
+    # @param  [String] name
+    #         see Section#name
+    #
+    # @param  [Hash] items
+    #         see Section#items
+    #
+    # @param  [Hash] options
+    #         see Section#options
+    #
+    # @return [XCRes::Section]
+    #
+    def new_section(name, data, options={})
+      XCRes::Section.new(name, data, self.options.merge(options))
+    end
+
+    # Apply the configured exclude file patterns to a list of files
+    #
+    # @param [Array<Pathname>] file_paths
+    #        the list of files to filter
+    #
+    # @param [Array<Pathname>]
+    #        the filtered list of files
+    #
+    def filter_exclusions file_paths
+      file_paths.reject do |path|
+        exclude_file_patterns.any? { |pattern| File.fnmatch("#{pattern}", path) || File.fnmatch("**/#{pattern}", path) }
+      end
+    end
+
+    # Discover all references to files with a specific extension in project,
+    # which belong to a resources build phase of an application target.
+    #
+    # @param  [String] extname
+    #         the extname, which contains a leading dot
+    #         e.g.: '.bundle', '.strings'
+    #
+    # @return [Array<PBXFileReference>]
+    #
+    def find_file_refs_by_extname(extname)
+      project.files.select do |file_ref|
+        File.extname(file_ref.path) == extname \
+        && is_file_ref_included_in_application_target?(file_ref)
+      end
+    end
+
+    # Checks if a file ref is included in any resources build phase of any
+    # of the application targets of the #project.
+    #
+    # @param  [PBXFileReference] file_ref
+    #         the file to search for
+    #
+    # @return [Bool]
+    #
+    def is_file_ref_included_in_application_target?(file_ref)
+      resources_files.include?(file_ref)
+    end
+
+    # Find files in resources build phases of application targets
+    #
+    # @return [Array<PBXFileReference>]
+    #
+    def resources_files
+      target.resources_build_phase.files.map do |build_file|
+        if build_file.file_ref.is_a?(Xcodeproj::Project::Object::PBXGroup)
+          build_file.file_ref.recursive_children
+        else
+          [build_file.file_ref]
+        end
+      end.flatten.compact
+    end
+
+  end
+end

data/lib/xcres/analyzer/resources_aggregate_analyzer.rb

@@ -0,0 +1,27 @@
+require 'xcres/analyzer/aggregate_analyzer'
+require 'xcres/analyzer/resources_analyzer/bundle_resources_analyzer'
+require 'xcres/analyzer/resources_analyzer/loose_resources_analyzer'
+require 'xcres/analyzer/resources_analyzer/xcassets_analyzer'
+
+module XCRes
+
+  # A +ResourcesAnalyzer+ scans the project for resources,
+  # which should be included in the output file.
+  #
+  # It is a +AggregateAnalyzer+, which uses the following child analyzers:
+  #  * +XCRes::ResourcesAnalyzer::BundleResourcesAnalyzer+
+  #  * +XCRes::ResourcesAnalyzer::LooseResourcesAnalyzer+
+  #
+  class ResourcesAggregateAnalyzer < AggregateAnalyzer
+
+    def analyze
+      self.analyzers = []
+      add_with_class ResourcesAnalyzer::BundleResourcesAnalyzer
+      add_with_class ResourcesAnalyzer::LooseResourcesAnalyzer
+      add_with_class ResourcesAnalyzer::XCAssetsAnalyzer
+      super
+    end
+
+  end
+
+end