trk 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3da7a8df4179a04353de1da8f56b71fd084ea0b7323509669a033b5bbe0cd427
-  data.tar.gz: dcfe27b52720e39081f6c834e8b98becd7b142ccd033da7c59844c1ad10aa737
+  metadata.gz: daa75cf6eea07a201c466b5d8d18bf320ed898bf9458d94345b8481a0b9ec110
+  data.tar.gz: d1698a006089a9e4a49b6d63efed1aace33a9bdd9a311f99e6014e14994e5a26
 SHA512:
-  metadata.gz: 40d509303d7f61454e4d9c369c7600e7b6626bb2775160a27c69f2afe7709a4b256d393d4169592f791f7b8cdfba0b90ea88e151a1cc5c6bd532640214ea1241
-  data.tar.gz: 17d7a7f32106d78233e56a426d86000f7b08d53a6f161de9bc5d073409c7640eff887d15a9ace02434cff9019f232c60e0c691ea51b1937c37718104f8023381
+  metadata.gz: 0d77302b31fe36f291dd222e777de1f3f05999e8b67b03288296817e2e81e596017fe9a73507f5f89697e269c08e570eed3597774d0e2860ee163e00d607e574
+  data.tar.gz: ea4d57c56eb0edffc2498a10780b3f797d3d75f1b0c57a34b512dd01cf762111a7c6630a7cdcc683f71b866d73d317f9dfb54e68eadc8492aa9796833e85a8bc

data/README.md

@@ -17,16 +17,41 @@ mkdir ~/trk
 
 ### Links for code in README
 
-For code that is written only in README file we need to wrap with
-`This code is from: link` where link is a repo path with an anchor to
-subheader `#sub-header`, and finish with `End of code from: link`
+For complete file
+```
+# This code is from: https://trk.tools/app/trk-readme-source-links/-/blob/main/README.md
+```
+
+When only a part of the file is extracted from trk.tools use Start and End of
+code
+
 ```
 # .bashrc
-# This code is from: https://trk.tools/app/trk-readme-source-links#links-for-code-in-readme
+# Start of code from: https://trk.tools/app/trk-readme-source-links#links-for-code-in-readme
 ...
 # End of code from: https://trk.tools/app/trk-readme-source-links#links-for-code-in-readme
 ```
 
+For download use `wget` and `raw` instead of `blob`
+```
+# wget -P path https://trk.tools/app/trk-readme-source-links/-/raw/main/README.md
+```
+
+Using this gem you can get the string with
+```
+trk link-show
+```
+
+For vim you can use mapping
+```
+# .vimrc
+nnoremap <leader>s :r !trk link-show %<CR>
+
+# local gem
+nnoremap <leader>s :r !cd ~/trk.tools/app/trk-readme-source-links && bundle exec exe/trk link-show %:p<CR>
+nnoremap <leader>r :r !cd ~/trk.tools/app/trk-readme-source-links && bundle exec exe/trk link-show-raw %:p<CR>
+```
+
 ### Links for code in other files
 
 For other files we need to link to specific file
@@ -62,9 +87,39 @@ Run without installing the gem
 bundle exec exe/trk pull
 ```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To put a debugger use
+```
+binding.break
+```
+
+## Test
+
+To run all tests
+```
+rake test
+```
+To run single file
+```
+ruby -Itest test/test_link.rb
+```
+or single test
+```
+ruby -Itest test/test_link.rb --name test_link_show_success
+```
+
+## Gem push
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `lib/trk/version.rb`, and
+then deploy with:
+```
+bundle exec rake release
+```
+which will create a git tag for the version, push git commits and the created
+tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/trk/cli.rb

@@ -2,9 +2,29 @@ require "thor"
 require "open3"
 require "net/http"
 require "uri"
+require "debug"
 
 module Trk
   class CLI < Thor
+    def self.start(given_args = ARGV, config = {})
+      if given_args.include?("--version") || given_args.include?("-v")
+        puts "trk version #{VERSION}"
+        exit
+      end
+      super
+    end
+
+    def self.help(shell, subcommand = false)
+      super
+      puts "\n To enable autocomplete, put in .bashrc: 'complete -W \"$(trk completion)\" trk', eg:\n"
+      puts "echo '# https://trk.tools/app/trk-readme-source-links\ncomplete -W \"$(trk completion)\" trk' >> ~/.bashrc && source ~/.bashrc"
+    end
+
+    desc "completion", "Outputs available commands for autocompletion"
+    def completion
+      puts self.class.all_commands.keys.join(" ")
+    end
+
     desc "add_github_keys USERNAME", "Add Github user public keys to .ssh/authorized_keys"
     def add_github_keys(username)
       uri = URI "https://trk.tools/sh/ssh-tips/-/raw/main/add_github_keys_to_authorized_keys.sh"
@@ -56,5 +76,50 @@ module Trk
 
       puts "\n#{CHECK_ICON} All done!"
     end
+
+    desc "link-show FILENAME", "Show link of the file"
+    def link_show(filename)
+      result = Link.new(filename).show
+      if result.success?
+        # puts "#{CHECK_ICON} link done #{result.message}\n#{result.data[:link]}"
+        puts result.data[:link]
+      else
+        puts "#{UNCHECK_ICON} link failed\n#{result.message}"
+      end
+    end
+
+    desc "link-show-raw FILENAME", "Show wget link of the file"
+    def link_show_raw(filename)
+      result = Link.new(filename).raw
+      if result.success?
+        # puts "#{CHECK_ICON} link done #{result.message}\n#{result.data[:link]}"
+        puts result.data[:link]
+      else
+        puts "#{UNCHECK_ICON} link failed\n#{result.message}"
+      end
+    end
+
+    desc "sos", "Add sos script to .bashrc if not already there"
+    def sos(*arguments)
+      command = <<~HERE_DOC
+        # Start of code: https://trk.tools/sh/screen-tips#remote-multiuser-access-help-using-ssh-and-gnu-screen
+        # remote version
+        sos() { sos_user=$1 sos_port=$2 sos_host=h2.trk.tools bash <(curl -sL sos.trk.tools) ;}
+        # local version
+        # sos() { sos_user=$1 sos_port=$2 sos_host=h2.trk.tools ~/trk.tools/sh/screen-tips/remote_multiuser_access_help_using_ssh_and_gnu_screen.sh ;}
+        # End of code: https://trk.tools/sh/screen-tips#remote-multiuser-access-help-using-ssh-and-gnu-screen
+      HERE_DOC
+      bashrc_path = File.expand_path("~/.bashrc")
+      bashrc_content = File.read(bashrc_path) if File.exist?(bashrc_path)
+      if bashrc_content&.include?("sos()")
+        puts "#{UNCHECK_ICON} sos already exists in .bashrc"
+      else
+        File.open(bashrc_path, "a") do |file|
+          file.puts
+          file.puts command
+        end
+        puts "#{CHECK_ICON} sos function added to .bashrc, please open new terminal, or run: source ~/.bashrc"
+      end
+    end
   end
 end

data/lib/trk/link.rb

@@ -0,0 +1,40 @@
+module Trk
+  class Link
+    BASE_URL = "https://trk.tools"
+    BRANCH_PREFIX = "-/blob/main/"
+    BRANCH_RAW_PREFIX = "-/raw/main/"
+    THIS_CODE_IS_FROM = "This code is from:"
+    START_OF_CODE_FROM = "Start of code from:"
+    END_OF_CODE_FROM = "End of code from:"
+    WGET = "#   wget -P"
+
+    def initialize(filename = nil)
+      @filename = filename
+    end
+
+    def show
+      full_path = File.absolute_path?(@filename) ? @filename : File.expand_path(@filename)
+      home_path = Dir.home
+      folders_from_home = full_path.sub(/^#{Regexp.escape(home_path)}\//, "").split("/")
+      return Error.new "File #{@filename} is not inside ~/trk.tools" unless folders_from_home.first == "trk.tools"
+
+      repo_path = folders_from_home[1..2].join("/")
+      file_path = folders_from_home[3..].join("/")
+      link = "# #{THIS_CODE_IS_FROM} #{BASE_URL}/#{repo_path}/#{BRANCH_PREFIX}#{file_path}"
+      Result.new "OK", link: link
+    end
+
+    def raw
+      full_path = File.absolute_path?(@filename) ? @filename : File.expand_path(@filename)
+      home_path = Dir.home
+      folders_from_home = full_path.sub(/^#{Regexp.escape(home_path)}\//, "").split("/")
+      return Error.new "File #{@filename} is not inside ~/trk.tools" unless folders_from_home.first == "trk.tools"
+
+      repo_path = folders_from_home[1..2].join("/")
+      file_path = folders_from_home[3..].join("/")
+      file_folder = folders_from_home[3..-2].join("/") || "."
+      link = "#{WGET} #{file_folder} #{BASE_URL}/#{repo_path}/#{BRANCH_RAW_PREFIX}#{file_path}"
+      Result.new "OK", link: link
+    end
+  end
+end

data/lib/trk/result_and_error.rb

@@ -0,0 +1,42 @@
+class Result
+  attr_accessor :message, :data
+
+  # Use this to class to return results from service:
+  #
+  #   class MyService
+  #     def perform
+  #       if true
+  #         Result.new "Next task created", next_task: next_task
+  #       else
+  #         Error.new "Failed"
+  #       end
+  #     end
+  #   end
+  #
+  # and use in controller:
+  #
+  #   result = MyService.new.perform
+  #   if result.success?
+  #     flash[:notice] = result.message
+  #     redirect_to result.data[:next_task]
+  #   end
+  #
+  # Note when iterating a huge objects, use `next_task_id` so Ruby Garbage
+  # Collector can clear all temp objects from the service run
+  # If you return some object which is not basic, it can not safely clear all
+  # temp objects
+  #
+  def initialize(message, data = {})
+    @message, @data = message, data
+  end
+
+  def success?
+    true
+  end
+end
+
+class Error < Result
+  def success?
+    false
+  end
+end

data/lib/trk/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Trk
-  VERSION = "0.1.3"
+  VERSION = "0.1.6"
   CHECK_ICON = "✅ "
   UNCHECK_ICON = "❌ "
 end

data/lib/trk.rb

@@ -2,8 +2,8 @@
 
 require_relative "trk/version"
 require_relative "trk/cli"
+require_relative "trk/link"
+require_relative "trk/result_and_error"
 
 module Trk
-  class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: trk
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Dusan Orlovic
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -41,6 +40,8 @@ files:
 - exe/trk
 - lib/trk.rb
 - lib/trk/cli.rb
+- lib/trk/link.rb
+- lib/trk/result_and_error.rb
 - lib/trk/version.rb
 - sig/trk.rbs
 homepage: https://trk.tools
@@ -49,7 +50,6 @@ licenses:
 metadata:
   homepage_uri: https://trk.tools
   source_code_uri: https://trk.tools/app/trk-readme-source-links
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: CLI tools to manipulate https://trk.tools README files and projects.
 test_files: []