devlogs 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b99f8b324427d042c22df13670cd362387c29d2392d3c5ac5b4dc3933e7a6350
+  data.tar.gz: 10e884ccc05ab8f967ef1b12eb8b28bb728d0642510e9279c76f2c696929cbb8
+SHA512:
+  metadata.gz: 41736e5c49fae07395e3da06f9aba779a48d14b5ded23ba0a062ff9de1a176050fee2208a959417846e9029166c4deb59eb93114dc93c67e3c7c55415b0be550
+  data.tar.gz: e9854ed3e849a7208a8c9e3c82410973945c99a9a2e488a9f153f8612bcb80ed5f3a66f6a45f2d8cfe4945bb66b6abad3738b2df339a429bf5b7d9e7d31945cb

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+__devlog
+*.gem
+__devlogs
+mirror

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in devlogs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    devlogs (0.1.4)
+      rsync (~> 1.0, >= 1.0.9)
+      thor (~> 1.2.1)
+      tty-prompt (~> 0.23.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rsync (1.0.9)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (1.8.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  devlogs!
+  pry (~> 0.14.0)
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 aquaflamingo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# 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/
+
+![Maintain non-source controlled logs across various projects with mirroring to a single](./docs/mirroring.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devlogs'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install devlogs
+
+## Usage
+### Initialize
+Inside your project initialize the `__devlogs` repository:
+```bash
+$ devlogs init
+```
+
+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.
+
+Example:
+
+```
+myproject
+ __devlogs
+   >> content
+```
+
+```
+obsidianvault
+  project
+    mirror_logs
+     >> content mirrored here
+```
+
+### Creating entries
+Once you are done for the day or session run the `entry` command:
+
+```bash
+devlogs entry
+```
+
+Your editor will pop up and you can fill in cliff notes.
+
+```
+# <DATE HERE>
+
+* Setup Postgresql Database
+* Created the Post and User models
+* Can't figure out how to connect devise + omniauth yet - need to figure that out
+```
+
+Save and if you set a mirror it will sync over!
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "devlogs"
+
+task default: :build

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "devlogs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/devlogs.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/devlogs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "devlogs"
+  spec.version       = Devlogs::VERSION
+  spec.authors       = ["aquaflamingo"]
+  spec.email         = ["16901597+aquaflamingo@users.noreply.github.com"]
+
+  spec.summary       = "A command line utility to create and manage project management with a logs repository."
+  spec.description   = "Create, manage and sync developer project logs"
+  spec.homepage      = "http://github.com/aquaflamingo/devlogs"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/aquaflamingo/devlogs"
+  spec.metadata["changelog_uri"] = "https://github.com/aquaflamingo/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rsync", "~> 1.0", ">= 1.0.9"
+  spec.add_dependency "thor", "~> 1.2.1"
+  spec.add_dependency "tty-prompt", "~> 0.23.1"
+
+  spec.add_development_dependency "pry", "~> 0.14.0"
+end

data/exe/devlogs

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "devlogs"
+
+Devlogs::App.start(ARGV)

data/lib/devlogs/repository.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "tty-prompt"
+require "yaml"
+require "rsync"
+require "pry"
+
+# 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"
+
+  # 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
+  #
+  # @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 = File.join(@config.path, entry_file_name)
+
+    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)}
+
+          What did you do today?
+
+        ENDOFFILE
+      end
+    end
+
+    editor_program = ENV["EDITOR"]
+
+    system("#{editor_program} #{entry_file_path}")
+
+    puts "Writing entry to #{entry_file_path}.."
+  end
+
+  # Syncs the directory changes to the (optional) mirror repository
+  # specified in the configuration.
+  #
+  # @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
+      path = @config.path[-1] == "/" ? @config.path : @config.path + "/"
+
+      Rsync.run("-av", path, @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
+  end
+
+  class << self
+    # Loads a repository from the provided path
+    #
+    # @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)
+
+      new(repo_config)
+    end
+  end
+
+  # Config is a configuration data object for storing Repository configuration
+  # in memory for access.
+  class Config
+    attr_reader :name, :description, :mirror, :path
+
+    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
+    end
+
+    # Returns whether or not the devlogs repository is configured to mirror
+    #
+    # @returns [Boolean]
+    def mirror?
+      @mirror.use_mirror
+    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
+  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)
+      info_file_name = "#{results[:name].gsub(/ /, "_")}_devlogs.info"
+      info_file = File.join(path, info_file_name)
+
+      # Create config file
+      File.open(config_file, "w") do |f|
+        f.write results.to_yaml
+      end
+
+      File.open(info_file, "w") do |f|
+        f.puts "# #{results[:name]}"
+        f.puts (results[:desc]).to_s
+      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
+      end
+    end
+  end
+end

data/lib/devlogs/version.rb

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

data/lib/devlogs.rb

@@ -0,0 +1,56 @@
+# 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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: devlogs
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- aquaflamingo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rsync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Create, manage and sync developer project logs
+email:
+- 16901597+aquaflamingo@users.noreply.github.com
+executables:
+- devlogs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- devlogs.gemspec
+- docs/mirroring.png
+- exe/devlogs
+- lib/devlogs.rb
+- lib/devlogs/repository.rb
+- lib/devlogs/version.rb
+homepage: http://github.com/aquaflamingo/devlogs
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/aquaflamingo/devlogs
+  source_code_uri: https://github.com/aquaflamingo/devlogs
+  changelog_uri: https://github.com/aquaflamingo/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A command line utility to create and manage project management with a logs
+  repository.
+test_files: []