un_used_methods 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb16037d95822bc46032688ce2f4946b51bdcb036f6d10ac3e99bad7e55e841f
-  data.tar.gz: f09b4e02a470acc103637647c5518a36ec60df67afa3a7a5a08bc191b4fc24e5
+  metadata.gz: 165752d3ad48f228b8dc3314fb55c847df1669e46779fab24cd7ae22ee79c4fb
+  data.tar.gz: 17a1e0d278cbe0af632f040851401e7c62d7c08b262639ed522e6615ab128121
 SHA512:
-  metadata.gz: 010c199699355f6eb81141e82377a193a409c98156ead13417867a71a9384622da243d74eee859d12539e8c8fe12f5cfcbe03261326a73c3ab3e316ff64f0510
-  data.tar.gz: 9120c81b4cebcadaa300622c6d7c7fe372bb8776f84a7ab8fee16eed814810250a4f0f1468b6be11bf69be591afdc3efee4f079804e759bbcb41daa63d4431ee
+  metadata.gz: 9d412e91fc1ff54838afcc323a46ac6156f5427abc167a9bf7201d563f0ea4be8c1d1d7b1d8e7c7737c38116cb9b431557855784253b9f99f6f3828877ece2f2
+  data.tar.gz: 734cdc3cd74a4f26d3470231942e7a9a97b18475aee25ecd344cdce55d75ff2c50fa875c6a66ff1d1017ae218b444fad0bf7473d7062cdc8eaeaea5df18f15ef

data/.idea/un_used_methods.iml

@@ -35,4 +35,45 @@
     <orderEntry type="library" scope="PROVIDED" name="thor (v1.3.1, ruby-3.1.6-p260 (2)) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.5.0, ruby-3.1.6-p260 (2)) [gem]" level="application" />
   </component>
+  <component name="RakeTasksCache-v2">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build un_used_methods-0.1.1.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum of un_used_methods-0.1.1.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install un_used_methods-0.1.1.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install un_used_methods-0.1.1.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.1 and build and push un_used_methods-0.1.1.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
+          <RakeTaskImpl id="rubocop">
+            <subtasks>
+              <RakeTaskImpl description="Autocorrect RuboCop offenses (only when it's safe)" fullCommand="rubocop:autocorrect" id="autocorrect" />
+              <RakeTaskImpl description="Autocorrect RuboCop offenses (safe and unsafe)" fullCommand="rubocop:autocorrect_all" id="autocorrect_all" />
+              <RakeTaskImpl description="" fullCommand="rubocop:auto_correct" id="auto_correct" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Run RSpec code examples" fullCommand="spec" id="spec" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
 </module>

data/README.md

@@ -1,39 +1,69 @@
-# UnUsedMethods
-
-TODO: Delete this and the text below, and describe your gem
-
-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/un_used_methods`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, 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]/un_used_methods. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/un_used_methods/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the UnUsedMethods project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/un_used_methods/blob/master/CODE_OF_CONDUCT.md).
+# UnUsedMethods Gem
+
+[![Gem Version](https://badge.fury.io/rb/un_used_methods.svg)](https://badge.fury.io/rb/un_used_methods)
+
+The `un_used_methods` gem is designed to help you identify and clean up unused methods in your Ruby on Rails application. In a large codebase, it can be challenging to track which methods are actively used and which are obsolete. The `un_used_methods` gem scans your application's codebase and identifies methods that are defined but not used anywhere else in your project. This helps you spot and remove unnecessary code, improving maintainability and performance.
+
+
+## Features
+
+- Scans for method definitions across various directories (models, controllers, helpers, views, and more).
+- Checks for method usage in code files and view templates.
+- Reports methods that are defined but not used in the project.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'un_used_methods'
+```
+
+Then run:
+
+```ruby
+bundle install
+```
+
+## Usage
+
+To use the gem, run the following command:
+
+```ruby
+bundle exec un_used_methods find_unused
+```
+
+This command will analyze your codebase and print out any unused methods it finds. The gem scans through Ruby files, HTML/ERB templates, and other relevant file types to ensure comprehensive coverage.
+
+## Example Output
+
+```plaintext
+Method 'test' called in file: app/models/test.rb
+Method 'another_method' not called anywhere in the project
+
+Unused Methods found in your model, controller and helper directories:
+app/models/test.rb: another_method
+```
+
+## Configuration
+
+The gem uses default settings to scan common directories and file types. If you need to customize the directories or file types to scan, you can modify the gem's configuration within the codebase.
+
+## Development
+
+To contribute to the development of this gem:
+
+1. Fork the repository.
+2. Create a new branch (`git checkout -b feature/your-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin feature/your-feature`).
+5. Create a new Pull Request.
+6. Write RSpec test cases for the features you added.
+
+## License
+
+This gem is available as open source under the terms of the MIT License.
+
+## Acknowledgements
+
+This gem leverages concepts from static code analysis and method usage detection to enhance code quality.

