ptf 0.1.0 → 0.2.0

data/lib/ptf/data.rb

@@ -1,9 +0,0 @@
-require 'ptf/data/group'
-require 'ptf/data/metadata_file'
-require 'ptf/data/data_file'
-
-module Ptf
-  module Data
-  end
-end
-

data/lib/ptf/data/data_file.rb

@@ -1,42 +0,0 @@
-module Ptf
-  module Data
-    class DataFile
-
-      DIR_PATH = Ptf::Utilities::FileSystem.data_dir
-
-      # Initialize a new DataFile.
-      #
-      # @param metadata_file [Ptf::Data::MetadataFile] the associated metadata file.
-      #
-      # @raise [ArgumntError] if a MetadataFile is not given.
-      def initialize(metadata_file)
-        raise ArgumentError, "Metadata file not given." unless metadata_file.is_a? Ptf::Data::MetadataFile
-
-        @metadata_file = metadata_file
-      end
-
-      # Returns the full path to the data file.
-      #
-      # @return [String] the full path to the data file.
-      def data_file_path
-        File.join(DIR_PATH, @metadata_file.hash)
-      end
-
-      # Returns the header string for the file.
-      #
-      # @return [String] the header string for the data file.
-      def header_string
-        "##{@metadata_file.group.abbreviation}--#{@metadata_file.id} #{@metadata_file.title}\n#Due: #{@metadata_file.due_date_str}\n#Estimate: #{@metadata_file.estimate}\n\n\n"
-      end
-
-      # Write the header string to the data file. Overwrites any data file for the same task.
-      def write_to_file
-        File.open(data_file_path, "w") do |f|
-          f.write header_string
-        end
-      end
-
-    end
-  end
-end
-

data/lib/ptf/data/group.rb

@@ -1,107 +0,0 @@
-module Ptf
-  module Data
-    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
-
-      class << self
-        def from_name(group_name)
-          group_file = Ptf::Utilities::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::Utilities::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::Utilities::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::Utilities::FileSystem.group_list_file, "r") do |f|
-            f.each_line do |l|
-              name, abbrev = l.gsub(/\s+/, "").split(":")
-
-              group_arr.push (Ptf::Data::Group.new(name, abbrev))
-            end
-          end
-
-          group_arr
-        end
-
-        def default_group
-          config = Ptf::Config.get_config
-          default_group = config[:default_group]
-
-          name, abbrev = default_group.gsub(/\s+/, "").split(":")
-          Ptf::Data::Group.new(name, abbrev)
-        end
-
-      end
-
-    end
-  end
-end
-

data/lib/ptf/data/metadata_file.rb

@@ -1,237 +0,0 @@
-module Ptf
-  module Data
-    # 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::Data::Group] the Group the task is associated with.
-      # @param due_date [DateTime, nil] the due date given for the task.
-      # @param estimate [Numeric, nil] the estimated time to complete the task.
-      # @param id [Integer] the unique ID number for this task.
-      #
-      # @return [Ptf::Data::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::Utilities::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::Data::MetadataFile] the object representation of the metadata file.
-      def self.create_from_file(filepath)
-        raise ArgumentError, "File #{filepath} does not exist." unless Ptf::Utilities::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::Data::Group.from_name(val)
-            when "due_date", "created_at", "completed_at"
-              val = (val.nil? ? val : Ptf::Utilities::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::Data::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
-
-        @data[key] = val
-      end
-
-      # Returns the title of the task.
-      #
-      # @return [String] the title of the task.
-      def title
-        @data[:title]
-      end
-
-      # Returns the group the task is associated with.
-      #
-      # @return [Ptf::Data::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::Utilities::Date.datetime_to_str(due_date)
-      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?
-
-        due_date.strftime("%a %b %_d - %l%p -")
-      end
-
-      # Returns the estimated time to complete the task.
-      #
-      # @return [Numeric] the estimated time to compelte the task.
-      def estimate
-        @data[: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::Utilities::Date.datetime_to_str(@data[:created_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
-
-        `rm #{@filepath}`
-        @filepath = File.join(File.join(Ptf::Utilities::FileSystem.metadata_closed_dir, group.name), id.to_s)
-
-        write_to_file
-      end
-
-      def reopen
-        `rm #{@filepath}`
-        @filepath = File.join(File.join(Ptf::Utilities::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::Utilities::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
-end
-

data/lib/ptf/utilities.rb

@@ -1,28 +0,0 @@
-require 'ptf/utilities/date'
-require 'ptf/utilities/file_system'
-
-module Ptf
-  module Utilities
-    class << self
-
-      def datetime_to_str(datetime)
-        raise ArgumentError, "DateTime expected. Received #{datetime.class} instead." unless datetime.is_a? DateTime
-
-        datetime.strftime('%Y%m%d%H%M%S')
-      end
-
-      def str_to_datetime(str)
-        date_regex = /^([0-9][0-9][0-9][0-9])([01][0-9])([0-3][0-9])?([0-2][0-9])([0-5][0-9])([0-5][0-9])$/
-
-        regex_match = date_regex.match(str)
-
-        raise ArgumentError, "Improperly formatted datetime string." unless regex_match.to_a.length == 7
-
-        _, year, month, day, hour, minute, second = regex_match.to_a
-
-        DateTime.new(year.to_i, month.to_i, day.to_i, hour.to_i, minute.to_i, second.to_i)
-      end
-
-    end
-  end
-end

data/lib/ptf/utilities/date.rb

@@ -1,63 +0,0 @@
-module Ptf
-  module Utilities
-    module Date
-      class << self
-
-        def datetime_to_str(datetime)
-          raise ArgumentError, "DateTime expected. Received #{datetime.class} instead." unless datetime.is_a? DateTime
-
-          datetime.strftime('%Y%m%d%H%M%S')
-        end
-
-        def create_datetime_from_str(str)
-
-          begin
-            dt = str_to_datetime(str)
-            return dt
-          rescue
-          end
-
-          time_regex = /([0-2]?\d):([0-5]\d):?([0-5]\d)?/
-          # Check if given time 12:21(:21)
-          match = time_regex.match(str).to_a
-
-          if !match.nil? && (match.length == 3 || match.length == 4)
-            now = DateTime.now
-            return DateTime.new(now.year, now.month, now.day, match[1].to_i, match[2].to_i, 0, now.zone)
-          end
-
-          # Check if given date 12/27(/[15|2015])
-          date_regex = /^([01]?\d)\/([0-3]?\d)\/?(\d\d\d\d|\d\d)?$/
-          match = date_regex.match(str)
-
-          if !match.nil? && (match.length == 3 || match.length == 4)
-            now = DateTime.now
-
-            if !match[3].nil? && match[3].length == 2
-              year = 2000 + match[3].to_i
-            elsif !match[3].nil?
-              year = match[3].to_i
-            end
-
-            return DateTime.new((match[3].nil? ? now.year : year), match[1].to_i, match[2].to_i, 12, 0, 0, now.zone)
-          end
-
-          nil
-        end
-
-        def str_to_datetime(str)
-          date_regex = /^(\d\d\d\d)([01]\d)([0-3]\d)([0-2]\d)([0-5]\d)([0-5]\d)?$/
-
-          regex_match = date_regex.match(str)
-
-          raise ArgumentError, "Improperly formatted datetime string, #{str}." unless regex_match.to_a.length == 7
-
-          _, year, month, day, hour, minute, second = regex_match.to_a
-
-          DateTime.new(year.to_i, month.to_i, day.to_i, hour.to_i, minute.to_i, second.to_i)
-        end
-
-      end
-    end
-  end
-end