rb-dayone 0.4.1 → 0.6.0

data/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+.ruby-version
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Rarity artefacts
+.rarity

data/Gemfile

@@ -2,5 +2,4 @@ source :rubygems
 
 gem 'builder', '~> 2.0'
 gem 'commander', '~> 4.1.2'
-gem 'libxml-ruby', '~> 2.3.3'
 gem 'nokogiri', '~> 1.5.0'

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    commander (4.1.2)
+      highline (~> 1.6.11)
+    highline (1.6.13)
+    nokogiri (1.5.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  builder (~> 2.0)
+  commander (~> 4.1.2)
+  nokogiri (~> 1.5.0)

data/Manifest

@@ -1,28 +1,22 @@
+# INCLUDE lib/**/*
+# INCLUDE bin/*
+# INCLUDE *
+# EXCLUDE **/.DS_Store
+# EXCLUDE .rarity
+# EXCLUDE .yardopts
+
+.gitignore
 bin/dayone
 Gemfile
-History.rdoc
+Gemfile.lock
 lib/rb-dayone.rb
 lib/rb-dayone/entry.rb
 lib/rb-dayone/entry_importer.rb
+lib/rb-dayone/location.rb
 lib/rb-dayone/plist_reader.rb
 lib/rb-dayone/search.rb
 Manifest
 Rakefile
 rb-dayone.gemspec
 README.md
-spec/data/entries/748AD5D252F44149920485B0CEA478E3.doentry
-spec/data/entries/F13723CDFD454481B24312DCD627BFD7.doentry
-spec/data/foo.doentry
-spec/data/locations/location-auto/location
-spec/data/locations/location-specified/location
-spec/data/locations/location-unspecified
-spec/data/sample.doentry
-spec/data/sample.plist
-spec/data/utf.doentry
-spec/dayone_spec.rb
-spec/entry_importer_spec.rb
-spec/entry_spec.rb
-spec/plist_reader_spec.rb
-spec/search_spec.rb
-spec/spec_helper.rb
-version.txt
+version.txt

data/README.md

@@ -1,10 +1,10 @@
 # rb-dayone
 
-A means to create DayOne entries in ruby. Also, my first public ruby gem!
+A means to create DayOne entries in ruby.
 
 ## Examples
 
-You can create an entry pretty simply, by passing in your entry text:
+You can create an entry pretty simply:
 
     e = DayOne::Entry.new "# Hello, world!"
   
@@ -21,58 +21,110 @@ When you're ready to save your entry, just run the `create!` method:
 
     e.create!
 
-Alternatively, run from the command line:
+## Binary
 
-    dayone add --text "#Hello, world" --starred
+Rb-dayone ships with a binary, `dayone`. Run `dayone --help` for instructions on how to use it.
 
-For more information on what you can do from the command line:
+## Install
 
-    dayone --help
+    gem install rb-dayone
 
-### Validating and repairing doentry files ###
+## Author
 
-As of version 0.2.0 of this gem, `rb-dayone` is finally outputting *nice* XML. Before then, it wasn't. You can check if any of your DayOne entries need repairing by running:
+Original author: [Jan-Yves Ruzicka](http://www.1klb.com). Get in touch [via email](mailto:jan@1klb.com).
 
-    dayone validate
+## History
 
-If they do, you might be able to fix them using:
+### 0.6.0 / 2013-01-14
 
-    dayone repair
+* [NEW] Location support
+* [NEW] Re-added the binary with actual functionality.
+* [FIXED] No longer relies on LibXML - all Nokogiri!
+* [FIXED] Imports times correctly as UTC.
 
-If not, let me know, and I'll see what I can do to fix stuff.
+### 0.5.0 / 2013-01-09
 
-## Install
+* [NEW] Added support for tagging entries via `Entry#tag`, `Entry#tags`, and `Entry#add_tags_from_entry_text`.
+* [REMOVED] Got rid of the binary. You can probably make a better library on your own.
 
-    gem install rb-dayone
+## 0.4.1 / 2012-11-14
 
-## Author
+* [FIXED] rb-dayone was looking in the wrong place for preferences
+* [FIXED] new preference files not json-parseable. Swapped to XML/Nokogiri
 
-Original author: [Jan-Yves Ruzicka](http://www.1klb.com) ([@akchizar](http://www.twitter.com/akchizar)). Get in touch [via email](mailto:janyves.ruzicka@gmail.com).
+## 0.4.0 / 2012-10-22
 
-## To do
+* Added image support
 
-* Image support
-* Location support?
+## 0.3.3 / 2012-08-17
+
+* [FIXED] LibXML will now accept UTF-8 characters in journal entries.
+* Added the command "repair" to the dayone binary, which will at least repair *my* damage.
+* Added the command "verify" to the dayone binary, which I at least find helpful.
+* Added a post-install note telling people upgrading from <= 0.2.0 to repair.
+
+## 0.3.2 / 2012-08-16
+
+* Switched from REXML to LibXML-ruby for XML parsing. Now accepts ampersands in entries, as well as UTF-8. Rejoice!
+
+## 0.3.1 / 2012-08-16
+
+* [FIXED] Minor bugfixes
+* [FIXED] REXML will no longer kill the whole program if it can't parse a journal file.
+
+## 0.3.0 / 2012-08-16
+
+* [FIXED] Fixed several bugs in Builder xml output, including:
+  * Output of trailing <target />
+  * Output of malformed DOCTYPE
+* You can now import existing DayOne entries and search them
+
+## 0.2.0 / 2012-08-14
+
+* Now auto-detects DayOne journal location from your plist file
 
-## License
+## 0.1.7 / 2012-08-13
 
-Copyright (c) 2012 Jan-Yves Ruzicka
+* 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.
 
-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:
+## 0.1.6 / 2012-08-13
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+* Updated documentation so YARD would generate nice rdocs
+* dayone binary now uses the Commander gem
+* Now using a Manifest file rather than globbing in whole directories
 
-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.
+## 0.1.5 / 2012-08-12
+
+* [FIXED] Ouch, horrid horrid gemspec and readme. Let's make them prettier.
+
+## 0.1.4 / 2012-08-12
+
+* Added a couple more tests for better coverage
+
+## 0.1.3 / 2012-08-12
+
+* Removed the SimpleXML class, now using the Builder gem
+
+## 0.1.2 / 2012-08-12
+
+* [FIXED] Actual testing on my own system
+
+## 0.1.1 / 2012-08-07
+
+* [FIXED] DayOne constants are now `attr_accessors` - set them yourself if you wish!
+
+## 0.1.0 / 2012-08-06
+
+* Added binary
+* Support for DayOne locations
+* Uploaded to github!
+
+## 0.0.1 / 2012-08-05
+
+* Started development
+
+## To do
+
+* Location support?
+* Switch from using two different XML libraries to one XML library.

data/bin/dayone

@@ -1,152 +1,39 @@
 #!/usr/bin/env ruby
-require 'fileutils'
+require 'rb-dayone'
 require 'commander/import'
+require 'optparse/time'
+require 'time'
 
 program :name, 'dayone'
-program :version, File.read(File.join(File.dirname(__FILE__),'../version.txt'))
-program :description, "Command line interface for the rb-dayone gem"
-
-dayone_folder = File.join(ENV['HOME'], '.rb-dayone')
-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 = <<-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
-    when 0
-      puts "location: #{File.read(dayone_location_file)}"
-    when 2
-      key, val = *args
-      case key
-      when 'location'
-        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
-        puts "Key #{key} not recognised"
-        exit 1
-      end
-    else
-      puts c.syntax
-      puts c.summary
-      exit 1
-    end
-  end
-end
-
-command :add do |c|
-  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 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 = DayOne::Entry.new
-
-    needs_stdin_help = !(opts.image || opts.text)
-    if needs_stdin_help
-      entry.entry_text = $stdin.read.strip
+program :version, DayOne::version
+program :description, 'A binary interface for the rb-dayone gem'
+
+command :create do |c|
+  c.syntax = 'create [--starred] [--time=TIME] [--image=IMAGE] [--tags=TAGS] [--autotag] [--quiet] [ENTRYTEXT]'
+  c.description = "Create a DayOne entry. If you don't supply entry text, it will notify you and fetch it from STDIN."
+  c.option '--starred', "Make the entry starred"
+  c.option '--time=TIME', Time, "Set the time the entry was made at. Defaults to now."
+  c.option '--image=IMAGE', String, "Add an image to the entry, specified by the path."
+  c.option '--tags=TAGS', String, "Add tags to the entry. Tags may be comma-separated."
+  c.option '--autotag', "Automatically collects #tags from the entry text and populates the tags field of the entry"
+  c.option '--quiet', "Don't push feedback to STDOUT."
+
+  c.action do |args,opts|
+    e = DayOne::Entry.new
+    e.starred = opts.starred
+    e.creation_date = opts.time || Time.now
+    e.image = opts.image if opts.image
+    e.tags = opts.tags.split(',') if opts.tags
+    if args.empty?
+      puts "Entry text:" unless opts.quiet
+      e.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
+      # puts "Creating entry, "
+      e.entry_text = args.shift
     end
 
-    entry.starred = opts.starred
-    
-    entry.create!
-  end
-end
-
-command :repair do |c|
-  c.syntax = "repair"
-  c.description = "Will repair any damage caused by previous versions of rb-dayone."
-  c.summary = "This command will trawl your DayOne journal archive looking for any malformed DayOne entries created by previous versions of rb-dayone, and will fix them. Currently it fixed malformed doctype declarations and trailing target tags."
-
-  c.action do |args, opts|
-    require 'rb-dayone'
-    
-    repairs = {
-      'trailing target' => [
-        /<target\/>\Z/,
-        ''
-      ],
-      'malformed doctype' => [
-        %r|<!DOCTYPE "plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"">|,
-        %|<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">|
-      ]
-    }
-    
-    DayOne.entries.each do |f|
-      contents = File.read(f)
-      modified = []
-      repairs.each do |name, (replace_this, with_this)|
-        if replace_this === contents
-          modified << name
-          contents = contents.gsub(replace_this, with_this)
-        end
-      end
-      
-      unless modified.empty?
-        File.open(f,'w'){ |io| io.puts contents }
-        puts "Repaired file #{f}:"
-        modified.each{ |s| puts "  Fixed #{s}" }
-      end
-    end
-    puts "All files have been repaired!"
-  end
-end
-
-command :validate do |c|
-  c.syntax = "validate"
-  c.description = "Checks through your DayOne database to see if any of your journal entries break XML validation."
-
-  c.action do
-    require 'libxml'
-    require 'rb-dayone'
-    
-    LibXML::XML::Error.set_handler(&LibXML::XML::Error::QUIET_HANDLER)
-    failed_entries = []
-    
-    all_entries = DayOne.entries
-    puts "Checking #{all_entries.size} entr#{all_entries.size == 1 ? 'y' : 'ies'}..."
-    
-    all_entries.each do |f|
-      begin
-        contents = File.read(f)
-        LibXML::XML::Parser.string(contents).parse
-      rescue LibXML::XML::Error
-        failed_entries << f
-      end
-    end
-    
-    if failed_entries.empty?
-      puts "No errors. Everything is OK!"
-    else
-      puts "#{failed_entries.size} error#{failed_entries.size == 1 ? '' : 's'} in validation:"
-      failed_entries.each{ |f| puts "  #{f}" }
-    end
+    e.add_tags_from_entry_text if opts.autotag
+    e.create!
+    puts "Entry created" unless opts.quiet
   end
 end

data/lib/rb-dayone.rb

@@ -1,5 +1,9 @@
 require 'time'
 require 'builder'
+require 'nokogiri'
+require 'fileutils'
+
+lib_root = File.dirname(__FILE__)
 
 # This module contains all classes used in the DayOne gem,
 # as well as some helper methods
@@ -20,19 +24,16 @@ module DayOne
     # will set from the DayOne plist (See +auto_journal_location+).
     # @return [String] the DayOne journal location
     def journal_location
-      if !@journal_location 
-        if File.exists?(journal_file)
-          contents = File.read(journal_file)
-          @journal_location = if contents == 'auto'
-            auto_journal_location
-          else
-            contents
-          end
+      @journal_location ||= if File.exists?(journal_file)
+        contents = File.read(journal_file)
+        if contents == 'auto'
+          auto_journal_location
         else
-          @journal_location = auto_journal_location
+          contents
         end
+      else
+        auto_journal_location
       end
-      @journal_location
     end
     
     # The location of the DayOne journal file as determined by
@@ -47,9 +48,13 @@ module DayOne
     def entries
       Dir[File.join(journal_location, 'entries','*.doentry')]
     end
+
+    def version
+      @version ||= File.read(File.join(File.dirname(__FILE__),'..','version.txt'))
+    end
     
     private
-    
+
     # The journal file location
     # @return [String] the location of the journal file
     def journal_file
@@ -58,7 +63,7 @@ module DayOne
   end
 end
 
-lib_root = File.dirname(__FILE__)
+
 Dir[File.join(lib_root, "rb-dayone", "*.rb")].each{ |f| require f }
 
 # Default values