xcres 0.4.0

data/lib/xcres/logger.rb

@@ -0,0 +1,148 @@
+#encoding: utf-8
+
+require 'colored'
+
+# A Logger utility help class
+#
+class XCRes::Logger
+
+  # @return [Bool]
+  #         if set to false, calls to #log will be ignored
+  #         otherwise they will be printed, false by default.
+  attr_accessor :verbose
+  alias :verbose? verbose
+
+  # @return [Bool]
+  #         if set to true, all log calls of all kinds will be ignored
+  #         otherwise they will be printed, false by default.
+  attr_accessor :silent
+  alias :silent? silent
+
+  # @return [Bool]
+  #         if set to true, ANSI colors will be used to color the output
+  #         otherwise it will output plain text, true by default.
+  attr_accessor :colored
+  alias :colored? colored
+
+  # @return [String]
+  #         the indentation of the output, empty string by default.
+  attr_accessor :indentation
+
+  # Initialize a new logger
+  #
+  def initialize
+    self.silent = false
+    self.verbose = false
+    self.colored = true
+    self.indentation = ''
+  end
+
+  # Prints a formatted message
+  #
+  # @param [String] message
+  #        the message, which can have format placeholders
+  #
+  # @param [#to_s...] format_args
+  #        will be passed as right hand side to the percent operator,
+  #        which will fill the format placeholders used in the message
+  #
+  def inform message, *format_args
+    puts indentation + message % format_args unless silent?
+  end
+
+  # Prints a formatted message in a given color, and prints its arguments
+  # with bold font weight
+  #
+  # @param [String] message
+  #        the message, which can have format placeholders
+  #
+  # @param [Symbol] color
+  #        the color, String has to #respond_to? this
+  #
+  # @param [#to_s...] format_args
+  #        will be passed as right hand side to the percent operator,
+  #        which will fill the format placeholders used in the message
+  #
+  def inform_colored message, color, *format_args
+    if colored?
+      parts = message
+         .gsub(/%[\ +#]?\d*\.?\d*[a-z]/, "\0"+'\0'+"\0")
+         .split("\0")
+         .reject(&:empty?)
+      message = parts.map do |part|
+        if part[0] == '%' && part[1] != '%'
+          (part % format_args.shift).bold.gsub('%', '%%')
+        else
+          part
+        end
+      end.map(&color).join('')
+    end
+    inform message, *format_args
+  end
+
+  # Print a log message of log level verbose
+  #
+  # @param [String] message
+  #        the message, which can have format placeholders
+  #
+  # @param [#to_s...] format_args
+  #        will be passed as right hand side to the percent operator,
+  #        which will fill the format placeholders used in the message
+  #
+  def log message, *format_args
+    inform_colored 'Ⓥ' + ' ' + message, :magenta, *format_args if verbose?
+  end
+
+  # Print a log message to indicate success of an operation in green color
+  #
+  # @param [String] message
+  #        the message, which can have format placeholders
+  #
+  # @param [#to_s...] format_args
+  #        will be passed as right hand side to the percent operator,
+  #        which will fill the format placeholders used in the message
+  #
+  def success message, *format_args
+    inform_colored '✓' + ' ' + message, :green, *format_args
+  end
+
+  # Print a warning log message in yellow color
+  #
+  # @param [String] message
+  #        the message, which can have format placeholders
+  #
+  # @param [#to_s...] format_args
+  #        will be passed as right hand side to the percent operator,
+  #        which will fill the format placeholders used in the message
+  #
+  def warn message, *format_args
+    inform_colored '⚠' + ' ' + message, :yellow, *format_args
+  end
+
+  # Print a log message to indicate failure of an operation in red color
+  #
+  # @param [String|Exception] message
+  #        The message, which can have format placeholders,
+  #        can also be a kind of Exception, then its message would been
+  #        used instead. The backtrace will be only printed, if the verbose
+  #        mode is enabled.
+  #
+  # @param [#to_s...] format_args
+  #        will be passed as right hand side to the percent operator,
+  #        which will fill the format placeholders used in the message
+  #
+  def fail message, *format_args
+    exception = nil
+    if message.kind_of? Exception
+      exception = message
+      message = exception.message
+    end
+
+    inform_colored '✗' + ' ' + message, :red, *format_args
+
+    if verbose? && exception != nil
+      log "Backtrace:\n"+exception.backtrace.join("\n"), :red
+    end
+  end
+
+end

data/lib/xcres/model/section.rb

@@ -0,0 +1,43 @@
+module XCRes
+  class Section
+
+    # @return [String]
+    #         the name / key of the section
+    attr_reader :name
+
+    # @return [Hash{String => String|Hash}]
+    #         the items of the section
+    attr_reader :items
+
+    # @return [Hash]
+    #         options of the section for serialization
+    attr_accessor :options
+
+    # Initialize a new section
+    #
+    # @param  [String] name
+    #         see #name
+    #
+    # @param  [Hash] items
+    #         see #items
+    #
+    # @param  [Hash] options
+    #         see #options
+    #
+    #
+    def initialize(name, items, options={})
+      @name  = name
+      @items = items
+      @options = options
+    end
+
+    def ==(other)
+      self.name == other.name \
+        && self.items == other.items \
+        && self.options == other.options
+    end
+
+    alias eql? ==
+
+  end
+end

data/lib/xcres/model/xcassets/bundle.rb

@@ -0,0 +1,55 @@
+require 'xcres/model/xcassets/resource'
+
+module XCRes::XCAssets
+
+  # Represents the whole asset catalog
+  #
+  class Bundle
+
+    # @return [Pathname]
+    #
+    attr_accessor :path
+
+    # @return [Array<Pathname>]
+    #         the paths of the resources contained, relative to the container
+    #         given by #path.
+    attr_accessor :resource_paths
+
+    # @return [Array<Resource>]
+    #         the parsed resources
+    attr_accessor :resources
+
+    # Open a XCAssets collection at a given path
+    #
+    # @return [XCAssets::Bundle]
+    #
+    def self.open(path)
+      self.new(path).read
+    end
+
+    # Initialize a new file with given path
+    #
+    # @param [Pathname] path
+    #        the location of the container
+    #
+    def initialize(path = nil)
+      @path = Pathname(path) unless path.nil?
+      @resources = []
+    end
+
+    # Read the resources from disk
+    #
+    # @return [XCAssets::Bundle]
+    #
+    def read
+      @resource_paths = Dir.chdir(path) do
+        Dir['*'].map { |p| Pathname(p) }
+      end
+      @resources = @resource_paths.map do |path|
+        Resource.new(self, path)
+      end
+      self
+    end
+  end
+
+end

data/lib/xcres/model/xcassets/resource.rb

@@ -0,0 +1,141 @@
+require 'json'
+require 'xcres/helper/file_helper'
+require 'xcres/model/xcassets/resource_image'
+
+module XCRes::XCAssets
+
+  # Represents a single resource of an asset catalog
+  #
+  class Resource
+    include XCRes::FileHelper
+
+    # @return [XCAssets::Bundle]
+    #         the whole bundle
+    attr_accessor :bundle
+
+    # @return [Pathname]
+    #         the directory name
+    attr_accessor :path
+
+    # @return [Hash]
+    #         file meta info
+    attr_accessor :info
+
+    # @return [Array<ResourceImage>]
+    #         the images contained in this resource
+    attr_accessor :images
+
+    # Initialize a new resource
+    #
+    # @param  [XCAssets:Bundle]
+    #         the containing bundle
+    #
+    # @param  [Pathname]
+    #         see #path.
+    #
+    def initialize(bundle, path)
+      self.bundle = bundle
+      self.path = path
+    end
+
+    # Return the name of the resource
+    #
+    # @return [String]
+    #
+    def name
+      @name ||= basename_without_ext path
+    end
+
+    # Return the type of the resource,
+    # e.g. 'appiconset', 'imageset', 'launchimage'
+    #
+    # @return [String]
+    #
+    def type
+      @type ||= File.extname(path).sub(/^./, '')
+    end
+
+    # Lazy read the info, if not initialized
+    #
+    # @return [Hash]
+    #
+    def info
+      @info ||= read_info
+    end
+
+    # Lazy read the images, if not initialized
+    #
+    # @return [Array<XCAssets::ResourceImage>]
+    #
+    def images
+      @images ||= read_images
+    end
+
+    # Serialize to hash
+    #
+    # @return [Hash]
+    #
+    def to_hash
+      {
+        'images' => images.map(&:to_hash),
+        'info' => info,
+      }
+    end
+
+    protected
+
+    # The path of the Contents.json file
+    #
+    # @return [Pathname]
+    #
+    def json_path
+      bundle.path + path + 'Contents.json'
+    end
+
+    # Parse the Content.json file
+    #
+    # @return [Hash]
+    #
+    def parsed_contents
+      @hash ||= JSON.parse File.read(json_path)
+    end
+
+    # Deserialize #contents.
+    #
+    # @return [XCAssets::Resource]
+    #
+    def read
+      @info = read_info
+      @images = read_images
+      self
+    end
+
+    # Deserialize the file info from the #contents.
+    #
+    # @return [Hash]
+    #
+    def read_info
+      parsed_contents['info'] || {}
+    end
+
+    # Deserialize the images from the #contents.
+    #
+    # @return [Array<XCAssets::ResourceImage>]
+    #
+    def read_images
+      return [] if parsed_contents['images'].nil?
+      parsed_contents['images'].map do |img_hash|
+        ResourceImage.read(img_hash)
+      end
+    end
+
+    def ==(other)
+      return false unless other.respond_to?(:to_hash)
+      self.to_hash == other.to_hash
+    end
+
+    alias eql? ==
+
+  end
+
+end

data/lib/xcres/model/xcassets/resource_image.rb

@@ -0,0 +1,134 @@
+require 'active_support/core_ext/string/inflections'
+
+module XCRes::XCAssets
+
+  # Represents a single image of a resource in an asset catalog
+  #
+  class ResourceImage
+
+    # The known keys
+    KNOWN_KEYS = [
+        :filename,
+        :scale,
+        :orientation,
+        :size,
+        :idiom,
+        :subtype,
+        :extent,
+        :minimum_system_version
+    ].freeze
+
+    # @return [Pathname]
+    #         file name
+    attr_accessor :filename
+
+    # @return [Integer]
+    #         scale of the image
+    attr_accessor :scale
+
+    # @return [Symbol]
+    #         the orientation, e.g. 'portrait'
+    attr_accessor :orientation
+
+    # @return [String]
+    #         the size, e.g. '29x29', '40x40'
+    attr_accessor :size
+
+    # @return [Symbol]
+    #         the idiom, e.g. 'iphone'
+    attr_accessor :idiom
+
+    # @return [Symbol]
+    #         the subtype, e.g. 'retina4'
+    attr_accessor :subtype
+
+    # @return [Symbol]
+    #         the extent, e.g. 'full-screen'
+    attr_accessor :extent
+
+    # @return [String]
+    #         the minimum system version, e.g. '7.0'
+    attr_accessor :minimum_system_version
+
+    # @return [Hash{Symbol => String}]
+    #         further attributes, not mapped to a specific attribute
+    attr_accessor :attributes
+
+    # Read from hash
+    #
+    # @param  [Hash]
+    #         the hash to deserialize
+    #
+    # @return [ResourceImage]
+    #
+    def self.read(hash)
+      self.new.read(hash)
+    end
+
+    # Initialize a new ResourceImage
+    #
+    # @param  [Hash]
+    #         the initial attribute values
+    #
+    def initialize(attributes={})
+      self.scale = attributes.delete('scale') unless attributes['scale'].nil?
+
+      KNOWN_KEYS.each do |key|
+        self.send "#{key}=".to_sym, attributes.delete(key)
+      end
+
+      self.attributes = attributes
+    end
+
+    # Read from hash
+    #
+    # @param  [Hash]
+    #         the hash to deserialize
+    #
+    # @return [ResourceImage]
+    #
+    def read(hash)
+      self.scale = hash.delete('scale').sub(/x$/, '').to_i unless hash['scale'].nil?
+
+      KNOWN_KEYS.each do |key|
+        value = hash.delete(key.to_s.dasherize)
+        next if value.nil?
+        self.send "#{key}=".to_sym, value
+      end
+
+      self.attributes = hash
+
+      return self
+    end
+
+    # Serialize to hash
+    #
+    # @return [Hash{String => String}]
+    #
+    def to_hash
+      hash = {}
+
+      hash['scale'] = "#{scale}x" unless scale.nil?
+
+      (KNOWN_KEYS - [:scale]).each do |key|
+        value = self.send(key)
+        hash[key.to_s.dasherize] = value.to_s unless value.nil?
+      end
+
+      attributes.each do |key, value|
+        hash[key.to_s] = value
+      end
+
+      hash
+    end
+
+    def ==(other)
+      return false unless other.respond_to?(:to_hash)
+      self.to_hash == other.to_hash
+    end
+
+    alias eql? ==
+
+  end
+
+end

data/lib/xcres/version.rb

@@ -0,0 +1,9 @@
+module XCRes
+
+  # @return [String]
+  #
+  #   XCRes’s version, following [semver](http://semver.org).
+  #
+  VERSION = "0.4.0"
+
+end

data/lib/xcres.rb

@@ -0,0 +1,9 @@
+require 'pathname'
+require 'active_support/core_ext/string/strip'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/array/conversions'
+
+module XCRes
+  require 'xcres/version'
+  require 'xcres/command/main_command'
+end

data/spec/fixtures/Example/Example/AppDelegate.h

@@ -0,0 +1,15 @@
+//
+//  AppDelegate.h
+//  Example
+//
+//  Created by Marius Rackwitz on 01.05.14.
+//  Copyright (c) 2014 XCRes. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+
+@interface AppDelegate : UIResponder <UIApplicationDelegate>
+
+@property (strong, nonatomic) UIWindow *window;
+
+@end

data/spec/fixtures/Example/Example/AppDelegate.m

@@ -0,0 +1,49 @@
+//
+//  AppDelegate.m
+//  Example
+//
+//  Created by Marius Rackwitz on 01.05.14.
+//  Copyright (c) 2014 XCRes. All rights reserved.
+//
+
+#import "AppDelegate.h"
+
+@implementation AppDelegate
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+    self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
+    // Override point for customization after application launch.
+    self.window.backgroundColor = [UIColor whiteColor];
+    [self.window makeKeyAndVisible];
+    return YES;
+}
+
+- (void)applicationWillResignActive:(UIApplication *)application
+{
+    // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state.
+    // Use this method to pause ongoing tasks, disable timers, and throttle down OpenGL ES frame rates. Games should use this method to pause the game.
+}
+
+- (void)applicationDidEnterBackground:(UIApplication *)application
+{
+    // Use this method to release shared resources, save user data, invalidate timers, and store enough application state information to restore your application to its current state in case it is terminated later. 
+    // If your application supports background execution, this method is called instead of applicationWillTerminate: when the user quits.
+}
+
+- (void)applicationWillEnterForeground:(UIApplication *)application
+{
+    // Called as part of the transition from the background to the inactive state; here you can undo many of the changes made on entering the background.
+}
+
+- (void)applicationDidBecomeActive:(UIApplication *)application
+{
+    // Restart any tasks that were paused (or not yet started) while the application was inactive. If the application was previously in the background, optionally refresh the user interface.
+}
+
+- (void)applicationWillTerminate:(UIApplication *)application
+{
+    // Called when the application is about to terminate. Save data if appropriate. See also applicationDidEnterBackground:.
+}
+
+@end

data/spec/fixtures/Example/Example/Example-Info.plist

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleDisplayName</key>
+	<string>${PRODUCT_NAME}</string>
+	<key>CFBundleExecutable</key>
+	<string>${EXECUTABLE_NAME}</string>
+	<key>CFBundleIdentifier</key>
+	<string>io.github.xcres.${PRODUCT_NAME:rfc1034identifier}</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>${PRODUCT_NAME}</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>armv7</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+</dict>
+</plist>

data/spec/fixtures/Example/Example/Example-Prefix.pch

@@ -0,0 +1,16 @@
+//
+//  Prefix header
+//
+//  The contents of this file are implicitly included at the beginning of every source file.
+//
+
+#import <Availability.h>
+
+#ifndef __IPHONE_3_0
+#warning "This project uses features only available in iOS SDK 3.0 and later."
+#endif
+
+#ifdef __OBJC__
+    #import <UIKit/UIKit.h>
+    #import <Foundation/Foundation.h>
+#endif

data/spec/fixtures/Example/Example/Images.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,23 @@
+{
+  "images" : [
+    {
+      "idiom" : "iphone",
+      "size" : "29x29",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "iphone",
+      "size" : "40x40",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "iphone",
+      "size" : "60x60",
+      "scale" : "2x"
+    }
+  ],
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}