123456789_123456789_123456789_123456789_123456789_

Class: RSpec::Core::Metadata::ExampleGroupHash Private

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, HashPopulator
Instance Chain:
self, HashPopulator
Inherits: RSpec::Core::Metadata::HashPopulator
Defined in: rspec-core/lib/rspec/core/metadata.rb

Class Method Summary

HashPopulator - Inherited

.new

Instance Attribute Summary

HashPopulator - Inherited

#block, #description_args, #metadata, #user_metadata

Instance Method Summary

HashPopulator - Inherited

#populate, #build_description_from, #build_scoped_id_for, #description_separator, #ensure_valid_user_keys, #file_path_and_line_number_from, #populate_location_attributes

Class Method Details

.backwards_compatibility_default_proc(&example_group_selector)

[ GitHub ] 

  


# File 'rspec-core/lib/rspec/core/metadata.rb', line 265



def self.backwards_compatibility_default_proc(&example_group_selector)
  Proc.new do |hash, key|
    case key
    when :example_group
      # We commonly get here when rspec-core is applying a previously
      # configured filter rule, such as when a gem configures:
      #
      #   RSpec.configure do |c|
      #     c.include MyGemHelpers, :example_group => { :file_path => /spec\/my_gem_specs/ }
      #   end
      #
      # It's confusing for a user to get a deprecation at this point in
      # the code, so instead we issue a deprecation from the config APIs
      # that take a metadata hash, and MetadataFilter sets this thread
      # local to silence the warning here since it would be so
      # confusing.
      unless RSpec::Support.thread_local_data[:silence_metadata_example_group_deprecations]
        RSpec.deprecate("The `:example_group` key in an example group's metadata hash",
                        :replacement => "the example group's hash directly for the " \
                        "computed keys and `:parent_example_group` to access the parent " \
                        "example group metadata")
      end

      group_hash = example_group_selector.call(hash)
      LegacyExampleGroupHash.new(group_hash) if group_hash
    when :example_group_block
      RSpec.deprecate("`metadata[:example_group_block]`",
                      :replacement => "`metadata[:block]`")
      hash[:block]
    when :describes
      RSpec.deprecate("`metadata[:describes]`",
                      :replacement => "`metadata[:described_class]`")
      hash[:described_class]
    end
  end
end


  








  

    .create(parent_group_metadata, user_metadata, example_group_index, *args, &block)  
  

  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/metadata.rb', line 248



def self.create(parent_group_metadata, user_metadata, example_group_index, *args, &block)
  group_metadata = hash_with_backwards_compatibility_default_proc

  if parent_group_metadata
    group_metadata.update(parent_group_metadata)
    group_metadata[:parent_example_group] = parent_group_metadata
  end

  hash = new(group_metadata, user_metadata, example_group_index, args, block)
  hash.populate
  hash.metadata
end


  








  

    .hash_with_backwards_compatibility_default_proc  
  

  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/metadata.rb', line 261



def self.hash_with_backwards_compatibility_default_proc
  Hash.new(&backwards_compatibility_default_proc { |hash| hash })
end


  







Instance Method Details



  

    #described_class   (private)
  

  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/metadata.rb', line 304



def described_class
  candidate = metadata[:description_args].first
  return candidate unless NilClass === candidate || String === candidate
  parent_group = metadata[:parent_example_group]
  parent_group && parent_group[:described_class]
end


  








  

    #full_description   (private)
  

  [ GitHub ]


  

  


# File 'rspec-core/lib/rspec/core/metadata.rb', line 311



def full_description
  description          = metadata[:description]
  parent_example_group = metadata[:parent_example_group]
  return description unless parent_example_group

  parent_description   = parent_example_group[:full_description]
  separator = description_separator(parent_example_group[:description_args].last,
                                    metadata[:description_args].first)

  parent_description + separator + description
end