utopia-tags-gallery 0.12.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDdhYmIzOTFmYzEyODgzNWUzZDlkNmEyMjQ0NzI2NGFjNThjYWQwZQ==
+  data.tar.gz: !binary |-
+    MDJmMjY1MDYzNDAyN2E4MGRjMDAyYjZhZGQ4NzFhY2QyNjJhOWFhYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGE0MGU4YTRhZjc3NThkMzU3YTk4Mzg1YTBhYzMzMzUzZjA0NGM1Y2YyODhl
+    MGEzNzNiZGVjYTY4M2IwNjMyYzkzNmQwNDlhYjk4M2QzM2E2NTc4NDk3OWFh
+    NjVkNDgxYjFlYWQ3MDVkMTczMjhiMzczODM4YmNjNzE0MzZjOWM=
+  data.tar.gz: !binary |-
+    MDYxN2ZkMzMxNTI4MjhjZGIyMTNmZjgxMjg1NGQ2NzgzMjM4OWYzN2ZlODVm
+    Zjg2MGIwMDkxZjgyMTNkOTA2YmIyN2MxZjA4ZTFhZjAzMDRkMjUxZGYyN2Qx
+    YmJkNTU0NGIzMzc4ZjIzMGM2NzZjNGRlZWIyYmEzNjExZDU0ZDU=

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 utopia-gallery.gemspec
+gemspec

data/README.md

@@ -0,0 +1,51 @@
+# Utopia::Tags::Gallery
+
+Utopia is a website generation framework which provides a robust set of tools
+to build highly complex dynamic websites. It uses the filesystem heavily for
+content and provides frameworks for interacting with files and directories as
+structure representing the website.
+
+This package includes a useful gallery component which can be used for
+displaying thumbnails of images, documents and movies.
+
+## Installation
+
+Add this line to your website's Gemfile:
+
+    gem 'utopia-tags-gallery'
+
+And then execute:
+
+    $ bundle
+
+## 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
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2012, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/utopia/tags/gallery.rb

@@ -0,0 +1,85 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.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.
+
+require 'utopia/tags'
+
+require 'utopia/tags/gallery/thumbnail'
+require 'utopia/tags/gallery/container'
+
+module Utopia
+	module Tags
+		module Gallery
+			class Metadata
+				def initialize(metadata)
+					@metadata = metadata
+				end
+
+				attr :metadata
+
+				def [] (key)
+					@metadata[key.to_s]
+				end
+
+				def to_s
+					@metadata['caption'] || ''
+				end
+
+				def to_html
+					to_s.to_html
+				end
+			end
+	
+			def self.call(transaction, state)
+				container = Container.new(transaction.end_tags[-2].node, Utopia::Path.create(state["path"] || "./"))
+				metadata = container.metadata
+				metadata.default = {}
+
+				tag_name = state["tag"] || "img"
+				container_class = state["class"] || "gallery"
+
+				options = {}
+				options[:process] = state["process"]
+				options[:filter] = Regexp.new("(#{state["filetypes"]})$", "i") if state["filetypes"]
+		
+				filter = Regexp.new(state["filter"], Regexp::IGNORECASE) if state["filter"]
+
+				transaction.tag("div", "class" => container_class) do |node|
+					items = container.each(options).sort do |a, b|
+						if metadata[a.original.basename]["order"] and metadata[b.original.basename]["order"]
+							metadata[a.original.basename]["order"] <=> metadata[b.original.basename]["order"]
+						else
+							a.original.basename <=> b.original.basename
+						end
+					end
+
+					items.each do |path|
+						next if filter and !filter.match(path.original.basename)
+				
+						alt = Metadata.new(metadata[path.original.basename])
+						
+						transaction.tag(tag_name, "src" => path, "alt" => alt)
+					end
+				end
+			end
+		end
+	end
+end
+
+Utopia::Tags.register("gallery", Utopia::Tags::Gallery)

data/lib/utopia/tags/gallery/container.rb

@@ -0,0 +1,157 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.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.
+
+require 'fileutils'
+
+module Utopia
+	module Tags
+		module Gallery
+			CACHE_DIR = "_cache"
+			
+			class Path
+				def initialize(original_path)
+					@original_path = original_path
+					@cache_root = @original_path.dirname + CACHE_DIR
+			
+					@extensions = {}
+				end
+
+				attr :cache_root
+				attr :extensions
+
+				def original
+					@original_path
+				end
+
+				def self.append_suffix(name, suffix, extension = nil)
+					components = name.split(".")
+			
+					components.insert(-2, suffix)
+			
+					if (extension)
+						components[-1] = extension
+					end
+			
+					return components.join(".")
+				end
+
+				def processed(process = nil)
+					if process
+						name = @original_path.basename
+						return cache_root + Path.append_suffix(name, process.to_s, @extensions[process.to_sym])
+					else
+						return @original_path
+					end
+				end
+		
+				def to_html(process = nil)
+					Tag.new("img", {"src" => path(process)}).to_html
+				end
+		
+				def to_s
+					@original_path.to_s
+				end
+		
+				def method_missing(name, *args)
+					return processed(name.to_s)
+				end
+			end
+		
+			class Container
+				include Enumerable
+				
+				def initialize(node, path, processes = Processes::DEFAULT)
+					@node = node
+					@path = path
+					
+					@processes = processes
+				end
+	
+				def metadata
+					metadata_path = @node.local_path(@path + "gallery.yaml")
+		
+					if File.exist? metadata_path
+						return YAML::load(File.read(metadata_path))
+					else
+						return {}
+					end
+				end
+	
+				def each(options = {})
+					return to_enum(:each, options) unless block_given?
+					
+					options[:filter] ||= /(jpg|png)$/i
+
+					paths = []
+					local_path = @node.local_path(@path)
+
+					Dir.entries(local_path).each do |filename|
+						next unless filename.match(options[:filter])
+
+						path = Path.new(@path + filename)
+
+						process!(path, options[:process]) if options[:process]
+
+						yield path
+					end
+				end
+	
+				def process!(image_path, processes)
+					# Create the local cache directory if it doesn't exist already
+					local_cache_path = @node.local_path(image_path.cache_root)
+		
+					unless File.exist? local_cache_path
+						FileUtils.mkdir local_cache_path
+					end
+		
+					# Calculate the new name for the processed image
+					local_original_path = @node.local_path(image_path.original)
+		
+					if processes.kind_of? String
+						processes = processes.split(",").collect{|p| p.split(":")}
+					end
+		
+					processes.each do |process_name, extension|
+						process_name = process_name.to_sym
+			
+						process = @processes[process_name]
+						extension ||= process.default_extension(image_path)
+			
+						image_path.extensions[process_name] = extension if extension
+			
+						local_processed_path = @node.local_path(image_path.processed(process_name))
+			
+						unless File.exists? local_processed_path
+							image = Magick::ImageList.new(local_original_path)
+							image.scene = 0
+				
+							processed_image = process.call(image)
+							processed_image.write(local_processed_path)
+				
+							# Run GC to free up any memory.
+							image = processed_image = nil
+							GC.start if defined? GC
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/utopia/tags/gallery/thumbnail.rb

@@ -0,0 +1,115 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.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.
+
+require 'RMagick'
+
+module Utopia
+	module Tags
+		module Gallery
+			module Processes
+				class Thumbnail
+					def initialize(size = [800, 800])
+						@size = size
+					end
+		
+					def call(img)
+						# Only resize an image if it is bigger than the given size.
+						if (img.columns > @size[0] || img.rows > @size[1])
+							img.resize_to_fit(*@size)
+						else
+							img
+						end
+					end
+		
+					def default_extension(path)
+						ext = path.original.extension
+			
+						case ext
+						when /pdf/i
+							return "png"
+						else
+							return ext.downcase
+						end
+					end
+				end
+	
+				# Resize the image to fit within the specified dimensions while retaining the aspect ratio of the original image. If necessary, crop the image in the larger dimension.
+				class CropThumbnail < Thumbnail
+					def call(img)
+						img.resize_to_fill(*@size)
+					end
+				end
+	
+				class CircularCropThumbnail < CropThumbnail
+					def call(img)
+						img = super(img)
+
+						# The crop composite doesn't work correcty with unusual colourspaces:
+						img.colorspace = Magick::SRGBColorspace
+
+						circle = Magick::Image.new(*@size)
+						gc = Magick::Draw.new
+						gc.fill('black')
+						gc.circle(@size[0] / 2.0, @size[1] / 2.0, @size[0] / 2.0, 1)
+						gc.draw(circle)
+
+						mask = circle.blur_image(0,1).negate
+
+						mask.matte = false
+						img.matte = true
+
+						img.composite!(mask, Magick::CenterGravity, Magick::CopyOpacityCompositeOp)
+					end
+				end
+	
+				class DocumentThumbnail < Thumbnail
+					def call(img)
+						img = super(img)
+			
+						img.colorspace = Magick::SRGBColorspace
+			
+						return img
+					end
+		
+					def default_extension(path)
+						return "png"
+					end
+				end
+
+				class PhotoThumbnail < Thumbnail
+					def default_extension(path)
+						return "jpeg"
+					end
+				end
+			
+				DEFAULT = {
+					:document => Processes::DocumentThumbnail.new([300, 300]),
+					:photo => Processes::PhotoThumbnail.new([300, 300]),
+
+					:square => Processes::CropThumbnail.new([300, 300]),
+					:circle => Processes::CircularCropThumbnail.new([300, 300]),
+
+					:large => Processes::Thumbnail.new([800, 800]),
+					:small => Processes::Thumbnail.new([300, 300]),
+				}
+			end
+		end
+	end
+end

data/lib/utopia/tags/gallery/version.rb

@@ -0,0 +1,7 @@
+module Utopia
+	module Tags
+		module Gallery
+			VERSION = "0.12.0"
+		end
+	end
+end

data/utopia-tags-gallery.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'utopia/tags/gallery/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "utopia-tags-gallery"
+	spec.version       = Utopia::Tags::Gallery::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.description   = <<-EOF
+		Utopia is a website generation framework which provides a robust set of tools
+		to build highly complex dynamic websites. It uses the filesystem heavily for
+		content and provides frameworks for interacting with files and directories as
+		structure representing the website.
+
+		This package includes a useful gallery component which can be used for
+		displaying thumbnails of images, documents and movies.
+	EOF
+	spec.summary       = %q{A gallery tag for use with Utopia web framework.}
+	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"
+	
+	spec.add_dependency "utopia", "~> 0.12.0"
+	spec.add_dependency "rmagick"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: utopia-tags-gallery
+version: !ruby/object:Gem::Version
+  version: 0.12.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: utopia
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  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'
+description: ! "\t\tUtopia is a website generation framework which provides a robust
+  set of tools\n\t\tto build highly complex dynamic websites. It uses the filesystem
+  heavily for\n\t\tcontent and provides frameworks for interacting with files and
+  directories as\n\t\tstructure representing the website.\n\n\t\tThis package includes
+  a useful gallery component which can be used for\n\t\tdisplaying thumbnails of images,
+  documents and movies.\n"
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/utopia/tags/gallery.rb
+- lib/utopia/tags/gallery/container.rb
+- lib/utopia/tags/gallery/thumbnail.rb
+- lib/utopia/tags/gallery/version.rb
+- utopia-tags-gallery.gemspec
+homepage: ''
+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.0.2
+signing_key: 
+specification_version: 4
+summary: A gallery tag for use with Utopia web framework.
+test_files: []