immosquare-cleaner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99d7d3985550b02c0e29de7fe0934b9b3190f82961570d671fbc45a4fdfe8f17
+  data.tar.gz: 655b87bc65f6b485050f8ee616ecb8601d8b130d619bdfe9856ce3b8a8d5c280
+SHA512:
+  metadata.gz: 8e01de397011a5a527e8fcd3f931ca4b66b7d3851d52315f10a58e7d18b8da79c8d82f71cddc19f2af7933916bf91e2464751196ee6880e2f8590611c485a623
+  data.tar.gz: 41b6a114cb2c420227afe547b3cccfb6f350afb19c8202a4ce7453348a4438b45ffbebcb0fcf11e934845324b87a72e1d141ab5e8a4861df1479c1349df51518

data/bin/immosquare-cleaner

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require "immosquare_cleaner"
+require "optparse"
+
+options = {}
+
+##===========================================================================##
+## optparse is a standard library of ruby, it's used to parse command line   ##
+##===========================================================================##
+OptionParser.new do |opts|
+  opts.banner = "Usage: immosquare-cleaner [options] file"
+
+  ##===========================================================================##
+  ## Capture all single-letter options (like '-t', '-a', etc.)                 ##
+  ##===========================================================================##
+  ("a".."z").each do |letter|
+    opts.on("-#{letter} [OPTION]", "Option -#{letter}") do |value|
+      options[letter.to_sym] = value
+    end
+  end
+
+  ##===========================================================================##
+  ## If you also want to capture longer options, add them here                 ##
+  ## Example:                                                                  ##
+  ## opts.on("--tag TAG", "Tag option") do |t|                                 ##
+  ##   options[:tag] = t                                                       ##
+  ## end                                                                       ##
+  ##===========================================================================##
+end.parse!
+
+##===========================================================================##
+## Check if the file path is provided                                         ##
+##===========================================================================##
+file_path = ARGV[0]
+if !file_path
+  puts("Error: Please provide a file path.")
+  exit 1
+end
+
+##===========================================================================##
+## Check if the file exists                                                   ##
+##===========================================================================##
+if !File.exist?(file_path)
+  puts("Error: The file '#{file_path}' does not exist.")
+  exit 1
+end
+
+
+##===========================================================================##
+## We can now call the clean method, passing the file path and options        ##
+##===========================================================================##
+ImmosquareCleaner.clean(file_path, **options)

data/lib/immosquare-cleaner/configuration.rb

@@ -0,0 +1,16 @@
+module ImmosquareCleaner
+  class Configuration
+
+    attr_accessor :rubocop_options, :htmlbeautifier_options, :erblint_options
+
+    def initialize
+      @rubocop_options        = nil
+      @htmlbeautifier_options = nil
+      @erblint_options        = nil
+    end
+
+
+
+
+  end
+end

data/lib/immosquare-cleaner/railtie.rb

@@ -0,0 +1,9 @@
+module ImmosquareYaml
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      load "tasks/immosquare-cleaner.rake"
+    end
+
+  end
+end

data/lib/immosquare-cleaner/version.rb

@@ -0,0 +1,3 @@
+module ImmosquareCleaner
+  VERSION = "0.1.0".freeze
+end

data/lib/immosquare_cleaner.rb

