ptf 0.1.0 → 0.2.0

data/lib/ptf/group.rb

@@ -0,0 +1,115 @@
+module Ptf
+  class Group
+
+    def initialize(name, abbrev)
+      @name = name
+      @abbreviation = abbrev
+    end
+
+    def name
+      @name
+    end
+
+    def abbreviation
+      @abbreviation
+    end
+
+    def to_s
+      "#{name}:#{abbreviation}"
+    end
+
+    def is_default?
+      Group.default_group.to_s == to_s
+    end
+
+
+    class << self
+      def config
+        @config = Ptf::Config.get_config if @config.nil?
+
+        @config
+      end
+
+      def from_name(group_name)
+        group_file = Ptf::FileSystem.group_list_file
+        File.open(group_file, "r") do |f|
+          f.each_line do |l|
+            name, abbrev = l.gsub(/\s+/, "").split(":")
+
+            if group_name == name
+              return Group.new(name, abbrev)
+            end
+
+          end
+        end
+
+        nil
+      end
+
+      def from_abbrev(group_abbrev)
+        group_file = Ptf::FileSystem.group_list_file
+        File.open(group_file, "r") do |f|
+          f.each_line do |l|
+            name, abbrev = l.gsub(/\s+/, "").split(":")
+
+            if group_abbrev == abbrev
+              return Group.new(name, abbrev)
+            end
+
+          end
+        end
+
+        nil
+      end
+
+      def get_group(group)
+        if(group.length <= 4 && group == group.upcase)
+          from_abbrev(group)
+        else
+          from_name(group)
+        end
+      end
+
+      def group_exist?(g)
+        group_file = Ptf::FileSystem.group_list_file
+
+        File.open(group_file, "r") do |f|
+          f.each_line do |l|
+            name, abbrev = l.gsub(/\s+/, "").split(":")
+
+            if name == g || abbrev == g
+              return true
+            end
+
+          end
+        end
+
+        false
+      end
+
+      def all_groups
+        group_arr = []
+
+        File.open(Ptf::FileSystem.group_list_file, "r") do |f|
+          f.each_line do |l|
+            name, abbrev = l.gsub(/\s+/, "").split(":")
+
+            group_arr.push (Ptf::Group.new(name, abbrev))
+          end
+        end
+
+        group_arr
+      end
+
+      def default_group
+        default_group = config[:default_group]
+
+        name, abbrev = default_group.gsub(/\s+/, "").split(":")
+        Ptf::Group.new(name, abbrev)
+      end
+
+    end
+
+  end
+end
+

data/lib/ptf/metadata_file.rb

