123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Server::AppMetadata::Platform Private

Do not use. This class is for internal use only.
Relationships & Source Files
Inherits: Object
Defined in: lib/mongo/server/app_metadata/platform.rb

Overview

Implements the logic for building the platform string for the handshake.

Since:

  • 2.0.0

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#jruby? ⇒ true | false (readonly)

Queries whether the current runtime is JRuby or not.

Returns:

  • (true | false) —

    whether the runtime is JRuby or not.

Since:

  • 2.0.0

[ GitHub ] 

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 47



def jruby?
  RUBY_ENGINE == 'jruby'
end


  








  

    #metadata  ⇒ Mongo::Server::AppMetadata  (readonly)
  



  

    
  





  
Returns:



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 27



attr_reader :metadata


  








  

    #mri?  ⇒ true | false  (readonly)
  



  

    

Queries whether the current runtime is Ruby MRI or not.


  





  
Returns:


    
  
  • 
    (true | false)
—    
    

    whether the runtime is Ruby MRI or not.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 40



def mri?
  RUBY_ENGINE == 'ruby'
end


  







Instance Method Details



  

    #default_platform_list  ⇒ Array<String> 
  



  

    

Builds and returns the default platform list, for use when building the platform string.


  





  
Returns:


    
  
  • 
    (Array<String>)
—    
    

    the list of platform identifiers
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 91



def default_platform_list
  [
    metadata.platform,
    *ruby_versions,
    *platforms,
    RbConfig::CONFIG['build']
  ]
end


  








  

    #engine_name  
  



  

    
  





  
Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 53



def engine_name
  ENGINE_NAMES[RUBY_ENGINE] || RUBY_ENGINE
end


  








  

    #java_version  ⇒ String | nil 
  



  

    

Returns the version of the current Java environment, or nil if not invoked with JRuby.


  





  
Returns:


    
  
  • 
    (String | nil)
—    
    

    the current Java version
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 81



def java_version
  return nil unless jruby?

  java.lang.System.get_property('java.version')
end


  








  

    #platforms  ⇒ Array<String> 
  



  

    

Returns the list of platform identifiers that identify this runtime.


  





  
Returns:


    
  
  • 
    (Array<String>)
—    
    

    the list of platform identifiers.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 71



def platforms
  [ RUBY_PLATFORM ].tap do |list|
    list.push "JVM #{java_version}" if jruby?
  end
end


  








  

    #purpose  ⇒ String | nil 
  



  

    

Returns a single letter representing the purpose reported to the metadata, or nil if no purpose was specified.


  





  
Returns:


    
  
  • 
    (String | nil)
—    
    

    the code representing the purpose
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 104



def purpose
  return nil unless metadata.purpose

  metadata.purpose.to_s[0].upcase
end


  








  

    #ruby_versions  ⇒ Array<String> 
  



  

    

Returns the list of Ruby versions that identify this runtime.


  





  
Returns:


    
  
  • 
    (Array<String>)
—    
    

    the list of ruby versions
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 60



def ruby_versions
  if mri?
    [ "Ruby #{RUBY_VERSION}" ]
  else
    [ "#{engine_name} #{RUBY_ENGINE_VERSION}", "like Ruby #{RUBY_VERSION}" ]
  end
end


  








  

    #to_s  ⇒ String 
  



  

    

Builds and returns the platform string by concatenating relevant values together.


  





  
Returns:


    
  
  • 
    (String)
—    
    

    the platform string
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.0.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/server/app_metadata/platform.rb', line 114



def to_s
  primary = [ *default_platform_list, purpose ].compact.join(', ')
  list = [ primary ]

  metadata.wrapping_libraries&.each do |library|
    list << (library[:platform] || '')
  end

  list.join('|')
end