@@ -0,0 +1,136 @@
+require          "immosquare-yaml"
+require_relative "immosquare-cleaner/configuration"
+require_relative "immosquare-yaml/railtie" if defined?(Rails)
+
+module ImmosquareCleaner
+  class << self
+
+    ##===========================================================================##
+    ## Constants
+    ##===========================================================================##
+    SHEBANG = "#!/usr/bin/env ruby".freeze
+
+    ##===========================================================================##
+    ## Gem configuration
+    ##===========================================================================##
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def config
+      yield(configuration)
+    end
+
+    def clean(file_path, **options)
+      ##============================================================##
+      ## Default options
+      ##============================================================##
+      cmd     = []
+      options = {}.merge(options)
+
+
+      begin
+        raise("Error: The file '#{file_path}' does not exist.") if !File.exist?(file_path)
+
+        ##============================================================##
+        ## We normalize the last line of the file to ensure it ends with a single
+        ##============================================================##
+        normalize_last_line(file_path)
+
+        ##============================================================##
+        ## We clean files based on their extension
+        ##============================================================##
+        if file_path.end_with?(".html.erb")
+          cmd << [true, "bundle exec htmlbeautifier #{file_path} #{ImmosquareCleaner.configuration.htmlbeautifier_options || "--keep-blank-lines 4"}"]
+          cmd << [true, "bundle exec erblint -c #{gem_root}/linters/erb-lint.yml #{file_path} #{ImmosquareCleaner.configuration.erblint_options || "--autocorrect"}"]
+        elsif file_path.end_with?(".rb", ".rake", "Gemfile", "Rakefile", ".axlsx", ".gemspec", ".ru", ".podspec", ".jbuilder", ".rabl", ".thor", "config.ru", "Berksfile", "Capfile", "Guardfile", "Podfile", "Thorfile", "Vagrantfile") || File.open(file_path, &:gets)&.include?(SHEBANG)
+          cmd << [true, "bundle exec rubocop -c #{gem_root}/linters/rubocop.yml #{file_path} #{ImmosquareCleaner.configuration.rubocop_options || "--autocorrect-all"}"]
+        elsif file_path =~ %r{locales/.*\.yml$}
+          ImmosquareYaml.clean(file_path)
+        elsif npx_installed? && prettier_installed?
+          prettier_parser = nil
+          prettier_parser = "--parser markdown" if file_path.end_with?(".md.erb")
+          cmd << [false, "npx prettier --write #{file_path} #{prettier_parser} --config #{gem_root}/linters/prettier.yml"]
+        else
+          puts("Warning: npx and/or prettier are not installed. Skipping formatting.")
+        end
+
+
+
+        ##===========================================================================##
+        ## We change the current directory to the gem root to ensure the gem's paths
+        ## are used when executing the commands
+        ##===========================================================================##
+        cmd.each do |from_gem_root, c|
+          if from_gem_root
+            Dir.chdir(gem_root) { system(c) }
+          else
+            system(c)
+          end
+        end if !cmd.empty?
+      rescue StandardError => e
+        puts(e.message)
+        false
+      end
+    end
+
+
+    private
+
+    def gem_root
+      File.expand_path("..", __dir__)
+    end
+
+    def npx_installed?
+      system("which npx > /dev/null 2>&1")
+    end
+
+    def prettier_installed?
+      system("npx prettier --version > /dev/null 2>&1")
+    end
+
+    ##===========================================================================##
+    ## This method ensures the file ends with a single newline, facilitating
+    ## cleaner multi-line blocks. It operates by reading all lines of the file,
+    ## removing any empty lines at the end, and then appending a newline.
+    ## This guarantees the presence of a newline at the end, and also prevents
+    ## multiple newlines from being present at the end.
+    ##
+    ## Params:
+    ## +file_path+:: The path to the file to be normalized.
+    ##
+    ## Returns:
+    ## The total number of lines in the normalized file.
+    ##===========================================================================##
+    def normalize_last_line(file_path)
+      ##============================================================##
+      ## Read all lines from the file
+      ## https://gist.github.com/guilhermesimoes/d69e547884e556c3dc95
+      ##============================================================##
+      content = File.read(file_path)
+
+      ##===========================================================================##
+      ## Remove all trailing empty lines at the end of the file
+      content.gsub!(/#{Regexp.escape($INPUT_RECORD_SEPARATOR)}+\z/, "")
+      ##===========================================================================##
+
+      ##===========================================================================##
+      ## Append a newline at the end to maintain the file structure
+      ###===========================================================================##
+      content += $INPUT_RECORD_SEPARATOR
+
+      ##===========================================================================##
+      ## Write the modified lines back to the file
+      ##===========================================================================##
+      File.write(file_path, content)
+
+      ##===========================================================================##
+      ## Return the total number of lines in the modified file
+      ##===========================================================================##
+      content.lines.size
+    end
+
+  end
+end

data/lib/tasks/immosquare-cleaner.rake

@@ -0,0 +1,11 @@
+namespace :immosquare_cleaner do
+  ##============================================================##
+  ## Function to clean translation files in rails app
+  ##============================================================##
+  desc "Clean translation files in rails app"
+  task :clean => :environment do
+    Dir.glob("#{Rails.root}/*").each do |file|
+      ImmosquareCleaner.clean(file)
+    end
+  end
+end

data/linters/erb-lint.yml

@@ -0,0 +1,13 @@
+EnableDefaultLinters: true
+linters:
+  NoJavascriptTagHelper:
+    enabled: false
+  SpaceInHtmlTag:
+    enabled: false
+  Rubocop:
+    enabled: true
+    rubocop_config:
+      inherit_from:
+        - linters/rubocop.yml
+      Layout/TrailingWhitespace:
+        Enabled: false

data/linters/prettier.yml

@@ -0,0 +1,12 @@
+# https://www.prettier.cn/docs/options.html
+printWidth: 10000
+tabWidth: 2
+useTabs: false
+semi: false
+singleQuote: false
+quoteProps: "as-needed"
+trailingComma: "none"
+bracketSpacing: true
+arrowParens: "always"
+endOfLine: "lf"
+singleAttributePerLine: false

data/linters/rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  immosquare-rubocop: rubocop.yml

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: immosquare-cleaner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IMMO SQUARE
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-29 00:00:00.000000000 Z
+dependencies:
+- !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: htmlbeautifier
+  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: immosquare-rubocop
+  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: immosquare-yaml
+  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'
+description: Immosquare-cleaner streamlines Rails applications by running tools like
+  RuboCop, ERBLint, Stylelint and more. It ensures code quality, readability, and
+  consistency across the application.
+email:
+- jules@immosquare.com
+executables:
+- immosquare-cleaner
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/immosquare-cleaner
+- lib/immosquare-cleaner/configuration.rb
+- lib/immosquare-cleaner/railtie.rb
+- lib/immosquare-cleaner/version.rb
+- lib/immosquare_cleaner.rb
+- lib/tasks/immosquare-cleaner.rake
+- linters/erb-lint.yml
+- linters/prettier.yml
+- linters/rubocop.yml
+homepage: https://github.com/IMMOSQUARE/Immosquare-cleaner
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- linters
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: A gem to lint and organize files in a Rails application.
+test_files: []