devlogs 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2023b8563770781f9708368975e70b713ec937df3331461096841e4f0fbd03a3
-  data.tar.gz: b1e7b12bac7c07aede0fa9dc8e8daca29db668e256c7a73067bc1f56993cad58
+  metadata.gz: 9df7671be5997a9e311b6a8c10863732b95fb3e6bdb89a7f5ba8476d3cec4653
+  data.tar.gz: af3731bb2c7134cea231b17a7c940d313d13f21c0721c720029e1084d706f0a4
 SHA512:
-  metadata.gz: 88c3a1909b19c35619abcaabd5815843ccb334362f2a1d5a8be7efb9f82fc64be9c43f51a1b0c76be012ef043b4a1b66bc0a4643ca2cb248ccafb3ee8a4b9fb3
-  data.tar.gz: 925757b3d644479dc402f2c17a762a349a9eb8b5dda7a75ecb88ec71e9712933b1fd223d239164ce4a24b8e0864040ad51c1a5f78ccce42535b1599f3b5ebfd3
+  metadata.gz: ffe4be66ace5c88074c0ce3e8a20e0f82a53162e59776be3bfdbf1d72c038d4d73365ca65bf91047b4730a64efeb548f3e1b7f8a8704a0f9554bc427ed0daa39
+  data.tar.gz: 9f3326e754283f25d307c598aa8824c53aa5686c112ebb9c9301ee7dc424710c572cac02275f72cf204e5e00677c92c03bd7e3f4ee157e7d585c9a3bcd2fc6c9

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.0.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
 ```
 
@@ -48,10 +48,10 @@ obsidianvault
 ```
 
 ### Creating entries
-Once you are done for the day or session run the `entry` command:
+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.
@@ -73,8 +73,6 @@ You can use the `last` command to retrieve the most recent entry
 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

@@ -5,6 +5,7 @@ require_relative "repository"
 require_relative "editor"
 require_relative "pager"
 require_relative "prompt_utils"
+require_relative "repository/initializer"
 require "thor"
 
 module 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
 
     #
@@ -64,8 +68,8 @@ module Devlogs
     # 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
 
@@ -79,6 +83,11 @@ module Devlogs
     def ls
       entries = repo.ls
 
+      if entries.size < 1 
+        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 +103,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/log_template.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "erb"
+
+#
+# LogTemplate is a class that represents the rendered log template
+#
+class LogTemplate
+  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/repository/config.rb

@@ -0,0 +1,36 @@
+# 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
+
+    # 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]
+      @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_store.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "rsync"
+
+require_relative "config"
+
+# A per repository configuration storage directory
+class Repository
+  class ConfigStore
+    attr_reader :dir, :values
+
+    CONFIG_FILE = ".devlogs.config.yml"
+
+    # TODO: should be part of configuration
+    TEMPLATE_FILE = ".log_template.erb.md"
+    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
+
+    def file_path
+      File.join(@dir, CONFIG_FILE)
+    end
+
+    def template_file_path
+      File.join(@dir, TEMPLATE_FILE)
+    end
+
+    class << self
+      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,86 @@
+# frozen_string_literal: true
+
+require_relative "config_store"
+
+# Initialize is an execution object which initializes a Repository on the
+# filesystem
+class Repository
+  class Initializer
+    INFO_FILE_SUFFIX = "devlogs.info.md"
+    LOG_TEMPLATE_FILE_NAME = "__log_template.erb.md"
+
+    # Creates a new devlogs repository at the provided path
+    def self.run(opts = {})
+      new_config = if opts[:dirpath]
+                     Repository::ConfigStore.new(dir: opts[:dirpath])
+                   else
+                     Repository::ConfigStore.new
+                   end
+
+      exists = File.exist?(new_config.file_path)
+
+      if exists && !opts[:force]
+        puts "Log repository already exists in #{new_config.file_path}. Aborting..."
+        raise RuntimeError
+      end
+
+      results = prompt_for_info
+
+      # Create the new_config directory
+      FileUtils.mkdir_p(new_config.dir)
+
+      # Create new_config file
+      File.open(new_config.file_path, "w") do |f|
+        f.write results.to_yaml
+      end
+
+      # Replace spaces in project name with underscores
+      sanitized_project_name = results[:name].gsub(/ /, "_").downcase
+
+      # Create the info file
+      info_file_name = "#{sanitized_project_name}.devlogs.info.md"
+      info_file = File.join(new_config.dir, info_file_name)
+
+      File.open(info_file, "w") do |f|
+        f.puts "# #{results[:name]}"
+        f.puts (results[:desc]).to_s
+      end
+
+      # Copy the default template file inside the gem into the repository
+      default_template_path = get_template_path
+
+      new_config_template_file_path = File.join(new_config.dir, Repository::ConfigStore::TEMPLATE_FILE)
+
+      FileUtils.cp(default_template_path, new_config_template_file_path)
+    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
+      end
+    end
+
+    # Gets the template file path embedded in the gem from the library root
+    def self.get_template_path
+      File.join(Devlogs.lib_root, "templates", LOG_TEMPLATE_FILE_NAME)
+    end
+  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,55 +2,50 @@
 
 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 "log_template"
 
 # Repostiroy 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"
