imagemagick-identify 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dane Natoli
+
+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,31 @@
+# ImageMagick::Identify
+
+A wrapper around ImageMagick's identify command
+
+## Installation
+
+Install [ImageMagick](http://www.imagemagick.org/script/index.php) on your server using your favourite package manager.
+
+Add this line to your application's Gemfile:
+
+    gem 'imagemagick-identify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imagemagick-identify
+
+## Usage
+
+Create an `ImageMagick::Identify` object using `ImageMagick::Identify(<filename>)`, then call `run` on it.  It will return you an `ImageMagick::Result` which contains the attreibutes of that image.
+
+## 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 @@
+require "bundler/gem_tasks"

data/imagemagick-identify.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imagemagick/identify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imagemagick-identify"
+  spec.version       = ImageMagick::Identify::VERSION
+  spec.authors       = ["Dane Natoli"]
+  spec.email         = ["dane.natoli@gmail.com"]
+  spec.description   = %q{A wrapper around ImageMagick's identify command}
+  spec.summary       = %q{A wrapper around ImageMagick's identify command}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/imagemagick/exceptions.rb

@@ -0,0 +1,4 @@
+module ImageMagick
+  class FileNotFoundException < Exception; end
+  class CommandNotFoundException < Exception; end
+end

data/lib/imagemagick/identify.rb

@@ -0,0 +1,44 @@
+require "imagemagick/exceptions"
+require "imagemagick/identify/version"
+require "imagemagick/identify/command"
+require "imagemagick/identify/parser"
+require "imagemagick/identify/result"
+
+module ImageMagick
+  class Identify
+
+    def initialize(file_path)
+      @file_path = file_path
+      validate_file_path!
+    end
+
+    class << self
+      def for(file_path)
+        new(file_path)
+      end
+
+      private :new
+    end
+
+    def run
+      output = command.execute(@file_path)
+      parsed_result = parser.parse(output)
+      Result.new(parsed_result)
+    end
+
+    private
+
+    def command
+      ImageMagick::Identify::Command
+    end
+
+    def parser
+      ImageMagick::Identify::Parser
+    end
+
+    def validate_file_path!
+      raise FileNotFoundException, "File doesn't exist!" unless File.exists?(@file_path)
+    end
+
+  end
+end

data/lib/imagemagick/identify/command.rb

@@ -0,0 +1,23 @@
+# This class is a wrapper around the identify command for ImageMagick.
+# It will return the verbose information for the file.
+
+require "utilities/which"
+
+module ImageMagick
+  module Identify::Command
+
+    def self.execute(file_path)
+      command = "#{path_to_identify} -verbose -unique #{file_path.inspect}"
+      `#{command}`
+    end
+
+    private
+
+    def self.path_to_identify
+      Which.which("identify").tap{ |path|
+        raise CommandNotFoundException, "ImageMagick command 'identify' not found!" unless path
+      }
+    end
+
+  end
+end

data/lib/imagemagick/identify/parser.rb

@@ -0,0 +1,28 @@
+# This class is responsible for parsing the output of the identify
+# command, and returning a nested hash structure.
+
+module ImageMagick
+  module Identify::Parser
+
+    INDENT_PER_LEVEL = 2
+
+    def self.parse(input, spaces = INDENT_PER_LEVEL)
+      matcher = /\n\s{#{spaces}}\b/ #new line with n spaces until the next word
+
+      {}.tap{ |result|
+        input.split(matcher).each do |string|
+          if string.include?(":\n")
+            key, value = string.split(":\n", 2).map(&:strip)
+            result[key] = parse(value, spaces + INDENT_PER_LEVEL)
+          else
+            key, value = string.split(": ", 2).map(&:strip)
+            result[key] = value
+          end
+        end
+      }
+    end
+
+    private
+
+  end
+end

data/lib/imagemagick/identify/result.rb

@@ -0,0 +1,16 @@
+# This class represents the result of the ImageMagick identify command.
+# It exposes only the results that we care about through methods.
+
+module ImageMagick
+  class Identify::Result
+
+    def initialize(result={})
+      @result = result
+    end
+
+    def colors
+      @result["Colors"].to_i
+    end
+
+  end
+end

data/lib/imagemagick/identify/version.rb

@@ -0,0 +1,5 @@
+module ImageMagick
+  class Identify
+    VERSION = "0.0.1"
+  end
+end

data/lib/utilities/which.rb

@@ -0,0 +1,14 @@
+# This module provides the equivalent of the unix which command.
+# It is used by the ImageMagick module to check for the extistence
+# of the ImageMagick command 'identify'.
+
+module Which
+  def self.which(command)
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      command_path = File.join(path, command)
+      return command_path if File.executable? command_path
+    end
+
+    nil
+  end
+end

data/spec/lib/imagemagick/identify/command_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe ImageMagick::Identify::Command do
+
+  describe ".execute" do
+    context "when ImageMagick is installed" do
+      before :each do
+        Which.stub(:which).and_return("identify")
+      end
+
+      context "and given a file that exists" do
+        let(:file_name){ "spec/fixtures/images/test.jpg" }
+
+        example do
+          described_class.execute(file_name).should include("Colors")
+        end
+      end
+
+      context "and given a file that doesn't exist" do
+        let(:file_name){ "this/is/a/made_up_file.jpg" }
+
+        example do
+          described_class.execute(file_name).should be_empty
+        end
+      end
+    end
+
+    context "when ImageMagick is not installed" do
+      before :each do
+        Which.stub(:which).and_return(nil)
+      end
+
+      example do
+        expect{
+          described_class.execute("spec/fixtures/images/test.jpg") 
+        }.to raise_error ImageMagick::CommandNotFoundException, "ImageMagick command 'identify' not found!"
+      end
+    end
+  end
+
+end

data/spec/lib/imagemagick/identify/parser_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe ImageMagick::Identify::Parser do
+
+  describe ".parse" do
+
+    context "when it is given some valid input" do
+      let(:input) do
+        "Image: spec/fixtures/images/clock_in_1.jpg\n  Format: JPEG (Joint Photographic Experts Group JFIF format)\n  Geometry: 640x480+0+0\n  Resolution: 72x72\n  Channel depth:\n    red: 8-bit\n    green: 8-bit\n    blue: 8-bit\n  Channel statistics:\n    Red:\n      min: 0 (0)\n      max: 255 (1)\n      mean: 145.544 (0.570762)\n      standard deviation: 75.8102 (0.297295)"
+      end
+
+      let(:expectation) do
+        {
+          "Image" => "spec/fixtures/images/clock_in_1.jpg",
+          "Format" => "JPEG (Joint Photographic Experts Group JFIF format)",
+          "Geometry" => "640x480+0+0",
+          "Resolution" => "72x72",
+          "Channel depth" => { "red" => "8-bit", "green" => "8-bit", "blue" => "8-bit" },
+          "Channel statistics" => { "Red" => { "min" => "0 (0)", "max" => "255 (1)", "mean" => "145.544 (0.570762)",   "standard deviation" => "75.8102 (0.297295)" } }
+        }
+      end
+
+      example do
+        described_class.parse(input).should == expectation
+      end
+    end
+
+    context "when it is given no input" do
+      example do
+        described_class.parse("").should == {}
+      end
+    end
+  end
+end

data/spec/lib/imagemagick/identify/result.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ImageMagick::Identify::Result do
+
+  describe "#colors" do
+    context "when given a result with colors specified" do
+      subject{ described_class.new("Colors" => 12345)}
+
+      its(:colors){ should == 12345 }
+    end
+
+    context "when given a result with colors not specified" do
+      subject{ described_class.new }
+
+      its(:colors){ should be_zero }
+    end
+  end
+end

data/spec/lib/imagemagick/identify_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ImageMagick::Identify do
+
+  describe ".new" do
+    example do
+      expect{
+        described_class.new
+      }.to raise_error NoMethodError
+    end
+  end
+
+  describe ".for" do
+    context "when given a file that exists" do
+      subject{ described_class.for("spec/fixtures/images/test.jpg") }
+
+      it{ should be_a(ImageMagick::Identify) }
+    end
+
+    context "when given a file that doesn't exist" do
+      example do
+        expect{
+          described_class.for("this/is/a/made_up_file.jpg")
+        }.to raise_error ImageMagick::FileNotFoundException, "File doesn't exist!"
+      end
+    end
+  end
+
+  describe ".run" do
+    context "when given a file that exists" do
+      subject{ described_class.for("spec/fixtures/images/test.jpg") }
+
+      example do
+        subject.run.should be_a(ImageMagick::Identify::Result)
+      end
+
+      example do
+        subject.run.colors.should == 50258
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'imagemagick/identify'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: imagemagick-identify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dane Natoli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: A wrapper around ImageMagick's identify command
+email:
+- dane.natoli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- imagemagick-identify.gemspec
+- lib/imagemagick/exceptions.rb
+- lib/imagemagick/identify.rb
+- lib/imagemagick/identify/command.rb
+- lib/imagemagick/identify/parser.rb
+- lib/imagemagick/identify/result.rb
+- lib/imagemagick/identify/version.rb
+- lib/utilities/which.rb
+- spec/fixtures/images/test.jpg
+- spec/lib/imagemagick/identify/command_spec.rb
+- spec/lib/imagemagick/identify/parser_spec.rb
+- spec/lib/imagemagick/identify/result.rb
+- spec/lib/imagemagick/identify_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: A wrapper around ImageMagick's identify command
+test_files:
+- spec/fixtures/images/test.jpg
+- spec/lib/imagemagick/identify/command_spec.rb
+- spec/lib/imagemagick/identify/parser_spec.rb
+- spec/lib/imagemagick/identify/result.rb
+- spec/lib/imagemagick/identify_spec.rb
+- spec/spec_helper.rb