mongoid_snappy 0.0.4

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
+.idea

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+mongoid_snappy

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 GlebTV
+
+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,49 @@
+# MongoidSnappy
+
+Allow string attributes in Mongoid to be compressed with Snappy
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_snappy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_snappy
+
+## Usage
+
+MongoDB doesn't have built in support for data compression.
+
+See https://jira.mongodb.org/browse/SERVER-164
+
+So in meantime the solution is application level compression.
+
+Define a field of type Mongoid::Snappy
+
+```ruby
+class MyModel
+  field :long_text, type: Mongoid::Snappy
+end
+```
+
+Strings are transparently compressed and decompressed:
+
+```ruby
+m = MyModel.new
+m.long_text = 'a very long string here'
+m.long_text # -> 'a very long string here'
+```
+
+## 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/lib/mongoid_snappy.rb

@@ -0,0 +1,128 @@
+# coding: utf-8
+
+require 'mongoid_snappy/version'
+require 'snappy'
+
+module Mongoid
+  class Snappy
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$)/ }
+
+    def initialize(data)
+      @data = data.force_encoding('UTF-8')
+    end
+
+    def to_s
+      @data
+    end
+
+    def inspect
+      '"' + @data + '"'
+    end
+
+    def ==(other)
+      if other.class == self.class
+        other.to_s == to_s
+      elsif other.class == String
+        @data == other
+      else
+        false
+      end
+    end
+
+    def coerce(something)
+      [self, something]
+    end
+
+    def mongoize
+      Moped::BSON::Binary.new(:generic, ::Snappy.deflate(@data))
+    end
+
+    protected
+
+    def method_missing(name, *args, &block)
+      @data.send(name, *args, &block)
+    end
+
+    class << self
+
+      # Get the object as it was stored in the database, and instantiate
+      # this custom class from it.
+      def demongoize(object)
+        if object.is_a?(Moped::BSON::Binary)
+          Mongoid::Snappy.new(::Snappy.inflate(object.data))
+        elsif object.is_a?(String)
+          Mongoid::Snappy.new(object)
+        else
+          object
+        end
+      end
+
+      # Takes any possible object and converts it to how it would be
+      # stored in the database.
+      def mongoize(object)
+        case
+          when object.is_a?(Mongoid::Snappy) then object.mongoize
+          when object.is_a?(String) then Mongoid::Snappy.new(object).mongoize
+          else object
+        end
+      end
+
+      # Converts the object that was supplied to a criteria and converts it
+      # into a database friendly form.
+      def evolve(object)
+        case object
+          when Mongoid::Snappy then object.mongoize
+          when String then Mongoid::Snappy.new(object).mongoize
+          else object
+        end
+      end
+    end
+  end
+end
+
+if Object.const_defined?("RailsAdmin")
+  require 'rails_admin/adapters/mongoid'
+  require 'rails_admin/config/fields/types/text'
+  module RailsAdmin
+    module Adapters
+      module Mongoid
+        alias_method :type_lookup_without_mongoid_snappy, :type_lookup
+        def type_lookup(name, field)
+          if field.type.to_s == 'Mongoid::Snappy'
+            { :type => :mongoid_snappy }
+          else
+            type_lookup_without_mongoid_snappy(name, field)
+          end
+        end
+      end
+    end
+
+    module Config
+      module Fields
+        module Types
+          class MongoidSnappy < RailsAdmin::Config::Fields::Types::Text
+            # Register field type for the type loader
+            RailsAdmin::Config::Fields::Types::register(self)
+
+            register_instance_option :pretty_value do
+              if value.respond_to?(:data)
+                ::Snappy.inflate(value.data).force_encoding('UTF-8')
+              else
+                value
+              end
+            end
+
+            register_instance_option :formatted_value do
+              if value.respond_to?(:data)
+                ::Snappy.inflate(value.data).force_encoding('UTF-8')
+              else
+                value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/mongoid_snappy/version.rb

