ruby - Jekyll 扩展调用外部脚本

Question

我编写了一个简单的 Jekyll 插件来使用 twitter gem 提取我的推文(见下文)。我想将插件的 ruby​​ 脚本保留在我的开放 Github 站点上，但在最近对 twitter API 进行更改之后，gem 现在需要身份验证凭据。

require 'twitter'   # Twitter API
require 'redcarpet' # Formatting links

module Jekyll
  class TwitterFeed < Liquid::Tag
    def initialize(tag_name, text, tokens)
      super
      input = text.split(/, */ )
      @user = input[0]
      @count = input[1]
      if input[1] == nil
        @count = 3
      end
    end
    def render(context)
      # Initialize a redcarpet markdown renderer to autolink urls
      # Could use octokit instead to get GFM
      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
                                                 :autolink => true, 
                                                 :space_after_headers => true)

      ## Attempt to load credentials externally here:
      require '~/.twitter_auth.rb'

      out = "<ul>"
      tweets = @client.user_timeline(@user)
      for i in 0 ... @count.to_i
      out = out + "<li>" + markdown.render(tweets[i].text) +
        " <a href=\"http://twitter.com/" + @user + "/statuses/" + 
        tweets[i].id.to_s + "\">"  + tweets[i].created_at.strftime("%I:%M %Y/%m/%d") + 
        "</a> " + "</li>"
      end
      out + "</ul>"
    end
  end
end
Liquid::Template.register_tag('twitter_feed', Jekyll::TwitterFeed)

如果我更换线路

      require '~/.twitter_auth.rb'

其中 twitter_auth.rb 包含类似以下内容:

require 'twitter'
@client = Twitter::Client.new(
:consumer_key => "CEoYXXXXXXXXXXX",
:consumer_secret => "apnHXXXXXXXXXXXXXXXXXXXXXXXX",
:oauth_token => "105XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
:oauth_token_secret => "BJ7AlXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
)

如果我将这些内容直接放入上面的脚本中，那么我的插件脚本就可以正常工作。但是，当我将它们移至外部文件并尝试按所示读取它们时，Jekyll 无法进行身份验证。当我从 irb 调用该函数时，该函数似乎工作得很好，所以我不确定为什么它在 Jekyll 构建期间不起作用。

Answer 1

我认为您可能对 require 的工作原理感到困惑。当您调用 require 时，Ruby 首先检查该文件是否已被请求，如果是，则直接返回。如果没有，则运行文件的内容，但不在与 require 语句相同的范围内。换句话说，使用 require 并不与用文件内容替换 require 语句相同(是 em> 例如，C 的 #include 是如何工作的)。

在您的情况下，当您需要 ~/.twitter_auth.rb 文件时，将创建 @client 实例变量，但作为顶部的实例变量level main 对象，不作为 TwitterFeed 实例的实例变量，其中调用 require 表单。

您可以执行一些操作，例如将 Twitter::Client 对象分配给一个常量，然后您可以从 render 方法引用该常量:

MyClient = Twitter::Client.new{...

然后

require '~/twitter_auth.rb'
@client = MyClient
...

我只是建议将此作为对 require 发生的情况的解释，这并不是一个很好的技术。

我认为，更好的选择是将您的凭据以简单的数据格式保存在您的主目录中，然后从脚本中读取它们并使用它们创建 Twitter 客户端。在这种情况下，Yaml 可能会完成这项工作。

首先将您的 ~/twitter_auth.rb 替换为 ~/twitter_auth.yaml ，如下所示:

:consumer_key: "CEoYXXXXXXXXXXX"
:consumer_secret: "apnHXXXXXXXXXXXXXXXXXXXXXXXX"
:oauth_token: "105XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
:oauth_token_secret: "BJ7AlXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

然后，如果您的类中有 requre "~/twitter_auth.rb"，请将其替换为此内容(您还需要在顶部添加 require 'yaml'文件):

@client = Twitter::Client.new(YAML.load_file("~/twitter_auth.yaml"))