data/lib/un_used_methods/analyzer.rb

@@ -19,14 +19,10 @@ module UnUsedMethods
     def find_un_used_methods
       un_used_methods = []
 
-      # Analyze Models
-      un_used_methods += find_in_directory("app/models")
-
-      # Analyze Controllers
-      un_used_methods += find_in_directory("app/controllers")
-
-      # Analyze Helpers
-      un_used_methods += find_in_directory("app/helpers")
+      # Analyze Models, Controllers, and Helpers
+      ["app/models", "app/controllers", "app/helpers"].each do |directory|
+        un_used_methods += find_in_directory(directory)
+      end
 
       un_used_methods
     end
@@ -37,7 +33,7 @@ module UnUsedMethods
       Dir.glob("#{directory}/**/*.rb").each do |file|
         methods = extract_methods(file)
         methods.each do |method|
-          un_used_methods << "#{file}: #{method}" if method_used?(method, file)
+          un_used_methods << "#{file}: #{method}" unless method_used?(method, file)
         end
       end
 
@@ -46,29 +42,77 @@ module UnUsedMethods
 
     def extract_methods(file)
       content = File.read(file)
+      content = strip_comments(content, file)
       content.scan(/def (\w+)/).flatten
     end
 
     def method_used?(method, definition_file)
-      # Patterns to detect method calls with and without parentheses
-      method_call_pattern = /(\.|^|\s)#{method}\s*(\(|$)/
-      # Search directories for relevant file types
+      method_call_patterns = build_method_call_patterns(method)
+
       files = Dir.glob("app/**/*.{rb,html,erb,haml,slim,js,jsx,ts,tsx}") + Dir.glob("lib/**/*.{rb}")
-      method_used = false
-      files.each do |file|
-        content = File.read(file)
-        # Check for method usage (skip the method's own definition line)
-        if content =~ method_call_pattern && file != definition_file
-          method_used = true
-          p "Method '#{method}' called in file: #{file}"
-          break
-        elsif content.scan(method_call_pattern).count > 1 && file == definition_file
-          method_used = true
-          p "Method '#{method}' called in its own file: #{file}"
-          break
-        end
+
+      # Check if method is used in any file other than its own definition file
+      return true if file_contains_method_call?(files, definition_file, method_call_patterns)
+
+      # Check if the method is used in callbacks like `before_action` or `after_action`
+      return true if method_used_in_callback?(method, files)
+
+      # Check method usage within its own file
+      method_called_in_own_file?(definition_file, method_call_patterns)
+    end
+
+    def build_method_call_patterns(method)
+      [
+        /(\.|^|\s)#{method}\s*\(/, # Matches method calls with parameters
+        /(\.|^|\s)#{method}\b(?!\()/, # Matches method calls without parameters
+        /(\.|^|\s):#{method}\b/, # Matches method references as symbols (e.g., :method_name)
+        /\b#{method}\b/ # Matches method as a standalone word, e.g., when passed as an argument
+      ]
+    end
+
+    def file_contains_method_call?(files, definition_file, patterns)
+      files.any? do |file|
+        next if file == definition_file
+
+        content = read_file(file)
+        patterns.any? { |pattern| content.match?(pattern) }
+      end
+    end
+
+    def method_called_in_own_file?(definition_file, patterns)
+      content = read_file(definition_file)
+      patterns.any? { |pattern| content.scan(pattern).count > 1 }
+    end
+
+    def method_used_in_callback?(method, files)
+      # Create a dynamic regex pattern to match any Rails callback with the given method
+      callback_pattern = /\b(before|after|around|validate|commit|save|create|update|destroy)\w*\s*:#{method}\b/
+
+      files.any? do |file|
+        content = read_file(file)
+        content.match?(callback_pattern)
+      end
+    end
+
+    def read_file(file)
+      content = File.read(file)
+      strip_comments(content, file)
+    end
+
+    def strip_comments(content, file)
+      case File.extname(file)
+      when ".rb"
+        # Remove Ruby comments and strings
+        content.gsub(/#.*$/, "").gsub(/"(?:[^"\\]|\\.)*"|'(?:[^'\\]|\\.)*'/, "")
+      when ".erb", ".html", ".haml", ".slim"
+        # Remove HTML, ERB, HAML, SLIM comments
+        content.gsub(/<!--.*?-->/m, "").gsub(/<%#.*?%>/m, "")
+      when ".js", ".jsx", ".ts", ".tsx"
+        # Remove JavaScript/TypeScript comments
+        content.gsub(%r{//.*$}, "").gsub(%r{/\*.*?\*/}m, "")
+      else
+        content
       end
-      !method_used
     end
 
     def report_un_used_methods(unused_methods)

data/lib/un_used_methods/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UnUsedMethods
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: un_used_methods
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Dhamo1107
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-17 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake