merchii-placeholder_image 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.bundle
+.rbx
+.*~
+Gemfile.lock
+pkg/*
+*.gem
+*.rbc
+*~

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - ruby-head
+  - rbx
+notifications:
+  disabled: true

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  group :darwin do
+    gem 'rb-fsevent'
+  end
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { "spec" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+  watch(%r|^Gemfile\.lock|)           { "spec" }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jonas Grimfelt, Merchii. http://merchii.com
+
+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,55 @@
+# PLACEHOLDER_IMAGE [![](https://secure.travis-ci.org/merchii/placeholder_image.png)](http://travis-ci.org/merchii/placeholder_image)
+
+*Generate generic placeholder vector images - just like placehold.it, but native.*
+
+## Dependencies
+
+* **[rmagick](https://github.com/rmagick/rmagick)** - for now, plan to optionally replace it with [mini_magick](https://github.com/probablycorey/mini_magick) when I "get" the API well enough.
+* **[commander](https://github.com/visionmedia/commander)** - for command-line support.
+
+## Usage
+
+Command-line:
+
+```shell
+$ placeholder_image 150x100 /tmp/placeholder.png
+$ placeholder_image 300x300 /tmp/placeholder.png --text "Hello" --bgcolor "#dddddd" --color "#bbbbbb"
+```
+
+Code:
+
+```ruby
+generator = PlaceholderImage::Generator.new('150x100')
+generator.generate!("/tmp/placeholder.png")
+
+generator = PlaceholderImage::Generator.new('300x300', background_color: "#dddddd", text_color: "#bbbbbb")
+generator.generate!("/tmp/placeholder.png")
+```
+
+## Options
+
+Command-line:
+
+```shell
+$ placeholder_image help generate
+```
+
+Code:
+
+* `background_color` - render background using this color. Default: `'#000000'`.
+* `text_color` - render text using this color. Default: `'#ffffff'`.
+* `text` - the text rendered centered within the image. Default: `'#{WIDTH} x #{HEIGHT}'`.
+
+## Ruby Versions
+
+No JRuby support, because of RMagick-clash.
+
+## Notes
+
+This gem was developed for our own requirements at **[Merchii](http://github.com/merchii)**, so feel free to send pull-requests with enhancements of any kind (features, bug-fixes, documentation, tests, etc.) to make it better or useful for you as well.
+
+## License
+
+Released under the MIT license.
+
+Copyright (c) [Jonas Grimfelt](http://github.com/grimen), [Merchii](http://github.com/merchii)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << ['lib', 'spec']
+  t.pattern = "spec/**/*_spec.rb"
+end

data/TODO

@@ -0,0 +1,6 @@
+
+== HIGH
+
+- [issue]: Silence RMagick warnings.
+
+- [feature/enhancement]: Implement using MiniMagick - need to learn the API, had some trouble so went RMagick-route.

data/bin/placeholder_image

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+require 'commander/import'
+require 'placeholder_image'
+
+program :name, 'placeholder_image'
+program :version, PlaceholderImage::VERSION
+program :description, 'Generate generic placeholder vector images - just like placehold.it, but native.'
+
+default_command :generate
+
+command :generate do |c|
+  c.syntax = 'placeholder_image generate WIDTHxHEIGHT FILEPATH [options]'
+  c.description = 'Generate placeholder image based on specified options.'
+  c.option '--bgcolor STRING', String, 'Image: background color'
+  c.option '--color STRING', String, 'Image: text color'
+  c.option '--text STRING', String, 'Image: text'
+  c.action do |args, options|
+    image_dimensions = args.shift
+    image_path = args.shift
+    generator_options = {
+      :background_color => options.bgcolor,
+      :text_color => options.color,
+      :text => options.text
+    }
+    begin
+      generator = PlaceholderImage::Generator.new(image_dimensions, generator_options)
+      generator.generate!(image_path)
+      say "=== GENERATED: ==========================="
+      say "Path: #{image_path.inspect}"
+      say "Options:"
+      generator.options.each do |k, v|
+        say "   #{k}: #{v.inspect}"
+      end
+      say "=========================================="
+    rescue => e
+      say "#{e}"
+    end
+  end
+end

