fui 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3004280a95452a6d9d564a749e4e4401d141018b
-  data.tar.gz: 7833b104af4e870cb65df25671a0dc11f3985f1c
+SHA256:
+  metadata.gz: e1b8934ca5afcaf97a11129a196887f07aa1596113b40c18e061db018410df26
+  data.tar.gz: d8639e7b395f89c874c81cbe0d5613dea5e5db59a7e0ceb389e0ea32a361a0be
 SHA512:
-  metadata.gz: 348e74f6fe709c2eb3cf15c50f4665431b5a39654c4daea299461329c22b696cff75dfd62c0d3a8374bcbe68d0cec06f2075bd3585b377ad8de3988872186695
-  data.tar.gz: 1193c75c6bb5cd05f82732179f6e3cc6b5bbcd9a5fd654e65174e3be10efb15edcc0a9837b8f0967feb1719e1a39e63db9a3bc5801336a695dce35a426b976ac
+  metadata.gz: 8bc77ab09250e68b6ff3f54111f107852d1a988cabfb875c167662363c3040cc904d37ac9133275741190aa11f72477e3bf19d5b6074d9ceffc6bfadc22ff5a1
+  data.tar.gz: 4397a5d1a4c8b19d7b4dc91b50808200c30d96083e311a3f7bf816df3b1b58922827e98bcfb77955fb02a4d977a8763bf03d5d59bf3c4ac45ff51f499b7ad72a

data/CHANGELOG.md

@@ -1,29 +1,45 @@
-### 0.4.2 (Next)
+### 0.6.0 (2026/04/12)
 
