scene7ize 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scene7ize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brad Carson
+
+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,38 @@
+# Scene7ize
+
+Converts local image paths in an HTML or CSS file to Scene7 paths containing dimensions and format info.  Will make working with Scene7 a little less unbearable.
+
+Automatically assumes JPGs have been optimized, default quality is set to 100.
+
+## Installation
+
+    $ gem install scene7ize
+
+## Usage
+
+The first argument is the Scene7 URL prefix.
+The second argument is an input file.
+Third argument (optional) is an output file.
+
+To run in "safe mode", specify an output file:
+
+    $ scene7ize http://s7.example.com index.html output.html
+
+Or, omit the output file to replace contents of an input file.
+
+    $ scene7ize http://s7.example.com index.html
+
+## TODO
+
+1. Code documentation
+2. Better error handling and documentation for arguments
+3. Accept a default parameter to set JPEG quality
+4. Create a way to reverse the Scene7ize process and restore original paths (likely by searching path for image files)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/scene7ize

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'scene7ize'
+require 'scene7ize/cli'
+
+Scene7ize::CLI.start

data/lib/scene7ize/cli.rb

@@ -0,0 +1,55 @@
+require 'thor'
+
+module Scene7ize
+
+  # Facade for Scene7ize command line interface managed by [Thor](https://github.com/wycats/thor).
+  # This is the main interface to Scene7ize that is called by the Scene7ize binary `bin/scene7ize`.
+  # Do not put any logic in here, create a class and delegate instead.
+  class CLI < Thor
+
+    require 'scene7ize'
+    require 'scene7ize/version'
+
+    desc 'parse', 'Parses an input file, replacing image URLs with Scene7 ones'
+    method_option :url_prefix,
+                  :type => :string,
+                  :aliases => '-u',
+                  :banner => 'the Scene7 URL prefix',
+                  :required => true
+
+    method_option :input_file,
+                  :type => :string,
+                  :aliases => '-i',
+                  :banner => 'the input file to process',
+                  :required => true
+
+    method_option :output_file,
+                  :type => :string,
+                  :aliases => '-o',
+                  :banner => 'write to an output file instead of overwriting the input file'
+    def parse
+
+      Scene7ize.parse_file(options[:url_prefix], options[:input_file], options[:output_file])
+
+    end
+
+
+    desc 'version', 'Show the Guard version'
+    map %w(-v --version) => :version
+
+    # Shows the current version of Scene7ize.
+    #
+    # @see Scene7ize::VERSION
+    #
+    def version
+      puts "Scene7ize version #{ ::Scene7ize::VERSION }"
+    end
+
+    private
+
+    def method_missing(meth, *args)
+      help
+    end
+  end
+
+end

data/lib/scene7ize/version.rb

@@ -0,0 +1,3 @@
+module Scene7ize
+  VERSION = "0.2.0"
+end

data/lib/scene7ize.rb

@@ -0,0 +1,48 @@
+require "scene7ize/version"
+require 'mini_magick'
+require 'uri'
+
+module Scene7ize
+  DEFAULT_REGEX = /(?<=['"])(?<dir_and_basename>((?!['"]).)*)\.(?<ext>gif|jpg|jpeg|png)(?=['"])/im
+
+
+  def self.scene7url_from(scene7prefix, image_filename)
+    # TODO: error handling
+    image = MiniMagick::Image.open(image_filename)
+
+    suffix = case image[:format].downcase
+      when 'jpg', 'jpeg'
+        '&qlt=100'
+      when 'png'
+        '&fmt=png-alpha'
+      when 'gif'
+        '&fmt=gif-alpha'
+      else
+        ""
+    end
+
+    basename = File.basename(image_filename, File.extname(image_filename))
+
+    # TODO: error handle  URI::InvalidURIError
+    URI.join(scene7prefix, "#{basename}?wid=#{image[:width]}&hei=#{image[:height]}#{suffix}").to_s
+  end
+
+
+  def self.parse_file(scene7prefix, input_file, output_file = nil)
+    file_content = File.read(input_file)
+    input_file_path = File.dirname(input_file)
+
+    replacement = file_content.gsub!(DEFAULT_REGEX) do |match|
+      image_filename = "#{$~[:dir_and_basename]}.#{$~[:ext]}"
+
+      # reconstruct image path relative to input file and open
+      image_filename = File.join(input_file_path, image_filename)
+      self.scene7url_from(scene7prefix, image_filename)
+    end
+
+    output_file = input_file if output_file.nil?
+    File.open(output_file, "w") { |file| file.puts replacement }
+
+  end
+
+end

data/scene7ize.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scene7ize/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "scene7ize"
+  gem.version       = Scene7ize::VERSION
+  gem.authors       = ["Brad Carson"]
+  gem.email         = ["brad@pixelwavedesign.com"]
+  gem.description   = %q{...}
+  gem.summary       = %q{Converts local image paths in an HTML or CSS file to Scene7 paths containing dimensions and format data}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
+  gem.add_dependency 'thor'
+  gem.add_dependency 'mini_magick'
+
+end

data/spec/scene7ize_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Scene7ize do
+
+  context "#parse_file" do
+
+    before(:each) do
+      @input_filename = 'index.html'
+      @output_filename = 'output.html'
+      @image = double("Image", :width => 10, :height => 15, :format => 'jpg')
+      @s7_url_prefix = 'http://s7.example.com'
+      @s7_url = "#{@s7_url_prefix}/test-image?wid=#{@image.width}&hei=#{@image.height}&qlt=100"
+
+      # I suspect that in this test we really don't even care about the file contents and could
+      # omit this from the test since we are really just ensuring a different output file is
+      # being written?
+
+      @input_data = <<-CONTENTS
+        <p id="jpg"><a href="test-image.jpg"><img src="test-image.jpg" alt="Test jpg"></a></p>
+      CONTENTS
+
+      @output_data = <<-CONTENTS
+        <p id="jpg"><a href="#{@s7_url}"><img src="#{@s7_url}" alt="Test jpg"></a></p>
+      CONTENTS
+    end
+
+    it "should write to an output file when one is given" do
+      File.stub(:read).with(@input_filename) { @input_data }
+      Scene7ize.stub(:scene7url_from)
+      File.should_not_receive(:open).with(@input_filename)
+      File.should_receive(:open).with(@output_filename, 'w').and_return(@output_data)
+      Scene7ize.parse_file(@s7_url_prefix, @input_filename, @output_filename)
+    end
+
+    it "should overwrite input file when an output is not specified" do
+      File.stub(:read).with(@input_filename) { @input_data }
+      Scene7ize.stub(:scene7url_from)
+      File.should_not_receive(:open).with(@output_filename)
+      File.should_receive(:open).with(@input_filename, 'w').and_return(@output_data)
+      Scene7ize.parse_file(@s7_url_prefix, @input_filename)
+    end
+
+    it "should display an error given an invalid input file" do
+      expect { Scene7ize.parse_file(@s7_url_prefix, 'file-that-doesnt-exist.ext') }.to raise_error
+    end
+
+  end
+
+
+
+  context "#scene7url_from" do
+
+    context "given a supported image" do
+      before(:each) do
+        @image_filename = 'test.jpg'
+        @image = { :width => 10, :height => 15, :format => 'jpg' }
+
+        MiniMagick::Image.should_receive(:open).and_return(@image)
+        @scene7url = Scene7ize.scene7url_from("http://example.com/scene7/", @image_filename)
+      end
+
+      it "should contain a specified prefix"
+
+      it "should create a valid scene7 url" do
+        @scene7url.should == "http://example.com/scene7/test?wid=10&hei=15&qlt=100"
+      end
+
+      it "should contain a valid width parameter" do
+        @scene7url.should match /wid=10/
+      end
+
+      it "should contain a valid height parameter" do
+        @scene7url.should match /hei=15/
+      end
+
+      it "should contain a quality format parameter" do
+        @scene7url.should match /qlt=100/
+      end
+
+      it "should not contain a file extension" do
+        @scene7url.should_not match /\.(jpg|png|jpeg|gif)\?/
+      end
+    end
+
+    it "given a PNG, should contain a valid format parameter" do
+      @image_filename = 'test.png'
+      @image = { :width => 10, :height => 15, :format => 'png' }
+
+      MiniMagick::Image.should_receive(:open).and_return(@image)
+      @scene7url = Scene7ize.scene7url_from("http://example.com/scene7/", @image_filename)
+
+      @scene7url.should match /fmt=png-alpha/
+      @scene7url.should_not match /fmt=gif-alpha/
+      @scene7url.should_not match /qlt=\d{1,}/
+    end
+
+    it "given a GIF, should contain a valid format parameter" do
+      @image_filename = 'test.gif'
+      @image = { :width => 10, :height => 15, :format => 'gif' }
+
+      MiniMagick::Image.should_receive(:open).and_return(@image)
+      @scene7url = Scene7ize.scene7url_from("http://example.com/scene7/", @image_filename)
+
+      @scene7url.should match /fmt=gif-alpha/
+      @scene7url.should_not match /fmt=png-alpha/
+      @scene7url.should_not match /qlt=\d{1,}/
+    end
+
+    it "should throw an error if not a valid image file" do
+      @image_filename = 'test.png'
+
+      expect { Scene7ize.scene7url_from("http://example.com/scene7/", @image_filename) }.to raise_error
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'scene7ize'
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: scene7ize
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Brad Carson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '...'
+email:
+- brad@pixelwavedesign.com
+executables:
+- scene7ize
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/scene7ize
+- lib/scene7ize.rb
+- lib/scene7ize/cli.rb
+- lib/scene7ize/version.rb
+- scene7ize.gemspec
+- spec/scene7ize_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Converts local image paths in an HTML or CSS file to Scene7 paths containing
+  dimensions and format data
+test_files:
+- spec/scene7ize_spec.rb
+- spec/spec_helper.rb