feat: add multi-project support via for_project DSL with scoped rake tasks

Author: floriansr

.rubocop.yml

@@ -21,6 +21,7 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
     - lokalise_rails.gemspec
+    - lib/tasks/lokalise_rails_tasks.rake
 
 Metrics/BlockNesting:
   Max: 2
@@ -80,4 +81,4 @@ Gemspec/DevelopmentDependencies:
 
 RSpec/SpecFilePathFormat:
   Exclude:
-    - spec/lib/generators/lokalise_rails/**/*.rb
+    - spec/lib/generators/lokalise_rails/**/*.rb

README.md

@@ -127,6 +127,58 @@ namespace :lokalise_custom do
 end
 ```
 
+## Multiple Lokalise projects
+
+If your Rails app needs to sync with more than one Lokalise **project** (different `project_id`, possibly a different `api_token`), use `for_project` in `config/lokalise_rails.rb`. It registers a named, isolated config and automatically generates scoped rake tasks without changing the existing `lokalise_rails:import` and `lokalise_rails:export` tasks.
+
+```ruby
+# config/lokalise_rails.rb
+
+# Main project — unchanged
+LokaliseRails::GlobalConfig.config do |c|
+  c.api_token  = ENV['LOKALISE_API_TOKEN']
+  c.project_id = ENV['LOKALISE_PROJECT_ID']
+end
+
+# Additional project
+LokaliseRails::GlobalConfig.for_project(:mobile) do |c|
+  c.project_id  = ENV['LOKALISE_MOBILE_PROJECT_ID']
+  c.locales_path = "#{Rails.root}/config/locales/mobile"
+end
+```
+
+This generates the following rake tasks automatically:
+
+```
+rake lokalise_rails:import         # existing - uses the main config
+rake lokalise_rails:export         # existing - uses the main config
+rake lokalise_rails:mobile:import  # auto-generated — uses the :mobile config
+rake lokalise_rails:mobile:export  # auto-generated — uses the :mobile config
+```
+
+Any setting not explicitly set in the `for_project` block falls back to the main `GlobalConfig` - so shared options like `api_token` only need to be written once:
+
+```ruby
+LokaliseRails::GlobalConfig.config do |c|
+  c.api_token  = ENV['LOKALISE_API_TOKEN']  # shared by all projects
+  c.project_id = ENV['LOKALISE_PROJECT_ID']
+end
+
+LokaliseRails::GlobalConfig.for_project(:mobile) do |c|
+  # api_token is inherited from the main config above
+  c.project_id  = ENV['LOKALISE_MOBILE_PROJECT_ID']
+  c.locales_path = "#{Rails.root}/config/locales/mobile"
+end
+```
+
+You can register as many named projects as needed and sync them all in one command:
+
+```
+rails lokalise_rails:import lokalise_rails:mobile:import
+```
+
+> **Note:** `for_project` is designed for apps that need multiple distinct Lokalise **projects**. If you only need to sync multiple local directories against the same project, the `lokalise_custom` rake task pattern described above is sufficient.
+
 ## Configuration
 
 Options are specified in the `config/lokalise_rails.rb` file.

lib/generators/templates/lokalise_rails_config.rb

@@ -68,4 +68,13 @@
     ## Disable the import rake task:
     ## c.disable_import_task = false
   end
+
+  # To sync with a second Lokalise project, register a named config.
+  # This auto-generates lokalise_rails:<name>:import and lokalise_rails:<name>:export tasks.
+  # Settings not set here fall back to the GlobalConfig block above.
+  #
+  # LokaliseRails::GlobalConfig.for_project(:mobile) do |c|
+  #   c.project_id  = ENV['LOKALISE_MOBILE_PROJECT_ID']
+  #   c.locales_path = "#{Rails.root}/config/locales/mobile"
+  # end
 end

lib/lokalise_rails/global_config.rb

@@ -33,6 +33,62 @@ def disable_import_task
       def locales_path
         @locales_path || "#{LokaliseRails::Utils.root}/config/locales"
       end
+
+      # Registers a named project config and auto-generates scoped rake tasks
+      # (lokalise_rails:<name>:import and lokalise_rails:<name>:export).
+      #
+      # Settings not explicitly set in the block fall back to GlobalConfig
+      # via LokaliseManager's inline override mechanism, so shared options
+      # like api_token only need to be set once in the main config block.
+      #
+      # @param name [Symbol, String] identifier for the project
+      # @yield [collector] block to configure project-specific settings
+      #
+      # @example
+      #   LokaliseRails::GlobalConfig.for_project(:mobile) do |c|
+      #     c.project_id  = ENV['LOKALISE_MOBILE_PROJECT_ID']
+      #     c.locales_path = "#{Rails.root}/config/locales/mobile"
+      #   end
+      def for_project(name, &block)
+        collector = ProjectConfigCollector.new
+        block&.call(collector)
+        projects[name.to_sym] = collector.to_h
+      end
+
+      # Returns the registry of named project configs.
+      #
+      # @return [Hash{Symbol => Hash}]
+      def projects
+        @projects ||= {}
+      end
+    end
+
+    # Collects attribute assignments from a for_project block into a plain hash.
+    # The hash is passed as inline overrides to LokaliseManager.importer/exporter,
+    # so any attribute not explicitly set falls back to GlobalConfig automatically.
+    class ProjectConfigCollector
+      def initialize
+        @settings = {}
+      end
+
+      def to_h
+        @settings.dup
+      end
+
+      def method_missing(name, *args)
+        attr = name.to_s
+        if attr.end_with?('=')
+          @settings[attr.chomp('=').to_sym] = args.first
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        name.to_s.end_with?('=') || super
+      end
     end
+
+    private_constant :ProjectConfigCollector
   end
 end

lib/tasks/lokalise_rails_tasks.rake

@@ -37,4 +37,26 @@ namespace :lokalise_rails do
   rescue StandardError => e
     abort "Export failed: #{e.message}"
   end
+
+  # Auto-generate scoped import/export tasks for each named project
+  # registered via LokaliseRails::GlobalConfig.for_project.
+  LokaliseRails::GlobalConfig.projects.each do |project_name, project_opts|
+    namespace project_name do
+      desc "Import translations from Lokalise (#{project_name})"
+      task :import do
+        importer = LokaliseManager.importer(project_opts, LokaliseRails::GlobalConfig)
+        importer.import!
+      rescue StandardError => e
+        abort "Import failed: #{e.message}"
+      end
+
+      desc "Export translations to Lokalise (#{project_name})"
+      task :export do
+        exporter = LokaliseManager.exporter(project_opts, LokaliseRails::GlobalConfig)
+        exporter.export!
+      rescue StandardError => e
+        abort "Export failed: #{e.message}"
+      end
+    end
+  end
 end

spec/dummy/config/lokalise_rails.rb

@@ -5,4 +5,8 @@
     c.api_token = ENV.fetch('LOKALISE_API_TOKEN', nil)
     c.project_id = ENV.fetch('LOKALISE_PROJECT_ID', nil)
   end
+
+  LokaliseRails::GlobalConfig.for_project(:dummy_project) do |c|
+    c.project_id = ENV.fetch('LOKALISE_PROJECT_ID', nil)
+  end
 end

spec/lib/lokalise_rails/global_config_spec.rb

@@ -159,4 +159,57 @@
       expect(fake_class).to have_received(:disable_import_task=)
     end
   end
+
+  describe '.for_project' do
+    after { described_class.projects.clear }
+
+    it 'registers a named project with the given settings' do
+      described_class.for_project(:mobile) do |c|
+        c.project_id = 'mobile_id.123'
+        c.locales_path = '/config/locales/mobile'
+      end
+
+      expect(described_class.projects[:mobile]).to eq(
+        project_id: 'mobile_id.123',
+        locales_path: '/config/locales/mobile'
+      )
+    end
+
+    it 'supports registering multiple named projects' do
+      described_class.for_project(:mobile) { |c| c.project_id = 'mobile.123' }
+      described_class.for_project(:admin) { |c| c.project_id = 'admin.456' }
+
+      expect(described_class.projects.keys).to contain_exactly(:mobile, :admin)
+    end
+
+    it 'stores an empty hash when no block is given' do
+      described_class.for_project(:empty)
+
+      expect(described_class.projects[:empty]).to eq({})
+    end
+
+    it 'accepts lambda values such as skip_file_export' do
+      filter = ->(file) { file.include?('fr') }
+      described_class.for_project(:mobile) { |c| c.skip_file_export = filter }
+
+      expect(described_class.projects[:mobile][:skip_file_export]).to eq(filter)
+    end
+
+    it 'does not leak settings into GlobalConfig' do
+      described_class.for_project(:mobile) { |c| c.project_id = 'mobile.123' }
+
+      expect(described_class.project_id).not_to eq('mobile.123')
+    end
+
+    it 'raises NoMethodError when calling a getter (non-setter) in the block' do
+      expect { described_class.for_project(:mobile, &:project_id) }.to raise_error(NoMethodError)
+    end
+
+    it 'responds to setter methods but not to getter methods' do
+      described_class.for_project(:mobile) do |c|
+        expect(c.respond_to?(:project_id=)).to be true
+        expect(c.respond_to?(:project_id)).to be false
+      end
+    end
+  end
 end