objc2swift_assistant 0.3.0

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in objc2swift_assistant.gemspec
+gemspec
+
+gem "json"
+gem "commander"
+gem "swift_generator"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Kornher
+
+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,83 @@
+# objc2swift_assistant
+
+This ruby gem is a command line tool to generate Swift files from Objective-C source files. The file structure of the original source is mirrored by the generated code by default.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'objc2swift_assistant'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install objc2swift_assistant
+
+## Usage
+
+```ruby
+obj2swift generate --source SOURCE_PATH --dest GENERATED_CODE_PATH --config CONFIG_FILE
+```
+
+### Config Files
+Config files can specify:
+* Directories to ignore
+* Source files to ignore
+* **Coming Soon**: Mappings from Objective-C types to Swift types
+
+An example configuration file:
+```json
+{
+  "company_name": "MyGreatCompany.com",
+  "ignore": [
+    "**/CoreData",
+    "**/Test",
+    "SourceToOmit.h",
+    "SourceToOmit.m"
+  ],
+  "subdirs": [
+    {
+      "path": "Customers/Customer1",
+      "company_name": "Customer1 Inc."
+    }
+  ]
+}
+```
+#### Config File Structure
+
+
+
+##### Config File Keys
+The keys supported in config files at this time:
+* **"path"**	: 		The path of the current node, relative to the parent node. "**"
+wildcards allowed in leftmost position. Ignored in root node.
+* **"company_name"** :	The company name to insert into the copyright and company fields in file comment blocks.
+* **"subdirs"** :		The list of sub-nodes under a node. Each must have a "path" specified. Wildcards are supported.
+* **"ignore"** :		An array of source-file paths to ignore at this place in the directory structure. Note that only files with the specific extension will be ignored. Note in the example that both the ".h" and the ".m" files must be specified to prevent the generation of code for classes defined in those files. "**" wildcard patterns are allowed.
+* **"emit\_original\_code"** :      Include original Objective-C method bodies and class variable declarations in the generated file as commented out bodies of the swift entities. Default: true.
+* **"emit\_original\_signatures"** :  Include original Objective-C method signatures (commented out) in the generated file. Ignored if emit\_converted\_code is false. Default: true.
+
+Note that other options (including JSON serialization, generation of unit tests) are available through the Ruby API, but are not supported or documented at this time.
+
+##### Wildcard Support
+Only the **\*\*/...** wildcard pattern is currently supported. Full "file globbing" may be supported in the future.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/objc2swift_assistant/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "assistant"
+
+# 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/objc2swift_assistant

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require 'assistant'
+require 'objc2swift_assistant/logging'
+
+# assistant = Objc2swiftAssistant::Assistant.new
+# assistant.runFromCommandLine
+
+program :name, 'obj2swift'
+program :version, '1.0.0'
+program :description, 'Generates Swift class Skeletons from Objective-C files.'
+
+# command :update do |c|
+#   c.syntax = 'obj2swift update [classnames]'
+#   c.description = 'Update Swift class skeletons from Objective-C'
+#   c.option '--source STRING', String, 'The root of the existing Objective-C source'
+#   c.option '--dest STRING', String, 'The root of the existing generated Swift source'
+#   c.action do |args, options|
+#     options.default :source => nil, :dest => nil
+#     # say "#{options.source}bar#{options.dest}"
+#     a = Objc2swiftAssistant::Assistant.new( options.source, options.dest ? options.dest : "" )
+#     a.update()
+#   end
+# end
+
+command :generate do |c|
+  c.syntax = 'obj2swift generate --source SOURCE_PATH --dest GENERATED_CODE_PATH --config CONFIG_FILE'
+  c.description = 'Generate Swift files and skeletons from Objective-C'
+  c.option '--source STRING', String, 'The root of the existing Objective-C source'
+  c.option '--dest STRING', String, 'The root of the generated Swift source'
+  c.option '--config STRING', String, 'Optional configuration file'
+  # c.option '--nocode STRING', String, 'Just concatenate the .h and .m commented source into one .sw file.'
+  c.option '--structure STRING', String, 'Dump the source file structure w/output location and errors encountered [all, errors, none]'
+  c.option '--log STRING', String, 'Log level: [error, warning, verbose, debug, none].'
+  c.action do |args, options|
+    # options.default :source => nil, :dest => nil, :nocode => false, :config => nil, :log => "warning", :structure => "errors"
+    options.default :source => nil, :dest => nil, :config => nil, :log => "warning", :structure => "all"
+
+    a = Objc2swiftAssistant::Assistant.new( options.source, options.dest, options.config, options.log, options.structure )
+    a.read_config_file
+    if a.configuration.log_level.nil?
+      puts( "#{options.log} is no a valid log level. The options are: error, warning, verbose, debug, none")
+    else
+      a.generate( false )   # TODO: nocde or remove the option
+    end
+  end
+end
+
+

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/lib/assistant.rb

