griddle 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt Mongeau
+
+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.rdoc

@@ -0,0 +1,17 @@
+= griddle
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Matt Matt san Mongeau. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "griddle"
+    gem.summary = %Q{GridFS made simple.}
+    gem.description = %Q{GridFS made simple...}
+    gem.email = "matt@toastyapps.com"
+    gem.homepage = "http://github.com/toastyapps/griddle"
+    gem.authors = ["Matt Mongeau"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_dependency "mongo_mapper", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "griddle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/griddle.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{griddle}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Mongeau"]
+  s.date = %q{2010-03-03}
+  s.description = %q{GridFS made simple...}
+  s.email = %q{matt@toastyapps.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "griddle.gemspec",
+     "lib/griddle.rb",
+     "lib/griddle/attachment.rb",
+     "lib/griddle/has_grid_attachment.rb",
+     "lib/griddle/style.rb",
+     "lib/griddle/upfile.rb",
+     "rails/init.rb",
+     "test/attachment_test.rb",
+     "test/fixtures/baboon.jpg",
+     "test/fixtures/fox.jpg",
+     "test/fixtures/sample.pdf",
+     "test/has_attachment_test.rb",
+     "test/models.rb",
+     "test/style_test.rb",
+     "test/test_helper.rb",
+     "test/upfile_test.rb"
+  ]
+  s.homepage = %q{http://github.com/toastyapps/griddle}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{GridFS made simple.}
+  s.test_files = [
+    "test/attachment_test.rb",
+     "test/has_attachment_test.rb",
+     "test/models.rb",
+     "test/style_test.rb",
+     "test/test_helper.rb",
+     "test/upfile_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo_mapper>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, [">= 0"])
+  end
+end
+

data/lib/griddle/attachment.rb

@@ -0,0 +1,72 @@
+module Griddle
+  class Attachment
+    include MongoMapper::Document
+    
+    belongs_to :owner, :polymorphic => true
+    key :name, String
+    key :owner_id, ObjectId, :required => true
+    key :owner_type, String, :required => true
+    key :file_name, String
+    key :file_size, Integer
+    key :content_type, String
+    key :styles, Hash
+    key :options, Hash
+    
+    before_destroy :destroy_file
+    before_save :save_file
+    
+    def self.for(name, owner, options = {})
+      a = Attachment.find_or_create_by_name_and_owner_type_and_owner_id(name, owner.class.to_s, owner.id)
+      if options.has_key?(:styles)
+        a.styles = (options[:styles] || {}).inject({}) do |h, value|
+          h[value.first] = Style.new value.first, value.last, a
+          h
+        end
+      end
+      a
+    end
+    
+    def grid_key
+      @grid_key ||= "#{owner_type.tableize}/#{owner_id}/#{name}/#{file_name}".downcase
+    end
+    
+    def assign(uploaded_file)
+      return nil unless valid_assignment?(uploaded_file)
+      @tmp_file = uploaded_file
+    end
+    
+    def file=(new_file)
+      file_name = new_file.respond_to?(:original_filename) ? new_file.original_filename : File.basename(new_file.path)
+      self.file_name = file_name
+      self.file_size = File.size(new_file)
+      self.content_type = new_file.content_type
+      
+      GridFS::GridStore.open(self.class.database, grid_key, 'w', :content_type => self.content_type) do |f|
+        f.write new_file.read
+      end
+    end
+    
+    def file
+      GridFS::GridStore.new(self.class.database, grid_key, 'r') unless file_name.blank?
+    end
+    
+    def destroy_file
+      GridFS::GridStore.unlink(self.class.database, grid_key)
+    end
+    
+    def exists?
+      !file_name.nil?
+    end
+    
+    private
+    
+    def save_file
+      self.file = @tmp_file if @tmp_file
+    end
+    
+    def valid_assignment?(file)
+      file.nil? || (file.respond_to?(:original_filename) && file.respond_to?(:content_type))
+    end
+    
+  end
+end

data/lib/griddle/has_grid_attachment.rb

@@ -0,0 +1,53 @@
+require 'mongo/gridfs'
+module Griddle
+  module HasGridAttachment
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+    
+    module ClassMethods
+      def has_grid_attachment name, options = {}
+        write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
+        attachment_definitions[name] = options
+
+        after_save :save_attached_files
+        
+        define_method(name) do |*args|
+          attachment_for(name)
+        end
+        
+        define_method("#{name}=") do |file|
+          attachment_for(name).assign(file)
+        end        
+      end
+      
+      def attachment_definitions
+        read_inheritable_attribute(:attachment_definitions)
+      end
+    end
+    
+    module InstanceMethods
+      
+      def attachment_for name
+        @_gripster_attachments ||= {}
+        @_gripster_attachments[name] ||= Attachment.for(name, self)
+      end
+      
+      def each_attachment
+        self.class.attachment_definitions.each do |name, definition|
+          yield(name, attachment_for(name))
+        end
+      end
+      
+      def save_attached_files
+        each_attachment do |name, attachment|
+          attachment.owner_id = self.id
+          attachment.send(:save) unless attachment.nil?
+        end
+      end
+    end
+  end
+end

data/lib/griddle/style.rb

@@ -0,0 +1,39 @@
+module Griddle
+  class Style
+    
+    attr_accessor :name, :definition, :attachment
+    
+    def initialize(name, definition, attachment)
+      @name = name
+      @attachment = attachment
+      @definition = case 
+      when definition.is_a?(String)
+        {
+          :geometry => definition
+        }
+      when definition.is_a?(Array)
+        raise "Don't send an array to Style"
+      else
+        raise "Definition must be a type of String, Array, or Hash" unless definition.is_a?(Hash)
+        {
+          :geometry => definition[:geometry]
+        }
+      end
+      
+    end
+    
+    def [](key)
+      return nil unless respond_to? key
+      send(key)
+    end
+    
+    def attachment
+      @attachment
+    end
+    
+    def geometry
+      @definition[:geometry]
+    end
+    
+  end
+end

data/lib/griddle/upfile.rb

@@ -0,0 +1,48 @@
+module Griddle
+  # The Upfile module is a convenience module for adding uploaded-file-type methods
+  # to the +File+ class. Useful for testing.
+  # user.avatar = File.new("test/test_avatar.jpg")
+  module Upfile
+ 
+    # Infer the MIME-type of the file from the extension.
+    def content_type
+      type = (self.path.match(/\.(\w+)$/)[1] rescue "octet-stream").downcase
+      case type
+      when %r"jp(e|g|eg)" then "image/jpeg"
+      when %r"tiff?" then "image/tiff"
+      when %r"png", "gif", "bmp" then "image/#{type}"
+      when "txt" then "text/plain"
+      when %r"html?" then "text/html"
+      when "js" then "application/js"
+      when "csv", "xml", "css" then "text/#{type}"
+      else "application/x-#{type}"
+      end
+    end
+ 
+    # Returns the file's normal name.
+    def original_filename
+      File.basename(self.path)
+    end
+ 
+    # Returns the size of the file.
+    def size
+      File.size(self)
+    end
+  end
+end
+ 
+if defined? StringIO
+  class StringIO
+    attr_accessor :original_filename, :content_type
+    def original_filename
+      @original_filename ||= "stringio.txt"
+    end
+    def content_type
+      @content_type ||= "text/plain"
+    end
+  end
+end
+ 
+class File #:nodoc:
+  include Griddle::Upfile
+end

data/lib/griddle.rb

@@ -0,0 +1,18 @@
+if RUBY_VERSION =~ /1.9.[0-9]/
+  require 'fileutils'
+else
+  require 'ftools'
+end
+require 'mime/types'
+require 'griddle/has_grid_attachment'
+require 'griddle/attachment'
+require 'griddle/upfile'
+require 'griddle/style'
+
+module Griddle
+  def self.version
+    "0.0.1"
+  end
+end
+
+File.send(:include, Griddle::Upfile)

data/rails/init.rb

@@ -0,0 +1 @@
+require 'griddle'

data/test/attachment_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+require "models"
+
+class AttachmentTest < Test::Unit::TestCase
+  
+  context "An Attachment" do
+    
+    setup do
+      @dir = File.dirname(__FILE__) + '/fixtures'
+      @image = File.open("#{@dir}/baboon.jpg", 'r')
+      @doc = DocNoAttachment.create
+      @attachment = Griddle::Attachment.for(:image, @doc)
+    end
+    
+    should "have a #grid_key" do
+      assert_equal @attachment.grid_key, "#{@doc.class.to_s.tableize}/#{@doc.id}/image/"
+    end
+    
+    should "#assign a valid assignment" do
+      @attachment.assign(@image)
+      @attachment.save
+      assert  @attachment.file.is_a? GridFS::GridStore
+      assert GridFS::GridStore.exist?(DocNoAttachment.database, @attachment.grid_key)
+    end
+    
+    context "with a file" do
+      
+      setup do
+        @attachment.assign(@image)
+      end
+    
+      should "#destroy_file" do
+        @attachment.destroy_file
+        assert !GridFS::GridStore.exist?(DocNoAttachment.database, @attachment.grid_key)
+      end
+      
+    end
+    
+  end
+  
+  
+end

data/test/has_attachment_test.rb

@@ -0,0 +1,72 @@
+require "test_helper"
+require "models"
+ 
+class HasAttachmentTest < Test::Unit::TestCase
+  context "A Doc that has_grid_attachment :image" do
+    setup do
+      @document = Doc.new
+      @dir = File.dirname(__FILE__) + '/fixtures'
+      @image = File.open("#{@dir}/baboon.jpg", 'r')
+      @file_system = MongoMapper.database['fs.files']
+    end
+ 
+    teardown do
+      #@file_system.drop
+      @image.close
+    end
+ 
+    should "have :after_save callback" do
+      assert_equal(1, Doc.after_save.collect(&:method).count)
+    end
+ 
+    context "when assigned a file" do
+      setup do
+        @document.image = @image
+        @document.save!
+      end
+ 
+      should "should return an Attachment" do
+        assert_equal(Griddle::Attachment, @document.image.class)
+      end
+ 
+      should "read file from grid store" do
+        assert_equal "image/jpeg", @file_system.find_one(:filename => @document.image.grid_key)['contentType']
+      end
+ 
+    end
+    
+    context "with styles" do
+      
+      setup do
+        @document = DocWithStyles.new
+      end
+      
+      context "when assigned a file" do
+        
+        setup do
+          @document.image = @image
+          @document.save!
+        end
+        
+        should "have a styles" do
+          assert_kind_of Hash, @document.image.styles
+        end 
+        
+      end
+      
+    end
+ 
+    context "when multiple instances" do
+      setup do
+        @document2 = Doc.new
+        @image2 = File.open("#{@dir}/fox.jpg", 'r')
+        @document3 = Doc.new
+        @image3 = File.open("#{@dir}/baboon.jpg", 'r')
+        @document2.image = @image2
+        @document3.image = @image3
+      end
+    end
+ 
+  end
+ 
+end

data/test/models.rb

@@ -0,0 +1,19 @@
+class Doc
+  include MongoMapper::Document
+  include Griddle::HasGridAttachment
+  has_grid_attachment :image
+end
+
+class DocNoAttachment
+  include MongoMapper::Document
+end
+
+class DocWithStyles
+  include MongoMapper::Document
+  include Griddle::HasGridAttachment
+  
+  has_grid_attachment :image, :styles => {
+    :thumb => '50x50#'
+  }
+  
+end

data/test/style_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+require "models"
+
+class StyleTest < Test::Unit::TestCase
+  
+  context "An Attachment with style rules" do
+    
+    setup do
+      @dir = File.dirname(__FILE__) + '/fixtures'
+      @image = File.open("#{@dir}/baboon.jpg", 'r')
+      @options = {
+        :styles=>{
+          :thumb => "50x50#"
+        }
+      }
+      
+      @doc = DocNoAttachment.create
+      @attachment = Griddle::Attachment.for(:image, @doc, @options)
+    end
+    
+    context "and a file" do
+      
+      setup do
+        @attachment.assign(@image)
+      end
+      
+      should "have a styles hash" do
+        assert_kind_of Hash, @attachment.styles
+      end
+      
+      should ":thumb be a type of Griddle::Style" do
+        assert_kind_of Griddle::Style, @attachment.styles[:thumb]
+      end
+      
+      should "have an #attachment for a style" do
+        assert_equal @attachment, @attachment.styles[:thumb].attachment
+      end
+      
+      should "have a geometry for a style" do
+        assert_equal @options[:styles][:thumb], @attachment.styles[:thumb][:geometry]
+      end
+      
+      should "have a #geometry for a style" do
+        assert_equal @options[:styles][:thumb], @attachment.styles[:thumb].geometry
+      end
+      
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'mongo_mapper'
+require 'griddle'
+require 'test/unit'
+require 'shoulda'
+
+TEST_DB = 'griddle-test' unless Object.const_defined?("TEST_DB")
+ 
+MongoMapper.database = TEST_DB
+ 
+class Test::Unit::TestCase
+  def teardown
+    MongoMapper.database.collections.each do |coll|
+      coll.remove
+    end
+  end
+ 
+  # Make sure that each test case has a teardown
+  # method to clear the db after each test.
+  def inherited(base)
+    base.define_method teardown do
+      super
+    end
+  end
+end

data/test/upfile_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class UpfileTest < Test::Unit::TestCase
+  
+  context "A File" do
+    setup do
+      @dir = File.dirname(__FILE__) + '/fixtures'
+      @image = File.open("#{@dir}/baboon.jpg", 'r')
+    end
+    
+    should "have a #content_type" do
+      assert_equal @image.content_type, "image/jpeg"
+    end
+    
+    should "have an #original_filename" do
+      assert_equal @image.original_filename, "baboon.jpg"
+    end
+    
+    should "have a #size" do
+      assert_equal @image.size, File.size(@image.path)
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: griddle
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Matt Mongeau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: GridFS made simple...
+email: matt@toastyapps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- griddle.gemspec
+- lib/griddle.rb
+- lib/griddle/attachment.rb
+- lib/griddle/has_grid_attachment.rb
+- lib/griddle/style.rb
+- lib/griddle/upfile.rb
+- rails/init.rb
+- test/attachment_test.rb
+- test/fixtures/baboon.jpg
+- test/fixtures/fox.jpg
+- test/fixtures/sample.pdf
+- test/has_attachment_test.rb
+- test/models.rb
+- test/style_test.rb
+- test/test_helper.rb
+- test/upfile_test.rb
+has_rdoc: true
+homepage: http://github.com/toastyapps/griddle
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: GridFS made simple.
+test_files: 
+- test/attachment_test.rb
+- test/has_attachment_test.rb
+- test/models.rb
+- test/style_test.rb
+- test/test_helper.rb
+- test/upfile_test.rb