smart_model 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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,59 @@
+= 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.
+
+== Setup
+=== As plugin
+To setup SmartMongo 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
+    rails plugin install http://github.com/nathanPro/SmartModel.git
+=== As a gem
+Just add
+    gem 'smart_model'
+To your Gemfile and run
+    [sudo] bundle install
+And everything is OK!
+
+== Generator
+SmartModel gives you a model generator:
+=== 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
+
+== SmartModel::Base
+Is a class with all the MongoMapper::Document methods, that even gives you aliases for setting your database up
+=== Managing columns
+To add a title columns to your project model, that keeps a string , you can just type this:
+    class Project
+        include SmartModel::Base # Load SmartModel
+        string :title , :required => true # Create title column ,that accept strings
+    end
+Or if you have many columns with the same behaviour , you can just manage them just like this:
+    class Project
+        include SmartModel::Base
+        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.
+
+== TO-DO
+create a scaffold generator ;
+make the tests *test something*
+
+== Why have I done it?
+I was on vacation , so , I decided to code something usefull , and this was my first idea
+
+== License
+Read under the amazing MIT license
+

data/lib/generators/smart_model/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Create rails files for model generator, using MongoMapper and SmartMongo.
+
+Example:
+    rails generate smart_model Thing
+
+    This will create:
+        app/models/thing.rb
+        test/unit/thing_test.rb
+        test/fixtures/things.yml
+

data/lib/generators/smart_model/smart_model_generator.rb

@@ -0,0 +1,15 @@
+class SmartModelGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :name , :type => :string
+  argument :db_fields, :type => :hash
+  def create_model
+    template "model.rb" , "app/models/#{file_name}.rb"
+    template "test.rb" , "test/unit/#{file_name}_test.rb"
+    copy_file "fixture.yml" , "test/fixtures/#{file_name.pluralize}.yml"
+  end
+  private
+  def file_name
+    name.downcase
+  end
+end
+

data/lib/generators/smart_model/templates/fixture.yml

@@ -0,0 +1,12 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one: {}
+# column: value
+#
+two: {}
+#  column: value
+

data/lib/generators/smart_model/templates/model.rb

@@ -0,0 +1,7 @@
+class <%= file_name.camelcase %>
+  include SmartModel::Base
+  <%- db_fields.each do |key,value| -%>
+  <%= value %> :<%=  key %>
+  <%- end -%>
+end
+

data/lib/generators/smart_model/templates/test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class <%= file_name.capitalize %>Test < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end
+

data/lib/smart_model.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'mongo_mapper'
+
+module SmartModel
+  module Base
+    def self.included(model)
+      # include MongoMapper::Document
+      model.send :include, MongoMapper::Document
+      # create database columns methods
+      %w(String Integer Boolean Array ObjectId Date Time).each do |name|
+        model.class_eval "
+        private
+        def self.#{name.downcase}(value , options = {})
+          key value , #{name}, options
+        end
+
+        def self.#{name.downcase.pluralize}(values , options = {})
+          values.each do |val|
+            key val , #{name} , options
+          end
+        end
+        "
+      end
+      # create column in the db with relationship belongs_to
+      model.class_eval "
+      def self.belongs_to(value)
+        key \"\#{value}_id\".to_sym , ObjectId
+        super value
+      end"
+    end
+  end
+end
+

data/rails/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), "..", "lib", "smart_model")
+

data/test/smart_model_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class SmartModelTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: smart_model
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Nathan Proen\xC3\xA7a"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-27 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: -462942284
+        segments: 
+        - 3
+        - 0
+        - 0beta4
+        version: 3.0.0beta4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id003
+description: Gives you support to use MongoDB and MongoMapper
+email: nathan@vieiraproenca.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/smart_model/templates/model.rb
+- lib/generators/smart_model/templates/fixture.yml
+- lib/generators/smart_model/templates/test.rb
+- lib/generators/smart_model/USAGE
+- lib/generators/smart_model/smart_model_generator.rb
+- lib/smart_model.rb
+- test/smart_model_test.rb
+- test/test_helper.rb
+- rails/init.rb
+- MIT-LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/nathanpro/smartmodel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Use all the power of MongoDB
+test_files: []
+