UTF8 Cleaner 项目教程

UTF8 Cleaner 项目教程

utf8-cleaner项目地址:https://gitcode.com/gh_mirrors/ut/utf8-cleaner

1. 项目的目录结构及介绍

UTF8 Cleaner 项目的目录结构如下：

utf8-cleaner/
├── Gemfile
├── Guardfile
├── LICENSE.txt
├── README.md
├── Rakefile
├── utf8-cleaner.gemspec
├── lib/
│   └── utf8-cleaner.rb
├── spec/
│   └── utf8-cleaner_spec.rb
└── .gitignore

目录结构介绍

• Gemfile: 用于定义项目的依赖关系。
• Guardfile: 用于配置 Guard，实现自动测试和文件变更监控。
• LICENSE.txt: 项目的许可证文件。
• README.md: 项目说明文档。
• Rakefile: 用于定义 Rake 任务。
• utf8-cleaner.gemspec: 项目的 gem 规范文件。
• lib/: 包含项目的主要代码文件。
  • utf8-cleaner.rb: 核心功能实现文件。
• spec/: 包含项目的测试文件。
  • utf8-cleaner_spec.rb: 测试用例文件。
• .gitignore: 定义 Git 忽略的文件和目录。

2. 项目的启动文件介绍

UTF8 Cleaner 项目的启动文件是 lib/utf8-cleaner.rb。这个文件包含了项目的核心功能实现。

启动文件介绍

# lib/utf8-cleaner.rb

require 'rack'
require 'active_support/core_ext/string'

module UTF8Cleaner
  class Middleware
    def initialize(app)
      @app = app
    end

    def call(env)
      env.each do |key, value|
        if value.is_a?(String)
          env[key] = value.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
        end
      end

      @app.call(env)
    end
  end
end

启动文件功能

• 引入了 rack 和 active_support/core_ext/string 库。
• 定义了 UTF8Cleaner::Middleware 类，用于处理请求环境中的无效 UTF-8 字符。
• call 方法遍历请求环境中的每个字符串值，并将其转换为有效的 UTF-8 字符串。

3. 项目的配置文件介绍

UTF8 Cleaner 项目的配置文件主要是 utf8-cleaner.gemspec 和 Gemfile。

配置文件介绍

utf8-cleaner.gemspec

# utf8-cleaner.gemspec

Gem::Specification.new do |spec|
  spec.name          = "utf8-cleaner"
  spec.version       = "1.0.0"
  spec.authors       = ["Leon Miller-Out"]
  spec.email         = ["leon@singlebrook.com"]
  spec.summary       = %q{Removes invalid UTF8 characters from the URL and other env vars}
  spec.description   = %q{This prevents errors like "invalid byte sequence in UTF-8"}
  spec.homepage      = "https://github.com/singlebrook/utf8-cleaner"
  spec.license       = "MIT"

  spec.files         = `git ls-files`.split($/)
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_dependency "rack"
  spec.add_dependency "activesupport"

  spec.add_development_dependency "guard"
  spec.add_development_dependency "guard-rspec"
  spec.add_development_dependency "listen", "= 3.0.8"
  spec.add_development_dependency "rake"
  spec.add_development_dependency "rspec"
end

Gemfile

# Gemfile

source 'https://rubygems.org'

gem 'utf8-cleaner'

utf8-cleaner项目地址:https://gitcode.com/gh_mirrors/ut/utf8-cleaner