123456789_123456789_123456789_123456789_123456789_

Class: Rails::Paths::Path

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
Inherits: Object
Defined in: railties/lib/rails/paths.rb

Class Method Summary

Instance Attribute Summary

::Enumerable - Included

#many?

Returns true if the enumerable has more than 1 element.

Instance Method Summary

::Enumerable - Included

#compact_blank

Returns a new ::Array without the blank items.

#exclude?

The negative of the Enumerable#include?.

#excluding

Returns a copy of the enumerable excluding the specified elements.

#in_order_of

Returns a new ::Array where the order has been set to that provided in the series, based on the key of the objects in the original enumerable.

#including

Returns a new array that includes the passed elements.

#index_by

Convert an enumerable to a hash, using the block result as the key and the element as the value.

#index_with

Convert an enumerable to a hash, using the element as the key and the block result as the value.

#maximum

Calculates the maximum from the extracted elements.

#minimum

Calculates the minimum from the extracted elements.

#pick

Extract the given key from the first element in the enumerable.

#pluck

Extract the given key from each element in the enumerable.

#sole

Returns the sole item in the enumerable.

#without
#as_json

::ActiveSupport::EnumerableCoreExt::Constants - Included

Constructor Details

.new(root, current, paths, options = {}) ⇒ Path

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 119

def initialize(root, current, paths, options = {})
  @paths   = paths
  @current = current
  @root    = root
  @glob    = options[:glob]
  @exclude = options[:exclude]

  options[:autoload_once] ? autoload_once! : skip_autoload_once!
  options[:eager_load]    ? eager_load!    : skip_eager_load!
  options[:autoload]      ? autoload!      : skip_autoload!
  options[:load_path]     ? load_path!     : skip_load_path!
end

Instance Attribute Details

#glob (rw)

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 117

attr_accessor :glob

Instance Method Details

#<<(path) Also known as: #push

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 171

def <<(path)
  @paths << path
end

#absolute_current

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 132

def absolute_current # :nodoc:
  File.expand_path(@current, @root.path)
end

#children

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 136

def children
  keys = @root.keys.find_all { |k|
    k.start_with?(@current) && k != @current
  }
  @root.values_at(*keys.sort)
end

#concat(paths)

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 176

def concat(paths)
  @paths.concat paths
end

#each(&block)

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 167

def each(&block)
  @paths.each(&block)
end

#existent

Returns all expanded paths but only if they exist in the filesystem.

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 220

def existent
  expanded.select do |f|
    does_exist = File.exist?(f)

    if !does_exist && File.symlink?(f)
      raise "File #{f.inspect} is a symlink that does not point to a valid file"
    end
    does_exist
  end
end

#existent_directories

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 231

def existent_directories
  expanded.select { |d| File.directory?(d) }
end

#expanded Also known as: #to_a

Expands all paths against the root and return all unique values.

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 201

def expanded
  raise "You need to set a path root" unless @root.path
  result = []

  each do |path|
    path = File.expand_path(path, @root.path)

    if @glob && File.directory?(path)
      result.concat files_in(path)
    else
      result << path
    end
  end

  result.uniq!
  result
end

#extensions

This method is for internal use only.
[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 196

def extensions # :nodoc:
  $1.split(",") if @glob =~ /\{([\S]+)\}/
end

#files_in(path) (private)

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 238

def files_in(path)
  files = Dir.glob(@glob, base: path)
  files -= @exclude if @exclude
  files.map! { |file| File.join(path, file) }
  files.sort
end

#first

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 143

def first
  expanded.first
end

#last

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 147

def last
  expanded.last
end

#paths

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 188

def paths
  raise "You need to set a path root" unless @root.path

  map do |p|
    Pathname.new(@root.path).join(p)
  end
end

#push(path)

Alias for #<<.

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 174

alias :push :<<

#to_a

Alias for #expanded.

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 235

alias to_a expanded

#to_ary

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 184

def to_ary
  @paths
end

#unshift(*paths)

[ GitHub ]

  
# File 'railties/lib/rails/paths.rb', line 180

def unshift(*paths)
  @paths.unshift(*paths)
end