sbconstants 0.0.4 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11f60a7cc73a7fd632d10cae568b307ef2c313a5
+  data.tar.gz: 555e5f8778c56c11a08673fc58be52e7286c6061
+SHA512:
+  metadata.gz: e872b75a0d28fca183a4adf3fea257120e79204bbd4e0cbb88768a99cc13a71ac4b4a11fdb4cf619b52fd4175f879499a8852afb182538bb68a96e1d6b9fadb1
+  data.tar.gz: 109e3329c802dc0f93d1a6b2431be3635cda6b47fddce3fd559d790a39cd3cbb20e03cb43b4ed87289960b3f83ba8e50a5258cb9a1ee2915940eaf95737eb652

data/README.md

@@ -1,6 +1,6 @@
-# Sbconstants
+# sbconstants
 
-Generate a constants file by grabbing identifiers from storybaords in a project
+Generate a constants file by grabbing identifiers from storyboards in a project. See [my blog post](http://paul-samuels.com/blog/2013/01/31/storyboard-constants/) for more use cases.
 
 ## Installation
 
@@ -10,11 +10,29 @@ Generate a constants file by grabbing identifiers from storybaords in a project
 
 For automated use:
 
-1. Add a file to hold your constants e.g. `PASStoryboardConstants.(h|m)`
+1. Add a file in Xcode to hold your constants e.g. `PASStoryboardConstants.(h|m)`
 2. Add a build script to build phases  
         sbconstants path_to_constant_file
 3. Enjoy your identifiers being added as constants to your constants file
 
+For manual use (using swift):
+
+1. Add a file in Xcode to hold your constants e.g. `StoryboardIdentifiers.swift`
+2. Add a command to your [Makefile](https://github.com/artsy/eidolon/blob/15da1330a04615b3553779742f166b707c6ef65f/Makefile#L54) to run something similar to `sbconstants path/to/StoryboardIdentifiers.swift --source-dir path/to/Storyboards --swift`
+
+## Command line API
+
+```sh
+$ sbconstants -h
+Usage: DESTINATION_FILE [options]
+    -p, --prefix=<prefix>            Only match identifiers with <prefix>
+    -s, --source-dir=<source>        Directory containing storyboards
+   -sw, --swift                      Use the swift language
+    -q, --queries=<queries>          YAML file containing queries
+    -d, --dry-run                    Output to STDOUT
+    -v, --verbose                    Verbose output
+```
+
 ## Contributing
 
 1. Fork it

data/lib/sbconstants.rb

@@ -2,7 +2,8 @@ module SBConstants
 end
 
 require 'sbconstants/cli'
-require 'sbconstants/constant_writer'
+require 'sbconstants/objc_constant_writer'
+require 'sbconstants/swift_constant_writer'
 require 'sbconstants/location'
 require 'sbconstants/query'
 require 'sbconstants/options'

data/lib/sbconstants/cli.rb

@@ -3,21 +3,21 @@ require 'set'
 module SBConstants
   class CLI
     attr_accessor :options, :constants, :sections
-    
+
     def self.run argv
       new(Options.parse(argv)).run
     end
-      
+
     def initialize options
       self.options   = options
       self.constants = Hash.new { |h,k| h[k] = Set.new }
     end
-    
+
     def run
       parse_storyboards
       write
     end
-    
+
     def sections
       @sections ||= begin
         sections_map = Hash.new { |h,k| h[k] = Set.new }
@@ -31,9 +31,9 @@ module SBConstants
         @sections = @sections.sort_by { |section| section.locations.map(&:key_path).join(',') }
       end
     end
-    
+
     private
-    
+
     def parse_storyboards
       Dir["#{options.source_dir}/**/*.storyboard"].each do |storyboard|
         File.readlines(storyboard).each_with_index do |line, index|
@@ -41,27 +41,31 @@ module SBConstants
             next unless value = line[query.regex, 1]
             next if value.strip.empty?
             next unless value.start_with?(options.prefix) if options.prefix
-                        
+
             constants[value] << Location.new(query.node, query.attribute, line.strip, File.basename(storyboard, '.storyboard'), index + 1)
           end
         end
       end
-    end  
-    
+    end
+
     def write
-      int_out, imp_out = $stdout, $stdout
-                      
-      if !options.dry_run
-        int_out = File.open("#{options.output_path}.h", 'w')
-        imp_out = File.open("#{options.output_path}.m", 'w')
-      end
-      
-      ConstantWriter.new(self, int_out, imp_out).write
-      
-      if !options.dry_run
-        int_out.close
-        imp_out.close
+      int_out, imp_out, swift_out = $stdout, $stdout, $stdout
+      dry_run = options.dry_run
+
+      if options.use_swift
+          swift_out = File.open("#{options.output_path}.swift", 'w') unless dry_run
+          SwiftConstantWriter.new(self, swift_out).write
+          swift_out.close
+      else
+
+        int_out = File.open("#{options.output_path}.h", 'w') unless dry_run
+        imp_out = File.open("#{options.output_path}.m", 'w') unless dry_run
+
+        ObjcConstantWriter.new(self, int_out, imp_out).write
+
+        int_out.close unless dry_run
+        imp_out.close unless dry_run
       end
     end
   end
-end
+end

data/lib/sbconstants/identifiers.yml

@@ -1,10 +1,12 @@
 ---
 segue: identifier
 tableViewCell: reuseIdentifier
+collectionViewCell: reuseIdentifier
 view: restorationIdentifier
 ? - navigationController
   - viewController
   - tableViewController
   - collectionViewController
 : - storyboardIdentifier
-  - restorationIdentifier
+  - restorationIdentifier
+  

data/lib/sbconstants/location.rb

@@ -3,17 +3,17 @@ module SBConstants
     def key_path
       @key_path ||= "#{node}.#{attribute}"
     end
-    
+
     def debug
       @debug ||= "#{file}[line:#{line}](#{key_path})"
     end
-    
+
     def eql? other
       self.class == other.class && key_path == other.key_path
     end
-    
+
     def hash
       key_path.hash
     end
   end
-end
+end

data/lib/sbconstants/{constant_writer.rb → objc_constant_writer.rb}

@@ -2,35 +2,37 @@ require 'delegate'
 require 'erb'
 
 module SBConstants
-  class ConstantWriter < SimpleDelegator
+  class ObjcConstantWriter < SimpleDelegator
     def initialize data_source, int_out, imp_out
       super data_source
       @int_out = int_out
       @imp_out = imp_out
     end
-    
+
     def write
       @int_out.puts header
       @imp_out.puts implementation
     end
-    
+
     def templates_dir
       @templates_dir ||= File.dirname(__FILE__) + '/templates/'
     end
-    
+
     def header
       template_with_file "\n", %Q{extern NSString * const <%= constant %>;\n}
     end
-    
+
     def implementation
-      head = %Q{\n#import "<%= File.basename(options.output_path) %>.h"\n\n}
+      head = %Q{#import "<%= File.basename(options.output_path) %>.h"\n\n}
       body = %Q{NSString * const <%= constant %> = @"<%= constant %>";\n}
       template_with_file head, body
     end
-    
+
     def template_with_file head, body
-      pre_processed_template = ERB.new(File.open("#{templates_dir}body.erb").read, nil, '<>').result(binding)
+      @head = head
+      @body = body
+      pre_processed_template = ERB.new(File.open("#{templates_dir}objc_body.erb").read, nil, '<>').result(binding)
       ERB.new(pre_processed_template, nil, '<>').result(binding)
     end
   end
-end
+end

data/lib/sbconstants/options.rb

@@ -3,55 +3,59 @@ require 'yaml'
 
 module SBConstants
   class Options
-    attr_accessor :dry_run, :prefix, :destination, :query_config, :output_path, :source_dir, :verbose, :query_file
-    
+    attr_accessor :dry_run, :prefix, :destination, :query_config, :output_path, :source_dir, :verbose, :query_file, :use_swift
+
     def self.parse argv
       options = self.new
       OptionParser.new do |opts|
         opts.banner = "Usage: DESTINATION_FILE [options]"
-    
+
         opts.on('-p', '--prefix=<prefix>', 'Only match identifiers with <prefix>') do |prefix|
           options.prefix = prefix
         end
-        
+
         opts.on('-s', '--source-dir=<source>', 'Directory containing storyboards') do |source_dir|
           options.source_dir = source_dir
         end
-        
+
+        opts.on('-w', '--swift', 'Output to a Swift File') do |use_swift|
+          options.use_swift = use_swift
+        end
+
         opts.on('-q', '--queries=<queries>', 'YAML file containing queries') do |queries|
           options.query_file = queries
         end
-        
+
         opts.on('-d', '--dry-run', 'Output to STDOUT') do |dry_run|
           options.dry_run = dry_run
         end
-        
+
         opts.on('-v', '--verbose', 'Verbose output') do |verbose|
           options.verbose = verbose
         end
       end.parse!(argv)
-      
+
       if argv.first.nil?
         options.dry_run = true
         options.output_path = 'no file given'
       else
-        options.output_path = argv.first.chomp(File.extname(ARGV.first)) 
+        options.output_path = argv.first.chomp(File.extname(ARGV.first))
       end
       options
     end
-    
+
     def initialize
       self.query_file = File.expand_path('../../sbconstants/identifiers.yml', __FILE__)
       self.source_dir = Dir.pwd
     end
-    
+
     def queries
       load_queries if @queries.nil?
       @queries
     end
-    
+
     private
-    
+
     def load_queries
       @queries = []
       config = YAML.load(File.open(query_file).read)
@@ -64,4 +68,4 @@ module SBConstants
       end
     end
   end
-end
+end

data/lib/sbconstants/section.rb

@@ -1,3 +1,16 @@
 module SBConstants
-  Section = Struct.new(:locations, :constants)
-end
+  Section = Struct.new(:locations, :constants) do
+
+    def pretty_title
+      title = locations.map(&:key_path).join('')
+                               .gsub(".", "")
+                               .gsub(" ", "")
+                               .gsub("identifier", "Identifier")
+                               .gsub("viewcontroller", "ViewController")
+                               .gsub("storyboard", "Storyboard")
+
+      title.slice(0,1).capitalize + title.slice(1..-1)
+    end
+
+  end
+end

data/lib/sbconstants/swift_constant_writer.rb

@@ -0,0 +1,28 @@
+require 'delegate'
+require 'erb'
+
+module SBConstants
+  class SwiftConstantWriter < SimpleDelegator
+    def initialize data_source, swift_out
+      super data_source
+      @swift_out = swift_out
+    end
+
+    def write
+      head = %Q{\nimport Foundation"\n}
+      body = %Q{    case <%= constant.gsub(" ", "").gsub("-", "") %> = "<%= constant %>"\n}
+      @swift_out.puts template_with_file head, body
+    end
+
+    def templates_dir
+      @templates_dir ||= File.dirname(__FILE__) + '/templates/'
+    end
+
+    def template_with_file head, body
+      @head = head
+      @body = body
+      pre_processed_template = ERB.new(File.open("#{templates_dir}swift_body.erb").read, nil, '<>').result(binding)
+      ERB.new(pre_processed_template, nil, '<>').result(binding)
+    end
+  end
+end

data/lib/sbconstants/templates/{body.erb → objc_body.erb}

@@ -1,5 +1,6 @@
 // Auto generated file - any changes will be lost
-<%= head %>
+
+<%= @head %>
 <%% sections.each do |section| %>
 #pragma mark - <%%= section.locations.map(&:key_path).join(', ') %>
 <%% section.constants.each do |constant| %>
@@ -11,7 +12,7 @@
 //
 <%% end %>
 <%% end %>
-<%= body %>
+<%= @body %>
 <%% end %>
 
-<%% end %>
+<%% end %>

data/lib/sbconstants/templates/swift_body.erb

@@ -0,0 +1,17 @@
+// Auto generated file from SBConstants - any changes may be lost
+<%% sections.each do |section| %>
+
+public enum <%%= section.pretty_title %> : String {
+<%% section.constants.each do |constant| %>
+<%% if options.verbose %>
+//
+<%% constants[constant].each do |location| %>
+//    info: <%%= location.debug %>
+// context: <%%= location.context %>
+//
+<%% end %>
+<%% end %>
+<%= @body %>
+<%% end %>
+}
+<%% end %>

data/lib/sbconstants/version.rb

@@ -1,3 +1,3 @@
 module SBConstants
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
 end

data/sbconstants.gemspec

@@ -6,11 +6,12 @@ require 'sbconstants/version'
 Gem::Specification.new do |gem|
   gem.name          = "sbconstants"
   gem.version       = SBConstants::VERSION
-  gem.authors       = ["Paul Samuels"]
-  gem.email         = ["paulio1987@gmail.com"]
-  gem.description   = %q{Generate constants from storyboards}
-  gem.summary       = %q{Generate constants from storyboards}
+  gem.authors       = ["Paul Samuels", "Orta Therox"]
+  gem.email         = ["paulio1987@gmail.com", "orta.therox@gmail.com"]
+  gem.description   = %q{Generate constants from storyboards in objc and swift.}
+  gem.summary       = %q{Generate constants from storyboards in Objective-C and Swift.}
   gem.homepage      = "https://github.com/paulsamuels/SBConstants"
+  gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: sbconstants
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Paul Samuels
+- Orta Therox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies: []
-description: Generate constants from storyboards
+description: Generate constants from storyboards in objc and swift.
 email:
 - paulio1987@gmail.com
+- orta.therox@gmail.com
 executables:
 - sbconstants
 extensions: []
@@ -27,38 +28,40 @@ files:
 - bin/sbconstants
 - lib/sbconstants.rb
 - lib/sbconstants/cli.rb
-- lib/sbconstants/constant_writer.rb
 - lib/sbconstants/identifiers.yml
 - lib/sbconstants/location.rb
+- lib/sbconstants/objc_constant_writer.rb
 - lib/sbconstants/options.rb
 - lib/sbconstants/query.rb
 - lib/sbconstants/section.rb
-- lib/sbconstants/templates/body.erb
+- lib/sbconstants/swift_constant_writer.rb
+- lib/sbconstants/templates/objc_body.erb
+- lib/sbconstants/templates/swift_body.erb
 - lib/sbconstants/version.rb
 - sbconstants.gemspec
 homepage: https://github.com/paulsamuels/SBConstants
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
-summary: Generate constants from storyboards
+specification_version: 4
+summary: Generate constants from storyboards in Objective-C and Swift.
 test_files: []
 has_rdoc: