Class: Dev::Template::Docker::Ruby::Application

Inherits:
ApplicationInterface show all
Defined in:
lib/firespring_dev_commands/templates/docker/ruby/application.rb

Overview

Class for default rake tasks associated with a ruby project

Instance Attribute Summary collapse

Attributes inherited from ApplicationInterface

#name

Attributes inherited from BaseInterface

#exclude

Instance Method Summary collapse

Methods inherited from BaseInterface

#create_tasks!

Constructor Details

#initialize(application, container_path: nil, local_path: nil, start_container_dependencies_on_test: true, exclude: []) ⇒ Application

Create the templated rake tasks for the ruby application

Parameters:

  • application (String) —

    The name of the application

  • container_path (String) (defaults to: nil) —

    The path to the application inside of the container

  • local_path (String) (defaults to: nil) —

    The path to the application on your local system

  • start_container_dependencies_on_test (Boolean) (defaults to: true) —

    Whether or not to start up container dependencies when running tests



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 18

def initialize(
  application,
  container_path: nil,
  local_path: nil,
  start_container_dependencies_on_test: true,
  exclude: []
)
  @ruby = Dev::Ruby.new(container_path:, local_path:)
  @start_container_dependencies_on_test = start_container_dependencies_on_test
  super(application, exclude:)
end

Instance Attribute Details

#ruby ⇒ Object (readonly)

Returns the value of attribute ruby.



10
11
12
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 10

def ruby
  @ruby
end

#start_container_dependencies_on_test ⇒ Object (readonly)

Returns the value of attribute start_container_dependencies_on_test.



10
11
12
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 10

def start_container_dependencies_on_test
  @start_container_dependencies_on_test
end

Instance Method Details

#create_audit_task! ⇒ Object

Create the rake task which runs the security audits for the application packages



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 128

def create_audit_task!
  # Have to set a local variable to be accessible inside of the instance_eval block
  application = @name
  ruby = @ruby
  exclude = @exclude
  return if exclude.include?(:audit)

  DEV_COMMANDS_TOP_LEVEL.instance_eval do
    namespace application do
      desc 'Run all security audits'
      task audit: [:'ruby:audit'] do
        # This is just a placeholder to execute the dependencies
      end

      namespace :ruby do
        desc 'Run Bundle Audit on the target application' \
             "\n\tuse MIN_SEVERITY=(info low moderate high critical) to fetch only severity type selected and above (default=high)." \
             "\n\tuse IGNORELIST=(comma delimited list of ids) removes the entry from the list."
        task audit: %w(init_docker up_no_deps) do
          opts = []
          opts << '-T' if Dev::Common.new.running_codebuild?

          # Retrieve results of the scan.
          data = Dev::Docker::Compose.new(services: application, options: opts, capture: true).exec(*ruby.audit_command)
          Dev::Ruby::Audit.new(data).to_report.check
        end

        # namespace :audit do
        #   desc 'Run NPM Audit fix command'
        #   task fix: %w(init_docker up_no_deps) do
        #     raise 'not implemented'
        #     # Dev::Docker::Compose.new(services: application).exec(*ruby.audit_fix_command)
        #   end
        # end
      end
    end
  end
end

#create_eol_task! ⇒ Object

Create the rake task for the ruby eol method



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
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 168

def create_eol_task!
  # Have to set a local variable to be accessible inside of the instance_eval block
  exclude = @exclude
  ruby = @ruby

  DEV_COMMANDS_TOP_LEVEL.instance_eval do
    return if exclude.include?(:eol)

    task eol: [:'eol:ruby'] do
      # This is just a placeholder to execute the dependencies
    end

    namespace :eol do
      desc 'Compares the current date to the EOL date for supported packages in the ruby package file'
      task ruby: %w(init) do
        eol = Dev::EndOfLife::Ruby.new(ruby)
        ruby_products = eol.default_products

        puts
        puts "Ruby product versions (in #{eol.lockfile})".light_yellow
        Dev::EndOfLife.new(product_versions: ruby_products).status
      end
    end
  end
end

#create_install_task! ⇒ Object

Create the rake task which runs the install command for the application packages



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 108

def create_install_task!
  # Have to set a local variable to be accessible inside of the instance_eval block
  application = @name
  ruby = @ruby
  exclude = @exclude
  return if exclude.include?(:install)

  DEV_COMMANDS_TOP_LEVEL.instance_eval do
    namespace application do
      namespace :ruby do
        desc 'Install all bundled gems'
        task install: %w(init_docker up_no_deps) do
          Dev::Docker::Compose.new(services: application).exec(*ruby.install_command)
        end
      end
    end
  end
end

#create_lint_task! ⇒ Object

Create the rake task which runs linting for the application name rubocop:disable Metrics/MethodLength



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 32

def create_lint_task!
  application = @name
  ruby = @ruby
  exclude = @exclude
  return if exclude.include?(:lint)

  DEV_COMMANDS_TOP_LEVEL.instance_eval do
    namespace application do
      desc 'Run all linting software'
      task lint: %w(ruby:lint) do
        # This is just a placeholder to execute the dependencies
      end

      namespace :lint do
        desc 'Run all linting software and apply all available fixes'
        task fix: %w(ruby:lint:fix) do
          # This is just a placeholder to execute the dependencies
        end
      end

      namespace :ruby do
        desc "Run the ruby linting software against the #{application}'s codebase"
        task lint: %w(init_docker up_no_deps) do
          LOG.debug("Check for ruby linting errors in the #{application} codebase")

          options = []
          options << '-T' if Dev::Common.new.running_codebuild?
          Dev::Docker::Compose.new(services: application, options:).exec(*ruby.lint_command)
        end

        namespace :lint do
          desc "Run the ruby linting software against the #{application}'s codebase and apply all available fixes"
          task fix: %w(init_docker up_no_deps) do
            LOG.debug("Check and fix all ruby linting errors in the #{application} codebase")

            options = []
            options << '-T' if Dev::Common.new.running_codebuild?
            Dev::Docker::Compose.new(services: application, options:).exec(*ruby.lint_fix_command)
          end
        end
      end
    end
  end
end

#create_test_task! ⇒ Object

Create the rake task which runs all tests for the application name



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/firespring_dev_commands/templates/docker/ruby/application.rb', line 79

def create_test_task!
  application = @name
  ruby = @ruby
  exclude = @exclude
  up_cmd = @start_container_dependencies_on_test ? :up : :up_no_deps
  return if exclude.include?(:test)

  DEV_COMMANDS_TOP_LEVEL.instance_eval do
    namespace application do
      desc 'Run all tests'
      task test: [:'ruby:test'] do
        # This is just a placeholder to execute the dependencies
      end

      namespace :ruby do
        desc "Run all ruby tests against the #{application}'s codebase"
        task test: %W(init_docker #{up_cmd}) do
          LOG.debug("Running all ruby tests in the #{application} codebase")

          options = []
          options << '-T' if Dev::Common.new.running_codebuild?
          Dev::Docker::Compose.new(services: application, options:).exec(*ruby.test_command)
        end
      end
    end
  end
end