active_record_content_blob 0.1.0

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.14.0"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+  gem 'database_cleaner'
+  gem "pry"
+  gem "rdoc", "~> 3.12"
+end
+
+
+gem 'sqlite3'
+gem 'activesupport', ">=3.2.12"
+gem 'activerecord', ">=3.2.12"

data/Gemfile.lock

@@ -0,0 +1,99 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    arel (4.0.0)
+    atomic (1.1.12)
+    builder (3.1.4)
+    coderay (1.0.9)
+    database_cleaner (1.1.1)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.7.8)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.2)
+    slop (3.4.6)
+    sqlite3 (1.3.7)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.2.12)
+  activesupport (>= 3.2.12)
+  bundler
+  database_cleaner
+  jeweler (~> 1.8.4)
+  pry
+  rdoc (~> 3.12)
+  rspec (~> 2.14.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Dan Nguyen
+
+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,19 @@
+= active_record_content_blob
+
+Description goes here.
+
+== Contributing to active_record_content_blob
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Dan Nguyen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "active_record_content_blob"
+  gem.homepage = "http://github.com/dannguyen/active_record_content_blob"
+  gem.license = "MIT"
+  gem.summary = %Q{Attach a TEXT/BLOB column to your model as a has_one}
+  gem.description = %Q{Loading up TEXT/BLOB columns can be slow}
+  gem.email = "dansonguyen@gmail.com"
+  gem.authors = ["Dan Nguyen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "active_record_content_blob #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/active_record_content_blob.rb

@@ -0,0 +1,6 @@
+require 'content_blob'
+
+module ActiveRecordContentBlob; end
+include ActiveRecordContentBlob
+
+require 'content_blob/blobable'

data/lib/content_blob/blobable.rb

@@ -0,0 +1,59 @@
+module ActiveRecordContentBlob
+  module Blobable
+
+    # This is what an ActiveRecord model includes if it wants to have a content_blob
+
+    extend ActiveSupport::Concern
+    included do
+
+      scope :has_blob, ->{joins(:content_blob)}
+
+      if self.instance_methods.include?(:contents) || self.column_names.include?('contents')
+        raise StandardError, "Cannot already have a :contents attribute or method"
+      end
+
+      has_one :content_blob, as: :blobable, dependent: :destroy
+      # TODO: allow customization of :contents name
+      # in case model already has a contents field
+      delegate :contents, to: :content_blob, allow_nil: true 
+    end
+
+
+    module ClassMethods 
+
+      # returns a new record with an attached blob
+      def build_with_blob(hsh, blob_content=nil)
+        hsh_syms = hsh.symbolize_keys
+        # delete a possible :content_blob so that we can initialize
+        #   the record
+        
+        record = self.new(hsh_syms.reject{|k,v| k == :contents})
+
+        if blob_content.nil?
+          # then build a blob only if hsh_syms has :content_blob key
+          if hsh_syms.key?(:contents)
+            blob_content = hsh_syms[:contents]
+            record.build_a_blob(blob_content)
+          end
+        else
+          # second argument is for the blo
+          record.build_a_blob(blob_content)
+        end
+
+        return record
+      end
+
+      def create_with_blob(hsh, blob_content=nil)
+        build_with_blob(hsh, blob_content).save
+      end
+    end # classmethods
+
+    ## instance methods    
+    def build_a_blob(some_content)
+      self.build_content_blob(contents: some_content)
+    end
+
+
+
+  end
+end

data/lib/content_blob.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+require 'active_support'
+class ContentBlob < ActiveRecord::Base 
+
+
+   serialize :contents
+
+   validates_uniqueness_of :blobable_id, scope: :blobable_type
+   belongs_to :blobable, polymorphic: true
+
+end

data/lib/generators/content_blob/content_blob_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+class ContentBlobGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  desc "Creates the content_blobs table"
+
+  self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  def create_migration_files
+    create_migration_file_if_not_exist 'create_content_blobs'
+  end
+
+  private
+
+  def create_migration_file_if_not_exist(file_name)
+    unless self.class.migration_exists?(File.dirname(File.expand_path("db/migrate/#{file_name}")), file_name)
+      migration_template "#{file_name}.rb", "db/migrate/#{file_name}.rb"
+    end
+  end
+end

data/lib/generators/content_blob/templates/create_content_blobs.rb

@@ -0,0 +1,16 @@
+class CreateContentBlobs < ActiveRecord::Migration
+  def self.up
+    create_table :content_blobs do |t|
+      t.integer  "blobable_id"
+      t.string   "blobable_type"
+      t.text     "contents",       :limit => 2147483647
+      t.timestamps
+    end
+
+    add_index :content_blobs, [:blobable_type, :blobable_id]
+  end
+
+  def self.down
+    drop_table :content_blobs
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'database_cleaner'
+require 'sqlite3'
+
+require 'active_record_content_blob'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+#DatabaseCleaner.strategy = :truncation
+
+RSpec.configure do |config|
+   # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :content_blobs do |t|
+    t.integer  "blobable_id"
+    t.string   "blobable_type"
+    t.text     "contents",       :limit => 2147483647
+    t.timestamps
+  end
+
+  add_index :content_blobs, [:blobable_type, :blobable_id]
+
+
+  ##############
+  create_table :music_records, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :bad_records, :force => true do |t|
+    t.string :namez
+    t.string :contents
+    t.timestamps
+  end
+
+end
+
+
+
+

data/spec/unit/blobable_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+class MusicRecord < ActiveRecord::Base 
+  include Blobable
+end
+
+class BadRecord < ActiveRecord::Base; end
+
+describe "Blobable" do
+  before(:each) do 
+    DatabaseCleaner.clean
+    MusicRecord.delete_all
+    ContentBlob.delete_all
+  end
+
+  it 'should raise an error if a class has :contents as an actual field' do 
+    expect{BadRecord.class_eval('include Blobable')}.to raise_error
+  end
+
+  describe '#build_a_blob' do
+    before(:each) do 
+      @record = MusicRecord.new
+      @record.build_a_blob({'abc' => 123})
+      @record.save
+    end
+
+    it 'should have :blobable_id and :blobable_type' do 
+      @blob = @record.content_blob
+      expect(@blob.blobable_id).to eq @record.id 
+      expect(@blob.blobable_type).to eq 'MusicRecord'
+    end
+
+    it 'should assign single argument to :contents' do 
+      expect(@record.contents).to eq({'abc' => 123})
+    end
+
+    it 'should overwrite existing blob' do 
+      @record.build_a_blob({'xyz'=>'999'})
+      expect(@record.content_blob.new_record?).to be_true
+      expect(@record.content_blob.valid?).to be_true
+
+      @record.save
+      
+      @record = MusicRecord.find(@record.id)
+      expect(@record.contents['xyz']).to eq '999'
+
+      expect(ContentBlob.count).to eq 1
+    end
+  end
+
+  describe 'class convenience method ::build_with_blob' do 
+    context 'one argument' do 
+      it 'should build associated content_blob with Hash :contents' do 
+        @record = MusicRecord.build_with_blob({name: 'X', contents: [1]})
+        expect(@record.contents).to eq [1]
+      end
+
+      it 'should build no content_blob without :contents' do 
+        @record = MusicRecord.build_with_blob(name: 'X')
+        expect(@record.contents).to be_nil
+      end
+    end
+
+    context 'second argument' do 
+      it 'should use second argument as :contents for built blob' do 
+        @record = MusicRecord.build_with_blob({name: 'A'}, [99])
+        expect(@record.contents).to eq [99]
+      end
+    end
+  end
+
+  context 'scopes' do 
+    before(:each) do 
+      @r1 = MusicRecord.create_with_blob(name: 'A', contents: ['Z'])
+      @r2 = MusicRecord.create(name: 'qqq')
+    end
+
+    describe '::has_blob' do 
+      it 'should only count records with associated content_blob' do
+       expect(MusicRecord.has_blob.count).to eq 1
+       expect(MusicRecord.has_blob.first.name).to eq 'A'
+      end
+
+      it 'should not eager load content_blob'
+    end
+  end
+end

data/spec/unit/content_blob_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe "ContentBlob" do
+  context 'standalone' do
+    before(:each) do 
+      DatabaseCleaner.clean
+    end
+
+    context 'serialization' do 
+      it 'should by default serialize @contents' do 
+        @blob = ContentBlob.create(contents: [1,2,3])
+        expect(@blob.contents).to be_an Array
+      end    
+    end
+
+    context 'validation and scope' do 
+      it 'should validate_uniqueness_of blobable_id and blobable_type' do 
+        ContentBlob.create(blobable_id: 10, blobable_type: 'Hello')
+        @blob = ContentBlob.new(blobable_id: 10, blobable_type: 'Hello')
+        expect(@blob.valid?).to be_false
+      end
+    end
+
+    context 'x' do
+
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: active_record_content_blob
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dan Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: pry
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Loading up TEXT/BLOB columns can be slow
+email: dansonguyen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/active_record_content_blob.rb
+- lib/content_blob.rb
+- lib/content_blob/blobable.rb
+- lib/generators/content_blob/content_blob_generator.rb
+- lib/generators/content_blob/templates/create_content_blobs.rb
+- spec/spec_helper.rb
+- spec/unit/blobable_spec.rb
+- spec/unit/content_blob_spec.rb
+homepage: http://github.com/dannguyen/active_record_content_blob
+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: -996606693736125422
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Attach a TEXT/BLOB column to your model as a has_one
+test_files: []