fus 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 286731628f2c28dcaa3c92e8f9542e8bda025895
-  data.tar.gz: d9bf7fcba759693edb44112175acf15f86fb6b2c
+  metadata.gz: cfcacd9d75754dbe979b47f6c6499be68711dc6c
+  data.tar.gz: 08a9509df0f86f9a604d269430d501f7f257af2d
 SHA512:
-  metadata.gz: 7ac13df6d7ebcf35dc9aa9837eb567aa6a134f4cb108c50eded8e4324feefe7c59a2dc3e8d3c010825798e6b360baa22c6dc95ffd165acaf6ad8f95fc8db0409
-  data.tar.gz: 6e89f31f36a0f3c8ddf42a829adc481b9898a4155bec9014398b714f8564613faaf630c3e9908b7d0622218948787ddbec72716e5b599e6cd84bf01c91eab21a
+  metadata.gz: 384a22d13e0350ec977e6c3725cb38d90aea0fba0bee6be28c991a6a5f69d6d8416a95ebcd3182b8120bd8bf2e3dda488137dbbc803dad0ef9173ab6cc5eb0b1
+  data.tar.gz: 043cec1b9e239c2febbef1b32aeda5b193635309dec175220cd1025617d63aad28eb72a36a2db18f8caaa8224b46bd6a70a72a658811d9b3fb336e69df738425

data/README.md

@@ -6,20 +6,45 @@ Fus is a command line tool for finding unused Swift classes in your project.
 This tool was inspired by [fui](https://github.com/dblock/fui)
 
 ## Installation
-    $ gem install fus
+```
+$ gem install fus
+```
 
 ## Usage
 
+#### Get Help
+
+```
+fus help
+```
+
+#### Find Unused Classes in the Current Directory
+
 ```
-FUS commands:
-  fus find            # Find unused swift classes
-  fus list            # List all swift classes
-  
-Options:
-  -p, [--path=path]  # path in which to search (defaults to /Users/thomasabend/Desktop/Programming/fus)
+fus find
 ```
+
+The `find` command lists the names of all unused classes.
+
+#### List all Swift Classes in the Current Directory
+
+```
+fus list
+```
+
+The `list` command lists the names of all the Swift classes identified by FUS.
+
+#### Find Unused Classes at a Path
+
+```
+fus find --path [the path to search at]
+```
+
 ## Contributing
 
+This project (like Swift itself) is a work in progress. 
+Contributions are very welcome.
+
 1. Fork it ( https://github.com/[my-github-username]/fus/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/fus/finder.rb

@@ -1,27 +1,34 @@
 module Fus
+  # The thing that finds the stuff
   class Finder
     attr_reader :swift_paths
 
     def initialize(path)
       raise Errno::ENOENT.new(path) unless Dir.exists?(path)
       path = File.expand_path(path)
-      @swift_paths = Dir.glob("#{path}/**/*.swift")
+      @swift_paths = Dir
+          .glob("#{path}/**/*.swift")
+          .select {|path| path.scan(/\/Pods\//).empty? }
       @obj_c_paths = Dir.glob("#{path}/**/*.m") + Dir.glob("#{path}/**/*.h")
         .select {|path| path.scan(/-Swift.h/).empty? }
       @ib_paths = (Dir.glob("#{path}/**/*.xib") + 
                   Dir.glob("#{path}/**/*.storyboard"))
     end
 
+    # A list of names of unused classes
     def unused_classnames
       unused_classes.map(&:name)
     end
     
+    # A list of names of all Swift classes
     def swift_classnames
       swift_classes.map(&:name)
     end
     
 
     private
+    # Search all the swift paths and find things that look like classes
+    # then map those names into SwiftClasses
     def swift_classes
       @swift_classes ||= 
       @swift_paths
@@ -30,6 +37,8 @@ module Fus
       .map {|name| SwiftClass.new(name)}
     end
     
+    # Go through the list of all Swift classes and filter out the ones
+    # that are used in Swift, IB, or Obj-C
     def unused_classes
       @unused_classes ||= swift_classes.reject do |swift_class|
         swift_class.spec? ||
@@ -39,12 +48,14 @@ module Fus
       end
     end
 
+    # Given some text, identify Swift classes
     def find(swift_text)
       swift_text
         .scan(/class\s+([^func][^var][a-zA-Z_]+)\s*:?\s[a-zA-Z_]*\b?\s*{/)
         .flatten
     end
 
+    # Determines if a class is used in Swift
     def used_in_swift?(swift_class, paths=@swift_paths)
       paths.any? do |path|
         next if swift_class.matches_classname?(path)
@@ -52,10 +63,12 @@ module Fus
       end
     end
 
+    # Determines if a class is used in Obj-C
     def used_in_obj_c?(swift_class, paths=@obj_c_paths)
       paths.any? { |path| swift_class.used_in_obj_c?(File.open(path).read) }
     end
 
+    # Determines if a class is used in InterfaceBuilder
     def used_in_ib?(swift_class, paths=@ib_paths)
       paths.any? { |path| swift_class.used_in_xml?(File.open(path).read) }
     end

data/lib/fus/swift_class.rb

@@ -1,28 +1,34 @@
 module Fus
+  # A thin wrapper around the name of a Swift class
   class SwiftClass
     attr_reader :name
     def initialize(name)
       @name = name
     end
     
+    # Is this class a test class
     def spec?
-      name.match(/Spec/)
+      name.match(/Spec|Tests|Test/)
     end
     
+    # Does this class name match this path
     def matches_classname?(path)
       path.match(/#{name}\b/)
     end
     
+    # Is this class used in this XML
     def used_in_xml?(xml)
       xml.include?("customClass=\"#{name}\"")
     end
     
+    # Is this class used in this Obj-C text
     def used_in_obj_c?(text)
       text.match(/(^|[^@])#{name}/)
     end
     
+    # Is this class used in this Swift text
     def used_in_swift?(text)
-      text.match(/(\b#{name}.?[.:(])|([:].?#{name})|(typealias\s+.*=.+#{name})/)
+      text.match(/(\b#{name}.?[.:(])|([:].?#{name})|((typealias|associatedType)\s+.*=.+#{name})/)
     end
   end
 end

data/lib/fus/version.rb

@@ -1,3 +1,3 @@
 module Fus
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - tsabend
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor