rb-dayone 0.1.5 → 0.1.6

data/Gemfile

@@ -1,3 +1,4 @@
 source :rubygems
 
-gem 'builder', '~> 2.0'
+gem 'builder', '~> 2.0'
+gem 'commander', '~> 4.1.2'

data/{History.txt → History.rdoc}

@@ -1,3 +1,9 @@
+== 0.1.6 / 2012-08-13
+
+* 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
+
 == 0.1.5 / 2012-08-12
 
 * [FIXED] Ouch, horrid horrid gemspec and readme. Let's make them prettier.

data/Manifest

@@ -0,0 +1,11 @@
+bin/dayone
+Gemfile
+History.rdoc
+lib/rb-dayone.rb
+lib/rb-dayone/entry.rb
+Manifest
+rb-dayone.gemspec
+README.md
+spec/entry_spec.rb
+spec/spec_helper.rb
+version.txt

data/bin/dayone

@@ -1,34 +1,38 @@
 #!/usr/bin/env ruby
 require 'fileutils'
+require 'commander/import'
 
-USAGE = <<-end
-Usage:
-dayone --set location <PATH>
-end
+program :name, 'dayone'
+program :version, File.read(File.join(File.dirname(__FILE__),'../version.txt'))
+program :description, "Command line interface for the rb-dayone gem"
 
-def usage
-  puts USAGE
-  exit 1
-end
+dayone_folder = File.join(ENV['HOME'], '.rb-dayone')
+dayone_location_file = File.join(dayone_folder, 'location')
 
-# Put your code here
-case ARGV[0]
-when '--set'
-  case ARGV[1]
-  when 'location'
-    # Make sure location store folder exists
-    dayone_folder = File.join(ENV['HOME'], '.rb-dayone')
-    FileUtils::mkdir_p dayone_folder
-    
-    # Put our location in it
-    new_dayone_location = File.expand_path(ARGV[2])
-    File.open(File.join(dayone_folder, 'location'),'w'){ |io| io.puts new_dayone_location }
-    
-    # Let the user know
-    puts "DayOne journal now located at: #{new_dayone_location}"
-  else
-    usage
+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.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 = 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
-else
-  usage
 end

data/lib/rb-dayone/entry.rb

@@ -0,0 +1,77 @@
+# A text-only journal entry for DayOne.
+class DayOne::Entry
+
+  # The date of the journal entry
+  attr_accessor :creation_date
+  
+  # The journal entry's body text
+  attr_accessor :entry_text
+  
+  # Whether the entry has been starred
+  attr_accessor :starred
+  
+  # The PList doctype, used for XML export
+  DOCTYPE = 'plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"'
+  
+  # Initialise a journal entry, ready for inclusion into your journal
+  # @param [String] entry_text the body text of the journal entry
+  # @param [Hash] hsh a hash of options - allowed keys include `:creation_date`, `:entry_text` and `:starred`, others are ignored
+  # @return [DayOne::Entry] the journal entry
+  def initialize entry_text='', hsh={}
+    # Some defaults
+    @creation_date = Time.now
+    @starred = false
+    @entry_text = entry_text
+    
+    hsh.each do |k,v|
+      setter = "#{k}="
+      self.send(setter,v) if self.respond_to? setter
+    end
+  end
+  
+  # Generate (or retrieve, if previously generatred) a UUID
+  # for this entry.
+  # @return [String] the entry's UUID
+  def uuid
+    @uuid ||= `uuidgen`.gsub('-','').strip
+  end
+  
+  # Convert an entry to XML.
+  # @return [String] the entry as XML
+  def to_xml
+    builder = Builder::XmlMarkup.new
+    builder.instruct!                     # Basic xml tag
+    builder.declare! :DOCTYPE, DOCTYPE   # PList doctype
+    builder.plist(version:1.0) do
+      builder.dict do
+        builder.key 'Creation Date'
+        builder.date creation_date.utc.iso8601
+        
+        builder.key 'Entry Text'
+        builder.string entry_text
+        
+        builder.key 'Starred'
+        if starred
+          builder.true
+        else
+          builder.false
+        end
+        
+        builder.key 'UUID'
+        builder.string uuid
+      end
+    end
+    builder.target
+  end
+  
+  # Create a .doentry file with this entry.
+  # This uses the #to_xml method to generate
+  # the entry proper.
+  # @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 }
+    return true
+  end
+end

