devlogs 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ee70029616eb23078cfe60734052a855642617338f776543da002c18986cfad
-  data.tar.gz: 8169a90b74e0524f6b9b0ebdb786ff0fb1df38e8d59c7d6bbdbbce7936d037d5
+  metadata.gz: 2023b8563770781f9708368975e70b713ec937df3331461096841e4f0fbd03a3
+  data.tar.gz: b1e7b12bac7c07aede0fa9dc8e8daca29db668e256c7a73067bc1f56993cad58
 SHA512:
-  metadata.gz: 3aba32f26e6905b876ad6e0777a86d29abfe1ea0642180fe1320ee82b20cc3a8efd2e22088d3b469149f920fa12808166ee7572b1f2207337afbf146bbac38cc
-  data.tar.gz: 9fa406dae78b034c22c9db6f992e00a0255c920bb569f68fb4c5a20a295df8bcab8fad4f7f58f1d8a4f0870e05025f0d7b7c135bd50feea06e5b31ccf5b62fcf
+  metadata.gz: 88c3a1909b19c35619abcaabd5815843ccb334362f2a1d5a8be7efb9f82fc64be9c43f51a1b0c76be012ef043b4a1b66bc0a4643ca2cb248ccafb3ee8a4b9fb3
+  data.tar.gz: 925757b3d644479dc402f2c17a762a349a9eb8b5dda7a75ecb88ec71e9712933b1fd223d239164ce4a24b8e0864040ad51c1a5f78ccce42535b1599f3b5ebfd3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devlogs (0.2.0)
+    devlogs (0.3.1)
       rsync (~> 1.0, >= 1.0.9)
       thor (~> 1.2.1)
       tty-prompt (~> 0.23.1)

data/Makefile

@@ -0,0 +1,16 @@
+PROJECT=devlogs
+
+console:
+	@bundle exec bin/console
+
+setup:
+	@bundle exec bin/setup
+
+install:
+	@bundle exec rake install
+
+release:
+	@bundle exec rake release
+
+release.gh:
+	@gh release create

data/lib/devlogs/cli.rb

@@ -3,6 +3,8 @@
 require_relative "version"
 require_relative "repository"
 require_relative "editor"
+require_relative "pager"
+require_relative "prompt_utils"
 require "thor"
 
 module Devlogs
@@ -10,6 +12,8 @@ module Devlogs
   # The CLI devlogs CLI
   #
   class CLI < Thor
+    include PromptUtils
+
     package_name "devlogs"
 
     # Returns exit with non zero status when an exception occurs
@@ -68,6 +72,23 @@ module Devlogs
       repo.sync
     end
 
+    #
+    # Lists repository logs
+    #
+    desc "ls", "Lists the repository logs and allows you to select"
+    def ls
+      entries = repo.ls
+
+      # Use the file names as visible keys for the prompt
+      entry_names = entries.map { |e| File.basename(e) }
+
+      # Build the TTY:Prompt
+      result = build_select_prompt(data: entry_names, text: "Select a log entry...")
+
+      # Open in paging program
+      Pager.open(entries[result])
+    end
+
     private
 
     # Helper method for repository loading

data/lib/devlogs/editor.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require_relative "./executable.rb"
+
 # Wrapper for terminal editor
-class Editor
+class Editor < Executable
   def initialize
     @program = ENV["EDITOR"]
   end

data/lib/devlogs/executable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Executable
+  def initialize
+    raise NotImplementedError, "Abstract class"
+  end
+
+  # Opens the file contained at the path
+  def open(path)
+    command = "#{@program} #{path}"
+
+    system command
+  end
+
+  class << self
+    # Opens the file at +path+ using system editor
+    def open(path)
+      session = new
+
+      session.open(path)
+    end
+  end
+end

data/lib/devlogs/pager.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Wrapper for terminal reader
+require_relative "./executable.rb"
+
+# Wrapper for terminal pager
+class Pager < Executable
+  def initialize
+    @program = ENV["PAGER"]
+  end
+end

data/lib/devlogs/prompt_utils.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+#
+# Utility module for tty-prompt library
+#
+module PromptUtils
+  #
+  # Builds a basic select prompt using the provided data
+  #
+  # @param data [Array<String>]
+  #
+  # @returns String
+  #
+  def build_select_prompt(data:, text:)
+    ttyprompt = TTY::Prompt.new
+
+    ttyprompt.select(text) do |menu|
+      data.each_with_index do |d, index|
+        menu.choice d, index
+      end
+    end
+  end
+end

data/lib/devlogs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Devlogs
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devlogs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - aquaflamingo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsync
@@ -86,6 +86,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -96,6 +97,9 @@ files:
 - lib/devlogs.rb
 - lib/devlogs/cli.rb
 - lib/devlogs/editor.rb
+- lib/devlogs/executable.rb
+- lib/devlogs/pager.rb
+- lib/devlogs/prompt_utils.rb
 - lib/devlogs/repository.rb
 - lib/devlogs/version.rb
 homepage: http://github.com/aquaflamingo/devlogs