Class: Ukiryu::Definition::Discovery

Inherits:
Object
  • Object
show all
Defined in:
lib/ukiryu/definition/discovery.rb

Overview

Discover tool definitions in standard filesystem locations

This class searches for tool definitions in XDG-compliant paths and tool-bundled locations.

Class Method Summary collapse

Class Method Details

.available_tools ⇒ Array<String>

List all discovered tool names

Returns:

  • (Array<String>) —

    tool names



136
137
138
 
# File 'lib/ukiryu/definition/discovery.rb', line 136

def self.available_tools
  discover.keys.sort
end

.definitions_for(tool_name) ⇒ Array<DefinitionMetadata>

Get all definitions for a specific tool

Parameters:

  • tool_name (String) —

    the tool name

Returns:



144
145
146
 
# File 'lib/ukiryu/definition/discovery.rb', line 144

def self.definitions_for(tool_name)
  discover[tool_name] || []
end

.determine_source_type(path) ⇒ Symbol

Determine the source type for a search path

Parameters:

  • path (String) —

    the search path

Returns:

  • (Symbol) —

    source type



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ukiryu/definition/discovery.rb', line 193

def self.determine_source_type(path)
  expanded = File.expand_path(path)

  if expanded.include?(xdg_data_home)
    :user
  elsif expanded.include?('/opt/')
    :bundled
  elsif expanded.include?('/usr/local/share')
    :local_system
  elsif expanded.include?('/usr/share')
    :system
  else
    :bundled # Default to bundled for unknown paths
  end
end

.discover ⇒ Hash<String, Array<DefinitionMetadata>>

Discover all available definitions

Searches all paths for tool definitions and returns metadata

Returns:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ukiryu/definition/discovery.rb', line 98

def self.discover
  definitions = Hash.new { |h, k| h[k] = [] }

  search_paths.each do |search_path|
    next unless File.directory?(search_path)

    discover_in_path(search_path).each do |metadata|
      definitions[metadata.name] << metadata
    end
  end

  # Sort each tool's definitions by priority
  definitions.each_value(&:sort!)

  definitions
end

.discover_in_path(search_path) ⇒ Array<DefinitionMetadata>

Discover definitions in a specific path

Parameters:

  • search_path (String) —

    the path to search

Returns:



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/ukiryu/definition/discovery.rb', line 152

def self.discover_in_path(search_path)
  definitions = []

  # Determine source type based on path
  source_type = determine_source_type(search_path)

  # Look for tool subdirectories (structure: {tool}/{version}.yaml)
  if File.directory?(search_path)
    Dir.foreach(search_path) do |tool_name|
      next if tool_name.start_with?('.')

      tool_dir = File.join(search_path, tool_name)
      next unless File.directory?(tool_dir)

      # Find YAML files in tool directory
      Dir.glob(File.join(tool_dir, '*.yaml')).each do |yaml_file|
        metadata = metadata_from_file(yaml_file, source_type)
        definitions << metadata if metadata
      rescue StandardError => e
        # Skip invalid files silently
        warn "[Ukiryu] Skipping invalid definition #{yaml_file}: #{e.message}"
      end
    end
  end

  # Also check for flat YAML files (structure: {tool}-{version}.yaml or {version}.yaml)
  Dir.glob(File.join(search_path, '*-*.yaml')).each do |yaml_file|
    metadata = metadata_from_file(yaml_file, source_type)
    definitions << metadata if metadata
  rescue StandardError => e
    # Skip invalid files silently
    warn "[Ukiryu] Skipping invalid definition #{yaml_file}: #{e.message}"
  end

  definitions
end

.find(tool_name, version = nil) ⇒ DefinitionMetadata?

Find the best definition for a tool

Parameters:

  • tool_name (String) —

    the tool name

  • version (String, nil) (defaults to: nil) —

    optional version constraint

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/ukiryu/definition/discovery.rb', line 120

def self.find(tool_name, version = nil)
  definitions = discover[tool_name]
  return nil if definitions.nil? || definitions.empty?

  if version
    # Find exact version match
    definitions.find { |d| d.version == version }
  else
    # Return highest priority definition
    definitions.first
  end
end

.metadata_from_file(yaml_file, source_type) ⇒ DefinitionMetadata?

Create metadata from a YAML file

Parameters:

  • yaml_file (String) —

    path to the YAML file

  • source_type (Symbol) —

    source type

Returns:



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ukiryu/definition/discovery.rb', line 214

def self.metadata_from_file(yaml_file, source_type)
  # Try to load just the name and version from YAML
  yaml_content = File.read(yaml_file)
  data = YAML.safe_load(yaml_content, permitted_classes: [Symbol], aliases: true)

  return nil unless data.is_a?(Hash)
  return nil unless data['name']

  name = data['name']
  version = data['version'] || '1.0' # Default version

  Ukiryu::Definition::DefinitionMetadata.new(
    name: name,
    version: version,
    path: yaml_file,
    source_type: source_type
  )
rescue Psych::SyntaxError, StandardError
  nil
end

.search_paths ⇒ Array<String>

Get all search paths for definitions

Returns paths in priority order (highest priority first):

  1. User definitions

  2. Tool-bundled paths (dynamically discovered)

  3. Local system definitions

  4. System definitions

Returns:

  • (Array<String>) —

    search paths



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/ukiryu/definition/discovery.rb', line 44

def self.search_paths
  paths = []

  # 1. User definitions (highest priority after explicit flag)
  paths << user_definitions_directory

  # 2. Tool-bundled paths (dynamically discovered)
  paths.concat(tool_bundled_paths)

  # 3. Local system definitions
  xdg_data_dirs.each do |dir|
    paths << File.join(dir, 'ukiryu', 'definitions')
  end

  # 4. System definitions
  paths << File.join(xdg_data_home, 'ukiryu', 'definitions')

  paths.uniq
end

.tool_bundled_paths ⇒ Array<String>

Get tool-bundled definition paths

Searches for tool installations and checks for bundled definitions

Returns:

  • (Array<String>) —

    tool-bundled paths



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ukiryu/definition/discovery.rb', line 69

def self.tool_bundled_paths
  paths = []

  # Check PATH for tool installations
  ENV.fetch('PATH', '').split(':').each do |bin_dir|
    next unless File.directory?(bin_dir)

    # Check for ukiryu subdirectory alongside bin
    parent_dir = File.dirname(bin_dir)
    ukiryu_dir = File.join(parent_dir, 'ukiryu')
    paths << ukiryu_dir if File.directory?(ukiryu_dir)

    # Check for share/ukiryu subdirectory
    share_dir = File.join(parent_dir, 'share', 'ukiryu')
    paths << share_dir if File.directory?(share_dir)
  end

  # Check /opt directory structure
  opt_paths = Dir.glob('/opt/*/ukiryu').select { |d| File.directory?(d) }
  paths.concat(opt_paths)

  paths.uniq
end

.user_definitions_directory ⇒ String

Get the user definitions directory

Returns:

  • (String) —

    path to user definitions directory



31
32
33
 
# File 'lib/ukiryu/definition/discovery.rb', line 31

def self.user_definitions_directory
  File.join(xdg_data_home, 'ukiryu', 'definitions')
end

.xdg_data_dirs ⇒ Array<String>

System data directories (XDG_DATA_DIRS or /usr/local/share:/usr/share)

Returns:

  • (Array<String>) —

    system data directories



20
21
22
23
24
25
26
 
# File 'lib/ukiryu/definition/discovery.rb', line 20

def self.xdg_data_dirs
  if ENV.key?('XDG_DATA_DIRS')
    ENV.fetch('XDG_DATA_DIRS', '').split(':').map(&:strip).reject(&:empty?)
  else
    ['/usr/local/share', '/usr/share']
  end
end

.xdg_data_home ⇒ String

User data directory (XDG_DATA_HOME or ~/.local/share)

Returns:

  • (String) —

    user data directory



13
14
15
 
# File 'lib/ukiryu/definition/discovery.rb', line 13

def self.xdg_data_home
  ENV.fetch('XDG_DATA_HOME', File.expand_path('~/.local/share'))
end