data/lib/rb-dayone.rb

@@ -0,0 +1,48 @@
+require 'time'
+require 'builder'
+
+# This module contains all classes used in the DayOne gem,
+# as well as some helper methods
+module DayOne
+  class << self
+    # This is where all DayOne-relevant information is stored.
+    # Set by default to ~/.rb-dayone
+    attr_accessor :dayone_folder
+    
+    # The location of the journal file
+    attr_accessor :journal_location
+  
+    # 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.
+    def journal_location
+      @journal_location ||= File.read(journal_file).strip
+    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
+    end
+    
+    private
+    
+    # The journal file location
+    # @return [String] the location of the journal file
+    def journal_file
+      @journal_file ||= File.join(dayone_folder, 'location')
+    end
+  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

data/rb-dayone.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rb-dayone"
+  s.version = File.read('version.txt')
+  
+  s.summary = "Create DayOne journal entries in ruby."
+  s.description = "Create [DayOne](http://www.dayoneapp.com) journal entries simply and easily in ruby. Currently only supports text entries, image entries to come."
+  
+  s.author = 'Jan-Yves Ruzicka'
+  s.email = 'janyves.ruzicka@gmail.com'
+  s.homepage = 'https://github.com/jyruzicka/rb-dayone'
+  
+  s.files = File.read('Manifest').split("\n")
+  s.require_paths << 'lib'
+  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'
+end

data/spec/entry_spec.rb

@@ -5,8 +5,9 @@ describe DayOne::Entry do
   
   let(:entry){ DayOne::Entry.new }
   
-  after do
+  after :all do
     Dir['spec/entries/*.doentry'].each{ |f| FileUtils.rm(f) }
+    FileUtils.rm('spec/entries')
   end
   
   describe "#to_xml" do

data/version.txt

@@ -0,0 +1 @@
+0.1.6

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb-dayone
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-12 00:00:00.000000000 Z
+date: 2012-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -38,12 +38,15 @@ extra_rdoc_files:
 files:
 - bin/dayone
 - Gemfile
-- Gemfile.lock
-- History.txt
-- Rakefile
+- History.rdoc
+- lib/rb-dayone.rb
+- lib/rb-dayone/entry.rb
+- Manifest
+- rb-dayone.gemspec
 - README.md
 - spec/entry_spec.rb
 - spec/spec_helper.rb
+- version.txt
 homepage: https://github.com/jyruzicka/rb-dayone
 licenses: []
 post_install_message: ! '--------------------------------------------------------------------------------
@@ -80,3 +83,4 @@ signing_key:
 specification_version: 3
 summary: Create DayOne journal entries in ruby.
 test_files: []
+has_rdoc: 

data/Gemfile.lock

@@ -1,10 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    builder (2.1.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  builder (~> 2.0)

data/Rakefile

@@ -1,21 +0,0 @@
-gem_title = 'rb-dayone'
-
-task :build do
-  specfile = "#{gem_title}.gemspec"
-  puts `gem build '#{specfile}'`
-  
-  gem_file = Dir["#{gem_title}-*.gem"]
-  gem_file.each do |f|
-    puts `mv '#{f}' pkg`
-  end
-end
-
-task :install do
-  pkg = Dir['pkg/*.gem'].sort[-1]
-  puts `gem install #{pkg}`
-end
-
-task :go => [:build, :install] do
-end
-
-task :default => :go