static_sync 0.1.7 → 0.1.8

data/README.md

@@ -21,13 +21,11 @@ This gem provides a command line tool for uploading static websites to amazon/ra
   gem install static_sync
 ```
 
-## Example Usage
+## Example Command Line Usage
 
 In your project directory create a `.static` file:
 
 ```
-> cat .static
-
 # What to upload
 local:
   directory: build
@@ -43,7 +41,7 @@ remote:
 # Everything below this line is optional.
 
 # What not to upload (ruby regular expression).
-ignored: (psd,gz)$
+ignored: (psd|gz)$
 
 # Number of seconds to cache each content type, defaults to no cache.
 cache:
@@ -52,8 +50,11 @@ cache:
   css: 31536000
   image: 31536000
 
-# If you wish to strictly prevent modification of existing files.
-immutable_mode: false
+# If you wish to prevent modification of existing files.
+# conflict_mode: 'fail'
+
+# If you wish to prevent modification of existing files that are cached.
+# conflict_mode: 'fail_if_cached'
 ```
 
 And simply run the following command any time you want to upload.
@@ -62,16 +63,33 @@ And simply run the following command any time you want to upload.
   static_sync
 ```
 
-### Environment Variables
+## Example Ruby Project Usage
+
+Very similar to the command line version except options can passed as a hash instead of being read from .static
+
+```
+require 'static_sync'
+
+StaticSync.upload(
+  'local' => {
+    ...
+  },
+  'remote' => {
+    ...      
+  }
+)
+```
+
+## Environment Variables
 
 You can reference environment variables in your `.static` file like this:
 
 ```
 remote:
   provider: AWS
-  username: <%= ENV['s3_key'] %>
-  password: <%= ENV['s3_secret'] %>
-  directory: <%= ENV['s3_bucket'] %>
+  username: <%= ENV['S3_KEY'] %>
+  password: <%= ENV['S3_SECRET'] %>
+  directory: <%= ENV['S3_BUCKET'] %>
 ```
 
 ## Contributing

data/lib/static_sync/config.rb

@@ -7,38 +7,40 @@ module StaticSync
       self.fetch('log', true)
     end
 
-    def immutable_mode
-      self.fetch('immutable_mode', false)
+    def local
+      self.fetch('local', {})
     end
 
-    def cache
-      self.fetch('cache', {})
+    def local_directory
+      self.local['directory']
     end
 
     def remote
       self.fetch('remote', {})
     end
 
-    def source
-      self.fetch('local', {})['directory']
-    end
-
-    def target
+    def remote_directory
       self.remote['directory']
     end
 
-    def storage
-      Fog::Storage.new({
-        :persistent            => true,
-        :provider              => self.remote['provider'],
-        :region                => self.remote['region'],
-        :aws_access_key_id     => self.remote['username'],
-        :aws_secret_access_key => self.remote['password']
-      })
+    def cache
+      self.fetch('cache', {})
     end
 
     def ignored
-      self['ignored']
+      self.fetch('ignored', nil)
+    end
+
+    def conflict_mode
+      self.fetch('conflict_mode', 'overwrite')
+    end
+
+    def fail_on_conflict?
+      conflict_mode == 'fail'
+    end
+
+    def fail_on_conflict_if_cached?
+      conflict_mode == 'fail_if_cached'
     end
 
     def load(path = '.static')

data/lib/static_sync/processor.rb

@@ -1,4 +1,3 @@
-require "fog"
 require "logger"
 
 require_relative "storage"
@@ -7,7 +6,7 @@ require_relative "uploadable"
 module StaticSync
   class Processor
 
-    class ImmutableError < StandardError
+    class ConflictError < StandardError
     end
 
     def initialize(config, storage = nil)
@@ -16,17 +15,14 @@ module StaticSync
     end
 
     def sync
-      log.info("Synching #{@config.source} to #{@config.target}.") if @config.log
-      Dir.chdir(@config.source) do
+      log.info("Synching #{@config.local_directory} to #{@config.remote_directory}.") if @config.log
+      Dir.chdir(@config.local_directory) do
         local_filtered_files.each do |file|
           current_file = Uploadable.new(file, @config)
 
           unless @storage.has_version?(current_file.version)
             if @storage.has_file?(current_file.version)
-              log.info("Overwriting #{file}") if @config.log
-              if @config.immutable_mode
-                raise ImmutableError, "immutable_mode does not allow modifications to existing files."
-              end
+              handle_conflict(current_file)
             else
               log.info("Uploading #{file}") if @config.log
             end
@@ -42,6 +38,17 @@ module StaticSync
       log.info("Synching done.") if @config.log
     end
 
+    def handle_conflict(file)
+      log.info("Overwriting #{file}") if @config.log
+      if @config.fail_on_conflict?
+        raise ConflictError, "modifications to existing files are not allowed."
+      elsif @config.fail_on_conflict_if_cached?
+        if file.cached?
+          raise ConflictError, "modifications to existing cached files are not allowed."
+        end
+      end
+    end
+
     def local_filtered_files
       local_files.reject do |file|
         file =~ Regexp.new(@config.ignored) if @config.ignored

