ovaltine 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA1: 
-  metadata.gz: bf29e84c1f9fcf6bf4121916abd32252f21bcf11
-  data.tar.gz: 45c7913c46c4044da01ea1910ac0223177ab63b7
 SHA512: 
-  metadata.gz: 94aac6bb2aff88696a796823c8a2caf5f9899d63a154da2b93cd354740365a98ad4e725bd9a10a8d5742861314693080439a24c1012fac9613eeecab9f3651c5
-  data.tar.gz: ebf734f231c593d20dbccbaec111744af471beb63524479efe86a2781ec6c1cbc587444d3c3a10cbc83678a9c6fffccc231f596a8a2704300832abb58e0eb9e7
+  data.tar.gz: f76c243272bd421a5635d495d6796d4820688d624d322d7c2a3994e920c65d3b3ddea40f08fe6fcec1fe66973c963c1ca830cf6a1f5c91a64192c56d461f6442
+  metadata.gz: da7d8f1f5a64d059b5b62bc76847df9d3ff7c595c2df30147b9747aacaed3e4b60391f61c0b0b72bdf8f07688dc00ef8e9b761bcde085b898409eedb506daac1
+SHA1: 
+  data.tar.gz: 88b8b643bcc95048a2e41e9e970bbe10d68311be
+  metadata.gz: 96b9c29b9c0754d1065ddc765524a428a409978a

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 1.0.4
+
+- Hotfix for failed error handling in Ruby 1.8.7
+- Avoid writing xcode project files when no files added
+- Add language argument for potentially generating templates in other languages
+- Prefix identifier constants
+
+# 1.0.3
+
+- Experimental support for adding generated files to Xcode project
+
 # 1.0.2
 
 - Hotfix for Ruby 1.8.7

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    ovaltine (1.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bacon (1.2.0)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon (~> 1.2)
+  bundler (~> 1.3)
+  ovaltine!
+  rake (~> 10.0)

data/README.md

@@ -1,15 +1,25 @@
-# Ovaltine
+# Ovaltine [![Build Status](https://travis-ci.org/kattrali/ovaltine.svg?branch=master)](https://travis-ci.org/kattrali/ovaltine)
 
 The chocolatey treat which makes your code clean! Yum!
 
 `Ovaltine` scans your `storyboard` files and generates constant files for view controller, segue, and reuse identifiers. For instance, if you have a storyboard called `Main` and a view controller with the Storyboard ID `authenticationViewController`, then you can instantiate that controller with something like `[ABCMainStoryboard instantiateAuthenticationViewController]`. No mistyping, plenty of chocolately goodness.
 
-# Installation
+## Installation
 
 ```
 gem install ovaltine
 ```
 
-# Usage
+## Example Usage
 
-Run `ovaltine` from the command line
+```
+ovaltine --prefix ABC --auto-replace --auto-add --project path/to/project.xcodeproj path/to/project/files
+```
+
+Run from the command line or as a build step (if you are brave!) [Here](https://gist.github.com/kattrali/bbe9e2464d02a8ca4cb1) are some example files generated using `ovaltine`.
+
+## Additional Documentation
+
+```
+ovaltine --help
+```

data/Rakefile

@@ -2,4 +2,4 @@
 desc "Run unit tests"
 task :spec do
   sh 'bacon specs/*_spec.rb'
-end
+end

data/TODO.md

@@ -1,6 +1,5 @@
 
 ## TODO
 
-* Support adding generated files to projects (with minimal dependencies, for easier tool integration)
 * Add switch for language preferences
-* Add support for OS X storyboards
+* Add support for OS X storyboards

data/bin/ovaltine

@@ -12,8 +12,8 @@ require 'ovaltine'
 require 'optparse'
 
 parser_options = {
-  :output_directory => '.',
-  :prefix => ''
+  :prefix => '',
+  :language => 'objc'
 }
 
 def exit_with_error(message)
@@ -29,7 +29,7 @@ OptionParser.new do |opts|
   opts.on('-o', '--output DIR', 'Specify output directory. Default is pwd') do |path|
     parser_options[:output_directory] = path
   end
-  opts.on('--prefix PREFIX', 'Class prefix for generated files') do |prefix|
+  opts.on('--prefix PREFIX', 'Specify class prefix for generated files') do |prefix|
     parser_options[:prefix] = prefix
   end
   opts.on('--auto-add', 'Automatically add generated files to the Xcode project') do
@@ -38,6 +38,9 @@ OptionParser.new do |opts|
   opts.on('--auto-replace', 'Automatically replace files with the same name as generated files') do
     parser_options[:auto_replace] = true
   end
+  opts.on('--objc', 'Specify Objective-C as the template language (Default)') do
+    parser_options[:language] = 'objc'
+  end
   opts.on_tail('-h', '--help', 'Show this message') { puts opts; exit }
   opts.on_tail("-v", "--version", "Show version") { puts Ovaltine::VERSION; exit }
   opts.parse!

data/lib/ovaltine/objc/storyboard_formatter.rb

@@ -103,7 +103,7 @@ module Ovaltine
     end
 
     def variable_name identifier
-      "_#{identifier.gsub(/\W/,'').gsub(/\b\w/){ $&.downcase }}"
+      "_#{@prefix}#{identifier.gsub(/\W/,'').gsub(/\b\w/){ $&.downcase }}"
     end
 
 

data/lib/ovaltine/objc/storyboard_templates.rb

@@ -20,7 +20,7 @@ module Ovaltine
 
 #import <Foundation/Foundation.h>
 
-@interface {CLASS_NAME}
+@interface {CLASS_NAME} : NSObject
 
 +(UIStoryboard *)storyboard;
 
@@ -40,7 +40,7 @@ module Ovaltine
 #import <UIKit/UIKit.h>
 #import "{CLASS_NAME}.h"
 
-static UIStoryboard* _storyboard = nil;
+static UIStoryboard *_storyboard = nil;
 {STATIC_VARIABLES}
 
 @implementation {CLASS_NAME}

data/lib/ovaltine/version.rb

@@ -1,3 +1,3 @@
 module Ovaltine
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/ovaltine/xcode_project/ext/stdlib.rb

@@ -0,0 +1,19 @@
+class String
+  def to_plist
+    to_json
+  end
+end
+
+class Array
+  def to_plist
+    items = map { |item| "#{item.to_plist}" }
+    "( #{items.join ","} )"
+  end
+end
+
+class Hash
+  def to_plist
+    items = map { |key, value| "#{key.to_plist} = #{value.to_plist};\n" }
+    "{ #{items.join} }"
+  end
+end

data/lib/ovaltine/xcode_project/pbxfilereference.rb

@@ -0,0 +1,14 @@
+
+module Ovaltine
+  class XcodeProject
+    class PBXFileReference < PBXObject
+      def self.create path, file_type
+        self.new PBXObject.create_uuid, {
+          "sourceTree" => "<group>",
+          "path" => path,
+          "lastKnownFileType" => file_type
+        }
+      end
+    end
+  end
+end

data/lib/ovaltine/xcode_project/pbxgroup.rb

@@ -0,0 +1,41 @@
+
+module Ovaltine
+  class XcodeProject
+    class PBXGroup < PBXObject
+
+      def self.create name
+        self.new(PBXObject.create_uuid, {
+          "children" => [],
+          "name" => name,
+          "sourceTree" => "<group>"
+        })
+      end
+
+      def add_object obj
+        unless self["children"].include?(obj.uuid)
+          self["children"] << obj.uuid
+        end
+      end
+
+      def children recursive=false
+        children = self.project_file.objects_with_uuids self["children"]
+
+        if recursive
+          subgroups = PBXObject.filter children, { "isa" => "PBXGroup" }
+          subgroups.each { |subgroup| children << subgroup.children(true) }
+        end
+
+        children.flatten
+      end
+    end
+
+    class PBXSourcesBuildPhase < PBXObject; end
+    class PBXFrameworksBuildPhase < PBXObject; end
+    class PBXResourcesBuildPhase < PBXObject; end
+    class PBXNativeTarget < PBXObject; end
+    class PBXProject < PBXObject; end
+    class PBXContainerItemProxy < PBXObject; end
+    class PBXReferenceProxy < PBXObject; end
+    class XCBuildConfiguration < PBXObject; end
+  end
+end

data/lib/ovaltine/xcode_project/pbxobject.rb

@@ -0,0 +1,32 @@
+
+module Ovaltine
+  class XcodeProject
+    class PBXObject < Hash
+      attr_accessor :project_file
+      attr_reader :uuid
+
+      def self.filter array, attrs
+        array.select do |obj|
+          attrs.select { |k,v| obj[k] == v }.length == attrs.length
+        end
+      end
+
+      def self.create_uuid
+        uuid = ""
+        24.times { uuid += "0123456789ABCDEF"[rand(16),1] }
+        uuid
+      end
+
+      def initialize uuid, hash
+        @project = nil
+        @uuid = uuid
+        self["isa"] = self.class.to_s.split('::').last
+        hash.each { |k,v| self[k] = v }
+      end
+
+      def inspect
+        @uuid + "=" + super
+      end
+    end
+  end
+end

data/lib/ovaltine/xcode_project.rb

@@ -0,0 +1,104 @@
+
+module Ovaltine
+  class XcodeProject
+
+    def load_dependencies
+      unless @@loaded ||= false
+        unless Object.const_defined?(:JSON)
+          begin
+            require 'json'
+          rescue LoadError
+            require File.expand_path(File.join(File.dirname(__FILE__),'../../vendor/json_pure/parser'))
+            require File.expand_path(File.join(File.dirname(__FILE__),'../../vendor/json_pure/generator'))
+          end
+        end
+        @@loaded = true
+      end
+    end
+
+    def initialize path
+      load_dependencies
+      if path =~ /\.xcodeproj$/
+        @path = File.join(path, 'project.pbxproj')
+      else
+        @path = path
+      end
+      @json = JSON.parse(`plutil -convert json -o - "#{@path}"`)
+
+      @json["objects"].each do |uuid, hash|
+        klass = PBXObject
+        begin
+          klass = Ovaltine::XcodeProject.const_get "#{hash['isa']}"
+        rescue
+        end
+
+        obj = klass.new uuid, hash
+        obj.project_file = self
+
+        @json["objects"][uuid] = obj
+      end
+    end
+
+    def save
+      File.open(@path, "w") { |f| f.write @json.to_plist }
+    end
+
+    def objects
+      @json["objects"].values
+    end
+
+    def groups
+      objects_of_class(PBXGroup)
+    end
+
+    def files
+      objects_of_class(PBXFileReference)
+    end
+
+    def objects_of_class klass
+      str = klass.to_s.split('::').last
+      objects.select {|obj| obj["isa"] == str }
+    end
+
+    def objects_with_uuids uuids
+      uuids.map {|uuid| self.object_with_uuid uuid }
+    end
+
+    def object_with_uuid uuid
+      @json["objects"][uuid]
+    end
+
+    def add_file_ref path
+      relpath = File.expand_path(path).gsub(File.dirname(File.dirname(File.expand_path(@path))), '')[1..-1]
+      relpath = relpath[(relpath.index('/') + 1)..-1]
+      return nil if files.detect {|ref| ref["path"] == relpath}
+      ref = PBXFileReference.create(relpath, file_type(path))
+      add_object(ref)
+      main_group = groups.detect do |g|
+        !g["name"] && g["path"] && !g["path"].include?("Test")
+      end
+      unless group = groups.detect {|g| g["name"] == "Generated Files"}
+        group = PBXGroup.create("Generated Files")
+        add_object(group)
+        main_group.add_object(group)
+      end
+      group.add_object(ref)
+      ref
+    end
+
+    def add_object obj
+      obj.project_file = self
+      @json["objects"][obj.uuid] = obj
+    end
+
+    def file_type path
+      file_type = 'sourcecode'
+      if path =~ /\.m$/
+        file_type = 'sourcecode.c.objc'
+      elsif path =~ /\.h$/
+        file_type = 'sourcecode.c.h'
+      end
+      file_type
+    end
+  end
+end

data/lib/ovaltine.rb

@@ -1,25 +1,38 @@
 
 require 'ovaltine/storyboard'
-require 'ovaltine/objc/storyboard_formatter'
-require 'ovaltine/objc/storyboard_templates'
 require 'ovaltine/version'
+require 'ovaltine/xcode_project'
+require 'ovaltine/xcode_project/pbxobject'
+require 'ovaltine/xcode_project/pbxgroup'
+require 'ovaltine/xcode_project/pbxfilereference'
+require 'ovaltine/xcode_project/ext/stdlib'
 
 module Ovaltine
 
   def self.create_constant_files(path, options)
+    require_formatter(options[:language])
     files = Dir.glob("#{path}/**/*.storyboard")
     groups = files.group_by {|f| File.basename(f).sub('.storyboard','')}
     formatters = groups.map do |name, paths|
       storyboard = Storyboard.new(name, paths)
-      StoryboardFormatter.new(storyboard, options[:prefix], options[:output_directory])
+      StoryboardFormatter.new(storyboard, options[:prefix], (options[:output_directory] || path))
     end
     generated_paths = formatters.map(&:output_paths).flatten
-    if path = generated_paths.detect {|p| File.exist?(p)} and !options[:auto_replace]
-      if prompt("Some generated files already exist. Overwrite? (Y/n)", 'y')
-        write_files(formatters)
+    if existing_path = generated_paths.detect {|p| File.exist?(p)} and !options[:auto_replace]
+      return unless prompt("Some generated files already exist. Overwrite? (Y/n)", 'y')
+    end
+
+    paths = write_files(formatters)
+
+    if project_filepath = options[:project] || Dir.glob("#{File.dirname(path)}/**/*.xcodeproj").first
+      return unless options[:auto_add] or prompt("[Experimental] Add files to project? (y/N)", 'n')
+      project = XcodeProject.new(project_filepath)
+      if paths.sort.map {|p| project.add_file_ref(p)}.compact.size > 0
+        project.save
+        puts "#{File.basename(project_filepath)} updated"
+      else
+        puts "All files already added"
       end
-    else
-      write_files(formatters)
     end
   end
 
@@ -35,6 +48,7 @@ module Ovaltine
       puts "  * #{File.basename(path)}"
     end
     puts "\n#{files.size} files generated"
+    files
   end
 
   def self.prompt title, default_answer
@@ -48,4 +62,12 @@ module Ovaltine
       answer.downcase == 'y'
     end
   end
+
+  def self.require_formatter(language='objc')
+    case language
+    when 'objc'
+      require 'ovaltine/objc/storyboard_formatter'
+      require 'ovaltine/objc/storyboard_templates'
+    end
+  end
 end

data/specs/storyboard_formatter_spec.rb

@@ -1,7 +1,8 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'bacon'
-require 'ovaltine'
+require 'ovaltine/storyboard'
+require 'ovaltine/objc/storyboard_formatter'
 
 describe 'StoryboardFormatter' do
 

data/vendor/json_pure/COPYING

@@ -0,0 +1,57 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see GPL file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.