heckler 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605da338e5d75dfc3615fd7255390559228de9223cea8c4696a7781f64b7d33f
-  data.tar.gz: 067dfae307730437b0d5bae6a90e06f9033ab0f479469234d11da2dde64bff92
+  metadata.gz: 9733f79bc2c0954718b84cef40e963eea19e61093d1afc6f3bb9fae077d7a342
+  data.tar.gz: 4c383a199322fca8fcc1efb8a1420bb3b6900b998557c839b534d1b7c609009e
 SHA512:
-  metadata.gz: 0e84e49df096985d552c49bd91d9bae548904174d743c5ca6288884e9494ce4be5e5a4601f900b967334500b376e113c719888fbaa91ace5a02ef405b955d8bc
-  data.tar.gz: 3b1f705402cb5e522ee4f47d8652947ac1cb56b6e1d2ff539e2fd9d616b15e55a497f173295acbc917d58464fa79e9ab37e35fb03426b8871fad9cb4facfa12e
+  metadata.gz: edf2983e808bdbc69173410794727734284fb1bead0a607a06dcd809ca848270fea42d4f211f6f50a668fdca67603f2afcc6328514c9faac4fa1946bc188a806
+  data.tar.gz: 8fe464cd042f1ec1b2809515ba3b81ff9ea0afe638017db7d092da1fcf962a96ae8810edc3ddb4cda516233308cfdef10339a1fc13bb4a84072df1ecf17f7003

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 ## [Unreleased]
-
-## [0.1.0] - 2025-01-16
-
+## [0.0.2] - 2025-01-19
+- CLI working as expected: shows end result to users and code is in bin/heckler file.
+## [0.0.1] - 2025-01-16
 - Initial release

data/bin/heckler

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/heckler'
+
+$stdout.sync = true
+require 'optparse'
+
+command = ARGV.shift
+
+case command
+when 'init'
+  Config.init
+when nil
+  config = Heckler::Config.instance
+  aspell = Heckler::Aspell.new(config)
+  directory = Dir.pwd
+  @checkers = [Heckler::Checker::FileSystem.new(config, aspell)]
+  issues = []
+
+  @checkers.each do |checker|
+    issues.concat(checker.check(directory))
+  end
+
+  puts issues.inspect
+else
+  puts "Unknown command: #{command}"
+  puts 'Available commands: init, or no command for default behavior'
+end

data/lib/heckler/aspell.rb

@@ -1,5 +1,5 @@
-require "open3"
-require_relative "config"
+require 'open3'
+require_relative 'config'
 
 Misspelling = Data.define(:word, :suggestions)
 
@@ -19,8 +19,7 @@ module Heckler
     private
 
     def get_misspellings(text)
-      misspellings = run(text)
-      misspellings
+      run(text)
     end
 
     def take_suggestions(suggestions)
@@ -29,17 +28,18 @@ module Heckler
     end
 
     def run(text)
-      stdin, stdout, stderr, wait_thr = Open3.popen3("aspell", "--encoding", "utf-8", "-a", "--ignore-case", "--lang=en_US", "--sug-mode=ultra")
+      stdin, stdout, stderr, _wait_thr = Open3.popen3('aspell', '--encoding', 'utf-8', '-a', '--ignore-case',
+                                                      '--lang=en_US', '--sug-mode=ultra')
       stdin.puts text
       stdin.close
       output = stdout.read
       stdout.close
       stderr.close
 
-      output.lines.select { |line| line.start_with?("&") }.map do |line|
-        word_metadata, suggestions = line.strip.split(":")
-        word = word_metadata.split(" ")[1]
-        suggestions = suggestions.strip.split(", ")
+      output.lines.select { |line| line.start_with?('&') }.map do |line|
+        word_metadata, suggestions = line.strip.split(':')
+        word = word_metadata.split(' ')[1]
+        suggestions = suggestions.strip.split(', ')
         Misspelling.new(word, take_suggestions(suggestions))
       end
     end

data/lib/heckler/checker/file_system.rb

@@ -1,6 +1,6 @@
-require_relative "../aspell"
+require_relative '../aspell'
 
-require "find"
+require 'find'
 
 # The Checker::FileSystem class provides functionality to check spelling in file and directory names within a given directory structure.
 #
@@ -30,21 +30,18 @@ module Heckler
       def check(directory)
         files_or_directories = []
         Find.find(directory) do |path|
-          next if File.basename(path).start_with?(".")
-          next if File.fnmatch("*/.git/*", path)
+          next if File.basename(path).start_with?('.')
+          next if File.fnmatch('*/.*/*', path)
 
           files_or_directories << path
         end
 
-
         files_or_directories.sort_by! { |path| File.realpath(path) }
 
-        puts files_or_directories
-
         issues = []
 
         files_or_directories.each do |file_or_directory|
-          name = SpellcheckFormatter.format(File.basename(file_or_directory, ".*"))
+          name = SpellcheckFormatter.format(File.basename(file_or_directory, '.*'))
           new_issues = @spellchecker.check(name).map do |misspelling|
             Issue.new(misspelling, File.realpath(file_or_directory), 0)
           end
@@ -60,10 +57,10 @@ module Heckler
   class SpellcheckFormatter
     def self.format(input)
       # Remove leading underscores
-      input = input.gsub(/^_+/, "")
+      input = input.gsub(/^_+/, '')
 
       # Replace underscores and dashes with spaces
-      input = input.tr("_-", " ")
+      input = input.tr('_-', ' ')
 
       # Insert spaces between lowercase and uppercase letters (camelCase or PascalCase)
       input = input.gsub(/([a-z])([A-Z])/, '\1 \2')
@@ -72,7 +69,7 @@ module Heckler
       input = input.gsub(/([A-Z]+)([A-Z][a-z])/, '\1 \2')
 
       # Replace multiple spaces with a single space
-      input = input.gsub(/\s+/, " ")
+      input = input.gsub(/\s+/, ' ')
 
       # Convert the final result to lowercase
       input.downcase

data/lib/heckler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Heckler
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/heckler.rb

@@ -3,8 +3,11 @@
 # @see https://github.com/peckphp/peck
 ##
 
-require_relative "heckler/version"
-require_relative "heckler/cli"
+require_relative 'heckler/config'
+require_relative 'heckler/aspell'
+require_relative 'heckler/preset'
+require_relative 'heckler/checker/file_system'
+require_relative 'heckler/version'
 
 module Heckler
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heckler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-01-19 00:00:00.000000000 Z
 dependencies: []
 description: "**Heckler** is a tool to identify wording or spelling mistakes in ruby
   codebase: filenames, class names, method names, property names and more. Spelling
@@ -25,14 +25,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- exe/heckler
+- bin/heckler
 - heckler.json
 - lib/heckler.rb
 - lib/heckler/aspell.rb
 - lib/heckler/checker/file_system.rb
-- lib/heckler/cli.rb
 - lib/heckler/config.rb
-- lib/heckler/personn.rb
 - lib/heckler/preset.rb
 - lib/heckler/presets/base.stub
 - lib/heckler/version.rb

data/exe/heckler

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-require "heckler"
-
-puts "test"
-Heckler::CLI.start(ARGV)

data/lib/heckler/cli.rb

@@ -1,50 +0,0 @@
-require 'optparse'
-
-require_relative "config"
-require_relative "aspell"
-require_relative "preset"
-require_relative "checker/file_system"
-
-
-module Heckler
-  class Runner
-    attr_reader :checkers
-
-    def initialize(checkers)
-      @checkers = checkers
-    end
-
-    def run(directory)
-      issues = []
-
-      puts directory
-
-      @checkers.each do |checker|
-        issues.concat(checker.check(directory))
-      end
-
-      issues
-    end
-  end
-
-  class CLI
-    def self.start(args)
-      command = args.shift
-
-      case command
-      when 'init'
-        Config.init
-      when nil
-        config = Config.instance
-        aspell = Aspell.new(config)
-
-        Runner.new([
-          Heckler::Checker::FileSystem.new(config, aspell)
-        ]).run(Dir.pwd)
-      else
-        puts "Unknown command: #{command}"
-        puts "Available commands: init, or no command for default behavior"
-      end
-    end
-  end
-end