fog-local 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38b9c0483e09f643f9f45d328ce5d726a72e114a
-  data.tar.gz: 2241c0bfc4cd14ad1564cde923d938e3c6ceba81
+  metadata.gz: 5b065f649b2b35609e1a2ae757ccb5036d2d9494
+  data.tar.gz: b72140031f1a364ce4917ed40975155302a7653c
 SHA512:
-  metadata.gz: 9c5a6bb0078efa532207c11ffa10ef058a9056261d929f7f3ae5c32384ddbc3488a1347cd584f4fbf843bb18198079bfeb2abe328e9fabd5834c41c533b7dbf5
-  data.tar.gz: 85fa728c4ba44739e15ed322a693a611a58f4cd9f931e54586e09a8153ca2fc1275674da75d227a5c08f182e7d8f384a76f1dbb91e8a51953581286f6f381bb5
+  metadata.gz: a0d8e89df4684a9400e776872a780906e371d3feea6f0d5d3028d2e7e65b3a2211583e34cd563dfe98b20ca5d307e2ae83ec2cce9405e24ac054503dca24c192
+  data.tar.gz: 1340c09b2b5431deb708134546c7a21231ebc415a3e214e258b8682b7677609f3a4661dab000784ebf448012261d28e92a5a6408c02fc735f51be582cdacfad6

data/.travis.yml

@@ -10,6 +10,7 @@ rvm:
   - 2.2.6
   - 2.3.3
   - 2.4.0
+  - 2.5.1
   - jruby-19mode
   - jruby-9.1.7.0
 env:

data/CONTRIBUTORS.md

@@ -16,3 +16,4 @@
 * James Herdman <james.herdman@me.com>
 * Adam Tanner <adam@adamtanner.org>
 * Mark Yen <marky@activestate.com>
+* Kevin Deisz <kevin.deisz@gmail.com>

data/README.md

@@ -22,27 +22,22 @@ Or install it yourself as:
 
 ## Usage
 
