devlogs 0.3.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2023b8563770781f9708368975e70b713ec937df3331461096841e4f0fbd03a3
-  data.tar.gz: b1e7b12bac7c07aede0fa9dc8e8daca29db668e256c7a73067bc1f56993cad58
+  metadata.gz: 710e8aea6a7ce1d312e3f94c36bb01c718358e94d46be5745956ffa66e902c77
+  data.tar.gz: f02110b5872d1cc117aad8b4e5cd5e5baabdb160336a9a300d96b16ad08aca5a
 SHA512:
-  metadata.gz: 88c3a1909b19c35619abcaabd5815843ccb334362f2a1d5a8be7efb9f82fc64be9c43f51a1b0c76be012ef043b4a1b66bc0a4643ca2cb248ccafb3ee8a4b9fb3
-  data.tar.gz: 925757b3d644479dc402f2c17a762a349a9eb8b5dda7a75ecb88ec71e9712933b1fd223d239164ce4a24b8e0864040ad51c1a5f78ccce42535b1599f3b5ebfd3
+  metadata.gz: 70776c55ba2df5ac5c14d96e6a773a30821e8ceb7fbcffeb9af65c005cd54cf04ec161dff61b8f0285f1324921ca1fb7d92aa05ce8ce48056423c5a7b3a1f28e
+  data.tar.gz: 371ede787d87a78a2de645734e8a0953467acb7a9e64a01c5d887057b894eefe3530649c2d482462d05119fc28fec9c5e6aeb37705944aab9641881c39ebb6ee

data/.gitignore

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

data/Gemfile.lock

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

data/README.md

@@ -23,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 the _default_ `.devlogs/.devlogs.config`. (You can optionally set where you want to initialize the repository via --dirpath)
 
 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.
 
@@ -36,7 +36,7 @@ Example:
 
 ```
 myproject
- _devlogs
+ .devlogs
    >> content
 ```
 
@@ -47,11 +47,12 @@ obsidianvault
      >> content mirrored here
 ```
 
-### Creating entries
-Once you are done for the day or session run the `entry` command:
+### Logs 
+#### Creating log entries
+Once you are done for the day or session run the `new` command:
 
 ```bash
-devlogs entry
+devlogs new
 ```
 
 Your editor will pop up and you can fill in cliff notes.
@@ -66,24 +67,60 @@ 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
+#### 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.
+#### List all log entires
+You can use the `ls` command to retrieve the most recent entry
 
-## Development
+```bash
+devlogs ls
+```
+
+### Issues
+Devlogs also allows you to manage issues locally as well. Devlogs creates a separate subdirectory in the `.devlogs` folder which will contain all issues. These files are also synced if the repository is mirrored.
+
+#### Creating an Issue
+You can create a new issue via `devlogs new_issue`. You will be prompted to provide some information and then your editor will open and you can fill in some details
+
+```bash
+devlogs new_issue
+```
+
+#### List all issues
+You can use the `ls_issues` command to retrieve the most recent entry
 
+```bash
+devlogs ls_issues
+```
+
+### Custom Templates
+Devlogs initializes the log repository with two custom templates that you can edit freely `.log_template.erb.md` and `.issue_template.erb.md`. These are [Embedded Ruby Files](https://en.wikipedia.org/wiki/ERuby) meaning they can access certain variables.
+
+#### Log Template
+| Variable Name | Value |
+| --- | --- |
+| Time | The current date, hour and minute time |
+
+#### Issue Template
+| Variable Name | Value |
+| --- | --- |
+| Time | The current date, hour and minute time |
+| Issue Title | The provided issue title input from the issue creation prompt |
+| Description | The provided description input from the issue creation prompt |
+| Reproduction Steps | The provided input for reproduction steps from the issue creation prompt |
+
+## 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.
 
 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).
 
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devlogs.
+Bug reports and pull requests are welcome on GitHub at https://github.com/aquaflamingo/devlogs.
 
 ## License
 

data/lib/devlogs/cli.rb

@@ -4,7 +4,8 @@ require_relative "version"
 require_relative "repository"
 require_relative "editor"
 require_relative "pager"
-require_relative "prompt_utils"
+require_relative "helper/tty_prompt_helper"
+require_relative "repository/initializer"
 require "thor"
 
 module Devlogs
@@ -12,7 +13,7 @@ module Devlogs
   # The CLI devlogs CLI
   #
   class CLI < Thor
-    include PromptUtils
+    include TTYPromptHelper
 
     package_name "devlogs"
 
@@ -33,16 +34,19 @@ module Devlogs
     # Initializes a +devlogs+ repository with a configuration
     #
     desc "init", "Initialize a developer logs for project"
-    method_options force: :boolean, alias: :string
+    method_options force: :boolean
+    method_options dirpath: :string
     def init
       puts "Creating devlogs repository"
 
-      Repository::Initialize.run(
-        { force: options.force? },
-        File.join(".", "_devlogs")
+      Repository::Initializer.run(
+        {
+          force: options.force?,
+          dirpath: options.dirpath
+        }
       )
 
-      puts "Created devlogs"
+      puts "Created devlogs repository"
     end
 
     #
@@ -60,18 +64,53 @@ module Devlogs
         puts File.read(last_entry)
       end
     end
+
+    # FIXME: Add logs sub command
     #
     # 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
+    desc "new", "Create a new devlogs entry" # [4]
+    def new
       puts "Creating new entry..."
       repo.create
 
       repo.sync
     end
 
+    # FIXME: Add logs sub command
+    #
+    # Creates a devlogs entry in the repository and syncs changes
+    # to the mirrored directory if set
+    #
+    desc "new_issue", "Create a new devlogs entry" # [4]
+    def new_issue
+      repo.create_issue
+      repo.sync
+    end
+
+    #
+    # Lists repository issues
+    #
+    desc "ls_issues", "Lists the repository issues and allows you to select"
+    def ls_issues
+      issues = repo.ls_issues
+
+      if issues.empty?
+        puts "No issues present in this repository"
+        exit 0
+      end
+
+      # Use the file names as visible keys for the prompt
+      issue_names = issues.map { |e| File.basename(e) }
+
+      # Build the TTY:Prompt
+      result = build_select_prompt(data: issue_names, text: "Select an issue issue...")
+
+      # Open in paging program
+      Pager.open(issues[result])
+    end
+
     #
     # Lists repository logs
     #
@@ -79,6 +118,11 @@ module Devlogs
     def ls
       entries = repo.ls
 
+      if entries.empty?
+        puts "No logs present in this repository"
+        exit 0
+      end
+
       # Use the file names as visible keys for the prompt
       entry_names = entries.map { |e| File.basename(e) }
 
@@ -94,6 +138,7 @@ module Devlogs
     # Helper method for repository loading
     #
     def repo
+      # FIXME: Need to add in path specification here
       @repo ||= Repository.load
     end
   end

data/lib/devlogs/gem.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Devlogs
+  def self.lib_root
+    File.join(File.dirname(__dir__), "devlogs")
+  end
+end

data/lib/devlogs/helper/time_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TimeHelper
+  # Example: 11-22-2022__13h43m
+  TIME_FORMAT_FILE_PREFIX = "%m-%d-%Y__%kh%Mm"
+
+  def current_time(format: TIME_FORMAT_FILE_PREFIX)
+    time = Time.new
+    time.strftime(format)
+  end
+end

data/lib/devlogs/{prompt_utils.rb → helper/tty_prompt_helper.rb}

@@ -5,7 +5,7 @@ require "tty-prompt"
 #
 # Utility module for tty-prompt library
 #
-module PromptUtils
+module TTYPromptHelper
   #
   # Builds a basic select prompt using the provided data
   #
@@ -22,4 +22,10 @@ module PromptUtils
       end
     end
   end
+
+  module Validator
+    def self.length_range(min: 0, max: 99)
+      ->(input) { input.size > min && input.size <= max }
+    end
+  end
 end

data/lib/devlogs/render/erb_template_renderer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "erb"
+
+#
+# ErbTemplateRenderer is a base class for rendering arbitrary
+# ERB templates.
+#
+class ErbTemplateRenderer
+  attr_reader :time
+
+  TIME_FORMAT_TEXT_ENTRY = "%m-%d-%Y %k:%M"
+
+  def initialize(template_file_path)
+    @time = Time.new.strftime(TIME_FORMAT_TEXT_ENTRY)
+    @template_file_path = template_file_path
+  end
+
+  #
+  # Runs the ERB rendering using the provided template file template_file_path
+  #
+  # @returns [String]
+  #
+  def render
+    erb = ERB.new(File.read(@template_file_path))
+    erb.result(get_binding)
+  end
+
+  # rubocop:disable
+  #
+  # For ERB
+  #
+  def get_binding
+    binding
+  end
+end

data/lib/devlogs/render/issue_template_renderer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "erb_template_renderer"
+
+#
+# IssueTemplateRenderer captures issue information and
+# renders it within a given ERB template
+#
+class IssueTemplateRenderer < ErbTemplateRenderer
+  attr_reader :title, :description, :reproduction
+
+  def initialize(template_file_path, info = {})
+    super(template_file_path)
+
+    @title = info[:display_title]
+    @description = info[:description]
+    @reproduction = info[:reproduction]
+  end
+end

data/lib/devlogs/render/log_template_renderer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "erb_template_renderer"
+
+#
+# LogTemplateRenderer captures log information and
+# renders it within a given ERB template
+#
+class LogTemplateRenderer < ErbTemplateRenderer
+end

data/lib/devlogs/repository/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# The repository's configuration values located in the yml file
+class Repository
+  class Config
+    # FIXME: Need to figure out file path
+    attr_reader :name, :description, :mirror, :file_path, :template_file_path, :short_code
+
+    # Configuration associated with the Mirror
+    MirrorConfig = Struct.new(:use_mirror, :path, keyword_init: true)
+
+    def initialize(path, opts = {})
+      @file_path = path
+      @template_file_path = opts[:template_file_path]
+      @name = opts[:name]
+      @short_code = opts[:short_code]
+      @description = opts[:description]
+      @mirror = MirrorConfig.new(opts[:mirror])
+    end
+
+    # Returns whether or not the devlogs repository is configured to mirror
+    #
+    # @returns [Boolean]
+    def mirror?
+      @mirror.use_mirror
+    end
+
+    # Ensures no weird double trailing slash path values
+    def path(with_trailing: false)
+      if with_trailing
+        @file_path[-1] == "/" ? @path_value : @path_value + "/"
+      else
+        @file_path
+      end
+    end
+  end
+end

data/lib/devlogs/repository/config_builder.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+class Repository
+  class ConfigBuilder
+    def initialize(dirpath)
+      @config_store = if dirpath
+                        Repository::ConfigStore.new(dir: dirpath)
+                      else
+                        Repository::ConfigStore.new
+                      end
+    end
+
+    def build
+      config_info = prompt_for_info
+
+      DraftConfig.new(@config_store, config_info)
+    end
+
+    private
+
+    # Creates an interactive prompt for user input
+    #
+    # @returns [Hash]
+    def prompt_for_info
+      prompt = TTY::Prompt.new
+
+      prompt.collect do |_p|
+        # Project name
+        key(:name).ask("What is the project name?") do |q|
+          q.required true
+        end
+
+        # Project description
+        key(:desc).ask("What is the project description?") do |q|
+          q.required true
+        end
+
+        # Project short code, e.g. RLP
+        key(:short_code).ask("What is the project short code (3 letters)?") do |q|
+          q.required true
+
+          q.validate ->(input) { input.size.positive? && input.size <= 3 }
+
+          q.messages[:valid?] = "Short code must be 3 letters or less"
+        end
+
+        key(:mirror) do
+          key(:use_mirror).ask("Do you want to mirror these logs?", convert: :boolean)
+          key(:path).ask("Path to mirror directory: ")
+        end
+      end
+    end
+
+    class DraftConfig
+      INFO_FILE_SUFFIX = "devlogs.info.md"
+      LOG_TEMPLATE_FILE_NAME = "__log_template.erb.md"
+      ISSUE_TEMPLATE_FILE_NAME = "__issue_template.erb.md"
+
+      def initialize(config_store, config_info)
+        @config_store = config_store
+        @config_info = config_info
+      end
+
+      #
+      # Initiates the write process of devlogs repository
+      #
+      # @param force [Boolean]
+      #
+      def save!(force: false)
+        exists = File.exist?(@config_store.file_path)
+
+        if exists && !force
+          puts "Log repository already exists in aborting..."
+          raise RuntimeError
+        end
+
+        create_config_store_dir
+        save_config_file
+        save_info_file
+        save_log_template_file
+
+        create_issue_dir
+        save_issue_template_file
+        save_data_file
+      end
+
+      private
+
+      #
+      # Creates the configuration store directory
+      #
+      def create_config_store_dir
+        # Create the draft_config directory
+        FileUtils.mkdir_p(@config_store.dir)
+      end
+
+      #
+      # Creates the issue directory
+      #
+      def create_issue_dir
+        # Create the draft_config directory
+        FileUtils.mkdir_p(@config_store.issue_dir_path)
+      end
+
+      #
+      # Saves the .devlogs.config.yml file
+      #
+      def save_config_file
+        # Create draft_config file
+        File.open(@config_store.file_path, "w") do |f|
+          f.write @config_info.to_yaml
+        end
+      end
+
+      #
+      # Saves the .info file
+      #
+      def save_info_file
+        # Replace spaces in project name with underscores
+        sanitized_project_name = @config_info[:name].gsub(/ /, "_").downcase
+
+        # Create the info file
+        info_file_name = "#{sanitized_project_name}.#{INFO_FILE_SUFFIX}"
+        info_file = File.join(@config_store.dir, info_file_name)
+
+        File.open(info_file, "w") do |f|
+          f.puts "# #{@config_info[:name]}"
+          f.puts (@config_info[:desc]).to_s
+        end
+      end
+
+      #
+      # Copies the log template to the config store directory
+      #
+      def save_log_template_file
+        # Copy the default template file inside the gem into the repository
+        default_log_template_path = get_template_path(LOG_TEMPLATE_FILE_NAME)
+
+        draft_config_log_template_file_path = File.join(@config_store.dir, Repository::ConfigStore::LOG_TEMPLATE_FILE)
+
+        FileUtils.cp(default_log_template_path, draft_config_log_template_file_path)
+      end
+
+      #
+      # Copies the log template to the config store directory
+      #
+      def save_issue_template_file
+        default_iss_template_path = get_template_path(ISSUE_TEMPLATE_FILE_NAME)
+
+        draft_config_iss_template_file_path = File.join(@config_store.dir, Repository::ConfigStore::ISSUE_TEMPLATE_FILE)
+
+        FileUtils.cp(default_iss_template_path, draft_config_iss_template_file_path)
+      end
+
+      #
+      # Creates a .devlogs.data.yml file
+      #
+      def save_data_file
+        data_file = File.join(@config_store.dir, Repository::ConfigStore::DATA_FILE)
+
+        #
+        # MARK: Default Data
+        #
+        data_info = {
+          issues: {
+            index: 1
+          },
+          logs: {},
+          repository: {}
+        }
+
+        File.open(data_file, "w") do |f|
+          f.puts data_info.to_yaml
+        end
+      end
+
+      # Gets the template file path embedded in the gem from the library root
+      #
+      # @returns [String]
+      #
+      def get_template_path(file_name)
+        File.join(Devlogs.lib_root, "templates", file_name)
+      end
+    end
+  end
+end

data/lib/devlogs/repository/config_store.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "rsync"
+
+require_relative "config"
+
+# A per repository configuration storage directory
+class Repository
+  class ConfigStore
+    attr_reader :dir
+
+    CONFIG_FILE = ".devlogs.config.yml"
+    DATA_FILE = ".devlogs.data.yml"
+    ISSUE_TEMPLATE_FILE = ".issue_template.erb.md"
+    LOG_TEMPLATE_FILE = ".log_template.erb.md"
+
+    ISSUE_DIR = "issues"
+    DEFAULT_DIRECTORY_PATH = "."
+    DEFAULT_DIRECTORY_NAME = ".devlogs"
+
+    def initialize(dir: File.join(DEFAULT_DIRECTORY_PATH, DEFAULT_DIRECTORY_NAME))
+      @dir = dir
+    end
+
+    def values
+      @values ||= load_values_from_config_file
+    end
+
+    #
+    # Retrieves the data file
+    #
+    # @returns [String]
+    #
+    def data_file_path
+      File.join(@dir, DATA_FILE)
+    end
+
+    #
+    # Retrieves .devlogs.config.yml file path
+    #
+    # @returns [String]
+    #
+    def file_path
+      File.join(@dir, CONFIG_FILE)
+    end
+
+    #
+    # The template File
+    #
+    # @returns [String]
+    # FIXME: rename to log_template_file_path
+    def template_file_path
+      File.join(@dir, LOG_TEMPLATE_FILE)
+    end
+
+    #
+    # The issue template file path:
+    #
+    # @returns [String]
+    #
+    def issue_template_file_path
+      File.join(@dir, ISSUE_TEMPLATE_FILE)
+    end
+
+    #
+    # Issue directory path
+    #
+    # @returns [String]
+    #
+    def issue_dir_path
+      File.join(@dir, ISSUE_DIR)
+    end
+
+    class << self
+      #
+      # Initialization utility method
+      #
+      def load_from(path = File.join(DEFAULT_DIRECTORY_PATH, DEFAULT_DIRECTORY_NAME))
+        exists = File.exist?(path)
+
+        raise "no repository found #{path}" unless exists
+
+        new(dir: path)
+      end
+    end
+
+    private
+
+    def load_values_from_config_file
+      yml = YAML.load_file(File.join(file_path))
+
+      Repository::Config.new(file_path, yml)
+    end
+  end
+end

data/lib/devlogs/repository/initializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "config_store"
+require_relative "config_builder"
+
+# Initialize is an execution object which initializes a Repository on the
+# filesystem
+class Repository
+  class Initializer
+    # Creates a new devlogs repository at the provided path
+    def self.run(opts = {})
+      new_config = Repository::ConfigBuilder.new(opts[:dirpath])
+
+      draft = new_config.build
+
+      draft.save!(force: opts[:force])
+    end
+  end
+end

data/lib/devlogs/repository/issue_manager.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require_relative "../helper/time_helper"
+require_relative "../helper/tty_prompt_helper"
+require_relative "../render/issue_template_renderer"
+
+#
+# IssueManager is an abstraction class to orchestrate the internals
+# of issue management and creation for a repository
+#
+class IssueManager
+  include TTYPromptHelper
+  include TimeHelper
+
+  VALID_DIRECTION = %i[asc desc].freeze
+  ISSUE_SEPARATOR = "__"
+
+  #
+  # @param [Repository::ConfigStore]
+  #
+  def initialize(repo_config_store)
+    @config_store = repo_config_store
+  end
+
+  #
+  # Lists the issue entries present in the repository
+  #
+  # @param direction [Symbol] ascending or descending
+  #
+  def list(direction = :desc)
+    raise ArgumentError, "Must be one of: " + VALID_DIRECTION unless VALID_DIRECTION.include?(direction.to_sym)
+
+    # Anything with the SHORTCODE- prefix
+    #
+    # i.e. RLP-1, RLP-2, et cetera
+    #
+    short_code_pattern = "#{config_values.short_code}-*"
+
+    #
+    # pattern: RLP-*
+    #
+    glob_pattern = File.join(@config_store.issue_dir_path, short_code_pattern)
+
+    Dir.glob(glob_pattern).sort_by do |fpath|
+      # i.e. [RLP-1, title_of_issue.md]
+      issue_tag, = File.basename(fpath).split(ISSUE_SEPARATOR)
+
+      # i.e. [RLP, 1]
+      _, issue_num = issue_tag.split("-")
+
+      if direction == :asc
+        issue_num.to_i
+      else
+        -1 * issue_num.to_i
+      end
+    end
+  end
+
+  #
+  # Adds a new entry to the repository
+  #
+  # @returns [String] entry file path
+  #
+  def create
+    info = issue_info_prompt
+
+    issue = compose_issue(info)
+
+    issue_file_path = File.join(@config_store.issue_dir_path, issue[:file_name])
+
+    template = IssueTemplateRenderer.new(@config_store.issue_template_file_path, issue)
+
+    unless File.exist?(issue_file_path)
+      # Add default boiler plate if the file does not exist yet
+      File.open(issue_file_path, "w") do |f|
+        f.write template.render
+      end
+
+      increment_issue_index!
+    end
+
+    issue_file_path
+  end
+
+  private
+
+  #
+  # Sanitizes and composes the content for display
+  #
+  # @returns [Hash]
+  def compose_issue(info = {})
+    # RLP-n
+    short_code_issue = compute_short_code
+
+    # RLP-1: User Validation Fails.md
+    display_title = "#{short_code_issue}: #{info[:title]}"
+
+    # rlp_1__user_validation_fails.md
+    file_name_title = snakify(info[:title])
+
+    issue_file_name = "#{short_code_issue}#{ISSUE_SEPARATOR}#{file_name_title}.md".downcase
+
+    {
+      display_title: display_title,
+      file_name: issue_file_name,
+      description: info[:description].join(""),
+      reproduction: info[:reproduction].join("")
+    }
+  end
+
+  #
+  # Increments the issue index in the data file by one
+  #
+  def increment_issue_index!
+    data = YAML.load_file(@config_store.data_file_path)
+
+    data[:issues][:index] += 1
+
+    File.open(@config_store.data_file_path, "w") do |f|
+      f.write data.to_yaml
+    end
+  end
+
+  #
+  # Gets TTY input for issue data
+  #
+  # @return [Hash]
+  #
+  def issue_info_prompt
+    prompt = TTY::Prompt.new
+
+    prompt.collect do
+      key(:title).ask("What is the issue title?") do |q|
+        q.required true
+        q.validate Validator.length_range(min: 0, max: 25)
+        q.messages[:valid?] = "Title cannot be empty and may be maximum 25 characters"
+      end
+
+      key(:description).multiline("Describe the issue: ") do |q|
+        q.default "There is an issue with..."
+        q.help "Press ctrl+d to end"
+      end
+
+      key(:reproduction).multiline("Describe the reproduction steps: ") do |q|
+        q.default "To reproduce the issue..."
+        q.help "Press ctrl+d to end"
+      end
+    end
+  end
+
+  #
+  # Convenience method for accessing config store values
+  #
+  # @returns [Repository::Config]
+  #
+  def config_values
+    @config_store.values
+  end
+
+  # Transforms a string with spaces or hyphens to
+  # an snake case String
+  #
+  # @param input [String]
+  # @returns [String]
+  #
+  def snakify(input)
+    input.gsub(/[ -]/, "_").downcase
+  end
+
+  #
+  # Reads the .data.yml file in the repository to
+  # get the latest issue index number
+  #
+  # @returns [String]
+  #
+  def compute_short_code
+    data = YAML.load_file(@config_store.data_file_path)
+
+    issue_index = data[:issues][:index]
+
+    "#{config_values.short_code}-#{issue_index}".upcase
+  end
+end

data/lib/devlogs/repository/log_manager.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "../helper/time_helper"
+require_relative "../render/log_template_renderer"
+
+#
+# LogManager is an abstraction class to orchestrate the internals
+# of issue management and creation for a repository
+#
+class LogManager
+  include TimeHelper
+  LOG_FILE_SUFFIX = "log.md"
+  VALID_DIRECTION = %i[asc desc].freeze
+
+  def initialize(repo_config_store)
+    @config_store = repo_config_store
+  end
+
+  # Lists the log entries present in the repository
+  #
+  # @param direction [Symbol] ascending or descending
+  #
+  def list(direction = :desc)
+    raise ArgumentError, "Must be one of: " + VALID_DIRECTION unless VALID_DIRECTION.include?(direction.to_sym)
+
+    # Anything with the _log.md suffix
+    glob_pattern = File.join(@config_store.dir, "*_#{LOG_FILE_SUFFIX}")
+
+    Dir.glob(glob_pattern).sort_by do |fpath|
+      # The date is joined by two underscores to the suffix
+      date, = File.basename(fpath).split("_#{LOG_FILE_SUFFIX}")
+
+      time_ms = Time.strptime(date, TimeHelper::TIME_FORMAT_FILE_PREFIX).to_i
+
+      if direction == :asc
+        time_ms
+      else
+        -time_ms
+      end
+    end
+  end
+
+  #
+  # Adds a new entry to the repository
+  #
+  # @returns [String] entry file path
+  #
+  def create
+    entry_file_name = "#{current_time}_#{LOG_FILE_SUFFIX}"
+
+    entry_file_path = File.join(@config_store.dir, entry_file_name)
+
+    template = LogTemplateRenderer.new(@config_store.template_file_path)
+
+    unless File.exist?(entry_file_path)
+      # Add default boiler plate if the file does not exist yet
+      File.open(entry_file_path, "w") do |f|
+        f.write template.render
+      end
+    end
+
+    entry_file_path
+  end
+end

data/lib/devlogs/repository/sync_manager.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rsync"
+
+# FIXME: Create module
+class Repository
+  #
+  # SyncManager is an abstraction class for managing any necessity to sync
+  # files on the file system using Rsync.
+  #
+  class SyncManager
+    #
+    # @param config_store [Repository::ConfigStore]
+    #
+    def initialize(config_store)
+      @config_store = config_store
+    end
+
+    # Run rsync with -a to copy directories recursively
+
+    # Use trailing slash to avoid sub-directory
+    # See rsync manual page
+    #
+    # @throws Error if sync fails
+    def run
+      dest_path = @config_store.values.mirror.path
+      src_path = config_store_path_with_trailing
+
+      runner.run("-av", src_path, dest_path) do |result|
+        if result.success?
+          puts "Mirror sync complete."
+          result.changes.each do |change|
+            puts "#{change.filename} (#{change.summary})"
+          end
+        else
+          raise "Failed to sync: #{result.error}"
+        end
+      end
+    end
+
+    private
+
+    #
+    # Utility method for getting access to the runner program
+    # @returns [Rsync]
+    #
+    def runner
+      @runner ||= Rsync
+    end
+
+    # Depending on the runner (Rsync) program,
+    # you may need a trailing slash on the directory path
+    #
+    # @returns [String]
+    def config_store_path_with_trailing
+      @config_store.dir[-1] == "/" ? @config_store.dir : @config_store.dir + "/"
+    end
+  end
+end

data/lib/devlogs/repository.rb

@@ -2,61 +2,46 @@
 
 require "fileutils"
 require "tty-prompt"
-require "yaml"
-require "rsync"
 require "pry"
 require "time"
+
+require_relative "repository/config_store"
 require_relative "editor"
+require_relative "repository/sync_manager"
+require_relative "helper/time_helper"
+require_relative "repository/log_manager"
+require_relative "repository/issue_manager"
 
-# Repostiroy is an accessor object for the devlogs directory
+# Repository is an accessor object for the devlogs directory
 class Repository
-  CONFIG_FILE = ".devlogs.config.yml"
-
-  # TODO: should be part of configuration
-  DEFAULT_LOG_SUFFIX = "devlogs.md"
-  DEFAULT_DIRECTORY_PATH = "."
-  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"
+  include TimeHelper
 
-  VALID_DIRECTION = %i[asc desc].freeze
-
-  # Initializes a _devlogs repository with the supplied configuration
-  # @param repo_config [Repository::Config]
+  # Initializes a .devlogs repository with the supplied configuration
   #
-  def initialize(repo_config)
-    @config = repo_config
+  def initialize(repo_config_store)
+    @config_store = repo_config_store
+    @repo_config = @config_store.values
   end
 
-  # Creates a new _devlogs entry for recording session completion
+  # Creates a new .devlogs entry for recording session completion
   #
   # @returns nil
   def create
-    time = Time.new
-    prefix = time.strftime(DEFAULT_TIME_FORMAT_FILE_PREFIX)
-
-    entry_file_name = "#{prefix}_#{DEFAULT_LOG_SUFFIX}"
+    entry_file_path = log_manager.create_entry
 
-    entry_file_path = File.join(@config.path, entry_file_name)
+    Editor.open(entry_file_path)
 
-    unless File.exist?(entry_file_path)
-      # Add default boiler plate if the file does not exist yet
-      File.open(entry_file_path, "w") do |f|
-        f.write <<~ENDOFFILE
-          # #{time.strftime(DEFAULT_TIME_FORMAT_TEXT_ENTRY)}
-          Tags: #dev, #log
+    puts "Writing entry to #{entry_file_path}.."
+  end
 
-          What did you do today?
+  #
+  # @returns nil
+  def create_issue
+    issue_file_path = issue_manager.create
 
-        ENDOFFILE
-      end
-    end
+    Editor.open(issue_file_path)
 
-    Editor.open(entry_file_path)
-
-    puts "Writing entry to #{entry_file_path}.."
+    puts "Writing issue to #{issue_file_path}.."
   end
 
   # Syncs the directory changes to the (optional) mirror repository
@@ -64,42 +49,17 @@ class Repository
   #
   # @returns nil
   def sync
-    if @config.mirror?
-      # Run rsync with -a to copy directories recursively
-
-      # Use trailing slash to avoid sub-directory
-      # See rsync manual page
-
-      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|
-            puts "#{change.filename} (#{change.summary})"
-          end
-        else
-          raise "Failed to sync: #{result.error}"
-        end
-      end
-    end
+    sync_manager.run if @repo_config.mirror?
   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
+    log_manager.list(direction)
+  end
 
-      # Descending
-      if direction == :asc
-        time_ms
-      else
-        -time_ms
-      end
-    end
+  # Lists the issues in the repository
+  def ls_issues(direction = :desc)
+    issue_manager.list(direction)
   end
 
   class << self
@@ -107,129 +67,24 @@ class Repository
     #
     # @returns [Repository]
     #
-    def load(path = File.join(DEFAULT_DIRECTORY_PATH, DEFAULT_DIRECTORY_NAME))
-      exists = File.exist?(path)
-
-      raise "no repository found #{path}" unless exists
-
-      cfg = YAML.load_file(File.join(path, CONFIG_FILE))
-
-      cfg[:path] = path
-
-      repo_config = Config.hydrate(cfg)
+    def load(path = File.join(Repository::ConfigStore::DEFAULT_DIRECTORY_PATH, Repository::ConfigStore::DEFAULT_DIRECTORY_NAME))
+      store = Repository::ConfigStore.load_from(path)
 
-      new(repo_config)
+      new(store)
     end
   end
 
-  # Config is a configuration data object for storing Repository configuration
-  # in memory for access.
-  class Config
-    attr_reader :name, :description, :mirror, :path_value
+  private
 
-    # 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_value = p
-    end
-
-    # Returns whether or not the devlogs repository is configured to mirror
-    #
-    # @returns [Boolean]
-    def mirror?
-      @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]
-    def self.hydrate(cfg)
-      new(cfg[:name], cfg[:description], cfg[:mirror], cfg[:path])
-    end
+  def sync_manager
+    @sync_manager ||= Repository::SyncManager.new(@config_store)
   end
 
-  # Initialize is an execution object which initializes a Repository on the
-  # filesystem
-  class Initialize
-    # Creates a new devlogs repository at the provided path
-    def self.run(opts = {}, path = File.join(DEFAULT_DIRECTORY_PATH, DEFAULT_DIRECTORY_NAME))
-      exists = File.exist?(path)
-
-      if exists && !opts[:force]
-        puts "Log repository already exists in #{path}. Aborting..."
-        raise RuntimeError
-      end
-
-      results = prompt_for_info
-
-      FileUtils.mkdir_p(path)
-      config_file = File.join(path, CONFIG_FILE)
-
-      # 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
-      File.open(config_file, "w") do |f|
-        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
+  def log_manager
+    @log_manager ||= LogManager.new(@config_store)
+  end
 
-    # Creates an interactive prompt for user input
-    #
-    # @returns [Hash]
-    def self.prompt_for_info
-      prompt = TTY::Prompt.new
-
-      prompt.collect do |_p|
-        # Project name
-        key(:name).ask("What is the project name?") do |q|
-          q.required true
-        end
-
-        # Project description
-        key(:desc).ask("What is the project description?") do |q|
-          q.required true
-        end
-
-        key(:mirror) do
-          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
+  def issue_manager
+    @issue_manager ||= IssueManager.new(@config_store)
   end
 end

data/lib/devlogs/templates/__issue_template.erb.md

@@ -0,0 +1,13 @@
+[[@INFO]]
+Tags:
+Links:
+
+---
+
+# <%= title %>
+
+## Problem
+<%= description %>
+
+## Reproduction Steps
+<%= reproduction %>

data/lib/devlogs/templates/__log_template.erb.md

@@ -0,0 +1,5 @@
+# LOG: <%= @time %>
+Tags: #dev, #log
+
+What did you do today?
+

data/lib/devlogs/version.rb

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

data/lib/devlogs.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative "devlogs/gem"
 require_relative "devlogs/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devlogs
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.1.0
 platform: ruby
 authors:
 - aquaflamingo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsync
@@ -98,9 +98,23 @@ files:
 - lib/devlogs/cli.rb
 - lib/devlogs/editor.rb
 - lib/devlogs/executable.rb
+- lib/devlogs/gem.rb
+- lib/devlogs/helper/time_helper.rb
+- lib/devlogs/helper/tty_prompt_helper.rb
 - lib/devlogs/pager.rb
-- lib/devlogs/prompt_utils.rb
+- lib/devlogs/render/erb_template_renderer.rb
+- lib/devlogs/render/issue_template_renderer.rb
+- lib/devlogs/render/log_template_renderer.rb
 - lib/devlogs/repository.rb
+- lib/devlogs/repository/config.rb
+- lib/devlogs/repository/config_builder.rb
+- lib/devlogs/repository/config_store.rb
+- lib/devlogs/repository/initializer.rb
+- lib/devlogs/repository/issue_manager.rb
+- lib/devlogs/repository/log_manager.rb
+- lib/devlogs/repository/sync_manager.rb
+- lib/devlogs/templates/__issue_template.erb.md
+- lib/devlogs/templates/__log_template.erb.md
 - lib/devlogs/version.rb
 homepage: http://github.com/aquaflamingo/devlogs
 licenses: