file_charset_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c387d93de97961c258c907c60e164013073a7bacbf3de84f7a2784ba23b4ad8b
+  data.tar.gz: e129371b71f1ea57cf80450ecc5a93333b05eac522501be2a556d05a8bc64212
+SHA512:
+  metadata.gz: b476fb8e5c5fcb1431e188cb102936872f018545f221fa23b60a1dacadc751e74c23476734bb330b0d4e604c19eb70f5aacaaf4d319688fd4858f34da4e04642
+  data.tar.gz: 53b3dfec9eeb342a811217ca1a2f3db7c33452d6d9ae864017a4670474b77553477c8fff327ca16c49b11b94c5573f40abcfe449393f7b7d6d28a6a1a19a5970

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.5
+before_install: gem install bundler -v 2.1.4

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 me@yammer.jp. 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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in file_charset.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    file_charset_validator (0.1.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.2)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    thor (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  file_charset_validator!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Keisuke Nakayama
+
+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,56 @@
+# file_charset_validator
+
+file_charset_validator is CLI tool to validate text files' encoding.
+
+This is implemented by ruby, and distributed as a gem.
+
+## Installation
+
+Install it yourself as:
+
+```
+$ gem install file_charset_validator
+```
+
+## Usage
+
+
+```sh
+$ file_charset_validator --encoding UTF_8 path/to/file/1 path/to/file/2
+```
+
+If the character codes of `path/to/file/1` and `path/to/file/2` are both UTF_8, it will exit normally.
+Otherwise, it will output a message and exit abnormally.
+
+
+### Options
+
+`--encoding` (`-e`)
+
+You can specify the character encoding to be verified.
+The character encoding that can be specified is defined as a constant in the encoding class of the ruby built-in library.
+
+### Arguments
+
+`<path, ...>`
+
+You can specify one or more file paths to be verified.
+
+## 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]/file_charset_validator. 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]/file_charset_validator/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 FileCharset project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/file_charset_validator/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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "file_charset_validator"
+
+# 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,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/e2e_test.sh

@@ -0,0 +1,13 @@
+#!/bin/bash -e
+
+bundle exec file_charset_validator --encoding UTF_8 spec/sample/rashomon/UTF_8.txt spec/sample/rashomon/UTF_8.txt spec/sample/rashomon/UTF_8.txt
+! bundle exec file_charset_validator --encoding UTF_8 spec/sample/rashomon/UTF_8.txt spec/sample/rashomon/UTF_8.txt spec/sample/rashomon/EUC_JP.txt
+! bundle exec file_charset_validator --encoding UTF_8 spec/sample/rashomon/UTF_8.txt spec/sample/rashomon/UTF_8.txt spec/sample/rashomon/Shift_JIS.txt
+
+bundle exec file_charset_validator --encoding Shift_JIS spec/sample/rashomon/Shift_JIS.txt spec/sample/rashomon/Shift_JIS.txt spec/sample/rashomon/Shift_JIS.txt
+! bundle exec file_charset_validator --encoding UTF_8 spec/sample/rashomon/Shift_JIS.txt spec/sample/rashomon/Shift_JIS.txt spec/sample/rashomon/EUC_JP.txt
+! bundle exec file_charset_validator --encoding UTF_8 spec/sample/rashomon/Shift_JIS.txt spec/sample/rashomon/Shift_JIS.txt spec/sample/rashomon/UTF_8.txt
+
+bundle exec file_charset_validator --encoding EUC_JP spec/sample/rashomon/EUC_JP.txt spec/sample/rashomon/EUC_JP.txt spec/sample/rashomon/EUC_JP.txt
+! bundle exec file_charset_validator --encoding EUC_JP spec/sample/rashomon/EUC_JP.txt spec/sample/rashomon/EUC_JP.txt spec/sample/rashomon/Shift_JIS.txt
+! bundle exec file_charset_validator --encoding EUC_JP spec/sample/rashomon/EUC_JP.txt spec/sample/rashomon/EUC_JP.txt spec/sample/rashomon/UTF_8.txt

data/exe/file_charset

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "file_charset"
+require "file_charset/cli.rb"
+
+CLI.start(ARGV)

data/exe/file_charset_validator

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require "file_charset_validator"
+require "file_charset_validator/cli.rb"
+
+
+=begin
+if ARGV.empty?
+  STDOUT.puts "Usage: file_charset_validator --encoding <encoding-name> [path, path, ...]"
+  exit 1
+end
+
+if ARGV[0] == "--encoding"
+  encoding = ARGV[1]
+  paths = ARGV[2..-1]
+else
+  encoding = "UTF_8"
+  paths = ARGV
+end
+
+exit FileCharsetValidator.check_paths_with_string_encoding(paths, encoding) ? 0 : 1
+=end
+
+CLI.start(ARGV)

data/file_charset_validator.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/file_charset_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_charset_validator"
+  spec.version       = FileCharsetValidator::VERSION
+  spec.authors       = ["Keisuke Nakayama"]
+  spec.email         = ["me@yammer.jp"]
+
+
+  spec.summary       = "Validate file charset"
+  spec.description   = "Validate what the character set of the specified file is. Is it UTF-8? or Shift-JIS? or ..."
+  spec.homepage      = "https://github.com/yammerjp/file_charset_validator"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yammerjp/file_charset_validator"
+  spec.metadata["changelog_uri"] = "https://github.com/yammerjp/file_charset_validator/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "thor"
+end

data/lib/file_charset_validator/cli.rb

@@ -0,0 +1,29 @@
+require "file_charset_validator"
+require "thor"
+require "file_charset_validator/helper.rb"
+
+class CLI < Thor
+  default_command :check
+
+  desc 'check [option] <path, ...>', 'Check the character set of the file specified by the arguments'
+  option :encoding, type: :string, aliases: '-e', desc: 'Encoding name (ex. UTF_8, Shift_JIS, EUC_JP)'
+  def check(*paths)
+    if paths.empty?
+      self.help
+      return
+    end
+
+    encoding = get_encoding(options[:encoding] || 'UTF_8')
+    if encoding.nil?
+      STDERR.puts "Unknown encoding: #{options[:encoding]}"
+      exit 1
+    end
+
+    invalid_paths = FileCharsetValidator.invalid_encoding_paths(paths, encoding)
+    head = "Invalid encoding file: "
+    if !invalid_paths.empty?
+      STDERR.puts "#{head}#{invalid_paths.join("\n#{head}")}"
+      exit 1
+    end
+  end
+end

data/lib/file_charset_validator/helper.rb

@@ -0,0 +1,7 @@
+def get_encoding(encoding_string)
+  if Encoding.const_defined? encoding_string
+    Object.const_get("Encoding::#{encoding_string}")
+  else
+    nil
+  end
+end

data/lib/file_charset_validator/version.rb

@@ -0,0 +1,3 @@
+class FileCharsetValidator
+  VERSION = "0.1.0"
+end

data/lib/file_charset_validator.rb

@@ -0,0 +1,10 @@
+require "file_charset_validator/version"
+require "file_charset_validator/helper.rb"
+
+class FileCharsetValidator
+  def self.invalid_encoding_paths(paths, encoding)
+    paths.reject do |path|
+      IO.binread(path.chomp).force_encoding(encoding).valid_encoding?
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: file_charset_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keisuke Nakayama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: Validate what the character set of the specified file is. Is it UTF-8?
+  or Shift-JIS? or ...
+email:
+- me@yammer.jp
+executables:
+- file_charset
+- file_charset_validator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- e2e_test.sh
+- exe/file_charset
+- exe/file_charset_validator
+- file_charset_validator.gemspec
+- lib/file_charset_validator.rb
+- lib/file_charset_validator/cli.rb
+- lib/file_charset_validator/helper.rb
+- lib/file_charset_validator/version.rb
+homepage: https://github.com/yammerjp/file_charset_validator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yammerjp/file_charset_validator
+  source_code_uri: https://github.com/yammerjp/file_charset_validator
+  changelog_uri: https://github.com/yammerjp/file_charset_validator/blob/main/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.1.6
+signing_key: 
+specification_version: 4
+summary: Validate file charset
+test_files: []