congo 0.1.1

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+tmp/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rodrigo Alvarez
+
+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,17 @@
+= congo
+
+Description goes here.
+
+== 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) 2009 Rodrigo Alvarez. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "congo"
+    gem.summary = %Q{Library to define flexible schemas for mongodb documents. }
+    gem.email = ["papipo@gmail.com", "didier@nocoffee.fr"]
+    gem.homepage = "http://github.com/Papipo/congo"
+    gem.authors = ["Rodrigo Alvarez", "Didier Lafforgue"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "mongo_mapper", ">= 0.7.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+Spec::Rake::SpecTask.new('spec:unit') do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/unit/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new('spec:functionals') do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/functional/**/*_spec.rb']
+end
+
+task :spec => [:check_dependencies, 'spec:unit', 'spec:functionals']
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "congo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/config/locales/en.yml

@@ -0,0 +1,18 @@
+en: 
+  congo:
+    date:
+      formats:
+        default: "%m/%d/%Y"
+        
+    errors:
+      messages:
+        invalid_keys: "are not valid"
+        invalid: "is invalid"
+        empty: "can't be empty"
+        taken: "has already been taken"
+        exclusion: "is reserved"
+        inclusion: "is not included in the list"
+        confirmation: "doesn't match confirmation"
+        accepted: "must be accepted"
+        wrong_length: "is the wrong length"
+        not_a_number: "is not a number"        

data/config/locales/fr.yml

@@ -0,0 +1,18 @@
+fr:
+  congo:
+    date:
+      formats:
+        default: "%d/%m/%Y"
+    
+    errors:
+      messages:
+        invalid_keys: "ne sont pas valides"
+        invalid: "n'est pas valide"
+        empty: "doit être rempli(e)"
+        taken: "n'est pas disponible"
+        exclusion: "n'est pas disponible"
+        inclusion: "n'est pas inclus(e) dans la liste"
+        confirmation: "ne concorde pas avec la confirmation"
+        accepted: "doit être accepté(e)"
+        wrong_length: "ne fait pas la bonne longueur"
+        not_a_number: "n'est pas un nombre"

data/init.rb

@@ -0,0 +1,2 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+require 'congo'

data/lib/congo.rb

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'congo/support'
+require 'congo/migration'
+require 'congo/validation'
+require 'congo/list'
+require 'congo/grip/attachment'
+require 'congo/grip/has_attachment'
+require 'congo/metadata/key'
+require 'congo/metadata/association'
+require 'congo/metadata/validation'
+require 'congo/content_type'
+require 'congo/types'
+require 'congo/scoper'
+require 'congo/proxy_scoper'
+

data/lib/congo/content_type.rb

@@ -0,0 +1,107 @@
+module Congo
+  class ContentType
+    include MongoMapper::Document
+    include Validation
+    include Migration
+  
+    ## keys
+    key :embedded, Boolean, :default => false
+    key :name, String
+    key :collection_name, String
+    key :slug, String
+    key :description, String
+    key :scope_type, String
+    key :scope_id, ObjectId
+    
+    ## associations
+    belongs_to :scope, :polymorphic => true
+    many :metadata_keys, :class_name => 'Congo::Metadata::Key', :dependent => :destroy
+    many :metadata_validations, :class_name => 'Congo::Metadata::Validation', :dependent => :destroy
+    many :metadata_associations, :class_name => 'Congo::Metadata::Association', :dependent => :destroy
+    
+    ## callbacks
+    before_validation :make_names_clean
+    before_destroy :destroy_contents
+    
+    # TODO: add callback to check if validations are still valid (for instance, a dropped key should not still have its validations)
+  
+    ## methods 
+    
+    def to_const
+      klass = Class.new
+      if self.embedded?
+        klass.send(:include, MongoMapper::EmbeddedDocument)
+      else
+        klass.send(:include, MongoMapper::Document)
+        klass.timestamps!
+        set_collection_name(klass)
+        apply_scope(klass)
+      end
+      
+      klass.class_eval <<-EOV
+        def content_type
+          @content_type ||= self.class.content_type
+        end
+        
+        def self.content_type
+          Congo::ContentType.find('#{self._id}')
+        end
+      EOV
+      
+      apply_metadata(klass)
+      apply_migration(klass)
+      klass
+    end
+  
+    private
+            
+    def set_collection_name(klass)
+      klass.set_collection_name self.send(:mongodb_collection_name)
+    end
+    
+    def mongodb_collection_name
+      "#{scope_type}_#{scope_id}_#{name.tableize}" # maybe just name.tableize is enough
+    end
+  
+    def apply_scope(klass)
+      foreign_key = scope_type.underscore.gsub('/', '_').foreign_key
+      association_name = scope_type.demodulize.underscore
+      
+      klass.key foreign_key, ObjectId
+      klass.belongs_to association_name, :class_name => scope_type, :foreign_key => foreign_key
+      klass.validates_presence_of association_name
+    end
+          
+    def apply_metadata(klass)
+      %w[metadata_keys metadata_associations metadata_validations].each do |association|
+        self.send(association).each { |meta| meta.apply(klass, scope) }
+      end
+    end
+    
+    def destroy_contents
+      MongoMapper.database.collection(self.send(:mongodb_collection_name)).drop
+    end
+    
+    def make_names_clean
+      if self.collection_name
+        self.collection_name = self.collection_name.gsub(/[\s\W]+/, ' ').strip
+        self.name = self.collection_name if self.name.blank?
+      end
+      
+      self.name = self.name.strip.classify.gsub(/\s+/, '_').camelize if self.name
+      self.slug = slugify_name(self.collection_name) if self.collection_name
+    end
+        
+    def slugify_name(name)
+      # replace accented chars with ther ascii equivalents
+      s = ActiveSupport::Inflector.transliterate(name).to_s
+      # Remove leading or trailing space
+      s.strip!
+      # Remove leading or trailing slash
+      s.gsub! /(^[\/]+)|([\/]+$)/, ''
+      # Turn unwanted chars into the seperator
+      s.gsub!(/[^a-zA-Z0-9\-_\+\/]+/i, '_')
+      s.downcase
+    end
+  end
+end

data/lib/congo/grip/attachment.rb

@@ -0,0 +1,22 @@
+module Congo
+  module Grip
+    class Attachment
+   
+      attr_reader :name, :path, :content_type, :size, :body
+   
+      def initialize(attrs = {})
+        @name = attrs[:name]
+        @path = attrs[:path]
+        @content_type = attrs[:content_type]
+        @size = attrs[:size]
+        @body = attrs[:body]
+      end
+      
+      def to_s
+        self.body
+      end
+            
+    end
+  end
+end
+    

data/lib/congo/grip/has_attachment.rb

@@ -0,0 +1,99 @@
+# Got from http://github.com/jnunemaker/grip/blob/master/lib/grip.rb
+# Wait for jnunemaker to include it in the next release of Mongomapper
+# Note:
+#   we patched it to reflect the collection name within the path of the file.
+
+require 'mongo/gridfs'
+require 'mime/types'
+require 'tempfile'
+
+# if thumbnailable?
+#   tmp = Tempfile.new("thumb_#{filename}")
+#   MojoMagick::resize(uploaded_file.path, tmp.path, {:width => 50, :height => 40, :scale => '>'})
+#   self.thumbnail = tmp.read      
+# end
+
+# open    : db, name, mode, options (:root, :metadata, :content_type)
+# read    : db, name, length, offset
+# unlink  : db, names
+# list    : db, root collection
+#
+# GridStore.open(database, 'filename', 'w') { |f|
+#   f.puts "Hello, world!"
+# }
+
+module Congo
+  module Grip
+    module HasAttachment
+      def self.included(base)
+        base.extend Congo::Grip::HasAttachment::ClassMethods
+      end
+  
+      module ClassMethods
+        def has_grid_attachment(name, options = {})
+          configuration = { :path => ":class/:name/:id" }
+          configuration.update(options) if options.is_a?(Hash)
+        
+          write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
+          attachment_definitions[name] = {}
+      
+          after_save :save_attachments
+          before_destroy :destroy_attached_files
+      
+          key "#{name}_size".to_sym, Integer
+          key "#{name}_path".to_sym, String
+          key "#{name}_name".to_sym, String
+          key "#{name}_content_type".to_sym, String
+      
+          define_method(name) do
+            return nil unless self.send("#{name}?".to_sym)
+            
+            Congo::Grip::Attachment.new({
+              :name => self["#{name}_name"],
+              :path => self["#{name}_path"],
+              :size => self["#{name}_size"],
+              :content_type => self["#{name}_content_type"],
+              :body => GridFS::GridStore.read(self.class.database, self["#{name}_path"])
+            })
+          end
+      
+          define_method("#{name}=") do |file|
+            return if file.nil?
+            self['_id']                  = Mongo::ObjectID.new if _id.blank?
+            self["#{name}_size"]         = file.size rescue File.size(file)
+            self["#{name}_name"]         = file.original_filename rescue File.basename(file.path)          
+            self["#{name}_path"]         = configuration[:path].gsub(':class', self.class.to_s.underscore).gsub(':name', self.content_type.name.underscore).gsub(':id', _id.to_s)
+            self["#{name}_content_type"] = file.content_type rescue MIME::Types.type_for(self["#{name}_name"]).to_s
+            self.class.attachment_definitions[name] = file
+          end
+        
+          define_method("#{name}?") do
+            !self["#{name}_name"].nil?
+          end
+        end
+    
+        def attachment_definitions
+          read_inheritable_attribute(:attachment_definitions)
+        end
+      end
+  
+      def save_attachments
+        self.class.attachment_definitions.each do |attachment|
+          name, file = attachment
+      
+          if (file.is_a?(File) || file.is_a?(Tempfile))
+            GridFS::GridStore.open(self.class.database, self["#{name}_path"], 'w', :content_type => self["#{name}_content_type"]) do |f|
+              f.write(file.read)
+            end
+          end
+        end
+      end
+  
+      def destroy_attached_files
+        self.class.attachment_definitions.each do |name, attachment|
+          GridFS::GridStore.unlink(self.class.database, self["#{name}_path"])
+        end
+      end
+    end
+  end
+end

data/lib/congo/list.rb

@@ -0,0 +1,64 @@
+module Congo
+  module List
+    
+    def self.included(model)
+      model.class_eval do
+        include InstanceMethods
+        
+        def to_const_with_list
+          klass = to_const_without_list
+          apply_list(klass)
+          klass
+        end
+        
+        alias_method_chain :to_const, :list
+      end
+    end
+    
+    module InstanceMethods
+            
+      private
+      
+      def apply_list(klass)
+        klass.key :_position, Integer, :default => 0
+        
+        klass.class_eval do
+        
+          include Congo::List::ContentInstanceMethods
+        
+          before_destroy :remove_from_list
+          before_create  :add_to_list_bottom
+          
+          def self.reorder_all(ids)
+            return false if ids.nil? or ids.empty?
+            updates = {}
+            ids.each_with_index do |id, index|
+              updates[id] = { :_position => index + 1 }
+            end
+            self.update(updates)
+          end
+        end
+      end
+
+    end
+    
+    module ContentInstanceMethods
+      
+      private
+      
+      def add_to_list_bottom
+        self._position = self.class.count + 1
+      end
+      
+      def remove_from_list
+        updates = {}        
+        self.class.all(:conditions => { :_position.gt => self._position.to_i }).each do |item|
+          updates[item._id] = { :_position => item._position - 1 }
+        end
+        self.class.update(updates) unless updates.empty?
+      end
+      
+    end
+    
+  end
+end