@@ -0,0 +1,110 @@
+require "objc2swift_assistant/version"
+
+require 'commander'
+require_relative 'objc2swift_assistant/file_sets'
+require 'objc2swift_assistant/recognizers/implementation_recognizer'
+require 'objc2swift_assistant/recognizers/property_declaration_recognizer'
+require 'objc2swift_assistant/recognizers/interface_recognizer'
+require 'objc2swift_assistant/recognizers/category_recognizer'
+require 'objc2swift_assistant/recognizers/method_recognizer'
+require 'objc2swift_assistant/recognizers/enum_recognizer'
+require 'objc2swift_assistant/recognizers/protocol_recognizer'
+require 'objc2swift_assistant/recognizers/pragma_mark_recognizer'
+require 'objc2swift_assistant/recognizers/at_sign_directives_recognizer'
+require 'objc2swift_assistant/objc_2_swift_configuration'
+require 'objc2swift_assistant/logging'
+
+module Objc2swiftAssistant
+
+  class Assistant
+    attr_accessor :source_root
+    attr_accessor :dest_root
+    attr_accessor :recognizers
+    attr_accessor :config_file_path
+    attr_accessor :config
+    attr_accessor :log_level_name
+    attr_accessor :configuration
+    attr_accessor :structure_option
+
+    def initialize( source, dest, config_file, log_level_name, structure_option)
+      @source_root = source
+      @dest_root = dest
+      @config_file_path = config_file.nil? ? nil : Pathname.new( config_file )
+      @log_level_name = log_level_name
+      @structure_option = structure_option
+      @recognizers = [
+          CategoryDeclarationRecognizer.new(),
+          CategoryImplRecognizer.new(),
+          ProtocolRecognizer.new(),
+          #EnumRecognizer.new(),
+          ImplementationRecognizer.new(),
+          InterfaceRecognizer.new(),
+          MethodRecognizer.new(),
+          PropertyDeclarationRecognizer.new(),
+          AtDirectiveRecognizer.new()
+          #PragmaMarkRecognizer.new()
+      ]
+    end
+
+    def update
+      source_file_set = ObjCFileSet.new( @source_root, @config_hash )
+      source_file_set.scan
+
+    end
+
+    def generate( dry_run )
+      unless @config_file_path.nil?
+        log_stage_start( 'Reading Configuration File' )
+      end
+
+      @recognizers.each do | recognizer |
+        recognizer.configuration = @configuration
+      end
+
+      source_file_set = ObjCFileSet.new( @source_root, @recognizers, configuration:@configuration)
+
+      log_stage_start( 'Scanning Objective-C Source Files' )
+      source_file_set.scan
+
+      log_stage_start( 'Recognizing code fragmants' )
+      source_file_set.recognize_code_fragments
+
+      log_stage_start( 'Converting to Swift' )
+      source_file_set.prepare_conversion
+
+      source_file_set.generate_swift_file_set( @dest_root, dry_run )
+
+      source_file_set.dump( '', '   ', @configuration.dump_only_errors ) if @configuration.dump_source
+
+      # TODO
+      # source_file_set.generate_swift_files(dry_run)
+      #
+      # generator = SwiftFileGenerator( @dest_root, source_file_set )
+      # generator.map_sources_to_destinations
+
+      # if writeCode
+      #
+      # else
+
+      # generator.concat_source_files()
+    end
+
+    def read_config_file
+      if @config_file_path.nil?
+        @configuration = ObjC2SwiftConfiguration.new( {}, @log_level_name, @structure_option )
+      else
+        file_data = @config_file_path.read
+        config_hash = JSON.parse(file_data)
+        @configuration = ObjC2SwiftConfiguration.new( config_hash, @log_level_name, @structure_option )
+      end
+
+      @configuration.load_configuration
+    end
+
+    def log_stage_start( text )
+      return unless @verbose
+      @configuration.log_verbose( "\n---------------------------------------- #{text} ----------------------------------------\n\n" )
+    end
+
+  end # class
+end # module

