开源项目 Phony 使用教程

开源项目 Phony 使用教程

phonyE164 international phone number normalizing, splitting, formatting. 项目地址:https://gitcode.com/gh_mirrors/ph/phony

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

Phony 项目的目录结构如下：

phony/
├── bin/
├── lib/
├── spec/
├── .gitignore
├── .rspec
├── .travis.yml
├── Gemfile
├── LICENSE.txt
├── phony.gemspec
├── README.md
└── Rakefile

目录介绍

• bin/: 包含可执行文件。
• lib/: 包含项目的核心代码。
• spec/: 包含项目的测试代码。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .rspec: 包含 RSpec 测试框架的配置。
• .travis.yml: 配置 Travis CI 持续集成服务。
• Gemfile: 指定项目依赖的 RubyGems。
• LICENSE.txt: 项目的许可证。
• phony.gemspec: 项目的 gem 规范文件。
• README.md: 项目的主文档，包含项目介绍、安装和使用说明。
• Rakefile: 包含 Rake 任务定义。

2. 项目的启动文件介绍

Phony 项目的启动文件位于 lib/ 目录下。核心文件为 lib/phony.rb，它负责加载项目的其他模块并提供主要的 API 接口。

# lib/phony.rb
require 'phony/country'
require 'phony/dsl'
require 'phony/national_code'
require 'phony/national_splitters'
require 'phony/local_splitters'
require 'phony/trunk_code'
require 'phony/country_codes'
require 'phony/configuration'
require 'phony/version'

module Phony
  extend DSL

  class << self
    attr_accessor :configuration
  end

  def self.configuration
    @configuration ||= Configuration.new
  end

  def self.reset
    @configuration = Configuration.new
  end

  def self.configure
    yield(configuration)
  end
end

3. 项目的配置文件介绍

Phony 项目的配置文件主要是 phony.gemspec 和 Gemfile。

phony.gemspec

phony.gemspec 文件定义了 gem 的规范，包括名称、版本、作者、描述、依赖等信息。

# phony.gemspec
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'phony/version'

Gem::Specification.new do |spec|
  spec.name          = 'phony'
  spec.version       = Phony::VERSION
  spec.authors       = ['Florian Hanke']
  spec.email         = ['florian.hanke+phony@gmail.com']
  spec.description   = %q{Fast international phone number parsing}
  spec.summary       = %q{Fast international phone number parsing}
  spec.homepage      = 'https://github.com/floere/phony'
  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_development_dependency 'bundler', '~> 1.3'
  spec.add_development_dependency 'rake'
  spec.add_development_dependency 'rspec'
end

Gemfile

Gemfile 文件指定了项目依赖的 RubyGems。

# Gemfile
source 'https://rubygems.org'

gem 'phony'

group :development do
  gem 'rspec'
  gem 'rake'
end

以上是 Phony 开源项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

phonyE164 international phone number normalizing, splitting, formatting. 项目地址:https://gitcode.com/gh_mirrors/ph/phony