mongoid-kraken 0.0.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andrew Bennett
+
+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 @@
+= mongoid-kraken
+
+Description goes here.
+
+== Contributing to mongoid-kraken
+ 
+* 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) 2011 Andrew Bennett. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rspec"
+require "rspec/core/rake_task"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "mongoid/kraken/version"
+
+task :gem => :build
+desc "Build the mongoid-kraken.gem file"
+task :build do
+  system "gem build mongoid-kraken.gemspec"
+end
+
+desc "Install the mongoid-kraken.gem file"
+task :install => :build do
+  system "sudo gem install mongoid-kraken-#{Mongoid::Kraken::VERSION}.gem"
+end
+
+desc "Tag a release and push the mongoid-kraken.gem file"
+task :release => :build do
+  system "git tag -a #{Mongoid::Kraken::VERSION} -m 'Tagging #{Mongoid::Kraken::VERSION}'"
+  system "git push --tags"
+  system "gem push mongoid-#{Mongoid::VERSION}.gem"
+end
+
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rspec::Core::RakeTask.new("spec:unit") do |spec|
+  spec.pattern = "spec/unit/**/*_spec.rb"
+end
+
+Rspec::Core::RakeTask.new("spec:functional") do |spec|
+  spec.pattern = "spec/functional/**/*_spec.rb"
+end
+
+Rspec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/mongoid-kraken.rb

@@ -0,0 +1 @@
+require 'mongoid/kraken'

data/lib/mongoid/kraken.rb

@@ -0,0 +1,100 @@
+require 'mongoid/kraken/kraken'
+require 'mongoid/kraken/sucker'
+require 'mongoid/kraken/tentacle'
+
+require 'mongoid/kraken/autoload'
+
+module Mongoid
+  module Kraken
+    extend ActiveSupport::Concern
+
+    included do
+      referenced_in :kraken, :class_name => 'Mongoid::Kraken::Kraken'
+      after_initialize :summon_the_kraken!
+    end
+
+    module ClassMethods
+      def instantiate(attrs = nil)
+        super(attrs).instance_eval { summon_the_kraken! }
+      end
+
+      def kraken_class
+        Mongoid::Kraken::Kraken
+      end
+
+      def kraken_tentacle_class
+        Mongoid::Kraken::Tentacle
+      end
+
+      def kraken_sucker_class
+        Mongoid::Kraken::Sucker
+      end
+    end
+
+    module InstanceMethods
+      def kraken_fields
+        self.class_eval { self.fields }
+      end
+
+    protected
+      def summon_the_kraken!
+        unless self.kraken.nil?
+          self.kraken.all_tentacles.flatten.each do |tentacle|
+            case tentacle.sucker.relation
+            when :field then
+              self.class_eval(&kraken_field(self, tentacle))
+            when :referenced_in then
+              self.class_eval(&kraken_referenced_in(self, tentacle))
+            when :references_many then
+              self.class_eval(&kraken_references_many(self, tentacle))
+            when :references_and_referenced_in_many then
+              self.class_eval(&kraken_references_and_referenced_in_many(self, tentacle))
+            end
+          end
+        end
+        return self
+      end
+
+    private
+      def kraken_field(klass, tentacle)
+        tentacle_name = tentacle.name.to_s
+        lambda do |base|
+          field(
+            tentacle_name,
+            tentacle.sucker.settings.reverse_merge(:type => tentacle.sucker.type)
+          )
+        end
+      end
+
+      def kraken_referenced_in(klass, tentacle)
+        tentacle_name = tentacle.name.to_s
+        lambda do |base|
+          referenced_in(
+            tentacle_name,
+            tentacle.sucker.settings.reverse_merge(:class_name => klass.class.name)
+          )
+        end
+      end
+
+      def kraken_references_many(klass, tentacle)
+        tentacle_name = tentacle.name.to_s
+        lambda do |base|
+          references_many(
+            tentacle_name,
+            tentacle.sucker.settings.reverse_merge(:class_name => klass.class.name)
+          )
+        end
+      end
+
+      def kraken_references_and_referenced_in_many(klass, tentacle)
+        tentacle_name = tentacle.name.to_s
+        lambda do |base|
+          references_and_referenced_in_many(
+            tentacle_name,
+            tentacle.sucker.settings.reverse_merge(:class_name => klass.class.name)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/kraken/autoload.rb

@@ -0,0 +1,47 @@
+require 'mongoid/field'
+
+module Mongoid
+  module Kraken
+    module Autoload
+      extend ActiveSupport::Concern
+
+      included do |base|
+        field(:kraken_id, {
+          :type => BSON::ObjectId,
+          :default => kraken_autoload_default(:name => "#{base.name}")
+        })
+      end
+
+      module ClassMethods
+        attr_accessor :kraken_autoload_key
+
+        def inherited(subclass)
+          super
+          subclass_fields = fields.dup
+          kraken_id_field = subclass_fields.delete(kraken_autoload_key)
+          subclass_fields[kraken_autoload_key] = Mongoid::Field.new(
+              kraken_autoload_key,
+              :default => kraken_autoload_default(:name => "#{subclass.name}")
+            )
+          subclass.fields = subclass_fields
+        end
+
+        def kraken_autoload_config(*args)
+          fields[kraken_autoload_key].instance_variable_set('@default', kraken_autoload_default(*args))
+        end
+
+        def kraken_autoload_key
+          @kraken_autoload_key ||= 'kraken_id'
+        end
+
+      protected
+        def kraken_autoload_default(*args)
+          lambda {
+            k = Mongoid::Kraken::Kraken.where(*args).first
+            k.id unless k.nil?
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/kraken/kraken.rb

@@ -0,0 +1,26 @@
+# AttributeGroup = Kraken
+module Mongoid
+  module Kraken
+    class Kraken
+      include Mongoid::Document
+      field :name, :type => String
+      referenced_in   :parent,   :inverse_of => :children, :class_name => 'Mongoid::Kraken::Kraken'
+      references_many :children, :inverse_of => :parent,   :class_name => 'Mongoid::Kraken::Kraken'
+      references_and_referenced_in_many :tentacles, :class_name => 'Mongoid::Kraken::Tentacle'
+
+      def all_tentacles
+        if parent.nil?
+          return self.tentacles
+        else
+          out = []
+          out << self.parent.all_tentacles
+          out << self.tentacles
+          out
+        end
+      end
+
+      validates_presence_of :name
+      validates_uniqueness_of :name
+    end
+  end
+end

data/lib/mongoid/kraken/sucker.rb

@@ -0,0 +1,45 @@
+module Mongoid
+  module Kraken
+    class Sucker
+      include Mongoid::Document
+
+      field :relation, :class => Symbol, :default => :field
+      field :type,     :class => String, :default => 'String'
+      field :settings, :class => Hash,   :default => Hash.new
+
+      embedded_in :tentacle, :class_name => 'Mongoid::Kraken::Tentacle'
+
+      after_initialize :sucker_type_casting
+
+      def self.instantiate(attrs = nil)
+        super(attrs).instance_eval { sucker_type_casting }
+      end
+
+      validates_presence_of  :relation
+      validates_inclusion_of :relation, :in => [
+          :field,
+          :referenced_in,
+          :references_many,
+          :references_and_referenced_in_many
+        ]
+      validates_presence_of :type
+      validates_each :settings do |record, attr, value|
+        record.errors.add attr, 'must be a Hash' unless value.is_a?(Hash)
+      end
+
+    protected
+      def sucker_type_casting
+        self.fields['type'].define_singleton_method(:get) { |value| value.to_s.constantize unless value.nil? }
+        self.fields['type'].define_singleton_method(:set) { |value| value.to_s unless value.nil? }
+
+        self.fields['settings'].define_singleton_method(:get) do |value|
+          value ||= {}
+          value.symbolize_keys! if value.respond_to?(:symbolize_keys!)
+          value
+        end
+
+        return self
+      end
+    end
+  end
+end

data/lib/mongoid/kraken/tentacle.rb

@@ -0,0 +1,57 @@
+# Attribute = Tentacle
+module Mongoid
+  module Kraken
+    class Tentacle
+      include Mongoid::Document
+
+      field :name,  :type => String
+      field :label, :type => String
+
+      embeds_one :sucker, :class_name => 'Mongoid::Kraken::Sucker'
+
+      #references_many :krakens, :class_name => 'Mongoid::Kraken::Kraken' do
+      #  def self.extended(proxy)
+      #    proxy.target.selector = { "tentacle_ids" => proxy.base['_id'] }
+      #  end
+      #end
+
+      before_create    :sucker_default
+      after_initialize :sucker_default
+
+      %w(relation type settings).each do |key|
+        define_method("sucker_#{key}") do |*args|
+          sucker_default.send(key, *args)
+        end
+
+        define_method("sucker_#{key}=") do |*args|
+          sucker_default.send("#{key}=", *args)
+        end
+      end
+
+      validates_presence_of :name
+      validates_associated :sucker
+      # Each Tentacle has a unique name and Sucker
+      validates_each :name do |document, attribute, value|
+        criteria = document.class.where({
+            'sucker.relation' => document.sucker.relation,
+            'sucker.type'     => document.sucker.type.to_s,
+            'sucker.settings' => document.sucker.settings
+          })
+        criteria = criteria.where(attribute => Regexp.new("^#{Regexp.escape(value.to_s)}$", Regexp::IGNORECASE))
+        if criteria.exists?
+          document.errors.add(
+            attribute,
+            :taken,
+            :value => value, :message => "and sucker are already taken"
+          )
+        end
+      end
+
+    private
+      def sucker_default
+        self.sucker ||= Mongoid::Kraken::Sucker.new
+        return self.sucker
+      end
+    end
+  end
+end

data/lib/mongoid/kraken/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Mongoid #:nodoc
+  module Kraken #:nodoc
+    VERSION = "0.0.0"
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid-kraken
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Andrew Bennett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.rc.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.5"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "4.4"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.5
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Kraken is an implementation of the EAV (Entity-Attribute-Value) model using mongoid
+email: 
+- potatosaladx@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mongoid-kraken.rb
+- lib/mongoid/kraken.rb
+- lib/mongoid/kraken/tentacle.rb
+- lib/mongoid/kraken/kraken.rb
+- lib/mongoid/kraken/sucker.rb
+- lib/mongoid/kraken/version.rb
+- lib/mongoid/kraken/autoload.rb
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/potatosalad/mongoid-kraken
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2309052378569038485
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Kraken is EAV done right
+test_files: []
+