adhearsion-mongoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3db3ebf88de59a56fdcf83eb4c6b828a31ed5e1
+  data.tar.gz: eb6c0230daf0ac660fc1e93b12924a7751efad09
+SHA512:
+  metadata.gz: 1212fb8a888e50f87207bb5f32f8f1d9ce6ed8e141d1cc53f77956184e98920709fe87619fb6da22e31b92748db83c6edcc96f46249f06e4ec71ebebf6630824
+  data.tar.gz: 2e29c974e4a4f57bfcffdf08a50777e30ce77b228928f84b0b164df22891d124e24d5d03f767c6d8a2ea3c60c9104d5f11f871353919c27531348abd1e10a657

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in adhearsion-mongoid.gemspec
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+adhearsion-mongoid
+==================
+
+adhearsion-mongoid is an [Adhearsion](https://github.com/adhearsion/adhearsion) Plugin providing [Mongoid](https://github.com/mongoid/mongoid) compatibility.
+
+Features
+--------
+
+* Append compatibility with Mongoid 3.0+
+
+Requirements
+------------
+
+* Adhearsion 2.0+
+
+Testing environment
+-------------------
+
+Plugin has been tested with Adhearsion 2.4, Ruby 2.0 and Mongoid 4.0 (development).
+
+Install
+-------
+
+Add `adhearsion-mongoid` to your Adhearsion app's Gemfile.
+
+Plugin configuration (optional)
+-------------------------------
+
+In your Adhearsion app configuration file, add the following values:
+
+```ruby
+Adhearsion.config[:adhearsion_mongoid] do |config|
+  config.models_paths = "lib/models"
+  config.config_path = "config/mongoid.yml"
+end
+```
+
+Mongoid configuration
+---------------------
+
+By default, simply use "config/mongoid.yml" configuration file.
+
+Usage
+-----
+
+Simply place your models in in your model directory ("lib/models" by default) and thats all.
+
+
+Author
+------
+
+Original author: [Florent Morin](https://github.com/florentmorin)
+(adapted from [Juan de Bravo](https://github.com/juandebravo) work)
+Special Thanks
+--------------
+
+Thanks to [Juan de Bravo](https://github.com/juandebravo) for the [adhearsion-activerecord](https://github.com/adhearsion/adhearsion-activerecord) plugin
+My plugin was simply adapted from it.
+
+Links
+-----
+* [Source](https://github.com/morin-innovation/adhearsion-mongoid)
+* [Documentation](http://rdoc.info/github/morin-innovation/adhearsion-mongoid/master/frames)
+* [Bug Tracker](https://github.com/morin-innovation/adhearsion-mongoid/issues)
+
+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 so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Check [License file](https://github.com/morin-innovation/adhearsion-mongoid/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "bundler/setup"
+
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--colour --format doc'
+end
+
+task :default => :spec

data/lib/adhearsion-mongoid.rb

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

data/lib/adhearsion/mongoid.rb

@@ -0,0 +1,12 @@
+require "adhearsion"
+require 'mongoid'
+
+require "active_support/dependencies/autoload"
+
+require "adhearsion/mongoid/version"
+require "adhearsion/mongoid/plugin"
+
+module Adhearsion
+  module Mongoid
+  end
+end

data/lib/adhearsion/mongoid/plugin.rb

@@ -0,0 +1,26 @@
+module Adhearsion
+  module Mongoid
+
+    ##
+    # Adhearsion Plugin that defines the Mongoid configuration options
+    # and includes a hook to start the Mongoid service in Adhearsion initialization process
+    class Plugin < Adhearsion::Plugin
+      extend ActiveSupport::Autoload
+
+      autoload :Service, 'adhearsion/mongoid/plugin/service'
+
+      # Configure models path ('lib/models' by default) and Mongoid configuration path ('config/mongoid.yml' by default)
+      config :adhearsion_mongoid do
+        models_paths ['lib/models'],        :desc => 'paths to directories containing models files to load'
+        config_path 'config/mongoid.yml',   :desc => 'path to Mongoid configuration file'
+      end
+
+      # Include the Mongoid service in plugins initialization process
+      init :adhearsion_mongoid do
+        Service.start
+      end
+
+    end
+
+  end
+end

data/lib/adhearsion/mongoid/plugin/service.rb

@@ -0,0 +1,65 @@
+module Adhearsion
+  module Mongoid
+    class Plugin
+      class Service
+        class << self
+
+          ##
+          # Load the mongoid preferences, models and initiate logger
+          def start
+            logger.info "Loading Mongoid preferences"
+            
+            params = config.to_hash.select { |k,v| !v.nil? }
+            
+            ::Mongoid.load!(*params.delete(:config_path), ENV['AHN_ENV'])
+            
+            logger.info "Loading Mongoid models"
+            require_models(*params.delete(:models_paths))
+
+            logger.info "Loading Mongoid logger"
+            ::Mongoid.logger = logger
+            ::Moped.logger = logger
+            
+            logger.info "Mongoid successfully configured"
+          end
+          
+          ##
+          # stop service (unused)
+          def stop
+          end
+
+          private
+
+          ##
+          # models are '.rb' file in models directory
+          def require_models(*paths)
+            paths.each do |path|
+              Dir.foreach(path) do |filename|
+                pn = Pathname.new path
+                
+                if pn.relative?
+                  root_path = Adhearsion.config.root
+                  root_path ||= Dir.pwd
+                  full_path = File.join root_path, path, filename                  
+                else
+                  full_path = File.join path, filename
+                end
+                
+                if File.file? full_path and File.extname(full_path) == ".rb"
+                  require full_path
+                end
+              end
+            end
+          end
+
+          ##
+          # Access to mongoid plugin configuration
+          def config
+            @config ||= Plugin.config
+          end
+
+        end # class << self
+      end # Service
+    end # Plugin
+  end # Mongoid
+end # Adhearsion

data/lib/adhearsion/mongoid/version.rb

@@ -0,0 +1,5 @@
+module Adhearsion
+  module Mongoid
+    VERSION = "0.1.0"
+  end
+end

data/spec/adhearsion/mongoid/plugin/service_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+ENV['AHN_ENV'] = 'test'
+
+describe Adhearsion::Mongoid::Plugin::Service do
+
+  describe "when starting the Mongoid connection" do
+
+    def tmp_models_dir_path
+      path = File.join Dir.tmpdir, "models"
+      
+      unless File.directory? path
+        FileUtils.mkdir path
+      end
+      
+      path
+    end
+
+    def create_tempmodel_with_contents(contents)
+      path = File.join tmp_models_dir_path, "user.rb"
+      file = File.new(path, "w+")
+      file.puts contents
+      file.flush
+      path
+    end
+
+    def sample_user_model
+      <<-CODE
+        class User
+          include Mongoid::Document
+          
+          field :name, type: String
+        end
+      CODE
+    end
+
+    it "should make any required models available" do
+      path = create_tempmodel_with_contents sample_user_model
+
+      Adhearsion.config.adhearsion_mongoid.models_paths = [tmp_models_dir_path]
+      Adhearsion::Mongoid::Plugin::Service.start
+      
+      u = User.new
+      u.should respond_to :name
+      
+      File.delete path
+      
+      Dir.delete tmp_models_dir_path
+    end
+
+  end
+
+end

data/spec/adhearsion/mongoid/plugin_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Adhearsion::Mongoid::Plugin do
+
+  describe "while accessing the plugin configuration" do
+
+    it "should retrieve a valid configuration instance" do
+      Adhearsion.config.adhearsion_mongoid.should be_instance_of Loquacious::Configuration
+    end
+
+    it "should configure properly the models_paths" do
+      Adhearsion.config[:adhearsion_mongoid].models_paths.class.should == Array
+    end
+
+  end
+
+  describe "while loading plugins" do
+    it "should load the init block and start the service" do
+      Adhearsion::Mongoid::Plugin::Service.should_receive(:start).once.and_return true
+      Adhearsion::Plugin.init_plugins
+    end
+  end
+end

data/spec/adhearsion/mongoid_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Adhearsion::Mongoid do
+
+  subject { Adhearsion::Mongoid }
+
+  it "should be a module" do
+    subject.should be_kind_of Module
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'adhearsion'
+require 'adhearsion/mongoid'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.tty = true
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: adhearsion-mongoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florent Morin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: adhearsion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides an Adhearsion plugin to handle the Mongoid and database
+  integration
+email:
+- florent.morin@morin-innovation.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/adhearsion/mongoid/plugin/service.rb
+- lib/adhearsion/mongoid/plugin.rb
+- lib/adhearsion/mongoid/version.rb
+- lib/adhearsion/mongoid.rb
+- lib/adhearsion-mongoid.rb
+- README.md
+- Rakefile
+- Gemfile
+- spec/adhearsion/mongoid/plugin/service_spec.rb
+- spec/adhearsion/mongoid/plugin_spec.rb
+- spec/adhearsion/mongoid_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/morin-innovation
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: adhearsion-mongoid
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: This gem provides an Adhearsion plugin to handle the Mongoid and database
+  integration
+test_files:
+- spec/adhearsion/mongoid/plugin/service_spec.rb
+- spec/adhearsion/mongoid/plugin_spec.rb
+- spec/adhearsion/mongoid_spec.rb
+- spec/spec_helper.rb