Class: Danger::Dangerfile

Inherits:
Object
  • Object
show all
Includes:
DSL
Defined in:
lib/danger/danger_core/dangerfile.rb,
lib/danger/danger_core/dangerfile_dsl.rb

Defined Under Namespace

Modules: DSL

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env_manager, cork_board) ⇒ Dangerfile

Returns a new instance of Dangerfile.


69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/danger/danger_core/dangerfile.rb', line 69

def initialize(env_manager, cork_board)
  @plugins = {}
  @core_plugins = []
  @ui = cork_board

  # Triggers the core plugins
  @env = env_manager

  # Triggers local plugins from the root of a project
  Dir["./danger_plugins/*.rb"].each do |file|
    require File.expand_path(file)
  end

  refresh_plugins if env_manager.pr?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_sym, *arguments, &_block) ⇒ Object

rubocop:disable Style/MethodMissing


60
61
62
63
64
65
66
67
# File 'lib/danger/danger_core/dangerfile.rb', line 60

def method_missing(method_sym, *arguments, &_block)
  @core_plugins.each do |plugin|
    if plugin.public_methods(false).include?(method_sym)
      return plugin.send(method_sym, *arguments)
    end
  end
  super
end

Instance Attribute Details

#defined_in_filePathname

Returns the path where the Dangerfile was loaded from. It is nil if the Dangerfile was generated programmatically.

Returns:

  • (Pathname)

    the path where the Dangerfile was loaded from. It is nil if the Dangerfile was generated programmatically.


21
22
23
# File 'lib/danger/danger_core/dangerfile.rb', line 21

def defined_in_file
  @defined_in_file
end

#envObject

Returns the value of attribute env


16
17
18
# File 'lib/danger/danger_core/dangerfile.rb', line 16

def env
  @env
end

#pluginsObject

Returns the value of attribute plugins


16
17
18
# File 'lib/danger/danger_core/dangerfile.rb', line 16

def plugins
  @plugins
end

#uiObject

Returns the value of attribute ui


16
17
18
# File 'lib/danger/danger_core/dangerfile.rb', line 16

def ui
  @ui
end

#verboseObject

Returns the value of attribute verbose


16
17
18
# File 'lib/danger/danger_core/dangerfile.rb', line 16

def verbose
  @verbose
end

Class Method Details

.core_plugin_classesObject

These are the classes that are allowed to also use method_missing in order to provide broader plugin support


32
33
34
# File 'lib/danger/danger_core/dangerfile.rb', line 32

def self.core_plugin_classes
  [DangerfileMessagingPlugin]
end

.essential_plugin_classesObject

The ones that everything would break without


37
38
39
# File 'lib/danger/danger_core/dangerfile.rb', line 37

def self.essential_plugin_classes
  [DangerfileMessagingPlugin, DangerfileGitPlugin, DangerfileDangerPlugin, DangerfileGitHubPlugin, DangerfileGitLabPlugin]
end

Instance Method Details

#core_dsl_attributesObject


104
105
106
# File 'lib/danger/danger_core/dangerfile.rb', line 104

def core_dsl_attributes
  @core_plugins.map { |plugin| { plugin: plugin, methods: plugin.public_methods(false) } }
end

#external_dsl_attributesObject


108
109
110
# File 'lib/danger/danger_core/dangerfile.rb', line 108

def external_dsl_attributes
  plugins.values.reject { |plugin| @core_plugins.include? plugin } .map { |plugin| { plugin: plugin, methods: plugin.public_methods(false) } }
end

#fail(*args, &blk) ⇒ Object


51
52
53
# File 'lib/danger/danger_core/dangerfile.rb', line 51

def fail(*args, &blk)
  method_missing(:fail, *args, &blk)
end

#method_values_for_plugin_hashes(plugin_hashes) ⇒ Object


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/danger/danger_core/dangerfile.rb', line 112

def method_values_for_plugin_hashes(plugin_hashes)
  plugin_hashes.flat_map do |plugin_hash|
    plugin = plugin_hash[:plugin]
    methods = plugin_hash[:methods].select { |name| plugin.method(name).parameters.empty? }

    methods.map do |method|
      case method
      when :api
        value = "Octokit::Client"

      when :pr_json
        value = "[Skipped]"

      when :pr_body
        value = plugin.send(method)
        value = value.scan(/.{,80}/).to_a.each(&:strip!).join("\n")

      else
        value = plugin.send(method)
        # So that we either have one value per row
        # or we have [] for an empty array
        value = value.join("\n") if value.kind_of?(Array) && value.count > 0
      end

      [method.to_s, value]
    end
  end
end

#parse(path, contents = nil) ⇒ Object

Parses the file at a path, optionally takes the content of the file for DI


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'lib/danger/danger_core/dangerfile.rb', line 167

def parse(path, contents = nil)
  print_known_info if verbose

  contents ||= File.open(path, "r:utf-8", &:read)

  # Work around for Rubinius incomplete encoding in 1.9 mode
  if contents.respond_to?(:encoding) && contents.encoding.name != "UTF-8"
    contents.encode!("UTF-8")
  end

  if contents.tr!("“”‘’‛", %(""'''))
    # Changes have been made
    ui.puts "Your #{path.basename} has had smart quotes sanitised. " \
      "To avoid issues in the future, you should not use " \
      "TextEdit for editing it. If you are not using TextEdit, " \
      "you should turn off smart quotes in your editor of choice.".red
  end

  if contents.include?("puts")
    ui.puts "You used `puts` in your Dangerfile. To print out text to GitHub use `message` instead"
  end

  self.defined_in_file = path
  instance_eval do
    # rubocop:disable Lint/RescueException
    begin
      # rubocop:disable Eval
      eval(contents, nil, path.to_s)
      # rubocop:enable Eval
    rescue Exception => e
      message = "Invalid `#{path.basename}` file: #{e.message}"
      raise DSLError.new(message, path, e.backtrace, contents)
    end
    # rubocop:enable Lint/RescueException
  end
end

Iterates through the DSL's attributes, and table's the output


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/danger/danger_core/dangerfile.rb', line 142

def print_known_info
  rows = []
  rows += method_values_for_plugin_hashes(core_dsl_attributes)
  rows << ["---", "---"]
  rows += method_values_for_plugin_hashes(external_dsl_attributes)
  rows << ["---", "---"]
  rows << ["SCM", env.scm.class]
  rows << ["Source", env.ci_source.class]
  rows << ["Requests", env.request_source.class]
  rows << ["Base Commit", env.meta_info_for_base]
  rows << ["Head Commit", env.meta_info_for_head]

  params = {}
  params[:rows] = rows.each { |current| current[0] = current[0].yellow }
  params[:title] = "Danger v#{Danger::VERSION}\nDSL Attributes".green

  ui.section("Info:") do
    ui.puts
    ui.puts Terminal::Table.new(params)
    ui.puts
  end
end

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/danger/danger_core/dangerfile.rb', line 204

def print_results
  status = status_report
  return if (status[:errors] + status[:warnings] + status[:messages] + status[:markdowns]).count.zero?

  ui.section("Results:") do
    [:errors, :warnings, :messages].each do |key|
      formatted = key.to_s.capitalize + ":"
      title = case key
              when :errors
                formatted.red
              when :warnings
                formatted.yellow
              else
                formatted
              end
      rows = status[key]
      print_list(title, rows)
    end

    if status[:markdowns].count > 0
      ui.section("Markdown:") do
        status[:markdowns].each do |current_markdown|
          ui.puts current_markdown
        end
      end
    end
  end
end

#refresh_pluginsObject Also known as: init_plugins

Iterate through available plugin classes and initialize them with a reference to this Dangerfile


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/danger/danger_core/dangerfile.rb', line 87

def refresh_plugins
  plugins = Plugin.all_plugins
  plugins.each do |klass|
    next if klass.respond_to?(:singleton_class?) && klass.singleton_class?
    plugin = klass.new(self)
    next if plugin.nil? || @plugins[klass]

    name = plugin.class.instance_name
    self.class.send(:attr_reader, name)
    instance_variable_set("@#{name}", plugin)

    @plugins[klass] = plugin
    @core_plugins << plugin if self.class.core_plugin_classes.include? klass
  end
end

#to_sString

Returns a string useful to represent the Dangerfile in a message presented to the user.

Returns:

  • (String)

    a string useful to represent the Dangerfile in a message presented to the user.


26
27
28
# File 'lib/danger/danger_core/dangerfile.rb', line 26

def to_s
  "Dangerfile"
end

#warn(*args, &blk) ⇒ Object

Both of these methods exist on all objects ruby-doc.org/core-2.2.3/Kernel.html#method-i-warn ruby-doc.org/core-2.2.3/Kernel.html#method-i-fail However, as we're using using them in the DSL, they won't get method_missing called correctly without overriding them.


47
48
49
# File 'lib/danger/danger_core/dangerfile.rb', line 47

def warn(*args, &blk)
  method_missing(:warn, *args, &blk)
end