Ecto Autoslug Field 项目使用教程

Ecto Autoslug Field 项目使用教程

ecto_autoslug_fieldAutomatically create slugs for Ecto schemas.项目地址:https://gitcode.com/gh_mirrors/ec/ecto_autoslug_field

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

Ecto Autoslug Field 是一个用于自动生成 Ecto 模式 slug 字段的库。以下是该项目的目录结构及其介绍：

ecto_autoslug_field/
├── lib/
│   ├── ecto_autoslug_field.ex
│   ├── ecto_autoslug_field/
│   │   ├── slug.ex
│   │   ├── slug_test.ex
│   │   └── version.ex
├── test/
│   ├── ecto_autoslug_field_test.exs
│   ├── support/
│   │   ├── repo.ex
│   │   └── schema.ex
├── .editorconfig
├── .formatter.exs
├── .gitignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── mix.exs
└── mix.lock

目录结构介绍

• lib/: 包含项目的主要代码文件。
  • ecto_autoslug_field.ex: 主模块文件。
  • ecto_autoslug_field/: 子模块文件夹。
    • slug.ex: 处理 slug 生成的逻辑。
    • slug_test.ex: slug 生成逻辑的测试文件。
    • version.ex: 版本信息文件。
• test/: 包含项目的测试文件。
  • ecto_autoslug_field_test.exs: 主测试文件。
  • support/: 测试支持文件夹。
    • repo.ex: 测试用的仓库文件。
    • schema.ex: 测试用的模式文件。
• .editorconfig: 编辑器配置文件。
• .formatter.exs: 代码格式化配置文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 变更日志文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE.md: 许可证文件。
• README.md: 项目说明文件。
• mix.exs: 项目配置文件。
• mix.lock: 依赖锁定文件。

2. 项目的启动文件介绍

Ecto Autoslug Field 项目的启动文件是 lib/ecto_autoslug_field.ex。这个文件定义了主模块 EctoAutoslugField，并导入了子模块。

defmodule EctoAutoslugField do
  @moduledoc """
  Automatically create slugs for Ecto schemas.
  """

  alias EctoAutoslugField.Slug

  defmacro __using__(opts) do
    quote do
      import EctoAutoslugField, only: [slug_field: 2]
      @before_compile EctoAutoslugField
      @ecto_autoslug_field_opts unquote(opts)
    end
  end

  defmacro slug_field(name, from) do
    quote do
      field unquote(name), EctoAutoslugField.Slug, from: unquote(from)
    end
  end

  defmacro __before_compile__(env) do
    opts = Module.get_attribute(env.module, :ecto_autoslug_field_opts)
    Slug.generate_slug(env.module, opts)
  end
end

启动文件介绍

• defmodule EctoAutoslugField do: 定义主模块。
• alias EctoAutoslugField.Slug: 导入子模块 Slug。
• defmacro __using__(opts) do: 定义使用模块时的宏。
• defmacro slug_field(name, from) do: 定义 slug 字段的宏。
• defmacro __before_compile__(env) do: 编译前的宏处理。

3. 项目的配置文件介绍

Ecto Autoslug Field 项目的配置文件是 mix.exs。这个文件包含了项目的依赖、版本、描述等信息。

defmodule EctoAutoslugField.MixProject

ecto_autoslug_fieldAutomatically create slugs for Ecto schemas.项目地址:https://gitcode.com/gh_mirrors/ec/ecto_autoslug_field