mongomatic-rails3 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jordan West
+
+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,56 @@
+= Rails::Mongomatic
+
+Rails 3 support for Mongomatic (http://www.mongomatic.com). Generators, url_for support, and more. 
+
+== Background
+
+Mongomatic is a minimalist framework. It strives to do just enough atop an already great Mongo driver. Not developed in an ActiveRecord style, the Mongomatic core can be used in Rails 3 but certain helpers are not supported. This library adds support certain Rails 3 features. Although the original developers continue to use the core of Mongomatic only in their work, we have provided this library for people extremely accustomed to parts of the Rails framework who still want to use Mongomatic, for convenience. There is a chance certain parts of this library will be merged into Mongomatic core but there is an equally likely chance they will not. 
+
+== Installation
+
+Add mongomatic-rails3 to your gemfile like this,
+
+  gem 'mongomatic-rails3', :require => 'rails/mongomatic'
+  
+See Config File below.
+
+== Config. File
+
+Mongomatic loads the database connection configuration file config/mongomatic.yml. In the spirit of Mongomatic the configuration file is, in our opinion, simpler than other OMs. This may change in the future depending on feedback. Simply define your configuration using Mongo::Connection. There cannot be any syntax errors and each connection must return an instance of Mongo::DB. 
+
+An example configuration file:
+  development: Mongo::Connection.new.db("test")
+  test: Mongo::Connection.new.db("test")
+  production: Mongo::Connection.new.db("test")
+  
+You can use ERB syntax inside of your file if pieces of connection options are shared between environments. So you can generate your config file instead of starting to type it by hand, mongomatic-rails3 provides a config generator. You will, however, need to make some changes to the connection options.
+
+You can generate the config file by running,
+  rails g mongomatic:config [DB]
+
+Run, 
+  rails g mongomatic:config --help
+for more information.
+
+== Generating Models
+
+Mongomatic fully implements the ActiveModel generator. This means that with mongmatic-rails3 installed running,
+  rails g model [NAME]
+
+will generate a class inheriting from Mongomatic::Base. Mongomatic supports per-class connections. You can specify one when generating your model. See below for more information. You can also run
+
+  rails g model --help
+  
+  Usage:
+    rails generate model NAME [field:type field:type] [options]
+
+  Mongomatic options:
+    -c, [--connection=Mongo::Connection.new.db('test')]  # Connection String
+    -e, [--expectations]                                 # Include Mongomatic::Expectations
+    
+    
+== Other Notes
+
+==== Scaffolds
+
+mongomatic-rails3 adds support for Scaffold generation, however, scaffold support is currently limited. This library does not *yet* support form_for, due to its hash-only data access syntax (you should instead use form_tag), which scaffolds generate in their views (*yet* will most likely mean a special form helper for Mongomatic). You can, however, still use scaffolds as a starting point.  

data/lib/rails/generators/mongomatic/config/config_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators/mongomatic_generator'
+module Mongomatic
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      desc "Create mongomatic configuration file (config/mongomatic.yml)"
+      
+      argument :db, :type => :string, :optional => true
+      
+      def self.source_root
+        @_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+      
+      def default
+        'test'
+      end
+      
+      def create_config_file
+        template 'mongomatic.yml', Rails.root.join('config', 'mongomatic.yml')
+      end
+    end
+  end
+end

data/lib/rails/generators/mongomatic/model/model_generator.rb

@@ -0,0 +1,37 @@
+require 'rails/generators/mongomatic_generator'
+
+module Mongomatic
+  module Generators
+    class ModelGenerator < Base
+      desc "Creates a mongomatic model"
+      class_option :connection, 
+                   :type => :string, 
+                   :default => "", 
+                   :desc => "Connection String",
+                   :banner => "Mongo::Connection.new.db('test')",
+                   :aliases => ['-c']
+                   
+      class_option :expectations, 
+                   :desc => "Include Mongomatic::Expectations",
+                   :default => false, 
+                   :aliases => ['-e'], 
+                   :type => :boolean
+                   
+      check_class_collision
+      
+      def connection
+        options[:connection]
+      end
+      
+      def expectations?
+        options[:expectations] == true
+      end
+      
+      def create_model_file
+        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+      
+      hook_for :test_framework
+    end
+  end
+end

data/lib/rails/generators/mongomatic/model/templates/model.rb

@@ -0,0 +1,8 @@
+class <%= class_name %> < Mongomatic::Base
+  <%- if expectations? -%>
+  include Mongomatic::Expectations::Helper
+  <%- end -%>
+end
+<%- unless connection.blank? -%>
+<%= class_name %>.db = <%= connection %>
+<%- end -%>

data/lib/rails/generators/mongomatic_generator.rb

@@ -0,0 +1,42 @@
+require "rails/generators/named_base"
+require "rails/generators/active_model"
+
+module Mongomatic
+  module Generators
+    class Base < ::Rails::Generators::NamedBase
+      def self.source_root
+        @_source_root ||= File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
+      end
+    end
+    
+    class ActiveModel < ::Rails::Generators::ActiveModel
+      def self.all(klass)
+        "#{klass}.find"
+      end
+      
+      def self.find(klass, params=nil)
+        (params.blank?) ? "#{klass}.find" : "#{klass}.find_one(BSON::ObjectID(#{params}))"
+      end
+      
+      def self.build(klass, params=nil)
+        "#{klass}.new(#{params})"
+      end
+      
+      def save
+        "#{name}.upsert"
+      end
+      
+      def update_attributes(params=nil)
+        "#{name}.merge!(#{params})"
+      end
+      
+      def errors
+        "#{name}.errors"
+      end
+      
+      def destroy
+        "#{name}.remove"
+      end
+    end
+  end
+end

data/lib/rails/mongomatic.rb

@@ -0,0 +1,9 @@
+require 'mongomatic'
+require 'rails/mongomatic/railtie'
+require 'rails/mongomatic/support'
+
+module Mongomatic
+  class Base
+    include Rails::Mongomatic::Support
+  end
+end

data/lib/rails/mongomatic/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails'
+require 'rails/mongomatic'
+
+module Rails
+  module Monogmatic
+    class Railtie < Rails::Railtie
+      config.generators.orm :mongomatic, :migrations => false
+      
+      initializer "setup" do
+        config_file = Rails.root.join("config", "mongomatic.yml")
+        if config_file.file?
+          connection_str = YAML.load(ERB.new(config_file.read).result)[Rails.env]
+          ::Mongomatic.db = eval(connection_str)
+        end
+      end
+    end
+  end
+end

data/lib/rails/mongomatic/support.rb

@@ -0,0 +1,37 @@
+module Rails
+  module Mongomatic
+    module Support
+      def self.included(base)
+        base.extend ClassMethods
+      end
+      
+      def new_record?
+        new?
+      end
+      
+      def persisted?
+        !(new? || removed?)
+      end
+      
+      def to_key
+        (new_record?) ? nil : [to_param]
+      end
+      
+      def to_param
+        self['_id'].to_s
+      end
+      
+      def merge!(hash)
+        return true unless hash
+        merge(hash)
+        update
+      end
+      
+      module ClassMethods
+        def model_name
+          @_model_name ||= ActiveModel::Name.new(self)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: mongomatic-rails3
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jordan West
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongomatic
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :runtime
+  version_requirements: *id001
+description: Mongomatic is a simple Ruby object mapper for Mongo
+email: jordanrw@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/rails/generators/mongomatic/config/config_generator.rb
+- lib/rails/generators/mongomatic/model/model_generator.rb
+- lib/rails/generators/mongomatic/model/templates/model.rb
+- lib/rails/generators/mongomatic_generator.rb
+- lib/rails/mongomatic.rb
+- lib/rails/mongomatic/railtie.rb
+- lib/rails/mongomatic/support.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://mongomatic.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Mongomatic support for rails 3
+test_files: []
+