packwerk-haml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cf64b42e173ed5328da2eb231754268801673e2fb3b15a8d26f2a776a85e4ca
+  data.tar.gz: fedd16f49ea69842f7e8f9e5731067d64ed350258fde909e7fb158f188b0ab01
+SHA512:
+  metadata.gz: b07c733e469e90ab115f088ede0924e31de5f0d49f8123c3968b51d540aca9002e2904c00546ee2233c8a4c5aa81a4769f5aede37f6246d7cc7e8f91cf7f7184
+  data.tar.gz: 39b1c6c4b9adfd3de8189881c9f13abc0b467756ad5e0ecb948ae46bee1be70e54fe057d86ec2599abe5aef647c8a41f5dae3ca3159072fccd6556b1adf45119

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,75 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-performance
+  - rubocop-sorbet
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: disable
+  UseCache: true
+  SuggestExtensions: false
+  CacheRootDirectory: tmp
+  Exclude:
+    - "test/fixtures/**/*"
+
+Sorbet/ConstantsFromStrings:
+  Enabled: true
+
+Sorbet/ForbidIncludeConstLiteral:
+  Enabled: true
+
+Sorbet/SignatureBuildOrder:
+  Enabled: true
+
+Sorbet/KeywordArgumentOrdering:
+  Enabled: true
+
+Sorbet/ValidSigil:
+  Enabled: true
+
+Performance/AncestorsInclude: # new in 1.7
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument: # new in 1.7
+  Enabled: true
+
+Performance/BlockGivenWithExplicitBlock: # new in 1.9
+  Enabled: true
+
+Performance/CollectionLiteralInLoop: # new in 1.8
+  Enabled: true
+
+Performance/ConstantRegexp: # new in 1.9
+  Enabled: true
+
+Performance/MethodObjectAsBlock: # new in 1.9
+  Enabled: true
+
+Performance/RedundantEqualityComparisonBlock: # new in 1.10
+  Enabled: true
+
+Performance/RedundantSortBlock: # new in 1.7
+  Enabled: true
+
+Performance/RedundantSplitRegexpArgument: # new in 1.10
+  Enabled: true
+
+Performance/RedundantStringChars: # new in 1.7
+  Enabled: true
+
+Performance/ReverseFirst: # new in 1.7
+  Enabled: true
+
+Performance/SortReverse: # new in 1.7
+  Enabled: true
+
+Performance/Squeeze: # new in 1.7
+  Enabled: true
+
+Performance/StringInclude: # new in 1.7
+  Enabled: true
+
+Performance/Sum: # new in 1.8
+  Enabled: true

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in packwerk-haml.gemspec
+gemspec
+
+gem("packwerk", git: "https://github.com/richardmarbach/packwerk", branch: "configurable_parser_interface")
+
+gem("rubocop-performance", require: false)
+gem("rubocop-sorbet", require: false)
+gem("rubocop-shopify", require: false)
+
+group :development do
+  gem("minitest-focus", require: false)
+  gem("ruby-lsp", "~> 0.2.1")
+
+  gem("m")
+  gem("rake")
+  gem("tapioca", require: false)
+  gem("sorbet-static-and-runtime")
+end

data/Gemfile.lock

