defog 0.3.0 → 0.3.1

data/README.rdoc

@@ -50,7 +50,7 @@ Open a proxy to a remote file by creating a <code>Defog::File</code> object:
         end
 
 <code>mode</code> can be "r", "r+", "w", "w+", "a", or "a+" with the usual
-semantics. 
+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
 cloud file in the local proxy.  When opened in a writeable mode ("r+", "w",

data/lib/defog/file.rb

@@ -1,5 +1,6 @@
 module Defog
-  # Create a Defog::File proxy instance via Defog::Proxy#file, such as
+  # Create a Defog::File proxy instance via Defog::Handle#open or via the
+  # shortcut from Defog::Proxy#file, such as
   #
   #    defog = Defog::Proxy.new(:provider => :AWS, :aws_access_key_id => access_key, ...)
   #
@@ -28,8 +29,17 @@ module Defog
   # 
   # (Note that the proxy file path has the same file extension as the cloud key string.)
   #
-  # Upon closing the proxy file, in normal use the cloud storage gets synchronized and
-  # the proxy deleted.  See File#close for more details.
+  # Upon closing the proxy file, in normal use the cloud storage gets
+  # synchronized if needed and the proxy deleted.  To prevent deletion, you
+  # can use:
+  #    defog.file("key", "r", :persist => true)
+  # See File#close for more details.
+  #
+  # If you are managing your cache size, when opening a proxy for writing you may want to provide a hint as
+  # to the expected size of the data:
+  #    defog.file("key", "w", :size_hint => 500.kilobytes)
+  # See README for more details.
+  #
   class File < ::File
 
     def initialize(opts={}, &block) #:nodoc:
@@ -40,7 +50,9 @@ module Defog
       key = @handle.key
       proxy_path = @handle.proxy_path
       proxy_path.dirname.mkpath
-      case opts.mode
+      re_encoding = /(b|:.*)$/
+      @encoding = opts.mode.match(re_encoding).to_s
+      case opts.mode.sub(re_encoding,'')
       when "r"
         download = true
         @upload = false
@@ -64,11 +76,11 @@ module Defog
     end
 
     def download_proxy
-      @handle.proxy.fog_wrapper.get_file(@handle.key, @handle.proxy_path)
+      @handle.proxy.fog_wrapper.get_file(@handle.key, @handle.proxy_path, @encoding)
     end
 
     def upload_proxy
-      @handle.proxy.fog_wrapper.put_file(@handle.key, @handle.proxy_path) 
+      @handle.proxy.fog_wrapper.put_file(@handle.key, @handle.proxy_path, @encoding) 
     end
 
 

data/lib/defog/fog_wrapper.rb

@@ -20,16 +20,18 @@ module Defog #:nodoc: all
       klass.new(opts)
     end
 
-    def get_file(key, path)
+    def get_file(key, path, encoding)
       raise Error::NoCloudFile, "No such file in #{provider} #{location}: #{key}" unless fog_head(key)
       return if path.exist? and Digest::MD5.hexdigest(path.read) == get_md5(key)
-      path.open("w") do |f|
+      path.open("w#{encoding}") do |f|
         f.write(fog_head(key).body)
       end
     end
 
-    def put_file(key, path)
-      fog_directory.files.create(:key => key, :body => path.open)
+    def put_file(key, path, encoding)
+      path.open("r#{encoding}") do |file|
+        fog_directory.files.create(:key => key, :body => file)
+      end
     end
 
     def fog_head(key)

data/lib/defog/handle.rb

@@ -78,11 +78,12 @@ module Defog
 
     # Returns a Defog::File object, which is a specialization of ::File. 
     #
-    # <code>mode</code> can be "r", "r+", "w", "w+", "a", or "a+" with the
+    # <code>mode</code> can be the usual "r", "r+", "w", "w+", "a", or "a+" with the
     # usual semantics.  When opened in a readable mode ("r", "r+", "w+",
     # "a+"), 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 at close time.
+    # the changes back to the cloud file at close time.  The mode can be
+    # suffixed with 'b' or with ':' and encoding specifiers as usual.
     #
     # Like ::File.open, if called with a block yields the file object to
     # the block and ensures the file will be closed when leaving the block.
@@ -92,6 +93,12 @@ module Defog
     #    :persist => true
     # to suppress deleting the file and so maintain the file after closing.   See File#close for more
     # details.
+    #
+    # If you are managing your cache size, when opening a proxy for writing
+    # you may want to provide a hint as to the expected size of the data:
+    #    :size_hint => 500.kilobytes
+    # See README for more details.
+    #
     def open(mode, opts={}, &block)
       opts = opts.keyword_args(:persist => @proxy.persist, :size_hint => :optional)
       File.open(opts.merge(:handle => self, :mode => mode), &block)

data/lib/defog/version.rb

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

data/spec/file_spec.rb

@@ -5,6 +5,7 @@ shared_examples "get proxy" do
     create_remote("hello")
     file = @proxy.file(key, @mode)
     File.exist?(file.path).should be_true
+    file.close
   end
 
   it "should raise error if remote doesn't exist" do
@@ -22,13 +23,13 @@ shared_examples "get proxy" do
   it "should use existing proxy if it's valid" do
     create_remote("hello")
     create_proxy("hello")
-    Pathname.any_instance.should_not_receive(:open).with("w")
+    Pathname.any_instance.should_not_receive(:open).with(/^w/)
     @proxy.file(key, @mode)
 
     # doublecheck that should_not_receive was the right
     # thing to test.  will it be received for an invalid proxy?
     create_proxy("goodbye")
-    Pathname.any_instance.should_receive(:open).with("w")
+    Pathname.any_instance.should_receive(:open).with(/^w/)
     @proxy.file(key, @mode)
   end
 end
@@ -41,6 +42,22 @@ shared_examples "read" do
       file.read.should == "read me"
     end
   end
+
+  it "should pass 'b' mode through" do
+    create_remote("binary me")
+    @proxy.file(key, "#{@mode}b") do |file|
+      file.external_encoding.name.should == "ASCII-8BIT"
+    end
+  end
+
+  it "should pass encodings through" do
+    create_remote("encode me")
+    @proxy.file(key, "#{@mode}:EUC-JP:UTF-16") do |file|
+      file.external_encoding.name.should == "EUC-JP"
+      file.internal_encoding.name.should == "UTF-16"
+    end
+  end
+
 end
 
 shared_examples "read after write" do

metadata

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