devlogs 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99f8b324427d042c22df13670cd362387c29d2392d3c5ac5b4dc3933e7a6350
-  data.tar.gz: 10e884ccc05ab8f967ef1b12eb8b28bb728d0642510e9279c76f2c696929cbb8
+  metadata.gz: 0ee70029616eb23078cfe60734052a855642617338f776543da002c18986cfad
+  data.tar.gz: 8169a90b74e0524f6b9b0ebdb786ff0fb1df38e8d59c7d6bbdbbce7936d037d5
 SHA512:
-  metadata.gz: 41736e5c49fae07395e3da06f9aba779a48d14b5ded23ba0a062ff9de1a176050fee2208a959417846e9029166c4deb59eb93114dc93c67e3c7c55415b0be550
-  data.tar.gz: e9854ed3e849a7208a8c9e3c82410973945c99a9a2e488a9f153f8612bcb80ed5f3a66f6a45f2d8cfe4945bb66b6abad3738b2df339a429bf5b7d9e7d31945cb
+  metadata.gz: 3aba32f26e6905b876ad6e0777a86d29abfe1ea0642180fe1320ee82b20cc3a8efd2e22088d3b469149f920fa12808166ee7572b1f2207337afbf146bbac38cc
+  data.tar.gz: 9fa406dae78b034c22c9db6f992e00a0255c920bb569f68fb4c5a20a295df8bcab8fad4f7f58f1d8a4f0870e05025f0d7b7c135bd50feea06e5b31ccf5b62fcf

data/.gitignore

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

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,4 @@
 # devlogs
-![Version](https://img.shields.io/badge/version-0.1.0-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/exe/devlogs

@@ -3,4 +3,4 @@
 
 require "devlogs"
 
-Devlogs::App.start(ARGV)
+Devlogs::CLI.start(ARGV)

data/lib/devlogs/cli.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "version"
+require_relative "repository"
+require_relative "editor"
+require "thor"
+
+module Devlogs
+  #
+  # The CLI devlogs CLI
+  #
+  class CLI < Thor
+    package_name "devlogs"
+
+    # Returns exit with non zero status when an exception occurs
+    def self.exit_on_failure?
+      true
+    end
+
+    #
+    # Returns version of the cli
+    #
+    desc "version", "Prints the current version"
+    def version
+      puts Devlogs::VERSION
+    end
+
+    #
+    # Initializes a +devlogs+ repository with a configuration
+    #
+    desc "init", "Initialize a developer logs for project"
+    method_options force: :boolean, alias: :string
+    def init
+      puts "Creating devlogs repository"
+
+      Repository::Initialize.run(
+        { force: options.force? },
+        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
+    #
+    desc "entry", "Create a new devlogs entry" # [4]
+    def entry
+      puts "Creating new entry..."
+      repo.create
+
+      repo.sync
+    end
+
+    private
+
+    # Helper method for repository loading
+    #
+    def repo
+      @repo ||= Repository.load
+    end
+  end
+end

data/lib/devlogs/editor.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Wrapper for terminal editor
+class Editor
+  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/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
@@ -42,6 +46,7 @@ class Repository
       File.open(entry_file_path, "w") do |f|
         f.write <<~ENDOFFILE
           # #{time.strftime(DEFAULT_TIME_FORMAT_TEXT_ENTRY)}
+          Tags: #dev, #log
 
           What did you do today?
 
@@ -49,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
@@ -66,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|
@@ -81,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
     #
@@ -104,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
@@ -122,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]
@@ -146,7 +176,11 @@ class Repository
 
       FileUtils.mkdir_p(path)
       config_file = File.join(path, CONFIG_FILE)
-      info_file_name = "#{results[:name].gsub(/ /, "_")}_devlogs.info"
+
+      # Replace spaces in project name with underscores
+      sanitized_project_name = results[:name].gsub(/ /, "_").downcase
+
+      info_file_name = "#{sanitized_project_name}_devlogs.info.md"
       info_file = File.join(path, info_file_name)
 
       # Create config file
@@ -154,10 +188,20 @@ class Repository
         f.write results.to_yaml
       end
 
+      # Create the info file
       File.open(info_file, "w") do |f|
         f.puts "# #{results[:name]}"
         f.puts (results[:desc]).to_s
       end
+
+      # Git ignore if specified
+      if results[:gitignore]
+        gitignore = File.join(path, ".gitignore")
+
+        File.open(gitignore, "a") do |f|
+          f.puts DEFAULT_DIRECTORY_NAME
+        end
+      end
     end
 
     # Creates an interactive prompt for user input
@@ -181,6 +225,10 @@ class Repository
           key(:use_mirror).ask("Do you want to mirror these logs?", convert: :boolean)
           key(:path).ask("Path to mirror directory: ")
         end
+
+        key(:gitignore).ask("Do you want to gitignore the devlogs repository?") do |q|
+          q.required true
+        end
       end
     end
   end

data/lib/devlogs/version.rb

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

data/lib/devlogs.rb

@@ -1,56 +1,3 @@
 # frozen_string_literal: true
 
-require_relative "devlogs/version"
-require_relative "devlogs/repository"
-
-require "thor"
-
-module Devlogs
-  #
-  # The CLI devlogs App
-  #
-  class App < Thor
-    package_name "devlogs"
-
-    # Returns exit with non zero status when an exception occurs
-    def self.exit_on_failure?
-      true
-    end
-
-    #
-    # Initializes a +devlogs+ repository with a configuration
-    #
-    desc "init", "Initialize a developer logs for project"
-    method_options force: :boolean, alias: :string
-    def init
-      puts "Creating devlogs repository"
-
-      Repository::Initialize.run(
-        { force: options.force? },
-        File.join(".", "__devlogs")
-      )
-
-      puts "Created devlogs"
-    end
-
-    #
-    # Creates a devlogs entry in the repository and syncs changes
-    # to the mirrored directory if set
-    #
-    desc "entry", "Create a new devlogs entry" # [4]
-    def entry
-      puts "Creating new entry..."
-      repo.create
-
-      repo.sync
-    end
-
-    private
-
-    # Helper method for repository loading
-    #
-    def repo
-      @repo ||= Repository.load
-    end
-  end
-end
+require_relative "devlogs/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devlogs
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - aquaflamingo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsync
@@ -94,6 +94,8 @@ files:
 - docs/mirroring.png
 - exe/devlogs
 - lib/devlogs.rb
+- lib/devlogs/cli.rb
+- lib/devlogs/editor.rb
 - lib/devlogs/repository.rb
 - lib/devlogs/version.rb
 homepage: http://github.com/aquaflamingo/devlogs
@@ -118,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A command line utility to create and manage project management with a logs