@@ -0,0 +1,190 @@
+GIT
+  remote: https://github.com/richardmarbach/packwerk
+  revision: 752d37add96b9f4bf28492d7db152f6523b1d29c
+  branch: configurable_parser_interface
+  specs:
+    packwerk (3.1.0)
+      activesupport (>= 6.0)
+      ast
+      better_html
+      bundler
+      constant_resolver (>= 0.2.0)
+      parallel
+      parser
+      sorbet-runtime (>= 0.5.9914)
+      zeitwerk (>= 2.6.1)
+
+PATH
+  remote: .
+  specs:
+    packwerk-haml (0.1.0)
+      ast
+      haml (~> 6.2)
+      parser
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (7.1.1)
+      activesupport (= 7.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    better_html (2.0.2)
+      actionview (>= 6.0)
+      activesupport (>= 6.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      parser (>= 2.4)
+      smart_properties
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    constant_resolver (0.2.0)
+    crass (1.0.6)
+    drb (2.1.1)
+      ruby2_keywords
+    erubi (1.12.0)
+    haml (6.2.3)
+      temple (>= 0.8.2)
+      thor
+      tilt
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    m (1.6.2)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    method_source (1.0.0)
+    minitest (5.20.0)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    mutex_m (0.1.2)
+    netrc (0.11.0)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    prettier_print (1.2.1)
+    racc (1.7.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbi (0.1.1)
+      sorbet-runtime (>= 0.5.9204)
+      yarp (>= 0.11.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.57.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    rubocop-sorbet (0.7.4)
+      rubocop (>= 0.90.0)
+    ruby-lsp (0.2.4)
+      language_server-protocol
+      sorbet-runtime
+      syntax_tree (>= 2.4)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    smart_properties (1.17.0)
+    sorbet (0.5.11072)
+      sorbet-static (= 0.5.11072)
+    sorbet-runtime (0.5.11072)
+    sorbet-static (0.5.11072-universal-darwin)
+    sorbet-static (0.5.11072-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11072)
+      sorbet (= 0.5.11072)
+      sorbet-runtime (= 0.5.11072)
+    spoom (1.2.4)
+      erubi (>= 1.10.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      syntax_tree (>= 6.1.1)
+      thor (>= 0.19.2)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    tapioca (0.11.9)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.1.0, >= 0.1.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.2.0, >= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    temple (0.10.3)
+    thor (1.2.2)
+    tilt (2.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    yard (0.9.34)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    yarp (0.13.0)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  m
+  minitest-focus
+  packwerk!
+  packwerk-haml!
+  rake
+  rubocop-performance
+  rubocop-shopify
+  rubocop-sorbet
+  ruby-lsp (~> 0.2.1)
+  sorbet-static-and-runtime
+  tapioca
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Richard Marbach
+
+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,32 @@
+# Packwerk Haml
+
+Add haml support to [packwerk](https://github.com/Shopify/packwerk/)
+
+## Installation
+
+1. Add the gem to your Gemfile
+
+```ruby
+gem "packwerk-haml"
+```
+
+2. Require `packwerk-haml` in your `packwerk.yml`
+
+```yml
+require:
+  - packwerk-haml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` 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 at https://github.com/richardmarbach/packwerk-haml.
+
+## 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,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop, :sorbet]

data/lib/packwerk_haml/parser.rb

@@ -0,0 +1,64 @@
+# typed: true
+# frozen_string_literal: true
+
+require "haml"
+require "ast/node"
+
+module PackwerkHaml
+  class Parser
+    extend T::Sig
+
+    include ::Packwerk::FileParser
+
+    sig { params(haml_compiler: T.untyped, ruby_parser: ::Packwerk::Parsers::Ruby).void }
+    def initialize(haml_compiler: ::Haml::Engine.new, ruby_parser: ::Packwerk::Parsers::Ruby.new)
+      @haml_compiler = haml_compiler
+      @ruby_parser = ruby_parser
+    end
+
+    sig { override.params(io: T.any(StringIO, IO), file_path: String).returns(T.untyped) }
+    def call(io:, file_path: "<unknown>")
+      parse_template(io.read, file_path: file_path)
+    end
+
+    sig { override.params(path: String).returns(T::Boolean) }
+    def match?(path:)
+      File.extname(path) == ".haml"
+    end
+
+    private
+
+    def parse_template(template, file_path:)
+      compiled = @haml_compiler.call(template)
+      to_ruby_ast(compiled, file_path)
+    rescue EncodingError => e
+      result = ::Packwerk::Parsers::ParseResult.new(file: file_path, message: e.message)
+      raise ::Packwerk::Parsers::ParseError, result
+    rescue ::Parser::SyntaxError => e
+      result = ::Packwerk::Parsers::ParseResult.new(file: file_path, message: "Syntax error: #{e}")
+      raise ::Packwerk::Parsers::ParseError, result
+    end
+
+    def to_ruby_ast(code, file_path)
+      @ruby_parser.call(
+        io: StringIO.new(code),
+        file_path: file_path,
+      )
+    end
+
+    CODE_NODES = [:haml_comment, :silent_script].freeze
+
+    sig { params(node: T.nilable(::Haml::Parser::ParseNode), block: T.untyped).returns(T.untyped) }
+    def code_nodes(node, &block)
+      return enum_for(:code_nodes, node) unless block
+
+      return unless node.is_a?(::Haml::Parser::ParseNode)
+
+      yield node if CODE_NODES.include?(node.type)
+
+      node.children.each do |child|
+        code_nodes(child, &block)
+      end
+    end
+  end
+end

data/lib/packwerk_haml/version.rb

@@ -0,0 +1,6 @@
+# typed: false
+# frozen_string_literal: true
+
+module PackwerkHaml
+  VERSION = "0.1.0"
+end

data/lib/packwerk_haml.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "packwerk"
+require "packwerk_haml/parser"
+
+module PackwerkHaml
+end

data/packwerk-haml.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/packwerk_haml/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "packwerk-haml"
+  spec.version = PackwerkHaml::VERSION
+  spec.authors = ["Richard Marbach"]
+  spec.email = ["rmarbach@gmail.com"]
+
+  spec.summary = "HAML support for packwerk"
+  spec.description = "HAML support for packwerk"
+  spec.homepage = "https://github.com/richardmarbach/packwerk-haml"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/richardmarbach/packwerk-haml"
+  spec.metadata["changelog_uri"] = "https://github.com/richardmarbach/packwerk-haml"
+
+  # 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(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # For Ruby parsing
+  spec.add_dependency("ast")
+  spec.add_dependency("parser")
+
+  # For HAML parsing
+  spec.add_dependency("haml", "~>6.2")
+end

data/sig/packwerk/haml.rbs

@@ -0,0 +1,4 @@
+module Packwerk
+  module Haml
+  end
+end

data/sorbet/config

@@ -0,0 +1,4 @@
+--dir
+.
+--ignore=tmp/
+--ignore=vendor/

data/sorbet/rbi/annotations/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-vendored=true

data/sorbet/rbi/annotations/actionview.rbi

@@ -0,0 +1,75 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This file was pulled from a central RBI files repository.
+# Please run `bin/tapioca annotations` to update it.
+
+module ActionView
+  TemplateError = T.type_alias { Template::Error }
+
+  class MissingTemplate < ActionView::ActionViewError
+    sig { returns(String) }
+    def path; end
+  end
+end
+
+class ActionView::Helpers::FormBuilder
+  sig { returns(T.untyped) }
+  def object; end
+end
+
+module ActionView::Helpers::NumberHelper
+  sig { params(number: T.untyped, options: T::Hash[T.untyped, T.untyped]).returns(T.nilable(String)) }
+  def number_to_currency(number, options = T.unsafe(nil)); end
+
+  sig { params(number: T.untyped, options: T::Hash[T.untyped, T.untyped]).returns(T.nilable(String)) }
+  def number_to_human(number, options = T.unsafe(nil)); end
+
+  sig { params(number: T.untyped, options: T::Hash[T.untyped, T.untyped]).returns(T.nilable(String)) }
+  def number_to_human_size(number, options = T.unsafe(nil)); end
+
+  sig { params(number: T.untyped, options: T::Hash[T.untyped, T.untyped]).returns(T.nilable(String)) }
+  def number_to_percentage(number, options = T.unsafe(nil)); end
+
+  sig { params(number: T.untyped, options: T::Hash[T.untyped, T.untyped]).returns(T.nilable(String)) }
+  def number_to_phone(number, options = T.unsafe(nil)); end
+
+  sig { params(number: T.untyped, options: T::Hash[T.untyped, T.untyped]).returns(T.nilable(String)) }
+  def number_with_delimiter(number, options = T.unsafe(nil)); end
+
+  sig { params(number: T.untyped, options: T::Hash[T.untyped, T.untyped]).returns(T.nilable(String)) }
+  def number_with_precision(number, options = T.unsafe(nil)); end
+end
+
+module ActionView::Helpers::SanitizeHelper
+  mixes_in_class_methods ActionView::Helpers::SanitizeHelper::ClassMethods
+end
+
+module ActionView::Helpers::UrlHelper
+  extend ActiveSupport::Concern
+  include ActionView::Helpers::TagHelper
+  mixes_in_class_methods ActionView::Helpers::UrlHelper::ClassMethods
+
+  sig { params(name: T.nilable(String), options: T.untyped, html_options: T.untyped, block: T.untyped).returns(ActiveSupport::SafeBuffer) }
+  def link_to(name = nil, options = nil, html_options = nil, &block); end
+
+  sig { params(condition: T.untyped, name: String, options: T.untyped, html_options: T.untyped, block: T.untyped).returns(T.untyped) }
+  def link_to_if(condition, name, options = {}, html_options = {}, &block); end
+end
+
+module ActionView::Layouts
+  mixes_in_class_methods ActionView::Layouts::ClassMethods
+end
+
+module ActionView::Rendering
+  mixes_in_class_methods ActionView::Rendering::ClassMethods
+end
+
+module ActionView::ViewPaths
+  mixes_in_class_methods ActionView::ViewPaths::ClassMethods
+end
+
+module ActionView::ViewPaths::ClassMethods
+  sig { params(value: T.any(String, T::Array[String])).void }
+  def append_view_path(value); end
+end