data/lib/static_sync/storage.rb

@@ -1,12 +1,8 @@
 require "fog"
-require "logger"
 
 module StaticSync
   class Storage
 
-    class Version < Struct.new(:path, :etag)
-    end
-
     def initialize(config)
       @config = config
 
@@ -14,20 +10,21 @@ module StaticSync
     end
 
     def has_file?(version)
-      file_versions.map(&:path).include?(version.path)
+      cache.has_file?(version)
     end
 
     def has_version?(version)
-      file_versions.include?(version)
+      cache.has_version?(version)
     end
 
-    def file_versions
-      @file_versions ||= begin
-        result = []
+    def cache
+      @cache ||= begin
+        versions = []
         remote_directory.files.each do |file|
-          result << Version.new(file.key, file.etag)
+          versions << StorageCache::Version.new(file.key, file.etag)
         end
-        result
+        versions
+        StorageCache.new(versions)
       end
     end
 
@@ -38,11 +35,21 @@ module StaticSync
     private
 
     def remote_directory
-      @config.storage.directories.new(:key => @config.target)
+      storage.directories.new(:key => @config.remote['directory'])
     end
 
     def validate_credentials!
-      @config.storage.get_bucket(@config.target)
+      storage.get_bucket(@config.remote['directory'])
+    end
+
+    def storage
+      Fog::Storage.new({
+        :persistent            => true,
+        :provider              => @config.remote['provider'],
+        :region                => @config.remote['region'],
+        :aws_access_key_id     => @config.remote['username'],
+        :aws_secret_access_key => @config.remote['password']
+      })
     end
 
   end

data/lib/static_sync/storage_cache.rb

@@ -0,0 +1,30 @@
+module StaticSync
+  class StorageCache
+
+    class Version < Struct.new(:path, :etag)
+    end
+
+    def initialize(versions)
+      @versions = versions
+    end
+
+    def has_file?(file)
+      @versions.any? do |version|
+        file.path == version.path
+      end
+    end
+
+    def has_version?(file)
+      @versions.any? do |version|
+        file.path == version.path && file.etag == version.etag
+      end
+    end
+
+    def has_conflict?(file)
+      @versions.any? do |version|
+        file.path == version.path && file.etag != version.etag
+      end
+    end
+
+  end
+end

data/lib/static_sync/uploadable.rb

@@ -4,13 +4,13 @@ require "mime/types"
 require "tempfile"
 require "zlib"
 
-require_relative "storage"
+require_relative "storage_cache"
 
 module StaticSync
   class Uploadable < Struct.new(:path, :config)
 
     def version
-      Storage::Version.new(path, etag)
+      StorageCache::Version.new(path, etag)
     end
 
     def mime
@@ -33,6 +33,10 @@ module StaticSync
       end
     end
 
+    def cached?
+      !cache_time.nil?
+    end
+
     def cache_time
       if mime
         type = mime.sub_type

data/lib/static_sync/version.rb

@@ -1,3 +1,3 @@
 module StaticSync
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/processor_spec.rb

@@ -18,6 +18,60 @@ describe StaticSync::Processor do
     StaticSync::Processor.new(config, storage)
   end
 
+  describe "#handle_conflict" do
+    let(:file) { stub }
+
+    context "when in overwrite mode" do
+      let(:config) do
+        StaticSync::Config.new.merge({
+          'conflict_mode' => 'overwrite'
+        })
+      end
+
+      it "does nothing" do
+        subject.handle_conflict(file)
+      end
+    end
+
+    context "when in fail mode" do
+      let(:config) do
+        StaticSync::Config.new.merge({
+          'conflict_mode' => 'fail'
+        })
+      end
+
+      it "raises a conflict error" do
+        expect {
+          subject.handle_conflict(file)
+        }.to raise_error(StaticSync::Processor::ConflictError)
+      end
+    end
+
+    context "when in fail on cache mode" do
+      let(:file) { stub(:cached? => false) }
+
+      let(:config) do
+        StaticSync::Config.new.merge({
+          'conflict_mode' => 'fail_if_cached'
+        })
+      end
+
+      it "does nothing by default" do
+        subject.handle_conflict(file)
+      end
+
+      context "when the file is cached" do
+        let(:file) { stub(:cached? => true) }
+
+        it "raises a conflict error" do
+          expect {
+            subject.handle_conflict(file)
+          }.to raise_error(StaticSync::Processor::ConflictError)
+        end
+      end
+    end
+  end
+
   describe "#local_filtered_files" do
 
     before do
@@ -27,7 +81,7 @@ describe StaticSync::Processor do
     end
 
     it "does not include files matching the ignore regex" do
-      Dir.chdir(config.source) do
+      Dir.chdir(config.local_directory) do
         subject.local_filtered_files.should == [
           "assets/javascripts/jquery.min.js",
           "cat.com/index.html",

data/spec/storage_cache_spec.rb

@@ -0,0 +1,78 @@
+require "./lib/static_sync/storage_cache"
+
+module StaticSync
+  describe StorageCache do
+
+    let(:path) { "index.html" }
+
+    let(:version_one) { StorageCache::Version.new(path, "0cc175b9c0f1b6a831c399e269772661") }
+    let(:version_two) { StorageCache::Version.new(path, "92eb5ffee6ae2fec3ad71c777531578f") }
+
+    let(:files) { [] }
+
+    subject do
+      StorageCache.new(files)
+    end
+
+    describe "#has_file?" do
+
+      it "returns false by default" do
+        subject.has_file?(version_one).should be_false
+        subject.has_file?(version_two).should be_false
+      end
+
+      context "when an existing version of a file exists in the cache" do
+
+        let(:files) { [version_one] }
+
+        it "returns true if the given version is the same" do
+          subject.has_file?(version_one).should be_true
+        end
+      end
+    end
+
+    describe "#has_version?" do
+
+      it "returns false by default" do
+        subject.has_version?(version_one).should be_false
+        subject.has_version?(version_two).should be_false
+      end
+
+      context "when an existing version of a file exists in the cache" do
+
+        let(:files) { [version_one] }
+
+        it "returns false if the given version is different" do
+          subject.has_version?(version_two).should be_false
+        end
+
+        it "returns true if the given version is the same" do
+          subject.has_version?(version_one).should be_true
+        end
+      end
+    end
+
+    describe "#has_conflict?" do
+
+      it "returns false by default" do
+        subject.has_conflict?(version_one).should be_false
+        subject.has_conflict?(version_two).should be_false
+      end
+
+      context "when an existing version of a file exists in the cache" do
+
+        let(:files) { [version_one] }
+
+        it "returns false when the given version is the same" do
+          subject.has_conflict?(version_one).should be_false
+        end
+
+        it "returns true when the given version is different" do
+          subject.has_conflict?(version_two).should be_true
+        end
+
+      end
+
+    end
+  end
+end

data/spec/uploadable_spec.rb

@@ -68,6 +68,23 @@ describe StaticSync::Uploadable do
 
   end
 
+  describe "#cached?" do
+    it "returns false by default" do
+      subject.cached?.should be_false
+    end
+
+    context "when caching is enabled for html" do
+
+      before do
+        config['cache'] = { 'html' => '86400' }
+      end
+
+      it "returns true for a html file" do
+        html_file.cached?.should be_true
+      end
+    end
+  end
+
   describe "#cache_time" do
 
     context "when caching is disabled" do
@@ -76,7 +93,7 @@ describe StaticSync::Uploadable do
         config['cache'] = { }
       end
 
-      it "is nil for html files" do
+      it "returns nil for a html file" do
         html_file.cache_time.should be_nil
       end
     end
@@ -87,15 +104,15 @@ describe StaticSync::Uploadable do
         config['cache'] = { 'html' => '86400' }
       end
 
-      it "is the configured value for html files" do
+      it "returns the configured value for html files" do
         html_file.cache_time.should == 86400
       end
 
-      it "is the configured value for text files" do
+      it "returns the configured value for text files" do
         text_file.cache_time.should be_nil
       end
 
-      it "is nil for css files" do
+      it "returns nil for css files" do
         css_file.cache_time.should be_nil
       end
     end
@@ -106,11 +123,11 @@ describe StaticSync::Uploadable do
         config['cache'] = { 'image' => '86400' }
       end
 
-      it "is the configured value for gif files" do
+      it "returns the configured value for gif files" do
         gif_file.cache_time.should == 86400
       end
 
-      it "is the configured value for png files" do
+      it "returns the configured value for png files" do
         png_file.cache_time.should == 86400
       end
     end
@@ -119,11 +136,11 @@ describe StaticSync::Uploadable do
 
   describe "#gzipped?" do
 
-    it "is true for html files" do
+    it "returns true for html files" do
       html_file.gzipped?.should be_true
     end
 
-    it "is false for png files" do
+    it "returns false for png files" do
       png_file.gzipped?.should be_false
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -77,6 +77,7 @@ files:
 - lib/static_sync/config.rb
 - lib/static_sync/processor.rb
 - lib/static_sync/storage.rb
+- lib/static_sync/storage_cache.rb
 - lib/static_sync/uploadable.rb
 - lib/static_sync/version.rb
 - spec/fixtures/site/assets/images/spinner.gif
@@ -86,6 +87,7 @@ files:
 - spec/fixtures/site/cat.com/index.html
 - spec/fixtures/site/index.html
 - spec/processor_spec.rb
+- spec/storage_cache_spec.rb
 - spec/uploadable_spec.rb
 - static_sync.gemspec
 homepage: 
@@ -114,4 +116,5 @@ specification_version: 3
 summary: Command line tool for uploading static websites to amazon/rackspace.
 test_files:
 - spec/processor_spec.rb
+- spec/storage_cache_spec.rb
 - spec/uploadable_spec.rb