+  TIME_FORMAT_FILE_PREFIX = "%m-%d-%Y__%kh%Mm"
+
+  LOG_FILE_SUFFIX = "log.md"
+  ISSUE_FILE_PREFIX = "iss"
 
   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)
+    time_prefix = time.strftime(TIME_FORMAT_FILE_PREFIX)
+
+    entry_file_name = "#{time_prefix}_#{LOG_FILE_SUFFIX}"
 
-    entry_file_name = "#{prefix}_#{DEFAULT_LOG_SUFFIX}"
+    # FIXME: Need to figure out file path
+    entry_file_path = File.join(@config_store.dir, entry_file_name)
 
-    entry_file_path = File.join(@config.path, entry_file_name)
+    # FIXME: Need to figure out file path
+    template = LogTemplate.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 <<~ENDOFFILE
-          # #{time.strftime(DEFAULT_TIME_FORMAT_TEXT_ENTRY)}
-          Tags: #dev, #log
-
-          What did you do today?
-
-        ENDOFFILE
+        f.write template.render
       end
     end
 
@@ -64,30 +59,14 @@ 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|
+    Dir.glob(File.join(@config_store.dir, "*_#{LOG_FILE_SUFFIX}")).sort_by do |fpath|
       # The date is joined by two underscores to the suffix
       date, = File.basename(fpath).split("__")
 
@@ -107,129 +86,16 @@ 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
+    def load(path = File.join(Repository::ConfigStore::DEFAULT_DIRECTORY_PATH, Repository::ConfigStore::DEFAULT_DIRECTORY_NAME))
+      store = Repository::ConfigStore.load_from(path)
 
-      repo_config = Config.hydrate(cfg)
-
-      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
-
-    # 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
+  private
 
-    # 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
-  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
-
-    # 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 sync_manager
+    @sync_manager ||= Repository::SyncManager.new(@config_store)
   end
 end

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.0.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.0.0
 platform: ruby
 authors:
 - aquaflamingo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rsync
@@ -98,9 +98,16 @@ files:
 - lib/devlogs/cli.rb
 - lib/devlogs/editor.rb
 - lib/devlogs/executable.rb
+- lib/devlogs/gem.rb
+- lib/devlogs/log_template.rb
 - lib/devlogs/pager.rb
 - lib/devlogs/prompt_utils.rb
 - lib/devlogs/repository.rb
+- lib/devlogs/repository/config.rb
+- lib/devlogs/repository/config_store.rb
+- lib/devlogs/repository/initializer.rb
+- lib/devlogs/repository/sync_manager.rb
+- lib/devlogs/templates/__log_template.erb.md
 - lib/devlogs/version.rb
 homepage: http://github.com/aquaflamingo/devlogs
 licenses: