contentz 0.2.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Pickles
+
+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,21 @@
+= contentz
+
+Contentz (pronounced "content zee") is an ActiveRecord extension that uses Zlib to compress/uncompress attribute data on write/read.
+
+== Usage
+
+Require the gem in <tt>config/environment.rb</tt>:
+
+  Rails::Initializer.run do |config|
+    config.gem 'benpickles-contentz', :lib => 'contentz', :source => 'http://gems.github.com'
+  end
+
+Use the <tt>contentz</tt> method in any ActiveRecord model to apply compression to attribute(s):
+
+  class Article < ActiveRecord::Base
+    contentz :body
+  end
+
+== Copyright
+
+Copyright (c) 2009 Ben Pickles. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "contentz"
+    gem.summary = 'Contentz (pronounced "content zee") is an ActiveRecord extension that uses Zlib to compress/uncompress attribute data on write/read.'
+    gem.email = "spideryoung@gmail.com"
+    gem.homepage = "http://github.com/benpickles/contentz"
+    gem.authors = ["Ben Pickles"]
+    gem.add_dependency "activerecord"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "contentz #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require File.join(File.dirname(__FILE__), 'test', 'config')
+
+namespace :db do
+  desc 'Build the MySQL test database.'
+  task :build do
+    `mysqladmin -u #{DB_USER} create #{DB_NAME}`
+  end
+
+  desc 'Drop the MySQL test database.'
+  task :drop do
+    `mysqladmin -u #{DB_USER} -f drop #{DB_NAME}`
+  end
+
+  desc 'Rebuild the MySQL test databases'
+  task :rebuild => [:drop, :build]
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 1

data/lib/contentz.rb

@@ -0,0 +1,29 @@
+module Contentz
+  require 'zlib'
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def contentz(*methods)
+      methods.each do |name|
+        define_method name do
+          begin
+            data = read_attribute(name)
+            Zlib::Inflate.inflate(data.to_s)
+          rescue Zlib::BufError
+            ''
+          end
+        end
+
+        define_method "#{name}=" do |value|
+          data = Zlib::Deflate.deflate(value.to_s, Zlib::BEST_COMPRESSION)
+          write_attribute(name, data)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Contentz

data/test/config.rb

@@ -0,0 +1,2 @@
+DB_USER = 'root'
+DB_NAME = 'contentz_gem_test'

data/test/contentz_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class ContentzTest < Test::Unit::TestCase
+  context 'contentz method defined' do
+    test 'on ActiveRecord::Base' do
+      assert_respond_to ActiveRecord::Base, :contentz
+    end
+  end
+
+  context 'read/write data:' do
+    setup do
+      @article = Article.new
+    end
+
+    test 'read non-binary (or unset/nil/empty) content as a blank string' do
+      assert_equal '', @article.body
+    end
+
+    test 'store content as binary data' do
+      @article.body = 'True or false, yes or no, the choice is yours.'
+      assert @article.read_attribute(:body).is_binary_data?
+    end
+
+    test 'store nil as a empty string' do
+      @article.body = ''
+      assert_equal '', @article.body
+      @article.body = nil
+      assert_equal '', @article.body
+    end
+
+    test 'write/read correctly' do
+      [
+        'Lorem ipsum',
+        '!@£$%^&*()œ∑†¥¨πåß∂ƒ©˙∆˚¬Ω≈ç√∫',
+        'Lorem ipsum dolor sit amet, consectetur adipiscing elit. ' * 666
+      ].each do |string|
+        @article.body = string
+        assert_equal string, @article.body
+      end
+    end
+  end
+
+  context 'saving and reloading' do
+    test 'should not alter the content' do
+      string = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+      id = Article.create!(:body => string).id
+      assert_equal string, Article.find(id).body
+    end
+  end
+
+  context 'with memoization' do
+    test 'should only uncompress the same content once' do
+      Zlib::Inflate.expects(:inflate).once
+      @article = ArticleWithMemoization.new
+      @article.body = 'content'
+      @article.body
+      @article.body
+    end
+  end
+end

data/test/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define do
+  create_table :articles, :force => true do |t|
+    t.binary :body
+  end
+end

data/test/setup.rb

@@ -0,0 +1,23 @@
+require 'config'
+require 'logger'
+
+ActiveRecord::Base.configurations = {
+  'test' => {
+    :adapter  => 'mysql',
+    :database => DB_NAME,
+    :username => DB_USER
+  }
+}
+
+ActiveRecord::Base.establish_connection 'test'
+
+require 'schema'
+
+class Article < ActiveRecord::Base
+  contentz :body
+end
+
+class ArticleWithMemoization < Article
+  extend ActiveSupport::Memoizable
+  memoize :body
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'test/unit'
+require 'activerecord'
+
+{
+  'context' => 'jeremymcanally-context -s http://gems.github.com',
+  'mocha' => 'mocha'
+}.each do |lib, command|
+  begin
+    require lib
+  rescue LoadError
+    puts "#{lib.capitalize} not available. Install it with: sudo gem install #{command}"
+    exit
+  end
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'contentz'
+require 'setup' # ActiveRecord setup.

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: contentz
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Ben Pickles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: spideryoung@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/contentz.rb
+- test/config.rb
+- test/contentz_test.rb
+- test/schema.rb
+- test/setup.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/benpickles/contentz
+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: Contentz (pronounced "content zee") is an ActiveRecord extension that uses Zlib to compress/uncompress attribute data on write/read.
+test_files: 
+- test/config.rb
+- test/contentz_test.rb
+- test/schema.rb
+- test/setup.rb
+- test/test_helper.rb