swifterate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e9f4cf722962659b824d981deb085b5e28bf7fe
+  data.tar.gz: 86abd2c89afc2ec23820d402ff98fe685eebb84b
+SHA512:
+  metadata.gz: b6f1d30edeaa51d9a613b6a477be76cef08430d3e413e5159ebeeea23be6242276065eb4977aa99e71e3364e8d20c46b9c3380bf2fe0f0e087ad898d91f0f445
+  data.tar.gz: 8af47272a07544b20a1996dd97f23f2d5ab86e3928552ee223e46051302f4d6d608609ff53e2ed45f06578857cea1dbe5d11c6000aa152b38bfba820f20dd244

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swifterate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mike Enriquez
+
+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,144 @@
+# Swifterate
+
+Swift code generator. Generate strongly typed enums based on your Info.plist and Asset Catalog. No more magic strings!
+
+## Installation
+
+Swifterate is distributed as a Ruby gem.
+
+```bash
+$ gem install swifterate
+```
+
+## Usage
+
+After installing, the `swifterate` command is available:
+
+```bash
+$ swifterate help
+Commands:
+  swifterate ac DIR          # Generate Swift code from an Asset Catalog directory located at DIR
+  swifterate help [COMMAND]  # Describe available commands or one specific command
+  swifterate plist FILE      # Generate Swift code from the .plist file located at FILE
+```
+
+The generated Swift code is printed to the console.  You can redirect the output to a file instead:
+
+```bash
+$ swifterate plist test/fixtures/Info.plist > InfoPlist.swift
+```
+
+## Examples
+
+Swifterate currently supports `.plist` and `.xcassets` as inputs to generate Swift code.
+
+### .plist to Swift Enum
+
+Generate a swift enum from the following MyApp-Info.plist file:
+
+```xml
+<?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>CFBundleName</key>
+	<string>MyApp</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0.0</string>
+	<key>CFBundleVersion</key>
+	<string>100</string>
+</dict>
+</plist>
+```
+
+The following is generated with the command: `swifterate plist MyApp-Info.plist`
+
+```swift
+enum InfoPlist: String {
+
+    case CFBundleName = "CFBundleName"
+    case CFBundleShortVersionString = "CFBundleShortVersionString"
+    case CFBundleVersion = "CFBundleVersion"
+
+    private var infoDictionary: [NSObject : AnyObject] {
+        return NSBundle.mainBundle().infoDictionary!
+    }
+
+    var dictionary: [NSObject : AnyObject] {
+        return infoDictionary[rawValue] as! [NSObject : AnyObject]
+    }
+    
+    var array: [AnyObject] {
+        return infoDictionary[rawValue] as! [AnyObject]
+    }
+    
+    var data: NSData {
+        return infoDictionary[rawValue] as! NSData
+    }
+    
+    var date: NSDate {
+        return infoDictionary[rawValue] as! NSDate
+    }
+    
+    var number: NSNumber {
+        return infoDictionary[rawValue] as! NSNumber
+    }
+    
+    var string: String {
+        return infoDictionary[rawValue] as! String
+    }
+
+
+    init(_ key: InfoPlist) {
+        self = key
+    }
+
+}
+```
+
+To use the generated enum:
+
+```swift
+let appName = InfoPlist(.CFBundleName).string // "MyApp"
+```
+
+### Asset Catalog to UIImage Extension
+
+Generate a `UIImage` extension with an enumerated list of assets from the Asset Catalog:
+
+```bash
+MyApp.xcassets/
+  AppIcon.appiconset/
+  LaunchImage.launchimage/
+  MyAppLogo.imageset/
+  PrimaryButton.imageset/
+```
+
+The following is generated with the command: `swifterate ac MyApp.xcassets`
+
+```swift
+extension UIImage {
+    
+    enum MyAppAsset: String {
+        case MyAppLogo = "MyAppLogo"
+        case PrimaryButton = "PrimaryButton"
+    }
+    
+    convenience init!(assetIdentifier: MyAppAsset) {
+        self.init(named: assetIdentifier.rawValue)
+    }
+    
+}
+```
+
+Notice that the `AppIcon` and `LaunchImage` aren't included. They cannot be referenced using `UIImage(imageNamed:)`
+
+To use the generated extension:
+
+```swift
+let myAppLogo = UIImage(assetIdentifier: .MyAppLogo)
+```
+
+## License
+
+Swifterate is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/test_*.rb"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swifterate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/swifterate

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'swifterate/cli'
+
+Swifterate::CLI.start

data/lib/swifterate.rb

@@ -0,0 +1,6 @@
+require "swifterate/version"
+require "swifterate/plist"
+require "swifterate/asset_catalog"
+
+module Swifterate
+end

data/lib/swifterate/asset_catalog.rb

@@ -0,0 +1,29 @@
+require 'pathname'
+
+module Swifterate
+  class AssetCatalog
+
+    CATALOG_EXTENSION = ".xcassets"
+    ASSET_EXTENSION = ".imageset"
+
+    def initialize(directory)
+      directory = Pathname.new(directory)
+      @catalog_name = directory.basename(CATALOG_EXTENSION).to_s
+      @asset_dirs = directory.children.select { |dir| dir.directory? && dir.extname == ASSET_EXTENSION }
+    end
+
+    def assets
+      @asset_dirs.map { |dir| dir.basename(ASSET_EXTENSION).to_s }
+    end
+
+    def members
+      Helper.enum_members(assets)
+    end
+
+    def swift_extension(name = @catalog_name + "Asset")
+      template_file = File.join(File.dirname(__FILE__), 'templates/UIImageExtensions.swift.mustache')
+      Mustache.render(File.read(template_file), name: name, members: members)
+    end
+
+  end
+end

