scheduled-format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1fcfd8366043e95ad3620345cc368848c36e2b08b3c3671d3189f19696c7030
+  data.tar.gz: efe64d9385bbd041ac75ac18c10d094b73e490c038b0c742e554a0b3b8f10ecf
+SHA512:
+  metadata.gz: 8b922da0a4298956a10e7fa8ca89b11ef5e945667bb6bac19d1ed3e9a3538402184789f35002e8b7e3a4735e074f39d80f629b433bd4ab363a264b9fce111619
+  data.tar.gz: 905a9715919ea3ff1dddbcd2adb3f11f076d06eb55351e5fd41350bd9e6ee664efd3325c014e3abb897d1170de1eebbe8b738feed84066fafd12ad8aa750f1ae

data/README.md

@@ -0,0 +1,63 @@
+# About
+
+[![Gem version][GV img]][Gem version]
+[![Build status][BS img]][Build status]
+[![Coverage status][CS img]][Coverage status]
+[![CodeClimate status][CC img]][CodeClimate status]
+[![YARD documentation][YD img]][YARD documentation]
+
+This format is used to store **scheduled tasks**: tasks that will be done later
+or in a certain context.
+
+# API
+
+```ruby
+require 'import'
+
+simple_format = import('simple-format')
+simple_format.parse(File.read('tasks.todo'))
+```
+
+# Format
+
+```
+Tomorrow
+- Buy milk. #errands
+- [9:20] Call with Mike.
+
+Prague
+- Pick up my shoes. #errands
+```
+
+# Currently unsupported
+
+- **Labels**. Labels allow us to match tasks with _named_ time frames.
+  See [#8](https://github.com/botanicus/now-task-manager/issues/8).
+
+```
+- ADM: Catch up with Eva.
+```
+
+# Intentionally unsupported
+
+- **Comments**. I want to keep the format simple and the task file small.
+  Every time there was something like comments, the file bloated uncontrollably.
+- **Task formatting**. Task is a string, it doesn't recognise any structures within.
+  Therefore, anything you can fit in to a line will be the task body. So you can
+  put anything that {Pomodoro::Formats::Today} supports such as scheduled times
+  and tags.
+
+_For more details about the format see
+[parser_spec.rb](https://github.com/botanicus/scheduled-format/blob/master/spec/scheduled-format/parser/parser_spec.rb)._
+
+[Gem version]: https://rubygems.org/gems/scheduled-format
+[Build status]: https://travis-ci.org/botanicus/scheduled-format
+[Coverage status]: https://coveralls.io/github/botanicus/scheduled-format
+[CodeClimate status]: https://codeclimate.com/github/botanicus/scheduled-format/maintainability
+[YARD documentation]: http://www.rubydoc.info/github/botanicus/scheduled-format/master
+
+[GV img]: https://badge.fury.io/rb/scheduled-format.svg
+[BS img]: https://travis-ci.org/botanicus/scheduled-format.svg?branch=master
+[CS img]: https://img.shields.io/coveralls/botanicus/scheduled-format.svg
+[CC img]: https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability
+[YD img]: http://img.shields.io/badge/yard-docs-blue.svg

data/lib/scheduled-format.rb

@@ -0,0 +1,37 @@
+require 'parslet'
+require 'parslet/convenience' # parse_with_debug
+
+Parser = import('scheduled-format/parser/parser')
+Transformer = import('scheduled-format/parser/transformer')
+TaskList = import('scheduled-format/task_list')
+
+# {include:file:doc/formats/scheduled.md}
+# The entry point method for parsing this format.
+#
+# @param string [String] string in the scheduled task list format
+# @return [TaskList, nil]
+#
+# @example
+#   scheduled_format = import('scheduled-format')
+#
+#   task_list = scheduled_format.parse <<-EOF.gsub(/^\s*/, '')
+#     Tomorrow
+#     - Buy milk. #errands
+#     - [9:20] Call with Mike.
+#
+#     Prague
+#     - Pick up my shoes. #errands
+#   EOF
+# @since 0.2
+def exports.parse(string_or_io)
+  string = string_or_io.respond_to?(:read) ? string_or_io.read : string_or_io
+  tree = Parser.new.parse_with_debug(string)
+  nodes = Transformer.new.apply(tree)
+  TaskList.new(nodes.empty? ? Array.new : nodes)
+end
+
+export parser: Parser,
+       transformer: Transformer,
+       task: import('scheduled-format/task'),
+       task_list: TaskList,
+       task_group: import('scheduled-format/task_group')

data/lib/scheduled-format/parser/parser.rb

@@ -0,0 +1,46 @@
+require 'parslet'
+
+# @api private
+class Parser < Parslet::Parser
+  rule(:hour_strict) {
+    (match['\d'].repeat(1) >> str(':') >> match['\d'].repeat(2, 2)).as(:hour)
+  }
+
+  rule(:start_time) {
+    str('[') >> hour_strict.as(:start_time) >> str(']') >> str(' ').maybe
+  }
+
+  rule(:time_frame) {
+    # TODO: (hour_strict.absent? >> match['^\]\n'] >> any)
+    str('[') >> match['\w '].repeat.as(:str) >> str(']') >> str(' ').maybe
+  }
+
+  rule(:header) {
+    # match['^\n'].repeat # This makes it hang!
+    (str("\n").absent? >> any).repeat(1).as(:str) >> str("\n")
+  }
+
+  rule(:task_body) do
+    (match['#\n'].absent? >> any).repeat.as(:str)
+  end
+
+  rule(:tag) do
+    str('#') >> match['^\s'].repeat.as(:str) >> str(' ').maybe
+  end
+
+  rule(:task) {
+    str('- ') >> (time_frame.as(:time_frame).maybe >> start_time.maybe >> task_body.as(:body) >> tag.as(:tag).repeat.as(:tags).maybe).as(:task) >> str("\n").repeat
+  }
+
+  rule(:task_group) {
+    (header.as(:header) >> task.repeat.as(:tasks)).as(:task_group)
+  }
+
+  rule(:task_groups) {
+    task_group.repeat(0)
+  }
+
+  root(:task_groups)
+end
+
+export { Parser }

data/lib/scheduled-format/parser/transformer.rb

@@ -0,0 +1,26 @@
+require 'parslet'
+require 'refined-refinements/hour'
+
+Task = import('scheduled-format/task')
+TaskGroup = import('scheduled-format/task_group')
+
+# @api private
+class Transformer < Parslet::Transform
+  rule(str: simple(:slice)) { slice.to_s.strip }
+
+  rule(tag: simple(:slice)) { slice.to_sym }
+
+  rule(hour: simple(:hour_string)) do
+    Hour.parse(hour_string.to_s)
+  end
+
+  rule(task: subtree(:data)) do
+    Task.new(**data)
+  end
+
+  rule(task_group: subtree(:data)) {
+    TaskGroup.new(**data)
+  }
+end
+
+export { Transformer }

data/lib/scheduled-format/task.rb

@@ -0,0 +1,39 @@
+class Task
+  attr_reader :body, :time_frame, :start_time, :tags
+
+  # Create a new scheduled task.
+  #
+  # @param body [String] the task description.
+  # @param start_time [Hour] when the task starts.
+  # @param time_frame [String] name, initials or an abbreviation of a time frame
+  #   to which the task will be scheduled.
+  # @param tags [Array<Symbol>] list of tags.
+  def initialize(body:, time_frame: nil, start_time: nil, tags: Array.new)
+    @body, @time_frame, @start_time, @tags = body, time_frame, start_time, tags
+
+    if body.empty?
+      raise ArgumentError.new("Body cannot be empty.")
+    end
+
+    if start_time && ! start_time.is_a?(Hour)
+      raise ArgumentError.new("Hour instance was expected, got #{start_time.class}")
+    end
+
+    if ! tags.empty? && tags.any? { |tag| ! tag.is_a?(Symbol) }
+      raise ArgumentError.new("Tags are supposed to be an array of symbols.")
+    end
+  end
+
+  # Format task in the {Pomodoro::Formats::Scheduled scheduled task list format}.
+  # @since 0.2
+  def to_s
+    [
+      '-',
+      ("[#{@time_frame}]" if @time_frame),
+      ("[#{@start_time}]" if @start_time),
+      "#{@body}", *@tags.map { |tag| "##{tag}"}
+    ].compact.join(' ')
+  end
+end
+
+export { Task }

data/lib/scheduled-format/task_group.rb

@@ -0,0 +1,101 @@
+require 'date'
+
+class TaskGroup
+  # @since 0.2
+  attr_reader :header, :tasks
+
+  # @param header [String] header of the task group.
+  # @param tasks [Array<String>] tasks of the group.
+  # @since 0.2
+  #
+  # @example
+  #   TaskGroup = import('scheduled-format/task_group')
+  #
+  #   tasks = ['Buy milk. #errands', '[9:20] Call with Mike.']
+  #   group = TaskGroup.new(header: 'Tomorrow', tasks: tasks)
+  def initialize(header:, tasks: Array.new)
+    @header, @tasks = header, tasks
+    if tasks.any? { |task| ! task.is_a?(Task) }
+      raise ArgumentError.new("Task objects expected.")
+    end
+  end
+
+  # Add a task to the task group.
+  #
+  # @since 0.2
+  def <<(task)
+    unless task.is_a?(Task)
+      raise ArgumentError.new("Task expected, got #{task.class}.")
+    end
+
+    @tasks << task unless @tasks.map(&:to_s).include?(task.to_s)
+  end
+
+  # Remove a task from the task group.
+  #
+  # @since 0.2
+  def delete(task)
+    unless task.is_a?(Task)
+      raise ArgumentError.new("Task expected, got #{task.class}.")
+    end
+
+    @tasks.delete_if { |t2| t2.to_s == task.to_s }
+  end
+
+  # Return a scheduled task list formatted string.
+  #
+  # @since 0.2
+  def to_s
+    [@header, @tasks.map(&:to_s), nil].flatten.join("\n")
+  end
+
+  def save(path)
+    data = self.to_s
+    File.open(path, 'w:utf-8') do |file|
+      file.puts(data)
+    end
+  end
+
+  # TODO: Next Monday
+  # NOTE: For parsing we don't use %-d etc, only %d.
+  DATE_FORMATS = {
+    '%d/%m'    => :next_month,    # 1/1
+    '%d/%m/%Y' => nil,            # 1/1/2018
+    '%A %d/%m' => :next_week,     # Monday 1/1  Note: Higher specifity has to come first.
+    '%A'       => :next_week      # Monday
+  }
+
+  # labels = ['Tomorrow', date.strftime('%A'), date.strftime('%-d/%m'), date.strftime('%-d/%m/%Y')]
+  def scheduled_date
+    return Date.today if @header == 'Today' # Change tomorrow to Today if you're generating it in the morning.
+    return Date.today + 1 if @header == 'Tomorrow'
+    parse_date_in_the_future(@header)
+  end
+
+  def tomorrow?
+    self.scheduled_date == Date.today + 1
+  end
+
+  private
+
+  # TODO: We need base_date, Date.today wouldn't cut it if we run "now g +3".
+  def parse_date_in_the_future(header)
+    DATE_FORMATS.each do |format, adjustment_method|
+      begin
+        date = Date.strptime(header, format)
+        date.define_singleton_method(:next_week) { self + 7 } # TODO: DataExts, extract it from commands.rb.
+        return ensure_in_the_future(date, adjustment_method)
+      rescue ArgumentError
+      end
+    end
+
+    return nil
+  end
+
+  def ensure_in_the_future(date, adjustment_method)
+    return date if adjustment_method.nil? || Date.today <= date
+    date.send(adjustment_method)
+  end
+end
+
+export { TaskGroup }

data/lib/scheduled-format/task_list.rb

@@ -0,0 +1,106 @@
+class TaskList
+  include Enumerable
+
+  # List of {TaskGroup task groups}. Or more precisely objects responding to `#header` and `#tasks`.
+  # @since 0.2
+  attr_reader :data
+
+  # @param [Array<TaskGroup>] data List of task groups.
+  #   Or more precisely objects responding to `#header` and `#tasks`.
+  # @raise [ArgumentError] if data is not an array or if its content doesn't
+  #   respond to `#header` and `#tasks`.
+  #
+  # @example
+  #   TaskGroup, TaskList = import('scheduled-format').grab(:TaskGroup, :TaskList)
+  #
+  #   tasks = ['Buy milk. #errands', '[9:20] Call with Mike.']
+  #   group = TaskGroup.new(header: 'Tomorrow', tasks: tasks)
+  #   list  = TaskList.new([group])
+  # @since 0.2
+  def initialize(data)
+    @data = data
+
+    unless data.is_a?(Array) && data.all? { |item| item.respond_to?(:header) && item.respond_to?(:tasks) }
+      raise ArgumentError.new("Data is supposed to be an array of TaskGroup instances.")
+    end
+  end
+
+  # Find a task group that matches given header.
+  #
+  # @return [TaskGroup, nil] matching the header.
+  # @since 0.2
+  #
+  # @example
+  #   # Using the code from the initialiser.
+  #   list['Tomorrow']
+  def [](header)
+    @data.find do |task_group|
+      task_group.header == header
+    end
+  end
+
+  # Add a task group onto the task list.
+  #
+  # @raise [ArgumentError] if the task group is already in the list.
+  # @param [TaskGroup] task_group the task group.
+  # @since 0.2
+  def <<(task_group)
+    unless task_group.is_a?(TaskGroup)
+      raise ArgumentError.new("TaskGroup expected, got #{task_group.class}.")
+    end
+
+    if self[task_group.header]
+      raise ArgumentError.new("Task group with header #{task_group.header} is already on the list.")
+    end
+
+    @data << task_group
+    self.sort!
+  end
+
+  def scheduled_task_groups
+    @data.group_by { |tg| tg.scheduled_date.nil? }[false] || Array.new
+  end
+
+  def non_scheduled_task_groups
+    @data.group_by { |tg| tg.scheduled_date.nil? }[true] || Array.new
+  end
+
+  def sort!
+    @data = self.scheduled_task_groups.sort_by(&:scheduled_date) +
+            self.non_scheduled_task_groups
+
+    self
+  end
+
+  # Remove a task group from the task list.
+  #
+  # @param [TaskGroup] task_group the task group.
+  # @since 0.2
+  def delete(task_group)
+    @data.delete(task_group)
+  end
+
+  # Iterate over the task groups.
+  #
+  # @yieldparam [TaskGroup] task_group
+  # @since 0.2
+  def each(&block)
+    @data.each(&block)
+  end
+
+  # Return a scheduled task list formatted string.
+  #
+  # @since 0.2
+  def to_s
+    @data.map(&:to_s).join("\n")
+  end
+
+  def save(path)
+    data = self.to_s
+    File.open(path, 'w:utf-8') do |file|
+      file.puts(data)
+    end
+  end
+end
+
+export { TaskList }

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: scheduled-format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James C Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commonjs_modules
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: "."
+email: james@101ideas.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/scheduled-format.rb
+- lib/scheduled-format/parser/parser.rb
+- lib/scheduled-format/parser/transformer.rb
+- lib/scheduled-format/task.rb
+- lib/scheduled-format/task_group.rb
+- lib/scheduled-format/task_list.rb
+homepage: http://github.com/botanicus/scheduled-format
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []