omnifocus_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4aa7bed8ea0fad435f0682b7b33f6bcfa12d78adde0273e10a793797409f0388
+  data.tar.gz: 7dc575f2d16e48cc0c6a3586436fe226d1634c1f5a737dc7adbb3d2941960cf7
+SHA512:
+  metadata.gz: '0883608fa3dad57ab1ed6d40f565ecdbad137faeeb532e06fe3596c64f561cd7113be83a5c599548c4db2afcc283cc612b78d2134f343809c1929b90823f2740'
+  data.tar.gz: cc51c2cc85c406f179cbd75730b868f5b9f6a9083beadad306912b914d0f7a20382d22bc16dd069fd207b86cd77055f67fb8ac79fe532f28d9e73af0e2bd60d5

data/.rubocop.yml

@@ -0,0 +1,17 @@
+# based on https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard
+
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-minitest
+  - rubocop-rake
+  - standard
+
+inherit_gem:
+  standard: config/ruby-3.0.yml
+
+AllCops:
+  NewCops: disable

data/.ruby-version

@@ -0,0 +1 @@
+ruby 3.2.0

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "cSpell.words": [
+        "Omnifocus"
+    ]
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omnifocus_parser.gemspec
+gemspec
+
+gem "debug"
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+gem "ruby-lsp", require: false
+gem "rubocop-minitest"
+gem "rubocop-rake"
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    omnifocus_parser (0.1.0)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    prettier_print (1.2.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.2)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.25.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-lsp (0.3.7)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 4.0.2, < 5.0.0)
+    ruby-progressbar (1.11.0)
+    sorbet-runtime (0.5.10598)
+    standard (1.20.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.40.0)
+      rubocop-performance (= 1.15.1)
+    syntax_tree (4.3.0)
+      prettier_print (>= 1.0.2)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  minitest (~> 5.0)
+  omnifocus_parser!
+  rake (~> 13.0)
+  rubocop-minitest
+  rubocop-rake
+  ruby-lsp
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Andy Waite
+
+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,40 @@
+# OmnifocusParser
+
+This library parses a CSV export from [OmniFocus](https://www.omnigroup.com/omnifocus/) into a set of convenient objects.
+
+Note: I wrote this gem to try out the newly added `Data` core class in Ruby ([learn more](https://blog.saeloun.com/2022/11/22/data-immutable-object.html)), so it can only be used with Ruby 3.2 or newer.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add omnifocus_parser
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install omnifocus_parser
+
+## Usage
+
+```ruby
+require "omnifocus_parser"
+
+parser = OmniFocusParser::Parser.new("example.csv")
+entries = parser.parse
+entries[0].class # => OmnifocusParser::Project
+entries[1].class # => OmnifocusParser::Item
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/andyw8/omnifocus_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/omnifocus_parser/action.rb

@@ -0,0 +1,16 @@
+module OmnifocusParser
+  Action = Data.define(
+    :task_id,
+    :name,
+    :status,
+    :project,
+    :context,
+    :due_date,
+    :completion_date,
+    :duration,
+    :start_date,
+    :flagged,
+    :notes,
+    :tags
+  )
+end

data/lib/omnifocus_parser/builder.rb

@@ -0,0 +1,39 @@
+module OmnifocusParser
+  class Builder
+    MAPPING = {
+      "Project" => Project,
+      "Action" => Action
+    }
+
+    def self.from_row(row)
+      task_id = row.fetch("Task ID")
+      type = row.fetch("Type")
+      name = row.fetch("Name")
+      status = row.fetch("Status")
+      project = row.fetch("Project")
+      context = row.fetch("Context")
+      due_date = row.fetch("Due Date")&.then { DateTime.parse(_1) }
+      completion_date = row.fetch("Completion Date")&.then { Date.parse(_1) }
+      duration = row.fetch("Duration")
+      start_date = row.fetch("Start Date")&.then { DateTime.parse(_1) }
+      flagged = row.fetch("Flagged") == "1"
+      notes = row.fetch("Notes")
+      tags = row.fetch("Tags")&.split(",")
+
+      MAPPING.fetch(type).new(
+        task_id: task_id,
+        name: name,
+        status: status,
+        project: project,
+        context: context,
+        due_date: due_date,
+        completion_date: completion_date,
+        duration: duration,
+        start_date: start_date,
+        flagged: flagged,
+        notes: notes,
+        tags: tags
+      )
+    end
+  end
+end

data/lib/omnifocus_parser/parser.rb

@@ -0,0 +1,15 @@
+require "csv"
+
+module OmnifocusParser
+  class Parser
+    def initialize(csv)
+      @csv = csv
+    end
+
+    def parse
+      CSV.foreach(@csv, headers: true).map do |row|
+        Builder.from_row(row)
+      end
+    end
+  end
+end

data/lib/omnifocus_parser/project.rb

@@ -0,0 +1,16 @@
+module OmnifocusParser
+  Project = Data.define(
+    :task_id,
+    :name,
+    :status,
+    :project,
+    :context,
+    :due_date,
+    :completion_date,
+    :duration,
+    :start_date,
+    :flagged,
+    :notes,
+    :tags
+  )
+end

data/lib/omnifocus_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OmnifocusParser
+  VERSION = "0.1.0"
+end

data/lib/omnifocus_parser.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module OmnifocusParser
+  class Error < StandardError; end
+end

data/omnifocus_parser.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/omnifocus_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "omnifocus_parser"
+  spec.version = OmnifocusParser::VERSION
+  spec.authors = ["Andy Waite"]
+  spec.email = ["andyw8@users.noreply.github.com"]
+
+  spec.summary = "OmniFocus parser"
+  spec.homepage = "https://gitub.com/andyw8/omnifocus_parser"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "zeitwerk"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/omnifocus_parser.rbs

@@ -0,0 +1,4 @@
+module OmnifocusParser
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: omnifocus_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Waite
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- andyw8@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- ".standard.yml"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omnifocus_parser.rb
+- lib/omnifocus_parser/action.rb
+- lib/omnifocus_parser/builder.rb
+- lib/omnifocus_parser/parser.rb
+- lib/omnifocus_parser/project.rb
+- lib/omnifocus_parser/version.rb
+- omnifocus_parser.gemspec
+- sig/omnifocus_parser.rbs
+homepage: https://gitub.com/andyw8/omnifocus_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitub.com/andyw8/omnifocus_parser
+  source_code_uri: https://gitub.com/andyw8/omnifocus_parser
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: OmniFocus parser
+test_files: []