check_super_calls 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '06812c03236fefd007e9b11769f71d3cb9610bbd'
+  data.tar.gz: 41204f9a1ab42f061050053ff0829de65c7ebe3c
+SHA512:
+  metadata.gz: 7f679d3aeac683b758cc7764117001057eb112f816105c575089a4cb623e0f4cb2a7586b7a4b27686dc3481fa1ae13e11514a4e2480c83022b5bc0079e06324a
+  data.tar.gz: e36d0fa75cb1c2e8add4485c95b8fd058e5e48f360f8e5fd167ef1589a96147540927332ce8f3fa7552652bfbe29891b0eb25de68b4e9025fd479c13368ce3ad

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,35 @@
+# CheckSuperCalls
+
+Script that checks if Swift and Objective C subclasses call specific superclass methods.
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/check_super_calls`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'check_super_calls'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install check_super_calls
+
+## Usage
+
+Run check-super-calls path/to/project/directory.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/check_super_calls.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Make tests output references'
+task :make_test_references do
+  require_relative 'test/make_test_references'
+  make_test_references
+  puts
+  puts 'Finished generating test references, inspect them for correctness.'
+  puts
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/check-super-calls

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'check_super_calls'
+
+::CheckSuperCalls.main(ARGV)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'check_super_calls'
+
+# 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(__FILE__)

data/bin/setup

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

data/check_super_calls.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'check_super_calls/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'check_super_calls'
+  spec.version       = CheckSuperCalls::VERSION
+  spec.authors       = ['Andrei Nagy']
+  spec.email         = ['nagy.andrei@gmail.com']
+
+  spec.summary       = 'Check calls to superclasses in iOS code.'
+  spec.description   = 'Script that checks if Swift and Objective C subclasses call specific superclass methods.'
+  spec.homepage      = 'https://github.com/andreinagy/check-super-calls'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    # spec.metadata['homepage_uri'] = spec.homepage
+    # spec.metadata["source_code_uri"] = "Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = 'check-super-calls'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/fixtures/ObjC/compliantFile.m

@@ -0,0 +1,44 @@
+
+- (void)viewDidLoad {
+    [super viewDidLoad];
+}
+
+- (void)viewWillAppear:(BOOL)animated {
+    [super viewWillAppear:animated];
+}
+
+- (void)viewWillDisappear:(BOOL)animated {
+    [super viewWillDisappear:animated];
+}
+
+- (void)viewDidAppear:(BOOL)animated {
+    [super viewDidAppear:animated];
+}
+
+- (void)viewDidDisappear:(BOOL)animated {
+    [super viewDidDisappear:animated];
+}
+
+- (void)viewWillLayoutSubviews {
+    [super viewWillLayoutSubviews];
+}
+
+- (void)viewDidLayoutSubviews {
+    [super viewDidLayoutSubviews];
+}
+
+- (instancetype)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
+    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
+    if (self) {
+        
+    }
+    return self;
+}
+
+- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
+    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
+    if (self) {
+        
+    }
+    return self;
+}

data/fixtures/ObjC/offendingFile.m

@@ -0,0 +1,28 @@
+
+- (void)viewDidLoad {
+}
+
+- (void)viewWillAppear:(BOOL)animated {
+}
+
+- (void)viewWillDisappear:(BOOL)animated {
+}
+
+- (void)viewDidAppear:(BOOL)animated {
+}
+
+- (void)viewDidDisappear:(BOOL)animated {
+}
+
+- (void)viewWillLayoutSubviews {
+}
+
+- (void)viewDidLayoutSubviews {
+}
+
+- (instancetype)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
+    if (self) {
+        
+    }
+    return self;
+}

data/fixtures/swift/compliantFile.swift

@@ -0,0 +1,32 @@
+
+override func viewDidLoad() {
+    super.viewDidLoad()
+}
+
+override func viewWillAppear(_ animated: Bool) {
+    super.viewWillAppear(animated)
+}
+
+override func viewWillDisappear(_ animated: Bool) {
+    super.viewWillDisappear(animated)
+}
+
+override func viewDidAppear(_ animated: Bool) {
+    super.viewDidAppear(animated)
+}
+
+override func viewDidDisappear(_ animated: Bool) {
+    super.viewDidDisappear(animated)
+}
+
+override func viewWillLayoutSubviews() {
+    super.viewWillLayoutSubviews()
+}
+
+override func viewDidLayoutSubviews() {
+    super.viewDidLayoutSubviews()
+}
+
+override init(nibName nibNameOrNil: String?, bundle nibBundleOrNil: Bundle?) {
+    super.init(nibName: nibNameOrNil, bundle: nibBundleOrNil)
+}

data/fixtures/swift/nestedDirectory/anotherFile.swift

@@ -0,0 +1,8 @@
+
+override
+func 
+viewDidLoad
+{
+    super.
+    viewDidLoad()
+}

data/fixtures/swift/offendingFile.swift

@@ -0,0 +1,23 @@
+override func viewDidLoad() {
+}
+
+override func viewWillAppear(_ animated: Bool) {
+}
+
+override func viewWillDisappear(_ animated: Bool) {
+}
+
+override func viewDidAppear(_ animated: Bool) {
+}
+
+override func viewDidDisappear(_ animated: Bool) {
+}
+
+override func viewWillLayoutSubviews() {
+}
+
+override func viewDidLayoutSubviews() {
+}
+
+override init(nibName nibNameOrNil: String?, bundle nibBundleOrNil: Bundle?) {
+}

data/lib/check_super_calls/arguments_parser.rb

@@ -0,0 +1,49 @@
+require 'optparse'
+
+# https://docs.ruby-lang.org/en/2.1.0/OptionParser.html
+Options = Struct.new(:input_directory)
+
+# Parses command line arguments
+class Parser
+  def self.default_options
+    result = Options.new
+    result.input_directory = '.'
+    result
+  end
+  private_class_method :default_options
+
+  def self.parse(argv)
+    # If no arguments supplied, print help
+    argv << '-h' if argv.empty?
+
+    result = default_options
+
+    options_parser = OptionParser.new do |o|
+      o.banner = 'Usage: check-super-calls.rb [input directory]'
+
+      o.on('-h',
+           '--help',
+           'Prints this help') do
+        puts options_parser
+        exit 0
+      end
+    end
+
+    begin
+      options_parser.parse!(argv)
+    rescue StandardError => exception
+      puts exception
+      puts options_parser
+      exit 1
+    end
+
+    result.input_directory = argv.pop
+    if result.input_directory.nil? || !Dir.exist?(result.input_directory)
+      puts 'Can\'t find directory ' + result.input_directory
+      Parser.parse %w[--help]
+      exit 0
+    end
+
+    result
+  end
+end

data/lib/check_super_calls/helpers.rb

@@ -0,0 +1,27 @@
+require 'find'
+
+# Convenience utilities.
+
+def find_files(ignore_list, base_path, extension)
+  file_paths = []
+  Find.find(base_path) do |path|
+    next if File.directory? path
+    next if path !~ extension
+
+    ignore_matches = (ignore_list || []).select do |item|
+      path.include? item
+    end
+    should_ignore = ignore_matches.any?
+
+    file_paths << path unless should_ignore
+  end
+  file_paths
+end
+
+def check_line_overrides(_string)
+  false
+end
+
+def check_line_calls_super(_string)
+  false
+end

data/lib/check_super_calls/languages/obj_c.rb

@@ -0,0 +1,89 @@
+require_relative 'pattern.rb'
+
+class ObjC
+  attr_accessor :file_regex, :patterns
+  def initialize
+    @file_regex = regex_ending_with('(h|m)')
+    @patterns = [
+      Pattern.new(
+        '[super viewDidLoad]',
+        regex_any_spaces_between(
+          ['-', '\(', 'void', '\)', 'viewDidLoad', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'viewDidLoad', '\]']
+        )
+      ),
+      Pattern.new(
+        '[super viewWillAppear:animated]',
+        regex_any_spaces_between(
+          ['-', '\(', 'void', '\)',
+           'viewWillAppear:', '\(', 'BOOL', '\)', 'animated', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'viewWillAppear:animated', '\]']
+        )
+      ),
+      Pattern.new(
+        '[super viewWillDisappear:animated]',
+        regex_any_spaces_between(
+          ['-', '\(', 'void', '\)',
+           'viewWillDisappear:', '\(', 'BOOL', '\)', 'animated', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'viewWillDisappear:animated', '\]']
+        )
+      ),
+      Pattern.new(
+        '[super viewDidAppear:animated]',
+        regex_any_spaces_between(
+          ['-', '\(', 'void', '\)',
+           'viewDidAppear:', '\(', 'BOOL', '\)', 'animated', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'viewDidAppear:animated', '\]']
+        )
+      ),
+      Pattern.new(
+        '[super viewDidDisappear:animated]',
+        regex_any_spaces_between(
+          ['-', '\(', 'void', '\)',
+           'viewDidDisappear:', '\(', 'BOOL', '\)', 'animated', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'viewDidDisappear:animated', '\]']
+        )
+      ),
+      Pattern.new(
+        '[super viewWillLayoutSubviews]',
+        regex_any_spaces_between(
+          ['-', '\(', 'void', '\)', 'viewWillLayoutSubviews', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'viewWillLayoutSubviews', '\]']
+        )
+      ),
+      Pattern.new(
+        '[super viewDidLayoutSubviews]',
+        regex_any_spaces_between(
+          ['-', '\(', 'void', '\)', 'viewDidLayoutSubviews', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'viewDidLayoutSubviews', '\]']
+        )
+      ),
+      Pattern.new(
+        '[super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];',
+        regex_any_spaces_between(
+          ['-', '\(', '(id|instancetype)', '\)',
+           'initWithNibName:', '\(', 'NSString', '\*', '\)', 'nibNameOrNil',
+           'bundle:', '\(', 'NSBundle', '\*', '\)', 'nibBundleOrNil', '\{']
+        ),
+        regex_any_spaces_between(
+          ['\[', 'super', 'initWithNibName:', 'nibNameOrNil',
+           'bundle:', 'nibBundleOrNil' '\]']
+        )
+      )
+    ]
+  end
+  end

data/lib/check_super_calls/languages/pattern.rb

@@ -0,0 +1,17 @@
+
+class Pattern
+  attr_accessor :name, :definition, :check
+  def initialize(name, definition, check)
+    @name = name
+    @definition = definition
+    @check = check
+  end
+  end
+
+def regex_ending_with(string)
+  Regexp.new('\\.' + string + '$')
+end
+
+def regex_any_spaces_between(array)
+  Regexp.new(array.join('\\s*'))
+end

data/lib/check_super_calls/languages/swift.rb

@@ -0,0 +1,94 @@
+require_relative 'pattern.rb'
+
+class Swift
+  attr_accessor :file_regex, :patterns
+  def initialize
+    @file_regex = regex_ending_with('swift')
+    @patterns = [
+      Pattern.new(
+        'super.viewDidLoad()',
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidLoad', '\(', '\)', '\{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidLoad', '\(', '\)',
+           '\{(.|s)*', 'super', '\.viewDidLoad', '\(', '\)']
+        )
+      ),
+      Pattern.new(
+        'super.viewWillAppear(animated)',
+        regex_any_spaces_between(
+          ['override', 'func', 'viewWillAppear\(_ animated: Bool\) \{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'func', 'viewWillAppear\(_ animated: Bool\) \{',
+           'super', '.viewWillAppear\(animated\)']
+        )
+      ),
+      Pattern.new(
+        'super.viewWillDisappear(animated)',
+        regex_any_spaces_between(
+          ['override', 'func', 'viewWillDisappear\(_ animated: Bool\) \{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'func', 'viewWillDisappear\(_ animated: Bool\) \{',
+           'super', '.viewWillDisappear\(animated\)']
+        )
+      ),
+      Pattern.new(
+        'super.viewDidAppear(animated)',
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidAppear\(_ animated: Bool\) \{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidAppear\(_ animated: Bool\) \{',
+           'super', '.viewDidAppear\(animated\)']
+        )
+      ),
+      Pattern.new(
+        'super.viewDidDisappear(animated)',
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidDisappear\(_ animated: Bool\) \{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidDisappear\(_ animated: Bool\) \{',
+           'super', '.viewDidDisappear\(animated\)']
+        )
+      ),
+
+      Pattern.new(
+        'super.viewWillLayoutSubviews()',
+        regex_any_spaces_between(
+          ['override', 'func', 'viewWillLayoutSubviews\(\) \{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'func', 'viewWillLayoutSubviews\(\) \{',
+           'super', '.viewWillLayoutSubviews\(\)']
+        )
+      ),
+      Pattern.new(
+        'super.viewDidLayoutSubviews()',
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidLayoutSubviews\(\) \{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'func', 'viewDidLayoutSubviews\(\) \{',
+           'super', '.viewDidLayoutSubviews\(\)']
+        )
+      ),
+
+      Pattern.new(
+        'super.init(nibName: nibNameOrNil, bundle: nibBundleOrNil)',
+        regex_any_spaces_between(
+          ['override', 'init\(nibName nibNameOrNil: String\?,' \
+            ' bundle nibBundleOrNil: Bundle\?\) \{']
+        ),
+        regex_any_spaces_between(
+          ['override', 'init', '\(nibName nibNameOrNil: String\?,' \
+            ' bundle nibBundleOrNil: Bundle\?\) \{',
+           'super', '.init(nibName: nibNameOrNil, bundle: nibBundleOrNil)']
+        )
+      )
+    ]
+  end
+  end

data/lib/check_super_calls/shell_adapter.rb

@@ -0,0 +1,27 @@
+require_relative 'helpers'
+require_relative 'languages/swift.rb'
+require_relative 'languages/obj_c.rb'
+
+# Adapter which handles shell access.
+class ShellAdapter
+  def process_files(ignore_list, base_path)
+    [
+      Swift.new,
+      ObjC.new
+    ].each do |language|
+      result = find_files(ignore_list, base_path, language.file_regex)
+
+      result.each do |file|
+        file_content = File.open(file, 'r:UTF-8').read
+
+        language.patterns.each do |pattern|
+          next if file_content !~ pattern.definition
+
+          if file_content !~ pattern.check
+            puts file + ': ' + pattern.name + ' not called'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/check_super_calls/version.rb

@@ -0,0 +1,3 @@
+module CheckSuperCalls
+  VERSION = '0.1.0'.freeze
+end

data/lib/check_super_calls.rb

@@ -0,0 +1,14 @@
+require 'check_super_calls/version'
+require 'check_super_calls/arguments_parser.rb'
+require 'check_super_calls/shell_adapter.rb'
+
+module CheckSuperCalls
+  class Error < StandardError; end
+  # Your code goes here...
+  def self.main(_args)
+    options = Parser.parse(ARGV)
+
+    shell = ShellAdapter.new
+    result = shell.process_files(nil, options.input_directory)
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: check_super_calls
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Nagy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+description: Script that checks if Swift and Objective C subclasses call specific
+  superclass methods.
+email:
+- nagy.andrei@gmail.com
+executables:
+- check-super-calls
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/check-super-calls
+- bin/console
+- bin/setup
+- check_super_calls.gemspec
+- fixtures/ObjC/compliantFile.m
+- fixtures/ObjC/file.h
+- fixtures/ObjC/offendingFile.m
+- fixtures/swift/compliantFile.swift
+- fixtures/swift/nestedDirectory/anotherFile.swift
+- fixtures/swift/offendingFile.swift
+- lib/check_super_calls.rb
+- lib/check_super_calls/arguments_parser.rb
+- lib/check_super_calls/helpers.rb
+- lib/check_super_calls/languages/obj_c.rb
+- lib/check_super_calls/languages/pattern.rb
+- lib/check_super_calls/languages/swift.rb
+- lib/check_super_calls/shell_adapter.rb
+- lib/check_super_calls/version.rb
+homepage: https://github.com/andreinagy/check-super-calls
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Check calls to superclasses in iOS code.
+test_files: []