@@ -0,0 +1,301 @@
+module Ptf
+  # Represents a single Metadata file.
+  #
+  # @author Austin Blatt
+  # @since 0.1.0
+  class MetadataFile
+
+    # Create a MetadataFile object from the given input.
+    #
+    # @param title [String] the task's title.
+    # @param group [Ptf::Group] the Group the task is associated with.
+    # @param due_date [DateTime, nil] the due date given for the task.
+    # @param estimate [Integer, nil] the estimated time to complete the task.
+    # @param id [Integer] the unique ID number for this task.
+    #
+    # @return [Ptf::MetadataFile] the metadata file for the task.
+    def self.create_from_input(title, group, due_date, estimate, id)
+      data = {
+        :title => title,
+        :group => group,
+        :due_date => due_date,
+        :estimate => estimate,
+        :id => id,
+        :created_at => DateTime.now,
+        :completed_at => nil
+      }
+
+      # Get the filepath for the infofile
+      open_dir = Ptf::FileSystem.metadata_open_dir
+      group_dir = File.join(open_dir, group.name)
+      filepath = File.join(group_dir, id.to_s)
+
+      self.new(filepath, data)
+    end
+
+    # Create a MetadataFile object from the given filepath.
+    #
+    # @param filepath [String] the full file path to the metadata file.
+    #
+    # @raise [ArgumentError] if the given filepath does not exist.
+    # @raise [ArgumentError] if the given file is not a metadata file.
+    #
+    # @return [Ptf::MetadataFile] the object representation of the metadata file.
+    def self.create_from_file(filepath)
+      raise ArgumentError, "File #{filepath} does not exist." unless Ptf::FileSystem.file_exist?(filepath)
+
+      data = {}
+      # parse file
+      File.open(filepath, "r") do |f|
+        f.each_line do |l|
+          key, val = l.gsub(/\s+/, "").split(":")
+
+          if key.nil? || !(key.is_a? String)
+            raise ArgumentError, "Error parsing file."
+          end
+
+          # Convert values to appropriate types
+          case key
+          when "group"
+            val = Ptf::Group.from_name(val)
+          when "due_date", "created_at", "completed_at"
+            val = (val.nil? ? val : Ptf::Date.str_to_datetime(val))
+          when "id"
+            val = val.to_i
+          when "estimate"
+            val = (val.nil? ? nil : val.to_i)
+          end
+
+          data[key.to_sym] = val
+        end
+      end
+
+      return self.new(filepath, data)
+    end
+
+    # Initialize a new metadata file.
+    #
+    # @param filepath [String] the full path to the file.
+    # @param data [Hash] the data in the file.
+    # @option data [String] :title the task's title.
+    # @option data [Ptf::Group] :group the Group the task is associated with.
+    # @option data [DateTime, nil] :due_date the due date given for the task.
+    # @option data [Integer, nil] :estimate the estimated time to complete the task.
+    # @option data [Integer] :id the unique ID number for this task.
+    # @option data [DateTime] :created_at the time the task was created.
+    # @option data [DateTime, nil] :completed_at the time the task was completed (nil if it has not been completed).
+    # @option data [String] :hash the file hash (the filepath of the data file).
+    def initialize(filepath, data)
+      @filepath = filepath
+      @data = data
+    end
+
+    # Add content to the metadata file.
+    #
+    # @param key [Symbol] the key for the new content.
+    # @param val [Object] the value for the new content.
+    #
+    # @raise [ArgumentError] if the key is not a symbol.
+    def add_content(key, val)
+      raise ArgumentError, "The key #{key} is not a symbol." unless key.is_a? Symbol
+      raise ArgumentError, "The key #{key} already exists." unless @data[key].nil?
+
+      @data[key] = val
+    end
+
+    # Returns the title of the task.
+    #
+    # @return [String] the title of the task.
+    def title
+      @data[:title]
+    end
+
+    # Set the task's title to a new title.
+    #
+    # @param new_title [String] the new title.
+    #
+    # @raise [ArgumentError] if the new_title is not a String.
+    def set_title(new_title)
+      raise ArgumentError, "The new title must be a string. Recieved a #{new_title.class.name}" unless new_title.is_a?(String)
+
+      @data[:title] = new_title
+    end
+
+    # Returns the group the task is associated with.
+    #
+    # @return [Ptf::Group] the group the task is associated with.
+    def group
+      @data[:group]
+    end
+
+    # Returns the due date of the task.
+    #
+    # @return [DateTime, nil] the due date of the task or nil if no due date exists.
+    def due_date
+      @data[:due_date]
+    end
+
+    # Returns the due date of the task as a String.
+    #
+    # @return [String] the due date of the task as a string.
+    def due_date_str
+      return "" if due_date.nil?
+
+      Ptf::Date.datetime_to_str(due_date)
+    end
+
+    # Set the task due's date.
+    #
+    # @param new_date [DateTime, nil] the new due date for the task
+    #
+    # @raise [ArgumentError] if new_date is not a DateTime or nil.
+    def set_due_date(new_date)
+      raise ArgumentError, "Invalid new due date." unless (new_date.nil? || new_date.is_a?(DateTime))
+
+      @data[:due_date] = new_date
+    end
+
+    # Returns the given datetime in list format
+    #
+    # @param datetime [DateTime] the datetime to convert to a String.
+    #
+    # @return [String] a String representing the datetime (ex. 'Wed Dec 21 - 11AM -')
+    def list_format(datetime)
+      datetime.strftime("%a %b %_d - %l%p -")
+    end
+
+    # Returns the due date of the task for the ptf list command.
+    #
+    # @return [String] the due date in the form 'Mon Dec 19 - 11AM -' or 'Mon Dec  9 -  2PM -'.
+    def due_date_list_format
+      return "" if due_date.nil?
+
+      list_format due_date
+    end
+
+    # Returns the estimated time to complete the task.
+    #
+    # @return [Integer] the estimated time to compelte the task.
+    def estimate
+      @data[:estimate]
+    end
+
+    # Set the task's estiamted time.
+    #
+    # @param new_estimate [Integer, nil] the new estimated time to complete the task.
+    #
+    # @raise [ArgumentError] if the new_estimate is not an Integer or nil.
+    def set_estimate(new_estimate)
+      raise ArgumentError, "The new estimate, #{new_estimate.to_s}, is not an integer." unless (new_estimate.nil? || new_estimate.is_a?(Integer))
+
+      @data[:estimate] = new_estimate
+    end
+
+    # Returns the date and time that the task was created at.
+    #
+    # @return [DateTime] the date and time that the task was created at.
+    def created_at
+      @data[:created_at]
+    end
+
+    # Returns the date and time that the task was created at as a String.
+    #
+    # @return [String] the date and time represented as a string.
+    def created_at_str
+      Ptf::Date.datetime_to_str create_at
+    end
+
+    # Returns the date and time that the task was completed at.
+    #
+    # @return [DateTime] the date and time that the task was completed at.
+    def completed_at
+      @data[:completed_at]
+    end
+
+    # Returns the date and time that the task was completed at as a String.
+    #
+    # @return [String] the date and time represented as a string.
+    def completed_at_str
+      Ptf::Date.datetime_to_str completed_at
+    end
+
+    # Returns the completed at time of the task for the ptf list command.
+    #
+    # @return [String] the completed at time in the form 'Mon Dec 19 - 11AM -' or 'Mon Dec  9 -  2PM -'.
+    def completed_at_list_format
+      return "" if completed_at.nil?
+
+      list_format completed_at
+    end
+
+    # Return the id of the task.
+    #
+    # @return [Integer] the ID number of the task.
+    def id
+      @data[:id]
+    end
+
+    # Return the hash of the task.
+    #
+    # @return [String] the hash of the metadata file (the name of the data file).
+    def hash
+      @data[:hash]
+    end
+
+    # Completes the task.
+    #
+    # Fills in the completed_at field with the current DateTime.
+    # Removes the metadata file from the in progress directory and writes it to the completed directory.
+    def complete_now
+      @data[:completed_at] = DateTime.now
+
+      FileUtils.rm @filepath
+      @filepath = File.join(File.join(Ptf::FileSystem.metadata_closed_dir, group.name), id.to_s)
+
+      write_to_file
+    end
+
+    def reopen
+      FileUtils.rm @filepath
+      @filepath = File.join(File.join(Ptf::FileSystem.metadata_open_dir, group.name), id.to_s)
+
+      write_to_file
+    end
+
+    def key_val_to_str(key, val)
+      str_val = val
+      case key
+      when :group
+        str_val = val.name
+      when :due_date, :created_at, :completed_at
+        str_val = (val.nil? ? "" : Ptf::Date.datetime_to_str(val))
+      end
+
+      "#{key}:#{str_val}"
+    end
+
+    # Returns the data in the file as a String.
+    #
+    # @return [String] the entire Metadata file as a String.
+    def file_string
+      return_str = ""
+      @data.each do |key, val|
+        return_str += "#{key_val_to_str(key, val)}\n"
+      end
+
+      return_str
+    end
+
+    # Writes the metadata file. Overwrites any previous metadata file for the same task.
+    def write_to_file
+      file = File.new(@filepath, "w")
+
+      @data.each do |key, val|
+        file.puts "#{key_val_to_str(key, val)}"
+      end
+      file.close
+    end
+
+  end
+end
+

data/lib/ptf/version.rb

@@ -1,3 +1,3 @@
 module Ptf
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ptf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Austin Blatt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-28 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -96,19 +96,18 @@ files:
 - lib/ptf/commands.rb
 - lib/ptf/commands/group.rb
 - lib/ptf/commands/group/add.rb
+- lib/ptf/commands/group/remove.rb
 - lib/ptf/commands/init.rb
 - lib/ptf/commands/list.rb
 - lib/ptf/commands/task.rb
 - lib/ptf/commands/task/create.rb
 - lib/ptf/commands/task/edit.rb
 - lib/ptf/config.rb
-- lib/ptf/data.rb
-- lib/ptf/data/data_file.rb
-- lib/ptf/data/group.rb
-- lib/ptf/data/metadata_file.rb
-- lib/ptf/utilities.rb
-- lib/ptf/utilities/date.rb
-- lib/ptf/utilities/file_system.rb
+- lib/ptf/data_file.rb
+- lib/ptf/date.rb
+- lib/ptf/file_system.rb
+- lib/ptf/group.rb
+- lib/ptf/metadata_file.rb
 - lib/ptf/version.rb
 - ptf.gemspec
 homepage: https://github.com/austb/ptf