为什么 Ruby Gems 代码有某些文件只需要同名的文件,但唯一的区别是它们有蛇形外壳?

如何解决为什么 Ruby Gems 代码有某些文件只需要同名的文件,但唯一的区别是它们有蛇形外壳?

对于我们当前的问题,让我们以这个 repo 为例。 https://github.com/slack-ruby/slack-ruby-client/tree/master/lib

在这个 repo 中,我们可以看到以下文件列表。

enter image description here

slack_ruby_client.rb 文件中只有 require 'slack-ruby-client'。我在其他一些 gem 中也看到了类似的约定。另一个例子是https://github.com/orbit-love/notion-ruby-client/tree/main/lib

这里有什么逻辑吗?有人可以向我解释一下或指导我阅读任何讨论此问题的文章吗?

解决方法

因为很多程序员不明白 slack_ruby_clientslack-ruby-client 不是一回事,所以 gem 的作者提供了这两个文件以避免被错误报告淹没。>

Nokogiri 的作者做了同样的事情,因为程序员一直将它拼错为 require 'nokogirl' 而不是 require 'nokogiri' 并报告它不起作用的错误,所以 Nokogiri 作者只是将一个名为nokogirl.rb 只包含 require 'nokogiri'

,

起初,gem 的默认入口点通常是与 gem 名称完全相同的文件,因为这遵循了 bundler 的硬编码默认值。命名 gems、ruby 文件以及映射到这些文件中的常量(类、模块等)时使用的约定也存在潜在冲突。

起初,当将 gem 作为依赖项添加到您的 Gemfile 时,bundler 可能会尝试自动请求 gem。在这里,它默认使用 gem 依赖项的名称(这可以用 :require 选项覆盖)。

因此,slack-ruby-clientnotion-ruby-client gem 的正常入口点的名称与 gem 相同。因此,Bundler 无需任何进一步说明即可要求 gem 代码。

现在,除了依赖打包器自动要求之外,还有其他方式需要 Ruby 代码。通常,开发人员手动需要代码来确保他们的依赖项都被加载,无论是否使用 bundler。

命名 ruby​​ 代码文件时的通常约定是使用以文件中定义的相应类/模块命名的 snake_case 名称。类名 MySpecialClass 将在名为 my_special_class.rb

的文件中定义

鉴于 gem 被称为 slack-ruby-client 并且人们知道这个特定的名称,因此他们可能会假设他们可以或应该要求 gem 为 require "slack_ruby_client",假设这里使用了 snake_case 文件名(就像在 Ruby 中的大多数情况一样)。 slack-ruby-client gem 通过提供一个适当命名的文件来加载实际模块来支持这一假设。

此外,当手动需要代码时,很多人认为他们可以使用转换为snake_case的模块名称来请求所需的模块。在 slack-ruby-client 提供 Slack 模块的情况下,人们可能因此假设他们可以只使用 require "slack" 加载模块。

因此,gem 还提供了一个名为 slack.rb 的文件,该文件需要 gem 的实际入口点。

最后,这些文件是由 gem 作者添加的,目的是为人们假设命名 gem 和/或其中的文件的各种约定提供便利的入口点,以便无缝地提供正确的功能。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


使用本地python环境可以成功执行 import pandas as pd import matplotlib.pyplot as plt # 设置字体 plt.rcParams['font.sans-serif'] = ['SimHei'] # 能正确显示负号 p
错误1:Request method ‘DELETE‘ not supported 错误还原:controller层有一个接口,访问该接口时报错:Request method ‘DELETE‘ not supported 错误原因:没有接收到前端传入的参数,修改为如下 参考 错误2:cannot r
错误1:启动docker镜像时报错:Error response from daemon: driver failed programming external connectivity on endpoint quirky_allen 解决方法:重启docker -> systemctl r
错误1:private field ‘xxx‘ is never assigned 按Altʾnter快捷键,选择第2项 参考:https://blog.csdn.net/shi_hong_fei_hei/article/details/88814070 错误2:启动时报错,不能找到主启动类 #
报错如下,通过源不能下载,最后警告pip需升级版本 Requirement already satisfied: pip in c:\users\ychen\appdata\local\programs\python\python310\lib\site-packages (22.0.4) Coll
错误1:maven打包报错 错误还原:使用maven打包项目时报错如下 [ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources)
错误1:服务调用时报错 服务消费者模块assess通过openFeign调用服务提供者模块hires 如下为服务提供者模块hires的控制层接口 @RestController @RequestMapping("/hires") public class FeignControl
错误1:运行项目后报如下错误 解决方案 报错2:Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile (default-compile) on project sb 解决方案:在pom.
参考 错误原因 过滤器或拦截器在生效时,redisTemplate还没有注入 解决方案:在注入容器时就生效 @Component //项目运行时就注入Spring容器 public class RedisBean { @Resource private RedisTemplate<String
使用vite构建项目报错 C:\Users\ychen\work>npm init @vitejs/app @vitejs/create-app is deprecated, use npm init vite instead C:\Users\ychen\AppData\Local\npm-
参考1 参考2 解决方案 # 点击安装源 协议选择 http:// 路径填写 mirrors.aliyun.com/centos/8.3.2011/BaseOS/x86_64/os URL类型 软件库URL 其他路径 # 版本 7 mirrors.aliyun.com/centos/7/os/x86
报错1 [root@slave1 data_mocker]# kafka-console-consumer.sh --bootstrap-server slave1:9092 --topic topic_db [2023-12-19 18:31:12,770] WARN [Consumer clie
错误1 # 重写数据 hive (edu)> insert overwrite table dwd_trade_cart_add_inc > select data.id, > data.user_id, > data.course_id, > date_format(
错误1 hive (edu)> insert into huanhuan values(1,'haoge'); Query ID = root_20240110071417_fe1517ad-3607-41f4-bdcf-d00b98ac443e Total jobs = 1
报错1:执行到如下就不执行了,没有显示Successfully registered new MBean. [root@slave1 bin]# /usr/local/software/flume-1.9.0/bin/flume-ng agent -n a1 -c /usr/local/softwa
虚拟及没有启动任何服务器查看jps会显示jps,如果没有显示任何东西 [root@slave2 ~]# jps 9647 Jps 解决方案 # 进入/tmp查看 [root@slave1 dfs]# cd /tmp [root@slave1 tmp]# ll 总用量 48 drwxr-xr-x. 2
报错1 hive> show databases; OK Failed with exception java.io.IOException:java.lang.RuntimeException: Error in configuring object Time taken: 0.474 se
报错1 [root@localhost ~]# vim -bash: vim: 未找到命令 安装vim yum -y install vim* # 查看是否安装成功 [root@hadoop01 hadoop]# rpm -qa |grep vim vim-X11-7.4.629-8.el7_9.x
修改hadoop配置 vi /usr/local/software/hadoop-2.9.2/etc/hadoop/yarn-site.xml # 添加如下 <configuration> <property> <name>yarn.nodemanager.res