smart_model 0.3.2 → 0.3.3

data/MIT-LICENSE

@@ -1,5 +1,4 @@
 Copyright (c) 2010 Nathan Proença
-
 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
@@ -18,4 +17,3 @@ 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

@@ -1,10 +1,11 @@
 = SmartModel
+
 == What is
-SmartModel is a rails 3 library made to improve the way you use MongoMapper. It gives you aliases, and even a model generator for mongoDB models.
+SmartModel is a rails 3 library(plugin and gem) made to improve the way you use MongoMapper. It gives you aliases, and even a model generator for mongoDB models.
 
 == Setup
 === As plugin
-To setup SmartMongo as a plugin , you need mongo_mapper(that needs bson_ext) , so add this to your Gemfile
+To setup SmartModel as a plugin , you need mongo_mapper(that needs bson_ext) , so add this to your Gemfile
     gem 'mongo_mapper'
     gem 'bson_ext'
 And then run
@@ -16,11 +17,14 @@ To your Gemfile and run
     [sudo] bundle install
 And everything is OK!
 
-== Generator
-SmartModel gives you a model generator:
+== Generators
+SmartMongo gives you 2 generators:
+=== smart_model
+    rails g smart_model
+that creates a initializer that defines the MongoMapper database
 === smart_model
     rails g smart_model project name:string content:string created_at:date in_progress:done
-That creates a model Project inherited from SmartMongo::Base
+That creates a model Project inherited from SmartModel::Base
 
 == SmartModel::Base
 Is a class with all the MongoMapper::Document methods, that even gives you aliases for setting your database up
@@ -36,24 +40,17 @@ Or if you have many columns with the same behaviour , you can just manage them j
         strings [:title , : content] , :required => true # Create :title and :content columns
     end
 The given methods are
-    string(s) , integer(s) , boolean(s) , array(s) , objectid(s) , date(s) , time(s)
-=== Relationships
-With SmartModel::Base you can just do this :
-    class Task
-        include SmartModel::Base
-        strings [ :name , :description ]
-        boolean :done
-        belongs_to :project
-    end
-That SmartModel already creates the db column and stablish the relationship.
+    string(s) , integer(s) , boolean(s) , array(s) , objectid(s) , date(s)
 
 == TO-DO
-create a scaffold generator ;
-make the tests *test something*
+create a scaffold generator
 
 == Why have I done it?
 I was on vacation , so , I decided to code something usefull , and this was my first idea
 
+== Contributors
+Nathan Proença (nathan@vieiraproenca@gmail.com) and Rodrigo Alves Vieira (rodrigo3n@gmail.com)
+
 == License
 Read under the amazing MIT license
 

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the smart_model Gem and Plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the smart_model Gem and Plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SmartModel'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/generators/smart_mongo/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Setup MongoMapper db
+
+Example:
+    rails generate smart_mongo
+
+    This will create:
+        config/initializers/setup_mongo_db.rb # setup mongo db
+

data/lib/generators/smart_mongo/smart_mongo_generator.rb

@@ -0,0 +1,8 @@
+class SmartMongoGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :db_name , :type => :string , :default => "#{RAILS_ROOT.to_s.split('/').last}-#{Rails.env}"
+  def setup
+    template "initializer.rb" , "config/initializers/setup_mongo_db.rb"
+  end
+end
+

data/lib/generators/smart_mongo/templates/initializer.rb

@@ -0,0 +1,2 @@
+MongoMapper.database = "<%= db_name %>"
+

data/rails/init.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "..", "lib", "smart_model.rb")
-require File.join(File.dirname(__FILE__), "..", "lib", "smart_model" , "relationships")
 require File.join(File.dirname(__FILE__), "..", "lib", "smart_model" , "attributes")
+require File.join(File.dirname(__FILE__), "..", "lib", "smart_model" , "relationships")
+require File.join(File.dirname(__FILE__), "..", "lib", "smart_model.rb")
 

data/test/smart_model_test.rb

@@ -1,9 +1,11 @@
-require 'test_helper'
+require File.dirname(__FILE__) + '/test_helper'
 
 class SmartModelTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
+	 
+  test "SmartModel model proper inclusion" do
+  	class TestSmartModelLoading
+  		include SmartModel::Base
+   	end
   end
-end
 
+end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
 require 'rubygems'
 require 'test/unit'
 require 'active_support'
+require '../lib/smart_model.rb'
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smart_model
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - "Nathan Proen\xC3\xA7a"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-27 00:00:00 -03:00
+date: 2010-07-10 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,7 @@ dependencies:
         version: 1.0.1
   type: :runtime
   version_requirements: *id003
-description: Gives you support to use MongoDB and MongoMapper
+description: Gives you support to use MongoDB and MongoMapper in Rails apps
 email: nathan@vieiraproenca.com
 executables: []
 
@@ -80,6 +80,9 @@ files:
 - lib/generators/smart_model/templates/test.rb
 - lib/generators/smart_model/USAGE
 - lib/generators/smart_model/smart_model_generator.rb
+- lib/generators/smart_mongo/templates/initializer.rb
+- lib/generators/smart_mongo/USAGE
+- lib/generators/smart_mongo/smart_mongo_generator.rb
 - lib/smart_model.rb
 - lib/smart_model/attributes.rb
 - lib/smart_model/relationships.rb
@@ -87,9 +90,10 @@ files:
 - test/test_helper.rb
 - rails/init.rb
 - MIT-LICENSE
+- Rakefile
 - README.rdoc
 has_rdoc: true
-homepage: http://github.com/nathanpro/smartmodel
+homepage: http://github.com/nathanpro/SmartModel
 licenses: []
 
 post_install_message: 
@@ -121,6 +125,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Use all the power of MongoDB
+summary: Jump all the power of MongoDB and MongoMappers into your Rails application
 test_files: []