Class: Overcommit::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/overcommit/configuration.rb

Overview

Stores configuration for Overcommit and the hooks it runs.

Instance Method Summary collapse

Constructor Details

#initialize(hash, options = {}) ⇒ Configuration

Creates a configuration from the given hash.

Parameters:

  • hash (Hash) —

    loaded YAML config file as a hash

  • options (Hash) (defaults to: {})
  • default (Hash) —

    a customizable set of options

  • logger (Hash) —

    a customizable set of options



10
11
12
13
14
 
# File 'lib/overcommit/configuration.rb', line 10

def initialize(hash, options = {})
  @options = options.dup
  @options[:logger] ||= Overcommit::Logger.silent
  @hash = Overcommit::ConfigurationValidator.new.validate(hash, options)
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



16
17
18
 
# File 'lib/overcommit/configuration.rb', line 16

def ==(other)
  super || @hash == other.hash
end

#[](key) ⇒ Array, ...

Access the configuration as if it were a hash.

Parameters:

  • key (String)

Returns:

  • (Array, Hash, Number, String) 


25
26
27
 
# File 'lib/overcommit/configuration.rb', line 25

def [](key)
  @hash[key]
end

#all_builtin_hook_configs ⇒ Hash

Returns configuration for all built-in hooks in each hook type.

Returns:

  • (Hash) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/overcommit/configuration.rb', line 49

def all_builtin_hook_configs
  hook_configs = {}

  Overcommit::Utils.supported_hook_type_classes.each do |hook_type|
    hook_names = @hash[hook_type].keys.reject { |name| name == 'ALL' }

    hook_configs[hook_type] = Hash[
      hook_names.map do |hook_name|
        [hook_name, for_hook(hook_name, hook_type)]
      end
    ]
  end

  hook_configs
end

#all_hook_configs ⇒ Hash

Returns configuration for all hooks in each hook type.

Returns:

  • (Hash) 


42
43
44
 
# File 'lib/overcommit/configuration.rb', line 42

def all_hook_configs
  smart_merge(all_builtin_hook_configs, all_plugin_hook_configs)
end

#all_plugin_hook_configs ⇒ Hash

Returns configuration for all plugin hooks in each hook type.

Returns:

  • (Hash) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/overcommit/configuration.rb', line 68

def all_plugin_hook_configs
  hook_configs = {}

  Overcommit::Utils.supported_hook_types.each do |hook_type|
    hook_type_class_name = Overcommit::Utils.camel_case(hook_type)

    directory = File.join(plugin_directory, hook_type.tr('-', '_'))
    plugin_paths = Dir[File.join(directory, '*.rb')].sort

    hook_names = plugin_paths.map do |path|
      Overcommit::Utils.camel_case(File.basename(path, '.rb'))
    end

    hook_configs[hook_type_class_name] = Hash[
      hook_names.map do |hook_name|
        [hook_name, for_hook(hook_name, Overcommit::Utils.camel_case(hook_type))]
      end
    ]
  end

  hook_configs
end

#apply_environment!(hook_context, env) ⇒ Object

Applies additional configuration settings based on the provided environment variables.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/overcommit/configuration.rb', line 134

def apply_environment!(hook_context, env)
  skipped_hooks = "#{env['SKIP']} #{env['SKIP_CHECKS']} #{env['SKIP_HOOKS']}".split(/[:, ]/)
  only_hooks = env.fetch('ONLY', '').split(/[:, ]/)
  hook_type = hook_context.hook_class_name

  if only_hooks.any? || skipped_hooks.include?('all') || skipped_hooks.include?('ALL')
    @hash[hook_type]['ALL']['skip'] = true
  end

  only_hooks.select { |hook_name| hook_exists?(hook_context, hook_name) }.
             map { |hook_name| Overcommit::Utils.camel_case(hook_name) }.
             each do |hook_name|
    @hash[hook_type][hook_name] ||= {}
    @hash[hook_type][hook_name]['skip'] = false
  end

  skipped_hooks.select { |hook_name| hook_exists?(hook_context, hook_name) }.
                map { |hook_name| Overcommit::Utils.camel_case(hook_name) }.
                each do |hook_name|
    @hash[hook_type][hook_name] ||= {}
    @hash[hook_type][hook_name]['skip'] = true
  end
end

#enabled_ad_hoc_hooks(hook_context) ⇒ Object

Returns the ad hoc hooks that have been enabled for a hook type.



100
101
102
103
104
105
 
# File 'lib/overcommit/configuration.rb', line 100

def enabled_ad_hoc_hooks(hook_context)
  @hash[hook_context.hook_class_name].keys.
    select { |hook_name| hook_name != 'ALL' }.
    select { |hook_name| ad_hoc_hook?(hook_context, hook_name) }.
    select { |hook_name| hook_enabled?(hook_context, hook_name) }
end

#enabled_builtin_hooks(hook_context) ⇒ Object

Returns the built-in hooks that have been enabled for a hook type.



92
93
94
95
96
97
 
# File 'lib/overcommit/configuration.rb', line 92

def enabled_builtin_hooks(hook_context)
  @hash[hook_context.hook_class_name].keys.
    select { |hook_name| hook_name != 'ALL' }.
    select { |hook_name| built_in_hook?(hook_context, hook_name) }.
    select { |hook_name| hook_enabled?(hook_context, hook_name) }
end

#for_hook(hook, hook_type = nil) ⇒ Object

Returns a non-modifiable configuration for a hook.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/overcommit/configuration.rb', line 108

def for_hook(hook, hook_type = nil)
  unless hook_type
    components = hook.class.name.split('::')
    hook = components.last
    hook_type = components[-2]
  end

  # Merge hook configuration with special 'ALL' config
  hook_config = smart_merge(@hash[hook_type]['ALL'], @hash[hook_type][hook] || {})

  # Need to specially handle `enabled` option since not setting it does not
  # necessarily mean the hook is disabled
  hook_config['enabled'] = hook_enabled?(hook_type, hook)

  hook_config.freeze
end

#merge(config) ⇒ Object

Merges the given configuration with this one, returning a new Overcommit::Configuration. The provided configuration will either add to or replace any options defined in this configuration.



128
129
130
 
# File 'lib/overcommit/configuration.rb', line 128

def merge(config)
  self.class.new(smart_merge(@hash, config.hash))
end

#plugin_directory ⇒ Object

Returns absolute path to the directory that external hook plugins should be loaded from.



31
32
33
 
# File 'lib/overcommit/configuration.rb', line 31

def plugin_directory
  File.join(Overcommit::Utils.repo_root, @hash['plugin_directory'] || '.git-hooks')
end

#plugin_hook?(hook_context_or_type, hook_name) ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/overcommit/configuration.rb', line 158

def plugin_hook?(hook_context_or_type, hook_name)
  hook_type_name =
    if hook_context_or_type.is_a?(String)
      Overcommit::Utils.snake_case(hook_context_or_type)
    else
      hook_context_or_type.hook_type_name
    end
  hook_name = Overcommit::Utils.snake_case(hook_name)

  File.exist?(File.join(plugin_directory, hook_type_name, "#{hook_name}.rb"))
end

#verify_plugin_signatures? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/overcommit/configuration.rb', line 35

def verify_plugin_signatures?
  @hash['verify_plugin_signatures'] != false
end