branchable_cdn_assets-middleman 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9ae41911f2c5847089e9f35916266e6af72f5c5
+  data.tar.gz: 50534f96859ea1fb073d75f1a71068ecad23e6b3
+SHA512:
+  metadata.gz: df4c5833e1795f56d7f39ab50cb79b68daaa5d725bb27a69650a7090882a7dfa918f338c0c71bf1e250ea7aed31b84081a5162d447be740558981925744f85ef
+  data.tar.gz: 179305796158df8cbba3512aeb6c1bdb98cad9214001ced1e08d550b007351b3fdedee020ce408b412e23e0e21441414beccfedfc1773d15daeff07d1d1ce58d

data/lib/branchable_cdn_assets-middleman.rb

@@ -0,0 +1,2 @@
+require 'branchable_cdn_assets'
+require_relative 'branchable_cdn_assets/middleman'

data/lib/branchable_cdn_assets/middleman.rb

@@ -0,0 +1,4 @@
+require 'middleman'
+
+require_relative 'middleman/helpers'
+require_relative 'middleman/extension'

data/lib/branchable_cdn_assets/middleman/extension.rb

@@ -0,0 +1,58 @@
+module BranchableCDNAssets
+  module Middleman
+
+    class Extension < ::Middleman::Extension
+
+      option :environments,  {}, 'environment specific configuration'
+      option :cloudfront,    {}, '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'
+
+      def after_configuration
+        if defined?(::Sass::Script::Functions)
+          $app = @app
+          ::Sass::Script::Functions.send :include, SassHelpers
+        end
+      end
+
+      def manipulate_resource_list resources
+        resources + local_files_as_resources
+      end
+
+      def config
+        data = {
+          production_branch: options.production_branch,
+          default_env:       options.default_env,
+          environments:      options.environments,
+          cloudfront:        options.cloudfront,
+          cdn_dir:           options.cdn_dir
+        }
+        Config.new data
+      end
+
+      def file_manager
+        BranchableCDNAssets::FileManager.new config
+      end
+
+      helpers do
+        include Helpers
+      end
+
+      private
+
+        def local_files_as_resources
+          file_manager.list( :local ).map do |file|
+            ::Middleman::Sitemap::Resource.new(
+              app.sitemap,
+              File.join( "assets/cdn", file ),
+              File.join( app.root, "cdn", file )
+            )
+          end
+        end
+
+    end
+    ::Middleman::Extensions.register(:cdn_assets, BranchableCDNAssets::Middleman::Extension)
+
+  end
+end

data/lib/branchable_cdn_assets/middleman/helpers.rb

@@ -0,0 +1,41 @@
+module BranchableCDNAssets
+  module Middleman
+
+    module Helpers
+
+      # return the correct path to an asset depending on
+      # what environment you're in and the state of the cdn
+      #
+      # @param path [String]
+      # @return [String] path to asset
+      def cdn_asset_url path
+
+        # check for file in sitemap
+        if environment != :build && resource = sitemap.find_resource_by_path( File.join( "assets/cdn", path ) )
+          return "/" + resource.destination_path
+        end
+
+        # check for the file in the file_manager
+        file = extensions[:cdn_assets].file_manager.find(path)
+        return file if file && file != :local
+
+        # not found at any location
+        raise "missing asset at '#{path}'"
+      end
+      alias :cdn_asset_path :cdn_asset_url
+
+    end
+
+
+    module SassHelpers
+
+      def cdn_asset_url( path )
+        file = $app.cdn_asset_url( path.value )
+        ::Sass::Script::String.new("url(\"#{file}\")")
+      end
+      alias :cdn_asset_path :cdn_asset_url
+
+    end
+
+  end
+end

data/lib/branchable_cdn_assets/middleman/rake_tasks.rb

@@ -0,0 +1,27 @@
+require 'rake'
+require 'branchable_cdn_assets-middleman'
+require 'branchable_cdn_assets/rake_tasks'
+
+module BranchableCDNAssets
+  module Middleman
+
+    class RakeTasks < BranchableCDNAssets::RakeTasks
+
+      class << self
+        def register namespace=:cdn
+          RakeTasks.new( namespace ).register_tasks
+        end
+      end
+
+      attr_reader :mm
+
+      def initialize namespace
+        @mm = ::Middleman::Application.server.inst
+        @file_manager   = FileManager.new @mm.extensions[:cdn_assets].config
+        @rake_namespace = namespace
+      end
+
+    end
+
+  end
+end

data/lib/branchable_cdn_assets/middleman/version.rb

@@ -0,0 +1,5 @@
+module BranchableCDNAssets
+  module Middleman
+    VERSION = '0.5.0'
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'branchable_cdn_assets-middleman'

data/spec/fixtures/base/config.rb

@@ -0,0 +1,36 @@
+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.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'
+    }
+  }
+
+  c.cloudfront = {
+    access_key: 'cf_access_key',
+    secret_key: 'cf_secret_key',
+    distribution_id: 'cd_dist_id'
+  }
+
+end
+
+activate :directory_indexes

data/spec/lib/branchable_cdn_assets-middleman_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe BranchableCDNAssets::Middleman do
+
+  it "has a version" do
+    expect( BranchableCDNAssets::Middleman::VERSION >= "0.0.0" ).to be_truthy
+  end
+
+end

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

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'middleman_spec_helper'
+
+describe BranchableCDNAssets::Middleman::Extension do
+
+  before :each do
+    Given.fixture('base')
+    Given.file 'cdn/img_one', ''
+    Given.file 'cdn/img_two', ''
+
+    @mm = Middleman::Fixture.app
+    @extension = @mm.extensions[:cdn_assets]
+  end
+
+  after :each do
+    Given.cleanup!
+  end
+
+  describe "#config" do
+
+    it "returns a Config instance" do
+      expect( @extension.config.is_a?( BranchableCDNAssets::Config ) ).to be_truthy
+    end
+
+    it "sets config with extension options" do
+      allow( Asgit ).to receive(:current_branch).and_return('master')
+      @extension.options[:production_branch] = 'master'
+
+      expect( @extension.config.host ).to eq 'production_host'
+    end
+
+    it "sets env to production if on :production_branch" do
+      allow( Asgit ).to receive(:current_branch).and_return('master')
+      @extension.options[:production_branch] = 'master'
+
+      expect( @extension.config.env ).to eq :production
+    end
+
+    it "sets env to current_branch if there is a matching env key" do
+      allow( Asgit ).to receive(:current_branch).and_return('test')
+
+      expect( @extension.config.env ).to eq :test
+    end
+
+    it "falls back to :default_env if no matching env data" do
+      allow( Asgit ).to receive(:current_branch).and_return('no_match')
+      @extension.options[:default_env] = 'set_default_env'
+
+      expect( @extension.config.env ).to eq :set_default_env
+    end
+
+  end
+
+  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'
+    end
+  end
+
+end

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

@@ -0,0 +1,70 @@
+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\n"
+    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
+    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

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

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'middleman_spec_helper'
+
+require 'branchable_cdn_assets/middleman/rake_tasks'
+
+describe BranchableCDNAssets::Middleman::RakeTasks do
+
+  describe "::register" do
+
+    before :each do
+      Given.fixture 'base'
+      Rake::Task.clear
+    end
+
+    after :each do
+      Given.cleanup!
+    end
+
+    it "adds tasks under provided namespace" do
+      described_class.register(:test)
+
+      expect( Rake::Task.tasks.map(&:to_s) ).to include 'test:list'
+    end
+
+    it "defaults to :cdn for namespace" do
+      described_class.register
+
+      expect( Rake::Task.tasks.map(&:to_s) ).to include 'cdn:list'
+    end
+
+    it "sends method with check to the file_manager" do
+      class FileManagerStub
+        extend BranchableCDNAssets::CheckBefore
+
+        def list *args
+          []
+        end
+
+        def pull!
+        end
+      end
+
+      file_manager_double = FileManagerStub.new
+      allow_any_instance_of( described_class ).to receive(:file_manager).and_return( file_manager_double )
+
+      expect( file_manager_double ).to receive(:list)
+      expect( file_manager_double ).to receive(:pull!)
+
+      described_class.register
+      Rake::Task['cdn:list'].invoke
+      Rake::Task['cdn:pull'].invoke
+    end
+
+  end
+
+end

data/spec/middleman_spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rack/test'
+require 'middleman'
+require 'support/middleman/fixture'
+require 'support/middleman/browser'

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'pry'
+require 'tempfile'
+require 'catch_and_release'
+require 'catch_and_release/rspec'
+require 'support/given'
+require 'support/hash'
+
+require 'branchable_cdn_assets-middleman'
+
+# silence stdout
+$stdout = StringIO.open('','w+')
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles        = true
+  end
+
+  config.include CatchAndRelease::RSpec
+end

data/spec/support/given.rb

@@ -0,0 +1,28 @@
+module Given
+  ROOT = Dir.pwd
+  TMP = File.join( Dir.pwd, 'tmp' )
+
+  class << self
+
+    def fixture name
+      cleanup!
+
+      `rsync -av ./spec/fixtures/#{name}/ #{TMP}/`
+      Dir.chdir TMP
+    end
+
+    def file name, content
+      file_path = File.join( TMP, name )
+      FileUtils.mkdir_p( File.dirname(file_path) )
+      File.open( file_path, 'w' ) do |file|
+        file.write content
+      end
+    end
+
+    def cleanup!
+      Dir.chdir ROOT
+      `rm -rf #{TMP}`
+    end
+
+  end
+end

data/spec/support/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  def without_key key
+    new_hash = self.dup
+    new_hash.delete(key)
+
+    return new_hash
+  end
+end

data/spec/support/middleman/browser.rb

@@ -0,0 +1,16 @@
+module Middleman
+  class Browser
+
+    attr_reader :browser
+
+    def initialize app
+      app_on_rack = app.class.to_rack_app
+      @browser    = ::Rack::Test::Session.new( ::Rack::MockSession.new(app_on_rack) )
+    end
+
+    def get path
+      browser.get( URI.escape(path) ).body
+    end
+
+  end
+end

data/spec/support/middleman/fixture.rb

@@ -0,0 +1,14 @@
+module Middleman
+  module Fixture
+
+    class << self
+      def app &block
+        ENV['MM_ROOT'] = Given::TMP
+        Middleman::Application.server.inst do
+          instance_eval(&block) if block
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: branchable_cdn_assets-middleman
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Steven Sloan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-03 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'
+  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 '
+email: marketing-dev@mailchimp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/branchable_cdn_assets-middleman.rb
+- lib/branchable_cdn_assets/middleman.rb
+- lib/branchable_cdn_assets/middleman/extension.rb
+- lib/branchable_cdn_assets/middleman/helpers.rb
+- lib/branchable_cdn_assets/middleman/rake_tasks.rb
+- lib/branchable_cdn_assets/middleman/version.rb
+- lib/middleman_extension.rb
+- spec/fixtures/base/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/rake_tasks_spec.rb
+- spec/middleman_spec_helper.rb
+- spec/spec_helper.rb
+- spec/support/given.rb
+- spec/support/hash.rb
+- spec/support/middleman/browser.rb
+- spec/support/middleman/fixture.rb
+homepage: http://github.com/mailchimp/branchable_cdn_assets-middleman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Middleman Adaptor for branchable_cdn_assets
+test_files:
+- spec/fixtures/base/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/rake_tasks_spec.rb
+- spec/lib/branchable_cdn_assets-middleman_spec.rb
+- spec/middleman_spec_helper.rb
+- spec/spec_helper.rb
+- spec/support/given.rb
+- spec/support/hash.rb
+- spec/support/middleman/browser.rb
+- spec/support/middleman/fixture.rb