defog 0.3.1 → 0.3.2

data/README.rdoc

@@ -19,6 +19,12 @@ Defog also provides a few simple remote-file management methods to minimize
 the need to dig down into the Fog layer; but full access to the underlying
 fog objects is available should it be needed.
 
+<b>NOTE:</b>  Currently the only supported providers are :local and :AWS since
+those are what the author currently uses.  Please fork and add others!
+(There's just a very small amount of provider-specific code in {one
+file}[https://github.com/ronen/defog/blob/master/lib/defog/fog_wrapper.rb],
+plus spec examples.)
+
 == Usage Summary
 
 Full Rdoc is available at http://rubydoc.info/gems/defog
@@ -52,15 +58,11 @@ Open a proxy to a remote file by creating a <code>Defog::File</code> object:
 <code>mode</code> can be "r", "r+", "w", "w+", "a", or "a+" with the usual
 semantics, and can be suffixed with "b" or with ":" and encoding as usual.
 
-When opened in a readable mode ("r", "r+", "w+", "a+"), first caches the
+When opened in a readable mode ("r", "r+", "w+", "a+"), Defog first caches the
 cloud file in the local proxy.  When opened in a writeable mode ("r+", "w",
-"w+", "a", "a+"), arranges to upload the changes back to the cloud file
+"w+", "a", "a+"), Defog arranges to upload the changes back to the cloud file
 at close time.
 
-Closing the file object (explicitly or implicitly at the end of
-the block) synchronizes the local proxy with the remote storage and (by
-default) deletes the local proxy file.
-
 The <code>Defog::File</code> class inherits from <code>::File</code>.  So
 you can use it directly for I/O operations, such as
   
@@ -76,7 +78,12 @@ You can also access the proxy file via its path, allowing things such as
 
 (Note that the proxy file path has the same file extension as the cloud key string.)
 
-To suppress updating the remote storage, delete the local proxy file before
+Closing the file object (explicitly or implicitly at the end of the block)
+synchronizes the local proxy with the remote storage if needed, and then (by
+default) deletes the local proxy file.
+
+To suppress deleting the local proxy file, use <code>:persist => true</code> (see
+Persistence below).  To suppress updating the remote storage, delete the local proxy file before
 closing (e.g. via <code>File.unlink(file.path)</code>) or pass
 <code>:synchronize => false</code> to the <code>#close</code> method.
 
@@ -190,6 +197,16 @@ And it's fair game to delete proxy files outside of Defog, such as via a
 cron job.  Of course in these cases it's up to you to make sure not to
 unintentionally delete a proxy file that's currently open.
 
+== Accessing Fog
+
+You can access the underlying fog objects as needed:
+
+   defog = Defog::Proxy.new(:provider => ...)
+
+   defog.fog_connection         # => the Fog::Storage object
+   defog.fog_directory          # => the fog directory that contains the files being proxied
+   defog.file("key").fog_model  # => the fog model for the cloud file
+
 == Installation
 
 Gemfile:

data/lib/defog/fog_wrapper.rb

@@ -44,7 +44,7 @@ module Defog #:nodoc: all
       def initialize(opts={})
         opts = opts.keyword_args(:local_root => :required)
         @local_root = Pathname.new(opts.local_root).realpath
-        @location = @local_root.to_s.gsub(%r{/},'_')
+        @location = @local_root.to_s.gsub(%r{/},'-')
         @fog_connection = Fog::Storage.new(:provider => provider, :local_root => @local_root)
         @fog_directory = @fog_connection.directories.get('.')
       end

data/lib/defog/proxy.rb

@@ -61,7 +61,7 @@ module Defog
       @proxy_root ||= case
                       when defined?(Rails) then Rails.root + "tmp"
                       else Pathname.new(Dir.tmpdir)
-                      end + "defog" + provider.to_s + location
+                      end + "defog" + "#{provider}-#{location}"
 
     end
 

data/lib/defog/version.rb

@@ -1,3 +1,3 @@
 module Defog
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/proxy_spec.rb

@@ -67,13 +67,13 @@ shared_examples "a proxy" do |args|
   context "proxy root location" do
     it "should default proxy root to tmpdir/defog" do
       proxy = Defog::Proxy.new(args)
-      proxy.proxy_root.should == Pathname.new(Dir.tmpdir) + "defog" + proxy.provider.to_s + proxy.location
+      proxy.proxy_root.should == Pathname.new(Dir.tmpdir) + "defog" + "#{proxy.provider.to_s}-#{proxy.location}"
     end
 
     it "should default proxy root to Rails.root" do
       with_rails_defined do
         proxy = Defog::Proxy.new(args)
-        proxy.proxy_root.should == Rails.root + "tmp/defog" + proxy.provider.to_s + proxy.location
+        proxy.proxy_root.should == Rails.root + "tmp/defog" + "#{proxy.provider.to_s}-#{proxy.location}"
       end
     end
 
@@ -87,7 +87,7 @@ shared_examples "a proxy" do |args|
   context "cache management" do
     before(:each) do
       @proxy = Defog::Proxy.new(args.merge(:max_cache_size => 100, :persist => true))
-      @proxy.proxy_root.rmtree
+      @proxy.proxy_root.rmtree if @proxy.proxy_root.exist?
       @proxy.proxy_root.mkpath
     end
 
@@ -216,7 +216,7 @@ describe Defog::Proxy do
     it_should_behave_like "a proxy", args
 
     it "should use the deslashed local_root as the location" do
-      Defog::Proxy.new(args).location.should == LOCAL_CLOUD_PATH.to_s.gsub(%r{/},"_")
+      Defog::Proxy.new(args).location.should == LOCAL_CLOUD_PATH.to_s.gsub(%r{/},"-")
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defog
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70269507983660 !ruby/object:Gem::Requirement
+  requirement: &70315023604540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70269507983660
+  version_requirements: *70315023604540
 - !ruby/object:Gem::Dependency
   name: hash_keyword_args
-  requirement: &70269507983240 !ruby/object:Gem::Requirement
+  requirement: &70315023604100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70269507983240
+  version_requirements: *70315023604100
 - !ruby/object:Gem::Dependency
   name: fastandand
-  requirement: &70269507982820 !ruby/object:Gem::Requirement
+  requirement: &70315023603660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70269507982820
+  version_requirements: *70315023603660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70269507982400 !ruby/object:Gem::Requirement
+  requirement: &70315023603220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70269507982400
+  version_requirements: *70315023603220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70269507981980 !ruby/object:Gem::Requirement
+  requirement: &70315023602800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70269507981980
+  version_requirements: *70315023602800
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70269507981540 !ruby/object:Gem::Requirement
+  requirement: &70315023602380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70269507981540
+  version_requirements: *70315023602380
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
-  requirement: &70269507981020 !ruby/object:Gem::Requirement
+  requirement: &70315023601960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70269507981020
+  version_requirements: *70315023601960
 description: Wrapper to fog gem, proxying access to cloud files as local files.
 email:
 - ronen@barzel.org