data/lib/placeholder_image.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+module PlaceholderImage
+
+  autoload :VERSION,    'placeholder_image/version'
+  autoload :Generator,  'placeholder_image/generator'
+
+  module Generators
+    autoload :RMagick,  'placeholder_image/generators/rmagick'
+  end
+end

data/lib/placeholder_image/generator.rb

@@ -0,0 +1,61 @@
+module PlaceholderImage
+  class Generator
+
+    GENERATORS = [:rmagick]
+
+    DEFAULT_FORMAT = 'png'
+    DEFAULT_BACKGROUND_COLOR = '#000000'
+    DEFAULT_TEXT_COLOR = '#ffffff'
+    DEFAULT_TEXT_SCALE_FACTOR = 9
+    DEFAULT_FONT = 'arial'
+    DIMENSIONS_SEPERATOR = " \u00D7 "
+
+    def initialize(dimension_string, options = {})
+      unless dimension_string.to_s.strip =~ /^\d+x\d+$/
+        raise ArgumentError, "Not a valid image dimension: #{dimension_string.inspect}. Expected format '100x100', etc."
+      end
+      dimensions = dimension_string.split('x')
+      @options = options
+      @options[:width] = dimensions[0].to_i
+      @options[:height] = dimensions[1].to_i
+      @generator = :rmagick
+    end
+
+    def generate
+      case @generator
+      when :rmagick
+        image = PlaceholderImage::Generators::RMagick.generate(options)
+      else
+        raise ArgumentError, "No such generator: #{@generator.inspect}. Valid generators: #{GENERATORS.inspect}"
+      end
+      image
+    end
+
+    def generate!(filename)
+      image = generate()
+      image.write(filename)
+    end
+
+    def options
+      width = @options[:width]
+      height = @options[:height]
+      background_color = @options[:background_color] ? @options[:background_color].to_s : DEFAULT_BACKGROUND_COLOR
+      text_color = @options[:text_color] ? @options[:text_color].to_s : DEFAULT_TEXT_COLOR
+      font = @options[:font] ? @options[:font].to_s : DEFAULT_FONT
+      text = @options[:text] ? @options[:text].to_s : [@options[:width], @options[:height]].join(DIMENSIONS_SEPERATOR)
+      text_scale_factor = DEFAULT_TEXT_SCALE_FACTOR
+      format = DEFAULT_FORMAT
+
+      {
+        :width => width,
+        :height => height,
+        :background_color => background_color,
+        :text_color => text_color,
+        :font => font,
+        :text => text,
+        :text_scale_factor => text_scale_factor,
+        :format => format
+      }
+    end
+  end
+end

data/lib/placeholder_image/generators/rmagick.rb

@@ -0,0 +1,29 @@
+require 'RMagick'
+require 'rvg/rvg'
+
+module PlaceholderImage
+  module Generators
+    class RMagick
+
+      def self.generate(options)
+        # background
+        rvg = ::Magick::RVG.new(options[:width], options[:height]).viewbox(0, 0, options[:width], options[:height]) do |canvas|
+          canvas.background_fill = options[:background_color]
+        end
+        image = rvg.draw
+
+        # text
+        draw = ::Magick::Draw.new
+        draw.pointsize = options[:width] / options[:text_scale_factor]
+        draw.fill = options[:text_color]
+        draw.gravity = ::Magick::CenterGravity
+        draw.annotate(image, 0, 0, 0, 0, options[:text])
+
+        image.format = options[:format]
+
+        image
+      end
+
+    end
+  end
+end

data/lib/placeholder_image/version.rb

@@ -0,0 +1,3 @@
+module PlaceholderImage
+  VERSION = '0.1.0'
+end

data/placeholder_image.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'placeholder_image/version'
+
+Gem::Specification.new do |s|
+  s.name        = "merchii-placeholder_image"
+  s.version     = PlaceholderImage::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jonas Grimfelt", "Merchii"]
+  s.email       = ["grimen@gmail.com", "operations@merchii.com"]
+  s.homepage    = "https://github.com/merchii/placeholder_image"
+  s.summary     = %q{Generate generic placeholder vector images - just like placehold.it, but native.}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # s.add_runtime_dependency 'mini_magick'
+  s.add_runtime_dependency 'rmagick'
+  s.add_runtime_dependency 'commander'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-matchers'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-bundler'
+  s.add_development_dependency 'guard-minitest'
+  # s.add_development_dependency 'chunky_png'
+end

data/spec/placeholder_image_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+
+describe ::PlaceholderImage do
+
+  include ::PlaceholderImage::SpecHelpers::RMagick
+
+  describe "VERSION" do
+    it 'should be defined' do
+      defined?(::PlaceholderImage::VERSION)
+    end
+
+    it 'should be a valid version string (e.g. "0.0.1", or "0.0.1.rc1")' do
+      valid_version_string = /^\d+\.\d+\.\d+/
+      ::PlaceholderImage::VERSION.must_match valid_version_string
+    end
+  end
+
+  describe ::PlaceholderImage::Generator do
+    before(:each) do
+      @image_path = '/tmp/placeholder.png'
+    end
+
+    describe '#generate!' do
+      describe "format" do
+        it "should generate image as PNG image" do
+          generator = PlaceholderImage::Generator.new('150x100')
+          generator.generate!(@image_path)
+          image = open_image(@image_path)
+
+          format(image).must_equal 'png'
+        end
+      end
+
+      describe "dimensions" do
+        it "should require width/height arguments" do
+          # Don't get the MiniTest usage... :S
+          # proc { PlaceholderImage::Generator.new }.must_throw ArgumentError
+        end
+
+        it "should generate image with correct width/height using arguments" do
+          generator = PlaceholderImage::Generator.new('150x100')
+          generator.generate!(@image_path)
+          image = open_image(@image_path)
+
+          dimensions(image).must_equal [150, 100]
+        end
+      end
+
+      describe "background color" do
+        it "should generate image with 'gray' as background color - unless specified" do
+          generator = PlaceholderImage::Generator.new('150x100')
+          generator.generate!(@image_path)
+          image = open_image(@image_path)
+
+          background_color(image).must_equal '#000000'
+        end
+
+        it "should generate image with specified background color - if specified" do
+          generator = PlaceholderImage::Generator.new('150x100', :background_color => '#ff0000')
+          generator.generate!(@image_path)
+          image = open_image(@image_path)
+
+          background_color(image).must_equal '#ff0000'
+        end
+      end
+
+      # DANGER ZONE: More of a experiment testing text/font... *<:D
+
+      describe "text color" do
+        it "should generate image with 'white' as text color - unless specified" do
+          generator = PlaceholderImage::Generator.new('150x100')
+          generator.generate!(@image_path)
+          image = open_image(@image_path)
+
+          text_color(image).must_equal '#ffffff'
+        end
+
+        it "should generate image with specified text color - if specified" do
+          generator = PlaceholderImage::Generator.new('150x100', :text_color => '#ff0000')
+          generator.generate!(@image_path)
+          image = open_image(@image_path)
+
+          text_color(image).must_equal '#ff0000'
+        end
+      end
+
+      describe "text" do
+        it "should generate image with '<WIDTH>x<HEIGHT>' as text- unless specified" do
+          skip
+          # generator = PlaceholderImage::Generator.new('150x100')
+          # generator.generate!(@image_path)
+          # image = open_image(@image_path)
+          #
+          # bitmap(image).must_equal bitmap(fixture_image("/path/to/fixture"))
+        end
+
+        it "should generate image with specified text - if specified" do
+          skip
+          # generator = PlaceholderImage::Generator.new('150x100', :text => "#WIN")
+          # generator.generate!(@image_path)
+          # image = open_image(@image_path)
+          #
+          # bitmap(image).must_equal bitmap(fixture_image("/path/to/fixture"))
+        end
+
+        it "should generate image with no text if specified string is blank (i.e. non-nil, but zero-length)" do
+          skip
+          # generator = PlaceholderImage::Generator.new('150x100', :text => "")
+          # generator.generate!(@image_path)
+          # image = open_image(@image_path)
+          #
+          # bitmap(image).must_equal bitmap(fixture_image("/path/to/fixture"))
+        end
+      end
+    end
+
+    describe "font" do
+      it "should generate image with 'Arial' as font - unless specified" do
+        skip
+        # generator = PlaceholderImage::Generator.new('150x100')
+        # generator.generate!(@image_path)
+        # image = open_image(@image_path)
+        #
+        # bitmap(image).must_equal bitmap(fixture_image("/path/to/fixture"))
+      end
+
+      it "should generate image with specified text color - if specified" do
+        skip
+        # generator = PlaceholderImage::Generator.new('150x100', :font => 'verdana')
+        # generator.generate!(@image_path)
+        # image = open_image(@image_path)
+        #
+        # bitmap(image).must_equal bitmap(fixture_image("/path/to/fixture"))
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'minitest/matchers'
+require 'tempfile'
+
+require 'placeholder_image'
+
+# References:
+#   - MiniMagick: https://github.com/probablycorey/mini_magick/blob/master/test/image_test.rb
+#   - ChunkyPNG: https://github.com/wvanbergen/chunky_png/blob/master/spec/chunky_png/color_spec.rb
+#   - RMagick: http://www.imagemagick.org/RMagick/doc/draw.html
+
+module PlaceholderImage
+  module SpecHelpers
+    module RMagick
+
+      def open_image(path)
+        ::Magick::ImageList.new(path).flatten_images
+      end
+
+      def colors(image)
+        pixels = {}
+
+        image.each_pixel do |pixel, c, r|
+          # RMagick's API just kills me...
+          color = pixel.to_color(compliance=::Magick::AllCompliance, matte=true, depth=8, hex=true)
+
+          if pixels[color]
+            pixels[color] += 1
+          else
+            pixels[color] = 1
+          end
+        end
+
+        pixels.sort_by { |k,v| v }.reverse.map { |v| v[0].downcase }
+      end
+
+      def background_color(image)
+        colors(image)[0]
+      end
+
+      def text_color(image)
+        colors(image)[1]
+      end
+
+      def dimensions(image)
+        [image.columns, image.rows]
+      end
+
+      def format(image)
+        image.format.downcase
+      end
+
+      def fixture_image(filename)
+        filename = File.join(File.dirname(__FILE__), 'fixtures', filename)
+        open_image(filename)
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: merchii-placeholder_image
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+  - Jonas Grimfelt
+  - Merchii
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-01 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rmagick
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: commander
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :runtime
+    version_requirements: *id002
+  - !ruby/object:Gem::Dependency 
+    name: rake
+    prerelease: false
+    requirement: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id003
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    prerelease: false
+    requirement: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id004
+  - !ruby/object:Gem::Dependency 
+    name: minitest
+    prerelease: false
+    requirement: &id005 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id005
+  - !ruby/object:Gem::Dependency 
+    name: minitest-matchers
+    prerelease: false
+    requirement: &id006 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id006
+  - !ruby/object:Gem::Dependency 
+    name: guard
+    prerelease: false
+    requirement: &id007 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id007
+  - !ruby/object:Gem::Dependency 
+    name: guard-bundler
+    prerelease: false
+    requirement: &id008 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id008
+  - !ruby/object:Gem::Dependency 
+    name: guard-minitest
+    prerelease: false
+    requirement: &id009 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id009
+description: Generate generic placeholder vector images - just like placehold.it, but native.
+email: 
+  - grimen@gmail.com
+  - operations@merchii.com
+executables: 
+  - placeholder_image
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - .travis.yml
+  - Gemfile
+  - Guardfile
+  - MIT-LICENSE
+  - README.md
+  - Rakefile
+  - TODO
+  - bin/placeholder_image
+  - lib/placeholder_image.rb
+  - lib/placeholder_image/generator.rb
+  - lib/placeholder_image/generators/rmagick.rb
+  - lib/placeholder_image/version.rb
+  - placeholder_image.gemspec
+  - spec/placeholder_image_spec.rb
+  - spec/spec_helper.rb
+homepage: https://github.com/merchii/placeholder_image
+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.9
+signing_key: 
+specification_version: 3
+summary: Generate generic placeholder vector images - just like placehold.it, but native.
+test_files: []
+