-Initialise a `Fog::Storage` object using local provider
+Initialise a `Fog::Local::Storage` object:
 
 ```ruby
-
-storage = Fog::Storage.new({
-  :local_root => '~/fog',
-  :provider   => 'Local'
-})
-
+storage = Fog::Local::Storage.new(local_root: '~/fog')
 ```
 
 This can then be used like any other [Fog storage](http://fog.io/storage/).
 
 ```ruby
-directory = storage.directories.create(:key => 'data')
-directory.files.create(:body => 'Hello World!', :key  => 'hello_world.txt')
+directory = storage.directories.create(key: 'data')
+directory.files.create(body: 'Hello World!', key: 'hello_world.txt')
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/fog/fog-local/fork )
+1. Fork it ( https://github.com/fog/fog-local/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/fog/bin/local.rb

@@ -3,7 +3,7 @@ class Local < Fog::Bin
     def class_for(key)
       case key
       when :storage
-        Fog::Storage::Local
+        Fog::Local::Storage
       else
         raise ArgumentError, "Unsupported #{self} service: #{key}"
       end
@@ -14,7 +14,7 @@ class Local < Fog::Bin
         hash[key] = case key
         when :storage
           Fog::Logger.warning("Local[:storage] is not recommended, use Storage[:local] for portability")
-          Fog::Storage.new(:provider => 'Local')
+          Fog::Local::Storage.new
         else
           raise ArgumentError, "Unrecognized service: #{key.inspect}"
         end

data/lib/fog/local.rb

@@ -1,16 +1,16 @@
 require 'fog/core'
 require 'fileutils'
 require 'tempfile'
-require File.expand_path('../local/version', __FILE__)
 
-module Fog
-  module Storage
-    autoload :Local, File.expand_path('../storage/local', __FILE__)
-  end
+require 'fog/local/version'
 
+module Fog
   module Local
-    extend Fog::Provider
+    extend Provider
 
-    service(:storage, 'Storage')
+    autoload :Storage, 'fog/local/storage'
+    service :storage, :Storage
   end
 end
+
+Fog::Storage::Local = Fog::Local::Storage # legacy compat

data/lib/fog/{storage/local → local}/models/directories.rb

@@ -1,8 +1,8 @@
 module Fog
-  module Storage
-    class Local
+  module Local
+    class Storage
       class Directories < Fog::Collection
-        model Fog::Storage::Local::Directory
+        model Directory
 
         def all
           data = if ::File.directory?(service.local_root)
@@ -22,6 +22,7 @@ module Fog
         end
 
         private
+
         def create_directory(key, options)
           options[:path] ? new(key: key + options[:path]) : new(key: key)
         end

data/lib/fog/{storage/local → local}/models/directory.rb

@@ -1,6 +1,6 @@
 module Fog
-  module Storage
-    class Local
+  module Local
+    class Storage
       class Directory < Fog::Model
         identity  :key
 
@@ -16,12 +16,7 @@ module Fog
         end
 
         def files
-          @files ||= begin
-            Fog::Storage::Local::Files.new(
-              :directory    => self,
-              :service   => service
-            )
-          end
+          @files ||= Files.new(directory: self, service: service)
         end
 
         def public=(new_public)

data/lib/fog/{storage/local → local}/models/file.rb

@@ -1,6 +1,6 @@
 module Fog
-  module Storage
-    class Local
+  module Local
+    class Storage
       class File < Fog::Model
         identity  :key,             :aliases => 'Key'
 
@@ -54,14 +54,7 @@ module Fog
             if dir_path == service.path_to(directory.key)
               break
             end
-            pwd = Dir.pwd
-            if ::File.directory?(dir_path)
-              Dir.chdir(dir_path)
-              if Dir.glob('*').empty?
-                Dir.rmdir(dir_path)
-              end
-              Dir.chdir(pwd)
-            end
+            rm_if_empty_dir(dir_path)
           end
           true
         end
@@ -125,6 +118,22 @@ module Fog
             IO.copy_stream(input_io, file)
           end
         end
+
+        def rm_if_empty_dir(dir_path)
+          if ::File.directory?(dir_path)
+            Dir.rmdir(dir_path) if dir_empty?(dir_path)
+          end
+        end
+
+        def dir_empty?(dir_path)
+          # NOTE: There’s Dir.empty?, but it is only available on Ruby 2.4+
+
+          # NOTE: `entries` will be empty on Windows, and contain . and .. on
+          # unix-like systems (macOS, Linux, BSD, …)
+
+          entries = Dir.entries(dir_path)
+          entries.empty? || entries.all? { |e| ['.', '..'].include?(e) }
+        end
       end
     end
   end

data/lib/fog/{storage/local → local}/models/files.rb

@@ -1,10 +1,10 @@
 module Fog
-  module Storage
-    class Local
+  module Local
+    class Storage
       class Files < Fog::Collection
         attribute :directory
 
-        model Fog::Storage::Local::File
+        model File
 
         def all
           requires :directory
@@ -71,6 +71,10 @@ module Fog
           super({ :directory => directory }.merge!(attributes))
         end
 
+        def is_truncated
+          false
+        end
+
         private
 
         def file_path(key)

data/lib/fog/local/storage.rb

@@ -1 +1,98 @@
-# This file was intentionally left blank
+module Fog
+  module Local
+    class Storage < Fog::Service
+      autoload :Directories, 'fog/local/models/directories'
+      autoload :Directory, 'fog/local/models/directory'
+      autoload :File, 'fog/local/models/file'
+      autoload :Files, 'fog/local/models/files'
+
+      requires :local_root
+      recognizes :endpoint, :scheme, :host, :port, :path
+
+      model_path 'fog/local/models'
+      collection  :directories
+      model       :directory
+      model       :file
+      collection  :files
+
+      require 'uri'
+
+      class Mock
+        attr_reader :endpoint
+
+        def self.data
+          @data ||= Hash.new do |hash, key|
+            hash[key] = {}
+          end
+        end
+
+        def self.reset
+          @data = nil
+        end
+
+        def initialize(options={})
+          Fog::Mock.not_implemented
+
+          @local_root = ::File.expand_path(options[:local_root])
+
+          @endpoint = options[:endpoint] || build_endpoint_from_options(options)
+        end
+
+        def data
+          self.class.data[@local_root]
+        end
+
+        def local_root
+          @local_root
+        end
+
+        def path_to(partial)
+          ::File.join(@local_root, partial)
+        end
+
+        def reset_data
+          self.class.data.delete(@local_root)
+        end
+
+        private
+        def build_endpoint_from_options(options)
+          return unless options[:host]
+
+          URI::Generic.build(options).to_s
+        end
+      end
+
+      class Real
+        attr_reader :endpoint
+
+        def initialize(options={})
+          @local_root = ::File.expand_path(options[:local_root])
+
+          @endpoint = options[:endpoint] || build_endpoint_from_options(options)
+        end
+
+        def local_root
+          @local_root
+        end
+
+        def path_to(partial)
+          ::File.join(@local_root, partial)
+        end
+
+        def copy_object(source_directory_name, source_object_name, target_directory_name, target_object_name, options={})
+          source_path = path_to(::File.join(source_directory_name, source_object_name))
+          target_path = path_to(::File.join(target_directory_name, target_object_name))
+          ::FileUtils.mkdir_p(::File.dirname(target_path))
+          ::FileUtils.copy_file(source_path, target_path)
+        end
+
+        private
+        def build_endpoint_from_options(options)
+          return unless options[:host]
+
+          URI::Generic.build(options).to_s
+        end
+      end
+    end
+  end
+end

data/lib/fog/local/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Local
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/tests/helper.rb

@@ -5,7 +5,8 @@ rescue LoadError => e
   $stderr.puts "not recording test coverage: #{e.inspect}"
 end
 
-require File.expand_path('../../lib/fog/local', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'fog/local'
 
 Bundler.require(:test)
 require 'tmpdir'

data/tests/local/models/directories_tests.rb

@@ -3,7 +3,7 @@ Shindo.tests('Storage[:local] | directories', ["local"]) do
   pending if Fog.mocking?
 
   @options = { :local_root => Dir.mktmpdir('fog-tests') }
-  @collection = Fog::Storage::Local.new(@options).directories
+  @collection = Fog::Local::Storage.new(@options).directories
 
   collection_tests(@collection, {:key => "fogdirtests"}, true)
 

data/tests/local/models/directory_tests.rb

@@ -12,7 +12,7 @@ Shindo.tests('Storage[:local] | directory', ["local"]) do
 
   tests('save') do
     returns('directory') do
-      connection = Fog::Storage::Local.new(@options)
+      connection = Fog::Local::Storage.new(@options)
       connection.directories.create(:key => 'directory')
       connection.directories.create(:key => 'directory').key
     end

data/tests/local/models/file_tests.rb

@@ -15,7 +15,7 @@ Shindo.tests('Storage[:local] | file', ["local"]) do
       returns('http://example.com/files/directory/file.txt') do
         @options[:endpoint] = 'http://example.com/files'
 
-        connection = Fog::Storage::Local.new(@options)
+        connection = Fog::Local::Storage.new(@options)
         directory = connection.directories.new(:key => 'directory')
         file = directory.files.new(:key => 'file.txt')
 
@@ -26,7 +26,7 @@ Shindo.tests('Storage[:local] | file', ["local"]) do
       returns(nil) do
         @options[:endpoint] = nil
 
-        connection = Fog::Storage::Local.new(@options)
+        connection = Fog::Local::Storage.new(@options)
         directory = connection.directories.new(:key => 'directory')
         file = directory.files.new(:key => 'file.txt')
 
@@ -37,7 +37,7 @@ Shindo.tests('Storage[:local] | file', ["local"]) do
       returns('http://example.com/files/my%20directory/my%20file.txt') do
         @options[:endpoint] = 'http://example.com/files'
 
-        connection = Fog::Storage::Local.new(@options)
+        connection = Fog::Local::Storage.new(@options)
         directory = connection.directories.new(:key => 'my directory')
         file = directory.files.new(:key => 'my file.txt')
 
@@ -48,7 +48,7 @@ Shindo.tests('Storage[:local] | file', ["local"]) do
   tests('#save') do
     tests('creates non-existent subdirs') do
       returns(true) do
-        connection = Fog::Storage::Local.new(@options)
+        connection = Fog::Local::Storage.new(@options)
         directory = connection.directories.new(:key => 'path1')
         file = directory.files.new(:key => 'path2/file.rb', :body => "my contents")
         file.save
@@ -57,7 +57,7 @@ Shindo.tests('Storage[:local] | file', ["local"]) do
     end
 
     tests('with tempfile').returns('tempfile') do
-      connection = Fog::Storage::Local.new(@options)
+      connection = Fog::Local::Storage.new(@options)
       directory = connection.directories.create(:key => 'directory')
 
       tempfile = Tempfile.new(['file', '.txt'])
@@ -76,4 +76,69 @@ Shindo.tests('Storage[:local] | file', ["local"]) do
       directory.files.get('tempfile.txt').body
     end
   end
+
+  tests('#destroy') do
+    # - removes dir if it contains no files
+    # - keeps dir if it contains non-hidden files
+    # - keeps dir if it contains hidden files
+    # - stays in the same directory
+
+    tests('removes enclosing dir if it is empty') do
+      returns(false) do
+        connection = Fog::Local::Storage.new(@options)
+        directory = connection.directories.new(:key => 'path1')
+
+        file = directory.files.new(:key => 'path2/file.rb', :body => "my contents")
+        file.save
+        file.destroy
+
+        File.exists?(@options[:local_root] + "/path1/path2")
+      end
+    end
+
+    tests('keeps enclosing dir if it is not empty') do
+      returns(true) do
+        connection = Fog::Local::Storage.new(@options)
+        directory = connection.directories.new(:key => 'path1')
+
+        file = directory.files.new(:key => 'path2/file.rb', :body => "my contents")
+        file.save
+
+        file = directory.files.new(:key => 'path2/file2.rb', :body => "my contents")
+        file.save
+        file.destroy
+
+        File.exists?(@options[:local_root] + "/path1/path2")
+      end
+    end
+
+    tests('keeps enclosing dir if contains only hidden files') do
+      returns(true) do
+        connection = Fog::Local::Storage.new(@options)
+        directory = connection.directories.new(:key => 'path1')
+
+        file = directory.files.new(:key => 'path2/.file.rb', :body => "my contents")
+        file.save
+
+        file = directory.files.new(:key => 'path2/.file2.rb', :body => "my contents")
+        file.save
+        file.destroy
+
+        File.exists?(@options[:local_root] + "/path1/path2")
+      end
+    end
+
+    tests('it stays in the same directory') do
+      returns(Dir.pwd) do
+        connection = Fog::Local::Storage.new(@options)
+        directory = connection.directories.new(:key => 'path1')
+
+        file = directory.files.new(:key => 'path2/file2.rb', :body => "my contents")
+        file.save
+        file.destroy
+
+        Dir.pwd
+      end
+    end
+  end
 end

data/tests/local/models/files_tests.rb

@@ -0,0 +1,21 @@
+Shindo.tests('Storage[:local] | files', ["local"]) do
+
+  pending if Fog.mocking?
+
+  before do
+    @options = { :local_root => Dir.mktmpdir('fog-tests') }
+  end
+
+  after do
+    FileUtils.remove_entry_secure(@options[:local_root]) if File.directory?(@options[:local_root])
+  end
+
+  tests("#is_truncated") do
+    returns(false) do
+      connection = Fog::Local::Storage.new(@options)
+      directory = connection.directories.create(:key => 'directory')
+      collection = directory.files
+      collection.is_truncated
+    end
+  end
+end

data/tests/local/storage_tests.rb

@@ -13,7 +13,7 @@ Shindo.tests('Local | storage') do
   tests('#endpoint') do
     tests('when no endpoint is provided').
       returns(nil) do
-        Fog::Storage::Local.new(@options).endpoint
+        Fog::Local::Storage.new(@options).endpoint
       end
 
     tests('when no host is provided').
@@ -22,14 +22,14 @@ Shindo.tests('Local | storage') do
         @options[:path] = '/files'
         @options[:port] = 80
 
-        Fog::Storage::Local.new(@options).endpoint
+        Fog::Local::Storage.new(@options).endpoint
       end
 
     tests('when endpoint is provided').
       returns('http://example.com/files') do
         @options[:endpoint] = 'http://example.com/files'
 
-        Fog::Storage::Local.new(@options).endpoint
+        Fog::Local::Storage.new(@options).endpoint
       end
 
     tests('when at least host option is provided').
@@ -38,7 +38,7 @@ Shindo.tests('Local | storage') do
         @options[:host] = 'example.com'
         @options[:path] = '/files'
 
-        Fog::Storage::Local.new(@options).endpoint
+        Fog::Local::Storage.new(@options).endpoint
       end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fog-local
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Wesley Beary
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-25 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,7 +85,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
@@ -96,13 +95,12 @@ files:
 - fog-local.gemspec
 - lib/fog/bin/local.rb
 - lib/fog/local.rb
+- lib/fog/local/models/directories.rb
+- lib/fog/local/models/directory.rb
+- lib/fog/local/models/file.rb
+- lib/fog/local/models/files.rb
 - lib/fog/local/storage.rb
 - lib/fog/local/version.rb
-- lib/fog/storage/local.rb
-- lib/fog/storage/local/models/directories.rb
-- lib/fog/storage/local/models/directory.rb
-- lib/fog/storage/local/models/file.rb
-- lib/fog/storage/local/models/files.rb
 - tests/helper.rb
 - tests/helpers/collection_helper.rb
 - tests/helpers/mock_helper.rb
@@ -111,6 +109,7 @@ files:
 - tests/local/models/directories_tests.rb
 - tests/local/models/directory_tests.rb
 - tests/local/models/file_tests.rb
+- tests/local/models/files_tests.rb
 - tests/local/storage_tests.rb
 - tests/watchr.rb
 homepage: https://github.com/fog/fog-local

data/.ruby-version

@@ -1 +0,0 @@
-2.2.0

data/lib/fog/storage/local.rb

@@ -1,98 +0,0 @@
-module Fog
-  module Storage
-    class Local < Fog::Service
-      autoload :Directories, ::File.expand_path('../local/models/directories', __FILE__)
-      autoload :Directory, ::File.expand_path('../local/models/directory', __FILE__)
-      autoload :File, ::File.expand_path('../local/models/file', __FILE__)
-      autoload :Files, ::File.expand_path('../local/models/files', __FILE__)
-
-      requires :local_root
-      recognizes :endpoint, :scheme, :host, :port, :path
-
-      model_path 'fog/storage/local/models'
-      collection  :directories
-      model       :directory
-      model       :file
-      collection  :files
-
-      require 'uri'
-
-      class Mock
-        attr_reader :endpoint
-
-        def self.data
-          @data ||= Hash.new do |hash, key|
-            hash[key] = {}
-          end
-        end
-
-        def self.reset
-          @data = nil
-        end
-
-        def initialize(options={})
-          Fog::Mock.not_implemented
-
-          @local_root = ::File.expand_path(options[:local_root])
-
-          @endpoint = options[:endpoint] || build_endpoint_from_options(options)
-        end
-
-        def data
-          self.class.data[@local_root]
-        end
-
-        def local_root
-          @local_root
-        end
-
-        def path_to(partial)
-          ::File.join(@local_root, partial)
-        end
-
-        def reset_data
-          self.class.data.delete(@local_root)
-        end
-
-        private
-        def build_endpoint_from_options(options)
-          return unless options[:host]
-
-          URI::Generic.build(options).to_s
-        end
-      end
-
-      class Real
-        attr_reader :endpoint
-
-        def initialize(options={})
-          @local_root = ::File.expand_path(options[:local_root])
-
-          @endpoint = options[:endpoint] || build_endpoint_from_options(options)
-        end
-
-        def local_root
-          @local_root
-        end
-
-        def path_to(partial)
-          ::File.join(@local_root, partial)
-        end
-
-        def copy_object(source_directory_name, source_object_name, target_directory_name, target_object_name, options={})
-          source_path = path_to(::File.join(source_directory_name, source_object_name))
-          target_path = path_to(::File.join(target_directory_name, target_object_name))
-          ::FileUtils.mkdir_p(::File.dirname(target_path))
-          ::FileUtils.copy_file(source_path, target_path)
-        end
-
-        private
-        def build_endpoint_from_options(options)
-          return unless options[:host]
-
-          URI::Generic.build(options).to_s
-        end
-      end
-    end
-  end
-end