fastlane-plugin-tinifyme 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c4dd33581bb6fd8b2e7c4cb681a67c2aa638d722d4e1081de9088fdfbca5232
+  data.tar.gz: 4c6ae1449c2f5ba1c0ebe09f1f9a5d9bcf8db6b706808f0febebe2d0a141ef59
+SHA512:
+  metadata.gz: c3ef02ca3e17fb18ec405dfac2283b203d8847cb8bd8dcb31a91e8100b81915a29693410e57c10109546cad24f004807e87e268d17ac7039c48285cf8c2d9c34
+  data.tar.gz: 29a06723613c74beb77d9a717caba722716476f18c3ad2ee6aeccffcee5473d277034b8775fa384704caab7eeacfa060549fdb80581dbe24599a770ea39acecc

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Danilo Becke <danilobecke@gmail.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,69 @@
+# tinifyme plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-tinifyme)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-tinifyme`, add it to your project by running:
+
+```bash
+fastlane add_plugin tinifyme
+```
+
+## About tinifyme
+
+Compress assets using [TinyPNG](https://tinypng.com). This plugin was designed to automate image compression in your project via pre-commit hook or one-off runs.
+
+You'll need a TinyPNG developer API key, which can be freely obtained on their website: [https://tinypng.com/developers](https://tinypng.com/developers).
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. 
+
+### Try it
+
+Clone the repo and run `fastlane install_plugins`.
+
+### Compress a specific image
+
+```bash
+bundle exec fastlane compress_image file_path:"path/to/file" api_key:"YOUR_API_KEY"
+```
+
+### Use as pre-commit hook
+
+1. Set your TinyPNG developer API key as the value of the `TINYPNG_API_KEY` env var
+2. Call your _fastlane_ lane from your `.git/hooks/pre-commit` file. For instance:
+
+```sh
+bundle exec fastlane compress_images_hook
+```
+
+## 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/tinifyme/actions/tinifyme_action.rb

@@ -0,0 +1,104 @@
+require 'fastlane_core'
+require 'fastlane/action'
+require_relative '../helper/tinifyme_helper'
+
+module Fastlane
+  module Actions
+    class TinifymeAction < Action
+      def self.run(params)
+        key = params[:api_key]
+        file_path = params[:file_path]
+        helper = Helper::TinifymeHelper.new
+        if file_path
+          compress([file_path], key)
+        else
+          UI.message(helper.format_output('Checking staged files...', is_step: true))
+          modified_images = helper.get_modified_images(params[:image_formats])
+          length = modified_images.length
+          return UI.success(helper.format_output('No images found!')) unless length > 0
+
+          UI.success(helper.format_output("Found #{length} #{length > 1 ? 'images' : 'image'}."))
+          compressed = compress(modified_images, key)
+          return UI.abort_with_message!("The commit was aborted.") unless compressed || params[:abort_commit_without_internet_connection] == false
+
+          UI.message(helper.format_output('Adding to commit...', is_step: true))
+          helper.add_to_commit(modified_images)
+          UI.success(helper.format_output("#{compressed ? 'Compressed images' : 'Images'} added to the current commit."))
+        end
+      end
+
+      def self.description
+        "Compress assets using TinyPNG."
+      end
+
+      def self.authors
+        ["Danilo Becke"]
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        "fastlane plugin to automate image compression in your project via precommit hook or one-off runs."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :api_key,
+            description: "Required TinyPNG API key (https://tinypng.com/developers)",
+            env_name: "TINYPNG_API_KEY",
+            optional: false,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :file_path,
+            description: "If present, the action will compress the given image. If not, the action will act as a pre-commit hook and look for staged added or modified images",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :image_formats,
+            description: "Allowed image extensions to be compressed",
+            default_value: [".jpg", ".png", ".webp", ".jpeg"],
+            optional: false,
+            type: Array
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :abort_commit_without_internet_connection,
+            description: "Decide whether the commit should be aborted when there are images to be compressed and the internet connection is not reachable (thus, the compression won't be possible)",
+            default_value: true,
+            optional: false,
+            type: Boolean
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      class << self
+        private
+
+        def helper
+          @helper ||= Helper::TinifymeHelper.new
+        end
+
+        def compress(images, key)
+          unless helper.has_connection?
+            UI.important('No internet connection.')
+            return false
+          end
+
+          helper.validate_credentials!(key)
+          UI.message(helper.format_output('Compressing...', is_step: true))
+          helper.compress!(images)
+          length = images.length
+          UI.success(helper.format_output("Compressed #{length} #{length > 1 ? 'images' : 'image'}."))
+          true
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/tinifyme/helper/tinifyme_helper.rb

@@ -0,0 +1,53 @@
+require 'fastlane_core/ui/ui'
+require 'tinify'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?(:UI)
+
+  module Helper
+    class TinifymeHelper
+      def has_connection?
+        require 'net/http'
+        url = URI('https://www.google.com')
+        begin
+          http = Net::HTTP.start(url.host, url.port, use_ssl: true)
+          http.finish
+          return true
+        rescue SocketError
+          return false
+        end
+      end
+
+      def validate_credentials!(api_key)
+        UI.message(self.format_output('Checking TinyPNG credentials...', is_step: true))
+        Tinify.key = api_key
+        Tinify.validate!
+        UI.success(self.format_output('Valid credentials!'))
+      rescue Tinify::Error => e
+        UI.abort_with_message!(e)
+      end
+
+      def format_output(text, is_step: false)
+        if is_step
+          return " > #{text}"
+        else
+          return "   #{text}"
+        end
+      end
+
+      def get_modified_images(image_extensions)
+        added_or_modified = `git diff --name-only --cached --diff-filter=d`
+        added_or_modified.split("\n").select { |file| file.downcase.end_with?(*image_extensions) }
+      end
+
+      def compress!(images)
+        images.each { |image| Tinify.from_file(image).to_file(image) }
+      end
+
+      def add_to_commit(images)
+        images_text = images.join(" ")
+        system("git add #{images_text}")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Tinifyme
+    VERSION = "1.0.0"
+  end
+end

data/lib/fastlane/plugin/tinifyme.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/tinifyme/version'
+
+module Fastlane
+  module Tinifyme
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Tinifyme.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-tinifyme
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Danilo Becke
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tinify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description:
+email: danilobecke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/tinifyme.rb
+- lib/fastlane/plugin/tinifyme/actions/tinifyme_action.rb
+- lib/fastlane/plugin/tinifyme/helper/tinifyme_helper.rb
+- lib/fastlane/plugin/tinifyme/version.rb
+homepage: https://github.com/danilobecke/fastlane-plugin-tinifyme
+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: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Compress assets using TinyPNG.
+test_files: []