middleman-s3_sync 3.0.47 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b9818aa4b2d7384ea359655f3ac8a3b051fafbd
-  data.tar.gz: 8416884e3a0bcd584f82f144e3a0d480780ae6af
+  metadata.gz: 0ea0d9098ccfca7a420089e791da7f7881298c5c
+  data.tar.gz: 93b501fb586db5be0cd329c448ac2edb5da3c044
 SHA512:
-  metadata.gz: 63ee52ab134fc7aff450acb5dcf5d865639ea163b948c5a8b430000f09216fc523eb9267f774379f85e4b4e27c62a5892a068737bf9b081b62a3a73f44eb30d4
-  data.tar.gz: d65744542b6d42817502f101b174cee9bc5893cbb5061a6a41b4b161ca1ad0d2859f80f60c6b78585344e4dd85805b8abe2467d4e14016d7662b500fe9837505
+  metadata.gz: 1d4b328645fe0171b6b5f01c0b0f2f19428c17a06b0e0af8bfa9b908763982e5a12b52b2c33e7b1a57b4e7e6bdd424ae27e302d97b17db7a8f08654868239615
+  data.tar.gz: 9d427de8aca80db2ff476dc42da6a2fc11bb769651c8f16a24780dbc0b9a9ae51459a038ae8c85abff8a45c5728d511791254bdc8566368f8d066a1d0089453a

data/.travis.yml

@@ -1,10 +1,11 @@
 ---
 language: ruby
+sudo: false
+cache: bundler
 rvm:
-- 1.9.3
 - 2.0.0
 - 2.1.5
-- 2.2.1
+- 2.2.3
 
 notifications:
   webhooks:

data/lib/middleman-s3_sync.rb

@@ -1,7 +1,8 @@
 require 'middleman-core'
+require 'middleman-s3_sync/commands'
 require 'middleman/s3_sync'
 
-::Middleman::Extensions.register(:s3_sync, '>= 3.0.0') do
-  ::Middleman::S3Sync
+::Middleman::Extensions.register(:s3_sync) do
+  require 'middleman-s3_sync/extension'
+  ::Middleman::S3SyncExtension
 end
-

data/lib/middleman-s3_sync/commands.rb

@@ -2,6 +2,8 @@ require 'middleman-core/cli'
 
 module Middleman
   module Cli
+    Base.map("sync" => "s3_sync")
+
     class S3Sync < Thor
       include Thor::Actions
 
@@ -13,11 +15,11 @@ module Middleman
         true
       end
 
-      desc "s3_sync", "Pushes the minimum set of files needed to S3"
-      method_option :force, type: :boolean,
+      desc "s3_sync [options]", "Synchronizes a middleman site to an AWS S3 bucket"
+      class_option :force, type: :boolean,
         desc: "Push all local files to the server",
         aliases: '-f'
-      method_option :bucket, type: :string,
+      class_option :bucket, type: :string,
         desc: "Specify which bucket to use, overrides the configured bucket.",
         aliases: '-b'
       method_option :prefix, type: :string,
@@ -26,25 +28,31 @@ module Middleman
       method_option :verbose, type: :boolean,
         desc: "Adds more verbosity...",
         aliases: '-v'
+      class_option :dry_run, type: :boolean,
+        desc: "Performs a dry run of the sync",
+        aliases: '-n'
 
       def s3_sync
-        shared_inst = ::Middleman::Application.server.inst
-        bucket = shared_inst.s3_sync_options.bucket rescue nil
+        ::Middleman::S3Sync.app = ::Middleman::Application.server.inst
+
+        s3_sync_options = ::Middleman::S3Sync.s3_sync_options
+
+        bucket = s3_sync_options.bucket rescue nil
+
         unless bucket
           raise Thor::Error.new "You need to activate the s3_sync extension and at least provide the bucket name."
         end
 
-        s3_sync_options = shared_inst.s3_sync_options
 
         # Override options based on what was passed on the command line...
         s3_sync_options.force = options[:force] if options[:force]
         s3_sync_options.bucket = options[:bucket] if options[:bucket]
         s3_sync_options.verbose = options[:verbose] if options[:verbose]
         s3_sync_options.prefix  = options[:prefix] if options[:prefix]
+        s3_sync_options.dry_run = options[:dry_run] if options[:dry_run]
 
-        ::Middleman::S3Sync.sync(s3_sync_options)
+        ::Middleman::S3Sync.sync()
       end
     end
-    Base.map('sync' => 's3_sync')
   end
 end

data/lib/middleman-s3_sync/extension.rb

@@ -1,59 +1,96 @@
 require 'middleman-core'
+require 'middleman/s3_sync'
 require 'map'
 
 module Middleman
-  module S3Sync
-    class << self
-      attr_accessor :options
+  class S3SyncExtension < Extension
+    # Options supported by the extension...
+    option :prefix, nil, 'Path prefix of the resource we are looking for on the server.'
+    option :http_prefix, nil, 'Path prefix of the resources'
+    option :acl, 'public-read', 'ACL for the resources being pushed to S3'
+    option :bucket, 'nil', 'The name of the bucket we are pushing to.'
+    option :region, 'us-east-1', 'The name of the AWS region hosting the S3 bucket'
+    option :aws_access_key_id, ENV['AWS_ACCESS_KEY_ID'] , 'The AWS access key id'
+    option :aws_secret_access_key, ENV['AWS_SECRET_ACCESS_KEY'], 'The AWS secret access key'
+    option :after_build, false, 'Whether to synchronize right after the build'
+    option :build_dir, nil, 'Where the built site is stored'
+    option :delete, true, 'Whether to delete resources that do not have a local equivalent'
+    option :encryption, false, 'Whether to encrypt the content on the S3 bucket'
+    option :force, false, 'Whether to push all current resources to S3'
+    option :prefer_gzip, true, 'Whether to push the compressed version of the resource to S3'
+    option :reduced_redundancy_storage, nil, 'Whether to use the reduced redundancy storage option'
+    option :path_style, true, 'Whether to use path_style URLs to communiated with S3'
+    option :version_bucket, false, 'Whether to enable versionning on the S3 bucket content'
+    option :verbose, false, 'Whether to provide more verbose output'
+    option :dry_run, false, 'Whether to perform a dry-run'
 
-      def registered(app, options_hash = {}, &block)
-        options = Options.new
-        yield options if block_given?
+    def initialize(app, options_hash = {}, &block)
+      super
+      app.define_hook :after_s3_sync
+      # Temporary workaround for 3.3 and 3.4.
+      app.send :include, ClassMethods
+    end
+
+    def after_configuration
+      read_config
+      options.aws_access_key_id ||= ENV['AWS_ACCESS_KEY_ID']
+      options.aws_secret_access_key ||= ENV['AWS_SECRET_ACCESS_KEY']
+      options.http_prefix = app.http_prefix if app.respond_to? :http_prefix
+      options.build_dir ||= app.build_dir if app.respond_to? :build_dir
+      ::Middleman::S3Sync.s3_sync_options = s3_sync_options
+    end
 
-        @options = options
+    def after_build
+      ::Middleman::S3Sync.sync() if options.after_build
+    end
 
-        app.send :include, Helpers
+    def manipulate_resource_list(mm_resources)
+      ::Middleman::S3Sync.mm_resources = mm_resources
+    end
 
-        app.define_hook :after_s3_sync
+    def s3_sync_options
+      options
+    end
 
-        app.after_configuration do |config|
-          # Record the http_prefix if it is set. We will need it while setting
-          # the options to detect whether it is set and adjust the prefix value
-          # accordingly
-          options.http_prefix = app.respond_to? :http_prefix ? app.http_prefix : nil
+    # Read config options from an IO stream and set them on `self`. Defaults
+    # to reading from the `.s3_sync` file in the MM project root if it exists.
+    #
+    # @param io [IO] an IO stream to read from
+    # @return [void]
+    def read_config(io = nil)
+      unless io
+        root_path = ::Middleman::Application.root
+        config_file_path = File.join(root_path, ".s3_sync")
 
-          # Define the after_build step after during configuration so
-          # that it's pushed to the end of the callback chain
-          app.after_build do |builder|
-            ::Middleman::S3Sync.sync(options) if options.after_build
-          end
+        # skip if config file does not exist
+        return unless File.exists?(config_file_path)
 
-          options.build_dir ||= build_dir
-        end
+        io = File.open(config_file_path, "r")
       end
-      alias :included :registered
 
-      def s3_sync_options
-        @options
-      end
+      config = YAML.load(io).symbolize_keys
 
-      def s3_sync_options=(options)
-        @options = options
+      OPTIONS.each do |config_option|
+        self.send("#{config_option}=".to_sym, config[config_option]) if config[config_option]
       end
+    end
 
-      module Helpers
-        def s3_sync_options
-          ::Middleman::S3Sync.s3_sync_options
-        end
 
-        def default_caching_policy(policy = {})
-          s3_sync_options.add_caching_policy(:default, policy)
-        end
+    module ClassMethods
+      def s3_sync_options
+        ::Middleman::S3SyncExtension.s3_sync_options
+      end
 
-        def caching_policy(content_type, policy = {})
-          s3_sync_options.add_caching_policy(content_type, policy)
-        end
+      def default_caching_policy(policy = {})
+        ::Middleman::S3Sync.add_caching_policy(:default, policy)
+      end
+
+      def caching_policy(content_type, policy = {})
+        ::Middleman::S3Sync.add_caching_policy(content_type, policy)
       end
     end
   end
+
+  ::Middleman::Extensions.register(:s3_sync, S3SyncExtension)
 end
+

data/lib/middleman/s3_sync.rb

@@ -1,12 +1,13 @@
 require 'fog/aws'
-require 'pmap'
+require 'fog/aws/storage'
 require 'digest/md5'
 require 'middleman/s3_sync/version'
 require 'middleman/s3_sync/options'
-require 'middleman-s3_sync/commands'
+require 'middleman/s3_sync/caching_policy'
 require 'middleman/s3_sync/status'
 require 'middleman/s3_sync/resource'
 require 'middleman-s3_sync/extension'
+require 'parallel'
 require 'ruby-progressbar'
 require 'thread'
 
@@ -14,20 +15,23 @@ module Middleman
   module S3Sync
     class << self
       include Status
+      include CachingPolicy
+
       @@bucket_lock = Mutex.new
       @@bucket_files_lock = Mutex.new
 
-      def sync(options)
-        @app = ::Middleman::Application.server.inst
-
-        self.s3_sync_options = options
+      attr_accessor :s3_sync_options
+      attr_accessor :mm_resources
+      attr_reader   :app
 
+      def sync()
+        say_status "Let's see if there's work to be done..."
         unless work_to_be_done?
-          say_status "\nAll S3 files are up to date."
+          say_status "All S3 files are up to date."
           return
         end
 
-        say_status "\nReady to apply updates to #{s3_sync_options.bucket}."
+        say_status "Ready to apply updates to #{s3_sync_options.bucket}."
 
         update_bucket_versioning
 
@@ -36,7 +40,7 @@ module Middleman
         update_resources
         delete_resources
 
-        @app.run_hook :after_s3_sync, ignored: files_to_ignore.map(&:path),
+        app.run_hook :after_s3_sync, ignored: files_to_ignore.map(&:path),
                                       created: files_to_create.map(&:path),
                                       updated: files_to_update.map(&:path),
                                       deleted: files_to_delete.map(&:path)
@@ -52,13 +56,29 @@ module Middleman
         end
       end
 
+      def add_local_resource(mm_resource)
+        s3_sync_resources[mm_resource.destination_path] = S3Sync::Resource.new(mm_resource, remote_resource_for_path(mm_resource.destination_path)).tap(&:status)
+      end
+
+      def remote_only_paths
+        paths - s3_sync_resources.keys
+      end
+
+      def app=(app)
+        @app = app
+        @app.extend ::Middleman::S3SyncExtension::ClassMethods
+      end
+
+      def content_types
+        @content_types || {}
+      end
+
       protected
       def update_bucket_versioning
         connection.put_bucket_versioning(s3_sync_options.bucket, "Enabled") if s3_sync_options.version_bucket
       end
 
       def connection
-
         connection_options = {
           :region => s3_sync_options.region,
           :path_style => s3_sync_options.path_style
@@ -76,37 +96,20 @@ module Middleman
         @connection ||= Fog::Storage::AWS.new(connection_options)
       end
 
-      def resources
-        @resources ||= paths.pmap(32) do |p|
-          progress_bar.increment
-          S3Sync::Resource.new(p, bucket_files.find { |f| f.key == "#{s3_sync_options.prefix}#{p}" }).tap(&:status)
-        end
+      def remote_resource_for_path(path)
+        bucket_files.find { |f| f.key == "#{s3_sync_options.prefix}#{path}" }
       end
 
-      def progress_bar
-        @progress_bar ||= ProgressBar.create(total: paths.length)
+      def s3_sync_resources
+        @s3_sync_resources ||= {}
       end
 
       def paths
         @paths ||= begin
-                     say_status "Gathering the paths to evaluate."
-                     (remote_paths.map { |rp| rp.gsub(/^#{s3_sync_options.prefix}/, '')} + local_paths).uniq.sort
+                     (remote_paths.map { |rp| rp.gsub(/^#{s3_sync_options.prefix}/, '')} + s3_sync_resources.keys).uniq.sort
                    end
       end
 
-      def local_paths
-        @local_paths ||= begin
-                           local_paths = (Dir[build_dir + "/**/*"] + Dir[build_dir + "/**/.*"])
-                                           .reject { |p| File.directory?(p) }
-
-                           if s3_sync_options.prefer_gzip
-                             local_paths.reject! { |p| p =~ /\.gz$/ && File.exist?(p.gsub(/\.gz$/, '')) }
-                           end
-
-                           local_paths.pmap(32) { |p| p.gsub(/#{build_dir}\//, '') }
-                         end
-      end
-
       def remote_paths
         @remote_paths ||= if s3_sync_options.delete
                             bucket_files.map(&:key)
@@ -150,27 +153,33 @@ module Middleman
       end
 
       def work_to_be_done?
+        Parallel.each(mm_resources, in_threads: 8, progress: "Processing sitemap") { |mm_resource| add_local_resource(mm_resource) }
+
+        Parallel.each(remote_only_paths, in_threads: 8, progress: "Processing remote files") do |remote_path|
+          s3_sync_resources[remote_path] ||= S3Sync::Resource.new(nil, remote_resource_for_path(remote_path)).tap(&:status)
+        end
+
         !(files_to_create.empty? && files_to_update.empty? && files_to_delete.empty?)
       end
 
       def files_to_delete
-        @files_to_delete ||= if s3_sync_options.delete
-                                 resources.select { |r| r.to_delete? }
-                             else
-                               []
-                             end
+        if s3_sync_options.delete
+          s3_sync_resources.values.select { |r| r.to_delete? }
+        else
+          []
+        end
       end
 
       def files_to_create
-        @files_to_create ||= resources.select { |r| r.to_create? }
+        s3_sync_resources.values.select { |r| r.to_create? }
       end
 
       def files_to_update
-        @files_to_update ||= resources.select { |r| r.to_update? }
+        s3_sync_resources.values.select { |r| r.to_update? }
       end
 
       def files_to_ignore
-        @files_to_ignore ||= resources.select { |r| r.to_ignore? }
+        s3_sync_resources.values.select { |r| r.to_ignore? }
       end
 
       def build_dir

data/lib/middleman/s3_sync/caching_policy.rb

@@ -0,0 +1,58 @@
+require 'map'
+
+module Middleman
+  module S3Sync
+    module CachingPolicy
+      def add_caching_policy(content_type, options)
+        caching_policies[content_type.to_s] = BrowserCachePolicy.new(options)
+      end
+
+      def caching_policy_for(content_type)
+        caching_policies.fetch(content_type.to_s, caching_policies[:default])
+      end
+
+      def default_caching_policy
+        caching_policies[:default]
+      end
+
+      def caching_policies
+        @caching_policies ||= Map.new
+      end
+    end
+
+    class BrowserCachePolicy
+      attr_accessor :policies
+
+      def initialize(options = {})
+        @policies = Map.from_hash(options)
+      end
+
+      def cache_control
+        policy = []
+        policy << "max-age=#{policies.max_age}" if policies.has_key?(:max_age)
+        policy << "s-maxage=#{policies.s_maxage}" if policies.has_key?(:s_maxage)
+        policy << "public" if policies.fetch(:public, false)
+        policy << "private" if policies.fetch(:private, false)
+        policy << "no-cache" if policies.fetch(:no_cache, false)
+        policy << "no-store" if policies.fetch(:no_store, false)
+        policy << "must-revalidate" if policies.fetch(:must_revalidate, false)
+        policy << "proxy-revalidate" if policies.fetch(:proxy_revalidate, false)
+        if policy.empty?
+          nil
+        else
+          policy.join(", ")
+        end
+      end
+
+      def to_s
+        cache_control
+      end
+
+      def expires
+        if expiration = policies.fetch(:expires, nil)
+          CGI.rfc1123_date(expiration)
+        end
+      end
+    end
+  end
+end

data/lib/middleman/s3_sync/options.rb

@@ -19,36 +19,16 @@ module Middleman
         :reduced_redundancy_storage,
         :path_style,
         :version_bucket,
+        :dry_run,
         :verbose,
         :content_types
       ]
       attr_accessor *OPTIONS
 
-      def initialize
-        # read config from .s3_sync on initialization
-        self.read_config
-      end
-
       def acl
         @acl || 'public-read'
       end
 
-      def add_caching_policy(content_type, options)
-        caching_policies[content_type.to_s] = BrowserCachePolicy.new(options)
-      end
-
-      def caching_policy_for(content_type)
-        caching_policies.fetch(content_type.to_s, caching_policies[:default])
-      end
-
-      def default_caching_policy
-        caching_policies[:default]
-      end
-
-      def caching_policies
-        @caching_policies ||= Map.new
-      end
-
       def aws_access_key_id=(aws_access_key_id)
         @aws_access_key_id = aws_access_key_id if aws_access_key_id
       end
@@ -95,75 +75,13 @@ module Middleman
       end
 
       def prefix
-        @prefix.blank? ? "" : "#{@prefix}/"
+        @prefix.nil? || @prefix.empty? ? "" : "#{@prefix}/"
       end
 
       def version_bucket
         @version_bucket.nil? ? false : @version_bucket
       end
 
-      def content_types
-        @content_types || {}
-      end
-
-      # Read config options from an IO stream and set them on `self`. Defaults
-      # to reading from the `.s3_sync` file in the MM project root if it exists.
-      #
-      # @param io [IO] an IO stream to read from
-      # @return [void]
-      def read_config(io = nil)
-        unless io
-          root_path = ::Middleman::Application.root
-          config_file_path = File.join(root_path, ".s3_sync")
-
-          # skip if config file does not exist
-          return unless File.exists?(config_file_path)
-
-          io = File.open(config_file_path, "r")
-        end
-
-        config = YAML.load(io).symbolize_keys
-
-        OPTIONS.each do |config_option|
-          self.send("#{config_option}=".to_sym, config[config_option]) if config[config_option]
-        end
-      end
-
-      protected
-      class BrowserCachePolicy
-        attr_accessor :policies
-
-        def initialize(options)
-          @policies = Map.from_hash(options)
-        end
-
-        def cache_control
-          policy = []
-          policy << "max-age=#{policies.max_age}" if policies.has_key?(:max_age)
-          policy << "s-maxage=#{policies.s_maxage}" if policies.has_key?(:s_maxage)
-          policy << "public" if policies.fetch(:public, false)
-          policy << "private" if policies.fetch(:private, false)
-          policy << "no-cache" if policies.fetch(:no_cache, false)
-          policy << "no-store" if policies.fetch(:no_store, false)
-          policy << "must-revalidate" if policies.fetch(:must_revalidate, false)
-          policy << "proxy-revalidate" if policies.fetch(:proxy_revalidate, false)
-          if policy.empty?
-            nil
-          else
-            policy.join(", ")
-          end
-        end
-
-        def to_s
-          cache_control
-        end
-
-        def expires
-          if expiration = policies.fetch(:expires, nil)
-            CGI.rfc1123_date(expiration)
-          end
-        end
-      end
     end
   end
 end

data/lib/middleman/s3_sync/resource.rb

@@ -1,14 +1,15 @@
 module Middleman
   module S3Sync
     class Resource
-      attr_accessor :path, :partial_s3_resource, :full_s3_resource, :content_type, :gzipped, :options
+      attr_accessor :path, :resource, :partial_s3_resource, :full_s3_resource, :content_type, :gzipped, :options
 
       CONTENT_MD5_KEY = 'x-amz-meta-content-md5'
 
       include Status
 
-      def initialize(path, partial_s3_resource)
-        @path = path
+      def initialize(resource, partial_s3_resource)
+        @resource = resource
+        @path = resource ? resource.destination_path : partial_s3_resource.key
         @partial_s3_resource = partial_s3_resource
       end
 
@@ -61,7 +62,7 @@ module Middleman
           s3_resource.merge_attributes(to_h)
           s3_resource.body = body
 
-          s3_resource.save
+          s3_resource.save unless options.dry_run
         }
       end
 
@@ -76,23 +77,23 @@ module Middleman
 
       def destroy!
         say_status ANSI.red { "Deleting" } + " " + remote_path
-        bucket.files.destroy remote_path
+        bucket.files.destroy remote_path unless options.dry_run
       end
 
       def create!
         say_status ANSI.green { "Creating" } + " #{remote_path}#{ gzipped ? ANSI.white {' (gzipped)'} : ''}"
         local_content { |body|
-          bucket.files.create(to_h.merge(body: body))
+          bucket.files.create(to_h.merge(body: body)) unless options.dry_run
         }
       end
 
       def ignore!
-        reason = if redirect?
-                   :redirect
-                 elsif directory?
-                   :directory
-                 end
         if options.verbose
+          reason = if redirect?
+                     :redirect
+                   elsif directory?
+                     :directory
+                   end
           say_status ANSI.yellow {"Ignoring"} + " #{remote_path} #{ reason ? ANSI.white {"(#{reason})" } : "" }"
         end
       end
@@ -135,6 +136,8 @@ module Middleman
                     elsif local? && remote?
                       if options.force
                         :updated
+                      elsif not caching_policy_match?
+                        :updated
                       elsif local_object_md5 == remote_object_md5
                         :identical
                       else
@@ -155,8 +158,10 @@ module Middleman
                       :new
                     elsif remote? && redirect?
                       :ignored
-                    else
+                    elsif remote?
                       :deleted
+                    else
+                      :ignored
                     end
       end
 
@@ -205,12 +210,20 @@ module Middleman
       end
 
       def content_type
-        @content_type ||= options.content_types[path]
-        @content_type ||= MIME::Types.of(path).first
+        @content_type ||= Middleman::S3Sync.content_types[path]
+        @content_type ||= resource.content_type
       end
 
       def caching_policy
-        @caching_policy ||= options.caching_policy_for(content_type)
+        @caching_policy ||= Middleman::S3Sync.caching_policy_for(content_type)
+      end
+
+      def caching_policy_match?
+        if (caching_policy)
+          caching_policy.cache_control == full_s3_resource.cache_control
+        else
+          true
+        end
       end
 
       protected

data/lib/middleman/s3_sync/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module S3Sync
-    VERSION = "3.0.47"
+    VERSION = "3.3.0"
   end
 end

data/middleman-s3_sync.gemspec

@@ -18,19 +18,20 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'middleman-core', '>= 3.0.0'
+  gem.add_runtime_dependency 'middleman-core', '~> 3.3'
   gem.add_runtime_dependency 'unf'
   gem.add_runtime_dependency 'fog-aws', '>= 0.1.1'
   gem.add_runtime_dependency 'map'
-  gem.add_runtime_dependency 'pmap'
+  gem.add_runtime_dependency 'parallel'
   gem.add_runtime_dependency 'ruby-progressbar'
   gem.add_runtime_dependency 'ansi', '~> 1.5.0'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'pry-nav'
+  gem.add_development_dependency 'pry-byebug'
   gem.add_development_dependency 'rspec', '>= 3.0.0'
   gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'rspec-mocks'
   gem.add_development_dependency 'timerizer'
   gem.add_development_dependency 'travis'
   gem.add_development_dependency 'travis-lint'

data/spec/caching_policy_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'middleman/s3_sync/caching_policy'
+
+describe Middleman::S3Sync::BrowserCachePolicy do
+  let(:options) { Hash.new }
+  subject(:policy) { Middleman::S3Sync::BrowserCachePolicy.new(options) }
+
+  it "should be blank" do
+    policy.should_not be_nil
+
+    policy.to_s.should_not =~ /max-age=/
+    policy.to_s.should_not =~ /s-maxage=/
+    policy.to_s.should_not =~ /public/
+    policy.to_s.should_not =~ /private/
+    policy.to_s.should_not =~ /no-cache/
+    policy.to_s.should_not =~ /no-store/
+    policy.to_s.should_not =~ /must-revalidate/
+    policy.to_s.should_not =~ /proxy-revalidate/
+    policy.expires.should be_nil
+  end
+
+  context "setting max-age" do
+    let(:options) { { max_age: 300 } }
+
+    its(:to_s) { should =~ /max-age=300/ }
+  end
+
+  context "setting s-maxage" do
+    let(:options) { { s_maxage: 300 } }
+
+    its(:to_s) { should =~ /s-maxage=300/ }
+  end
+
+  context "set public flag" do
+    let(:options) { { public: true } }
+    its(:to_s) { should =~ /public/ }
+  end
+
+  context "it should set the private flag if it is set to true" do
+    let(:options) { { private: true } }
+    its(:to_s) { should =~ /private/ }
+  end
+
+  context "it should set the no-cache flag when set property" do
+    let(:options) { { no_cache: true }}
+    its(:to_s) { should =~ /no-cache/ }
+  end
+
+  context "setting the no-store flag" do
+    let(:options) { { no_store: true } }
+    its(:to_s) { should =~ /no-store/ }
+  end
+
+  context "setting the must-revalidate policy" do
+    let(:options) { { must_revalidate: true } }
+    its(:to_s) { should =~ /must-revalidate/ }
+  end
+
+  context "setting the proxy-revalidate policy" do
+    let(:options) { { proxy_revalidate: true } }
+    its(:to_s) { should =~ /proxy-revalidate/ }
+  end
+
+  context "divide caching policiies with a comma and a space" do
+    let(:options) { { :max_age => 300, :public => true } }
+
+    it "splits policies eith commans and spaces" do
+      policies = policy.to_s.split(/, /)
+      policies.length.should == 2
+      policies.first.should == 'max-age=300'
+      policies.last.should == 'public'
+    end
+  end
+
+  context "set the expiration date" do
+    let(:options) { { expires: 1.years.from_now } }
+
+    its(:expires) { should == CGI.rfc1123_date(1.year.from_now )}
+  end
+end

data/spec/resource_spec.rb

@@ -6,14 +6,19 @@ describe Middleman::S3Sync::Resource do
     Middleman::S3Sync::Options.new
   }
 
+  let(:mm_resource) {
+    double(
+      destination_path: 'path/to/resource.html'
+    )
+  }
   before do
-    Middleman::S3Sync.options = options
+    Middleman::S3Sync.s3_sync_options = options
     options.build_dir = "build"
     options.prefer_gzip = false
   end
 
   context "a new resource" do
-    subject(:resource) { Middleman::S3Sync::Resource.new('path/to/resource.html', nil) }
+    subject(:resource) { Middleman::S3Sync::Resource.new(mm_resource, nil) }
 
     context "without a prefix" do
       before do
@@ -75,14 +80,17 @@ describe Middleman::S3Sync::Resource do
   end
 
   context "the file does not exist locally" do
-    subject(:resource) { Middleman::S3Sync::Resource.new('path/to/resource.html', remote) }
+    subject(:resource) { Middleman::S3Sync::Resource.new(nil, remote) }
 
-    let(:remote) { double("remote") }
+    let(:remote) {
+      double(
+        key: 'path/to/resource.html',
+        metadata: {}
+      )
+    }
 
     before do
-        allow(remote).to receive(:key).and_return('path/to/resource.html')
-        allow(remote).to receive(:metadata).and_return({})
-        resource.full_s3_resource = remote
+      resource.full_s3_resource = remote
     end
 
     context "without a prefix" do
@@ -116,7 +124,7 @@ describe Middleman::S3Sync::Resource do
         expect(resource).to be_remote
       end
 
-      it "exists locally" do
+      it "does not exist locally" do
         expect(resource).not_to be_local
       end
 

data/spec/spec_helper.rb

@@ -10,7 +10,6 @@ require 'timerizer'
 require 'rspec/its'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-s3_sync
 version: !ruby/object:Gem::Version
-  version: 3.0.47
+  version: 3.3.0
 platform: ruby
 authors:
 - Frederic Jean
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: unf
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pmap
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-nav
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,6 +179,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timerizer
   requirement: !ruby/object:Gem::Requirement
@@ -241,13 +255,14 @@ files:
 - lib/middleman-s3_sync/commands.rb
 - lib/middleman-s3_sync/extension.rb
 - lib/middleman/s3_sync.rb
+- lib/middleman/s3_sync/caching_policy.rb
 - lib/middleman/s3_sync/options.rb
 - lib/middleman/s3_sync/resource.rb
 - lib/middleman/s3_sync/status.rb
 - lib/middleman/s3_sync/version.rb
 - lib/middleman_extension.rb
 - middleman-s3_sync.gemspec
-- spec/options_spec.rb
+- spec/caching_policy_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/fredjean/middleman-s3_sync
@@ -275,6 +290,6 @@ signing_key:
 specification_version: 4
 summary: Tries really, really hard not to push files to S3.
 test_files:
-- spec/options_spec.rb
+- spec/caching_policy_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb

data/spec/options_spec.rb

@@ -1,130 +0,0 @@
-require 'spec_helper'
-require 'middleman/s3_sync/options'
-
-describe Middleman::S3Sync::Options do
-  subject(:options) { Middleman::S3Sync::Options.new }
-
-  its(:delete) { is_expected.to eq(true) }
-  its(:after_build) { is_expected.to eq(false)}
-  its(:prefer_gzip) { is_expected.to eq(true) }
-  its(:aws_secret_access_key) { is_expected.to eq(ENV['AWS_SECRET_ACCESS_KEY']) }
-  its(:aws_access_key_id) { is_expected.to eq(ENV['AWS_ACCESS_KEY_ID']) }
-  its(:caching_policies) { is_expected.to be_empty }
-  its(:default_caching_policy) { is_expected.to be_nil }
-
-  context "browser caching policy" do
-    let(:policy) { options.default_caching_policy }
-
-    it "should have a blank default caching policy" do
-      options.add_caching_policy :default, {}
-
-      policy.should_not be_nil
-
-      policy.to_s.should_not =~ /max-age=/
-      policy.to_s.should_not =~ /s-maxage=/
-      policy.to_s.should_not =~ /public/
-      policy.to_s.should_not =~ /private/
-      policy.to_s.should_not =~ /no-cache/
-      policy.to_s.should_not =~ /no-store/
-      policy.to_s.should_not =~ /must-revalidate/
-      policy.to_s.should_not =~ /proxy-revalidate/
-      policy.expires.should be_nil
-    end
-
-    it "should set the max-age policy" do
-      options.add_caching_policy :default, :max_age => 300
-
-      policy.to_s.should =~ /max-age=300/
-    end
-
-    it "should set the s-maxage policy" do
-      options.add_caching_policy :default, :s_maxage => 300
-
-      policy.to_s.should =~ /s-maxage=300/
-    end
-
-    it "should set the public flag on the policy if set to true" do
-      options.add_caching_policy :default, :public => true
-
-      policy.to_s.should =~ /public/
-    end
-
-    it "should not set the public flag on the policy if it is set to false" do
-      options.add_caching_policy :default, :public => false
-
-      policy.to_s.should_not =~ /public/
-    end
-
-    it "should set the private flag on the policy if it is set to true" do
-      options.add_caching_policy :default, :private => true
-
-      policy.to_s.should =~ /private/
-    end
-
-    it "should set the no-cache flag on the policy if it is set to true" do
-      options.add_caching_policy :default, :no_cache => true
-
-      policy.to_s.should =~ /no-cache/
-    end
-
-    it "should set the no-store flag if it is set to true" do
-      options.add_caching_policy :default, :no_store => true
-
-      policy.to_s.should =~ /no-store/
-    end
-
-    it "should set the must-revalidate policy if it is set to true" do
-      options.add_caching_policy :default, :must_revalidate => true
-
-      policy.to_s.should =~ /must-revalidate/
-    end
-
-    it "should set the proxy-revalidate policy if it is set to true" do
-      options.add_caching_policy :default, :proxy_revalidate => true
-
-      policy.to_s.should =~ /proxy-revalidate/
-    end
-
-    it "should divide caching policies with commas and a space" do
-      options.add_caching_policy :default, :max_age => 300, :public => true
-
-      policies = policy.to_s.split(/, /)
-      policies.length.should == 2
-      policies.first.should == 'max-age=300'
-      policies.last.should == 'public'
-    end
-
-    it "should set the expiration date" do
-      expiration = 1.years.from_now
-
-      options.add_caching_policy :default, :expires => expiration
-      policy.expires.should == CGI.rfc1123_date(expiration)
-    end
-  end
-
-  context "#read_config" do
-    let(:aws_access_key_id) { "foo" }
-    let(:aws_secret_access_key) { "bar" }
-    let(:bucket) { "baz" }
-    let(:config) { { "aws_access_key_id" => aws_access_key_id, "aws_secret_access_key" => aws_secret_access_key, "bucket" => bucket } }
-    let(:file) { StringIO.new(YAML.dump(config)) }
-
-    before do
-      options.read_config(file)
-    end
-
-    its(:aws_access_key_id) { should eq(aws_access_key_id) }
-    its(:aws_secret_access_key) { should eq(aws_secret_access_key) }
-    its(:bucket) { should eq(bucket) }
-  end
-
-  context "prefix with http_prefix" do
-    before do
-      options.http_prefix = "/blog"
-      options.prefix = "blog"
-    end
-
-    its(:prefix) { should eq("")}
-  end
-
-end