-* Your contribution here.
+* [#45](https://github.com/dblock/fui/pull/45): Migrated from Travis CI to GitHub Actions with danger-pr-comment workflow - [@dblock](https://github.com/dblock).
+* [#47](https://github.com/dblock/fui/pull/47): Fixed `ArgumentError: invalid byte sequence in UTF-8` when processing files with non-UTF-8 encoding - [@dblock](https://github.com/dblock).
+* [#48](https://github.com/dblock/fui/pull/48): Fixed `NameError: undefined local variable or method 'project_path'` in verbose mode - [@dblock](https://github.com/dblock).
+* [#49](https://github.com/dblock/fui/pull/49): Added summary output to `find` command: prints `Found N unused header(s).` or `No unused imports found.` - [@dblock](https://github.com/dblock).
+* [#50](https://github.com/dblock/fui/pull/50): Fixed `delete` command to also remove `.mm` (Objective-C++) implementation files - [@dblock](https://github.com/dblock).
+* [#51](https://github.com/dblock/fui/pull/51): Added support for Ruby 4.x - [@dblock](https://github.com/dblock).
+* [#52](https://github.com/dblock/fui/pull/52): Clarified README: fui finds unreferenced header files, not unused imports within files - [@dblock](https://github.com/dblock).
 
-### 0.4.1 (8/16/2017)
+### 0.5.0 (2018/12/19)
+
+* [#29](https://github.com/dblock/fui/pull/29): Added support for ignoring paths through `-i`, `--ignore-path` - [@jeffctown](https://github.com/jeffctown).
+* [#28](https://github.com/dblock/fui/pull/28): Added support for finding global imports (bracket notation) - [@jeffctown](https://github.com/jeffctown).
+* [#28](https://github.com/dblock/fui/pull/28): Added ability to turn off global or local import checks through `-g`, `--ignore-global-imports` or `-l`, `--ignore-local-imports` - [@jeffctown](https://github.com/jeffctown).
+* [#28](https://github.com/dblock/fui/pull/28): The `--ignorexib` option has been renamed to `--ignore-xib-files` - [@jeffctown](https://github.com/jeffctown).
+* [#31](https://github.com/dblock/fui/pull/31): Added Danger, PR linter and a README TOC - [@jeffctown](https://github.com/jeffctown).
+* [#32](https://github.com/dblock/fui/pull/32): Added support for ignoring bridging headers - [@jeffctown](https://github.com/jeffctown).
+* [#33](https://github.com/dblock/fui/pull/33): Added RELEASING.md to document release process - [@jeffctown](https://github.com/jeffctown).
+
+### 0.4.1 (2017/8/16)
 
 * [#24](https://github.com/dblock/fui/pull/24): Support .mm files - [@shachlan](https://github.com/Shachlan).
 
-### 0.4.0 (5/14/2016)
+### 0.4.0 (2016/5/14)
 
 * [#20](https://github.com/dblock/fui/pull/20): Added `-x`, `--ignorexib`, find unused classes referenced from its own XIB - [@Ezor](https://github.com/Ezor).
 
-### 0.3.0 (2/7/2014)
+### 0.3.0 (2014/2/7)
 
 * [#5](https://github.com/dblock/fui/issues/5): Explicitly require Ruby 1.9.3 or later in .gemspec - [@paulyoung](https://github.com/paulyoung).
 * [#4](https://github.com/dblock/fui/issues/4): Added support for .storyboard and .xib `customClass` references - [@dblock](https://github.com/dblock).
 
-### 0.2.0 (1/23/2014)
+### 0.2.0 (2014/1/23)
 
 * By default will display "(simulation)" because no actual files are being deleted - [@dblock](https://github.com/dblock).
 * Fui's exit code with `find` will be the number of unused references found - [@dblock](https://github.com/dblock).
 
-### 0.1.1 (1/22/2014)
+### 0.1.1 (2014/1/22)
 
 * Fix: properly handle .pch includes - [@dblock](https://github.com/dblock).
 
-### 0.1.0 (1/22/2014)
+### 0.1.0 (2014/1/22)
 
 * Initial public release, based on code by [@dstnbrkr](https://github.com/dstnbrkr) - [@dblock](https://github.com/dblock).

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013 Daniel Doubrovkine.
+Copyright (c) 2014-2018 Daniel Doubrovkine.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,51 +2,103 @@ Fui
 ==========
 
 [![Gem Version](https://badge.fury.io/rb/fui.svg)](https://badge.fury.io/rb/fui)
-[![Build Status](https://travis-ci.org/dblock/fui.svg)](https://travis-ci.org/dblock/fui)
+[![Test](https://github.com/dblock/fui/actions/workflows/test.yml/badge.svg)](https://github.com/dblock/fui/actions/workflows/test.yml)
 
 Find unused Objective-C imports.
 
+> **What fui does:** finds header (`.h`) files that are never imported anywhere in your project — i.e. classes that can potentially be deleted entirely.
+>
+> **What fui does not do:** find `#import` statements within a file that are unused by that file's code. For that, use a tool like [Clang's unused-includes warning](https://clang.llvm.org/docs/DiagnosticsReference.html) or AppCode.
+
+# Table of Contents
+
+- [Usage](#usage)
+  - [Get Help](#get-help)
+  - [Find Unused Classes in the Current Directory](#find-unused-classes-in-the-current-directory)
+  - [Find Unused Classes in any Path](#find-unused-classes-in-any-path)
+  - [Skip Interface Builder (.xib) Files](#skip-interface-builder-xib-files)
+  - [Ignore Local Imports](#ignore-local-imports)
+  - [Ignore Global Imports](#ignore-global-imports)
+  - [Ignore a Path](#ignore-a-path)
+  - [Ignore Multiple Paths](#ignore-multiple-paths)
+  - [Delete All Unused Class Files with Prompt](#delete-all-unused-class-files-with-prompt)
+- [Xcode Plugin](#xcode-plugin)
+- [Contributing](#contributing)
+- [Copyright and License](#copyright-and-license)
+
 ## Usage
 
-```
+```sh
 gem install fui
 ```
 
-#### Get Help
+### Get Help
 
-```
+```sh
 fui help
 ```
 
-#### Find Unused Classes in the Current Directory
+### Find Unused Classes in the Current Directory
 
-```
+```sh
 fui find
 ```
 
-The `find` command lists all the files that contain unused imports and exits with the number of files found.
+The `find` command lists all header (`.h`) files that are not imported anywhere in the project, and exits with the number of such files found.
 
-#### Find Unused Classes in a Path
+### Find Unused Classes in any Path
 
-```
+```sh
 fui --path=~/source/project/Name find
 ```
 
-#### Find Unused Classes in a Path Skipping Interface Builder (.xib) Files
+### Skip Interface Builder (.xib) Files
 
-ForRunning `fui` with `-x` (or `--ignorexib`) will, for example, mark `Foo.h` as unused when `Foo.xib` holds a reference to the `Foo` class and no other references to Foo.h exist.
+Running `fui` with `-x` (or `--ignore-xib-files`) will, for example, mark `Foo.h` as unused when `Foo.xib` holds a reference to the `Foo` class and no other references to Foo.h exist.
 
-```
+```sh
 fui -x --path=~/source/project/Name find
 ```
 
-#### Delete All Unused Class Files w/ Prompt
+### Ignore Local Imports
+
+Running `fui` with `-l` (or `--ignore-local-imports`) will, for example, mark `Foo.h` as unused when `Bar.h` contains a local (quotation syntax) import of `Foo.h` (eg. `#import Foo.h`).
+
+```sh
+fui -l --path=~/source/project/Name find
+```
+
+### Ignore Global Imports
+
+Running `fui` with `-g` (or `--ignore-global-imports`) will, for example, mark `Foo.h` as unused when `Bar.h` contains a global (bracket syntax) import of `Foo.h` (eg. `#import <Framework/Foo.h>`).
 
+```sh
+fui -g --path=~/source/project/Name find
 ```
+
+### Ignore a Path
+
+Running `fui` with `-i` (or `--ignore-path`) will, for example, ignore a `Pods` folder when searching for headers or referencing files.
+
+```sh
+fui --path=~/source/project/Name --ignore-path=Pods find
+```
+
+### Ignore Multiple Paths
+
+Running `fui` with `-i` (or `--ignore-path`) can ignore multiple folders when searching for headers or referencing files.
+
+```sh
+fui --path=~/source/project/Name --ignore-path=Pods --ignore-path=Libraries find
+```
+
+### Delete All Unused Class Files with Prompt
+
+```sh
 fui --path=~/source/project/Name delete --perform --prompt
 ```
 
-#### Xcode Plugin
+## Xcode Plugin
 
 Use [xcfui](https://github.com/jcavar/xcfui) for integration with Xcode.
 
@@ -56,6 +108,6 @@ There're [a few feature requests and known issues](https://github.com/dblock/fui
 
 ## Copyright and License
 
-Copyright (c) 2014, Daniel Doubrovkine, [Artsy](http://artsy.github.io), based on code by [Dustin Barker](https://github.com/dstnbrkr).
+Copyright (c) 2014-2018, Daniel Doubrovkine, [Artsy](http://artsy.github.io), based on code by [Dustin Barker](https://github.com/dstnbrkr).
 
 This project is licensed under the [MIT License](LICENSE.md).

data/RELEASING.md

@@ -0,0 +1,61 @@
+# Releasing fui
+
+There are no hard rules about when to release fui. Release bug fixes frequently, features not so frequently, and breaking changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [GitHub Actions](https://github.com/dblock/fui/actions).
+
+Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
+
+```
+### 0.4.0 (2016/5/14)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md
+git commit -m "Preparing for release, 0.4.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+fui 0.4.0 built to pkg/fui-0.4.0.gem.
+Tagged v0.4.0.
+Pushed git commits and tags.
+Pushed fui 0.4.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.4.1 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/fui/version.rb](lib/fui/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/fui/version.rb
+git commit -m "Preparing for next development iteration, 0.4.1."
+git push origin master
+```

data/bin/fui

@@ -6,13 +6,16 @@ include GLI::App
 
 program_desc 'Find unused imports in an Objective-C codebase.'
 
-flag [:p, :path], desc: 'Path to search.', default_value: Dir.pwd
-switch [:v, :verbose], desc: 'Produce verbose output.', default_value: false
-switch [:x, :ignorexib], desc: 'Ignore interface builder (.xib) files.', default_value: false
+flag %i[p path], desc: 'Path to search.', default_value: Dir.pwd
+flag %i[i ignore-path], desc: 'Path to ignore.', default_value: nil, multiple: true
+switch %i[v verbose], desc: 'Produce verbose output.', default_value: false
+switch %i[x ignore-xib-files], desc: 'Ignore interface builder (.xib) files.', default_value: false
+switch %i[g ignore-global-imports], desc: 'Ignores imports using a global (angle bracket) format.', default_value: false
+switch %i[l ignore-local-imports], desc: 'Ignores imports using a local (quote) format.', default_value: false
 
 default_command :find
 
-pre do |global_options, _command, options, _args|
+pre do |global_options, _command, _options, _args|
   options = global_options.dup
   path = options.delete(:path)
   $fui = Fui::Finder.new(path, options)
@@ -34,14 +37,20 @@ command :find do |c|
         puts relative_path
       end
     end
-    exit_now! nil, $fui.unused_references.count
+    count = $fui.unused_references.count
+    if count > 0
+      puts "Found #{count} unused #{count == 1 ? 'header' : 'headers'}."
+    else
+      puts 'No unused imports found.'
+    end
+    exit_now! nil, count
   end
 end
 
 desc 'Delete header and implementation files of unused classes'
 command :delete do |c|
-  c.switch [:t, :prompt], desc: 'Prompt on delete', default_value: true
-  c.switch [:f, :perform], desc: 'Actually perform deletion', default_value: false, negatable: false
+  c.switch %i[t prompt], desc: 'Prompt on delete', default_value: true
+  c.switch %i[f perform], desc: 'Actually perform deletion', default_value: false, negatable: false
 
   c.action do |global_options, options, _args|
     begin
@@ -54,7 +63,7 @@ command :delete do |c|
       end.each do |k, _v|
         relative_path = Pathname.new(k.path).relative_path_from(root).to_s
         if options[:prompt]
-          print "Remove #{relative_path}(.m) [y/N] "
+          print "Remove #{relative_path}(.m/.mm) [y/N] "
           response = STDIN.getc.upcase
           puts "#{response.chr}\r\n"
           next unless response.chr == 'Y'
@@ -65,15 +74,18 @@ command :delete do |c|
           puts "#{relative_path}#{options[:perform] ? '' : ' (simulation)'}\r\n"
         end
         File.delete(k.path) if options[:perform]
-        impl_path = k.path.gsub(/\.h$/, '.m')
-        next unless File.exist?(impl_path)
-        relative_path = Pathname.new(impl_path).relative_path_from(root).to_s
-        if global_options[:verbose]
-          puts "Removing #{relative_path}#{options[:perform] ? '' : ' (simulation)'}\r\n"
-        else
-          puts "#{relative_path}#{options[:perform] ? '' : ' (simulation)'}\r\n"
+        ['.m', '.mm'].each do |ext|
+          impl_path = k.path.gsub(/\.h$/, ext)
+          next unless File.exist?(impl_path)
+
+          relative_path = Pathname.new(impl_path).relative_path_from(root).to_s
+          if global_options[:verbose]
+            puts "Removing #{relative_path}#{options[:perform] ? '' : ' (simulation)'}\r\n"
+          else
+            puts "#{relative_path}#{options[:perform] ? '' : ' (simulation)'}\r\n"
+          end
+          File.delete(impl_path) if options[:perform]
         end
-        File.delete(impl_path) if options[:perform]
       end
     ensure
       system('stty -raw echo')

data/lib/fui/finder.rb

@@ -1,4 +1,5 @@
 module Fui
+  # A class to find various things in an Objective C project.
   class Finder
     attr_reader :path, :options
 
@@ -9,7 +10,21 @@ module Fui
     end
 
     def headers
-      @headers ||= Finder.find(path) { |path| Header.header?(path) }.collect { |path| Header.new(path) }
+      @headers ||= find(path) { |path| Header.header?(path) }.collect { |path| Header.new(path) }
+    end
+
+    def bridging_headers
+      @bridging_headers ||= find(path) { |path| Project.project?(path) }.collect { |path| Project.new(path).bridging_headers(options[:verbose]) }
+    end
+
+    def ignores
+      return unless options['ignore-path']
+
+      @ignores ||= options['ignore-path'].map do |i|
+        raise Errno::ENOENT, i unless Dir.exist?(i)
+
+        Pathname(i)
+      end
     end
 
     def references(&block)
@@ -19,7 +34,6 @@ module Fui
           references[header] = []
         end
         Find.find(path) do |path|
-          next unless File.ftype(path) == 'file'
           if ['.m', '.mm', '.h', '.pch'].include?(File.extname(path))
             process_code references, path, &block
           elsif ['.storyboard', '.xib'].include?(File.extname(path))
@@ -31,38 +45,62 @@ module Fui
     end
 
     def unused_references(&block)
-      @unused_references ||= references(&block).select { |_k, v| v.count == 0 }
+      @unused_references ||= references(&block).select { |k, v| v.count.zero? && !bridging_headers.include?(k.filename) }
     end
 
     private
 
     # Find all files for which the block yields.
-    def self.find(path)
+    def find(path)
       results = []
       Find.find(path) do |fpath|
+        if FileTest.directory?(fpath)
+          next unless ignores
+
+          ignores.each do |ignore|
+            next unless fpath.include?(ignore.realpath.to_s)
+
+            puts "Ignoring Directory: #{fpath}" if options[:verbose]
+            Find.prune
+          end
+        end
         results << fpath if yield fpath
       end
       results
     end
 
+    def local_imported(file_contents, header)
+      return false if options['ignore-local-imports']
+
+      file_contents.include?("#import \"#{header.filename}\"")
+    end
+
+    def global_imported(file_contents, header)
+      return false if options['ignore-global-imports']
+
+      escaped_header = Regexp.quote(header.filename)
+      regex = '(#import\s{1}<.+\/' + escaped_header + '>)'
+      file_contents.match(regex)
+    end
+
     def process_code(references, path)
-      File.open(path) do |file|
-        yield path if block_given?
-        filename = File.basename(path)
-        headers.each do |header|
-          filename_without_extension = File.basename(path, File.extname(path))
-          references[header] << path if filename_without_extension != header.filename_without_extension && File.read(file).include?("#import \"#{header.filename}\"")
-        end
+      yield path if block_given?
+      file_contents = File.read(path, encoding: 'binary').encode('UTF-8', invalid: :replace, undef: :replace)
+      headers.each do |header|
+        filename_without_extension = File.basename(path, File.extname(path))
+        global_import_exists = global_imported(file_contents, header)
+        local_import_exists = local_imported(file_contents, header)
+        references[header] << path if filename_without_extension != header.filename_without_extension && (local_import_exists || global_import_exists)
       end
     end
 
     def process_xml(references, path)
-      File.open(path) do |file|
-        yield path if block_given?
-        headers.each do |header|
-          filename_without_extension = File.basename(path, File.extname(path))
-          references[header] << path if (!options['ignorexib'] || filename_without_extension != header.filename_without_extension) && File.read(file).include?("customClass=\"#{header.filename_without_extension}\"")
-        end
+      yield path if block_given?
+      file_contents = File.read(path, encoding: 'binary').encode('UTF-8', invalid: :replace, undef: :replace)
+      headers.each do |header|
+        filename_without_extension = File.basename(path, File.extname(path))
+        check_xibs = !options['ignore-xib-files']
+        references[header] << path if (check_xibs || filename_without_extension != header.filename_without_extension) && file_contents.include?("customClass=\"#{header.filename_without_extension}\"")
       end
     end
   end

data/lib/fui/header.rb

@@ -1,4 +1,5 @@
 module Fui
+  # Represents a Header (.h) file
   class Header
     attr_accessor :filename, :filename_without_extension, :path
 

data/lib/fui/project.rb

@@ -0,0 +1,32 @@
+module Fui
+  # Represents an Xcode Project pbxproj file
+  class Project
+    attr_accessor :filename, :bridging_header, :path
+
+    def self.project?(path)
+      File.extname(path) == '.pbxproj'
+    end
+
+    def initialize(path)
+      @path = path
+      @filename = File.basename(path)
+    end
+
+    def bridging_headers(verbose)
+      @bridging_headers ||= begin
+        regex = /(SWIFT_OBJC_BRIDGING_HEADER) = \".+\"/
+        bridging_headers = []
+        File.new(path).grep regex do |result|
+          tokens = result.split('"')
+          next if tokens.length < 2
+
+          path_tokens = tokens[1].split('/')
+          bridging_header = path_tokens[path_tokens.length - 1]
+          puts "Bridging Header Found: #{bridging_header} in #{path}." if verbose
+          bridging_headers << bridging_header
+        end
+        bridging_headers.uniq
+      end
+    end
+  end
+end

data/lib/fui/version.rb

@@ -1,3 +1,3 @@
 module Fui
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/fui.rb

@@ -4,3 +4,4 @@ require 'pathname'
 require 'fui/version'
 require 'fui/header'
 require 'fui/finder'
+require 'fui/project'

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: fui
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2026-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: dblock@dblock.org
 executables:
 - fui
@@ -35,33 +35,34 @@ files:
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
+- RELEASING.md
 - bin/fui
 - lib/fui.rb
 - lib/fui/finder.rb
 - lib/fui/header.rb
+- lib/fui/project.rb
 - lib/fui/version.rb
 homepage: http://github.com/dblock/fui
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Find unused Objective-C imports.
 test_files: []