sbconstants 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11f60a7cc73a7fd632d10cae568b307ef2c313a5
-  data.tar.gz: 555e5f8778c56c11a08673fc58be52e7286c6061
+  metadata.gz: 5f4d5cd1526a1e1c0e4a95aebfe1775614adb585
+  data.tar.gz: 3e769892b40a72ca3e5f2818f904cc97346bffbb
 SHA512:
-  metadata.gz: e872b75a0d28fca183a4adf3fea257120e79204bbd4e0cbb88768a99cc13a71ac4b4a11fdb4cf619b52fd4175f879499a8852afb182538bb68a96e1d6b9fadb1
-  data.tar.gz: 109e3329c802dc0f93d1a6b2431be3635cda6b47fddce3fd559d790a39cd3cbb20e03cb43b4ed87289960b3f83ba8e50a5258cb9a1ee2915940eaf95737eb652
+  metadata.gz: f5e2179155417c7fdcb0d77d4aa6c4f6a0ce92362a4e1fcf2c8d210d628d8afb66e7687953570805c9d3831cffcabd6d997ed036829aec983c631c16cae9bf0e
+  data.tar.gz: 15b565db1bfc24f19eee9bd13140f9bf35a347911c501a2b063fd1cce22ac56a2f9e8daf1da934bd4d6259344d216f9e32cb0646cabee2ae5071e5ef59bf0326

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sbconstants.gemspec
 gemspec
+gem 'rake'

data/README.md

@@ -25,13 +25,27 @@ For manual use (using swift):
 ```sh
 $ sbconstants -h
 Usage: DESTINATION_FILE [options]
+    -d, --dry-run                    Output to STDOUT
     -p, --prefix=<prefix>            Only match identifiers with <prefix>
     -s, --source-dir=<source>        Directory containing storyboards
-   -sw, --swift                      Use the swift language
+    -t, --templates-dir=<templates>  Directory containing the templates to use for code formatting
     -q, --queries=<queries>          YAML file containing queries
-    -d, --dry-run                    Output to STDOUT
     -v, --verbose                    Verbose output
+    -w, --swift                      Output to a Swift File
+```
+
+## Custom formatting
+
+If you are running tools that verify your team is sticking to coding conventions you might find that the default output might not fit your requirements. Not to fear you can provide your own templates to decide the formatting you require by passing the `--templates-dir` option with the path to the directory containing the templates to use.
+
+Inside your custom templates you can interpolate the `constant_name` and `constant_value` like this
+
 ```
+NSString * const <%= constant_name %> = @"<%= constant_value %>";
+
+```
+
+You can override how the Objective-C constants are formatted by creating `objc_header.erb` and `objc_implementation.erb` files and adding the `--templates-dir` flag pointing to their containing directory.
 
 ## Contributing
 

data/lib/sbconstants/cli.rb

@@ -15,25 +15,55 @@ module SBConstants
 
     def run
       parse_storyboards
+      refute_key_collisions
       write
     end
-
+    
     def sections
       @sections ||= begin
-        sections_map = Hash.new { |h,k| h[k] = Set.new }
+        [].tap { |sections|
+          sections_grouped_by_keypath.each do |locations, constants|
+            sections << Section.new(locations.to_a, constants.to_a.sort)
+          end
+        }.sort_by { |section| section.locations.map(&:key_path).join(',') } 
+      end
+    end
+    
+    def sections_grouped_by_keypath
+      Hash.new { |h,k| h[k] = Set.new }.tap { |sections_grouped_by_keypath|
         constants.each do |constant, locations|
-          sections_map[locations] << constant
-        end
-        @sections = []
-        sections_map.each do |k,v|
-          @sections << Section.new(k.to_a, v.to_a.sort)
+          sections_grouped_by_keypath[locations] << constant
         end
-        @sections = @sections.sort_by { |section| section.locations.map(&:key_path).join(',') }
-      end
+      }
+    end
+    
+    def sanitise_key key
+      key.gsub(" ", "").gsub("-", "")
     end
 
     private
+    
+    def refute_key_collisions
+      keys_requiring_sanitisation, keys = constants.keys.partition { |constant| constant.include?(' ') }
+      
+      keys_requiring_sanitisation.each do |key|
+        next unless keys.include?(sanitise_key(key))
+        
+        $stderr.puts <<-EOD
+Error: Key collision
+
+The constant "#{key}" will have whitespace and hyphens stripped resulting in a constant named "#{sanitise_key(key)}". 
+This creates a problem as the constant "#{sanitise_key(key)}" will want to map to the storyboard constants "#{key}" and "#{sanitise_key(key)}".
 
+To resolve the issue remove the ambiguity in naming - search your storyboards for the key "#{key}"
+        EOD
+        exit 1 
+      end
+    end
+    
+    # Parse all found storyboards and build a dictionary of constant => locations
+    #
+    # A constant key can potentially exist in many files so locations is a collection
     def parse_storyboards
       Dir["#{options.source_dir}/**/*.storyboard"].each do |storyboard|
         File.readlines(storyboard).each_with_index do |line, index|
@@ -61,7 +91,7 @@ module SBConstants
         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
+        ObjcConstantWriter.new(self, int_out, imp_out, options.templates_dir).write
 
         int_out.close unless dry_run
         imp_out.close unless dry_run

data/lib/sbconstants/objc_constant_writer.rb

@@ -3,10 +3,13 @@ require 'erb'
 
 module SBConstants
   class ObjcConstantWriter < SimpleDelegator
-    def initialize data_source, int_out, imp_out
-      super data_source
-      @int_out = int_out
-      @imp_out = imp_out
+    attr_reader :templates_dir
+    
+    def initialize data_source, int_out, imp_out, templates_dir
+      super(data_source)
+      @int_out       = int_out
+      @imp_out       = imp_out
+      @templates_dir = templates_dir
     end
 
     def write
@@ -14,25 +17,36 @@ module SBConstants
       @imp_out.puts implementation
     end
 
-    def templates_dir
-      @templates_dir ||= File.dirname(__FILE__) + '/templates/'
+    def default_templates_dir
+      @default_templates_dir ||= File.dirname(__FILE__) + '/templates'
     end
 
     def header
-      template_with_file "\n", %Q{extern NSString * const <%= constant %>;\n}
+      template_with_file "\n", File.open(template_file_path("objc_header.erb")).read
     end
 
     def implementation
       head = %Q{#import "<%= File.basename(options.output_path) %>.h"\n\n}
-      body = %Q{NSString * const <%= constant %> = @"<%= constant %>";\n}
-      template_with_file head, body
+      template_with_file head, File.open(template_file_path("objc_implementation.erb")).read
     end
 
     def template_with_file head, body
       @head = head
       @body = body
-      pre_processed_template = ERB.new(File.open("#{templates_dir}objc_body.erb").read, nil, '<>').result(binding)
+      pre_processed_template = ERB.new(File.open("#{default_templates_dir}/objc_body.erb").read, nil, '<>').result(binding)
       ERB.new(pre_processed_template, nil, '<>').result(binding)
     end
+    
+    def present_constants(section)
+      section.constants.map { |constant| [ sanitise_key(constant), constant ] }
+    end
+    
+    def template_file_path basename
+      if templates_dir && File.exist?("#{templates_dir}/#{basename}")
+        "#{templates_dir}/#{basename}"
+      else
+        "#{default_templates_dir}/#{basename}"
+      end
+    end
   end
 end

data/lib/sbconstants/options.rb

@@ -3,13 +3,28 @@ require 'yaml'
 
 module SBConstants
   class Options
-    attr_accessor :dry_run, :prefix, :destination, :query_config, :output_path, :source_dir, :verbose, :query_file, :use_swift
+    attr_accessor(
+      :destination,
+      :dry_run, 
+      :output_path,
+      :prefix,
+      :query_config,
+      :query_file,
+      :source_dir,
+      :templates_dir,
+      :use_swift,
+      :verbose,
+    )
 
     def self.parse argv
       options = self.new
       OptionParser.new do |opts|
         opts.banner = "Usage: DESTINATION_FILE [options]"
 
+        opts.on('-d', '--dry-run', 'Output to STDOUT') do |dry_run|
+          options.dry_run = dry_run
+        end
+        
         opts.on('-p', '--prefix=<prefix>', 'Only match identifiers with <prefix>') do |prefix|
           options.prefix = prefix
         end
@@ -17,22 +32,22 @@ module SBConstants
         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
+        
+        opts.on('-t', '--templates-dir=<templates>', 'Directory containing the templates to use for code formatting') do |templates_dir|
+          options.templates_dir = templates_dir
         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
+        
+        opts.on('-w', '--swift', 'Output to a Swift File') do |use_swift|
+          options.use_swift = use_swift
+        end
       end.parse!(argv)
 
       if argv.first.nil?

data/lib/sbconstants/swift_constant_writer.rb

@@ -10,7 +10,7 @@ module SBConstants
 
     def write
       head = %Q{\nimport Foundation"\n}
-      body = %Q{    case <%= constant.gsub(" ", "").gsub("-", "") %> = "<%= constant %>"\n}
+      body = %Q{    case <%= sanitise_key(constant) %> = "<%= constant %>"\n}
       @swift_out.puts template_with_file head, body
     end
 

data/lib/sbconstants/templates/objc_body.erb

@@ -3,7 +3,7 @@
 <%= @head %>
 <%% sections.each do |section| %>
 #pragma mark - <%%= section.locations.map(&:key_path).join(', ') %>
-<%% section.constants.each do |constant| %>
+<%% present_constants(section).each do |constant_name, constant_value| %>
 <%% if options.verbose %>
 //
 <%% constants[constant].each do |location| %>

data/lib/sbconstants/templates/objc_header.erb

@@ -0,0 +1 @@
+extern NSString * const <%= constant_name %>;

data/lib/sbconstants/templates/objc_implementation.erb

@@ -0,0 +1 @@
+NSString * const <%= constant_name %> = @"<%= constant_value %>";

data/lib/sbconstants/version.rb

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

data/sbconstants.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = SBConstants::VERSION
   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.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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sbconstants
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Samuels
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies: []
-description: Generate constants from storyboards in objc and swift.
+description: Generate constants from storyboards in ObjC and Swift.
 email:
 - paulio1987@gmail.com
 - orta.therox@gmail.com
@@ -20,7 +20,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -36,6 +36,8 @@ files:
 - lib/sbconstants/section.rb
 - lib/sbconstants/swift_constant_writer.rb
 - lib/sbconstants/templates/objc_body.erb
+- lib/sbconstants/templates/objc_header.erb
+- lib/sbconstants/templates/objc_implementation.erb
 - lib/sbconstants/templates/swift_body.erb
 - lib/sbconstants/version.rb
 - sbconstants.gemspec
@@ -49,19 +51,18 @@ 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.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Generate constants from storyboards in Objective-C and Swift.
 test_files: []
-has_rdoc: