rb-dayone 0.3.3 → 0.4.0

data/History.rdoc

@@ -1,3 +1,7 @@
+== 0.4.0 / 2012-10-22
+
+* Added image support
+
 == 0.3.3 / 2012-08-17
 
 * [FIXED] LibXML will now accept UTF-8 characters in journal entries.

data/bin/dayone

@@ -42,23 +42,40 @@ Note: setting location to "auto" will set it from the DayOne plist file.
 end
 
 command :add do |c|
-  c.syntax = "add [--text=\"Entry text\"] [--starred]"
+  c.syntax = "add [--text \"Entry text\"] [--image path/to/image.jpg] [--starred]"
   c.description = "Add an entry to your DayOne journal."
   c.summary = <<-end
 Add an entry to your DayOne journal. By default will add an unstarred entry - use the --starred flag to change this.
 
-If you don't specify the --text tag, it will read text from STDIN and use this as the journal entry.
+If you don't specify the --text or --image tag, it will read text from STDIN and use this as the journal entry.
   end
   
   c.option "--text STRING", String, "Specify the journal entry text. If not specified, will read from STDIN"
   c.option "--starred", "Mark the entry starrd"
+  c.option "--image path/to/image.jpg", "Add an image to the entry"
 
   c.action do |args, opts|
     require 'rb-dayone'
-    entry_text = opts.text || $stdin.read.strip
-    starred = opts.starred
+    entry = DayOne::Entry.new
+
+    needs_stdin_help = !(opts.image || opts.text)
+    if needs_stdin_help
+      entry.entry_text = $stdin.read.strip
+    else
+      entry.entry_text = opts.text if opts.text
+
+      if opts.image
+        if File.exists? opts.image
+          entry.image = opts.image
+        else
+          puts "Can't find image: #{opts.image}"
+          exit 1
+        end
+      end
+    end
+
+    entry.starred = opts.starred
     
-    entry = DayOne::Entry.new entry_text, starred:starred
     entry.create!
   end
 end

data/lib/rb-dayone/entry.rb

@@ -1,8 +1,12 @@
 require 'libxml'
+require 'fileutils'
 
 # A text-only journal entry for DayOne.
 class DayOne::Entry
 
+  # A list of image extensions allowed for attached images
+  ALLOWED_IMAGES = ['.jpg','.jpeg']
+
   # The date of the journal entry
   attr_accessor :creation_date
   
@@ -14,6 +18,9 @@ class DayOne::Entry
   
   # Whether the entry has been saved to file at all.
   attr_accessor :saved
+
+  # Path to the entry image
+  attr_accessor :image
   
   # The PList doctype, used for XML export
   DOCTYPE = [:DOCTYPE, :plist, :PUBLIC, "-//Apple//DTD PLIST 1.0//EN", "http://www.apple.com/DTDs/PropertyList-1.0.dtd"]
@@ -76,13 +83,18 @@ class DayOne::Entry
   end
   
   # Create a .doentry file with this entry.
-  # This uses the #to_xml method to generate
-  # the entry proper.
+  # This uses the #to_xml method to generate the entry proper.
+  # It will also relocate its attached image, if required.
   # @return [Boolean] true if the operation was successful.
   def create!
     xml = self.to_xml
     file_location = File.join(DayOne::journal_location,'entries',"#{uuid}.doentry")
     File.open(file_location,'w'){ |io| io << xml }
+    if image
+      new_image_path = File.join(DayOne::journal_location, 'photos', "#{uuid}.jpg")
+      FileUtils.cp(image, new_image_path)
+      @image = new_image_path
+    end
     return true
   end
   
@@ -97,4 +109,18 @@ class DayOne::Entry
       return true
     end
   end
+
+  # Assign an image to the entry
+  # For now, this will only accept jpeg images (extension is 'jpg' or 'jpeg', case-insensitive)
+  # Later, may support conversion via the appropriate library
+  # @param image_path [String] the path to the image
+  def image= image_path
+    if !File.exists?(image_path)
+      raise RuntimeError, "Tried to link a journal entry to the image #{image_path}, but it doesn't exist."
+    elsif image_path =~ /\.[^.]+$/ && ALLOWED_IMAGES.include?($&.downcase)
+      @image = image_path
+    else
+      raise RuntimeError, "Tried to link a journal entry to the image #{image_path}, but it's not a supported image format (#{ALLOWED_IMAGES.join(", ")})."
+    end
+  end
 end

data/spec/entry_spec.rb

@@ -3,11 +3,11 @@ require 'fileutils'
 
 describe DayOne::Entry do
   before :each do
-    FileUtils::mkdir_p spec_data('working/entries')
+    setup_working
   end
   
   after :each do
-    FileUtils::rm_rf spec_data('working')
+    clean_working
   end
   
   describe "#to_xml" do
@@ -34,7 +34,6 @@ describe DayOne::Entry do
   describe "#create!" do
     it "should correctly create a .doentry file" do
       
-      DayOne::journal_location = spec_data('working')
       
       e = subject
       e.entry_text = "Hello, world!"

data/spec/spec_helper.rb

@@ -2,4 +2,14 @@ require './lib/rb-dayone'
 
 def spec_data *path
   File.join(File.dirname(__FILE__), 'data', *path)
+end
+
+def setup_working
+  FileUtils::mkdir_p spec_data('working/entries')
+  FileUtils::mkdir_p spec_data('working/photos')
+  DayOne::journal_location = spec_data('working')
+end
+
+def clean_working
+  FileUtils::rm_rf spec_data('working')
 end

data/version.txt

@@ -1 +1 @@
-0.3.3
+0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb-dayone
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2012-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder