fastlane-plugin-memory_leak_detector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e04f3ae11817aa2645365d2c19e82eeffee412f96fb6716f48ab0fa878e4b4d9
+  data.tar.gz: 84ddf41d23c3c884b2793424b89163c7a600a390d156fa577b0536d806e67a07
+SHA512:
+  metadata.gz: c96a53beaac7e44ac74bbb4098504f1a8f929eb2cede99b46055c9f1bcf8b84e71b8933f9419814b68770e1364ffbb5eb104c105ea2e68eb9754e5abb6c249e7
+  data.tar.gz: a235186a6943c5d928de4518a6244da384202b39a72ff7aa8099fccae9a765e37c96566f2c40d2e33a3f49141336f91e2a0d2f8d1181d3b35d031b272d587cae

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Nurzhan <nurzhaan0@gmial.com>
+
+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,52 @@
+# memory_leak_detector plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-memory_leak_detector)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-memory_leak_detector`, add it to your project by running:
+
+```bash
+fastlane add_plugin memory_leak_detector
+```
+
+## About memory_leak_detector
+
+Memory leak detector
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/memory_leak_detector/actions/memory_leak_detector_action.rb

@@ -0,0 +1,47 @@
+require 'fastlane/action'
+require_relative '../helper/memory_leak_detector_helper'
+
+module Fastlane
+  module Actions
+    class MemoryLeakDetectorAction < Action
+      def self.run(params)
+        UI.message("The memory_leak_detector plugin is working!")
+      end
+
+      def self.description
+        "Memory leak detector"
+      end
+
+      def self.authors
+        ["Nurzhan"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "The Memory Leak Detector is a Fastlane plugin designed to help iOS developers detect memory leaks during builds or tests. By integrating with Xcode’s Instruments tool, it automatically scans the app for potential memory leaks and provides detailed reports, including information about the affected classes and objects. This plugin streamlines the process of identifying and addressing memory management issues, improving the stability and performance of iOS applications."
+      end
+
+      def self.available_options
+        [
+          # FastlaneCore::ConfigItem.new(key: :your_option,
+          #                         env_name: "MEMORY_LEAK_DETECTOR_YOUR_OPTION",
+          #                      description: "A description of your option",
+          #                         optional: false,
+          #                             type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/memory_leak_detector/helper/memory_leak_detector_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class MemoryLeakDetectorHelper
+      # class methods that you define here become available in your action
+      # as `Helper::MemoryLeakDetectorHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the memory_leak_detector plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/memory_leak_detector/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module MemoryLeakDetector
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/memory_leak_detector.rb

@@ -0,0 +1,118 @@
+require 'fastlane/plugin/memory_leak_detector/version'
+
+module Fastlane
+  module Actions
+    class MemoryLeakDetectorAction < Action
+      def self.run(params)
+        UI.message("Running Memory Leak Detection...")
+
+        # Optional: Set the Xcode scheme and configuration for testing
+        scheme = params[:scheme]
+        configuration = params[:configuration]
+        output_file = params[:output_file] || "memory_leak_report.txt" # Default to a text file
+
+        # Run the Instruments command to detect memory leaks
+        command = "xcrun instruments -t 'Leaks' -D '#{output_file}' #{scheme} #{configuration}"
+        
+        # Execute the command to detect memory leaks
+        result = sh(command)
+
+        # Check if the command's result indicates any leaks
+        if result.include?("leak detected")
+          UI.error("Memory leak detected!")
+          # Capture and save the details of the leak to a file
+          save_report(output_file)
+        else
+          UI.success("No memory leaks detected!")
+          save_report(output_file, no_leaks: true)
+        end
+      end
+
+      def self.save_report(output_file, no_leaks: false)
+        # If no leaks are detected, output a clean "No leaks" message
+        if no_leaks
+          File.open(output_file, 'w') do |file|
+            file.puts "Memory Leak Report - No leaks detected"
+            file.puts "Timestamp: #{Time.now}"
+          end
+        else
+          # If leaks are detected, provide detailed information in the report
+          leak_details = get_leak_details(output_file)
+
+          File.open(output_file, 'w') do |file|
+            file.puts "Memory Leak Report - Leaks Detected"
+            file.puts "Timestamp: #{Time.now}"
+            file.puts "Leak details:"
+
+            leak_details.each_with_index do |leak, index|
+              file.puts "Leak ##{index + 1}:"
+              file.puts "Class: #{leak[:class]}"
+              file.puts "Object: #{leak[:object]}"
+              file.puts "File: #{leak[:file]}"
+              file.puts "Line: #{leak[:line]}"
+              file.puts "Stack trace: #{leak[:stack_trace]}"
+              file.puts "Retained reference count: #{leak[:ref_count]}"
+              file.puts "-" * 50
+            end
+          end
+        end
+
+        UI.message("Report saved to #{output_file}")
+      end
+
+      # Simulated function to extract leak details from the Instruments log
+      def self.get_leak_details(output_file)
+        # Example of what the leak details might look like
+        # You would replace this part with logic to parse Instruments output
+        # and extract the actual leak details.
+        leaks = [
+          {
+            class: "MyClass",
+            object: "MyObject",
+            file: "MyClass.swift",
+            line: 42,
+            stack_trace: "SomeStackTrace -> SomeMethod",
+            ref_count: 2
+          },
+          {
+            class: "AnotherClass",
+            object: "AnotherObject",
+            file: "AnotherClass.swift",
+            line: 35,
+            stack_trace: "AnotherStackTrace -> AnotherMethod",
+            ref_count: 3
+          }
+        ]
+        
+        leaks
+      end
+
+      def self.description
+        "Detect memory leaks in your app during builds or tests and generate a detailed report"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       description: "The Xcode scheme to use",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :configuration,
+                                       description: "The build configuration (e.g., Debug, Release)",
+                                       optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :output_file,
+                                       description: "The output file for the memory leak report",
+                                       optional: true,
+                                       type: String,
+                                       default_value: "memory_leak_report.txt")
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-memory_leak_detector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nurzhan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-14 00:00:00.000000000 Z
+dependencies: []
+description:
+email: nurzhaan0@gmial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/memory_leak_detector.rb
+- lib/fastlane/plugin/memory_leak_detector/actions/memory_leak_detector_action.rb
+- lib/fastlane/plugin/memory_leak_detector/helper/memory_leak_detector_helper.rb
+- lib/fastlane/plugin/memory_leak_detector/version.rb
+homepage: https://github.com/Nurzhan0/fastlane-plugin-memory-leak-detector
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Memory leak detector
+test_files: []