@@ -0,0 +1,3 @@
+module MongoidSnappy
+  VERSION = "0.0.4"
+end

data/mongoid_snappy.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_snappy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_snappy"
+  spec.version       = MongoidSnappy::VERSION
+  spec.authors       = ["GlebTV"]
+  spec.email         = ["glebtv@gmail.com"]
+  spec.description   = %q{Mongoid Snappy}
+  spec.summary       = %q{Allow string attributes in Mongoid to be compressed with Snappy}
+  spec.homepage      = "https://github.com/rs-pro/mongoid_snappy"
+  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_runtime_dependency 'snappy', '~> 0.0.8'
+  spec.add_runtime_dependency 'mongoid', '>= 3.0'
+
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "simplecov", "~> 0.7.1"
+  spec.add_development_dependency "database_cleaner", "~> 0.9.1"
+  spec.add_development_dependency "mongoid-rspec", "~> 1.7.0"
+  spec.add_development_dependency "faker", "~> 1.1.2"
+end

data/spec/mongoid_snappy_spec.rb

@@ -0,0 +1,48 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe MongoidSnappy do
+  it 'correctly stores data' do
+    100.times do
+      text = Faker::Lorem.paragraphs(5).join(" ")
+      c = Dummy.new(long_text: text)
+      c.long_text.should eq text
+      c.save.should be_true
+      c.long_text.should eq text
+      c.read_attribute(:long_text).data.length.should be < text.length
+      Dummy.find(c.id).long_text.should eq text
+    end
+  end
+
+  it 'correctly migrates data from string field' do
+    text = Faker::Lorem.paragraphs(3).join(" ")
+    c = Dummy.new(migrate_test: text)
+    c.save.should be_true
+    Migrated.first.migrate_test.should eq text
+  end
+
+  it 'correctly looks up string in DB' do
+    text = Faker::Lorem.words(5).join(" ")
+    c = Dummy.new(long_text: text)
+    c.long_text.should eq text
+    c.save.should be_true
+    c.long_text.should eq text
+
+    f = Dummy.where(long_text: text).first
+    f.should_not be_nil
+    f.long_text.should eq text
+  end
+
+  it 'correctly looks up string in DB' do
+    text = Mongoid::Snappy.new(Faker::Lorem.words(5).join(" "))
+    c = Dummy.new(long_text: text)
+    c.long_text.should eq text
+    c.save.should be_true
+    c.long_text.should eq text
+
+    f = Dummy.where(long_text: text).first
+    f.should_not be_nil
+    f.long_text.should eq text
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+require 'mongoid'
+require 'database_cleaner'
+require 'mongoid-rspec'
+require 'faker'
+require 'mongoid_snappy'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Mongoid.configure do |config|
+  ENV["MONGOID_ENV"] = "test"
+  Mongoid.load!("spec/support/mongoid.yml")
+end
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.strategy = :truncation
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+  config.include Mongoid::Matchers
+  config.mock_with :rspec
+end

data/spec/support/models.rb

@@ -0,0 +1,12 @@
+class Dummy
+  include Mongoid::Document
+
+  field :migrate_test, type: String
+  field :long_text, type: Mongoid::Snappy
+end
+
+class Migrated
+  include Mongoid::Document
+  store_in collection: 'dummies'
+  field :migrate_test, type: Mongoid::Snappy
+end

data/spec/support/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid_snappy
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_snappy
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- GlebTV
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: snappy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Mongoid Snappy
+email:
+- glebtv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_snappy.rb
+- lib/mongoid_snappy/version.rb
+- mongoid_snappy.gemspec
+- spec/mongoid_snappy_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/mongoid.yml
+homepage: https://github.com/rs-pro/mongoid_snappy
+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'
+      segments:
+      - 0
+      hash: 1394254402025025875
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1394254402025025875
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Allow string attributes in Mongoid to be compressed with Snappy
+test_files:
+- spec/mongoid_snappy_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/mongoid.yml