rails_responsive_images 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 533708a79d576f39b8d794bc49edd323b38f400d
-  data.tar.gz: f197d41ae752d62b983e1f92dbb1866d02a1aa69
+  metadata.gz: 843b8ec2d4b097ea84360d505d967f80bc26eed4
+  data.tar.gz: 00becd925cc066477f201671c119c0566e29fdb6
 SHA512:
-  metadata.gz: 390c812e13f4ef90f387a499d72e4d30ac9eafce3f9f8cc7d6ce225e1ed9f4c1aa55f7469eac279d75b881b7d953064ba9799fac3ebdd0902f5c8f19b416ee6f
-  data.tar.gz: ec61eb527efd3b44f9121bb185472c43a7471d61f45ce9682a058e4694df59fe8b9057b522216ab1cd78cfe8c6d19e79b51e051d36ab374c0b8f9452d5f757a1
+  metadata.gz: eb312fc7220ea6e51af9d00f1e56dc3e54e1ad5b8b934ac833089cb6a26e20eff66d2506fa50388de44c0c1cc6f79ab0d5259e2e8b613c80688e4e559508bca1
+  data.tar.gz: 07507cd44debe7ded4894ccffd313cc75758f26f788007d19de0700c790a4cf8f81e521f3cf064fbe6373df9bb5a5e2f64b1e456cbca49e8bbff3a6cb5a95b9f

data/README.md

@@ -1,12 +1,17 @@
-# RailsResponsiveImages
+# Rails responsive images
 
-A Rails image_tag() extension to generate HTML5 <picture> tag markup from the W3C HTML Responsive Images Extension Proposal.
+A Rails image_tag() extension to generate HTML5 <picture> tag markup from the W3C HTML Responsive Images Extension Proposal. Dont't care about image resizing, the gem will do the work for you - on the fly ;-) or just use the rake task "rake rails_responsive_images".
 
+The following image_tag
 ```ruby
+= image_tag 'awesome/picture.jpeg', alt: 'awesome', responsive: true
+```
+will generate this output:
+```html
 <picture>
-  <source media="(max-width: 766px)" srcset="/assets/responsive_images_766/picture.jpg">
-  <source media="(max-width: 990px)" srcset="/assets/responsive_images_990/picture.jpg">
-  <source media="(max-width: 200px)" srcset="/assets/responsive_images_200/picture.jpg">
+  <source media="(max-width: 767px)" srcset="/assets/responsive_images_767/picture.jpg">
+  <source media="(max-width: 991px)" srcset="/assets/responsive_images_991/picture.jpg">
+  <source media="(max-width: 1999px)" srcset="/assets/responsive_images_1999/picture.jpg">
   <img width="2568" height="878" alt="awesome" src="/assets/picture.jpg">
 </picture>
 ```
@@ -44,6 +49,10 @@ Require jquery-picture for cross browser support
 ```ruby
 = image_tag 'awesome/picture.jpeg', alt: 'awesome', responsive: true
 ```
+## TODO
+- write tests
+- write docs
+- review & cleanup the code
 
 ## Contributing
 

data/app/controllers/rails_responsive_images/assets_controller.rb

@@ -1,6 +1,4 @@
 module RailsResponsiveImages
-  require 'RMagick'
-  require 'fileutils'
   class AssetsController < ActionController::Base
     def responsive_image
       filepath = params[:filepath]
@@ -18,29 +16,14 @@ module RailsResponsiveImages
       full_original_filepath = Rails.root.join('app', 'assets', 'images', original_filepath, image_filename)
       full_responsive_filepath = Rails.root.join('app', 'assets', 'images', filepath, image_filename)
 
-      create_responsive_folder!(full_responsive_filepath)
+      Image.instance.create_responsive_folder!(full_responsive_filepath)
 
       fail ActionController::RoutingError.new('Not found') unless File.exist?(full_original_filepath)
 
-      generate_responsive_image!(full_original_filepath, requested_image_size, full_responsive_filepath)
+      Image.instance.generate_responsive_image!(full_original_filepath, requested_image_size, full_responsive_filepath)
 
       mime_type = MIME::Types.type_for("#{full_responsive_filepath}").first.content_type
       send_file full_responsive_filepath, type: mime_type, disposition: :inline
     end
-
-    private
-
-    def create_responsive_folder!(path)
-      dirname = File.dirname(path)
-      unless File.directory?(dirname)
-        FileUtils.mkdir_p(dirname)
-      end
-    end
-
-    def generate_responsive_image!(original_image, size, output_path)
-      img = ::Magick::Image.read(original_image).first
-      img = img.resize_to_fit(size, size)
-      img.write(output_path)
-    end
   end
 end

data/app/models/rails_responsive_images/image.rb

@@ -0,0 +1,20 @@
+module RailsResponsiveImages
+  require 'RMagick'
+  require 'fileutils'
+  class Image
+    include Singleton
+
+    def create_responsive_folder!(path)
+      dirname = File.dirname(path)
+      unless File.directory?(dirname)
+        FileUtils.mkdir_p(dirname)
+      end
+    end
+
+    def generate_responsive_image!(original_image, size, output_path)
+      img = ::Magick::Image.read(original_image).first
+      img = img.resize_to_fit(size, size)
+      img.write(output_path)
+    end
+  end
+end

data/config/routes.rb

@@ -1,3 +1,3 @@
-Rails.application.routes.draw do
+::Rails.application.routes.draw do
   get '/assets/*filepath/:filename', to: 'rails_responsive_images/assets#responsive_image'
 end

data/lib/rails_responsive_images/version.rb

@@ -1,3 +1,3 @@
 module RailsResponsiveImages
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/tasks/rails_responsive_images.rake

@@ -0,0 +1,38 @@
+require "rails_responsive_images"
+
+desc "Rails responsive images builds different sized versions from your images inside of the asset folder"
+task rails_responsive_images: [ 'rails_responsive_images:check_requirements', 'rails_responsive_images:resize' ]
+
+namespace :rails_responsive_images do
+  desc "Check for required programms"
+  task :check_requirements do
+    RakeFileUtils.verbose(false)
+    tools = %w[convert] # imagemagick
+    puts "\nResize images with the following tools:"
+    tools.delete_if { |tool| sh('which', tool) rescue false }
+    raise "The following tools must be installed and accessible from the execution path: #{ tools.join(', ') }\n\n" if tools.size > 0
+  end
+
+  task :resize do
+    RakeFileUtils.verbose(false)
+    start_time = Time.now
+
+    file_list = FileList.new(Rails.root.join('app', 'assets', 'images/**/*.{gif,jpeg,jpg,png}').to_s) do |f|
+      f.exclude(/(responsive_images_)\d+/)
+    end
+
+    puts "\nResize #{ file_list.size } image files."
+
+    ::RailsResponsiveImages.configuration.image_sizes.each do |size|
+      file_list.split(' ').first.each do |original_filepath|
+        filepath = original_filepath.gsub(Rails.root.join('app', 'assets', 'images').to_s, '')
+        responsive_filepath = Rails.root.join('app', 'assets', 'images', "responsive_images_#{size}", filepath.sub(/\A\//, ''))
+        ::RailsResponsiveImages::Image.instance.create_responsive_folder!(responsive_filepath)
+        ::RailsResponsiveImages::Image.instance.generate_responsive_image!(original_filepath, size, responsive_filepath)
+      end
+    end
+
+    minutes, seconds = (Time.now - start_time).divmod 60
+    puts "\nTotal run time: #{minutes}m #{seconds.round}s\n"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_responsive_images
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Christoph Chilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,12 +95,14 @@ files:
 - README.md
 - Rakefile
 - app/controllers/rails_responsive_images/assets_controller.rb
+- app/models/rails_responsive_images/image.rb
 - config/routes.rb
 - lib/assets/javascripts/jquery-picture.js
 - lib/rails_responsive_images.rb
 - lib/rails_responsive_images/configuration.rb
 - lib/rails_responsive_images/engine.rb
 - lib/rails_responsive_images/version.rb
+- lib/tasks/rails_responsive_images.rake
 - rails_responsive_images.gemspec
 - spec/spec_helper.rb
 homepage: https://chilian.de