devlogs 0.1.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7ac238f0667f25c6b370f32660aa2d089ebbfff0ecec9bffb012f9851188174
-  data.tar.gz: 93aaabcee373c6511a479e6cf21b6803af0cfec922e4416fed2406a966307ced
+  metadata.gz: 2023b8563770781f9708368975e70b713ec937df3331461096841e4f0fbd03a3
+  data.tar.gz: b1e7b12bac7c07aede0fa9dc8e8daca29db668e256c7a73067bc1f56993cad58
 SHA512:
-  metadata.gz: 5833adbd0231c8fe941364cec3dd6d83878999ed67b8ebf055dda56a12289a0e609ac8cb3e2868db2f4e570e52958622f7f25f997701baf130cf86e730a5daa1
-  data.tar.gz: fe438af20e0f8ec3326bf56ee410f037ef81495e39218586ad70ff8ae7a50a056f2c409db0b4dc02914c47dfb7dca157a9c4082bf0926c6bf739f8f9800f26a3
+  metadata.gz: 88c3a1909b19c35619abcaabd5815843ccb334362f2a1d5a8be7efb9f82fc64be9c43f51a1b0c76be012ef043b4a1b66bc0a4643ca2cb248ccafb3ee8a4b9fb3
+  data.tar.gz: 925757b3d644479dc402f2c17a762a349a9eb8b5dda7a75ecb88ec71e9712933b1fd223d239164ce4a24b8e0864040ad51c1a5f78ccce42535b1599f3b5ebfd3

data/.gitignore

@@ -10,3 +10,4 @@ __devlog
 *.gem
 __devlogs
 mirror
+_devlogs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devlogs (0.1.6)
+    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/README.md

@@ -1,6 +1,4 @@
 # devlogs
-![Version](https://img.shields.io/badge/version-0.1.4-green)
-
 Project based session logging for solo-developers with the option to mirror changes to another directory.
 
 https://stacktrace.one/blog/avoid-project-management-solo-dev/
@@ -25,12 +23,12 @@ Or install it yourself as:
 
 ## Usage
 ### Initialize
-Inside your project initialize the `__devlogs` repository:
+Inside your project initialize the `_devlogs` repository:
 ```bash
 $ devlogs init
 ```
 
-Follow the prompts to setup the project configuration located in `__devlogs/.devlogs.config`. 
+Follow the prompts to setup the project configuration located in `_devlogs/.devlogs.config`. 
 
 You can setup a mirror directory path in the configuration stage to sync changes to another directory on your machine, for example to Obsidian.md.
 
@@ -38,7 +36,7 @@ Example:
 
 ```
 myproject
- __devlogs
+ _devlogs
    >> content
 ```
 
@@ -68,6 +66,15 @@ Your editor will pop up and you can fill in cliff notes.
 
 Save and if you set a mirror it will sync over!
 
+### Retrieve previous entry
+You can use the `last` command to retrieve the most recent entry
+
+```bash
+devlogs last
+```
+
+The `--open` command will cause the entry to be opened in a new default editor.
+
 ## Development
 
 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.

data/lib/devlogs/cli.rb

@@ -2,6 +2,9 @@
 
 require_relative "version"
 require_relative "repository"
+require_relative "editor"
+require_relative "pager"
+require_relative "prompt_utils"
 require "thor"
 
 module Devlogs
@@ -9,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
@@ -34,12 +39,27 @@ module Devlogs
 
       Repository::Initialize.run(
         { force: options.force? },
-        File.join(".", "__devlogs")
+        File.join(".", "_devlogs")
       )
 
       puts "Created devlogs"
     end
 
+    #
+    # Retrieves the most recent entry from the repository
+    #
+    desc "last", "Retrieves the last entry in the repository"
+    method_options open: :boolean, alias: :string
+    def last
+      puts "Reading last entry"
+      last_entry = repo.ls.first
+
+      if options.open?
+        Editor.open(last_entry)
+      else
+        puts File.read(last_entry)
+      end
+    end
     #
     # Creates a devlogs entry in the repository and syncs changes
     # to the mirrored directory if set
@@ -52,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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "./executable.rb"
+
+# Wrapper for terminal editor
+class Editor < Executable
+  def initialize
+    @program = ENV["EDITOR"]
+  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/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/repository.rb

@@ -5,6 +5,8 @@ require "tty-prompt"
 require "yaml"
 require "rsync"
 require "pry"
+require "time"
+require_relative "editor"
 
 # Repostiroy is an accessor object for the devlogs directory
 class Repository
@@ -13,20 +15,22 @@ class Repository
   # TODO: should be part of configuration
   DEFAULT_LOG_SUFFIX = "devlogs.md"
   DEFAULT_DIRECTORY_PATH = "."
-  DEFAULT_DIRECTORY_NAME = "__devlogs"
+  DEFAULT_DIRECTORY_NAME = "_devlogs"
 
   # Example: 11-22-2022_1343
   DEFAULT_TIME_FORMAT_FILE_PREFIX = "%m-%d-%Y__%kh%Mm"
   DEFAULT_TIME_FORMAT_TEXT_ENTRY = "%m-%d-%Y %k:%M"
 
-  # Initializes a __devlogs repository with the supplied configuration
+  VALID_DIRECTION = %i[asc desc].freeze
+
+  # Initializes a _devlogs repository with the supplied configuration
   # @param repo_config [Repository::Config]
   #
   def initialize(repo_config)
     @config = repo_config
   end
 
-  # Creates a new __devlogs entry for recording session completion
+  # Creates a new _devlogs entry for recording session completion
   #
   # @returns nil
   def create
@@ -50,9 +54,7 @@ class Repository
       end
     end
 
-    editor_program = ENV["EDITOR"]
-
-    system("#{editor_program} #{entry_file_path}")
+    Editor.open(entry_file_path)
 
     puts "Writing entry to #{entry_file_path}.."
   end
@@ -67,9 +69,8 @@ class Repository
 
       # Use trailing slash to avoid sub-directory
       # See rsync manual page
-      path = @config.path[-1] == "/" ? @config.path : @config.path + "/"
 
-      Rsync.run("-av", path, @config.mirror.path) do |result|
+      Rsync.run("-av", @config.path(with_trailing: true), @config.mirror.path) do |result|
         if result.success?
           puts "Mirror sync complete."
           result.changes.each do |change|
@@ -82,6 +83,25 @@ class Repository
     end
   end
 
+  # Lists the files in the repository
+  def ls(direction = :desc)
+    raise ArgumentError, "Must be one of: " + VALID_DIRECTION unless VALID_DIRECTION.include?(direction.to_sym)
+
+    Dir.glob(File.join(@config.path, "*_#{DEFAULT_LOG_SUFFIX}")).sort_by do |fpath|
+      # The date is joined by two underscores to the suffix
+      date, = File.basename(fpath).split("__")
+
+      time_ms = Time.strptime(date, "%m-%d-%Y").to_i
+
+      # Descending
+      if direction == :asc
+        time_ms
+      else
+        -time_ms
+      end
+    end
+  end
+
   class << self
     # Loads a repository from the provided path
     #
@@ -105,15 +125,16 @@ class Repository
   # Config is a configuration data object for storing Repository configuration
   # in memory for access.
   class Config
-    attr_reader :name, :description, :mirror, :path
+    attr_reader :name, :description, :mirror, :path_value
 
+    # Configuration associated with the Mirror
     MirrorConfig = Struct.new(:use_mirror, :path, keyword_init: true)
 
     def initialize(name, desc, mirror, p)
       @name = name
       @description = desc
       @mirror = MirrorConfig.new(mirror)
-      @path = p
+      @path_value = p
     end
 
     # Returns whether or not the devlogs repository is configured to mirror
@@ -123,6 +144,14 @@ class Repository
       @mirror.use_mirror
     end
 
+    def path(with_trailing: false)
+      if with_trailing
+        @path_value[-1] == "/" ? @path_value : @path_value + "/"
+      else
+        @path_value
+      end
+    end
+
     # Utility method to build a configuration from a Hash
     #
     # @returns [Repository::Config]

data/lib/devlogs/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devlogs
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.3.1
 platform: ruby
 authors:
 - aquaflamingo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-21 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
@@ -95,6 +96,10 @@ files:
 - exe/devlogs
 - 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