packwerk_slim_template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fd735a5469d37ee86529f99a8e2878ae65cc2615c7902842de944ea38bfe752
+  data.tar.gz: '049d75aa416b08b1750982f4770dd9e82757620c612788c70c9f4a66d0a8ff6d'
+SHA512:
+  metadata.gz: 68f13e9594755d317676ecca7d96c96414d4c8d1fdf0ce089b8ec3ee5e2f6939ee9a690673b78aad709817ce54f1ede9e409e6b17ad20f95ab812007a56e8ecb
+  data.tar.gz: d12cc1b600eeb02b06c294013a9512d5af5b7518354be7c02ca1e4539f303c429a6173b6961967b50f4fe818cce8ecfdda0d189d1024a69fd03d517124423721

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"packwerk_slim_template" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["yuuji.yaginuma@gmail.com"](mailto:"yuuji.yaginuma@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Yuji Yaginuma
+
+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,44 @@
+# PackwerkSlimTemplate
+
+PackwerkSlimTemplate supports Slim templates in [Packwerk](https://github.com/Shopify/packwerk)
+
+## Installation
+
+Add the gem to your application's `Gemfile`:
+
+```ruby
+gem "packwerk_slim_template"
+```
+
+Then install it:
+
+```bash
+bundle install
+```
+
+## Usage
+
+1. Ensure Packwerk knows it should scan Slim files. Update `config/packwerk.yml` (or your equivalent Packwerk configuration) so the `include` list contains Slim alongside the existing extensions:
+
+    ```yaml
+    include:
+      - "**/*.{rb,rake,erb,slim}"
+    ```
+
+2. Run Packwerk as usual:
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then run `bundle rake test` to execute the test suite. You can also run `bin/console` for an interactive prompt that lets you experiment with the converters.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/y-yagi/packwerk_slim_template. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/y-yagi/packwerk_slim_template/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PackwerkSlimTemplate project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/y-yagi/packwerk_slim_template/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/packwerk_slim_template/errors.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PackwerkSlimTemplate
+  class Error < StandardError; end
+
+  class SlimSyntaxError < Error
+    attr_reader :file_path, :line_number, :column
+
+    def initialize(message, file_path:, line_number: nil, column: nil)
+      @file_path = file_path
+      @line_number = line_number
+      @column = column
+      super(formatted_message(message))
+    end
+
+    private
+
+    def formatted_message(msg)
+      location = [@file_path, @line_number, @column].compact.join(":")
+      "#{location} - #{msg}"
+    end
+  end
+
+  class ParseError < Error; end
+end

data/lib/packwerk_slim_template/parser.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "packwerk"
+require "stringio"
+
+module PackwerkSlimTemplate
+  class Parser
+    include Packwerk::Parsers::ParserInterface
+
+    def initialize(ruby_parser: Packwerk::Parsers::Ruby.new)
+      @ruby_parser = ruby_parser
+    end
+
+    def call(io:, file_path:)
+      slim_content = io.read
+      result = SlimConverter.convert(slim_content, file_path: file_path)
+
+      # If no Ruby code extracted, return nil (Packwerk will skip)
+      return nil if result.ruby_code.empty?
+
+      @ruby_parser.call(
+        io: StringIO.new(result.ruby_code),
+        file_path: file_path
+      )
+    rescue Slim::Parser::SyntaxError => e
+      parse_result = Packwerk::Parsers::ParseResult.new(
+        file: file_path,
+        message: "#{file_path} - Slim syntax error at line #{e.lineno}: #{e.message}"
+      )
+      raise Packwerk::Parsers::ParseError, parse_result
+    rescue Packwerk::Parsers::ParseError => e
+      if e.message.include?(file_path)
+        raise
+      else
+        parse_result = Packwerk::Parsers::ParseResult.new(
+          file: file_path,
+          message: "#{file_path} - #{e.message}"
+        )
+        raise Packwerk::Parsers::ParseError, parse_result
+      end
+    end
+  end
+end
+
+module PackwerkSlimTemplate
+  module FactoryExtension
+    SLIM_REGEX = /\.slim\Z/
+
+    def for_path(path)
+      return @slim_parser ||= PackwerkSlimTemplate::Parser.new if SLIM_REGEX.match?(path)
+
+      super
+    end
+  end
+end
+
+Packwerk::Parsers::Factory.prepend(PackwerkSlimTemplate::FactoryExtension)

data/lib/packwerk_slim_template/slim_converter.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "slim"
+
+module PackwerkSlimTemplate
+  class LineMapper
+    def initialize
+      @mappings = {}
+    end
+
+    def add_mapping(ruby_line:, slim_line:, line_count: 1)
+      @mappings[ruby_line] = { slim_line: slim_line, span: line_count }
+    end
+
+    def slim_line_for(ruby_line)
+      mapping = @mappings.select { |k, v| k <= ruby_line && ruby_line < k + v[:span] }
+                         .max_by { |k, _| k }
+      mapping&.last&.dig(:slim_line)
+    end
+
+    def to_h
+      @mappings
+    end
+  end
+
+
+  class SlimConverter
+    ConversionResult = Struct.new(:ruby_code, :line_mapper, :ruby_snippets)
+
+    def self.convert(slim_content, file_path:)
+      new(slim_content, file_path).convert
+    end
+
+    def initialize(slim_content, file_path)
+      @slim_content = slim_content
+      @file_path = file_path
+      @line_mapper = LineMapper.new
+      @ruby_snippets = []
+      @current_ruby_line = 1
+    end
+
+    def convert
+      return empty_result if @slim_content.empty?
+
+      ast = parse_slim(@slim_content)
+      extract_ruby_nodes(ast)
+
+      ruby_code = @ruby_snippets.map { |s| s[:code] }.join("\n")
+
+      ConversionResult.new(ruby_code, @line_mapper, @ruby_snippets)
+    rescue Slim::Parser::SyntaxError => e
+      raise SlimSyntaxError.new(
+        e.message,
+        file_path: @file_path,
+        line_number: e.lineno
+      )
+    end
+
+    private
+
+    def empty_result
+      ConversionResult.new("", @line_mapper, [])
+    end
+
+    def parse_slim(content)
+      Slim::Parser.new.call(content)
+    end
+
+    def extract_ruby_nodes(node, slim_line = 1)
+      return unless node.is_a?(Array)
+
+      case node.first
+      when :multi
+        node[1..].each_with_index { |child, idx| extract_ruby_nodes(child, slim_line + idx) }
+      when :slim
+        handle_slim_node(node, slim_line)
+      when :html
+        node[1..].each_with_index { |child, idx| extract_ruby_nodes(child, slim_line + idx) }
+      end
+    end
+
+    def handle_slim_node(node, slim_line)
+      case node[1]
+      when :output
+        # [:slim, :output, escape, code, content]
+        code = node[3]
+        add_ruby_snippet(code, slim_line) if code && !code.empty?
+
+        nested_nodes = node.length > 4 ? node[4..] : nil
+        has_block_content = nested_nodes&.any? { |child| significant_child_node?(child) }
+
+        # Process nested content if present
+        if nested_nodes
+          nested_nodes.each_with_index do |child, idx|
+            extract_ruby_nodes(child, slim_line + idx + 1)
+          end
+        end
+
+        add_ruby_snippet("end", slim_line + (nested_nodes&.length || 0)) if has_block_content
+      when :control
+        # [:slim, :control, code, content]
+        code = node[2]
+        add_ruby_snippet(code, slim_line) if code && !code.empty?
+
+        # Process nested content (at index 3)
+        if node[3]
+          extract_ruby_nodes(node[3], slim_line + 1)
+        end
+
+        # Add closing 'end' for control structures
+        add_ruby_snippet("end", slim_line)
+      end
+    end
+
+    def add_ruby_snippet(code, slim_line)
+      @line_mapper.add_mapping(
+        ruby_line: @current_ruby_line,
+        slim_line: slim_line
+      )
+
+      @ruby_snippets << { code: code, slim_line: slim_line, ruby_line: @current_ruby_line }
+      @current_ruby_line += code.lines.count
+    end
+
+    def significant_child_node?(node)
+      return false unless node.is_a?(Array)
+
+      case node.first
+      when :newline
+        false
+      when :multi
+        node[1..].any? { |child| significant_child_node?(child) }
+      else
+        true
+      end
+    end
+  end
+end

data/lib/packwerk_slim_template/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PackwerkSlimTemplate
+  VERSION = "0.1.0"
+end

data/lib/packwerk_slim_template.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "packwerk_slim_template/version"
+require_relative "packwerk_slim_template/errors"
+require_relative "packwerk_slim_template/slim_converter"
+require_relative "packwerk_slim_template/parser"
+
+module PackwerkSlimTemplate
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: packwerk_slim_template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Yaginuma
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: packwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+email:
+- yuuji.yaginuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/packwerk_slim_template.rb
+- lib/packwerk_slim_template/errors.rb
+- lib/packwerk_slim_template/parser.rb
+- lib/packwerk_slim_template/slim_converter.rb
+- lib/packwerk_slim_template/version.rb
+homepage: https://github.com/y-yagi/packwerk_slim_template
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/y-yagi/packwerk_slim_template
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Slim support for packwerk
+test_files: []