Contents

# Do not use Rails-specific helper methods here (e.g., `blank?`) so the module can run standalone.
module RESTFramework
  module Version
    VERSION_FILEPATH = File.expand_path("../../VERSION", __dir__)

    def self.get_version(skip_git: false)
      # First, attempt to get the version from git.
      unless skip_git
        version = `git describe --dirty 2>/dev/null`&.strip
        return version unless !version || version.empty?
      end

      # Git failed or was skipped, so try to find a VERSION file.
      begin
        version = File.read(VERSION_FILEPATH)&.strip
        return version unless !version || version.empty?
      rescue SystemCallError
      end

      # If that fails, then try to get a plain commit SHA from git.
      unless skip_git
        version = `git describe --dirty --always`&.strip
        return "0.#{version}" unless !version || version.empty?
      end

      # No VERSION file, so version is unknown.
      return "0.unknown"
    end

    def self.stamp_version
      # Only stamp the version if it's not unknown.
      if RESTFramework::VERSION != "0.unknown"
        File.write(VERSION_FILEPATH, RESTFramework::VERSION)
      end
    end

    def self.unstamp_version
      File.delete(VERSION_FILEPATH) if File.exist?(VERSION_FILEPATH)
    end
  end

  VERSION = Version.get_version
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
rest_framework-0.9.5	lib/rest_framework/version.rb
rest_framework-0.9.4	lib/rest_framework/version.rb
rest_framework-0.9.3	lib/rest_framework/version.rb
rest_framework-0.9.2	lib/rest_framework/version.rb
rest_framework-0.9.1	lib/rest_framework/version.rb
rest_framework-0.9.0	lib/rest_framework/version.rb
rest_framework-0.8.17	lib/rest_framework/version.rb
rest_framework-0.8.16	lib/rest_framework/version.rb