data/lib/objc2swift_assistant/code_recognizer.rb

@@ -0,0 +1,220 @@
+require "objc2swift_assistant/version"
+
+require "objc2swift_assistant/objc_2_swift"
+
+module Objc2swiftAssistant
+  def de_comment_line( line )
+    new_line = line
+    m = line.match( /^(?<uncommented>.*)\/\/(?<comment>.*)/ )
+    unless m.nil?
+      new_line = m[ 'uncommented' ].strip
+    end
+
+    return new_line
+  end
+  module_function :de_comment_line
+
+  def de_comment_lines( lines )
+    # Line Comments
+    return lines.map do |line|
+      Objc2swiftAssistant::de_comment_line( line )
+    end
+  end
+  module_function :de_comment_lines
+
+  def is_getter_method_name( property_name, method_name )
+    #TODO: add boolean rules
+    return property_name == method_name
+  end
+  module_function :is_getter_method_name
+
+
+  def is_setter_method_name( property_name, method_name )
+    setter_name = "set" + property_name[0, 1].upcase + property_name[1..-1]
+    return method_name == setter_name
+  end
+  module_function :is_setter_method_name
+
+  class CodeRecognizer
+    attr_accessor :for_root_entities
+    attr_accessor :start_match_regex
+    attr_accessor :match_region_class
+    attr_accessor :source_file_type
+    attr_accessor :match_region_class
+    attr_accessor :voiding_match
+    attr_accessor :configuration      # set after initialization
+
+    def initialize( start_test_regex, match_region_class, source_file_type, for_root_entities, include_preceeding_comment=for_root_entities, voiding_regex: nil)
+      @start_line_match_regex = start_test_regex
+      @match_region_class = match_region_class
+      @source_file_type = source_file_type
+      @for_root_entities = for_root_entities
+      @voiding_regex = voiding_regex
+    end
+
+    def matches( raw_file_lines )
+
+      file_lines = Objc2swiftAssistant::de_comment_lines( raw_file_lines )
+
+      matched_regions = []
+      file_lines.each_with_index do |line, index|
+        if @start_line_match_regex =~ line
+          unless @voiding_regex.nil?
+            if @voiding_regex =~ line
+              break
+            end
+          end
+          #print( line )
+          matched_region = @match_region_class.new( index, @for_root_entities )
+          matched_region.detection_line = line
+          matched_region.configuration = @configuration
+          matched_regions << matched_region
+        end
+
+      end
+
+      @configuration.log_verbose( "" ) if matched_regions.length > 0
+      matched_regions.each do |region|
+        # if region.region_type == 'at_directive'
+        @configuration.log_verbose( "#{region.region_type} #{region.detection_line}" )
+        # end
+      end
+
+      return matched_regions
+    end
+
+    def should_scan_file( file_type  )
+      return true
+      # if @source_file_type == :all_source_files
+      #   return [:header_file, :implementation_file].include?( file_type )
+      # else
+      #   file_type == @source_file_type
+      # end
+    end
+
+  end
+
+
+  class MigrationRegion < FailableProcessingElement
+
+    attr_accessor :is_root_entity
+    attr_accessor :allowed_parent_region_types
+    attr_accessor :region_type
+    attr_accessor :can_occur_in_class_decl
+
+    attr_accessor :detection_line               # For diagnostics
+
+    attr_accessor :region_identifier
+
+    attr_accessor :is_single_line
+    attr_accessor :starting_line_number         # actually a zero-based index
+    attr_accessor :ending_line_number           # actually a zero-based index
+    attr_accessor :ending_of_root_header        # i.e. (ideally) The end of the class ivar declaration
+    attr_accessor :root_header                  # The content of the ivar declaration
+    # attr_accessor :consumed_line_count
+    attr_accessor :sub_regions
+    attr_accessor :parent_region
+    attr_accessor :configuration
+
+    def initialize( starting_line_number, is_root_entity, region_type, can_occur_in_class_decl:false )
+      @starting_line_number = starting_line_number
+      @is_root_entity = is_root_entity
+      @region_type = region_type
+      @detection_line = detection_line
+      @can_occur_in_class_decl = can_occur_in_class_decl
+      @sub_regions = []
+      @error_messages = []
+      @is_single_line = false
+    end
+
+    def contains_line( line_number )
+      line_number >= @starting_line_number && line_number <= @ending_line_number
+    end
+
+    def add_sub_region( sub_region )
+      @sub_regions << sub_region
+      sub_region.parent_region = self
+    end
+
+    def complete( file_lines )
+      # Delimit sub-regions
+      previous_sub_region = nil
+      @sub_regions.each do |sub_region|
+        resolve_ending_line_number( previous_sub_region, sub_region.starting_line_number - 1) unless previous_sub_region.nil?
+        previous_sub_region = sub_region
+      end
+      resolve_ending_line_number( previous_sub_region, self.ending_line_number ) unless previous_sub_region.nil?
+
+      self.extract_information( file_lines[ @starting_line_number..@ending_line_number] )
+      @sub_regions.each do |sub_region|
+        sub_region.complete( file_lines )
+      end
+
+      #Find the limits of the unrecognized code in the root migration region
+      @ending_of_root_header = nil
+      @sub_regions.each.with_index(0) do |sub_region, i|
+        if ! sub_region.can_occur_in_class_decl
+          @ending_of_root_header = sub_region.starting_line_number - 1
+          break
+        end
+      end
+
+      @ending_of_root_header = @ending_line_number if @ending_of_root_header.nil?
+      @root_header = file_lines[ @starting_line_number..@ending_of_root_header ]
+
+      # can_occur_in_class_decl
+    end
+
+    def resolve_ending_line_number( region, suggested_line_number )
+      if region.is_single_line
+        region.ending_line_number = region.starting_line_number
+      else
+        region.ending_line_number = suggested_line_number
+      end
+    end
+
+    def extract_information( file_lines )
+      # Do nothing by default
+    end
+
+    def generic_description( detail )
+      return detail
+    end
+
+    def brief_description()
+      return ""
+    end
+
+    def has_failed
+      ! @error_messages.length > 0
+    end
+
+    # Output
+    def dump( indent, tab, errors_only )
+      dump_region_info( indent, tab, errors_only )
+      @sub_regions.each do |sub_region|
+        sub_region.dump( indent+tab, tab, errors_only )
+      end
+    end
+
+    def dump_region_info( indent, tab, errors_only )
+      # puts( indent + "#{@region_type} [lines: #{@starting_line_number || '?'}-#{@ending_line_number || '?'}]")
+      printf( "%s%-25s [lines: %3d-%-3d] %s %s\n", indent, @region_type, @starting_line_number+1|| -1, @ending_line_number+1 || -1,
+              brief_description(), @error_message.nil? ? '' : 'ERROR: ' + @error_message )
+    end
+
+  end
+
+  class ClassRootRegion < MigrationRegion
+    attr_accessor :class_name
+
+    def initialize( starting_line_number, is_root_entity, region_type_name )
+      super( starting_line_number, is_root_entity, region_type_name )
+    end
+
+    def description()
+      generic_description( "Class: #{@class_name}" )
+    end
+  end
+
+end