char_detector 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bee172d7cfc38714ed519dfa6f709ddf52d1ffdc0c40bc23cf0480b545d865e7
-  data.tar.gz: 636ba79305d27b11734a4e10644cf226364f0464423a4c4be9b6f75e50829426
+  metadata.gz: 15caadfd5032900dbf206ad06f7b73b71beab22fa7d04346ba3996ef93b6ea04
+  data.tar.gz: ec2649c362c86e24a02ade24fffa08409771434276e2da330b154ecbe5917bea
 SHA512:
-  metadata.gz: 9566d3608f20d782b16e5abc63252c98efebae4436371a730fa47a4417f6dac4e91781f7287febff42793b7ffb5771a0a0f19b2d2bd55437a78e7077527b5182
-  data.tar.gz: c16121f0a6b0ec8fc277d718bee151ff34901870a6506c9226fd71231513bbd8e9ac68d6f1834180cd7209d0686fd3b6842bd02ecd1e2d3a45867888b70c922e
+  metadata.gz: ba42566dbae9a7d0bf420153e75d9f86bccf4419c7e92e5ad1e48482fb849af7ad2cf365e46159f01f51df4da6c9ced7541d3cf297595e7fe4298832ff0bafac
+  data.tar.gz: e984bf6d160f7a7dba5b9542753eebc541a2ac162580a4fcb4140f22418043144401962262c2161984b6826823fb6afcea50b42d2d9e0fe8a4349941cb1b1362

data/README.md

@@ -31,11 +31,6 @@ Ref: [ASCII table , ascii codes](https://theasciicode.com.ar/)
     + 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](https://github.com/liijunwei/char_detector/issues/5)
-+ TODO [Improve compatibility](https://github.com/liijunwei/char_detector/issues/4)
-
 ## Installation(WIP)
 
 Add this line to your application's Gemfile:

data/bin/char_detector

@@ -29,16 +29,4 @@ OptionParser.new do |opts|
   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
+CharDetector::Cli.execute(options)

data/char_detector.gemspec

@@ -18,9 +18,21 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/liijunwei/char_detector"
   spec.metadata["changelog_uri"] = "https://github.com/liijunwei/char_detector"
 
+  ignored_files = %w[
+    .gitignore
+    .ruby-version
+    .tool-versions
+    bin/console
+    bin/setup
+    CODE_OF_CONDUCT.md
+    LICENSE.txt
+    Rakefile
+  ]
+
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|image|.github)/}) }.reject { |f| ignored_files.include?(f) }
   end
+
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/char_detector/cli.rb

@@ -0,0 +1,39 @@
+module CharDetector
+  class Cli
+    def self.execute(options={})
+      new(options).run
+    end
+
+    attr_reader :options
+
+    def initialize(options={})
+      @options = options
+
+      if options[:file] && !File.exist?(options[:file])
+        warn("[fail] Can't find file: #{options[:file]}")
+        exit 1
+      end
+
+      if options.empty?
+        abort("[info] Pass -h for usage")
+        exit 1
+      end
+    end
+
+    def run
+      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
+    end
+  end
+end

data/lib/char_detector/engine.rb

@@ -1,34 +1,21 @@
-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?
+module CharDetector
+  class Engine
+    def initialize(file:)
+      @file = file
+    end
 
-      hash = {}
-      hash[:line]    = index + 1
-      hash[:columns] = scanned.map { |e| line.index(e)+1 }
+    attr_reader :file
 
-      matches << hash
-    end
+    def scan
+      matches = []
 
-    return matches
-  end
+      File.readlines(file).each_with_index do |line, index|
+        if result = Line.new(index+1, line, /\p{Cntrl}/).scanline
+          matches << result
+        end
+      end
 
-  def trim_newline(line)
-    if line.end_with?("\n")
-      line[0..-2]
-    else
-      line
+      return matches
     end
   end
 end

data/lib/char_detector/line.rb

@@ -0,0 +1,47 @@
+module CharDetector
+  class Line
+    def initialize(number, content, pattern)
+      @number  = number
+      @content = content
+      @pattern = pattern
+    end
+
+    attr_reader :number, :content, :pattern
+
+    def scanline
+      return nil if matched_chars.empty? # TODO null object pattern?
+
+      hash = {}
+      hash[:line]    = number
+      hash[:columns] = matched_columns
+
+      return hash
+    end
+
+    private
+
+    def matched_chars
+      all_matched_chars - matched_spaces
+    end
+
+    def all_matched_chars
+      trimmed_newline.scan(pattern)
+    end
+
+    def matched_spaces
+      trimmed_newline.scan(/\p{Space}/)
+    end
+
+    def matched_columns
+      matched_chars.map { |e| content.index(e)+1 }
+    end
+
+    def trimmed_newline
+      if content.end_with?("\n")
+        content[0..-2]
+      else
+        content
+      end
+    end
+  end
+end

data/lib/char_detector/version.rb

@@ -1,3 +1,3 @@
 module CharDetector
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/char_detector.rb

@@ -1,5 +1,7 @@
 require "char_detector/version"
+require "char_detector/line"
 require "char_detector/engine"
+require "char_detector/cli"
 
 module CharDetector
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: char_detector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - lijunwei
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -60,25 +60,14 @@ executables:
 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/cli.rb
 - lib/char_detector/engine.rb
+- lib/char_detector/line.rb
 - lib/char_detector/version.rb
 homepage: https://github.com/liijunwei/char_detector
 licenses:
@@ -103,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.16
 signing_key:
 specification_version: 4
 summary: Initially used for detecting control character in markdown/ruby file.

data/.github/workflows/main.yml

@@ -1,32 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - main
-
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
-    strategy:
-      matrix:
-        ruby:
-          - '3.1.1'
-          - '3.0.0'
-          - '2.7.2'
-          - '2.6.1'
-          - '2.5.1'
-          - '2.4.6'
-
-    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

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

data/.ruby-version

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

data/.tool-versions

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

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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.lock

@@ -1,40 +0,0 @@
-PATH
-  remote: .
-  specs:
-    char_detector (0.1.1)
-
-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
-  ruby
-
-DEPENDENCIES
-  char_detector!
-  pry
-  rake
-  rspec
-
-BUNDLED WITH
-   2.3.7

data/LICENSE.txt

@@ -1,21 +0,0 @@
-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/Rakefile

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

data/bin/console

@@ -1,10 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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