rb-dayone 0.4.1 → 0.6.0

data/lib/rb-dayone/entry.rb

@@ -1,6 +1,3 @@
-require 'libxml'
-require 'fileutils'
-
 # A text-only journal entry for DayOne.
 class DayOne::Entry
 
@@ -21,6 +18,12 @@ class DayOne::Entry
 
   # Path to the entry image
   attr_accessor :image
+
+  # An entry's tags
+  attr_accessor :tags
+
+  # The location of the entry.
+  attr_accessor :location
   
   # 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"]
@@ -35,6 +38,8 @@ class DayOne::Entry
     @starred = false
     @entry_text = entry_text
     @saved = false
+    @tags = []
+    @location = DayOne::Location.new hsh.delete(:location)
     
     hsh.each do |k,v|
       setter = "#{k}="
@@ -48,6 +53,26 @@ class DayOne::Entry
   def uuid
     @uuid ||= `uuidgen`.gsub('-','').strip
   end
+
+  # Add a tag to the entry
+  # @param [String] str The string tag to add to the list.
+  def tag str
+    @tags << str.to_s
+  end
+
+  # Searches the entry text for tags (#foo) and adds
+  # them to the entry's tags. Will avoid adding punctuation
+  # to the end of the tag (so e.g. '#foo.' will detect as #foo).
+  def add_tags_from_entry_text
+    @entry_text.scan(/(?<=[ \t])#(\S+)/) do |m|
+      m = m.shift
+      if m[-1] !~ /[a-zA-Z0-9]/
+        # Then the last char is a symbol or punctuation, and we should wipe it
+        m = m[0..-2]
+      end
+      tag m
+    end
+  end
   
   # The same as calling Entry#saved
   def saved?
@@ -67,6 +92,17 @@ class DayOne::Entry
         
         builder.key 'Entry Text'
         builder.string entry_text
+
+        if !tags.empty?
+          builder.key 'Tags'
+          builder.array do
+            tags.each do |t|
+              builder.string t
+            end
+          end
+        end
+
+        location.to_xml(builder) unless location.left_blank?
         
         builder.key 'Starred'
         if starred
@@ -100,14 +136,8 @@ class DayOne::Entry
   
   # Check to make sure that we output valid xml
   def xml_valid?
-    LibXML::XML::Error.set_handler(&LibXML::XML::Error::QUIET_HANDLER)
-    begin
-      LibXML::XML::Parser.string(to_xml).parse
-    rescue LibXML::XML::Error
-      return false
-    else
-      return true
-    end
+    doc = Nokogiri::XML(to_xml)
+    doc.errors.empty?
   end
 
   # Assign an image to the entry

data/lib/rb-dayone/entry_importer.rb

@@ -1,5 +1,3 @@
-require 'libxml'
-
 # Imports DayOne entries from XML files or plain text
 class DayOne::EntryImporter
   
@@ -12,16 +10,16 @@ class DayOne::EntryImporter
   # Create a new entry based on a string. To import from a file,
   # use EntryImporter.from_file.
   # @param [String] data The raw data for the importer to process
-  def initialize data
+  # @param [String] file The file this data came from. Defaults to +nil+.
+  def initialize data, file=nil
     @data = data
+    @file = file
   end
   
   # Create a new entry from a file
   # @param [String] file The file to import
   def self.from_file file
-    ei = new(File.read(file))
-    ei.file = file
-    ei
+    new(File.read(file), file)
   end
   
   # Access entry data by key
@@ -34,35 +32,7 @@ class DayOne::EntryImporter
   # Generate and return the data contained within the doentry file, as a hash
   # @return [Hash] the processed data
   def processed_data
-    if !@processed_data
-      @processed_data = {}
-      LibXML::XML::Error.set_handler(&LibXML::XML::Error::QUIET_HANDLER)
-      
-      begin
-        document = LibXML::XML::Parser.string(data).parse
-        key = nil
-        
-        document.find('//plist/dict/*').each do |elem|
-          case elem.name
-          when 'key'
-            key = elem.content
-          when 'date'
-            if elem.content =~ /(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)Z/
-              @processed_data[key] = Time.new($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i)
-            end
-          when 'true'
-            @processed_data[key] = true
-          when 'false'
-            @processed_data[key] = false
-          else
-            @processed_data[key] = elem.content
-          end
-        end
-      rescue LibXML::XML::Error
-        $stderr.puts "Error parsing #{file ? "file #{file}" : "data"}. Skipping."
-      end
-    end
-    @processed_data
+    @processed_data ||= process_dict(Nokogiri::XML(data).xpath('//plist/dict').first)
   end
   
   # Generate an entry from this importer
@@ -72,7 +42,52 @@ class DayOne::EntryImporter
       self['Entry Text'],
       starred: self['Starred'],
       creation_date: self['Creation Date'],
-      saved: true
+      saved: true,
+      tags: self['Tags']||[],
+      location: self['Location']||{}
     )
   end
+
+  private
+
+  # Process an XML tag. Returns a the value of the tag as a ruby value.
+  # @param [Nokogiri::XML::Element] element The element to process
+  # @return The values contained within the element
+  def process_value element
+    case element.name
+    when 'date'
+      if element.content =~ /(\d+)-(\d+)-(\d+)T(\d+):(\d+):(\d+)Z/
+          Time.utc($1.to_i, $2.to_i, $3.to_i, $4.to_i, $5.to_i, $6.to_i)
+        end
+    when 'string'
+      element.content
+    when 'real'
+      element.content.to_f
+    when 'true'
+      true
+    when 'false'
+      false
+    when 'array'
+      element.xpath('*').map{ |e| process_value(e) }
+    when 'dict'
+      process_dict(element)
+    end
+  end
+
+  # Process an XML dict element. Returns a hash of values
+  # @param [Nokogiri::XML::Element] element The dictionary element to process
+  # @return [Hash] The values contained within the element
+  def process_dict dict
+    processed_data = {}
+    key = nil
+
+    dict.xpath('*').each do |elem|
+      if elem.name == 'key'
+        key = elem.content
+      else
+        processed_data[key] = process_value(elem)
+      end
+    end
+    processed_data
+  end
 end

data/lib/rb-dayone/location.rb

@@ -0,0 +1,74 @@
+# This represents a location as recognised by DayOne.app
+class DayOne::Location
+
+  # An array of components that make up the location
+  STRING_COMPONENTS = [:country, :locality, :administrative_area, :place_name]
+  REAL_COMPONENTS = [:latitude, :longitude]
+  ALL_COMPONENTS = STRING_COMPONENTS + REAL_COMPONENTS
+
+  # These are all instance variables
+  attr_accessor *ALL_COMPONENTS
+
+  # Initialize the location with a hash of values.
+  # @param [Hash] hsh The values to be assigned on initalization
+  def initialize hsh=nil
+    if hsh
+      hsh.each do |k,v|
+        setter = "#{symbol(k)}="
+        send(setter,v) if respond_to?(setter)
+      end
+    end
+  end
+
+  # Has this location been left blank?
+  # @return [bool] If any value in this instance is not nil or blank
+  def left_blank?
+    STRING_COMPONENTS.all?{ |s| [nil,''].include?(send(s)) } &&
+    REAL_COMPONENTS.all?{ |s| [nil,0.0].include?(send(s)) }
+  end
+    
+  # Converts the location to xml. A +builder+ must be supplied, and
+  # this method will run operations on the builder and return
+  # a boolean indicating its success.
+  # @param [Builder] builder The builder this object will be put in
+  # @return [bool] The success of the operation
+  def to_xml builder
+    builder.key 'Location'
+    builder.dict do
+      STRING_COMPONENTS.each do |s|
+        builder.key xml_string(s)
+        builder.string send(s)
+      end
+
+      REAL_COMPONENTS.each do |s|
+        builder.key xml_string(s)
+        builder.real send(s)
+      end
+    end
+    true
+  end
+
+  private
+
+  # Gives the XML string for a particular symbol
+  # @param [Symbol] symbol The symbol to find the XML string for
+  # @return [String] The string for this symbol
+  def xml_string symbol
+    if symbol.is_a? String
+      symbol
+    else
+      symbol.to_s.gsub('_',' ').gsub(/\b./, &:upcase)
+    end
+  end
+
+  # Gives the symbol for a particular XML string
+  # @param [String] string The XML string to find the symbol for
+  # @return [Symbol] The symbol for this symbol
+  def symbol xml_string
+    if xml_string.is_a? Symbol
+      xml_string
+    else
+      xml_string.downcase.gsub(' ','_').intern
+    end
+  end
+end

data/lib/rb-dayone/plist_reader.rb

@@ -1,5 +1,3 @@
-require 'nokogiri'
-
 # The PListReader is a class that reads PLists.
 # It is used to read the DayOne preferences PList.
 class DayOne::PlistReader
@@ -59,7 +57,7 @@ class DayOne::PlistReader
   # @return [String] the path to the current DayOne journal location
   def journal_location
     key('JournalPackageURL') || # First, try the 1.7 location...
-    key('NSNavLastRootDirectory')
+    key('NSNavLastRootDirectory') # Then try the pre-1.7 location
   end
   
   # This allows us to access the body's method as well as the reader's.

data/lib/rb-dayone/search.rb

@@ -8,20 +8,27 @@ class DayOne::Search
   
   # The entry must be starred
   attr_accessor :starred
+
+  # The entry must have this tag
+  attr_accessor :tag
   
-  # Initialize the search. Currently you can only search by entry text and starred status,
-  # but both of these can be passed in via hash.
+  # Initialize the search. Currently you can search by:
+  # * entry text
+  # * starred status
+  # * tag
+  # 
+  # These can be passed in via hash.
   # @param [Hash] hash a hash of search criteria, including:
-  #   * +entry_text+: Text that the entry must include
-  #   * +starred+: whether the entry is starred or not
+  #   * +:entry_text+ -  Text that the entry must include
+  #   * +:starred+ - whether the entry is starred or not
+  #   * +:tag+ - a tag that the entry must have
   def initialize hash={}
-    @entry_text = ''
     hash.each do |k,v|
       setter = "#{k}="
       self.send(setter, v) if self.respond_to?(setter)
     end
   end
-  
+
   # Fetch the results by searching. Uses a cached version of the DayOne database.
   # @return [Array] all entries matching your results
   def results
@@ -29,8 +36,9 @@ class DayOne::Search
       @results = []
       working_results = cache
 
-      working_results = working_results.select{ |e| e.entry_text.include? entry_text } unless entry_text == ''
+      working_results = working_results.select{ |e| e.entry_text.include? entry_text } unless entry_text.nil?
       working_results = working_results.select{ |e| e.starred == starred } unless starred.nil?
+      working_results = working_results.select{ |e| e.tags.include? tag } unless tag.nil?
       
       @results = working_results
     end

data/rb-dayone.gemspec

@@ -11,27 +11,15 @@ Gem::Specification.new do |s|
   s.email = 'janyves.ruzicka@gmail.com'
   s.homepage = 'https://github.com/jyruzicka/rb-dayone'
   
-  s.files = File.read('Manifest').split("\n")
+  s.files = File.read('Manifest').split("\n").select{ |l| !l.start_with?('#') && l != ''}
   s.require_paths << 'lib'
-  s.bindir = 'bin'
-  s.executables << 'dayone'
   s.extra_rdoc_files = ['README.md']
+
+  s.executables << 'dayone'
+
   
   s.add_runtime_dependency 'builder', '~> 2.0'
   s.add_runtime_dependency 'commander', '~> 4.1.2'
   s.add_runtime_dependency 'libxml-ruby', '~> 2.3.3'
-  
-  s.post_install_message = <<-end
-#{'-'*80}
-Hi there! If you're upgrading from version <= 0.2.0 of this gem, I've been a
-horrid dev and let a few bugs through in my XML building code. In order to fix
-this, you can run `dayone verify` to see if your database needs fixing. If any 
-of the errors are my fault, you should be able to fix them with `dayone
-repair`.
-
-Sorry if this has caused any inconvenience. If you still have trouble repairing
-any of your .doentry files, send me an email and I'll see what I can do to
-help.
-#{'-'*80}
-  end
+  s.add_runtime_dependency 'nokogiri', '~> 1.5.0'
 end

data/version.txt

@@ -1 +1 @@
-0.4.1
+0.6.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb-dayone
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2013-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70362709355040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +21,10 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
+  version_requirements: *70362709355040
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70362709354080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,15 +32,10 @@ dependencies:
         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
+  version_requirements: *70362709354080
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70362709352740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -53,12 +43,18 @@ dependencies:
         version: 2.3.3
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *70362709352740
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70362709350740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.3
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70362709350740
 description: Create or search [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
@@ -68,42 +64,24 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- .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/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
 homepage: https://github.com/jyruzicka/rb-dayone
 licenses: []
-post_install_message: ! "--------------------------------------------------------------------------------\nHi
-  there! If you're upgrading from version <= 0.2.0 of this gem, I've been a\nhorrid
-  dev and let a few bugs through in my XML building code. In order to fix\nthis, you
-  can run `dayone verify` to see if your database needs fixing. If any \nof the errors
-  are my fault, you should be able to fix them with `dayone\nrepair`.\n\nSorry if
-  this has caused any inconvenience. If you still have trouble repairing\nany of your
-  .doentry files, send me an email and I'll see what I can do to\nhelp.\n--------------------------------------------------------------------------------\n"
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Create DayOne journal entries in ruby.
 test_files: []
-has_rdoc: