yard 0.5.1 → 0.5.2

data/ChangeLog

@@ -1,5 +1,18 @@
+2009-12-16  Loren Segal <lsegal@soen.ca>
+
+  * ChangeLog, lib/yard.rb, yard.gemspec: Bump version to 0.5.2
+
+  * lib/yard/cli/yri.rb, lib/yard/core_ext/file.rb, lib/yard/registry_store.rb,
+  lib/yard/serializers/file_system_serializer.rb, spec/core_ext/file_spec.rb:
+  Ensure '~/.yard' path is created before writing certain config files.  - Adds
+  File.open! to ensure path exists before writing file  Closes gh-57
+
+  * lib/yard/registry_store.rb: Return true/false in RegistryStore#load!
+
 2009-12-15  Loren Segal <lsegal@soen.ca>
 
+  * docs/WhatsNew.md: Forgot to add version number for changes
+
   * ChangeLog, README.md, lib/yard.rb, yard.gemspec: Bump version to 0.5.1
 
   * docs/WhatsNew.md: Update What's New document

data/lib/yard.rb

@@ -1,5 +1,5 @@
 module YARD
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
   ROOT = File.dirname(__FILE__)
   TEMPLATE_ROOT = File.join(File.dirname(__FILE__), '..', 'templates')
   CONFIG_DIR = File.expand_path('~/.yard')

data/lib/yard/cli/yardoc.rb

@@ -166,14 +166,14 @@ module YARD
         Gem.source_index.find_name('').each do |spec|
           reload = true
           dir = Registry.yardoc_file_for_gem(spec.name)
-          next unless dir
-          if File.directory?(dir) && !rebuild
+          if dir && File.directory?(dir) && !rebuild
             log.debug "#{spec.name} index already exists at '#{dir}'"
           else
-            Dir.chdir(spec.full_gem_path)
-            log.info "Building yardoc index for gem: #{spec.full_name}"
             yfile = Registry.yardoc_file_for_gem(spec.name, ">= 0", true)
+            next unless yfile
             Registry.clear
+            Dir.chdir(spec.full_gem_path)
+            log.info "Building yardoc index for gem: #{spec.full_name}"
             Yardoc.run('-n', '-b', yfile)
             reload = false
           end

data/lib/yard/cli/yri.rb

@@ -42,7 +42,7 @@ module YARD
         return if path == Registry.yardoc_file
         @cache[name] = path
         
-        File.open(CACHE_FILE, 'w') do |file|
+        File.open!(CACHE_FILE, 'w') do |file|
           @cache.each do |key, value|
             file.puts("#{key} #{value}")
           end

data/lib/yard/core_ext/file.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 class File
   RELATIVE_PARENTDIR = '..'
   RELATIVE_SAMEDIR = '.'
@@ -40,4 +42,11 @@ class File
     end
     File.join(*path)
   end
+  
+  # Forces opening a file (for writing) by first creating the file's directory
+  def self.open!(file, *args, &block)
+    dir = dirname(file)
+    FileUtils.mkdir_p(dir) unless directory?(dir)
+    open(file, *args, &block)
+  end
 end

data/lib/yard/registry_store.rb

@@ -94,8 +94,12 @@ module YARD
     # @return [Boolean] whether the database was loaded
     # @see #load_all
     def load!(file = nil)
-      load(file)
-      load_all
+      if load(file)
+        load_all
+        true
+      else
+        false
+      end
     end
     
     # Loads all cached objects into memory
@@ -220,11 +224,11 @@ module YARD
     end
     
     def write_proxy_types
-      File.open(proxy_types_path, 'wb') {|f| f.write(Marshal.dump(@proxy_types)) }
+      File.open!(proxy_types_path, 'wb') {|f| f.write(Marshal.dump(@proxy_types)) }
     end
     
     def write_checksums
-      File.open(checksums_path, 'w') do |f|
+      File.open!(checksums_path, 'w') do |f|
         @checksums.each {|k, v| f.puts("#{k} #{v}") }
       end
     end

data/lib/yard/serializers/file_system_serializer.rb

@@ -1,5 +1,3 @@
-require 'fileutils'
-
 module YARD
   module Serializers
     class FileSystemSerializer < Base
@@ -28,9 +26,8 @@ module YARD
       # @return [String] the written data (for chaining)
       def serialize(object, data)
         path = File.join(basepath, *serialized_path(object))
-        FileUtils.mkdir_p File.dirname(path)
         log.debug "Serializing to #{path}"
-        File.open(path, "wb") {|f| f.write data }
+        File.open!(path, "wb") {|f| f.write data }
       end
       
       # Implements the serialized path of a code object.

data/spec/core_ext/file_spec.rb

@@ -45,4 +45,20 @@ describe File do
       File.cleanpath('C/../../D').should == "../D"
     end
   end
+  
+  describe '.open!' do
+    it "should create the path before opening" do
+      File.should_receive(:directory?).with('/path/to').and_return(false)
+      FileUtils.should_receive(:mkdir_p).with('/path/to')
+      File.should_receive(:open).with('/path/to/file', 'w')
+      File.open!('/path/to/file', 'w')
+    end
+
+    it "should just open the file if the path exists" do
+      File.should_receive(:directory?).with('/path/to').and_return(true)
+      FileUtils.should_not_receive(:mkdir_p)
+      File.should_receive(:open).with('/path/to/file', 'w')
+      File.open!('/path/to/file', 'w')
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Loren Segal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 -05:00
+date: 2009-12-16 00:00:00 -05:00
 default_executable: 
 dependencies: []