Question

As part of the RSpec, i need to reference a file contained in a gem I am depending on (call it gem foo). I control gem foo, so I can make changes to it as needed.

Gem ‘foo’ contains a file that I need to reference with in the a rspec spec. Is there a reasonably stable RubyGem or Bundler API to figure out ‘foo’ base directory?

Assuming ‘foo’ is already required in my Gemfile:
in Gemfile:

gem 'foo'

I want to do something like this (in something_spec.rb):

filename = File.expand_path('examples/xml/result.xml', Gem.gem_base_path('foo'))

What is gem_base_path API call?

Answer 1

I would recommend creating a function in your gem to do this:

module Foo
  class Configuration
    def self.result_xml_path
      File.realpath("../examples/xml/result.xml")
    end
  end
end

You can then do the following in your spec:

filename = Foo::Configuration.result_xml_path

This is much safer since you are getting all the information from the gem. It also looks cleaner.