middleman-tinify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb1129125eee002dd0f7ad02f16f39c2749e7c0b
+  data.tar.gz: 73ba80b5e819409d43e00dd674d999310fa29f4d
+SHA512:
+  metadata.gz: 32b4c1ef31422e0fd7ff7f69f93cc00369b10b6c75257154c2001215c77f86cb549c56643595deb940030703aefb2a1457c1549c17d3f7204f75fd13040355cc
+  data.tar.gz: 8a4a1d1fa5d8bae5cbe54390dfe35363e3960974d757cc9de0699a289ad1662fd448a8bc05a770cf4ba72de813cdd0250905c8e8e739803630a4a317709a8741

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+/pkg
+/tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Planio GmbH
+
+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,67 @@
+middleman-tinify
+================
+
+This minimizes JPGs and PNGs during your middleman builds using the
+[tinify.com](https://api.tinify.com) API service. In order to use this service,
+you need to sign up for their service and get an API key.
+
+Installation
+------------
+
+Add the `middleman-tinify` gem to your Gemfile:
+
+```ruby
+# Gemfile
+gem 'middleman-tinify'
+```
+
+and run
+
+```
+bundle install
+```
+
+
+Usage
+-----
+
+Add the following line to your middleman config file:
+
+```ruby
+# config.rb
+
+activate :tinify, key: 'WfYnAvEjI9pELLsTyh36mKiZbYLZQtZz'
+```
+
+By default, all PNGs and JPGs within your `images_dir` will be minified. The
+following optional configuration is available:
+
+* `path`: Configure a different path to locate the relevant images. If left
+  blank, the `images_path` will be used. If your images are located in
+  `source/pictures`, use `path: 'pictures'`.
+
+* `proxy`: You can instruct the API client to make all requests over an HTTP
+  proxy. Set the URL of your proxy server, which can optionally include
+  credentials. Take a look at the [official API
+  documentation](https://tinypng.com/developers/reference/ruby) of the `tinify`
+  gem for an example.
+
+
+**N.B.:** Image minification will only be done in the regular build, not in the
+preview server.
+
+Running tests
+-------------
+
+Checkout this repository and execute the following commands:
+
+```
+bundle install
+TINIFY_KEY=$YOUR_API_KEY rake
+```
+
+
+License
+-------
+
+This software is licensed under the MIT License. [View the license](LICENSE).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/step_definitions/file_size.rb

@@ -0,0 +1,3 @@
+Then(/^the file "([^"]*)" should have (\d+) bytes$/) do |file, size|
+  expect(File.size(File.join(expand_path("."), file))).to eq size.to_i
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-tinify')

data/features/tinify.feature

@@ -0,0 +1,29 @@
+Feature: Minify PNGs
+
+  Scenario: No changes if tinify is not activated
+    Given a fixture app "image-app"
+    And a file named "config.rb" with:
+      """
+      """
+    And a successfully built app at "image-app"
+    Then the file "build/images/panda.png" should have 56907 bytes
+
+
+  Scenario: PNGs in images folder are minimized
+    Given a fixture app "image-app"
+    And a file named "config.rb" with:
+      """
+        activate :tinify, key: ENV['TINIFY_KEY']
+      """
+    And a successfully built app at "image-app"
+    Then the file "build/images/panda.png" should have 15237 bytes
+
+  Scenario: Image folder may be set explicitly
+    Given a fixture app "image-app"
+    And a file named "config.rb" with:
+      """
+        set :images_dir, 'pictures'
+        activate :tinify, key: ENV['TINIFY_KEY'], path: 'images'
+      """
+    And a successfully built app at "image-app"
+    Then the file "build/images/panda.png" should have 15237 bytes

data/lib/middleman-tinify.rb

@@ -0,0 +1,32 @@
+require "middleman-core"
+
+module Middleman
+  class Tinify < Extension
+    option :key, nil, 'API key for api.tinify.com'
+    option :proxy, nil, 'Proxy settings to access tinify.com service (optional)'
+    option :path, nil, 'Path to images to tinify, defaults to :images_dir if not set'
+
+    def initialize(app, options_hash={}, &block)
+      super
+      require 'tinify'
+
+      ::Tinify.key = options.key
+      ::Tinify.proxy = options.proxy if options.proxy
+    end
+
+    def after_build(builder)
+      source_dir = File.join(app.config[:build_dir], options.path || app.config[:images_dir])
+      prefix = app.config[:build_dir] + File::SEPARATOR
+
+      files = Dir[File.join(source_dir, "**", "*.{jpg,jpeg,png}")]
+
+      files.each do |file|
+        ::Tinify.from_file(file).to_file(file)
+
+        builder.thor.say_status :tinified, file.sub(prefix, "")
+      end
+    end
+  end
+end
+
+Middleman::Extensions.register(:tinify) { Middleman::Tinify }

data/middleman-tinify.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-tinify"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Gregor Schmidt - Planio GmbH"]
+  s.email       = ["support@plan.io"]
+  s.homepage    = "https://plan.io"
+  s.summary     = %q{Minfiy images in middleman}
+  s.description = %q{Uses tinify service to minimize images during your middleman build.}
+  s.license = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("middleman-core", "~> 4.2")
+  s.add_runtime_dependency("tinify", "~> 1.5")
+
+  s.add_development_dependency("aruba")
+  s.add_development_dependency("bundler")
+  s.add_development_dependency("capybara")
+  s.add_development_dependency("cucumber")
+  s.add_development_dependency("middleman-cli")
+  s.add_development_dependency("rake")
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: middleman-tinify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gregor Schmidt - Planio GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-25 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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: tinify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: middleman-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Uses tinify service to minimize images during your middleman build.
+email:
+- support@plan.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/step_definitions/file_size.rb
+- features/support/env.rb
+- features/tinify.feature
+- fixtures/image-app/source/images/panda.png
+- lib/middleman-tinify.rb
+- middleman-tinify.gemspec
+homepage: https://plan.io
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Minfiy images in middleman
+test_files:
+- features/step_definitions/file_size.rb
+- features/support/env.rb
+- features/tinify.feature