task_tracker_cli 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b33d5a33b59a52885416ce62c9fe22c5085bbec03b019cb21c4437233d49b51b
+  data.tar.gz: aeab96ce6b637caf26b9dfa457c78df0f9bd435f778cc61d015e417d3cee0070
+SHA512:
+  metadata.gz: 913767bee758adc5c1d7c6d9eef64ee58d23c23ca97f78ef7b0e86895982622cc89fa3e62df230d5b2f8de56225abeb18ba86b695531863d86652cb2a13b7315
+  data.tar.gz: 136cd645c21585c2e86767bf6fea756edb46d0f2f496a194571631595d6b1c9a6d9db2fff1f91a0444e5fb422f35cbd621523f23886523ba6827e45ca00e163b

data/README.md

@@ -0,0 +1,160 @@
+# Task Tracker CLI
+
+Built by [Sulman Baig](https://www.sulmanweb.com)
+
+> This project requirements are from [Task Tracker Roadmap.sh](https://roadmap.sh/projects/task-tracker)
+
+Task Tracker CLI is a Ruby gem that provides a command-line interface for managing your tasks and to-do list. It allows you to easily add, update, delete, and track the status of your tasks directly from the terminal.
+
+## Features
+
+- Add new tasks
+- Update existing tasks
+- Delete tasks
+- Mark tasks as in-progress or done
+- List all tasks
+- List tasks by status (todo, in-progress, done)
+- Persistent storage using JSON file in home directory
+
+## Requirements
+
+- Ruby version: 2.5.0 or higher
+
+## Installation
+
+Ensure you have Ruby 2.5.0 or higher installed. You can check your Ruby version by running:
+
+```
+ruby --version
+```
+
+If you need to install or update Ruby, visit the [official Ruby website](https://www.ruby-lang.org/en/documentation/installation/) for instructions.
+
+Install the gem by running:
+
+```
+gem install task_tracker_cli
+```
+
+## Usage
+
+After installation, you can use the `task-cli` command in your terminal to manage your tasks:
+
+### Adding a new task
+
+```
+task-cli add "Task description"
+```
+
+### Updating a task
+
+```
+task-cli update 1 "Updated task description"
+```
+
+### Deleting a task
+
+```
+task-cli delete 1
+```
+
+### Marking a task as in-progress
+
+```
+task-cli in-progress 1
+```
+
+### Marking a task as done
+
+```
+task-cli done 1
+```
+
+### Listing all tasks
+
+```
+task-cli list
+```
+
+### Listing tasks by status
+
+
+```
+task-cli list todo
+```
+
+```
+task-cli list in-progress
+```
+
+```
+task-cli list done
+```
+
+## Uninstallation
+
+To uninstall the gem, run:
+
+```
+gem uninstall task_tracker_cli
+```
+
+## Task Properties
+
+Each task has the following properties:
+
+- `id`: A unique identifier for the task
+- `description`: A short description of the task
+- `status`: The status of the task (`todo`, `in-progress`, `done`)
+- `createdAt`: The date and time when the task was created
+- `updatedAt`: The date and time when the task was last updated
+
+## File Storage
+
+Tasks are stored in a JSON file (`tasks.json`) in your home directory. This file is automatically created if it doesn't exist.
+
+## Development
+
+After cloning the repository, follow these steps to set up the development environment:
+
+1. Install dependencies:
+   ```
+   bundle install
+   ```
+
+2. Run the tests:
+   ```
+   rspec
+   ```
+
+3. To install this gem onto your local machine, run:
+   ```
+   gem build task_tracker_cli.gemspec
+   gem install ./task_tracker_cli-0.1.0.gem
+   ```
+
+4. To release a new version, update the version number in `task_tracker_cli.gemspec`, and then run:
+   ```
+   gem build task_tracker_cli.gemspec
+   gem push task_tracker_cli-0.1.0.gem
+   ```
+
+For development, you can use `irb` or `pry` to experiment with the code:
+
+```ruby
+require 'task_tracker_cli'
+task_manager = TaskManager.new
+# Now you can experiment with task_manager methods
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sulmanweb/task_tracker_cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sulmanweb/task_tracker_cli/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Task Tracker CLI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sulmanweb/task_tracker_cli/blob/main/CODE_OF_CONDUCT.md).

data/bin/task-cli

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/task_tracker_cli'
+
+TaskCLI.run

data/lib/task_manager.rb

@@ -0,0 +1,146 @@
+# Task Tracker in Ruby
+require 'json'
+require 'time'
+
+# Define a Task class to represent each task
+class Task
+  attr_accessor :id, :description, :status, :created_at, :updated_at
+
+  def initialize(description, status = 'todo')
+    @id = nil
+    @description = description
+    @status = status
+    @created_at = Time.now
+    @updated_at = Time.now
+  end
+
+  def update(description, status)
+    @description = description
+    @status = status
+    @updated_at = Time.now
+  end
+
+  def to_h
+    {
+      id: @id,
+      description: @description,
+      status: @status,
+      created_at: @created_at.to_s,
+      updated_at: @updated_at.to_s
+    }
+  end
+
+  def to_s
+    "ID: #{@id} | Description: #{@description} | Status: #{@status} | Created At: #{@created_at} | Updated At: #{@updated_at}"
+  end
+end
+
+# TaskManager to manage tasks
+class TaskManager
+  TASKS_FILE = File.join(Dir.home, 'tasks.json')
+
+  def initialize
+    @tasks = load_tasks
+  end
+
+  def load_tasks
+    return [] unless File.exist?(TASKS_FILE)
+
+    file = File.read(TASKS_FILE)
+    data = JSON.parse(file, symbolize_names: true)
+    data.map do |task_data|
+      task = Task.new(task_data[:description], task_data[:status])
+      task.id = task_data[:id]
+      task.created_at = Time.parse(task_data[:created_at])
+      task.updated_at = Time.parse(task_data[:updated_at])
+      task
+    end
+  end
+
+  def save_tasks
+    File.open(TASKS_FILE, 'w') do |file|
+      file.write(JSON.pretty_generate(@tasks.map(&:to_h)))
+    end
+  end
+
+  # Create a new task
+  def create_task(description)
+    task = Task.new(description)
+    task.id = @tasks.empty? ? 1 : @tasks.last.id + 1
+    @tasks << task
+    save_tasks
+    puts "Task added successfully (ID: #{task.id})"
+  end
+
+  # List all tasks
+  def list_tasks
+    if @tasks.empty?
+      puts "No tasks found.\n"
+    else
+      @tasks.each { |task| puts task }
+    end
+  end
+
+  # List tasks by status
+  def list_tasks_by_status(status)
+    filtered_tasks = @tasks.select { |task| task.status == status }
+    if filtered_tasks.empty?
+      puts "No tasks found with status '#{status}'."
+    else
+      filtered_tasks.each { |task| puts task }
+    end
+  end
+
+  # Find a task by ID
+  def find_task(id)
+    @tasks.find { |task| task.id == id }
+  end
+
+  # Update a task
+  def update_task(id, new_description)
+    task = find_task(id)
+    if task
+      task.update(new_description, task.status)
+      save_tasks
+      puts "Task updated successfully!"
+    else
+      puts "Task not found."
+    end
+  end
+
+  # Delete a task
+  def delete_task(id)
+    task = find_task(id)
+    if task
+      @tasks.delete(task)
+      save_tasks
+      puts "Task deleted successfully!"
+    else
+      puts "Task not found."
+    end
+  end
+
+  # Mark a task as in progress
+  def mark_in_progress(id)
+    task = find_task(id)
+    if task
+      task.update(task.description, 'in-progress')
+      save_tasks
+      puts "Task marked as in-progress!"
+    else
+      puts "Task not found."
+    end
+  end
+
+  # Mark a task as done
+  def mark_done(id)
+    task = find_task(id)
+    if task
+      task.update(task.description, 'done')
+      save_tasks
+      puts "Task marked as done!"
+    else
+      puts "Task not found."
+    end
+  end
+end

data/lib/task_tracker_cli.rb

@@ -0,0 +1,57 @@
+require_relative "task_manager"
+
+class TaskCLI
+  def self.run
+    task_manager = TaskManager.new
+    command = ARGV[0]
+    args = ARGV[1..-1]
+
+    case command
+    when 'add'
+      description = args.join(' ')
+      task_manager.create_task(description)
+    when 'update'
+      id = args[0].to_i
+      new_description = args[1..-1].join(' ')
+      task_manager.update_task(id, new_description)
+    when 'delete'
+      id = args[0].to_i
+      task_manager.delete_task(id)
+    when 'mark-in-progress'
+      id = args[0].to_i
+      task_manager.mark_in_progress(id)
+    when 'mark-done'
+      id = args[0].to_i
+      task_manager.mark_done(id)
+    when 'list'
+      if args.empty?
+        task_manager.list_tasks
+      else
+        status = args[0]
+        task_manager.list_tasks_by_status(status)
+      end
+    when 'init'
+      self.init_project
+    else
+      puts "Invalid command. Available commands: add, update, delete, mark-in-progress, mark-done, list, init"
+    end
+  end
+
+  def self.init_project
+    directories = ["tasks", "config", "logs"]
+    files = {
+      "config/settings.json" => '{"setting": "default"}',
+      "README.md" => "# Task Tracker CLI Project\n\nThis is your task tracker project. Modify this README accordingly."
+    }
+
+    directories.each do |dir|
+      Dir.mkdir(dir) unless Dir.exist?(dir)
+      puts "Created directory: #{dir}"
+    end
+
+    files.each do |file, content|
+      File.open(file, 'w') { |f| f.write(content) }
+      puts "Created file: #{file}"
+    end
+  end
+end

data/task_tracker_cli.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "task_tracker_cli"
+  spec.version       = "0.1.1"
+  spec.authors       = ["Sulman Baig"]
+  spec.email         = ["sulmanweb@gmail.com"]
+
+  spec.summary       = "A CLI tool for tracking tasks."
+  spec.description   = "A command-line interface tool to add, update, and manage tasks."
+  spec.homepage      = "https://github.com/sulmanweb/task_tracker_cli"
+  spec.license       = "MIT"
+
+  spec.files         = Dir["lib/**/*.rb"] + Dir["bin/*"] + ["task_tracker_cli.gemspec", "README.md"]
+  spec.bindir        = "bin"
+  spec.executables   = ["task-cli"]
+  spec.require_paths = ["lib"]
+
+  spec.metadata["homepage_uri"]          = spec.homepage
+  spec.metadata["source_code_uri"]       = "https://github.com/sulmanweb/task_tracker_cli/blob/main/lib/task_tracker_cli.rb"
+  spec.extra_rdoc_files                  = %w[README.md]
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.add_runtime_dependency 'json', '~> 2.0'
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.post_install_message = "Thank you for installing Task Tracker CLI by Sulman Baig!"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: task_tracker_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sulman Baig
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A command-line interface tool to add, update, and manage tasks.
+email:
+- sulmanweb@gmail.com
+executables:
+- task-cli
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/task-cli
+- lib/task_manager.rb
+- lib/task_tracker_cli.rb
+- task_tracker_cli.gemspec
+homepage: https://github.com/sulmanweb/task_tracker_cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sulmanweb/task_tracker_cli
+  source_code_uri: https://github.com/sulmanweb/task_tracker_cli/blob/main/lib/task_tracker_cli.rb
+  rubygems_mfa_required: 'true'
+post_install_message: Thank you for installing Task Tracker CLI by Sulman Baig!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.21
+signing_key:
+specification_version: 4
+summary: A CLI tool for tracking tasks.
+test_files: []