associo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d303af488b234afa9287b1047241a993511df12f
+  data.tar.gz: 427468da4bec28be43c75d87559c6cf7c9115226
+SHA512:
+  metadata.gz: e5272729031e9951c3150af06233b1a63ea1e830f06ae66a6a6eb089a76f24a57ca95489bcac85e4554f99e57996f7675426646e09b47243b45546d313d0e866
+  data.tar.gz: c19d6f2a7718d000403e763289ced24a0dc1d1adaa122961b1496023edd168890dd4a5e55dec6c6a8c10c47c11bb537adb925126362d20db74a5053f311d619b

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gemspec
+
+gem 'rake'
+gem 'bson_ext', :require => false
+gem 'shoulda'
+gem 'mocha'
+gem 'jnunemaker-matchy'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John Nunemaker
+
+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,39 @@
+= DEAD AND UNMAINTAINED
+
+== Joint
+
+MongoMapper and GridFS joined in file upload love.
+
+== Usage
+
+Declare the plugin and use the attachment method to make attachments.
+
+  class Foo
+    include MongoMapper::Document
+    plugin Joint
+
+    attachment :image
+    attachment :pdf
+  end
+
+This gives you #image, #image=, #pdf, and #pdf=. The = methods take any IO that responds to read (File, Tempfile, etc). The image and pdf methods return a GridIO instance (can be found in the ruby driver).
+
+Also, #image and #pdf are proxies so you can do stuff like:
+
+    doc.image.id, doc.image.size, doc.image.type, doc.image.name
+
+If you call a method other than those in the proxy it calls it on the GridIO instance so you can still get at all the GridIO instance methods.
+
+== 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 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs      << 'lib' << 'test'
+  test.pattern   = 'test/**/test_*.rb'
+  test.ruby_opts = ['-rubygems']
+  test.verbose   = true
+end
+
+task :default => :test

data/associo.gemspec

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+require File.expand_path('../lib/associo/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'associo'
+  s.summary     = %(MongoMapper and GridFS joined in file upload love.)
+  s.description = %(Implements an easy to use GridFS API for MongoMapper.)
+  s.email       = 'syntruth@gmail.com'
+  s.homepage    = 'https://github.com/syntruth/Associo'
+  s.authors     = ['John Nunemaker', 'Randy Carnahan']
+  s.version     = Associo::VERSION
+
+  s.add_dependency 'wand', '~> 0.4'
+  s.add_dependency 'mime-types'
+  s.add_dependency 'mongo_mapper', '~> 0.9'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f|
+    File.basename(f)
+  }
+
+  s.require_paths = ['lib']
+end

data/lib/associo.rb

@@ -0,0 +1,29 @@
+require 'set'
+require 'mime/types'
+require 'wand'
+require 'active_support/concern'
+
+# Main Associo module
+module Associo
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :attachment_names
+
+    self.attachment_names = Set.new
+
+    include attachment_accessor_module
+  end
+
+  def self.blank?(str)
+    str.nil? || str !~ /\S/
+  end
+
+  private_class_method :blank?
+end
+
+require 'associo/class_methods'
+require 'associo/instance_methods'
+require 'associo/attachment_proxy'
+require 'associo/io'
+require 'associo/file_helpers'

data/lib/associo/attachment_proxy.rb

@@ -0,0 +1,51 @@
+module Associo
+  # Proxy for the Attached file.
+  class AttachmentProxy
+    def initialize(instance, name)
+      @instance = instance
+      @name     = name
+    end
+
+    def id
+      @instance.send "#{@name}_id"
+    end
+
+    def name
+      @instance.send "#{@name}_name"
+    end
+
+    def size
+      @instance.send "#{@name}_size"
+    end
+
+    def type
+      @instance.send "#{@name}_type"
+    end
+
+    def chunk_size
+      @instance.send "#{@name}_chunk_size"
+    end
+
+    def nil?
+      !@instance.send("#{@name}?")
+    end
+
+    alias blank? nil?
+
+    def grid_io
+      @grid_io ||= @instance.grid.get(id)
+    end
+
+    def method_missing(method, *args, &block)
+      if grid_io.respond_to? method.to_s
+        grid_io.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      super
+    end
+  end
+end

data/lib/associo/class_methods.rb

@@ -0,0 +1,64 @@
+module Associo
+  # Define new class methods for documents that
+  # include the Associo module.
+  module ClassMethods
+    DEFAULT_CHUNK_SIZE = 261_120
+
+    def attachment_accessor_module
+      @attachment_accessor_module ||= Module.new
+    end
+
+    # rubocop:disable AbcSize, MethodLength
+    # TODO: refactor this.
+    def attachment(name, options = {})
+      options.symbolize_keys!
+
+      name = name.to_sym
+
+      chunk_size = options.fetch(:chunk_size, DEFAULT_CHUNK_SIZE).to_i
+      chunk_size = DEFAULT_CHUNK_SIZE if chunk_size.zero?
+
+      self.attachment_names = attachment_names.dup.add(name)
+
+      after_save     :save_attachments
+      before_save    :nullify_nil_attachments_attributes
+      after_save     :destroy_nil_attachments
+      before_destroy :destroy_all_attachments
+
+      key :"#{name}_id",   ObjectId
+      key :"#{name}_name", String
+      key :"#{name}_size", Integer
+      key :"#{name}_type", String
+
+      # Allow for optional, custom chunk size, in bytes.
+      # Default size is 255k, set above.
+      key :"#{name}_chunk_size", Integer, default: chunk_size
+
+      validates_presence_of(name) if options[:required]
+
+      attachment_accessor_module.module_eval <<-EOC
+        def #{name}
+          @#{name} ||= AttachmentProxy.new(self, :#{name})
+        end
+
+        def #{name}?
+          !nil_attachments.has_key?(:#{name}) && send(:#{name}_id?)
+        end
+
+        def #{name}=(file)
+          if file.nil?
+            nil_attachments[:#{name}] = send("#{name}_id")
+            assigned_attachments.delete(:#{name})
+          else
+            send("#{name}_id=", BSON::ObjectId.new) if send("#{name}_id").nil?
+            send("#{name}_name=", Associo::FileHelpers.name(file))
+            send("#{name}_size=", Associo::FileHelpers.size(file))
+            send("#{name}_type=", Associo::FileHelpers.type(file))
+            assigned_attachments[:#{name}] = file
+            nil_attachments.delete(:#{name})
+          end
+        end
+      EOC
+    end
+  end
+end

data/lib/associo/file_helpers.rb

@@ -0,0 +1,20 @@
+module Associo
+  # Syntax helper for accessing file attributes.
+  module FileHelpers
+    def self.name(file)
+      return file.original_filename if file.respond_to?(:original_filename)
+
+      File.basename(file.path)
+    end
+
+    def self.size(file)
+      file.respond_to?(:size) ? file.size : File.size(file)
+    end
+
+    def self.type(file)
+      return file.type if file.is_a? Associo::IO
+
+      Wand.wave file.path, original_filename: Associo::FileHelpers.name(file)
+    end
+  end
+end

data/lib/associo/instance_methods.rb

@@ -0,0 +1,59 @@
+# Define Instance Methods
+module Associo
+  def grid
+    @grid ||= Mongo::Grid.new(database)
+  end
+
+  private
+
+  def assigned_attachments
+    @assigned_attachments ||= {}
+  end
+
+  def nil_attachments
+    @nil_attachments ||= {}
+  end
+
+  # IO must respond to read and rewind
+  def save_attachments
+    assigned_attachments.each_pair do |name, io|
+      next unless io.respond_to?(:read)
+
+      io.rewind if io.respond_to?(:rewind)
+
+      grid.delete send(name).id
+
+      grid.put io, save_attachment_hash(name)
+    end
+
+    assigned_attachments.clear
+  end
+
+  def save_attachment_hash(name)
+    {
+      _id:          send(name).id,
+      filename:     send(name).name,
+      content_type: send(name).type,
+      chunk_size:   send(name).chunk_size
+    }
+  end
+
+  def nullify_nil_attachments_attributes
+    nil_attachments.each_key do |name|
+      send :"#{name}_id=",   nil
+      send :"#{name}_size=", nil
+      send :"#{name}_type=", nil
+      send :"#{name}_name=", nil
+    end
+  end
+
+  def destroy_nil_attachments
+    nil_attachments.each_value { |id| grid.delete id }
+
+    nil_attachments.clear
+  end
+
+  def destroy_all_attachments
+    self.class.attachment_names.map { |name| grid.delete send(name).id }
+  end
+end

data/lib/associo/io.rb

@@ -0,0 +1,29 @@
+require 'stringio'
+
+module Associo
+  # Defines the file io for the attached file.
+  class IO
+    attr_accessor :name, :content, :type, :size
+
+    def initialize(attrs = {})
+      attrs.each { |key, value| send("#{key}=", value) }
+
+      @type ||= 'plain/text'
+    end
+
+    def content=(value)
+      @io   = StringIO.new(value || nil)
+      @size = value ? value.size : 0
+    end
+
+    def read(*args)
+      @io.read(*args)
+    end
+
+    def rewind
+      @io.rewind if @io.respond_to?(:rewind)
+    end
+
+    alias path name
+  end
+end

data/lib/associo/version.rb

@@ -0,0 +1,3 @@
+module Associo
+  VERSION = '0.1.0'.freeze
+end

data/specs.watchr

@@ -0,0 +1,50 @@
+def run(cmd)
+  puts(cmd)
+
+  output = ''
+
+  IO.popen(cmd) do |com|
+    com.each_char do |c|
+      print c
+      output << c
+      $stdout.flush
+    end
+  end
+
+  output
+end
+
+def run_test_file(file)
+  run %(ruby -I"lib:test" -rubygems #{file})
+end
+
+def run_all_tests
+  run 'rake test'
+end
+
+def related_test_files(path)
+  Dir['test/**/*.rb'].select { |file| file =~ /test_#{File.basename(path)}/ }
+end
+
+watch('test/test_helper\.rb') do
+  system 'clear'
+  run_all_test
+end
+
+watch('test/.*test_.*\.rb') do |m|
+  system 'clear'
+  run_test_file m[0]
+end
+
+watch('lib/.*') do |m|
+  related_test_files(m[0]).each { |file| run_test_file(file) }
+end
+
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }