Add avoid-keep-awake asciidoc and json #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

glbrtrnh wants to merge 51 commits into JuBaas:main from glbrtrnh:avoid-keep-awake

CHANGELOG.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ### Added
+    - [C# #66](https://github.com/green-code-initiative/ecoCode-csharp/pull/66) [EC93] [C#] Return Task directly
+    - [JAVA #323](https://github.com/green-code-initiative/ecoCode/pull/323) [EC94] [Java] Use orElseGet instead of orElse
+    ### Changed
+    ### Deleted
+    ## [1.6.0] - 2024-06-03
+    ### Added
+    - [#293](https://github.com/green-code-initiative/ecoCode/issues/293) [EC513] Swift port
+    - [#310](https://github.com/green-code-initiative/ecoCode/issues/310) EC515 Swift port
+    - [#306](https://github.com/green-code-initiative/ecoCode/issues/306) Swift port of rule EC514
     - [#315](https://github.com/green-code-initiative/ecoCode/pull/315) Add rule EC530 for javascript
+    - [#321](https://github.com/green-code-initiative/ecoCode/pull/321) Add rule EC522 for javascript (avoid brightness override)
+    - [Python #26](https://github.com/green-code-initiative/ecoCode-python/issues/26) [EC89] [Python] Avoid unlimited cache
     ### Changed
+    - [#318](https://github.com/green-code-initiative/ecoCode/issues/318) Implement the rule EC523 for React Native
     ### Deleted
+    - [#318](https://github.com/green-code-initiative/ecoCode/issues/318) Merge the rule EC8 with EC523
     ## [1.5.4] - 2024-05-24
     ### Added
@@ Expand Down Expand Up @@
     ## Comparison List
-    [unreleased](https://github.com/green-code-initiative/ecoCode/compare/1.5.4...HEAD)
+    [unreleased](https://github.com/green-code-initiative/ecoCode/compare/1.6.0...HEAD)
+    [1.6.0](https://github.com/green-code-initiative/ecoCode/compare/1.5.4...1.6.0)
     [1.5.4](https://github.com/green-code-initiative/ecoCode/compare/1.5.3...1.5.4)
     [1.5.3](https://github.com/green-code-initiative/ecoCode/compare/1.5.2...1.5.3)
     [1.5.2](https://github.com/green-code-initiative/ecoCode/compare/1.5.1...1.5.2)
@@ Expand Down @@

README.md

-Original file line number
+Diff line change
@@ Expand Up @@
     They have contributed to the success of ecoCode :
     - [Davidson Consulting](https://www.davidson.fr/)
-    - [Orange Business Services](https://www.orange-business.com/)
+    - [Orange Business](https://www.orange-business.com/)
     - [Snapp'](https://www.snapp.fr/)
     - [Université de Pau et des Pays de l'Adour (UPPA)](https://www.univ-pau.fr/)
     - [Solocal](https://www.solocal.com/) / [PagesJaunes.fr](https://www.pagesjaunes.fr/)
@@ Expand Down @@

RULES.md

Large diffs are not rendered by default.

ecocode-rules-specifications/pom.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ @@
     	<parent>
     		<groupId>io.ecocode</groupId>
     		<artifactId>ecocode-parent</artifactId>
-    		<version>1.5.5-SNAPSHOT</version>
+    		<version>1.6.1-SNAPSHOT</version>
     	</parent>
     	<artifactId>ecocode-rules-specifications</artifactId>
@@ Expand Down @@

ecocode-rules-specifications/src/main/rules/EC505/javascript/EC505.asciidoc

-Original file line number
+Diff line change
@@ -0,0 +1,26 @@
+    :!sectids:
+    == Why is this an issue?
+    To avoid draining the battery, an Android device that is left idle quickly falls asleep.
+    Hence, keeping the screen on should be avoided, unless it is absolutely necessary.
+    == Example of non compliant code
+    ```js
+    export default function KeepAwakeExample() {
+      useKeepAwake(); // Non compliant
+      return (
+        <View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
+          <Text>This screen will never sleep!</Text>
+        </View>
+      );
+    }
+    ```
+    ```js
+    _activate = () => {
+        activateKeepAwake(); // Non-compliant
+        alert('Activated!');
+      };
+    ```

ecocode-rules-specifications/src/main/rules/EC505/javascript/EC505.json

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    {
+        "tags": [
+          "sobriety",
+          "environment",
+          "ecocode",
+          "react-native",
+          "eco-design"
+        ],
+        "compatibleLanguages": [
+          "JAVASCRIPT",
+          "TYPESCRIPT"
+        ]
+      }

ecocode-rules-specifications/src/main/rules/EC513/swift/EC513.asciidoc

-Original file line number
+Diff line change
@@ -0,0 +1,57 @@
+    Most iOS devices come equipped with a variety of sensors that measure motion, orientation, and various environmental conditions.
+    In addition to these, the devices include advanced sensors such as the image sensor (commonly referred to as the Camera) and the geo-positioning sensor (commonly referred to as GPS).
+    The common point of all these sensors is that they are power-intensive while in use. A typical issue arises when these sensors continue to process data unnecessarily after the application enters an idle state, typically when paused or when the user stops interacting with it.
+        Consequently, calls must be carefully paired: `CLLocationManager.startUpdatingLocation()` and `CLLocationManager.stopUpdatingLocation()`.
+        Failing to do so can drain the battery in just a few hours.
+    == Noncompliant Code Example
+    [source,swift]
+    ----
+    import CoreLocation
+    class LocationTracker: NSObject, CLLocationManagerDelegate {
+        var locationManager: CLLocationManager?
+        override init() {
+            super.init()
+            locationManager = CLLocationManager()
+            locationManager?.delegate = self
+            locationManager?.requestAlwaysAuthorization() // Request appropriate authorization
+            locationManager?.startUpdatingLocation() // Start location updates
+        }
+        // LocationManager Delegate Methods
+        func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
+            // Process new locations
+        }
+    }
+    ----
+    == Compliant Code Example
+    [source,swift]
+    ----
+    import CoreLocation
+    class LocationTracker: NSObject, CLLocationManagerDelegate {
+        var locationManager: CLLocationManager?
+        override init() {
+            super.init()
+            locationManager = CLLocationManager()
+            locationManager?.delegate = self
+            locationManager?.requestAlwaysAuthorization() // Request appropriate authorization
+            locationManager?.startUpdatingLocation() // Start location updates only when needed
+        }
+        // LocationManager Delegate Methods
+        func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
+            // Process new locations
+            // Possibly stop updates if they are no longer needed
+            locationManager?.stopUpdatingLocation()
+        }
+    }
+    ----

ecocode-rules-specifications/src/main/rules/EC514/swift/EC514.asciidoc

-Original file line number
+Diff line change
@@ -0,0 +1,46 @@
+    Most iOS devices have built-in sensors that measure motion, orientation, and various environmental conditions. Additionally, they have image sensors (a.k.a. Camera) and geo-positioning sensors (a.k.a. GPS).
+    The common point of all these sensors is that they consume significant power while in use. Their common issue is processing data unnecessarily when the app is in an idle state, typically when it enters the background or becomes inactive.
+        Consequently, calls to start and stop sensor updates must be carefully managed for motion sensor: CMMotionManager#startAccelerometerUpdates()/CMMotionManager#stopAccelerometerUpdates().
+        Failing to do so can drain the battery quickly.
+    == Noncompliant Code Example
+    [source,swift]
+    ----
+    import CoreMotion
+    let motionManager = CMMotionManager()
+    func startMotionUpdates() {
+        if motionManager.isAccelerometerAvailable {
+            motionManager.startAccelerometerUpdates(to: .main) { data, error in
+                // Handle accelerometer updates
+            }
+        }
+    }
+    ----
+    == Compliant Code Example
+    [source,swift]
+    ----
+    import CoreMotion
+    let motionManager = CMMotionManager()
+    func startMotionUpdates() {
+        if motionManager.isAccelerometerAvailable {
+            motionManager.startAccelerometerUpdates(to: .main) { data, error in
+                // Handle accelerometer updates
+            }
+        }
+    }
+    func stopMotionUpdates() {
+        if motionManager.isAccelerometerActive {
+            motionManager.stopAccelerometerUpdates()
+        }
+    }
+    ----

ecocode-rules-specifications/src/main/rules/EC515/swift/EC515.asciidoc

-Original file line number
+Diff line change
@@ -0,0 +1,61 @@
+    Creation of an `AVAudioRecorder` object is used to record audio. These class has a method to stop recording and release resources.
+    In addition to unnecessary resources (such as memory and instances of codecs) being held, failure to properly stop and release these object if it is no longer needed may also lead to continuous battery consumption for mobile devices.
+    == Noncompliant Code Example
+    [source,swift]
+    ----
+    import AVFoundation
+    var audioRecorder: AVAudioRecorder?
+    func startRecording() {
+        let settings = [
+            AVFormatIDKey: Int(kAudioFormatMPEG4AAC),
+            AVSampleRateKey: 12000,
+            AVNumberOfChannelsKey: 1,
+            AVEncoderAudioQualityKey: AVAudioQuality.high.rawValue
+        ]
+        do {
+            audioRecorder = try AVAudioRecorder(url: getDocumentsDirectory().appendingPathComponent("recording.m4a"), settings: settings)
+            audioRecorder?.record()
+        } catch {
+            // Handle error
+        }
+    }
+    ----
+    == Compliant Solution
+    [source,swift]
+    ----
+    import AVFoundation
+    var audioRecorder: AVAudioRecorder?
+    func startRecording() {
+        let settings = [
+            AVFormatIDKey: Int(kAudioFormatMPEG4AAC),
+            AVSampleRateKey: 12000,
+            AVNumberOfChannelsKey: 1,
+            AVEncoderAudioQualityKey: AVAudioQuality.high.rawValue
+        ]
+        do {
+            audioRecorder = try AVAudioRecorder(url: getDocumentsDirectory().appendingPathComponent("recording.m4a"), settings: settings)
+            audioRecorder?.record()
+        } catch {
+            // Handle error
+        }
+    }
+    func stopRecording() {
+        if let recorder = audioRecorder, recorder.isRecording {
+            recorder.stop()
+            audioRecorder = nil
+        }
+    }
+    ----

ecocode-rules-specifications/src/main/rules/EC522/EC522.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,14 +6,6 @@ @@
         "func": "Constant\/Issue",
         "constantCost": "20min"
       },
-      "tags": [
-        "sobriety",
-        "environment",
-        "ecocode",
-        "android",
-        "ios",
-        "eco-design"
-      ],
       "ecoScore": "0.4",
       "defaultSeverity": "Minor"
-    }
+    }

ecocode-rules-specifications/src/main/rules/EC522/java/EC522.json

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    {
+      "tags": [
+        "sobriety",
+        "environment",
+        "ecocode",
+        "android",
+        "eco-design"
+      ]
+    }

ecocode-rules-specifications/src/main/rules/EC522/javascript/EC522.asciidoc

-Original file line number
+Diff line change
@@ -0,0 +1,30 @@
+    :!sectids:
+    == Why is this an issue?
+    To avoid draining the battery, iOS and Android devices adapt the brightness of the screen depending on the environment light.
+    For some reasons, developers may disable this feature programmatically.
+    This feature was introduced to improve battery life, be careful when deactivating it.
+    Hence, keeping forcing the screen brightness on should be avoided, unless it is absolutely necessary.
+    == Example of non compliant code
+    ```js
+    // Example with expo-brightness (Expo framework library)
+    import React, { useEffect } from 'react';
+    import { View, Text } from 'react-native';
+    import * as Brightness from 'expo-brightness';
+    export default function App() {
+        useEffect(() => {
+            (async () => { Brightness.setSystemBrightnessAsyn(1); })(); // Brightness is forced here
+        }, []);
+        return (
+            <View>
+                <Text>Brightness Module Example</Text>
+            </View>
+        );
+    }

ecocode-rules-specifications/src/main/rules/EC522/javascript/EC522.json

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    {
+      "tags": [
+        "sobriety",
+        "environment",
+        "ecocode",
+        "react-native",
+        "eco-design"
+      ],
+      "compatibleLanguages": [
+        "JAVASCRIPT",
+        "TYPESCRIPT"
+      ]
+    }

ecocode-rules-specifications/src/main/rules/EC522/swift/EC522.json

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    {
+      "tags": [
+        "sobriety",
+        "environment",
+        "ecocode",
+        "ios",
+        "eco-design"
+      ]
+    }

ecocode-rules-specifications/src/main/rules/EC523/EC523.json

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,14 +6,6 @@ @@
         "func": "Constant\/Issue",
         "constantCost": "10min"
       },
-      "tags": [
-        "sobriety",
-        "environment",
-        "ecocode",
-        "android",
-        "ios",
-        "eco-design"
-      ],
       "ecoScore": "0.4",
       "defaultSeverity": "Major"
-    }
+    }

ecocode-rules-specifications/src/main/rules/EC523/java/EC523.json

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    {
+      "tags": [
+        "sobriety",
+        "environment",
+        "ecocode",
+        "android",
+        "eco-design"
+      ]
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add avoid-keep-awake asciidoc and json #1

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Add avoid-keep-awake asciidoc and json #1

Are you sure you want to change the base?

Uh oh!

Add avoid-keep-awake asciidoc and json #1

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!