middleman-imgix 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fbba5297726c9a3e3a325bfba635f9e3cd060bb3
+  data.tar.gz: 77c58e86e08c9ce123ee8d9b37082c92b996ba53
+SHA512:
+  metadata.gz: dbd10bdb03066aa4b3d7d07d0be3a70171709d71c38503f36f771eeeb000a432e60c918c61e404b76ee8a214971641770440bac6e02ed6b6c1c8cbb7893b7d09
+  data.tar.gz: be4c53177182f57dfa062f919e30c40b0d112307c8438de2fea082b37eb06fc488cc5e1ac0813bab8eebe1083be667272cd45c7f9d7362c1fdf831a6c1208fc5

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.1
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rspec', '~> 2.14.1'
+  gem 'capybara', '~> 2.1.0'
+end

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/middleman-imgix.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+Middleman::Extensions.register :imgix do
+  require 'middleman-imgix/extension'
+  Middleman::Imgix
+end

data/lib/middleman-imgix/extension.rb

@@ -0,0 +1,78 @@
+require 'middleman-core'
+
+class Middleman::Imgix < ::Middleman::Extension
+  option :host, nil, 'Your imgix host.', required: true
+  option :secure_url_token, nil, 'Your imgix secure_url_token.'
+  option :use_https, true, 'Whether to use http or https for imgix.'
+  option :shard_strategy, :crc, 'Your imgix shard strategy.'
+  option :include_library_param, true, 'Include the imgix library param in each URL.'
+  option :default_params, { auto: 'format' }, 'Default imgix params to use on all images.'
+  option :imgix_js_version, nil, 'Converts image_tags to support imgix.js version 2 or 3.'
+  option :exts, %w(.png .jpg .jpeg), 'List of file extensions that get converted to imgix URLs.'
+  option :sources, %w(.css .htm .html .js .php .xhtml), 'List of source extensions that are searched for imgix images.'
+  option :ignore, [], 'Regexes of filenames to skip adding imgix to.'
+  option :rewrite_ignore, [], 'Regexes of filenames to skip processing for path rewrites.'
+
+  expose_to_template imgix_options: :options
+
+  def initialize(app, options_hash={}, &block)
+    super
+
+    app.rewrite_inline_urls id: :imgix,
+                            url_extensions: options.exts,
+                            source_extensions: options.sources,
+                            ignore: options.ignore,
+                            rewrite_ignore: options.rewrite_ignore,
+                            proc: method(:rewrite_url)
+
+    require 'imgix'
+  end
+
+  def rewrite_url(asset_path, dirpath, _request_path)
+    uri = URI.parse(asset_path)
+
+    if uri.relative?
+      params = CGI::parse(uri.query.to_s)
+      params = params.reverse_merge(options.default_params)
+      path = client.path(uri.path)
+      path.to_url(params)
+    else
+      asset_path
+    end
+  end
+  memoize :rewrite_url
+
+  helpers do
+    def image_tag(path, params={})
+      if imgix_options.imgix_js_version && imgix_image?(path)
+        version = imgix_options.imgix_js_version.to_i
+        params[:class] = 'imgix-fluid' if version == 2
+        src = version == 2 ? 'data-src=' : 'ix-src='
+        super(path, params).gsub('src=', src)
+      else
+        super
+      end
+    end
+
+    def imgix_image?(path)
+      uri = URI.parse(path)
+      uri.relative? &&
+      imgix_options.exts.include?(::File.extname(uri.path)) &&
+      imgix_options.sources.include?(::File.extname(current_resource.path)) &&
+      imgix_options.ignore.none? { |r| ::Middleman::Util.should_ignore?(r, uri.path) } &&
+      imgix_options.rewrite_ignore.none? { |i| ::Middleman::Util.path_match(i, uri.path) }
+    end
+  end
+
+  private
+
+  def client
+    @client ||= Imgix::Client.new({
+      host: options.host,
+      secure_url_token: options.secure_url_token,
+      use_https: options.use_https,
+      shard_strategy: options.shard_strategy,
+      include_library_param: options.include_library_param
+    })
+  end
+end

data/middleman-imgix.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = 'middleman-imgix'
+  gem.version       = '1.0.1'
+  gem.licenses      = ['MIT']
+  gem.authors       = ['Big Cartel']
+  gem.email         = ['dev@bigcartel.com']
+  gem.description   = %q(Use imgix images in your Middleman site.)
+  gem.summary       = %q(Run all of your images (or only some) through imgix for all sorts of fun features.)
+  gem.homepage      = 'https://github.com/bigcartel/middleman-imgix'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'middleman-core', '~> 4.1', '>= 4.1.8'
+  gem.add_runtime_dependency 'imgix', '~> 1.1', '>= 1.1.0'
+end

data/spec/features/imgix_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+describe "middleman-imgix", type: :feature do
+  def visit_app(config='host: "images.example.com"')
+    app("activate :imgix, #{config}")
+    visit '/imgix.html'
+  end
+
+  describe "host" do
+    it "should raise an error if missing" do
+      expect { app('activate :imgix') }.to raise_error
+    end
+
+    it "can be set to a single host" do
+      visit_app
+      expect(page.body).to include('images.example.com')
+    end
+
+    it "can be set to multiple hosts" do
+      visit_app('host: ["images1.example.com", "images2.example.com"]')
+      expect(page.body).to include('images1.example.com')
+      expect(page.body).to include('images2.example.com')
+    end
+  end
+
+  describe "secure_url_token" do
+    it "should be nil by default" do
+      visit_app
+      expect(page.body).to_not include('&s=')
+    end
+
+    it "should work when set" do
+      visit_app('host: "images.example.com", secure_url_token: "test"')
+      expect(page.body).to include('&s=c2708015f12eae21de4d0e6cc55f525e')
+    end
+  end
+
+  describe "use_https" do
+    it "should be true by default" do
+      visit_app
+      expect(page.body).to include('https://')
+    end
+
+    it "should work when false" do
+      visit_app('host: "images.example.com", use_https: false')
+      expect(page.body).to include('http://')
+    end
+  end
+
+  describe "shard_strategy" do
+    it "should be crc by default" do
+      visit_app('host: ["1.example.com", "2.example.com", "3.example.com"]')
+      expect(page.body).to eq(%{<img src="https://2.example.com/images/test.png?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="https://2.example.com/images/test.jpg?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="/images/test.gif" alt="Test" />\n})
+    end
+
+    it "should work when cycle" do
+      visit_app('host: ["1.example.com", "2.example.com", "3.example.com"], shard_strategy: :cycle')
+      expect(page.body).to eq(%{<img src="https://1.example.com/images/test.png?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="https://2.example.com/images/test.jpg?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="/images/test.gif" alt="Test" />\n})
+    end
+  end
+
+  describe "include_library_param" do
+    it "should be true by default" do
+      visit_app
+      expect(page.body).to include('ixlib=rb-1.1.0')
+    end
+
+    it "should work when set" do
+      visit_app('host: "images.example.com", include_library_param: false')
+      expect(page.body).to_not include('ixlib=rb-1.1.0')
+    end
+  end
+
+  describe "default_params" do
+    it "should be auto format by default" do
+      visit_app
+      expect(page.body).to include('auto=format')
+    end
+
+    it "should work when customized" do
+      visit_app('host: "images.example.com", default_params: {fit:"max"}')
+      expect(page.body).to_not include('auto=format')
+      expect(page.body).to include('fit=max')
+    end
+  end
+
+  describe "imgix_js_version" do
+    it "should not use imgix.js default" do
+      visit_app
+      expect(page.body).to include(%{<img src="https://images.example.com/images/test.png?ixlib=rb-1.1.0&auto=format" alt="Test" />})
+    end
+
+    it "should support imgix.js v2" do
+      visit_app('host: "images.example.com", imgix_js_version: 2')
+      expect(page.body).to include(%{<img data-src="https://images.example.com/images/test.png?ixlib=rb-1.1.0&auto=format" class="imgix-fluid" alt="Test" />})
+    end
+
+    it "should support imgix.js v3" do
+      visit_app('host: "images.example.com", imgix_js_version: 3')
+      expect(page.body).to include(%{<img ix-src="https://images.example.com/images/test.png?ixlib=rb-1.1.0&auto=format" alt="Test" />})
+    end
+  end
+
+  describe "exts" do
+    it "should be pngs and jpgs by default" do
+      visit_app
+      expect(page.body).to eq(%{<img src="https://images.example.com/images/test.png?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="https://images.example.com/images/test.jpg?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="/images/test.gif" alt="Test" />\n})
+    end
+
+    it "should work when customized" do
+      visit_app('host: "images.example.com", exts: %w(.png .jpg .jpeg .gif)')
+      expect(page.body).to eq(%{<img src="https://images.example.com/images/test.png?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="https://images.example.com/images/test.jpg?ixlib=rb-1.1.0&auto=format" alt="Test" />\n<img src="https://images.example.com/images/test.gif?ixlib=rb-1.1.0&auto=format" alt="Test" />\n})
+    end
+  end
+
+  describe "sources" do
+    it "should be html, js, and css by default" do
+      visit_app
+      expect(page.body).to include(%'images.example.com')
+    end
+
+    it "should work when customized" do
+      visit_app('host: "images.example.com", sources: %w(.css)')
+      expect(page.body).to_not include(%'images.example.com')
+    end
+  end
+
+  describe "ignore" do
+    it "should not ignore anything by default" do
+      visit_app
+      expect(page.body).to include(%'images.example.com/images/test.png')
+    end
+
+    it "should work when customized" do
+      visit_app('host: "images.example.com", ignore: %w(/images/test.png)')
+      expect(page.body).to_not include(%'images.example.com/images/test.png')
+      expect(page.body).to include(%'/images/test.png')
+    end
+  end
+
+  describe "rewrite_ignore" do
+    it "should not ignore anything by default" do
+      visit_app
+      expect(page.body).to include(%'images.example.com/images/test.png')
+    end
+
+    it "should work when customized" do
+      visit_app('host: "images.example.com", rewrite_ignore: %w(/imgix.html)')
+      expect(page.body).to_not include(%'images.example.com/images/test.png')
+      expect(page.body).to include(%'/images/test.png')
+    end
+  end
+end

data/spec/fixtures/app/source/imgix.html.erb

@@ -0,0 +1,3 @@
+<%= image_tag 'test.png' %>
+<%= image_tag 'test.jpg' %>
+<%= image_tag 'test.gif' %>

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+require 'capybara/rspec'
+require 'middleman-core'
+require 'middleman-core/rack'
+require 'middleman-imgix'
+
+def app(config_rb='')
+  ENV['MM_ROOT'] = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'app'))
+  ENV['MM_ENV'] = 'test'
+
+  config_path = File.join(ENV['MM_ROOT'], 'config.rb')
+  File.write(config_path, config_rb)
+
+  mm_app = ::Middleman::Application.new do
+    config[:watcher_disable] = true
+  end
+
+  Capybara.app = ::Middleman::Rack.new(mm_app).to_app
+  File.delete(config_path)
+
+  mm_app
+end
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: middleman-imgix
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Big Cartel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: imgix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Use imgix images in your Middleman site.
+email:
+- dev@bigcartel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Rakefile
+- lib/middleman-imgix.rb
+- lib/middleman-imgix/extension.rb
+- middleman-imgix.gemspec
+- spec/features/imgix_spec.rb
+- spec/fixtures/app/source/images/test.gif
+- spec/fixtures/app/source/images/test.jpg
+- spec/fixtures/app/source/images/test.png
+- spec/fixtures/app/source/imgix.html.erb
+- spec/spec_helper.rb
+homepage: https://github.com/bigcartel/middleman-imgix
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Run all of your images (or only some) through imgix for all sorts of fun
+  features.
+test_files: []
+has_rdoc: