Class: Raykit::Project
- Inherits:
-
Object
- Object
- Raykit::Project
- Defined in:
- lib/raykit/project.rb
Instance Attribute Summary collapse
-
#description ⇒ Object
Returns the value of attribute description.
-
#directory ⇒ Object
readonly
Returns the value of attribute directory.
-
#log ⇒ Object
readonly
Returns the value of attribute log.
-
#name ⇒ Object
Returns the value of attribute name.
-
#remote ⇒ Object
readonly
Returns the value of attribute remote.
-
#target ⇒ Object
Returns the value of attribute target.
-
#timer ⇒ Object
Returns the value of attribute timer.
-
#verbose ⇒ Object
Returns the value of attribute verbose.
-
#version ⇒ Object
Returns the value of attribute version.
Instance Method Summary collapse
- #branch ⇒ Object
- #commit(commit_message) ⇒ Object
- #commit_message_filename ⇒ Object
- #detached? ⇒ Boolean
- #elapsed ⇒ Object
- #get_dev_dir(subdir) ⇒ Object
- #get_markdown_nvp(key, value, pad_char) ⇒ Object
- #has_diff?(filename) ⇒ Boolean
- #info ⇒ Object
-
#initialize(name = "", description = "", version = "") ⇒ Project
constructor
TODO: refactor to remove the defaults.
- #last_modified_filename ⇒ Object
-
#latest_commit ⇒ Object
latest local commit.
- #latest_tag ⇒ Object
- #latest_tag_commit ⇒ Object
- #latest_tag_md5 ⇒ Object
- #outstanding_commit? ⇒ Boolean
- #outstanding_tag? ⇒ Boolean
- #pull ⇒ Object
- #push ⇒ Object
- #read_only? ⇒ Boolean
- #run(command, quit_on_failure = true) ⇒ Object
- #set_version(version) ⇒ Object
- #size ⇒ Object
- #size_pack ⇒ Object
- #summary ⇒ Object
- #tag ⇒ Object
-
#target_md5 ⇒ Object
def target @target end.
- #to_markdown ⇒ Object
- #values ⇒ Object
Constructor Details
#initialize(name = "", description = "", version = "") ⇒ Project
TODO: refactor to remove the defaults
23 24 25 26 27 28 29 30 31 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 76 77 78 79 80 81 82 |
# File 'lib/raykit/project.rb', line 23 def initialize(name = "", description = "", version = "") @description = description if description.length.positive? @version = version if version.length.positive? @timeout = 1000 * 60 * 15 @verbose = false @timer = Raykit::Timer.new @remote = "" @commit_message_filename = "commit_message.tmp" if Dir.exist?(RAKE_DIRECTORY) @directory = RAKE_DIRECTORY if Dir.exist?("#{RAKE_DIRECTORY}/.git") && Dir.exist?(@directory) @git_directory = Raykit::Git::Directory.new(@directory) @remote = @git_directory.remote end else @directory = "" end # @log=Log.new("#{RAKE_DIRECTORY}/tmp/raykit.log") if (name.length.positive?) @name = name else if defined?(NAME) @name = NAME else slns = Dir.glob("*.sln") if slns.length == 1 @name = slns[0].gsub(".sln", "") else gemspecs = Dir.glob("*.gemspec") if gemspecs.length == 1 @name = gemspecs[0].gsub(".gemspec", "") else remote_parts = @remote.split("/") @name = remote_parts[-1].gsub(".git", "") if remote_parts.length.positive? end end end end if version.length.zero? if defined?(VERSION) @version = VERSION else @version = Raykit::Version.detect(@name) end end if description.length.zero? @description = DESCRIPTION if defined?(DESCRIPTION) end if (@remote.nil? || @remote.length.zero?) @repository = nil else @repository = Raykit::Git::Repository.new(@remote) end @values = Hash::new() @commands = Array::new() end |
Instance Attribute Details
#description ⇒ Object
Returns the value of attribute description.
8 9 10 |
# File 'lib/raykit/project.rb', line 8 def description @description end |
#directory ⇒ Object (readonly)
Returns the value of attribute directory.
88 89 90 |
# File 'lib/raykit/project.rb', line 88 def directory @directory end |
#log ⇒ Object (readonly)
Returns the value of attribute log.
88 89 90 |
# File 'lib/raykit/project.rb', line 88 def log @log end |
#name ⇒ Object
Returns the value of attribute name.
8 9 10 |
# File 'lib/raykit/project.rb', line 8 def name @name end |
#remote ⇒ Object (readonly)
Returns the value of attribute remote.
88 89 90 |
# File 'lib/raykit/project.rb', line 88 def remote @remote end |
#target ⇒ Object
Returns the value of attribute target.
8 9 10 |
# File 'lib/raykit/project.rb', line 8 def target @target end |
#timer ⇒ Object
Returns the value of attribute timer.
8 9 10 |
# File 'lib/raykit/project.rb', line 8 def timer @timer end |
#verbose ⇒ Object
Returns the value of attribute verbose.
8 9 10 |
# File 'lib/raykit/project.rb', line 8 def verbose @verbose end |
#version ⇒ Object
Returns the value of attribute version.
8 9 10 |
# File 'lib/raykit/project.rb', line 8 def version @version end |
Instance Method Details
#branch ⇒ Object
99 100 101 102 |
# File 'lib/raykit/project.rb', line 99 def branch return "main" if @git_directory.nil? @git_directory.branch end |
#commit(commit_message) ⇒ Object
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/raykit/project.rb', line 260 def commit() warn "[DEPRECATION] 'commit_message_filename' is deprecated. Use a run command for better transparency." Dir.chdir(@directory) do if File.exist?(".gitignore") status = `git status` if status.include?("Changes not staged for commit:") run("git add --all") if GIT_DIRECTORY.outstanding_commit? if File.exist?(@commit_message_filename) run("git commit --file #{@commit_message_filename}") File.delete(@commit_message_filename) else run("git commit -m'#{}'") end end end else puts "warning: .gitignore not found." end end self end |
#commit_message_filename ⇒ Object
255 256 257 258 |
# File 'lib/raykit/project.rb', line 255 def warn "[DEPRECATION] 'commit_message_filename' is deprecated." @commit_message_filename end |
#detached? ⇒ Boolean
137 138 139 140 |
# File 'lib/raykit/project.rb', line 137 def detached? return true if @git_directory.nil? @git_directory.detached? end |
#elapsed ⇒ Object
197 198 199 200 201 202 203 204 |
# File 'lib/raykit/project.rb', line 197 def elapsed elapsed = @timer.elapsed if elapsed < 1.0 "#{format("%.1f", @timer.elapsed)}s" else "#{format("%.0f", @timer.elapsed)}s" end end |
#get_dev_dir(subdir) ⇒ Object
84 85 86 |
# File 'lib/raykit/project.rb', line 84 def get_dev_dir(subdir) Raykit::Environment.get_dev_dir(subdir) end |
#get_markdown_nvp(key, value, pad_char) ⇒ Object
246 247 248 |
# File 'lib/raykit/project.rb', line 246 def get_markdown_nvp(key, value, pad_char) "\n| " + key.to_s.ljust(36, pad_char) + "| " + value.to_s.ljust(36, pad_char) end |
#has_diff?(filename) ⇒ Boolean
142 143 144 145 146 147 |
# File 'lib/raykit/project.rb', line 142 def has_diff?(filename) Dir.chdir(@directory) do text = `git diff #{filename}`.strip return true if text.length.positive? end end |
#info ⇒ Object
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/raykit/project.rb', line 206 def info ljust = 35 puts "" puts "PROJECT.name".ljust(ljust) + Rainbow(PROJECT.name).yellow.bright puts "PROJECT.version".ljust(ljust) + Rainbow(PROJECT.version).yellow.bright puts "PROJECT.remote".ljust(ljust) + Rainbow(PROJECT.remote).yellow.bright puts "PROJECT.branch".ljust(ljust) + Rainbow(PROJECT.branch).yellow.bright puts "PROJECT.detached?".ljust(ljust) + Rainbow(PROJECT.detached?).yellow.bright # puts "PROJECT.target".ljust(ljust) + Rainbow(PROJECT.target).yellow.bright # puts "PROJECT.target_md5".ljust(ljust) + Rainbow(PROJECT.target_md5).yellow.bright puts "PROJECT.latest_tag".ljust(ljust) + Rainbow(PROJECT.latest_tag).yellow.bright puts "PROJECT.latest_tag_commit".ljust(ljust) + Rainbow(PROJECT.latest_tag_commit).yellow.bright puts "PROJECT.latest_tag_md5".ljust(ljust) + Rainbow(PROJECT.latest_tag_md5).yellow.bright puts "PROJECT.latest_commit".ljust(ljust) + Rainbow(PROJECT.latest_commit).yellow.bright puts "PROJECT.last_modified_filename".ljust(ljust) + Rainbow(PROJECT.last_modified_filename).yellow.bright # puts "PROJECT.elapsed".ljust(ljust) + Rainbow(PROJECT.elapsed).yellow.bright puts "PROJECT.size".ljust(ljust) + Rainbow(PROJECT.size).yellow.bright puts "PROJECT.size_pack".ljust(ljust) + Rainbow(PROJECT.size_pack).yellow.bright puts "PROJECT.outstanding_commit?".ljust(ljust) + Rainbow(PROJECT.outstanding_commit?).yellow.bright puts "PROJECT.outstanding_tag?".ljust(ljust) + Rainbow(PROJECT.outstanding_tag?).yellow.bright puts "" self end |
#last_modified_filename ⇒ Object
169 170 171 172 173 |
# File 'lib/raykit/project.rb', line 169 def last_modified_filename Dir.chdir(@directory) do Dir.glob("**/*.*").select { |f| File.file?(f) }.max_by { |f| File.mtime(f) } end end |
#latest_commit ⇒ Object
latest local commit
109 110 111 112 113 114 115 116 |
# File 'lib/raykit/project.rb', line 109 def latest_commit return "" if detached? Dir.chdir(@directory) do text = `git log -n 1` scan = text.scan(/commit (\w+)\s/) return scan[0][0].to_s end end |
#latest_tag ⇒ Object
153 154 155 |
# File 'lib/raykit/project.rb', line 153 def latest_tag `git describe --abbrev=0`.strip end |
#latest_tag_commit ⇒ Object
157 158 159 |
# File 'lib/raykit/project.rb', line 157 def latest_tag_commit `git show-ref -s #{latest_tag}`.strip end |
#latest_tag_md5 ⇒ Object
161 162 163 164 165 166 167 |
# File 'lib/raykit/project.rb', line 161 def latest_tag_md5 text = `git tag #{latest_tag} -n3` scan = text.scan(/md5=(\w{32})/) return scan[0][0].to_s.strip if scan.length.positive? && scan[0].length.positive? "" end |
#outstanding_commit? ⇒ Boolean
118 119 120 121 122 123 |
# File 'lib/raykit/project.rb', line 118 def outstanding_commit? Dir.chdir(@directory) do return true unless `git status`.include?("nothing to commit") end false end |
#outstanding_tag? ⇒ Boolean
125 126 127 128 129 130 |
# File 'lib/raykit/project.rb', line 125 def outstanding_tag? # puts `git log -n 1` # !latest_tag_commit.eql?(latest_commit) # commit 2e4cb6d6c0721e16cd06afee85b7cdc27354921b (HEAD -> master, tag: 0.0.180, origin/master, origin/HEAD) outstanding_commit? || !`git log -n 1`.include?("tag:") end |
#pull ⇒ Object
293 294 295 296 297 298 |
# File 'lib/raykit/project.rb', line 293 def pull Dir.chdir(@directory) do run("git pull") end self end |
#push ⇒ Object
283 284 285 286 287 288 289 290 291 |
# File 'lib/raykit/project.rb', line 283 def push Dir.chdir(@directory) do status = `git status` if status.include?('use "git push"') run("git push") end end self end |
#read_only? ⇒ Boolean
132 133 134 135 |
# File 'lib/raykit/project.rb', line 132 def read_only? return true if !File.exist?(".git") || detached? return false end |
#run(command, quit_on_failure = true) ⇒ Object
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/raykit/project.rb', line 322 def run(command, quit_on_failure = true) if command.is_a?(Array) command.each { |subcommand| run(subcommand, quit_on_failure) } else cmd = Command.new(command).set_timeout(@timeout).run cmd.summary elapsed_str = Timer.get_elapsed_str(cmd.elapsed, 0) if !cmd.exitstatus.nil? && cmd.exitstatus.zero? else # display error details cmd.details if quit_on_failure abort end end cmd.save @commands << cmd cmd end end |
#set_version(version) ⇒ Object
149 150 151 |
# File 'lib/raykit/project.rb', line 149 def set_version(version) @version = version end |
#size ⇒ Object
175 176 177 178 179 180 181 182 183 184 |
# File 'lib/raykit/project.rb', line 175 def size Dir.chdir(@directory) do text = `git count-objects -v -H` if matches = text.match(/size: ([. \w]+)$/) matches[1] else text end end end |
#size_pack ⇒ Object
186 187 188 189 190 191 192 193 194 195 |
# File 'lib/raykit/project.rb', line 186 def size_pack Dir.chdir(@directory) do text = `git count-objects -v -H` if matches = text.match(/size-pack: ([. \w]+)$/) matches[1] else text end end end |
#summary ⇒ Object
250 251 252 253 |
# File 'lib/raykit/project.rb', line 250 def summary info if @verbose puts "[#{elapsed}] #{Rainbow(@name).yellow.bright} #{Rainbow(version).yellow.bright}" end |
#tag ⇒ Object
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/raykit/project.rb', line 300 def tag warn "[DEPRECATION] 'tag' is deprecated. Use run command(s) for better transparency." Dir.chdir(@directory) do specific_tag = `git tag -l #{@version}`.strip puts Rainbow("git tag - #{@version}").green if @verbose puts `git tag -l #{@version}` if @verbose if specific_tag.length.zero? puts "tag #{@version} not detected." if @verbose tag = `git describe --abbrev=0 --tags`.strip if @version != tag puts "latest tag #{@tag}" if @verbose run("git tag #{@version} -m'#{@version}'") run("git push origin #{@version}") # push end elsif @verbose puts "already has tag #{specific_tag}" end end self end |
#target_md5 ⇒ Object
def target
@target
end
93 94 95 96 97 |
# File 'lib/raykit/project.rb', line 93 def target_md5 return Digest::MD5.file(target).to_s.strip if !target.nil? && File.exist?(target) "" end |
#to_markdown ⇒ Object
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/raykit/project.rb', line 230 def to_markdown() md = "# #{@name}" md += get_markdown_nvp("Name", "Value", " ") md += get_markdown_nvp("-", "-", "-") md += get_markdown_nvp("Version", "#{@version}", " ") md += get_markdown_nvp("Machine", "#{Raykit::Environment::machine}", " ") md += get_markdown_nvp("User", "#{Raykit::Environment::user}", " ") @values.each do |key, value| md += get_markdown_nvp(key, value, " ") end @commands.each do |cmd| md = md + "\n" + cmd.to_markdown end md end |
#values ⇒ Object
104 105 106 |
# File 'lib/raykit/project.rb', line 104 def values @values end |