rb-dayone 0.1.7 → 0.2.0

data/History.rdoc

@@ -1,4 +1,8 @@
-== 0.1.7 / 
+== 0.2.0 / 2012-08-14
+
+* Now auto-detects DayOne journal location from your plist file
+
+== 0.1.7 / 2012-08-13
 
 * The dayone binary can now add entries to your journal
 * [FIXED] Managed to break the gem's include in 0.1.6, and because I'm a terrible amateur at all this, didn't pick up on it.

data/Manifest

@@ -3,9 +3,16 @@ Gemfile
 History.rdoc
 lib/rb-dayone.rb
 lib/rb-dayone/entry.rb
+lib/rb-dayone/plist_reader.rb
 Manifest
 rb-dayone.gemspec
 README.md
+spec/dayone_spec.rb
 spec/entry_spec.rb
+spec/locations/location-auto/location
+spec/locations/location-specified/location
+spec/locations/location-unspecified
 spec/spec_helper.rb
+spec/plist_reader_spec.rb
+spec/sample.plist
 version.txt

data/README.md

@@ -2,46 +2,45 @@
 
 A means to create DayOne entries in ruby. Also, my first public ruby gem!
 
-Examples
---------
+## Examples
 
 You can create an entry pretty simply, by passing in your entry text:
 
-  e = DayOne::Entry.new "# Hello, world!"
+    e = DayOne::Entry.new "# Hello, world!"
   
 You can also set up other values via a hash:
 
-  e = DayOne::Entry.new "I totally posted this an hour ago", creation_date: Time.now-3600
+    e = DayOne::Entry.new "I totally posted this an hour ago", creation_date: Time.now-3600
 
 Otherwise, you can set values using simple accessor methods, as you'd expect:
 
-  e = DayOne::Entry.new "I need to remember this."
-  e.starred = true
+    e = DayOne::Entry.new "I need to remember this."
+    e.starred = true
 
 When you're ready to save your entry, just run the `create!` method:
 
-  e.create!
+    e.create!
 
 Alternatively, run from the command line:
 
-  dayone add --text "#Hello, world" --starred
+    dayone add --text "#Hello, world" --starred
 
-Install
--------
+For more information on what you can do from the command line:
 
-`gem install rb-dayone`
+    dayone --help
 
-Author
-------
+## Install
 
-Original author: Jan-Yves Ruzicka
+    gem install rb-dayone
 
-To do
--------
+## Author
+
+Original author: Jan-Yves Ruzicka (@akchizar). Get in touch [via email](mailto:janyves.ruzicka@gmail.com).
+
+## To do
 
 * Image support
 * Location support?
-* Auto-journal detection
 
 License
 -------

data/bin/dayone

@@ -12,7 +12,11 @@ dayone_location_file = File.join(dayone_folder, 'location')
 command :set do |c|
   c.syntax = "set [key value]"
   c.description = "Show or set program settings."
-  c.summary = "If sent without arguments, this will show all program settings. If sent with two arguments, this will set <key> to <value>"
+  c.summary = <<-end
+If sent without arguments, this will show all program settings. If sent with two arguments, this will set <key> to <value>.
+  
+Note: setting location to "auto" will set it from the DayOne plist file.
+  end
   
   c.action do |args|
     case args.size
@@ -22,7 +26,7 @@ command :set do |c|
       key, val = *args
       case key
       when 'location'
-        new_dayone_location = File.expand_path(val)
+        new_dayone_location = (val == 'auto' ? 'auto' : File.expand_path(val))
         File.open(dayone_location_file,'w'){ |io| io << new_dayone_location }
         puts "#{key}: #{new_dayone_location}"
       else

data/lib/rb-dayone.rb

@@ -9,22 +9,37 @@ module DayOne
     # Set by default to ~/.rb-dayone
     attr_accessor :dayone_folder
     
-    # The location of the journal file
-    attr_accessor :journal_location
+    # The location of the DayOne journal file.
+    attr_writer :journal_location
+    
+    # An interface to the propertylist reader
+    attr_accessor :plist_reader
   
-    # This is where your DayOne Journal is kept. Modify either
-    # by directly modifying the ~/.rb-dayone/location file
-    # or by running `dayone --set location`
-    # @return [String] the location of DayOne's journal file.
+    # The location of the DayOne journal file.
+    # If the location is set to "auto" or is non-existant,
+    # will set from the DayOne plist (See +auto_journal_location+).
+    # @return [String] the DayOne journal location
     def journal_location
-      @journal_location ||= File.read(journal_file).strip
+      if !@journal_location 
+        if File.exists?(journal_file)
+          contents = File.read(journal_file)
+          @journal_location = if contents == 'auto'
+            auto_journal_location
+          else
+            contents
+          end
+        else
+          @journal_location = auto_journal_location
+        end
+      end
+      @journal_location
     end
     
-    # Error-checking method. Ensures that the journal location
-    # file exists.
-    # @return [Boolean] whether or not the journal location file exists
-    def journal_location_exists?
-      File.exists? journal_file
+    # The location of the DayOne journal file as determined by
+    # the DayOne plist file stored in +~/Library/Preferences+.
+    # @return [String] the DayONe journal location
+    def auto_journal_location
+      @auto_journal_location ||= File.expand_path(plist_reader['NSNavLastRootDirectory'])
     end
     
     private
@@ -37,14 +52,9 @@ module DayOne
   end
 end
 
-DayOne::dayone_folder = File.join(ENV['HOME'], '.rb-dayone')
-
-unless DayOne::journal_location_exists?
-  puts <<-end
-Error: DayOne journal file has not been located.
-Please set this using the command `dayone --set location
-before continuing.
-  end
-end
+lib_root = File.dirname(__FILE__)
+Dir[File.join(lib_root, "rb-dayone", "*.rb")].each{ |f| require f }
 
-require 'rb-dayone/entry'
+# Default values
+DayOne::dayone_folder = File.join(ENV['HOME'], '.rb-dayone')
+DayOne::plist_reader = DayOne::PlistReader.new

data/lib/rb-dayone/plist_reader.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+class DayOne::PlistReader
+  attr_accessor :path
+  
+  def initialize path=nil
+    @path = path || File.join(ENV['HOME'], 'Library', 'Preferences', 'com.dayoneapp.dayone.plist')
+  end
+  
+  def body
+    if !@body
+      json_string = `plutil -convert json -o - '#{path}'`
+      @body = JSON.parse(json_string)
+    end
+    @body
+  end
+  
+  def method_missing sym, *args
+    if self.body.respond_to? sym
+      self.body.send(sym, *args)
+    else
+      super sym, *args
+    end
+  end
+end

data/rb-dayone.gemspec

@@ -16,13 +16,7 @@ Gem::Specification.new do |s|
   s.bindir = 'bin'
   s.executables << 'dayone'
   s.extra_rdoc_files = ['README.md']
-  s.post_install_message = <<-end
-#{'-'*80}
-Thank you for installing rb-dayone!
-
-To finish setup, run `dayone set location <location>` to specify where your DayOne journal is stored.
-#{'-'*80}
-  end
   
   s.add_runtime_dependency 'builder', '~> 2.0'
+  s.add_runtime_dependency 'commander', '~> 4.1.2'
 end

data/spec/dayone_spec.rb

@@ -0,0 +1,32 @@
+require './spec/spec_helper'
+
+describe DayOne do
+  describe "#journal_location" do
+    
+    before(:each) do
+      DayOne::journal_location = nil
+      DayOne::instance_variable_set('@journal_file',nil)
+    end
+    
+    def location str
+      File.join(File.dirname(__FILE__),"locations", "location-#{str}")
+    end
+    
+    it "should return the value given by the +location+ file" do
+      DayOne::dayone_folder = location('specified')
+      DayOne::journal_location.should == 'sample location'
+    end
+    
+    it "should return a default value when +location+ is 'auto'" do
+      DayOne.plist_reader = {'NSNavLastRootDirectory' => 'foo'}
+      DayOne::dayone_folder = location('auto')
+      DayOne::journal_location.should == File.expand_path('foo')
+    end
+    
+    it "should return a default value if +location+ doesn't exist" do
+      DayOne.plist_reader = {'NSNavLastRootDirectory' => 'foo'}
+      DayOne::dayone_folder = location('unspecified')
+      DayOne::journal_location.should == File.expand_path('foo')
+    end
+  end
+end

data/spec/entry_spec.rb

@@ -2,9 +2,6 @@ require './spec/spec_helper'
 require 'fileutils'
 
 describe DayOne::Entry do
-  
-  let(:entry){ DayOne::Entry.new }
-  
   after :all do
     Dir['spec/entries/*.doentry'].each{ |f| FileUtils.rm(f) }
     FileUtils.rmdir('spec/entries')
@@ -12,7 +9,7 @@ describe DayOne::Entry do
   
   describe "#to_xml" do
     it "should give a default entry" do
-      e = entry.to_xml
+      e = subject.to_xml
       e.should match %r|<key>Entry Text</key>\s*<string></string>|
       e.should match %r|<key>Starred</key>\s*<false/>|
     end
@@ -34,7 +31,7 @@ describe DayOne::Entry do
       DayOne::journal_location = 'spec'
       FileUtils::mkdir_p 'spec/entries'
       
-      e = entry
+      e = subject
       e.entry_text = "Hello, world!"
       e.create!
       

data/spec/locations/location-auto/location

@@ -0,0 +1 @@
+auto

data/spec/locations/location-specified/location

@@ -0,0 +1 @@
+sample location

data/spec/plist_reader_spec.rb

@@ -0,0 +1,20 @@
+require './spec/spec_helper'
+
+describe DayOne::PlistReader do
+  describe "#initialize" do
+    it "should default to the normal preference file" do
+      File.should exist(subject.path)
+    end
+  end
+  
+  describe "#body" do
+    it "should give us the location of the DayOne journal file" do
+      subject.should have_key('NSNavLastRootDirectory')
+    end
+    
+    it "should correctly parse binary plists" do
+      reader = DayOne::PlistReader.new(File.join(File.dirname(__FILE__),'sample.plist'))
+      reader['foo'].should == 'bar'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1 @@
 require './lib/rb-dayone'
-require './lib/rb-dayone/entry'

data/version.txt

@@ -1 +1 @@
-0.1.7
+0.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb-dayone
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.2
 description: Create [DayOne](http://www.dayoneapp.com) journal entries simply and
   easily in ruby. Currently only supports text entries, image entries to come.
 email: janyves.ruzicka@gmail.com
@@ -41,25 +57,21 @@ files:
 - History.rdoc
 - lib/rb-dayone.rb
 - lib/rb-dayone/entry.rb
+- lib/rb-dayone/plist_reader.rb
 - Manifest
 - rb-dayone.gemspec
 - README.md
+- spec/dayone_spec.rb
 - spec/entry_spec.rb
+- spec/locations/location-auto/location
+- spec/locations/location-specified/location
 - spec/spec_helper.rb
+- spec/plist_reader_spec.rb
+- spec/sample.plist
 - version.txt
 homepage: https://github.com/jyruzicka/rb-dayone
 licenses: []
-post_install_message: ! '--------------------------------------------------------------------------------
-
-  Thank you for installing rb-dayone!
-
-
-  To finish setup, run `dayone set location <location>` to specify where your DayOne
-  journal is stored.
-
-  --------------------------------------------------------------------------------
-
-'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib