rdayone 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rdayone.gemspec
+gemspec
+
+gem 'guard-rspec'
+gem 'growl'

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{spec/fixtures/.+$})     { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Simon Jefford
+
+MIT License
+
+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,38 @@
+# Rdayone
+
+Rdayone is a simple Ruby library for accessing Day One journals.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rdayone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rdayone
+
+## Usage
+
+``` ruby
+require "rdayone"
+journal = Rdayone::Journal.new("/path/to/Journal.dayone")
+journal.entries # An Enumerable array like object that contains all your entries
+```
+
+## NOTE
+
+This is a *very* early release. Entries currently contain the entry text
+and date only.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rdayone/entry.rb

@@ -0,0 +1,21 @@
+module Rdayone
+  class Entry
+    def initialize(plist_hash = {})
+      @plist_hash = plist_hash
+      @attribute_mappings = {
+        text: "Entry Text",
+        creation_date: "Creation Date",
+        identifier: "UUID"
+      }
+    end
+
+    def method_missing(method, *args)
+      key = @attribute_mappings[method]
+      if key
+        @plist_hash[key]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/rdayone/entry_list.rb

@@ -0,0 +1,30 @@
+require 'plist'
+
+module Rdayone
+  class EntryList
+    include Enumerable
+
+    def initialize(entry_paths)
+      @entry_paths = entry_paths
+      @entry_cache = {}
+    end
+
+    def fetch(index)
+      raise ArgumentError if index > @entry_paths.length
+      entry = @entry_cache[index]
+      unless entry
+        entry = Rdayone::Entry.new(Plist::parse_xml(@entry_paths[index]))
+        @entry_cache[index] = entry
+      end
+      entry
+    end
+
+    alias :[] :fetch
+
+    def each
+      (0..@entry_paths.length - 1).each do |index|
+        yield self.fetch(index)
+      end
+    end
+  end
+end

data/lib/rdayone/finder.rb

@@ -0,0 +1,7 @@
+module Rdayone
+  class Finder
+    def self.find(path)
+      EntryList.new(Dir["#{path}/entries/*.doentry"])
+    end
+  end
+end

data/lib/rdayone/journal.rb

@@ -0,0 +1,11 @@
+module Rdayone
+  class Journal
+    attr_reader :file_path, :entries, :finder
+
+    def initialize(file_path, finder = Rdayone::Finder)
+      @file_path = file_path
+      @finder = finder
+      @entries = finder.find(file_path)
+    end
+  end
+end

data/lib/rdayone/version.rb

@@ -0,0 +1,3 @@
+module Rdayone
+  VERSION = "0.0.1"
+end

data/lib/rdayone.rb

@@ -0,0 +1,9 @@
+require "rdayone/version"
+require "rdayone/journal"
+require "rdayone/finder"
+require "rdayone/entry"
+require "rdayone/entry_list"
+
+module Rdayone
+  # Your code goes here...
+end

data/rdayone.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rdayone/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Simon Jefford"]
+  gem.email         = ["simon.jefford@gmail.com"]
+  gem.description   = %q{A ruby gem for accessing Day One (http://dayoneapp.com/) journals}
+  gem.summary       = %q{Access Day One journals from ruby.}
+  gem.homepage      = "http://github.com/simonjefford/rdayone"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rdayone"
+  gem.require_paths = ["lib"]
+  gem.version       = Rdayone::VERSION
+  gem.add_dependency('plist', '~> 3.1.0')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec', '~> 2.11.0')
+end

data/spec/fixtures/entries/02B82925942747709E1DF0518A650E1B.doentry

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Creation Date</key>
+	<date>2012-08-07T08:44:32Z</date>
+	<key>Entry Text</key>
+	<string>Something cool happened in London</string>
+	<key>Location</key>
+	<dict>
+		<key>Administrative Area</key>
+		<string>England</string>
+		<key>Country</key>
+		<string>United Kingdom</string>
+		<key>Latitude</key>
+		<real>51.505845000000001</real>
+		<key>Locality</key>
+		<string>London</string>
+		<key>Longitude</key>
+		<real>-0.1308377</real>
+		<key>Place Name</key>
+		<string>The Mall</string>
+		<key>State</key>
+		<string>manual</string>
+	</dict>
+	<key>Starred</key>
+	<false/>
+	<key>UUID</key>
+	<string>02B82925942747709E1DF0518A650E1B</string>
+	<key>Weather</key>
+	<dict>
+		<key>Celsius</key>
+		<string>15</string>
+		<key>Description</key>
+		<string>Partly Cloudy</string>
+		<key>Fahrenheit</key>
+		<string>59</string>
+		<key>IconName</key>
+		<string>pcloudy.png</string>
+	</dict>
+</dict>
+</plist>

data/spec/rdayone/entry_list_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Rdayone::EntryList do
+  subject { Rdayone::EntryList.new(entry_fixture_paths) }
+
+  context "entry fetching" do
+    it "returns the nth entry when used like an array" do
+      e = subject[0]
+      expect(e).to_not be_nil
+    end
+
+    it "returns a populated Entry" do
+      e = subject[0]
+      expect(e.text).to eq("Something cool happened in London")
+    end
+
+    it "throws an error if the index is out of range" do
+      expect { subject[100] }.to raise_error(ArgumentError)
+    end
+  end
+
+  context "enumerating" do
+    it "implements each" do
+      entries = []
+      subject.each { |e| entries << e }
+      expect(entries.count).to eq(1)
+    end
+
+    it "is Enumerable" do
+      mapresult = subject.map { |e| e.text }
+      expect(mapresult).to eq(["Something cool happened in London"])
+    end
+  end
+
+  context "caching" do
+    it "should cache entries for subsequent requests" do
+      list = subject.to_a
+      Plist.stub(:parse_xml).and_raise("Entry was not cached")
+      subject[0]
+    end
+  end
+end

data/spec/rdayone/entry_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Rdayone::Entry do
+  context "initialisation" do
+    it "can occur with no arguments" do
+      entry = Rdayone::Entry.new
+    end
+  end
+
+  context "basic parsing" do
+    let(:creation_date) { DateTime.new }
+
+    subject do
+      hash = { "Creation Date" => creation_date,
+               "Entry Text" => "something cool happened today",
+               "UUID" => "02B82925942747709E1DF0518A650E1B"}
+      Rdayone::Entry.new(hash)
+    end
+
+    it "populates the identifier" do
+      expect(subject.identifier).to eq("02B82925942747709E1DF0518A650E1B")
+    end
+
+    it "populates the entry text" do
+      expect(subject.text).to eq("something cool happened today")
+    end
+
+    it "populates the creation date" do
+      expect(subject.creation_date).to eq(creation_date)
+    end
+  end
+end

data/spec/rdayone/finder_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Rdayone::Finder do
+  it "finds all entries in the given directory" do
+    result = Rdayone::Finder.find('spec/fixtures')
+    expect(result.count).to be > 0
+  end
+end

data/spec/rdayone/journal_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Rdayone::Journal do
+  describe "loading" do
+    let(:finder) do
+      f = double("finder")
+      f.stub(:find) { [double("entry")] }
+      f
+    end
+
+    subject { Rdayone::Journal.new("some_path", finder) }
+
+    it "takes a file path" do
+      expect(subject.file_path).to eq("some_path")
+    end
+
+    it "populates an entries list" do
+      expect(subject.entries.count).to eq(1)
+    end
+
+    it "uses an entry finder" do
+      finder.should_receive(:find).with("some_path")
+      subject
+    end
+  end
+
+  describe "finder interaction" do
+    it "should default to the provided finder" do
+      journal = Rdayone::Journal.new("some_path")
+      expect(journal.finder).to eq(Rdayone::Finder)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require_relative '../lib/rdayone'
+require 'rspec'
+
+def entry_fixture_paths
+  Dir['spec/fixtures/entries/*']
+end
+
+def photo_fixture_paths
+  Dir['spec/fixtures/photos/*']
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rdayone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Simon Jefford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: A ruby gem for accessing Day One (http://dayoneapp.com/) journals
+email:
+- simon.jefford@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rdayone.rb
+- lib/rdayone/entry.rb
+- lib/rdayone/entry_list.rb
+- lib/rdayone/finder.rb
+- lib/rdayone/journal.rb
+- lib/rdayone/version.rb
+- rdayone.gemspec
+- spec/fixtures/entries/02B82925942747709E1DF0518A650E1B.doentry
+- spec/rdayone/entry_list_spec.rb
+- spec/rdayone/entry_spec.rb
+- spec/rdayone/finder_spec.rb
+- spec/rdayone/journal_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/simonjefford/rdayone
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4021303384569122307
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4021303384569122307
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Access Day One journals from ruby.
+test_files:
+- spec/fixtures/entries/02B82925942747709E1DF0518A650E1B.doentry
+- spec/rdayone/entry_list_spec.rb
+- spec/rdayone/entry_spec.rb
+- spec/rdayone/finder_spec.rb
+- spec/rdayone/journal_spec.rb
+- spec/spec_helper.rb