ptf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d061046d970e40aa337b3d7c22d6694c86218ed1
+  data.tar.gz: 2d7f5790adb59b3384be8ee40a8a750a16519202
+SHA512:
+  metadata.gz: 2227f3d74a214e752cb2fe504d8a7824a31b949123807c7305127be1f9f172ad2169fc1025cd191d0c05e6a62879f159f591f9f04bef52643b6522403f5398e1
+  data.tar.gz: 5dc3cd5181bedc740c02c8036884b24bd0d936a49c5589426a9e68d8e3ca5298fbc922fd037f6bc7634e5ed7a0a3ea19d17ecca0bc8e4ccd4d71f64b7af01731

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/planning/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ptf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Austin Blatt
+
+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,41 @@
+# PTF
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ptf`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ptf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ptf
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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]/ptf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ptf"
+
+# 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

data/bin/ptf

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'ptf'
+
+Ptf::Cli::Application.start(ARGV)
+
+#puts ARGV.length
+#puts ARGV
+
+#ptf_job = Ptf::Console.create_argument_list ARGV
+#Ptf.run(ptf_job)
+
+
+

data/bin/setup

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

data/lib/ptf/client/group.rb

@@ -0,0 +1,23 @@
+module Ptf
+  module Cli
+    class Group < Thor
+
+      desc "group add GROUP ABBREVIATION", "Create a new group"
+      def add(group, abbrev)
+        Ptf::Commands::Group::Add.add(group, abbrev)
+      end
+
+      desc "group remove", "Remove a group"
+      def remove
+        puts "remove group not implemented"
+      end
+
+      desc "group transfer", "Transfer a group to another"
+      def transfer
+        puts "transfer group not implemented"
+      end
+
+    end
+  end
+end
+

data/lib/ptf/client/summary.rb

@@ -0,0 +1,23 @@
+module Ptf
+  module Cli
+    class Summary < Thor
+
+      desc "summary create", "Create a summary"
+      def create
+        puts "summary create not implemented"
+      end
+
+      desc "summary edit", "Edit summary"
+      def edit
+        puts "summary edit not implemented"
+      end
+
+      desc "summary show", "Show summary"
+      def show
+        puts "summary show not implemented"
+      end
+
+    end
+  end
+end
+

data/lib/ptf/client/task.rb

@@ -0,0 +1,37 @@
+module Ptf
+  module Cli
+    class Task < Thor
+
+      desc "task create", "Create a new task"
+      option :title, :type => :string, :required => true, :aliases => :t
+      option :group, :type => :string, :aliases => :g
+      option :date, :type => :string, :aliases => :d
+      option :estimate, :type => :numeric, :aliases => :e
+      def create
+        Ptf::Commands::Task::Create.create(options[:title], options[:group], options[:date], options[:estimate])
+      end
+
+      desc "task edit ID", "Edit a task"
+      def edit(id)
+        Ptf::Commands::Task::Edit.edit(id.to_i)
+      end
+
+      desc "task show ID", "Show a task"
+      def show(id)
+        Ptf::Commands::Task.show(id)
+      end
+
+      desc "task close ID", "Mark a task a completed"
+      def close(id)
+        Ptf::Commands::Task.close(id)
+      end
+
+      desc "task reopen ID", "Reopen a closed task"
+      def reopen(id)
+        Ptf::Commands::Task.reopen(id)
+      end
+
+    end
+  end
+end
+

data/lib/ptf/client.rb

@@ -0,0 +1,39 @@
+require 'thor'
+
+require 'ptf/client/task'
+require 'ptf/client/group'
+require 'ptf/client/summary'
+
+module Ptf
+  module Cli
+    class Application < Thor
+
+      desc "init", "Initialize a new Planning Text File project"
+      long_desc <<-LONGDESC
+        Initializes a new Planning Text File workspace.
+
+        With the -f option it writes over an existing PTF workspace.
+      LONGDESC
+      option :f, :type => :boolean
+      def init
+        Ptf::Commands::Init.init(options[:f])
+      end
+
+      desc "task", "Subcommand to manage tasks"
+      subcommand "task", Task
+
+      desc "group", "Subcommand to manage groups"
+      subcommand "group", Group
+
+      desc "list DELIMIT", "List tasks. Given 'all' or a group name"
+      def list(delimiter)
+        Ptf::Commands::List.list(delimiter)
+      end
+
+      desc "summary", "Subcommand to manage a summary of all tasks"
+      subcommand "summary", Summary
+
+    end
+  end
+end
+

data/lib/ptf/commands/group/add.rb

@@ -0,0 +1,50 @@
+module Ptf
+  module Commands
+    module Group
+      module Add
+        class << self
+
+          def add(group, abbrev)
+            if Ptf::Data::Group.group_exist?(group)
+              puts "Group already exists using the name #{group}."
+              return
+            elsif Ptf::Data::Group.group_exist?(abbrev)
+              puts "Group already exists using the abbreviation #{abbrev}."
+              return
+            end
+
+            if abbrev.length > 4
+              puts "Abbreviation cannot be longer than 4 characters."
+              return
+            end
+
+            if group != group.downcase
+              puts "Group names must be entirely lowercase."
+              return
+            elsif abbrev != abbrev.upcase
+              puts "Group abbreviations must be entirely uppercase."
+              return
+            end
+
+            new_group = Ptf::Data::Group.new(group, abbrev)
+
+            group_file = Ptf::Utilities::FileSystem.group_list_file
+
+            File.open(group_file, 'a') { |f| f.write("#{new_group.to_s}\n") }
+
+            open_dir = Ptf::Utilities::FileSystem.metadata_open_dir
+            closed_dir = Ptf::Utilities::FileSystem.metadata_closed_dir
+
+            [open_dir, closed_dir].each do |d|
+              Dir.mkdir(File.join(d, new_group.name), Ptf::Utilities::FileSystem.file_permission)
+            end
+
+            puts "Added group #{new_group.to_s} successfully!"
+          end
+
+        end
+      end
+    end
+  end
+end
+

data/lib/ptf/commands/group.rb

@@ -0,0 +1,9 @@
+require 'ptf/commands/group/add'
+
+module Ptf
+  module Commands
+    module Group
+
+    end
+  end
+end

data/lib/ptf/commands/init.rb

@@ -0,0 +1,65 @@
+module Ptf
+  module Commands
+    module Init
+      class << self
+
+        def init(force_override = false)
+
+          default_permissions = Ptf::Utilities::FileSystem.file_permission
+          default_group = Ptf::Data::Group.default_group
+          default_counter = Ptf::Utilities::FileSystem.id_counter_starting_content
+
+          base_dir = Ptf::Utilities::FileSystem.base_dir
+
+          if Dir.exist? base_dir
+            if force_override
+              puts "PTF workspace existed, erasing..."
+              `rm -r #{base_dir}`
+            else
+              puts "A PTF workspace has already been initialized."
+              return
+            end
+          end
+
+          begin
+            Dir.mkdir(base_dir, default_permissions)
+
+            info_dir = Ptf::Utilities::FileSystem.metadata_dir
+            Dir.mkdir(info_dir, default_permissions)
+
+            data_dir = Ptf::Utilities::FileSystem.data_dir
+            Dir.mkdir(data_dir, default_permissions)
+
+            tmp_dir = Ptf::Utilities::FileSystem.tmp_dir
+            Dir.mkdir(tmp_dir, default_permissions)
+
+            open_dir = Ptf::Utilities::FileSystem.metadata_open_dir
+            Dir.mkdir(open_dir, default_permissions)
+
+            closed_dir = Ptf::Utilities::FileSystem.metadata_closed_dir
+            Dir.mkdir(closed_dir, default_permissions)
+
+            Dir.mkdir(File.join(open_dir, default_group.name), default_permissions)
+            Dir.mkdir(File.join(closed_dir, default_group.name), default_permissions)
+
+            counter_file = File.new(Ptf::Utilities::FileSystem.id_counter_file, "w")
+            counter_file.puts default_counter
+            counter_file.close
+
+            group_file = File.new(Ptf::Utilities::FileSystem.group_list_file, "w")
+            group_file.puts default_group.to_s
+            group_file.close
+          rescue Exception => e
+            puts "Failed to create PTF workspace."
+            `rm -r #{base_dir}`
+            raise e
+          end
+
+          puts "Created PTF workspace at #{base_dir} successfully!"
+        end
+
+      end
+    end
+  end
+end
+

data/lib/ptf/commands/list.rb

@@ -0,0 +1,91 @@
+module Ptf
+  module Commands
+    module List
+      class << self
+
+        def get_metadata_for_group(group)
+          raise ArgumentError, "Group #{group} does not exist." unless Ptf::Data::Group.group_exist?(group)
+
+          group_name = Ptf::Data::Group.get_group(group).name
+          open_group_path = File.join(Ptf::Utilities::FileSystem.metadata_open_dir, group_name)
+          open_group_dir = Dir.new(open_group_path)
+          # closed_group_dir = File.join(Ptf::Utilities::FileSystem.metadata_closed_dir, group)
+
+          open_tasks = open_group_dir.to_a[2..-1].collect do |file|
+            path = File.join(open_group_path, file)
+
+            Ptf::Data::MetadataFile.create_from_file(path)
+          end
+
+          open_tasks
+        end
+
+        def sort_task_arr(task_arr)
+          sorted_arr = task_arr
+
+          sorted_arr.sort! do |a,b|
+            if a.due_date.nil? && b.due_date.nil?
+              a.created_at <=> b.created_at
+            elsif a.due_date.nil?
+              1
+            elsif b.due_date.nil?
+              -1
+            else
+              a.due_date <=> b.due_date
+            end
+          end
+
+          sorted_arr
+        end
+
+        def generate_list_display(tasks)
+          list_display = ""
+          first = true, past_due = false, have_due_date = true
+          tasks.each do |t|
+            if have_due_date && t.due_date.nil?
+              have_due_date = false
+              list_display += "\n" unless first
+              list_display += "=========== NoDate ===========\n\n"
+            end
+
+            if have_due_date && first && t.due_date <= DateTime.now
+              first = false
+              past_due = true
+              list_display += "============ Past ============\n\n"
+            elsif first && have_due_date
+              first = false
+              list_display += "========== Upcoming ==========\n\n"
+            end
+
+            if have_due_date && past_due && t.due_date > DateTime.now
+              past_due = false
+              list_display += "\n========== Upcoming ==========\n\n"
+            end
+
+            list_display += "#{t.due_date_list_format} #{t.title} (#{t.group.abbreviation} #{t.id})\n"
+          end
+
+          list_display
+        end
+
+        def list(delimiter)
+          if delimiter.downcase == "all"
+            puts "List all not yet implemented"
+          else
+            if !Ptf::Data::Group.group_exist?(delimiter)
+              puts "Group #{delimiter} does not exist."
+              return
+            end
+
+            tasks = get_metadata_for_group(delimiter)
+            tasks = sort_task_arr(tasks)
+
+            puts generate_list_display(tasks)
+          end
+        end
+
+      end
+    end
+  end
+end
+

data/lib/ptf/commands/task/create.rb

@@ -0,0 +1,70 @@
+require 'digest'
+
+module Ptf
+  module Commands
+    module Task
+      module Create
+        class << self
+
+          def generate_hash(file_contents)
+            Digest::SHA1.hexdigest file_contents
+          end
+
+          def new_id_number
+            id_file_path = Ptf::Utilities::FileSystem.id_counter_file
+            next_id = File.read(id_file_path).to_i
+
+            id_file = File.new(id_file_path, "w")
+            id_file.write("#{next_id+1}")
+            id_file.close
+
+            next_id
+          end
+
+          def create(t, g, d, e)
+            title = t
+            group = g
+            due_date = d
+            estimate = e
+
+            # Select a group for the task
+            if group.nil?
+              group = Ptf::Data::Group.default_group
+            else
+              if Ptf::Data::Group.group_exist? group
+                group = Ptf::Data::Group.get_group group
+              else
+                puts "Group #{p} does not exist. Create it with ptf group add GROUP ABBREVIATION"
+                return
+              end
+            end
+
+            # Verify the due date
+            if !due_date.nil?
+              due_date = Ptf::Utilities::Date.create_datetime_from_str(due_date)
+              if due_date.nil?
+                puts "Improperly formatted due date '#{d}' given."
+                return
+              end
+            end
+
+            id = new_id_number
+
+            info_file = Ptf::Data::MetadataFile.create_from_input(title, group, due_date, estimate, id)
+
+            task_info_hash = generate_hash info_file.file_string
+
+            # Append hash to the file
+            info_file.add_content(:hash, task_info_hash)
+
+            data_file = Ptf::Data::DataFile.new(info_file)
+
+            info_file.write_to_file
+            data_file.write_to_file
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ptf/commands/task/edit.rb

@@ -0,0 +1,55 @@
+module Ptf
+  module Commands
+    module Task
+      module Edit
+        class << self
+
+          def verify_file(file)
+            puts "File verification not implemented"
+            true
+          end
+
+          def edit(id)
+            unless Ptf::Utilities::FileSystem.id_exist? (id)
+              puts "The task #{id} does not exist"
+              return
+            end
+
+            metadata_file = Ptf::Utilities::FileSystem.find_file id
+
+            if metadata_file.nil?
+              puts "The task #{id} has been closed. Reopen it with ptf task reopen ###."
+              return
+            end
+
+            # Get hash from file
+            data_file_name = Ptf::Data::MetadataFile.create_from_file(metadata_file).hash
+            data_file = File.join(Ptf::Utilities::FileSystem.data_dir, data_file_name)
+
+            # Create a copy in tmp foldere
+            tmp_file_path = File.join(Ptf::Utilities::FileSystem.tmp_dir, data_file_name)
+            FileUtils.copy data_file, tmp_file_path
+            edit_succeeded = system("vim #{data_file}")
+
+            if !edit_succeeded
+              # Move tmp file back, then remove it
+              puts "Vim edit failed. Aborting changes."
+              return
+            end
+
+            if verify_file(data_file)
+              puts "Edit successful!"
+            else
+              puts "File verification failed. Aborting changes."
+            end
+
+            # remove tmp file
+            FileUtils.remove_file tmp_file_path
+          end
+
+        end
+      end
+    end
+  end
+end
+