sbfaulkner-sequel_container 1.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 unwwwired.net
+ 
+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.markdown

@@ -0,0 +1,45 @@
+# sequel\_container
+
+contained documents (i.e. attachments) for sequel models
+
+## WHY?
+
+I needed a way to more easily support images and css in blobs, since the hosting provider I'm using is read-only (except for the tmp folder) and I'm not ready to use Amazon, or any other external storage provider.
+
+## Installation
+
+Run the following if you haven't already:
+
+    $ gem sources -a http://gems.github.com
+  
+Install the gem(s):
+
+    $ sudo gem install -r sbfaulkner-sequel_container
+
+## Example
+
+    require 'rubygems'
+    require 'sequel'
+    
+    class User < Sequel::Model
+      set_schema do
+        primary_key :id
+        varchar :avatar_type, :size => 255
+        bytea :avatar_data
+      end
+      is :container, :tmp => File.dirname(__FILE__) + '/tmp'
+      contains :avatar
+    end
+    
+## TODO
+
+- remove frozen copy sequel gem when updateis released
+- include logic for image width and height
+- better assignment support (i.e. don't require separate assignment of type and data)
+- publish in sequel www/pages/plugins
+- other containment types... e.g. filesystem, s3, git?
+
+## Legal
+
+**Author:** S. Brent Faulkner <brentf@unwwwired.net>  
+**License:** Copyright &copy; 2009 unwwwired.net, released under the MIT license

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+load File.join(File.dirname(__FILE__),'sequel_container.gemspec')
+
+Rake::GemPackageTask.new(SPEC) do |pkg|
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+Rake::Task[:test].comment = "Run the tests"
+
+task :default => :test

data/lib/sequel_container.rb

@@ -0,0 +1,77 @@
+require 'tmpdir'
+
+module Sequel
+  module Plugins
+    module Container
+      def self.apply(model, options = {})
+        model.const_set "CONTAINER_TMPDIR", options[:tmp] || Dir.tmpdir
+      end
+
+      module ClassMethods
+        def contains(object, options = {})
+          return object.each { |o| contains(o, options) } if object.is_a? Array
+
+          container = table_name
+
+          class_eval <<-CONTAINED_PATH, __FILE__, __LINE__ + 1
+            def #{object}_path
+              return if #{object}_data.nil? || #{object}_data.empty?
+              @#{object}_path ||= write_#{object}
+            end
+          CONTAINED_PATH
+
+          class_eval <<-CONTAINED_URL, __FILE__, __LINE__ + 1
+            def #{object}_url
+              return if #{object}_data.nil? || #{object}_data.empty?
+              @#{object}_path ||= write_#{object}
+              @#{object}_url ||= "/#{container}/\#{id}/\#{#{object}_filename}"
+            end
+          CONTAINED_URL
+
+          class_eval <<-CONTAINED_IMAGE, __FILE__, __LINE__ + 1
+            def #{object}_image?
+              #{object}_type[0,6] == 'image/'
+            end
+          CONTAINED_IMAGE
+
+          class_eval <<-CONTAINED_DIRECTORY, __FILE__, __LINE__ + 1
+            def #{object}_directory
+              @asset_directory ||= FileUtils.mkdir_p(File.join(CONTAINER_TMPDIR, "#{container}", id.to_s))
+            end
+            protected :#{object}_directory
+          CONTAINED_DIRECTORY
+
+          class_eval <<-CONTAINED_FILENAME, __FILE__, __LINE__ + 1
+            def #{object}_filename
+              @#{object}_filename ||= "#{object}.\#{#{object}_extension}"
+            end
+            protected :#{object}_filename
+          CONTAINED_FILENAME
+
+          class_eval <<-CONTAINED_EXTENSION, __FILE__, __LINE__ + 1
+            def #{object}_extension
+              @#{object}_extension ||= case #{object}_type
+                when /^text\\\/plain/
+                  'txt'
+                when /^(?:image|text)\\\/(.*)/
+                  $1
+                else
+                  raise "unhandled asset type \#{#{object}_type}"
+                end
+            end
+            protected :#{object}_extension
+          CONTAINED_EXTENSION
+
+          class_eval <<-WRITE_CONTAINED, __FILE__, __LINE__ + 1
+            def write_#{object}
+              path = File.join(#{object}_directory, #{object}_filename)
+              File.open(path, 'w') { |file| file.write #{object}_data }
+              path
+            end
+            protected :write_#{object}
+          WRITE_CONTAINED
+        end
+      end
+    end
+  end
+end

data/sequel_container.gemspec

@@ -0,0 +1,19 @@
+SPEC = Gem::Specification.new do |s| 
+  # identify the gem
+  s.name = "sequel_container" 
+  s.version = "1.0.1" 
+  s.author = "S. Brent Faulkner" 
+  s.email = "brentf@unwwwired.net" 
+  s.homepage = "http://github.com/sbfaulkner/sequel_container" 
+  # platform of choice
+  s.platform = Gem::Platform::RUBY
+  # description of gem
+  s.summary = "contained documents (i.e. attachments) for sequel models"
+  s.files = %w(lib/sequel_container.rb MIT-LICENSE Rakefile README.markdown sequel_container.gemspec test/sequel_container_test.rb test/data/bio.html test/data/bio.txt test/data/logo.gif)
+  s.require_path = "lib"
+  s.test_file = "test/sequel_container_test.rb" 
+  s.has_rdoc = true 
+  s.extra_rdoc_files = ["README.markdown"] 
+  s.add_dependency "sequel"
+  # s.rubyforge_project = "sequel_container"
+end 

data/test/data/bio.html

@@ -0,0 +1,13 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <title>biography</title>
+  </head>
+  <body>
+    <p>unwwwired.net is S. Brent Faulkner, an independent developer based in Caledon, Ontario with a wide range of experience from over 20 years in the software industry.</p>
+    </p>Working “closer to the metal” in C and C++ for many years, Brent's past projects included code generators, compilers and interpreters, mobile message switches and terminal emulators for UNIX and Windows.</p>
+    </p>More recently, he spent several years developing FileMaker Pro applications for the enterprise before being bitten by the Ruby on Rails bug.</p>
+    </p>Offering a wide variety of services, he has extensive experience with custom software development, web technologies, systems integration and system administration.</p>
+  </body>
+</html>

data/test/data/bio.txt

@@ -0,0 +1,7 @@
+unwwwired.net is S. Brent Faulkner, an independent developer based in Caledon, Ontario with a wide range of experience from over 20 years in the software industry.
+
+Working “closer to the metal” in C and C++ for many years, Brent's past projects included code generators, compilers and interpreters, mobile message switches and terminal emulators for UNIX and Windows.
+
+More recently, he spent several years developing FileMaker Pro applications for the enterprise before being bitten by the Ruby on Rails bug.
+
+Offering a wide variety of services, he has extensive experience with custom software development, web technologies, systems integration and system administration.

data/test/sequel_container_test.rb

@@ -0,0 +1,73 @@
+# get frozen copy of sequel with patched support for bytea escaping
+$:.unshift File.dirname(__FILE__)+'/sequel-2.8.0.patched/lib'
+
+require 'rubygems'
+require 'test/unit'
+require 'sequel'
+
+DB = Sequel.connect('postgres://postgres:p0stgr3s@localhost:5432/sequel_container_test')
+
+class Company < Sequel::Model
+  set_schema do
+    primary_key :id
+    varchar :logo_type, :size => 255
+    bytea :logo_data
+    varchar :biography_type, :size => 255
+    bytea :biography_data
+  end
+  create_table!
+  is :container
+  contains [ :logo, :biography ]
+end
+
+class User < Sequel::Model
+  set_schema do
+    primary_key :id
+    varchar :avatar_type, :size => 255
+    bytea :avatar_data
+  end
+  create_table!
+  is :container, :tmp => File.dirname(__FILE__) + '/tmp'
+  contains :avatar
+end
+
+class SequelCascadingTest < Test::Unit::TestCase
+  def test_should_create_empty_container
+    company = Company.create
+    assert company.reload
+    assert_nil company.logo_type
+    assert_nil company.logo_data
+    assert_nil company.logo_path
+    assert_nil company.logo_url
+  end
+
+  def test_should_contain_image
+    logo = File.read(File.dirname(__FILE__)+'/data/logo.gif')
+    company = Company.create :logo_type => 'image/gif', :logo_data => logo
+    assert company.reload
+    assert company.logo_image?
+    assert_equal logo, company.logo_data
+    assert_equal Dir.tmpdir+"/companies/#{company.id}/logo.gif", company.logo_path
+    assert_equal "/companies/#{company.id}/logo.gif", company.logo_url
+  end
+
+  def test_should_contain_text
+    bio = File.read(File.dirname(__FILE__)+'/data/bio.txt')
+    company = Company.create :biography_type => 'text/plain', :biography_data => bio
+    assert company.reload
+    assert !company.biography_image?
+    assert_equal bio, company.biography_data
+    assert_equal Dir.tmpdir+"/companies/#{company.id}/biography.txt", company.biography_path
+    assert_equal "/companies/#{company.id}/biography.txt", company.biography_url
+  end
+
+  def test_should_contain_html
+    bio = File.read(File.dirname(__FILE__)+'/data/bio.html')
+    company = Company.create :biography_type => 'text/html', :biography_data => bio
+    assert company.reload
+    assert !company.biography_image?
+    assert_equal bio, company.biography_data
+    assert_equal Dir.tmpdir+"/companies/#{company.id}/biography.html", company.biography_path
+    assert_equal "/companies/#{company.id}/biography.html", company.biography_url
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: sbfaulkner-sequel_container
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- S. Brent Faulkner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: brentf@unwwwired.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- lib/sequel_container.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- sequel_container.gemspec
+- test/sequel_container_test.rb
+- test/data/bio.html
+- test/data/bio.txt
+- test/data/logo.gif
+has_rdoc: true
+homepage: http://github.com/sbfaulkner/sequel_container
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: contained documents (i.e. attachments) for sequel models
+test_files: 
+- test/sequel_container_test.rb