char_detector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65f7fd5b56afb4495f46814a0b0fe7eca1926667db335156cae6e11d34252cd6
+  data.tar.gz: 6aab56d1925f648341ff07fcc1ceadfa3c60a06116cfb59cd7796ce21c10d857
+SHA512:
+  metadata.gz: 4cacc22143704d0fc681ef46437c3439762026492969ca17e6ddf87b9e9032e41b66972c9dcce3b9f8c340929fce4606f5b1a34f271c2cfd9afb17c67547350b
+  data.tar.gz: 7137b411dc9496836e8be43d1c74d8855ccddfebc71b5a5411bf04cd07571f0aaaa383324a660a8ad31e93c086392ff1ecd98a3b53619c98bee017fc1aefc403

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby:
+          - '3.1.1'
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.ruby-version

@@ -0,0 +1 @@
+3.1.1

data/.tool-versions

@@ -0,0 +1,2 @@
+ruby 3.1.1
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ljw532344863@sina.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+ruby File.read('.ruby-version')
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    char_detector (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  char_detector!
+  pry
+  rake
+  rspec
+
+RUBY VERSION
+   ruby 3.1.1p18
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 lijunwei
+
+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,113 @@
+# CharDetector
+
+## What
+
+This tool helps find whether a file contains [ASCII control characters](https://theasciicode.com.ar/), print location info if true.
+
+## Why
+
+It's annoying while working with sublime search. If a file somehow contains a ASCII control characters, it'll be treated as "binary" and won't show the result preview. And this kind of "binary" files tweaks the behavior of text editor.
+
+So I'd like to find these files and get rid of these control characters very much.
+
+![](./image/Xnip2022-05-08_13-52-58.png)
+
+Ref: [ASCII table , ascii codes](https://theasciicode.com.ar/)
+
+## Roadmap
+
++ Google keyword: "sublime search result binary"
+    + result: https://stackoverflow.com/questions/26030179/sublime-text-find-in-files-gives-binary-in-the-find-results
+    + result: https://exchangetuts.com/sublime-text-find-in-files-gives-binary-in-the-find-results-1640166664392553
+    + these two results above are not helpful
+    + result: https://blog.csdn.net/wozhouwang/article/details/101672976 (this one actually is the solution in python, but I didn't understand "control character" yet)
++ I reviewed [character encoding notes/unicode](https://github.com/liijunwei/practice/tree/main/unicode)
++ I found that if I open the abnormal file with vim, the character show up, I google search taught me that they are control characters
+    + [search with [[:cntrl:]] in vim](https://stackoverflow.com/questions/3844311/how-do-i-replace-or-find-non-printable-characters-in-vim-regex)
++ I found a word called ["POSIX bracket expressions"](https://www.regular-expressions.info/posixbrackets.html)
+    + I found the ruby version in [Ruby Core Doc@Regexp](https://ruby-doc.org/core-3.1.2/Regexp.html#class-Regexp-label-Character+Properties)
++ I wrote a temperary ruby script scanning abnormal files
++ I setup a ruby gem and TDD my script
+    + bundle gem char_detector
++ Test and fix and refactor
+
++ TODO refactor
++ TODO add features(If I have more requirements)
++ TODO format output(refer to rubocop's output) Thanks Freebird
+
+## Installation(WIP)
+
+Add this line to your application's Gemfile:
+
++ TODO publish this gem to https://rubygems.org/
+
+```ruby
+gem 'char_detector'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install char_detector
+```
+
+## Usage
+
+### demo on detecting in single file
+
+```bash
+bin/char_detector -f spec/samples/sample0.txt
+bin/char_detector -f spec/samples/sample1-newline.txt
+bin/char_detector -f spec/samples/sample2.txt
+bin/char_detector -f spec/samples/sample3.txt
+bin/char_detector -f spec/samples/sample4.txt
+bin/char_detector -f spec/samples/sample5.txt
+```
+
+![](./image/Xnip2022-05-08_14-10-52.png)
+
+### demo on detecting in file directory and file pattern
+
+```bash
+# parallel is GNU parallel to speed up the scanning process
+# macos: https://formulae.brew.sh/formula/parallel
+
+# with pattern
+parallel --progress --timeout 50 --retries 3 "bin/char_detector -f {}" ::: $(find spec/samples -name \*.txt)
+parallel --progress --timeout 50 --retries 3 "bin/char_detector -f {}" ::: $(find spec/samples -name \*.md)
+parallel --progress --timeout 50 --retries 3 "bin/char_detector -f {}" ::: $(find spec/samples -name \*.rb)
+
+# for all files in directory
+# may have unexpected errors :(
+parallel --progress --timeout 50 --retries 3 "bin/char_detector -f {}" ::: $(find spec/samples -type f)
+# same as
+find spec/samples -type f | parallel --progress --timeout 50 --retries 3 "bin/char_detector -f {}"
+# same as
+find spec/samples -type f | xargs -I {} bin/char_detector -f {} # this one is slow, so GNU parallel is recommended :D
+```
+![](./image/Xnip2022-05-08_14-11-04.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/[USERNAME]/char_detector. 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/[USERNAME]/char_detector/blob/master/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 CharDetector project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/char_detector/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/char_detector

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "char_detector"
+require 'optparse'
+require 'pry'
+require 'json'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: char_detector [options]"
+
+  opts.on("-h", "--help", "Show this message.") do
+    puts opts
+    exit 0
+  end
+
+  opts.on("-f FILE", "--file FILE", "file to scan") do |v|
+    options[:file] = v
+  end
+
+  opts.on("-p", "--pretty", "pretty report.") do
+    options[:pretty] = true
+  end
+
+  opts.on("-v", "--version", "cli version") do |v|
+    puts "CharDetector v#{CharDetector::VERSION}"
+    exit(0)
+  end
+end.parse!
+
+info = {}
+info[:file]   = options[:file]
+info[:result] = CharDetector::Engine.new(file: options[:file]).scan
+
+unless info[:result].empty?
+  if options[:pretty]
+    jj info
+  else
+    puts info.to_json
+  end
+end
+
+exit 0

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "char_detector"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/char_detector.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/char_detector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "char_detector"
+  spec.version       = CharDetector::VERSION
+  spec.authors       = ["lijunwei"]
+  spec.email         = ["ljw532344863@sina.com"]
+
+  spec.summary       = %q{Initially used for detecting control character in markdown/ruby file.}
+  spec.description   = %q{Initially used for detecting control character in markdown/ruby file.}
+  spec.homepage      = "https://github.com/liijunwei/char_detector"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/liijunwei/char_detector"
+  spec.metadata["changelog_uri"] = "https://github.com/liijunwei/char_detector"
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.executables   = ["char_detector"]
+  spec.require_paths = ["lib"]
+end

data/lib/char_detector/engine.rb

@@ -0,0 +1,34 @@
+class CharDetector::Engine
+  def initialize(file:)
+    @file = file
+  end
+
+  attr_reader :file
+
+  def scan
+    matches = []
+
+    File.readlines(file).each_with_index do |line, index|
+      scanned = trim_newline(line).scan(/\p{Cntrl}/)
+      scanned -= trim_newline(line).scan(/\p{Space}/)
+
+      next if scanned.empty?
+
+      hash = {}
+      hash[:line]    = index + 1
+      hash[:columns] = scanned.map { |e| line.index(e)+1 }
+
+      matches << hash
+    end
+
+    return matches
+  end
+
+  def trim_newline(line)
+    if line.end_with?("\n")
+      line[...-1]
+    else
+      line
+    end
+  end
+end

data/lib/char_detector/version.rb

@@ -0,0 +1,3 @@
+module CharDetector
+  VERSION = "0.1.0"
+end

data/lib/char_detector.rb

@@ -0,0 +1,7 @@
+require "char_detector/version"
+require "char_detector/engine"
+
+module CharDetector
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: char_detector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lijunwei
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  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: 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'
+description: Initially used for detecting control character in markdown/ruby file.
+email:
+- ljw532344863@sina.com
+executables:
+- char_detector
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".tool-versions"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/char_detector
+- bin/console
+- bin/setup
+- char_detector.gemspec
+- image/Xnip2022-05-08_13-52-58.png
+- image/Xnip2022-05-08_14-10-52.png
+- image/Xnip2022-05-08_14-11-04.png
+- lib/char_detector.rb
+- lib/char_detector/engine.rb
+- lib/char_detector/version.rb
+homepage: https://github.com/liijunwei/char_detector
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/liijunwei/char_detector
+  source_code_uri: https://github.com/liijunwei/char_detector
+  changelog_uri: https://github.com/liijunwei/char_detector
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Initially used for detecting control character in markdown/ruby file.
+test_files: []