Class: Makit::Setup::Gem

Inherits:
Object
  • Object
show all
Defined in:
lib/makit/setup/gem.rb

Class Method Summary collapse

Class Method Details

.create_gem_structure(project) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/makit/setup/gem.rb', line 23

def self.create_gem_structure(project)
  # Create directories

  FileUtils.mkdir_p("lib/#{project.name}")
  FileUtils.mkdir_p("test")
  FileUtils.mkdir_p("exe")

  # Create basic gem files

  create_gemspec(project)
  create_gemfile(project)
  create_main_lib(project)
  create_version_file(project)
  create_rakefile(project)
  create_test_helper(project)
  create_test_file(project)
  create_readme(project)
end

.create_gemfile(project) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/makit/setup/gem.rb', line 74

def self.create_gemfile(project)
  gemfile_content = "    # frozen_string_literal: true\n\n    source \"https://rubygems.org\"\n\n    # Specify your gem's dependencies in \#{project.name}.gemspec\n    gemspec\n  GEMFILE\n\n  return if File.exist?(\"Gemfile\")\n\n  File.write(\"Gemfile\", gemfile_content)\nend\n"

.create_gemspec(project) ⇒ Object 



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
 
# File 'lib/makit/setup/gem.rb', line 40

def self.create_gemspec(project)
  gemspec_content = "    # frozen_string_literal: true\n\n    require_relative \"lib/\#{project.name}/version\"\n\n    Gem::Specification.new do |spec|\n      spec.name = \"\#{project.name}\"\n      spec.version = \#{project.name.capitalize}::VERSION\n      spec.authors = [\"Your Name\"]\n      spec.email = [\"[email protected]\"]\n\n      spec.summary = \"A Ruby gem\"\n      spec.description = \"A Ruby gem description\"\n      spec.homepage = \"https://github.com/yourusername/\#{project.name}\"\n      spec.license = \"MIT\"\n\n      spec.files = Dir[\"lib/**/*.rb\", \"exe/**/*\", \"README.md\", \"LICENSE.txt\"]\n      spec.bindir = \"exe\"\n      spec.executables = []\n      spec.require_paths = [\"lib\"]\n\n      spec.add_development_dependency \"bundler\", \"~> 2.0\"\n      spec.add_development_dependency \"rake\", \"~> 13.0\"\n      spec.add_development_dependency \"minitest\", \"~> 5.0\"\n    end\n  GEMSPEC\n\n  gemspec_path = \"\#{project.name}.gemspec\"\n  return if File.exist?(gemspec_path)\n\n  File.write(gemspec_path, gemspec_content)\nend\n"

.create_main_lib(project) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/makit/setup/gem.rb', line 89

def self.create_main_lib(project)
  main_lib_path = "lib/#{project.name}.rb"
  return if File.exist?(main_lib_path)

  main_lib_content = "    # frozen_string_literal: true\n\n    require_relative \"\#{project.name}/version\"\n\n    module \#{project.name.capitalize}\n      class Error < StandardError; end\n      # Your code goes here...\n    end\n  MAIN_LIB\n\n  File.write(main_lib_path, main_lib_content)\nend\n"

.create_rakefile(_project) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/makit/setup/gem.rb', line 122

def self.create_rakefile(_project)
  return if File.exist?("Rakefile")

  rakefile_content = "    # frozen_string_literal: true\n\n    require \"bundler/gem_tasks\"\n    require \"minitest/test_task\"\n    require \"makit\"\n\n    Minitest::TestTask.create\n\n    task :default => [:build, :install] do\n    end\n  RAKEFILE\n\n  File.write(\"Rakefile\", rakefile_content)\nend\n"

.create_readme(project) ⇒ Object 



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/makit/setup/gem.rb', line 174

def self.create_readme(project)
  readme_content = "    # \#{project.name.capitalize}\n\n    Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/\#{project.name}`. To experiment with that code, run `bin/console` for an interactive prompt.\n\n    TODO: Delete this and the text above, and describe your gem\n\n    ## Installation\n\n    Add this line to your application's Gemfile:\n\n    ```ruby\n    gem \"\#{project.name}\"\n    ```\n\n    And then execute:\n\n        $ bundle\n\n    Or install it yourself as:\n\n        $ gem install \#{project.name}\n\n    ## Usage\n\n    ```ruby\n    require \"\#{project.name}\"\n\n    # TODO: Write usage instructions here\n    ```\n\n    ## Development\n\n    After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.\n\n    ## Contributing\n\n    Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/\#{project.name}.\n\n    ## License\n\n    The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n  README\n\n  File.write(\"README.md\", readme_content)\nend\n"

.create_test_file(project) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/makit/setup/gem.rb', line 154

def self.create_test_file(project)
  test_content = "    # frozen_string_literal: true\n\n    require \"test_helper\"\n\n    class \#{project.name.capitalize}Test < Minitest::Test\n      def test_that_it_has_a_version_number\n        refute_nil ::\#{project.name.capitalize}::VERSION\n      end\n\n      def test_it_does_something_useful\n        assert false\n      end\n    end\n  TEST\n\n  File.write(\"test/\#{project.name}_test.rb\", test_content)\nend\n"

.create_test_helper(project) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/makit/setup/gem.rb', line 141

def self.create_test_helper(project)
  return if File.exist?("test/test_helper.rb")

  test_helper_content = "    # frozen_string_literal: true\n\n    require \"minitest/autorun\"\n    require_relative \"../lib/\#{project.name}\"\n  TEST_HELPER\n\n  File.write(\"test/test_helper.rb\", test_helper_content)\nend\n"

.create_version_file(project) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/makit/setup/gem.rb', line 107

def self.create_version_file(project)
  #version_path = "lib/#{project.name}/version.rb"

  #return if File.exist?(version_path)


  #version_content = <<~VERSION

  #  # frozen_string_literal: true


  #  module #{project.name.capitalize}

   #   VERSION = "#{project.version}"

  #  end

  #VERSION


  #File.write(version_path, version_content)

end

.run ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/makit/setup/gem.rb', line 8

def self.run
  project = Makit::Configuration::Project.default
  Makit::Logging.default_logger.info("Setting up Ruby gem project: #{project.name}")

  # Create basic gem structure

  create_gem_structure(project)

  # Update build and test steps

  # update_build_step(project)

  # update_test_step(project)


  project.save
  Makit::Logging.default_logger.info("Ruby gem project setup completed")
end

.update_build_step(project) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/makit/setup/gem.rb', line 222

def self.update_build_step(project)
  project = Makit::Configuration::Project.default
  version = project.version
  build_commands = [
    "gem build makit.gemspec --output artifacts/makit-#{version}.gem",
  ]

  # "gem build makit.gemspec --output artifacts/makit-#{VERSION}.gem".cache_run


  steps = project.steps
  if steps.any? { |step| step.name == "build" }
    build_step = steps.find { |step| step.name == "build" }
    build_step.commands = build_commands
  else
    build_step = Makit::Configuration::Step.new(
      name: "build",
      description: "Build the gem",
      commands: build_commands,
    )
    project.add_step(build_step)
  end
  build_step.commands = build_commands
  project.save
end

.update_test_step(project) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/makit/setup/gem.rb', line 247

def self.update_test_step(project)
  test_commands = [
 # "bundle exec rake test"

    ]

  steps = project.steps
  if steps.any? { |step| step.name == "test" }
    test_step = steps.find { |step| step.name == "test" }
    test_step.commands = test_commands
  else
    test_step = Makit::Configuration::Step.new(
      name: "test",
      description: "Run the tests",
      commands: test_commands,
    )
    project.add_step(test_step)
  end
  project.save
end