guard-erb_lint 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fe12d40b4e1c38625cd2830321689bd18575b94616636da61db7c8f09b71eb0
+  data.tar.gz: d65a561d01be8049ea66bdc642f4b08d6fdc93b870a013b79c7f21eb9a0b3972
+SHA512:
+  metadata.gz: 948e49a3addf86d4382761f1c8a7f4689becdc7f360333aca90af2e7e2998f08949b2f2867e38ae88580d18b89aa87fd45a7838aa94a6e2a8d975d177988351b
+  data.tar.gz: 4ffa54b6b8089c4cf8671c5052d9c250d80afa955bdf0d025f3d97cabe5668af76d2fbc56b0e39b784ee586f2050fc2cbb92332b163fce0d75fe02ab89d599c4

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle/
+/tmp/
+/.idea/

data/.rubocop.yml

@@ -0,0 +1,49 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-rspec
+
+AllCops:
+  EnabledByDefault: true
+  NewCops: enable
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+Style/MissingElse:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/Copyright:
+  Enabled: false
+Style/ConstantVisibility:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: false
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+Style/OpenStructUse:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - lib/guard/erb_lint/templates/Guardfile
+
+Metrics/BlockLength:
+  Exclude:
+    - Guardfile
+    - spec/**/*
+Metrics/MethodLength:
+  Max: 20
+Metrics/AbcSize:
+  Max: 20
+
+Lint/NumberConversion:
+  Enabled: false
+Lint/ConstantResolution:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in guard-erb_lint.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: .
+  specs:
+    guard-erb_lint (1.0.1)
+      activesupport
+      erb_lint
+      guard-compat (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    better_html (1.0.16)
+      actionview (>= 4.0)
+      activesupport (>= 4.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      html_tokenizer (~> 0.0.6)
+      parser (>= 2.4)
+      smart_properties
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    erb_lint (0.1.1)
+      activesupport
+      better_html (~> 1.0.7)
+      html_tokenizer
+      parser (>= 2.7.1.4)
+      rainbow
+      rubocop
+      smart_properties
+    erubi (1.10.0)
+    ffi (1.15.4)
+    formatador (0.3.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rubocop (1.5.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
+    html_tokenizer (0.0.7)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    listen (3.7.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.15.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nenv (0.3.0)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.3-x86_64-linux)
+      racc (~> 1.4)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.21.0)
+    parser (3.0.3.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    rainbow (3.0.0)
+    rake (13.0.0)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.14.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    rubocop-shopify (2.3.0)
+      rubocop (~> 1.22)
+    ruby-progressbar (1.11.0)
+    shellany (0.0.1)
+    smart_properties (1.17.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  guard
+  guard-erb_lint!
+  guard-rubocop
+  rake (= 13.0)
+  rubocop
+  rubocop-rspec
+  rubocop-shopify
+
+BUNDLED WITH
+   2.2.3

data/Guardfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+guard(:erb_lint) do
+  watch(/.+\.erb$/)
+  watch(/.+\.html$/)
+end
+
+guard(:rubocop) do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mathias H Steffensen
+
+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,34 @@
+# Guard::ErbLint
+
+Automatically lints your ERB view files using [Guard](https://github.com/guard/guard) and the [Shopify/erb_lint](https://github.com/Shopify/erb-lint) gem.
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem("guard-erb_lint", git: "https://github.com/Driversnote-Dev/guard-erb_lint")
+```
+
+And then execute:
+
+```bash
+bundle install
+bundle exec guard init erb_lint
+```
+
+Or just add the following to your Guardfile:
+```ruby
+guard(:erb_lint) do
+  watch(/.+\.erb$/)
+  watch(/.+\.html$/)
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Driversnote-Dev/guard-erb_lint.
+
+## 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,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "guard/erb_lint"
+
+# 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,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+bundle check

data/guard-erb_lint.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-erb_lint"
+  spec.version       = "1.0.1"
+  spec.authors       = ["Mathias H Steffensen"]
+  spec.email         = ["mathiashsteffensen@protonmail.com"]
+
+  spec.summary       = "Guard plugin for erb_lint"
+  spec.homepage      = "https://github.com/Driversnote-Dev/guard-erb_lint"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  spec.files =
+    Dir.chdir(File.expand_path(__dir__)) do
+      %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:spec|features)/}) }
+    end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("activesupport")
+  spec.add_dependency("erb_lint")
+  spec.add_dependency("guard-compat", ">= 1")
+
+  spec.add_development_dependency("rake", "13.0")
+
+  spec.add_development_dependency("guard")
+  spec.add_development_dependency("guard-rubocop")
+
+  spec.add_development_dependency("rubocop")
+  spec.add_development_dependency("rubocop-rspec")
+  spec.add_development_dependency("rubocop-shopify")
+end

data/lib/guard/erb_lint/options.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Guard
+  class ErbLint < Plugin
+    module Options
+      DEFAULTS = { all_on_start: true, all_on_change: false }
+
+      def self.with_defaults(options)
+        DEFAULTS.each do |k, v|
+          options[k] = v if options.key?(k)
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/guard/erb_lint/templates/Guardfile

@@ -0,0 +1,4 @@
+guard(:erb_lint) do
+  watch(/.+\.erb$/)
+  watch(/.+\.html$/)
+end

data/lib/guard/erb_lint.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+require "guard/compat/plugin"
+require "erb_lint/cli"
+
+require "guard/erb_lint/options"
+
+module Guard
+  class ErbLint < Plugin
+    # Initializes a Guard plugin.
+    # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
+    #
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from a watcher
+    #
+    def initialize(options = {})
+      @options = Guard::ErbLint::Options.with_defaults(options).with_indifferent_access
+      super
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+      Compat::UI.info("Guard::ERBLint initialized")
+      run_all if @options[:all_on_start]
+    rescue StandardError
+      throw(:task_has_failed)
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    #
+    def run_all
+      run("--lint-all")
+    rescue StandardError
+      throw(:task_has_failed)
+    end
+
+    # Called on file(s) additions that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    # @return [Object] the task result
+    #
+    def run_on_additions(paths)
+      run_all_or_block { run(*paths) }
+    end
+
+    # Called on file(s) modifications that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_modifications has failed
+    # @return [Object] the task result
+    #
+    def run_on_modifications(paths)
+      run_all_or_block { run(*paths) }
+    end
+
+    def run(*args)
+      cli = ERBLint::CLI.new
+
+      Compat::UI.info("Running ERBLint with args #{args.join(", ")}")
+
+      cli.run(args)
+    end
+
+    private
+
+    def run_all_or_block
+      throw_on_err do
+        if @options[:all_on_change]
+          run_all
+        else
+          yield
+        end
+      end
+    end
+
+    def throw_on_err
+      yield
+    rescue StandardError
+      throw(:task_has_failed)
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: guard-erb_lint
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Mathias H Steffensen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: erb_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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-shopify
+  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:
+email:
+- mathiashsteffensen@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- guard-erb_lint.gemspec
+- lib/guard/erb_lint.rb
+- lib/guard/erb_lint/options.rb
+- lib/guard/erb_lint/templates/Guardfile
+homepage: https://github.com/Driversnote-Dev/guard-erb_lint
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Driversnote-Dev/guard-erb_lint
+  source_code_uri: https://github.com/Driversnote-Dev/guard-erb_lint
+  changelog_uri: https://github.com/Driversnote-Dev/guard-erb_lint/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Guard plugin for erb_lint
+test_files: []