branchable_cdn_assets-middleman 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c130145cf4f67c1f884a85a31cc1e24abaa68b5a
-  data.tar.gz: 8c26d06ccb56d4890f7ea8bd7e04be6c0d63ee02
+  metadata.gz: db8030ec152bd0407e74c622d95d127cecebe65e
+  data.tar.gz: 1a59b0c2b966dfe40f48073ea600199dfbcea039
 SHA512:
-  metadata.gz: 85e82fe4001cdc02abf6c2d34eb53ff9621507b36cfe47f86b9824fa591c5cd2ef3c02ad0d90e0cf944ce843bbcd98af9dd779aeabe5e297af10b1934b652c79
-  data.tar.gz: f8b9d059cc4cef0e02e4b3c6936d48a85eee79f3b2be4aa7bd594460147bc5f45af12dfa9467d146391f49a12fb8eea593cb362879303f8d1c9e9ceff612d178
+  metadata.gz: 983fedb01fa253045cfc846fa871b47ce48566ceb19452a6019b9c3decfb86fd61ff2c83c2f32b964651c2031ff34721c02d233d47936208a9f94b9bcbfc4381
+  data.tar.gz: a72ae5b031b45fc52149b784aee430f289dc6e68d023f3a7ec4b805bee2be0662d5b03714d5a8b98dd50b12ad7ac0b4557669e90dfc10f8bd8c3007e6508caee

data/lib/branchable_cdn_assets/middleman/extension.rb

@@ -2,12 +2,16 @@ module BranchableCDNAssets
   module Middleman
 
     class Extension < ::Middleman::Extension
+      self.supports_multiple_instances = true
 
-      option :environments,  {}, 'environment specific configuration'
-      option :cloudfront,    {}, 'access keys for cloudfront account'
-      option :cdn_dir,    'cdn', 'source directory for cdn files'
+      option :id,                     nil,  'name of this cdn'
+      option :environments,            {},  'environment specific configuration'
+      option :cloudfront,             nil,  'access keys for cloudfront account'
+      option :cdn_dir,              'cdn',  'source directory for cdn files'
       option :production_branch, 'master',  'which branch is the production branch'
-      option :default_env,      'staging', 'the default environment if none is set'
+      option :default_env,      'staging',  'the default environment if none is set'
+      option :file_filter,            nil,  'filter for managed files'
+      option :allow_local,          false,  'allow local files to remain on deploy checks'
 
       def after_configuration
         if defined?(::Sass::Script::Functions)
@@ -25,9 +29,15 @@ module BranchableCDNAssets
           production_branch: options.production_branch,
           default_env:       options.default_env,
           environments:      options.environments,
-          cloudfront:        options.cloudfront,
-          cdn_dir:           options.cdn_dir
+          dir:               options.cdn_dir,
+          file_filter:       options.file_filter,
+          allow_local:       options.allow_local
         }
+        if options.cloudfront
+          data.merge! invalidators: {
+            cloudfront: options.cloudfront
+          }
+        end
         Config.new data
       end
 
@@ -35,6 +45,10 @@ module BranchableCDNAssets
         BranchableCDNAssets::FileManager.new config
       end
 
+      def id
+        options.id || self.object_id.to_s
+      end
+
       helpers do
         include Helpers
       end
@@ -45,8 +59,8 @@ module BranchableCDNAssets
           file_manager.list( :local ).map do |file|
             ::Middleman::Sitemap::Resource.new(
               app.sitemap,
-              File.join( "assets/cdn", file ),
-              File.join( app.root, "cdn", file )
+              File.join( "assets/cdn", id, file ),
+              File.join( app.root, options.cdn_dir, file )
             )
           end
         end

data/lib/branchable_cdn_assets/middleman/helpers.rb

@@ -8,26 +8,50 @@ module BranchableCDNAssets
       #
       # @param path [String]
       # @return [String] path to asset
-      def cdn_asset_url path
+      def cdn_asset_url path, cdn=nil
 
         # remove trailing characters after extension
-        ext_trail = path.match(/\.\w+([\#\?\&]\S+)/).to_a
+        # http://rubular.com/r/l0JR3ZuqI2
+        ext_trail = path.match(/(?:\.\w+)?([\#\?\&]\S+)/).to_a
         ext_trail = ext_trail[1] || ''
 
         real_path = path.sub(ext_trail, '')
 
-        # check for file in sitemap
-        if environment != :build && resource = sitemap.find_resource_by_path( File.join( "assets/cdn", real_path ) )
-          return "/" + [resource.destination_path, ext_trail].join
+        # check for file in sitemap on each extension
+        sitemap_candidates = []
+        if environment != :build
+          extensions[:cdn_assets].each do |k, inst|
+            next if cdn && inst.id != cdn
+
+            resource = sitemap.find_resource_by_path( File.join( "assets/cdn", inst.id, real_path ) )
+            sitemap_candidates.push ["/", resource.destination_path, ext_trail].join('') if resource
+          end
         end
 
-        # check for the file in the file_manager
-        file = extensions[:cdn_assets].file_manager.find(real_path)
+        # check for the file in the file_managers
+        file_manager_candidates = []
+        extensions[:cdn_assets].each do |k, inst|
+          next if cdn && inst.id != cdn
+
+          location = (environment == :build) ? :remote : :all;
+          file     = inst.file_manager.find(real_path, location)
 
-        return [file, ext_trail].join if file && file != :local
+          file_manager_candidates.push [file, ext_trail].join('') if file && file != :local
+        end
+
+        candidates = file_manager_candidates + sitemap_candidates
+        unless candidates.empty?
+          if candidates.length == 1
+            return candidates.first
+          elsif cdn # file found local & on remote
+            return candidates.first
+          else
+            raise MultipleCDNError, "asset at '#{real_path}' found on multiple cdns. please pass a cdn id"
+          end
+        end
 
         # not found at any location
-        raise "missing asset at '#{real_path}'"
+        raise FileNotFoundError, "missing asset at '#{real_path}'"
       end
       alias :cdn_asset_path :cdn_asset_url
 
@@ -36,13 +60,20 @@ module BranchableCDNAssets
 
     module SassHelpers
 
-      def cdn_asset_url( path )
-        file = $app.cdn_asset_url( path.value )
+      def cdn_asset_url( path, cdn=nil )
+        cdn  = cdn.value if cdn.respond_to?(:value) # have to force cdn to a string if not nil
+        file = $app.cdn_asset_url( path.value, cdn )
         ::Sass::Script::String.new("url(\"#{file}\")")
       end
       alias :cdn_asset_path :cdn_asset_url
 
     end
 
+    class MultipleCDNError < StandardError
+    end
+
+    class FileNotFoundError < StandardError
+    end
+
   end
 end

data/lib/branchable_cdn_assets/middleman/rake_tasks.rb

@@ -22,7 +22,12 @@ module BranchableCDNAssets
       end
 
       def file_manager
-        @_file_manager ||= FileManager.new mm.extensions[:cdn_assets].config
+        return @_file_manager if @_file_manager
+
+        inst = mm.extensions[:cdn_assets].values.find { |inst| inst.id.to_s == @rake_namespace.to_s }
+        @_file_manager = FileManager.new inst.config
+
+        return @_file_manager
       end
 
     end

data/lib/branchable_cdn_assets/middleman/version.rb

@@ -1,5 +1,5 @@
 module BranchableCDNAssets
   module Middleman
-    VERSION = '0.5.2'
+    VERSION = '0.7.0'  unless defined?(BranchableCDNAssets::Middleman::VERSION)
   end
 end

data/spec/fixtures/multi/config.rb

@@ -0,0 +1,58 @@
+set :environment,     :test
+set :show_exceptions, false
+
+set :css_dir,     "assets/css"
+set :js_dir,      "assets/scripts"
+set :images_dir,  "assets/images"
+
+activate :cdn_assets do |c|
+
+  c.id      = "cdn1"
+  c.cdn_dir = "cdn"
+
+  c.environments = {
+    production: {
+      host: 'production_host',
+      url: 'http://production.com',
+      root: '/var/www/production'
+    },
+    test: {
+      host: 'test_host',
+      url: 'http://test.com',
+      root: '/var/www/test'
+    },
+    staging: {
+      host: 'staging_host',
+      url: 'http://staging.com',
+      root: '/var/www/staging'
+    }
+  }
+
+end
+
+activate :cdn_assets do |c|
+
+  c.id      = "cdn2"
+  c.cdn_dir = "cdn2"
+
+  c.environments = {
+    production: {
+      host: 'production_host',
+      url: 'http://production.com',
+      root: '/var/www/production'
+    },
+    test: {
+      host: 'test_host',
+      url: 'http://test.com',
+      root: '/var/www/test'
+    },
+    staging: {
+      host: 'staging_host',
+      url: 'http://staging.com',
+      root: '/var/www/staging'
+    }
+  }
+
+end
+
+activate :directory_indexes

data/spec/lib/branchable_cdn_assets/middleman/extension_spec.rb

@@ -9,7 +9,8 @@ describe BranchableCDNAssets::Middleman::Extension do
     Given.file 'cdn/img_two', ''
 
     @mm = Middleman::Fixture.app
-    @extension = @mm.extensions[:cdn_assets]
+
+    @extension = @mm.extensions[:cdn_assets].first[1]
   end
 
   after :each do
@@ -54,8 +55,8 @@ describe BranchableCDNAssets::Middleman::Extension do
   describe "#manipulate_resource_list" do
     it "adds local files to the resource list" do
       resource_paths = @mm.sitemap.resources.map(&:url)
-      expect( resource_paths ).to include '/assets/cdn/img_one'
-      expect( resource_paths ).to include '/assets/cdn/img_two'
+      expect( resource_paths ).to include "/assets/cdn/#{@extension.object_id}/img_one"
+      expect( resource_paths ).to include "/assets/cdn/#{@extension.object_id}/img_two"
     end
   end
 

data/spec/lib/branchable_cdn_assets/middleman/helpers_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+require 'middleman_spec_helper'
+
+describe BranchableCDNAssets::Middleman::Helpers do
+
+
+  describe "with a single instance" do
+    before :each do
+      Given.fixture 'base'
+      Given.file 'cdn/master.manifest',      "image_one\nimage_all\nimage_remote_one\nimg.one.jpg\nimage_prod"
+      Given.file 'cdn/some_branch.manifest', "image_one\nimage_all\nimage_remote_two\n"
+      Given.file 'cdn/image_one', ''
+      Given.file 'cdn/image_two', ''
+      Given.file 'cdn/image_all', ''
+      Given.file 'cdn/image_prod', ''
+
+      @mm = Middleman::Fixture.app
+      @extension = @mm.extensions[:cdn_assets].first[1]
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    describe "sitemap helpers" do
+      describe "#cdn_asset_url" do
+        context "when asset is on production cdn" do
+          it "returns the 'live' url of the asset" do
+            allow( Asgit ).to receive(:current_branch).and_return('master')
+            expect( @mm.cdn_asset_url('image_remote_one') ).to eq 'http://production.com/image_remote_one'
+          end
+        end
+
+        context "when asset is on staging cdn" do
+          it "returns the 'live' url of the asset" do
+            allow( Asgit ).to receive(:current_branch).and_return('some_branch')
+            expect( @mm.cdn_asset_url('image_remote_two') ).to eq 'http://staging.com/some_branch/image_remote_two'
+          end
+        end
+
+        context "when asset is local" do
+          it "returns the 'localhost' url of the asset" do
+            expect( @mm.cdn_asset_url('image_two') ).to eq "/assets/cdn/#{@extension.id}/image_two"
+          end
+        end
+
+        context "when asset is local and listed in a manifest" do
+          it "returns the 'localhost' url of the asset" do
+            expect( @mm.cdn_asset_url('image_one') ).to eq "/assets/cdn/#{@extension.id}/image_one"
+          end
+
+          context "when building" do
+            it "returns remote url" do
+              @mm.config[:environment] = :build
+
+              allow( Asgit ).to receive(:current_branch).and_return('some_branch')
+              expect( @mm.cdn_asset_url('image_all') ).to eq "http://staging.com/some_branch/image_all"
+              expect( @mm.cdn_asset_url('image_one') ).to eq "http://staging.com/some_branch/image_one"
+              expect( @mm.cdn_asset_url('image_prod') ).to eq "http://production.com/image_prod"
+            end
+          end
+        end
+
+        context "when the asset is missing" do
+          it "raises an error with the asset name" do
+            expect{
+              @mm.cdn_asset_url('missing_image')
+            }.to raise_error BranchableCDNAssets::Middleman::FileNotFoundError, "missing asset at 'missing_image'"
+          end
+        end
+
+        context "when assets have multiple extensions" do
+          it "returns the url with the given extensions" do
+            allow( Asgit ).to receive(:current_branch).and_return('master')
+            expect( @mm.cdn_asset_url('img.one.jpg') ).to eq "http://production.com/img.one.jpg"
+          end
+          it "raises an error if the root asset is missing" do
+            expect{
+              @mm.cdn_asset_url('missing_image.1.jpg')
+            }.to raise_error BranchableCDNAssets::Middleman::FileNotFoundError, "missing asset at 'missing_image.1.jpg'"
+          end
+        end
+
+        context "with added file extensions" do
+          it "returns the url with the given extensions" do
+            allow( Asgit ).to receive(:current_branch).and_return('master')
+            expect( @mm.cdn_asset_url('image_one?#iefix') ).to eq "/assets/cdn/#{@extension.id}/image_one?#iefix"
+            expect( @mm.cdn_asset_url('img.one.jpg?#iefix') ).to eq "http://production.com/img.one.jpg?#iefix"
+          end
+          it "raises an error if the root asset is missing" do
+            expect{
+              @mm.cdn_asset_url('missing_image?#iefix')
+            }.to raise_error BranchableCDNAssets::Middleman::FileNotFoundError, "missing asset at 'missing_image'"
+            expect{
+              @mm.cdn_asset_url('missing_image.one.jpg?#iefix')
+            }.to raise_error BranchableCDNAssets::Middleman::FileNotFoundError, "missing asset at 'missing_image.one.jpg'"
+          end
+        end
+      end
+    end
+
+    describe "sass helpers" do
+      describe "#cdn_asset_url" do
+        it "calls mm#cdn_asset_url with the asset path" do
+          expect( @mm ).to receive(:cdn_asset_url).with('image_path', nil)
+
+          source = 'body { background: url( cdn_asset_url("image_path") ); }'
+          Sass.compile( source )
+        end
+      end
+    end
+  end
+
+
+  describe "with a multiple instances" do
+    before :all do
+      Given.fixture 'multi'
+      Given.file 'cdn/master.manifest', "image_one\nimage_remote_cdn1"
+      Given.file 'cdn/image_local', ''
+      Given.file 'cdn/image_cdn', ''
+      Given.file 'cdn2/master.manifest', "image_one\nimage_remote_cdn2"
+      Given.file 'cdn2/image_local', ''
+      Given.file 'cdn2/image_cdn2', ''
+
+      @mm = Middleman::Fixture.app
+      @cdn1 = @mm.extensions[:cdn_assets]["instance_0"]
+      @cdn2 = @mm.extensions[:cdn_assets]["instance_1"]
+    end
+
+    after :all do
+      Given.cleanup!
+    end
+
+
+    describe "sitemap helpers" do
+      describe "#cdn_asset_url" do
+        context "when file exists on only one cdn" do
+          it "finds remote files on correct cdn" do
+            allow( Asgit ).to receive(:current_branch).and_return('master')
+
+            expect( @mm.cdn_asset_url('image_remote_cdn1') ).to eq 'http://production.com/image_remote_cdn1'
+            expect( @mm.cdn_asset_url('image_remote_cdn2') ).to eq 'http://production.com/image_remote_cdn2'
+          end
+
+          it "finds local files on correct cdn" do
+            expect( @mm.cdn_asset_url('image_cdn') ).to  eq "/assets/cdn/cdn1/image_cdn"
+            expect( @mm.cdn_asset_url('image_cdn2') ).to eq "/assets/cdn/cdn2/image_cdn2"
+          end
+        end
+
+        context "when file exists on multiple cdns" do
+          it "returns file on given cdn" do
+            expect( @mm.cdn_asset_url('image_local', 'cdn1') ).to eq "/assets/cdn/cdn1/image_local"
+            expect( @mm.cdn_asset_url('image_local', 'cdn2') ).to eq "/assets/cdn/cdn2/image_local"
+          end
+
+          it "raises error if a cdn key isn't given" do
+            expect{
+              @mm.cdn_asset_url('image_local')
+            }.to raise_error BranchableCDNAssets::Middleman::MultipleCDNError
+          end
+        end
+      end
+    end
+
+    describe "sass helpers" do
+      describe "#cdn_asset_url" do
+        it "is called with the cdn argument if given" do
+          expect( @mm ).to receive(:cdn_asset_url).with('image_path', 'cdn2')
+
+          source = 'body { background: url( cdn_asset_url("image_path", "cdn2") ); }'
+          Sass.compile( source )
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ require 'support/hash'
 require 'branchable_cdn_assets-middleman'
 
 # silence stdout
-$stdout = StringIO.open('','w+')
+$stdout = StringIO.open('','w+') unless ENV['VERBOSE']
 
 RSpec.configure do |config|
   config.mock_with :rspec do |mocks|

metadata

@@ -1,44 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: branchable_cdn_assets-middleman
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Steven Sloan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: branchable_cdn_assets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-description: ' Middleman Adaptor for branchable_cdn_assets '
+        version: '0.7'
+description: " Middleman Adaptor for branchable_cdn_assets "
 email: marketing-dev@mailchimp.com
 executables: []
 extensions: []
@@ -52,9 +52,10 @@ files:
 - lib/branchable_cdn_assets/middleman/version.rb
 - lib/middleman_extension.rb
 - spec/fixtures/base/config.rb
+- spec/fixtures/multi/config.rb
 - spec/lib/branchable_cdn_assets-middleman_spec.rb
 - spec/lib/branchable_cdn_assets/middleman/extension_spec.rb
-- spec/lib/branchable_cdn_assets/middleman/helpers_specs.rb
+- spec/lib/branchable_cdn_assets/middleman/helpers_spec.rb
 - spec/lib/branchable_cdn_assets/middleman/rake_tasks_spec.rb
 - spec/middleman_spec_helper.rb
 - spec/spec_helper.rb
@@ -72,24 +73,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Middleman Adaptor for branchable_cdn_assets
 test_files:
 - spec/fixtures/base/config.rb
+- spec/fixtures/multi/config.rb
 - spec/lib/branchable_cdn_assets/middleman/extension_spec.rb
-- spec/lib/branchable_cdn_assets/middleman/helpers_specs.rb
+- spec/lib/branchable_cdn_assets/middleman/helpers_spec.rb
 - spec/lib/branchable_cdn_assets/middleman/rake_tasks_spec.rb
 - spec/lib/branchable_cdn_assets-middleman_spec.rb
 - spec/middleman_spec_helper.rb

data/spec/lib/branchable_cdn_assets/middleman/helpers_specs.rb

@@ -1,96 +0,0 @@
-require 'spec_helper'
-require 'middleman_spec_helper'
-
-describe CDNAssets::Middleman::Helpers do
-
-  before :each do
-    Given.fixture 'base'
-    Given.file 'cdn/production.manifest', "image_one\nimage_remote_one\nimg.one.jpg"
-    Given.file 'cdn/staging.manifest',    "image_one\nimage_remote_two\n"
-    Given.file 'cdn/image_one', ''
-    Given.file 'cdn/image_two', ''
-
-    @mm = Middleman::Fixture.app
-    @extension = @mm.extensions[:cdn_assets]
-  end
-
-  after :each do
-    Given.cleanup!
-  end
-
-  describe "sitemap helpers" do
-    describe "#cdn_asset_url" do
-      context "when asset is on production cdn" do
-        it "returns the 'live' url of the asset" do
-          Asgit.stub(current_branch: 'master')
-          expect( @mm.cdn_asset_url('image_remote_one') ).to eq 'http://production.com/image_remote_one'
-        end
-      end
-
-      context "when asset is on staging cdn" do
-        it "returns the 'live' url of the asset" do
-          Asgit.stub(current_branch: 'some_branch')
-          expect( @mm.cdn_asset_url('image_remote_two') ).to eq 'http://staging.com/some_branch/image_remote_two'
-        end
-      end
-
-      context "when asset is local" do
-        it "returns the 'localhost' url of the asset" do
-          expect( @mm.cdn_asset_url('image_two') ).to eq '/assets/cdn/image_two'
-        end
-      end
-
-      context "when asset is local and listed in a manifest" do
-        it "returns the 'localhost' url of the asset" do
-          expect( @mm.cdn_asset_url('image_one') ).to eq '/assets/cdn/image_one'
-        end
-      end
-
-      context "when the asset is missing" do
-        it "raises an error with the asset name" do
-          expect{
-            @mm.cdn_asset_url('missing_image')
-          }.to raise_error "missing asset at 'missing_image'"
-        end
-      end
-
-      context "when assets have multiple extensions" do
-        it "returns the url with the given extensions" do
-          expect( @mm.cdn_asset_url('img.one.jpg') ).to eq '/assets/cdn/img.one.jpg'
-        end
-        it "raises an error if the root asset is missing" do
-          expect{
-            @mm.cdn_asset_url('missing_image.1.jpg')
-          }.to raise_error "missing asset at 'missing_image.1.jpg'"
-        end
-      end
-
-      context "with added file extensions" do
-        it "returns the url with the given extensions" do
-          expect( @mm.cdn_asset_url('image_one?#iefix') ).to eq '/assets/cdn/image_one?#iefix'
-          expect( @mm.cdn_asset_url('img.one.jpg?#iefix') ).to eq '/assets/cdn/img.one.jpg?#iefix'
-        end
-        it "raises an error if the root asset is missing" do
-          expect{
-            @mm.cdn_asset_url('missing_image?#iefix')
-          }.to raise_error "missing asset at 'missing_image'"
-          expect{
-            @mm.cdn_asset_url('missing_image.one.jpg?#iefix')
-          }.to raise_error "missing asset at 'missing_image.one.jpg'"
-        end
-      end
-    end
-  end
-
-  describe "sass helpers" do
-    describe "#cdn_asset_url" do
-      it "calls mm#cdn_asset_url with the asset path" do
-        expect( @mm ).to receive(:cdn_asset_url).with('image_path')
-
-        source = 'body { background: url( cdn_asset_url("image_path") ); }'
-        Sass.compile( source )
-      end
-    end
-  end
-
-end