kirigami 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86731343cb2b71eedd73d57ccfc13e60fdb88990
+  data.tar.gz: df44e2170e043317a0fe116e4699169dbb47651c
+SHA512:
+  metadata.gz: 48b81fb05fe359d2ad8dcce90222d09ea627e53ff489c1c19624157eb43524f485e745097032fbe147538659e3d7197f2ff2da078d53d75b7273d4738b797f77
+  data.tar.gz: c0a48c86142d16c5259084dbc1548574a23f9f938e3376a9c4512a9be9c803754e7bd9d6702bc30add01249f6b56c7730f0c6b7515fac1da681b97df5cd8252b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kirigami.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    kirigami (0.4.0)
+      activesupport
+      mini_magick
+      rails (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.4)
+      actionpack (= 5.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.2)
+    erubi (1.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_magick (4.8.0)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.4)
+      actioncable (= 5.1.4)
+      actionmailer (= 5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      activemodel (= 5.1.4)
+      activerecord (= 5.1.4)
+      activesupport (= 5.1.4)
+      bundler (>= 1.3.0)
+      railties (= 5.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  kirigami!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bodacious
+
+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,89 @@
+# Kirigami
+
+Cut the images in your assets dir to a web-friendly size.
+
+Kirigami performs optimisations on your images to ensure they are web-friendly.
+
+By default, Kirigami uses the optimisation suggestions recommended by
+[Google's Page Speed Insights](https://developers.google.com/speed/docs/insights/OptimizeImages)
+
+In ImageMagick terms, these are:
+
+    convert original.jpg -sampling-factor 4:2:0 -strip -quality 85 -interlace JPEG -colorspace RGB new.jpg
+
+Image dimensions, extensions, and filenames are not changed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kirigami'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kirigami
+
+## Usage
+
+**WARNING:** This will change the size and quality of images in your Rails application.
+Make sure you have read the documentation and have backed up your images before you proceed
+
+`$ rails kirigami:cut`
+
+This rake task will go through each of the images specified in your configuration and
+crop their size (if necessary), remove any metadata, and compress them (JPG only).
+
+To peek under the hood, check out [lib/kirigami/image.rb](lib/kirigami/image.rb#L28-L41)
+
+## Configuration
+
+To configure options, add an initializer in `config/initializers/kirigami.rb`
+
+``` ruby
+Kirigami.configure do |config|
+
+  # Only convert images with these extensions (default: %w[ png jpg jpeg gif ])
+  self.config.image_extensions  ||= %w[ png jpg jpeg gif ]
+
+  # Create a backup copy of each image before conversion (default: true)
+  self.config.safe_mode         ||= true
+
+  # JPEG compression quality (default: "85%")
+  self.config.jpeg_compression_quality ||= '85%'
+
+  # An array of dirpaths where your images are located (defaults: "./app/assets/images")
+  self.config.image_paths ||= "[yourapp]/app/assets/images"
+
+  # Ignore images within these dirpaths (default: [])
+  self.config.exclude_paths     ||= []
+
+  # Set minimagick to debug mode (default: false)
+  self.config.debug = false
+
+end
+```
+
+## TODO
+
+- [] Add support for specifying max sizes for individual images
+- [] Add proper tests
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/katanacode/kirigami.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+import 'lib/tasks/kirigami/cut.rb'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kirigami"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kirigami.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kirigami/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kirigami"
+  spec.version       = Kirigami::VERSION
+  spec.authors       = ["Bodacious"]
+  spec.email         = ["gavin@katanacode.com"]
+
+  spec.summary       = %q{Cut down your assets/images to web-friendly sizes}
+  spec.description   = %q{Cut down your assets/images to a web-friendly sizes}
+  spec.homepage      = "https://github.com/katanacode/kirigami"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'mini_magick'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'rails', ">= 3.0.0"
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/kirigami.rb

@@ -0,0 +1,14 @@
+require 'mini_magick'
+require 'active_support/configurable'
+
+require "kirigami/version"
+if defined?(Rails)
+  require 'kirigami/railtie'
+else
+  warn "Kirigami is currently configured for Rails projects."
+end
+require 'kirigami/image'
+require 'kirigami/configuration'
+module Kirigami
+  extend Kirigami::Configuration
+end

data/lib/kirigami/configuration.rb

@@ -0,0 +1,83 @@
+module Kirigami
+
+  module Configuration
+
+    ##
+    #
+    IMAGE_EXTENSIONS = %w[ png jpg jpeg gif ]
+
+    ##
+    #
+    EXCLUDE_PATHS = []
+
+    ##
+    #
+    SAFE_MODE = true
+
+    ##
+    #
+    JPEG_COMPRESSION_QUALITY = '85%'.freeze
+
+    ##
+    #
+    JPEG_COLORSPACE = 'RGB'.freeze
+
+    ##
+    #
+    JPEG_SAMPLING_FACTOR = "4:2:0".freeze
+
+    ##
+    #
+    JPEG_INTERLACING = "JPEG".freeze
+
+    ##
+    #
+    DEBUG = false
+
+
+    def self.extended(klass)
+      klass.class_eval do
+        include ActiveSupport::Configurable
+
+        config.image_extensions ||= IMAGE_EXTENSIONS
+
+        config.image_paths  ||= Array(rails_image_paths)
+
+        config.exclude_paths ||= EXCLUDE_PATHS
+
+        config.safe_mode ||= SAFE_MODE
+
+        config.jpeg_compression_quality ||= JPEG_COMPRESSION_QUALITY
+
+        config.jpeg_colorspace ||= JPEG_COLORSPACE
+
+        config.jpeg_sampling_factor ||= JPEG_SAMPLING_FACTOR
+
+        config.jpeg_interlacing ||= JPEG_INTERLACING
+
+        MiniMagick.configure do |magick|
+          magick.debug = Logger::DEBUG if config.debug
+        end
+
+      end
+    end
+
+    def logger
+      @logger ||= Logger.new($stdout, level: config.debug ? Logger::DEBUG : Logger::INFO)
+    end
+
+
+    private
+
+
+    def rails_assets_path
+      File.join("app/assets/images/**/*\.{%{formats}}")
+    end
+
+    def rails_image_paths
+      rails_assets_path % { formats: config.image_extensions.join(",") }
+    end
+
+  end
+
+end

data/lib/kirigami/image.rb

@@ -0,0 +1,89 @@
+module Kirigami
+  # An Image file to be compressed and cut via Kirigami
+  class Image
+
+    ##
+    # An ImageMagick Image Geometry for the target file size
+    # http://www.imagemagick.org/script/command-line-processing.php#geometry
+    #
+    # Returns String
+    attr_reader :max_size
+
+
+    ##
+    # The filepath of the image to be cut
+    #
+    # Returns Pathname
+    attr_reader :path
+
+    # Create a new Image
+    #
+    # max_size - An ImageSize to specify the size and name of image.
+    def initialize(path, max_size)
+      @path          = path
+      @max_size      = max_size
+    end
+
+    # Cuts the File down to size! Creates a backup copy first, if required.
+    def cut!
+      create_backup_copy
+      MiniMagick::Tool::Mogrify.new do |mogrify|
+        mogrify.resize(max_size)
+        mogrify.strip
+        if jpeg?
+          mogrify.colorspace(Kirigami.config.jpeg_colorspace)
+          mogrify.sampling_factor(Kirigami.config.jpeg_sampling_factor)
+          mogrify.interlace(Kirigami.config.jpeg_interlacing)
+          mogrify.quality(Kirigami.config.jpeg_compression_quality)
+        end
+        mogrify << target_filepath
+      end
+    end
+
+
+    private
+
+
+    # Create a backup copy of the File first
+    def create_backup_copy
+      FileUtils.cp(target_filepath, backup_filepath) if Kirigami.config.safe_mode
+    end
+
+    # The absolute filepath for the target File
+    #
+    # Returns Pathname
+    def target_filepath
+      File.join(File.dirname(path), filename)
+    end
+
+    # The filename for the target File
+    #
+    # Returns String
+    def filename
+      File.basename(path)
+    end
+
+    # The filename for the backup File. Uses {filename} + ".BAK"
+    #
+    # Returns String
+    def backup_filename
+      File.basename(path) + ".BAK"
+    end
+
+    # The absolute filepath for the backup File
+    #
+    # Returns Pathname
+    def backup_filepath
+      File.join(File.dirname(path), backup_filename)
+    end
+
+    # Is the target File a JPEG?
+    #
+    # Returns Boolean
+    def jpeg?
+      filename.ends_with?(".jpg")
+    end
+
+  end
+
+end

data/lib/kirigami/railtie.rb

@@ -0,0 +1,8 @@
+module Kirigami
+  class Railtie < Rails::Railtie
+    rake_tasks do
+
+      require_relative '../tasks/kirigami/cut.rb'
+    end
+  end
+end

data/lib/kirigami/version.rb

@@ -0,0 +1,3 @@
+module Kirigami
+  VERSION = "0.4.0"
+end

data/lib/tasks/kirigami/cut.rb

@@ -0,0 +1,22 @@
+require 'kirigami'
+
+namespace :kirigami do
+
+  desc "Cuts images down to web-friendly size"
+  task :cut  do
+    bash_pattern = "{" + Kirigami.config.image_paths.join(",") + "}"
+    Dir[bash_pattern].each do |image_path|
+      exclude_path = Kirigami.config.exclude_paths.detect do |path|
+        File.expand_path(image_path).to_s.starts_with?(path.realpath.to_s)
+      end
+      if exclude_path
+        Kirigami.logger.debug("Skipping image because: #{exclude_path} is excluded")
+        next
+      else
+        Kirigami.logger.debug("Processing image: #{image_path}")
+        Kirigami::Image.new(image_path, '2400x1600>').tap(&:cut!)
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: kirigami
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Cut down your assets/images to a web-friendly sizes
+email:
+- gavin@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kirigami.gemspec
+- lib/kirigami.rb
+- lib/kirigami/configuration.rb
+- lib/kirigami/image.rb
+- lib/kirigami/railtie.rb
+- lib/kirigami/version.rb
+- lib/tasks/kirigami/cut.rb
+homepage: https://github.com/katanacode/kirigami
+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: Cut down your assets/images to web-friendly sizes
+test_files: []