middleman-imgix 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbba5297726c9a3e3a325bfba635f9e3cd060bb3
-  data.tar.gz: 77c58e86e08c9ce123ee8d9b37082c92b996ba53
+  metadata.gz: 40e02fb17c11022299d5772a0f4ed95798f75113
+  data.tar.gz: 2ea22cee448d890cf52708fca022f64fdc5beb69
 SHA512:
-  metadata.gz: dbd10bdb03066aa4b3d7d07d0be3a70171709d71c38503f36f771eeeb000a432e60c918c61e404b76ee8a214971641770440bac6e02ed6b6c1c8cbb7893b7d09
-  data.tar.gz: be4c53177182f57dfa062f919e30c40b0d112307c8438de2fea082b37eb06fc488cc5e1ac0813bab8eebe1083be667272cd45c7f9d7362c1fdf831a6c1208fc5
+  metadata.gz: eb8b1efec59bb40c2ddf376d7ab7e81338954190dec756f2998242e724c390178c7e63eab8f9a75db3800bda70b1a922882c682b86058415d82ffe910f9abcba
+  data.tar.gz: 8451d2a1a9e9ca5127e83058399be6bab909f175a2f0559c991e03c9e095a549d5510992edc4c8b205caa38d4bacdb913aa64c326070b8a97f6f2c06b5ad5a57

data/.gitignore

@@ -3,3 +3,6 @@
 
 # Ignore pkg folder
 /pkg
+
+# Ignore gems
+*.gem

data/.travis.yml

@@ -5,6 +5,5 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
-  - 2.3.1
 notifications:
   email: false

data/LICENSE.md

@@ -0,0 +1,9 @@
+Copyright (c) 2016 Big Cartel, LLC
+
+# MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# middleman-imgix [![Build Status](https://travis-ci.org/bigcartel/middleman-imgix.svg?branch=master)](https://travis-ci.org/bigcartel/middleman-imgix) [![Gem Version](https://badge.fury.io/rb/middleman-imgix.svg)](https://badge.fury.io/rb/middleman-imgix)
+
+`middleman-imgix` is an extension for the [Middleman](https://middlemanapp.com) static site generator that allows you to run all of your images (or only some) through [imgix](https://www.imgix.com) for all sorts of fun features.
+
+## Installation
+
+From inside the Gemfile of your Middleman project | add:
+
+```
+gem 'middleman-imgix'
+```
+
+Then run `bundle install`
+
+## Configuration
+
+Activate the extension in your `config.rb` file, and supply your required imgix host:
+
+```
+activate :imgix, host: 'your-subdomain.imgix.net'
+```
+
+A number of other options are supported as well (see the [imgix gem](https://github.com/imgix/imgix-rb) for more info):
+
+```
+activate :imgix, host: 'your-subdomain.imgix.net', secure_url_token: 'your-token', shard_strategy: :cycle
+```
+
+Here's a list of all available options:
+
+| Option  | Default | Description |
+| ------------- | ------------- | ------------- |
+| `host` (required) | `nil` | A string or array of your imgix hosts. |
+| `secure_url_token` | `nil` | Your imgix [secure_url_token](https://docs.imgix.com/setup/securing-images). |
+| `use_https` | `true` | Whether to use http or https for imgix. |
+| `shard_strategy` | `:crc` | Your imgix [shard strategy](https://github.com/imgix/imgix-rb#domain-sharded-urls). |
+| `include_library_param` | `true` | Include the imgix [library param](https://github.com/imgix/imgix-rb#what-is-the-ixlib-param-on-every-request) in each URL. |
+| `default_params` | `{ auto: 'format' }` | Default [imgix params](https://docs.imgix.com/apis/url) to use on all images. |
+| `imgix_js_version` | `nil` | Converts `image_tag`s to support [imgix.js](https://www.imgix.com/imgix-js) version [2](https://github.com/imgix/imgix.js/tree/master-2.x) or [3](https://github.com/imgix/imgix.js). |
+| `exts` | `%w(.png .jpg .jpeg)` | List of file extensions that get converted to imgix URLs. |
+| `sources` | `%w(.css .htm .html .js .php .xhtml)` | List of source extensions that are searched for imgix images. |
+| `ignore` | `[]` | Regexes of filenames to skip adding imgix to. |
+| `rewrite_ignore` | `[]` | Regexes of filenames to skip processing for path rewrites. |
+
+## Usage
+
+After activating the extension, all applicable image URLs throughout your site (HTML, CSS, etc.) will begin pointing to imgix. For example...
+
+```ruby
+image_tag 'example.png'
+#=> <img src="https://your-subdomain.imgix.net/images/example.png?ixlib=rb-1.1.0&auto=format" />
+```
+
+### imgix.js
+
+If you're using [imgix.js](https://www.imgix.com/imgix-js) for responsive images (you still need to include that JS file yourself), you can [configure](#configuration) the `imgix_js_version` option to have the output from `image_tag` generate specific markup for your imgix.js version.
+
+#### imgix_js_version: 3
+
+```ruby
+image_tag 'example.png'
+#=> <img ix-src="https://your-subdomain.imgix.net/images/example.png?ixlib=rb-1.1.0&auto=format" />
+```
+
+#### imgix_js_version: 2
+
+```ruby
+image_tag 'example.png'
+#=> <img data-src="https://your-subdomain.imgix.net/images/example.png?ixlib=rb-1.1.0&auto=format" class="imgix-fluid" />
+```

data/middleman-imgix.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = 'middleman-imgix'
-  gem.version       = '1.0.1'
+  gem.version       = '1.0.2'
   gem.licenses      = ['MIT']
   gem.authors       = ['Big Cartel']
   gem.email         = ['dev@bigcartel.com']
@@ -13,6 +13,6 @@ Gem::Specification.new do |gem|
   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'
+  gem.add_runtime_dependency 'middleman-core', '>= 4.1'
+  gem.add_runtime_dependency 'imgix', '>= 1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-imgix
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Big Cartel
@@ -14,42 +14,30 @@ dependencies:
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.1'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 4.1.8
+        version: '4.1'
   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
+        version: '4.1'
 - !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
+        version: '1.1'
   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
+        version: '1.1'
 description: Use imgix images in your Middleman site.
 email:
 - dev@bigcartel.com
@@ -60,6 +48,8 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- LICENSE.md
+- README.md
 - Rakefile
 - lib/middleman-imgix.rb
 - lib/middleman-imgix/extension.rb