jekyll_picture_tag 1.11.0 → 2.0.0

data/.travis.yml

@@ -1,8 +0,0 @@
-services:
-  - docker
-
-before_install:
-  - docker build . -t jpt
-
-script:
-  - docker run -t jpt

data/Dockerfile

@@ -1,9 +0,0 @@
-FROM ruby:alpine
-WORKDIR /root/jekyll_picture_tag
-# Dependencies for nokogiri, eventmachine, and JPT
-RUN apk add git imagemagick g++ musl-dev make libstdc++ zlib build-base
-COPY Gemfile* jekyll_picture_tag.gemspec ./
-COPY lib/jekyll_picture_tag/version.rb ./lib/jekyll_picture_tag/version.rb
-RUN bundle install
-COPY . .
-CMD rake

data/docs/_layouts/directory.html

@@ -1,32 +0,0 @@
----
-layout: default
----
-
-<link href="{{ site.baseurl }}/assets/style.css" rel="stylesheet" type="text/css">
-
-<ul class="directory">
-  <li><a href="{{ site.baseurl }}/">Quick Start</a></li>
-  <li><a href="{{ site.baseurl }}/installation">Installation</a></li>
-  <li><a href="{{ site.baseurl }}/usage">Usage</a></li>
-  <li><a href="{{ site.baseurl }}/global_configuration">Global Settings</a></li>
-  <li><a href="{{ site.baseurl }}/presets">Writing Presets</a></li>
-  <li><a href="{{ site.baseurl }}/example_presets">Example Presets</a></li>
-  <li><a href="{{ site.baseurl }}/output">Output Formats</a></li>
-  <li><a href="{{ site.baseurl }}/notes">Notes and FAQ</a></li>
-  <li><a href="{{ site.baseurl }}/contributing">Contributing</a></li>
-  <li><a href="{{ site.baseurl }}/releases">Release History</a></li>
-</ul>
-
-<hr />
-
-{{ content }}
-
-<script>
-  const navItems = Array.from(document.querySelectorAll('ul.directory li'))
-  const currentPath = window.location.toString()
-  const activeItem = navItems.find(function(item) {
-    return item.firstChild.href == currentPath
-  })
-
-  activeItem.classList.add('active')
-</script>

data/docs/assets/style.css

@@ -1,31 +0,0 @@
-  @media (max-width: 600px) {
-    ul.directory {
-      flex-direction: column;
-      align-items: center;
-    }
-  }
-
-  ul.directory {
-    display: flex;
-    flex-wrap: wrap;
-    justify-content: center;
-    list-style: none;
-    padding-left: 0;
-    flex-grow: 0;
-  }  
-
-  ul.directory li {
-    margin: .3em;
-  }
-
-  ul.directory a {
-    line-height: 2;
-    padding: 8px 20px;
-  }
-
-  li.active a {
-    border-radius: 3px;
-    background-color: #007edf;
-    color: #fff;
-    box-shadow: 2px 2px 3px #999;
-  }

data/docs/contributing.md

@@ -1,109 +0,0 @@
----
----
-# Contributing
-
-Bug reports, feature requests, and feedback are very welcome, either through github issues or via
-email: robert@buchberger.cc 
-
-Pull requests are encouraged! I'm happy to answer questions and provide assistance along the way.
-Don't let any of the recommendations/requests in this guide stop you from submitting one.
-
-## Setup
-
-It's pretty standard:
-
-```
-$ git clone git@github.com:rbuchberger/jekyll_picture_tag.git
-$ cd jekyll_picture_tag
-$ bundle install
-```
-
-## Testing
-
-You probably only need to use docker if it's inconvenient to install ImageMagick 7.
-
-### Bare Metal
-
-`rake test` runs the test suite (both unit tests and integration tests). Ignore the mini_magick
-`method redefined` warnings (unless you know how to fix them?) 
-
-`rake unit` runs just the unit tests, while `rake integration` runs the integration tests. The unit
-test coverage isn't stellar, but both unit and integration tests together hit 100%.
-
-Speaking of coverage, simplecov is set up -- you'll get a measurement of coverage in the test output
-and a nice report in the `coverage` directory. I'd like to move to mutation based coverage testing,
-but that's a project for another day.
-
-The tests do output a few images to the `/tmp/` directory, which I'm pretty sure means it won't work
-on Windows. This is fixable if there is a need, so if that gets in your way just ask.
-
-`rake rubocop` checks code formatting, `rake rubocop:auto_correct` will try to fix any rubocop
-issues, if possible.
-
-`rake` will run all tests and rubocop.
-
-### Docker
-
-The following commands will build and run the tests inside a docker image. This is useful if it's
-inconvenient to install ImageMagick 7, or to ensure the Travis CI build will succeed:
-
-```
-$ docker build . -t jpt
-$ docker run -t jpt
-```
-
-## Docs
-
-I think one of the biggest opportunities for improvement in this plugin is its documentation. I'd
- really love help here, and all you need to know is markdown.
-
-It runs on github pages, which is based on jekyll. You can preview as you edit:
-
-0. Follow setup instructions above
-1. `$ cd docs`
-2. `$ bundle install`
-3. `$ bundle exec jekyll serve`
-4. In a web browser, navigate to `localhost:4000/jekyll_picture_tag/`
-
-## Code Guidelines
-
-* Generally, go for straightforward and readable rather than terse and clever. I'm not actually a
-  very good programmer; I need simple code that's easy to understand.
-
-* Refactoring is welcome, especially in the name of the previous point.
-
-* I'm very reluctant to introduce breaking changes to configuration settings. This rule isn't
-  absolute, but I'm not going to do it without a good reason.
-
-* I've been using 80 characters for code and 100 characters for documentation.
-
-* Don't disable cops without strong justification.
-
-* I generally try to write tests before writing code, especially when fixing bugs. This
-  gives us some confidence that what we think we're testing and what we're actually testing aren't
-  too different.
-
-## Hard rules
-
-These aren't the rules for submitting a pull request, these are the rules for merging into master.
-I'm thrilled to receive any help at all, and I'm more than happy to help with meeting these
-criteria:
-
-* Liquid tag syntax can only be extended; no breaking changes. I'm not willing to force
-  users to dig through their entire site and change every picture tag in order to update to the
-  latest version.
-
-* Maintain "no configuration required" - a new user must be able to add JPT to their gemfile, bundle
-  install, and start writing picture tags in their site without touching a yml file.
-
-* 100% test coverage (Meaning that when running the unit and integration tests together, every line
-  of code in the `lib` folder must run at least once.)
-
-* No failing tests
-
-* No rubocop warnings
-
-### Thanks!
-
-As I said, don't let any of the rules & guidelines scare you away. They're the rules for merging
-into master, not submitting a pull request. I'm thrilled to receive any help at all.

data/docs/example_presets.md

@@ -1,116 +0,0 @@
----
----
-# /_data/picture.yml
-
-These are example settings- I mostly made them up off the top of my head. You
-probably don't want to just copy-paste them. The full documentation
-for these can be found [here]({{ site.baseurl }}/presets).
-
-```yml
-
-# Media presets are just named css media queries, used in several places:
-# - To specify alternate source images (for art direction)
-# - To build the 'sizes' attribute
-# - When given alternate source images, specify which sizes to generate.
-media_presets:
-  wide_desktop: 'min-width: 1801px'
-  desktop: 'max-width: 1800px'
-  wide_tablet: 'max-width: 1200px'
-  tablet: 'max-width: 900px'
-  mobile: 'max-width: 600px'
-
-# Markup presets allow you to group settings together, and select one of them by
-# name in your jekyll tag. All settings are optional.
-markup_presets:
-
-  default:
-    # What form the output markup should take:
-    markup: auto
-
-    # Must be an array, and order matters. Defaults to just 'original', which
-    # does what you'd expect.
-    formats: [webp, original]
-
-    # Must be an array: which image sizes (width in pixels) to generate (unless
-    # directed otherwise below). If not specified, will use sensible default
-    # values.
-    widths: [200, 400, 800, 1600]
-
-    # Alternate source images (for art direction) are associated with media
-    # query presets. Here, you can optionally specify a different set of sizes
-    # to generate for those alternate source images.  This is how you avoid
-    # generating a 1600 pixel wide image that's only shown on narrow screens.
-    # Must be arrays.
-    media_widths: 
-      mobile: [200, 400, 600] 
-      tablet: [400, 600, 800]
-
-    # For building the 'sizes' attribute on img and source tags. specifies how
-    # wide the image will be when a given media query is true. Note that every
-    # source in a given <picture> tag will have the same associated sizes
-    # attribute.
-    sizes: 
-      mobile: 100vw
-      tablet: 80vw
-
-    # Specifies an optional, unconditional size attribute. Can be given alone,
-    # or if specified in combination with 'sizes' below, will be given last
-    # (when no media queries apply).
-    size: 800px
-
-    # Specify the properties of the fallback image. If not specified, will
-    # return a 900 pixel wide image in the original format.
-    fallback_width: 800
-    fallback_format: original
-
-    # Add HTML attributes. 'parent' will go to the <picture> tag if it's there,
-    # otherwise the 'img' tag.
-    attributes:
-      parent: 'data-downloadable="true"'
-      picture: 'class="awesome" data-volume="11"'
-      img: 'class="some-other-class"'
-      a: 'class="image-link"'
-
-    # This will wrap images in a link to the original source image. Obviously
-    # your source images will need to be part of the deployed site for this to
-    # work. If you have issues such as mangled HTML or extra {::nomarkdown}
-    # tags floating around, see docs/notes.md
-    link_source: true
-
-  # This is an example of how you would create a 'multiplier' based srcset;
-  # useful when an image will always be the same size on all screens (icons,
-  # graphics, thumbnails, etc), but you'd like to supply higher resolution
-  # images to devices with higher pixel ratios.
-  icon:
-    base_width: 20 # How wide the 1x image should be
-    pixel_ratios: [1, 1.5, 2]
-    fallback_width: 20
-    attributes:
-      img: 'class="icon"'
-
-  # Here's an example of how you'd configure jekyll-picture-tag to work with
-  # something like lazyload:
-  # https://github.com/verlok/lazyload
-  lazy:
-    # data_auto gives you data-src, data-srcset, and data-sizes instead of src,
-    # srcset, and sizes:
-    markup: data_auto
-    formats: [webp, original]
-    widths: [200, 400, 600, 800]
-    noscript: true # add a fallback image inside a <noscript> tag.
-    attributes: 
-      img: class="lazy"
-
-  # This is an example of how you'd get generated image and a URL, and nothing
-  # else.
-  direct:
-    markup: direct_url
-    fallback_format: webp # Default original
-    fallback_width: 600 # Default 800
-
-  # Here's a naked srcset. Doesn't even give you the surrounding quotes.
-  srcset:
-    markup: naked_srcset
-    formats: [webp] # must be an array, even if it only has one item
-
-```

data/docs/global_configuration.md

@@ -1,173 +0,0 @@
----
----
-# Global Configuration
-
-**All configuration is optional**. If you are happy with the defaults, you don't have to touch a
-single yaml file.
-
-Global settings are stored under the `picture:` key in `/_config.yml`.
-
-**Example config:**
-
-```yml
-picture:
-  source: "assets/images/fullsize"
-  output: "assets/images/generated"
-```
-
-* **Source Image Directory**
-
-  *Format:* `source: (directory)`
-
-  *Example:* `source: images/`
-
-  *Default:* Jekyll site root.
-
-  To make writing tags easier you can specify a source directory for your assets. Base images in the
-  tag will be relative to the `source` directory, which is relative to the Jekyll site root.
-
-  {% raw %}
-  For example, if `source` is set to `assets/images/_fullsize`, the tag
-  `{% picture enishte/portrait.jpg --alt An unsual picture %}` will look for a file at
-  {% endraw %}
-  `assets/images/_fullsize/enishte/portrait.jpg`.
-
-* **Destination Image Directory**
-
-    *Format:* `output: (directory)`
-
-    *Example:* `output: resized_images/`
-
-    *Default*: `generated/`
-
-  Jekyll Picture Tag saves resized, reformatted images to the `output` directory in your compiled
-  site. The organization of your `source` directory is maintained.
-
-  This setting is relative to your compiled site, which means `_site` unless you've changed it.
-
-* **Suppress Warnings**
-
-    *Format:* `suppress_warnings: (true|false)`
-
-    *Example:* `suppress_warnings: true`
-
-    *Default*: `false`
-
-  Jekyll Picture Tag will warn you in a few different scenarios, such as when your base image is
-  smaller than one of the sizes in your preset. (Note that Jekyll Picture Tag will never resize an
-  image to be larger than its source). Set this value to `true`, and these warnings will not be shown.
-
-* **Continue build with missing source images**
-
-    *Format:* `ignore_missing_images: (boolean|environment name|array of environments)`
-
-    *Example:* `ignore_missing_images: [development, testing]`
-
-    *Default:* `false`
-
-  Normally, JPT will raise an error if a source image is missing, causing the entire site build to
-  fail. This setting allows you to bypass this behavior and continue the build, either for certain
-  build environments or all the time. I highly encourage you to set this to `development`, and set
-  the jekyll build environment to `production` when you build for production so you don't shoot
-  yourself in the foot (publish a site with broken images). You can read more about Jekyll
-  environments [here](https://jekyllrb.com/docs/configuration/environments/).
-  
-* **Use Relative Urls**
-
-    *Format:* `relative_url: (true|false)`
-
-    *Example:* `relative_url: false`
-
-    *Default*: `true`
-
-  Whether to use relative (`/generated/test(...).jpg`) or absolute
-  (`https://example.com/generated/test(...).jpg`) urls in your src and srcset attributes.
-
-* **Use a CDN Url**
-
-    *Format:* `cdn_url: (url)`
-
-    *Example:* `cdn_url: https://cdn.example.com`
-
-    *Default*: none
-
-    Use for images that are hosted at a different domain or subdomain than the Jekyll site root. Overrides
-    `relative_url`. Keep reading, the next option is important.
-
-* **CDN build environments**
-
-    *Format:* `cdn_environments: (array of strings)`
-
-    *Example:* `cdn_environments: ['production', 'staging']`
-
-    *Default*: `['production']`
-
-    It's likely that if you're using a CDN, you may not want to use it in your local development environment. This
-    allows you to build a site with local images while in development, and still push to a CDN when you build for
-    production by specifying a different [environment](https://jekyllrb.com/docs/configuration/environments/). 
-
-    **Note that the default jekyll environment is `development`**, meaning that if you only set `cdn_url` and run
-    `jekyll serve` or `jekyll build`, nothing will change. You'll either need to run `JEKYLL_ENV=production bundle exec
-    jekyll build`, or add `development` to this setting.
-
-* **Kramdown nomarkdown fix**
-
-  *Format:* `nomarkdown: (true|false)`
-
-  *Example:* `nomarkdown: false`
-
-  *Default:* `true`
-
-  Whether or not to surround j-p-t's output with a `{::nomarkdown}..{:/nomarkdown}` block when called
-  from within a markdown file. 
-
-  This setting is overridden by the same setting in a preset. See [the notes]({{ site.baseurl
-  }}/notes) for more detailed information. 
-
-* **Fast Build**
-
-  *Format:* `fast_build: (true|false|environment|array of environments)`
-
-  *Examples:* 
-
-    - `fast_build: true`
-
-    - `fast_build: development`
-
-    - `fast_build: [development, staging]`
-
-  *Default:* `false`
-
-  Makes a tradeoff: Speeds repeated build times for sites with many images, by assuming that the
-  filename alone is enough to uniquely identify a source image. This doesn't speed up image
-  generation, just detection of whether or not it's necessary.
-
-  Ordinarily, JPT generates an MD5 hash for every source image, every site build. This ensures that
-  if you replace one image with another, but keep the filename the same, JPT will correctly generate
-  images for the new file. If you have many large images and/or limited hardware, this can take some
-  time and make the development process painful. Enable this setting to skip MD5 hash checking on
-  existing generated images (most of the time), and just assume that if the filename, format, and
-  width match then it's the right one. If there are multiple possible matches (resulting from
-  leftover generated images from previous filename replacements), it'll compute a hash instead of
-  guessing randomly.
-
-* **Disable Jekyll Picture Tag**
-
-  *Format:* `disabled: (true|false|environment|array of environments)`
-
-  *Examples:* 
-
-    - `disabled: true`
-
-    - `disabled: development`
-
-    - `disabled: [development, staging]`
-
-  *Default:* `false`
-
-  Disable image and markup generation entirely. Useful for debugging, or to speed up site builds
-  when you're working on something else.
-
-  Hint: If you're going to toggle this on and off frequently, you might just use an environment
-  variable. Set this to something like `nopics`, and then start the Jekyll server with something
-  like `JEKYLL_ENV=nopics bundle exec jekyll serve` when you don't want image generation.