i18n_tasks-plugin-view_component 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97221f5ca2ce493a3bb6e7a6c49e1f9aa0019a0f3582e7b0dc17908bb051e99a
+  data.tar.gz: 55e0f101dd42197a6d90b164c06d20b3454e5a303474150d32162969c2765d0f
+SHA512:
+  metadata.gz: 253bf83083cb7eb66eb397f7348ff188fb9548f14fd13859b7b614a4f85e85a82d3601428ee318662189b2713c4425fe61207337f0adacbe03fbbd78df6e8d85
+  data.tar.gz: fac6873b47c98fe35d1202ba2c73b01b927af48b3ccac00eba12d89c557ce2f213e2769edbb127ef801231e77ed9a886c528c2dacd679c6796084503c12d49e8

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  AllowedMethods:
+    - RSpec.describe
+    - describe
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-11
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in i18n_tasks-plugin-view_component.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.68'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Jochen Lutz
+
+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,84 @@
+# I18nTasks::Plugin::ViewComponent
+
+This gem adds support for [View Component](https://viewcomponent.org/)
+to [i18n-tasks](https://github.com/glebm/i18n-tasks).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_tasks-plugin-view_component', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install i18n_tasks-plugin-view_component
+
+## Usage
+
+Include the gem in your `i18n-tasks.yml.erb`. If you have a `i18n-tasks.yml`, just rename it.
+
+```erb
+<% require 'i18n_tasks/plugin/view_component' %>
+```
+
+Add the following config to the `data:` section.
+
+```yaml
+  adapter: I18nTasks::Plugin::ViewComponent::Filesystem
+```
+
+If you store your components somewhere different from the default `app/components`,
+add the base directory also to the `data:` section.
+
+```
+  view_component_root: app/components
+```
+
+## Compatibility Details
+
+While translations in the View Components's ruby code work (since the addition of
+`relative_exclude_method_name_paths` in i18n-tasks version 1.0.10), putting
+the locale files with the component code does not work, as these locale files
+put all strings directly beneath the language key:
+
+```
+# app/components/demo_app/example_component.yml
+en:
+  hello: "Hello world!"
+```
+
+I18n-tasks scans this as `hello`, while ViewComponent prefixes all strings with
+the component's fully qualified classname: `demo_app.example_component.hello`.
+This scope `demo_app.example_component` is used to resolve all relative i18n
+keys.
+
+This plugin adds logic to i18n-tasks to put the locale strings in the correct
+scope while loading the data.
+
+Additionally, it also adds a scanner for `.erb` files, that correctly handles
+files in sidecar directories, where vanilla i18n-tasks resolves the scope with
+the component's name duplicated. E.g. `t('.hello')` in
+`app/components/demo_app/example_component/example_component.html.erb` leads to
+`demo_app.example_component.example_component.hello` with vanilla i18n-tasks,
+while with this plugin, it resolves to `demo_app.example_component.hello`,
+which ViewComponent uses internally.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/ionos-cloud/i18n-tasks-view-component).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'i18n_tasks/plugin/view_component'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/i18n_tasks-plugin-view_component.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/i18n_tasks/plugin/view_component/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'i18n_tasks-plugin-view_component'
+  spec.version = I18nTasks::Plugin::ViewComponent::VERSION
+  spec.authors = ['Jochen Lutz']
+  spec.email = ['jochen.lutz@ionos.com']
+
+  spec.summary = 'Integrate ViewComponent with I18n-Tasks'
+  spec.description = 'support for View Component (https://viewcomponent.org/) in i18n-tasks (https://github.com/glebm/i18n-tasks)'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['source_code_uri'] = 'https://github.com/ionos-cloud/i18n-tasks-view-component'
+  spec.homepage = spec.metadata['source_code_uri']
+  spec.metadata['homepage_uri'] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'i18n-tasks', '~> 1.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/i18n_tasks/plugin/view_component/component_erb_scanner.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module I18nTasks
+  module Plugin
+    module ViewComponent
+      class ComponentErbScanner < I18n::Tasks::Scanners::ErbAstScanner
+        def absolute_key(key, path, roots: config[:relative_roots],
+                         exclude_method_name_paths: config[:relative_exclude_method_name_paths],
+                         calling_method: nil)
+          result = super
+
+          result.gsub(/(\w+)\.(?=\1#{key})/, '')
+        end
+      end
+    end
+  end
+end

data/lib/i18n_tasks/plugin/view_component/filesystem.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'i18n/tasks'
+
+module I18nTasks
+  module Plugin
+    module ViewComponent
+      class Filesystem < ::I18n::Tasks::Data::FileSystemBase
+        register_adapter :yaml, '*.yml', ::I18n::Tasks::Data::Adapter::YamlAdapter
+        register_adapter :json, '*.json', ::I18n::Tasks::Data::Adapter::JsonAdapter
+
+        def initialize(config) # rubocop:disable Metrics/MethodLength
+          @view_component_root = config.fetch(:view_component_root, 'app/components').gsub(%r{/$}, '')
+
+          erb_conf = I18n::Tasks::UsedKeys::SEARCH_DEFAULTS[:scanners].find do |s|
+            s[0] == '::I18n::Tasks::Scanners::ErbAstScanner'
+          end
+
+          if erb_conf
+            erb_conf[1][:exclude] ||= []
+            erb_conf[1][:exclude].push(component_root_erb_pattern)
+          end
+
+          super
+
+          I18n::Tasks.add_scanner(
+            'I18nTasks::Plugin::ViewComponent::ComponentErbScanner',
+            only: [component_root_erb_pattern]
+          )
+        end
+
+        ##
+        # Overloaded from `I18n::Tasks::Data::FileFormats` (included in `I18n::Tasks::Data::FileSystemBase`)
+        #
+        # In component-local locale files, it adds the component's module hierarchy to the locale scope,
+        # as does `ViewComponent::Translatable`.
+        #
+        # Locale files outside the ViewComponent directory are not modified.
+        #
+        def load_file(path)
+          result = super
+
+          return result unless component_locale_data?(path)
+
+          locale    = result.keys.first
+          key_parts = [locale, *component_keys(path)]
+
+          key_parts.reverse.inject(result[locale]) { |akk, key| { key => akk } }
+        end
+
+        ##
+        # Overloaded from `I18n::Tasks::Data::FileFormats` (included in `I18n::Tasks::Data::FileSystemBase`)
+        #
+        # This is the reverse method of `#load_file` above.
+        # It takes a locale tree and removes the scope of the component.
+        #
+        # As above, locale files outside the ViewComponent directory are not modified.
+        #
+        def normalized?(path, tree)
+          if component_locale_data?(path)
+            super(path, tree_without_component_keys(path, tree))
+          else
+            super
+          end
+        end
+
+        ##
+        # Overloaded from `I18n::Tasks::Data::FileFormats` (included in `I18n::Tasks::Data::FileSystemBase`)
+        #
+        # This is needed to reverse the effects i18n-task's standard router has in locale files inside ViewComponent's
+        # directories when invoking `i18n-tasks normalize`.
+        #
+        # As above, locale files outside the ViewComponent directory are not modified.
+        #
+        def write_tree(path, tree, sort = nil)
+          if component_locale_data?(path)
+            super(path, tree_without_component_keys(path, tree))
+          else
+            super
+          end
+        end
+
+        private
+
+        def component_locale_data?(path)
+          path.start_with?(@view_component_root)
+        end
+
+        def component_keys(path)
+          root_dir_levels = @view_component_root.split('/').size
+
+          components = File.dirname(path).split('/')[root_dir_levels..]
+
+          basename = File.basename(path).gsub(/(\.\w{2})?\.yml$/, '')
+
+          components << basename unless components.last == basename
+
+          components
+        end
+
+        def tree_without_component_keys(path, tree)
+          new_tree = tree.dup
+
+          new_tree.list.first.children = component_keys(path).inject(new_tree.list.first) { |akk, el| akk[el] }.children
+
+          new_tree
+        end
+
+        def component_root_erb_pattern
+          @component_root_erb_pattern ||= "#{@view_component_root}/**/*.erb"
+        end
+      end
+    end
+  end
+end

data/lib/i18n_tasks/plugin/view_component/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module I18nTasks
+  module Plugin
+    module ViewComponent
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/i18n_tasks/plugin/view_component.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'view_component/filesystem'
+require_relative 'view_component/component_erb_scanner'
+require_relative 'view_component/version'
+
+module I18nTasks
+  module Plugin
+    module ViewComponent
+    end
+  end
+end

data/sig/i18n_tasks/plugin/view_component.rbs

@@ -0,0 +1,8 @@
+module I18nTasks
+  module Plugin
+    module ViewComponent
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: i18n_tasks-plugin-view_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jochen Lutz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: support for View Component (https://viewcomponent.org/) in i18n-tasks
+  (https://github.com/glebm/i18n-tasks)
+email:
+- jochen.lutz@ionos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n_tasks-plugin-view_component.gemspec
+- lib/i18n_tasks/plugin/view_component.rb
+- lib/i18n_tasks/plugin/view_component/component_erb_scanner.rb
+- lib/i18n_tasks/plugin/view_component/filesystem.rb
+- lib/i18n_tasks/plugin/view_component/version.rb
+- sig/i18n_tasks/plugin/view_component.rbs
+homepage: https://github.com/ionos-cloud/i18n-tasks-view-component
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ionos-cloud/i18n-tasks-view-component
+  homepage_uri: https://github.com/ionos-cloud/i18n-tasks-view-component
+  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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Integrate ViewComponent with I18n-Tasks
+test_files: []