rb-dayone 0.6.0 → 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: adbfa1eebd1eef8d92dcd87f14c71e94dcbf14a2
+  data.tar.gz: b27c9d5ca865527309979cafe70f77f78963f9e1
+SHA512:
+  metadata.gz: 326fbff745ce8c1bbc6d0dac35fe3bcb050977dfcac2514cba262dd8dd25733fc37babeb3cbda02d36ecfaecf531b7ac0334fbde23adcb1db1d061ef99d5fb99
+  data.tar.gz: c7c4deac6273fa964652bad4fab62113113eacac99731b403e574a448af039ef04c43adc36c79dcb976bf1391e5be093db87f3afdd870c787ed63bd66586e9be

data/Gemfile

@@ -1,5 +1,5 @@
-source :rubygems
+source "https://www.rubygems.org"
 
-gem 'builder', '~> 2.0'
-gem 'commander', '~> 4.1.2'
-gem 'nokogiri', '~> 1.5.0'
+gem "builder", "~> 3.1.0"
+gem "commander", "~> 4.1.2"
+gem "nokogiri", "~> 1.6.0"

data/Gemfile.lock

@@ -1,16 +1,18 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://www.rubygems.org/
   specs:
-    builder (2.1.2)
-    commander (4.1.2)
+    builder (3.1.4)
+    commander (4.1.5)
       highline (~> 1.6.11)
-    highline (1.6.13)
-    nokogiri (1.5.6)
+    highline (1.6.20)
+    mini_portile (0.5.2)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  builder (~> 2.0)
+  builder (~> 3.1.0)
   commander (~> 4.1.2)
-  nokogiri (~> 1.5.0)
+  nokogiri (~> 1.6.0)

data/Manifest

@@ -15,6 +15,11 @@ lib/rb-dayone/entry_importer.rb
 lib/rb-dayone/location.rb
 lib/rb-dayone/plist_reader.rb
 lib/rb-dayone/search.rb
+lib/rb-dayone/search_engine.rb
+lib/rb-dayone/search_engines/creation_date_search.rb
+lib/rb-dayone/search_engines/entry_text_search.rb
+lib/rb-dayone/search_engines/starred_search.rb
+lib/rb-dayone/search_engines/tag_search.rb
 Manifest
 Rakefile
 rb-dayone.gemspec

data/README.md

@@ -21,6 +21,32 @@ When you're ready to save your entry, just run the `create!` method:
 
     e.create!
 
+### Searching
+
+You can now search your DayOne archives. Use the `DayOne::Search` object to start a search:
+
+    s = DayOne::Search.new do
+        entry_text.include "Foo" # Entry must have "foo" in the entry text
+        entry_text.exclude "Bar" # Entry cannot have "bar" in the entry text
+        tag.include "baz"        # Entry must be tagged "baz"
+        tag.exclude "caz"        # Entry cannot be tagged "caz"
+        starred.is true          # Entry is starred
+        starred.is false         # Entry is not starred
+        creation_date.after t    # Entry created after +t+
+        creation_date.before t   # Entry created before +t+
+    end
+
+    s.results # Retrieve an array of search results
+
+Most of these methods can be combined, e.g.:
+
+    s = DayOne::Search.new do
+        entry_text.include "Eggs"
+        entry_text.include "Milk"
+    end
+
+This will only find posts that contain both the words "Eggs" and "Milk" in the entry text.
+
 ## Binary
 
 Rb-dayone ships with a binary, `dayone`. Run `dayone --help` for instructions on how to use it.
@@ -35,6 +61,23 @@ Original author: [Jan-Yves Ruzicka](http://www.1klb.com). Get in touch [via emai
 
 ## History
 
+### 0.7.1 / 2014-01-15
+
+* [NEW] Save entries with `Entry#save!`, delete them with `Entry#delete!`
+* [NEW] Remove entry tags with `Entry#remove_tag`.
+* [FIXED] Will now recognise hashtags at the start of lines.
+* [FIXED] EntryImporter now adds the UUID to generated Entries
+* [FIXED] The `Entry#auto_tag` will now only accept tags with letters, numbers and underscores in them.
+
+### 0.7.0 / 2014-01-14
+
+* [NEW] Use `Entry#created_at` for `Entry#creation_date`, `Entry#auto_tag` for `Entry#add_tags_from_entry_text`
+* [NEW] Search!
+
+### 0.6.1 / 2014-01-13
+
+* [FIXED] Updated gem versions
+
 ### 0.6.0 / 2013-01-14
 
 * [NEW] Location support

data/lib/rb-dayone.rb

@@ -38,7 +38,7 @@ module DayOne
     
     # The location of the DayOne journal file as determined by
     # the DayOne plist file stored in +~/Library/Preferences+.
-    # @return [String] the DayONe journal location
+    # @return [String] the DayOne journal location
     def auto_journal_location
       @auto_journal_location ||= File.expand_path(plist_reader.journal_location)
     end
@@ -64,7 +64,8 @@ module DayOne
 end
 
 
-Dir[File.join(lib_root, "rb-dayone", "*.rb")].each{ |f| require f }
+Dir[File.join(lib_root, "rb-dayone/*.rb")].each{ |f| require f }
+Dir[File.join(lib_root, "rb-dayone/search_engines/*.rb")].each{ |f| require f }
 
 # Default values
 DayOne::dayone_folder = File.join(ENV['HOME'], '.rb-dayone')

data/lib/rb-dayone/entry.rb

@@ -6,6 +6,8 @@ class DayOne::Entry
 
   # The date of the journal entry
   attr_accessor :creation_date
+  alias_method :created_at, :creation_date
+  alias_method :created_at=, :creation_date=
   
   # The journal entry's body text
   attr_accessor :entry_text
@@ -24,6 +26,10 @@ class DayOne::Entry
 
   # The location of the entry.
   attr_accessor :location
+
+  # The UUID of the entry. Auto-generated if it doesn't already exist, this
+  # shouldn't be manually set.
+  attr_accessor :uuid
   
   # 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"]
@@ -54,27 +60,34 @@ class DayOne::Entry
     @uuid ||= `uuidgen`.gsub('-','').strip
   end
 
+  # The file where this entry should/will be saved
+  def file
+    @file ||= File.join(DayOne::journal_location,'entries',"#{uuid}.doentry")
+  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).
+  alias_method :add_tag, :tag
+
+  # Remove a tag from the entry
+  def remove_tag str
+    @tags.delete(str)
+  end
+
+  # Searches the entry text for tags (#foo) and adds them to the entry's tags.
+  # Only recognises letters, numbers and underscores in tags.
   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
+    @entry_text.scan(/(?<=[ \t\n])#([a-zA-Z0-9_]+)/){ |m| tag m.shift }
   end
+
+  alias_method :auto_tag, :add_tags_from_entry_text
   
-  # The same as calling Entry#saved
+  # The same as calling Entry#saved. Tells you if this entry has been saved to
+  # file yet.
   def saved?
     saved
   end
@@ -124,8 +137,7 @@ class DayOne::Entry
   # @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 }
+    File.open(self.file,'w'){ |io| io << xml }
     if image
       new_image_path = File.join(DayOne::journal_location, 'photos', "#{uuid}.jpg")
       FileUtils.cp(image, new_image_path)
@@ -133,6 +145,15 @@ class DayOne::Entry
     end
     return true
   end
+
+  alias_method :save!, :create!
+
+  # Deletes the .doentry file of this entry. This will remove the entry from
+  # your database, although you can reinstate it by calling +#save!+ on this
+  # object.
+  def delete!
+    FileUtils::rm self.file
+  end
   
   # Check to make sure that we output valid xml
   def xml_valid?

data/lib/rb-dayone/entry_importer.rb

@@ -44,21 +44,22 @@ class DayOne::EntryImporter
       creation_date: self['Creation Date'],
       saved: true,
       tags: self['Tags']||[],
-      location: self['Location']||{}
+      location: self['Location']||{},
+      uuid: self["UUID"]
     )
   end
 
   private
 
+  # TODO Import images
+
   # 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
+      Time.parse(element.content)
     when 'string'
       element.content
     when 'real'

data/lib/rb-dayone/search.rb

@@ -1,46 +1,24 @@
 # A search of the database.
 # Create this object with Search.new. Give it some parameters to search for, then
-# simple use Search#[] to access results.
+# use Search#[] to access results.
 class DayOne::Search
-  
-  # The entry must include this text
-  attr_accessor :entry_text
-  
-  # The entry must be starred
-  attr_accessor :starred
-
-  # The entry must have this tag
-  attr_accessor :tag
-  
-  # 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
-  #   * +:tag+ - a tag that the entry must have
-  def initialize hash={}
-    hash.each do |k,v|
-      setter = "#{k}="
-      self.send(setter, v) if self.respond_to?(setter)
-    end
+    
+  # Initialize the search. Takes a block, which allows
+  # access to an array of +SearchEngine+ subclasses.
+  def initialize &blck
+    instance_eval(&blck) if block_given?
   end
 
-  # Fetch the results by searching. Uses a cached version of the DayOne database.
+  # Fetch the results by searching.
   # @return [Array] all entries matching your results
   def results
     if !@results
-      @results = []
-      working_results = cache
+      # Fetch files + data
+      @results = DayOne::entries.each_with_object({}){ |file, hash| hash[file] = File.read(file) }
 
-      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
+      search_engines = self.active_search_engines
+      @results = @results.select{ |k,v| search_engines.all?{ |se| se.matches?(v) }}
+      @results = @results.map{ |file,data| DayOne::EntryImporter.new(data,file).to_entry }
     end
     @results
   end
@@ -51,17 +29,30 @@ class DayOne::Search
   def [] index
     results[index]
   end
-  
-  private
-  
-  # Caches all journal entries for us. On first running, will load everything
-  # from file. After this, will just refer back to the cache.
-  # @return [Array] an array of DayOne::Entry objects
-  def cache
-    if !@cache
-      entries = File.join(DayOne::journal_location, 'entries', '*.doentry')
-      @cache = Dir[entries].map{ |e| DayOne::EntryImporter::from_file(e).to_entry }
-    end
-    @cache
+
+  # entry_text search engine
+  def entry_text
+    @entry_text ||= DayOne::EntryTextSearch.new
+  end
+
+  # starred search engine
+  def starred
+    @starred ||= DayOne::StarredSearch.new
+  end
+
+  # Tags search engine
+  def tag
+    @tag ||= DayOne::TagSearch.new
+  end
+
+  # Creation date search engine
+  def creation_date
+    @creation_date ||= DayOne::CreationDateSearch.new
+  end
+
+  # Returns an array of search engines which are defined and will actually do
+  # filtering.
+  def active_search_engines
+    [@entry_text, @starred, @tag, @creation_date].compact
   end
 end

data/lib/rb-dayone/search_engine.rb

@@ -0,0 +1,7 @@
+# Abstract superclass for a number of
+# search routines
+class DayOne::SearchEngine
+  def matches? string
+    false
+  end
+end

data/lib/rb-dayone/search_engines/creation_date_search.rb

@@ -0,0 +1,32 @@
+# Searches posts with a given creation date
+class DayOne::CreationDateSearch < DayOne::SearchEngine
+
+  # No-argument initializer, sets default ivars.
+  def initialize
+    @before = nil
+    @after = nil
+  end
+
+  # Post must have occured before a given date
+  def before date
+    @before = date
+  end
+
+  # Post must have occured after a given date
+  def after date
+    @after = date
+  end
+  
+  # Does this search widget match the date value of the given string?
+  # @returns [Boolean] Whether it matches or not
+  def matches? string
+    return true if !(@before || @after)
+
+    t = Time.parse string[%r|<key>Creation Date</key>\s+<date>(.*?)</date>|,1]
+
+    return (
+      !(@before && t >= @before) &&  # NOT (@before defined and event occurs after @before)
+      !(@after  && t <= @after)
+    )
+  end
+end

data/lib/rb-dayone/search_engines/entry_text_search.rb

@@ -0,0 +1,33 @@
+# Searches the entry_text of a post
+class DayOne::EntryTextSearch < DayOne::SearchEngine
+
+  # No-argument initializer, sets default ivars.
+  def initialize
+    @include = []
+    @exclude = []
+  end
+
+  # Posts must contain the following string in their entry text.
+  def include string
+    @include << string
+  end
+
+  # Posts cannot contain the following string in their entry text
+  def exclude string
+    @exclude << string
+  end
+
+  # Does this search widget match the entry text of the given string?
+  # @returns [Boolean] Whether it matches or not
+  def matches? string
+    entry_text = string[%r|<key>Entry Text</key>\s+<string>(.*?)</string>|m,1]
+
+    # Edge case: no entry text
+    return true if entry_text.nil? && @include.empty?
+
+    return (entry_text &&
+      @include.all?{ |s| entry_text.include?(s) } &&
+      @exclude.all?{ |s| !entry_text.include?(s) }
+    )
+  end
+end

data/lib/rb-dayone/search_engines/starred_search.rb

@@ -0,0 +1,30 @@
+# Searches starred or unstarred posts
+class DayOne::StarredSearch < DayOne::SearchEngine
+
+  # No-argument initializer, sets default ivars.
+  def initialize
+    @is = nil
+  end
+
+  # Posts must be starred true or false.
+  def is bool
+    @is = bool
+  end
+
+  # Unset search criterion
+  def unset
+    @is = nil
+  end
+
+  # Does this search widget match the starred value of the given string?
+  # @returns [Boolean] Whether it matches or not
+  def matches? string
+    return true if @is.nil?
+
+    starred_string = string[%r|<key>Starred</key>\s+<(.*)/>|m,1]
+
+    return (starred_string &&
+      (starred_string == "true") == @is
+    )
+  end
+end

data/lib/rb-dayone/search_engines/tag_search.rb

@@ -0,0 +1,38 @@
+# Searches the tags of a post
+class DayOne::TagSearch < DayOne::SearchEngine
+
+  # No-argument initializer, sets default ivars.
+  def initialize
+    @include = []
+    @exclude = []
+  end
+
+  # Posts must have the following tag.
+  def include string
+    @include << to_tag(string)
+  end
+
+  # Posts cannot have the following tag.
+  def exclude string
+    @exclude << to_tag(string)
+  end
+
+  # Does this search widget match the tags of the given string?
+  # @returns [Boolean] Whether it matches or not
+  def matches? string
+    tag_string = string[%r|<key>Tags</key>\s+<array>(.*?)</array>|m,1]
+
+    # Edge case: no tags
+    return true if @include.empty? && tag_string.nil?
+
+    return (tag_string &&
+      @include.all?{ |s| tag_string.include?(s) } &&
+      @exclude.all?{ |s| !tag_string.include?(s) }
+    )
+  end
+
+  private
+  def to_tag s
+    "<string>#{s}</string>"
+  end
+end

data/rb-dayone.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.version = File.read('version.txt')
   
   s.summary = "Create DayOne journal entries in ruby."
-  s.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."
+  s.description = "Create or search [DayOne](http://www.dayoneapp.com) journal entries simply and easily in ruby."
   
   s.author = 'Jan-Yves Ruzicka'
   s.email = 'janyves.ruzicka@gmail.com'
@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.executables << 'dayone'
 
   
-  s.add_runtime_dependency 'builder', '~> 2.0'
+  s.add_runtime_dependency 'builder', '~> 3.1.0'
   s.add_runtime_dependency 'commander', '~> 4.1.2'
-  s.add_runtime_dependency 'libxml-ruby', '~> 2.3.3'
-  s.add_runtime_dependency 'nokogiri', '~> 1.5.0'
+  s.add_runtime_dependency 'libxml-ruby', '~> 2.7.0'
+  s.add_runtime_dependency 'nokogiri', '~> 1.6.0'
 end

data/version.txt

@@ -1 +1 @@
-0.6.0
+0.7.1

metadata

@@ -1,62 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: rb-dayone
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 0.7.1
 platform: ruby
 authors:
 - Jan-Yves Ruzicka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-09 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70362709355040 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70362709355040
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &70362709354080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70362709354080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.2
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &70362709352740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.3
+        version: 2.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *70362709352740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70362709350740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70362709350740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
 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.
+  and easily in ruby.
 email: janyves.ruzicka@gmail.com
 executables:
 - dayone
@@ -74,6 +85,11 @@ files:
 - lib/rb-dayone/location.rb
 - lib/rb-dayone/plist_reader.rb
 - lib/rb-dayone/search.rb
+- lib/rb-dayone/search_engine.rb
+- lib/rb-dayone/search_engines/creation_date_search.rb
+- lib/rb-dayone/search_engines/entry_text_search.rb
+- lib/rb-dayone/search_engines/starred_search.rb
+- lib/rb-dayone/search_engines/tag_search.rb
 - Manifest
 - Rakefile
 - rb-dayone.gemspec
@@ -81,27 +97,26 @@ files:
 - version.txt
 homepage: https://github.com/jyruzicka/rb-dayone
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.1.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Create DayOne journal entries in ruby.
 test_files: []