fastlane-plugin-localio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 567d3c7d22bdcbc694d4f7c796152270dd5f9d2460107a461540420f45e1d270
+  data.tar.gz: 07fc8436a3ab1a9986252b6b7da2b9701915e05c90f06b47ae17ea68f9e0aa68
+SHA512:
+  metadata.gz: 724f0852d3f9919d160d5525297fc91ea14fb41e51c7551535064f4ef5d617e9a8276004fc457eecf7c891178e2a84ad7a97e77f337c0ccb73d21fdf88bb06b3
+  data.tar.gz: 22effa0e8033297b3d67b074b4cddab91a78717a653bba9922ae1f8345874b17669a07a18e874b5382285329f19c136f7ebfe4519ec8fa7707f996ed031ec17c

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nacho Lopez
+
+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,188 @@
+# fastlane-plugin-localio
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/mrmans0n/fastlane-plugin-localio/blob/main/LICENSE)
+[![Gem Version](https://badge.fury.io/rb/fastlane-plugin-localio.svg)](https://badge.fury.io/rb/fastlane-plugin-localio)
+
+Fastlane plugin for the [localio](https://github.com/mrmans0n/localio) gem. Generates localization files from spreadsheets (Google Drive, XLS, XLSX, CSV) for multiple platforms (Android, iOS, Swift, Rails, JSON, Java Properties, RESX, Twine).
+
+## Installation
+
+Add to your project's `Gemfile`:
+
+```ruby
+gem "fastlane-plugin-localio"
+```
+
+Or install via fastlane:
+
+```bash
+fastlane add_plugin localio
+```
+
+## Usage
+
+The plugin supports two modes of operation.
+
+### Mode 1: Locfile-based (simple)
+
+If you already have a `Locfile` configured for localio, just point to it:
+
+```ruby
+localio(locfile: "path/to/Locfile")
+```
+
+### Mode 2: Inline parameters
+
+Configure everything directly in your Fastfile without needing a separate Locfile:
+
+```ruby
+localio(
+  platform: "android",
+  source: "xlsx",
+  source_path: "translations.xlsx",
+  source_sheet: "Sheet1",
+  output_path: "app/src/main/res",
+  formatting: "smart"
+)
+```
+
+## Source types
+
+### XLSX
+
+```ruby
+localio(
+  platform: "android",
+  source: "xlsx",
+  source_path: "translations.xlsx",
+  source_sheet: "Sheet1",
+  output_path: "app/src/main/res"
+)
+```
+
+### XLS
+
+```ruby
+localio(
+  platform: "ios",
+  source: "xls",
+  source_path: "translations.xls",
+  source_sheet: "Translations",
+  output_path: "Resources"
+)
+```
+
+### CSV
+
+```ruby
+localio(
+  platform: "json",
+  source: "csv",
+  source_path: "translations.csv",
+  output_path: "locales",
+  source_options: { column_separator: ";" }
+)
+```
+
+### Google Drive
+
+```ruby
+localio(
+  platform: "android",
+  source: "google_drive",
+  source_path: "My Translations Spreadsheet",
+  source_sheet: "Sheet1",
+  source_options: {
+    client_id: "your_client_id",
+    client_secret: "your_client_secret",
+    client_token: "path/to/token.json"
+  },
+  output_path: "app/src/main/res"
+)
+```
+
+## Platforms
+
+| Platform | Key | Description |
+|----------|-----|-------------|
+| Android | `android` | Generates `strings.xml` resource files |
+| iOS | `ios` | Generates `.strings` files |
+| Swift | `swift` | Generates Swift constants |
+| Rails | `rails` | Generates YAML locale files |
+| JSON | `json` | Generates JSON locale files |
+| Java Properties | `java_properties` | Generates `.properties` files |
+| RESX | `resx` | Generates `.resx` resource files |
+| Twine | `twine` | Generates Twine format files |
+
+## Platform options
+
+Pass platform-specific options via the `platform_options` parameter:
+
+```ruby
+localio(
+  platform: "swift",
+  source: "xlsx",
+  source_path: "translations.xlsx",
+  output_path: "Generated",
+  platform_options: {
+    create_constants: false,
+    override_default: "es"
+  }
+)
+```
+
+## Formatting
+
+Control how translation keys are formatted:
+
+| Style | Key |
+|-------|-----|
+| Smart (default) | `smart` |
+| Snake Case | `snake_case` |
+| Camel Case | `camel_case` |
+| None | `none` |
+
+```ruby
+localio(
+  platform: "android",
+  source: "xlsx",
+  source_path: "translations.xlsx",
+  output_path: "res",
+  formatting: "camel_case"
+)
+```
+
+## Filtering
+
+Use `only` and `except` to filter which keys are processed:
+
+```ruby
+localio(
+  platform: "android",
+  source: "xlsx",
+  source_path: "translations.xlsx",
+  output_path: "res",
+  only: '[\[][a][\]]',
+  except: '[\[][b][\]]'
+)
+```
+
+## Parameters
+
+| Key | Description | Default |
+|-----|-------------|---------|
+| `locfile` | Path to an existing Locfile | |
+| `platform` | Target platform | |
+| `source` | Source type (google_drive, xls, xlsx, csv) | |
+| `source_path` | Path to source file or spreadsheet title | |
+| `source_sheet` | Sheet name or index | |
+| `source_options` | Additional source options hash | |
+| `output_path` | Output directory | |
+| `formatting` | Key formatting style | `smart` |
+| `platform_options` | Additional platform options hash | |
+| `only` | Regex filter to include only matching keys | |
+| `except` | Regex filter to exclude matching keys | |
+
+## License
+
+MIT. See [LICENSE](LICENSE).

data/lib/fastlane/plugin/localio/actions/localio_action.rb

@@ -0,0 +1,174 @@
+require 'fastlane/action'
+require_relative '../helper/localio_helper'
+
+module Fastlane
+  module Actions
+    class LocalioAction < Action
+      def self.run(params)
+        if params[:locfile]
+          run_with_locfile(params[:locfile])
+        else
+          run_with_params(params)
+        end
+      end
+
+      def self.run_with_locfile(locfile_path)
+        Helper::LocalioHelper.require_localio!
+
+        UI.message("Running localio with Locfile: #{locfile_path}")
+
+        unless File.exist?(locfile_path)
+          UI.user_error!("Locfile not found at path: #{locfile_path}")
+        end
+
+        Dir.chdir(File.dirname(File.expand_path(locfile_path))) do
+          filename = File.basename(locfile_path)
+          config = ::Locfile.new
+          config.instance_eval(File.read(filename), filename)
+          ::Localio.from_configuration(config)
+        end
+      end
+
+      def self.run_with_params(params)
+        unless params[:platform]
+          UI.user_error!("Parameter 'platform' is required when not using a Locfile")
+        end
+
+        unless params[:source]
+          UI.user_error!("Parameter 'source' is required when not using a Locfile")
+        end
+
+        Helper::LocalioHelper.require_localio!
+
+        UI.message("Running localio with inline configuration (platform: #{params[:platform]}, source: #{params[:source]})")
+
+        config = Helper::LocalioHelper.build_configuration(params)
+        ::Localio.from_configuration(config)
+      end
+
+      def self.description
+        "Generates localization files from spreadsheets using the localio gem"
+      end
+
+      def self.authors
+        ["Nacho Lopez"]
+      end
+
+      def self.return_value
+        nil
+      end
+
+      def self.details
+        "Reads translation data from spreadsheets (Google Drive, XLS, XLSX, CSV) " \
+          "and generates platform-specific localization files using the localio gem. " \
+          "Supports two modes: Locfile-based (simple) and inline parameters (no Locfile needed)."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :locfile,
+            env_name: "LOCALIO_LOCFILE",
+            description: "Path to an existing Locfile. If provided, all other parameters are ignored",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :platform,
+            env_name: "LOCALIO_PLATFORM",
+            description: "Target platform (android, ios, swift, rails, json, java_properties, resx, twine)",
+            optional: true,
+            type: String,
+            verify_block: proc do |value|
+              unless Helper::LocalioHelper::VALID_PLATFORMS.include?(value.to_sym)
+                UI.user_error!("Invalid platform '#{value}'. Valid: #{Helper::LocalioHelper::VALID_PLATFORMS.join(', ')}")
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :source,
+            env_name: "LOCALIO_SOURCE",
+            description: "Source type (google_drive, xls, xlsx, csv)",
+            optional: true,
+            type: String,
+            verify_block: proc do |value|
+              unless Helper::LocalioHelper::VALID_SOURCES.include?(value.to_sym)
+                UI.user_error!("Invalid source '#{value}'. Valid: #{Helper::LocalioHelper::VALID_SOURCES.join(', ')}")
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :source_path,
+            env_name: "LOCALIO_SOURCE_PATH",
+            description: "Path to the source file (XLS/XLSX/CSV) or spreadsheet title (Google Drive)",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :source_sheet,
+            env_name: "LOCALIO_SOURCE_SHEET",
+            description: "Sheet name or index within the spreadsheet",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :source_options,
+            env_name: "LOCALIO_SOURCE_OPTIONS",
+            description: "Additional source options as a hash (merged with source_path/source_sheet)",
+            optional: true,
+            type: Hash
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :output_path,
+            env_name: "LOCALIO_OUTPUT_PATH",
+            description: "Output directory for generated localization files",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :formatting,
+            env_name: "LOCALIO_FORMATTING",
+            description: "Key formatting style (smart, snake_case, camel_case, none)",
+            optional: true,
+            default_value: "smart",
+            type: String,
+            verify_block: proc do |value|
+              unless Helper::LocalioHelper::VALID_FORMATTING.include?(value.to_sym)
+                UI.user_error!("Invalid formatting '#{value}'. Valid: #{Helper::LocalioHelper::VALID_FORMATTING.join(', ')}")
+              end
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :platform_options,
+            env_name: "LOCALIO_PLATFORM_OPTIONS",
+            description: "Additional platform options as a hash (e.g. { create_constants: false })",
+            optional: true,
+            type: Hash
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :only,
+            env_name: "LOCALIO_ONLY",
+            description: "Regex filter to include only matching keys",
+            optional: true,
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :except,
+            env_name: "LOCALIO_EXCEPT",
+            description: "Regex filter to exclude matching keys",
+            optional: true,
+            type: String
+          )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/localio/helper/localio_helper.rb

@@ -0,0 +1,59 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  module Helper
+    class LocalioHelper
+      VALID_PLATFORMS = %i[android ios swift rails json java_properties resx twine].freeze
+      VALID_SOURCES = %i[google_drive xls xlsx csv].freeze
+      VALID_FORMATTING = %i[smart snake_case camel_case none].freeze
+
+      def self.require_localio!
+        return if defined?(::Locfile) && ::Locfile.method_defined?(:platform)
+
+        begin
+          require 'localio'
+        rescue LoadError
+          UI.user_error!("The 'localio' gem is required. Add `gem 'localio'` to your Gemfile.")
+        end
+      end
+
+      def self.build_configuration(params)
+        config = Locfile.new
+
+        platform_sym = params[:platform].to_sym
+        platform_opts = params[:platform_options] || {}
+        config.platform(platform_sym, platform_opts)
+
+        source_sym = params[:source].to_sym
+        source_opts = build_source_options(params)
+        config.source(source_sym, source_opts)
+
+        config.output_path(params[:output_path]) if params[:output_path]
+        config.formatting(params[:formatting].to_sym) if params[:formatting]
+
+        config.only(keys: params[:only]) if params[:only]
+        config.except(keys: params[:except]) if params[:except]
+
+        config
+      end
+
+      def self.build_source_options(params)
+        opts = {}
+        opts.merge!(params[:source_options]) if params[:source_options]
+
+        case params[:source].to_sym
+        when :google_drive
+          opts[:spreadsheet] ||= params[:source_path]
+          opts[:sheet] ||= params[:source_sheet]
+        when :xls, :xlsx
+          opts[:path] ||= params[:source_path]
+          opts[:sheet] ||= params[:source_sheet]
+        when :csv
+          opts[:path] ||= params[:source_path]
+        end
+
+        opts
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/localio.rb

@@ -0,0 +1,13 @@
+require 'fastlane/plugin/localio/version'
+
+module Fastlane
+  module Localio
+    def self.all_classes
+      Dir[File.expand_path('*/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+Fastlane::Localio.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-localio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nacho Lopez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: localio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates localization files from spreadsheets using the localio gem.
+  Supports Google Drive, XLS, XLSX, and CSV sources with output for Android, iOS,
+  Swift, Rails, JSON, Java Properties, RESX, and Twine.
+email: nacho@nlopez.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/localio.rb
+- lib/fastlane/plugin/localio/actions/localio_action.rb
+- lib/fastlane/plugin/localio/helper/localio_helper.rb
+- lib/fastlane/plugin/localio/version.rb
+homepage: https://github.com/mrmans0n/fastlane-plugin-localio
+licenses:
+- MIT
+metadata: {}
+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.22
+signing_key:
+specification_version: 4
+summary: Fastlane plugin for the localio gem
+test_files: []