data/lib/swifterate/cli.rb

@@ -0,0 +1,20 @@
+require 'thor'
+require 'swifterate/generator'
+
+module Swifterate
+  class CLI < Thor
+
+    desc "plist FILE", "Generate Swift code from the .plist file located at FILE"
+    method_option :name, :type => :string, :desc => "The resuling Swift enum name. Defaults to InfoPlist"
+    def plist(input)
+      Generator.plist(File.expand_path(input), options[:name])
+    end
+
+    desc "ac DIR", "Generate Swift code from an Asset Catalog directory located at DIR"
+    method_option :name, :type => :string, :desc => "The resuling Swift enum name. Defaults to <Asset Catalog Name>Asset"
+    def ac(input)
+      Generator.ac(File.expand_path(input), options[:name])
+    end
+
+  end
+end

data/lib/swifterate/generator.rb

@@ -0,0 +1,28 @@
+require 'swifterate/plist'
+require 'swifterate/asset_catalog'
+
+module Swifterate
+  class Generator
+
+    def self.plist(input, name = nil)
+      plist = PList.new(input)
+
+      if name
+        puts plist.swift_enum(name)
+      else
+        puts plist.swift_enum
+      end
+    end
+
+    def self.ac(input, name = nil)
+      asset_catalog = AssetCatalog.new(input)
+
+      if name
+        puts asset_catalog.swift_extension(name)
+      else
+        puts asset_catalog.swift_extension
+      end
+    end
+
+  end
+end

data/lib/swifterate/helper.rb

@@ -0,0 +1,15 @@
+module Swifterate
+  class Helper
+
+    def self.enum_members(key_list)
+      key_list.map { |key| { member_name: sanitize_swift_member(key), key: key } }
+    end
+
+    private
+
+    def self.sanitize_swift_member(key)
+      key.gsub(/[^a-z0-9_]/i, '')
+    end
+
+  end
+end

data/lib/swifterate/plist.rb

@@ -0,0 +1,27 @@
+require 'cfpropertylist'
+require 'mustache'
+require 'swifterate/helper'
+
+module Swifterate
+  class PList
+
+    def initialize(file)
+      plist = CFPropertyList::List.new(file: file)
+      @data = CFPropertyList.native_types(plist.value)
+    end
+
+    def keys
+      @data.keys
+    end
+
+    def members
+      Helper.enum_members(keys)
+    end
+
+    def swift_enum(name = "InfoPlist")
+      template_file = File.join(File.dirname(__FILE__), 'templates/InfoPlist.swift.mustache')
+      Mustache.render(File.read(template_file), name: name, members: members)
+    end
+
+  end
+end

data/lib/swifterate/templates/InfoPlist.swift.mustache

@@ -0,0 +1,40 @@
+enum {{ name }}: String {
+
+    {{#members}}
+    case {{member_name}} = "{{key}}"
+    {{/members}}
+
+    private var infoDictionary: [NSObject : AnyObject] {
+        return NSBundle.mainBundle().infoDictionary!
+    }
+
+    var dictionary: [NSObject : AnyObject] {
+        return infoDictionary[rawValue] as! [NSObject : AnyObject]
+    }
+    
+    var array: [AnyObject] {
+        return infoDictionary[rawValue] as! [AnyObject]
+    }
+    
+    var data: NSData {
+        return infoDictionary[rawValue] as! NSData
+    }
+    
+    var date: NSDate {
+        return infoDictionary[rawValue] as! NSDate
+    }
+    
+    var number: NSNumber {
+        return infoDictionary[rawValue] as! NSNumber
+    }
+    
+    var string: String {
+        return infoDictionary[rawValue] as! String
+    }
+
+
+    init(_ key: {{ name }}) {
+        self = key
+    }
+
+}

data/lib/swifterate/templates/UIImageExtensions.swift.mustache

@@ -0,0 +1,13 @@
+extension UIImage {
+    
+    enum {{name}}: String {
+        {{#members}}
+        case {{member_name}} = "{{key}}"
+        {{/members}}
+    }
+    
+    convenience init!(assetIdentifier: {{name}}) {
+        self.init(named: assetIdentifier.rawValue)
+    }
+    
+}

data/lib/swifterate/version.rb

@@ -0,0 +1,3 @@
+module Swifterate
+  VERSION = "0.1.0"
+end

data/swifterate.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swifterate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swifterate"
+  spec.version       = Swifterate::VERSION
+  spec.authors       = ["Mike Enriquez"]
+  spec.email         = ["mike@enriquez.me"]
+
+  spec.summary       = %q{Swift code generator.}
+  spec.description   = %q{Swift code generator. Generate strongly typed enums based on your Info.plist and Asset Catalog. No more magic strings!}
+  spec.homepage      = "https://github.com/enriquez/swifterate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "CFPropertyList", "~> 2.3"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "mustache", "~> 1.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: swifterate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Enriquez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Swift code generator. Generate strongly typed enums based on your Info.plist
+  and Asset Catalog. No more magic strings!
+email:
+- mike@enriquez.me
+executables:
+- swifterate
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/swifterate
+- lib/swifterate.rb
+- lib/swifterate/asset_catalog.rb
+- lib/swifterate/cli.rb
+- lib/swifterate/generator.rb
+- lib/swifterate/helper.rb
+- lib/swifterate/plist.rb
+- lib/swifterate/templates/InfoPlist.swift.mustache
+- lib/swifterate/templates/UIImageExtensions.swift.mustache
+- lib/swifterate/version.rb
+- swifterate.gemspec
+homepage: https://github.com/enriquez/swifterate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Swift code generator.
+test_files: []