ruby - 确定gem的文件列表以符合规范

我一直使用git来确定应将哪些文件放入gem包中:

gem.files = `git ls-files`.split "\n"

不幸的是this approach has recently proved to be inappropriate。我需要一个独立的纯Ruby解决方案。

我的第一个想法是简单地遍历整个目录，但是仅此一个目录就可能包含不需要的文件。因此，在研究了问题之后，我想到了:

# example.gemspec

directory = File.dirname File.expand_path __FILE__
dotfiles = %w(.gitignore .rvmrc)
ignore_file = '.gitignore'
file_list = []

Dir.chdir directory do
  ignored = File.readlines(ignore_file).map(&:chomp).reject { |glob| glob =~ /\A(#|\s*\z)/ }
  file_list.replace Dir['**/**'] + dotfiles
  file_list.delete_if do |file|
    File.directory?(file) or ignored.any? { |glob| File.fnmatch? glob, file }
  end
end

# Later...

gem.files = file_list

对于gemspec来说似乎有点复杂。它还不完全支持 gitignore 's pattern format。目前看来可行，但我不希望以后再遇到问题。

有没有更简单但更可靠的方法来计算gem的文件列表？大多数 gem 显然使用git ls-files，而那些 gem 既不使用类似于我的解决方案，也不使用手动指定文件的 gem 。

最佳答案

与 rake

最简单的解决方案取决于rake列出目录中的所有文件，但排除.gitignore文件中的所有内容:

require 'rake/file_list'
Rake::FileList['**/*'].exclude(*File.read('.gitignore').split)

ruby

官方的rubygems解决方案，手动列出和排除:

require 'rake'
spec.files = FileList['lib/*.rb',
                      'bin/*',
                      '[A-Z]*',
                      'test/*'].to_a

# or without Rake...
spec.files = Dir['lib/*.rb'] + Dir['bin/*']
spec.files += Dir['[A-Z]*'] + Dir['test/**/*']
spec.files.reject! { |fn| fn.include? "CVS" }

邦德勒

捆绑器解决方案，手动列出:

s.files = Dir.glob("{lib,exe}/**/*", File::FNM_DOTMATCH).reject {|f| File.directory?(f) }

注意:拒绝目录是没有用的，因为默认情况下，gem会忽略它们。

流浪汉

模仿git ls-files并在纯 ruby 中照顾.gitignore的无用解决方案:

  # The following block of code determines the files that should be included
  # in the gem. It does this by reading all the files in the directory where
  # this gemspec is, and parsing out the ignored files from the gitignore.
  # Note that the entire gitignore(5) syntax is not supported, specifically
  # the "!" syntax, but it should mostly work correctly.
  root_path      = File.dirname(__FILE__)
  all_files      = Dir.chdir(root_path) { Dir.glob("**/{*,.*}") }
  all_files.reject! { |file| [".", ".."].include?(File.basename(file)) }
  all_files.reject! { |file| file.start_with?("website/") }
  all_files.reject! { |file| file.start_with?("test/") }
  gitignore_path = File.join(root_path, ".gitignore")
  gitignore      = File.readlines(gitignore_path)
  gitignore.map!    { |line| line.chomp.strip }
  gitignore.reject! { |line| line.empty? || line =~ /^(#|!)/ }

  unignored_files = all_files.reject do |file|
    # Ignore any directories, the gemspec only cares about files
    next true if File.directory?(file)

    # Ignore any paths that match anything in the gitignore. We do
    # two tests here:
    #
    #   - First, test to see if the entire path matches the gitignore.
    #   - Second, match if the basename does, this makes it so that things
    #     like '.DS_Store' will match sub-directories too (same behavior
    #     as git).
    #
    gitignore.any? do |ignore|
      File.fnmatch(ignore, file, File::FNM_PATHNAME) ||
        File.fnmatch(ignore, File.basename(file), File::FNM_PATHNAME)
    end
  end

路径规范

使用pathspec gem Match Path Specifications, such as .gitignore, in Ruby!
参见https://github.com/highb/pathspec-ruby

引用

引用:
Bundler
Vagrant
RubyGems
Rake easy solution