sentiql 0.3.0 → 0.3.1

data/README.rdoc

@@ -15,8 +15,14 @@ This is REALY a work in progress, I wrote this lib during one evening after read
 == Instalation
     gem install sentiql 
 
-== How To
-1. Connect to database
+== Features
+* OM to create, update and find by attribute
+* Prepared SQL statements, which automatically escapes input
+* Filters: before_save, before_create, after_save and after_create
+* Validations expressed in boolean logic
+* Automatic timestamps
+
+== Configuration
     DB = Mysql2::Client.new( 
           :host=>'localhost', 
           :username=>'username', 
@@ -26,40 +32,86 @@ This is REALY a work in progress, I wrote this lib during one evening after read
     DB.query_options.merge!(:symbolize_keys=>true)
     SentiQL::Base.connection = DB
 
-2. Working with User data
+== Usage examples
+1. Create
+    u = User.create :name=>'tdurden', :password=>'project_mayhem'
 
-    # creating
-    u = User.new :name=>'Tyler Durden', :password=>'project_mayhem'
-    u.save  
-
-    # updating
-    u[:name] = 'Tyler'
+2. Update
+    # single attribute update
+    u = User.find_by :name=>'tdurden'
+    u.full_name = 'Tyler Durden'
     u.save
 
-    # reading
-    t = User.find_by :name=>'Tyler' # -> and instance of User
-    t = SentiQL::Base.first 'SELECT name FROM users where name=? LIMIT 1', ['Tyler'] # -> {:name=>'Tyler', :password=>'project_mayhem'}
-    users = SentiQL::Base.all 'SELECT name FROM users' # -> [{:name=>'Tyler'}]
+    # multiple update
+    put '/users' do
+      @user = User.find_by :id=>params[:user][:id]
+      @user.updated_attributes params[:user]
+      @user.save
+    end
 
-    # runing SQL query
-    SentiQL::Base.execute 'DELETE FROM users WHERE name=?', ['Robert Paulson']
-    
+3. Select
+    # find by attribute
+    u = User.find_by :name=>'tdurden'
+
+    # select with SQL
+
+    # "?" is replaced with escaped adequate value from params array
+    sql = 'SELECT * FROM users WHERE name=?'
+    u = User.first sql, ['tdurden'] # -> [ {:name=>'tdurden', :password=>'project_mayhem'} ]
 
-3. User model
+    users = User.all 'SELECT * FROM users' # => Mysql2::Result
+    users.map {|u| u[:name] } #=> ['username1', 'username2']
 
+== Model
+1. Basic
     class User < SentiQL::Base
-      
-      set_schema :name, :password, :created_at            # column names of the table that you will play with
-      set_table :users                                    # table name
+    
+      set_table :users
+      set_schema :name, :full_name, :email, :crypted_password, :salt, :created_at, :updated_at
+
+    end
+
+2. Using filters
+
+    before_save :create_salt, :encrypt_password, 
+    after_create :download_profile_image
 
-      before_create :set_timestamp
+    protected
 
-      protected 
+    def create_salt
+      self[:salt] = 'salt'
+    end
+
+    def encrypt_password
+      self[:crypted_password] = "#{self[:salt]}#{self[:password]}"
+    end
+
+    def download_profile_image
+      # ...
+    end
 
-      def set_timestamp
-        self[:created_at] = Time.now
+3. Validations
+    ...
+
+    def validate
+      name_not_blank? && name_not_longer_then?(20)
+    end
+
+    def name_not_blank?
+      if self[:name] == "" || self[:name].nil?
+        @errors << "Name can't 
+be blank"
+        return false
       end
+      return true
+    end
 
+    def name_not_longer_then? max
+      if self[:name].length > max
+        @errors << "Name can't be longer then #{max} characters"
+        return false
+      end
+      return true
     end
 
 == Licence

data/db/migrate/20110515_test_tables.rb

@@ -13,7 +13,7 @@ class TestTables < ActiveRecord::Migration
 
     create_table :clubs do |t|
       t.string :name
-      t.text :desc
+      t.text :description
       t.text :reqs
 
       t.timestamps

data/lib/sentiql/version.rb

@@ -1,3 +1,3 @@
 module SentiQL
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/sentiql.rb

@@ -7,7 +7,7 @@ module SentiQL
 
     def initialize attrs={}
       @attrs = {}
-      @errors = {}
+      @errors = []
       attrs.each_pair do |key, value|
         @attrs[key.to_sym] = value
       end
@@ -31,7 +31,6 @@ module SentiQL
 
 
     def save
-
       filter_with :before_save_filters
 
       if @attrs[:id]
@@ -84,7 +83,12 @@ module SentiQL
       end
     end
 
-    def valid?; true; end
+    def validate; end
+    def valid?
+      @errors = []
+      validate
+      return @errors == [] ? true : false
+    end
       
     class << self
       def connection; @@connection; end

data/spec/sentiql_spec.rb

@@ -1,5 +1,42 @@
 require_relative 'spec_helper'
 require 'date'
+require 'active_support/all'
+
+class Club < SentiQL::Base
+
+  set_table :clubs
+  set_schema :name, :description, :reqs, :created_at, :updated_at
+
+  def validate
+    name_not_blank?
+    description_not_blank? && description_not_longer_then(400)
+  end
+
+  def name_not_blank?
+    if self[:name].blank?
+      errors << "Name can't be blank" 
+      return false
+    end
+    return true
+  end
+
+  def description_not_blank?
+    if self[:description].blank?
+      errors << "Description can't be blank"
+      return false
+    end
+    return true
+  end
+
+  def description_not_longer_then max
+    if self[:description].length > max
+      errors << "Description can't be longer then #{max.to_s}"
+      return false
+    end
+    return true
+  end
+
+end
 
 class User < SentiQL::Base
 
@@ -43,6 +80,42 @@ end
 
 describe SentiQL::Base do
 
+  describe 'validations' do
+
+    describe '.valid?' do
+
+      it 'returns false if there are errors' do
+        c = Club.new :name=>'Fight Club'
+        c.save
+        c.valid?.should be_false
+        c[:description] = 'some description'
+        c.valid?.should be_true
+      end
+
+    end
+
+    it "doesn't save to DB if record is not valid" do
+      c = Club.new :name=>'Fight Club'
+      c.save
+      c[:id].should be_nil
+    end
+
+    it "saves record if its valid" do
+      c = Club.new :name=>'Fight Club'
+      c.save
+      c[:description] = 'some description'
+      c.save
+      c.id.should_not be_nil
+    end
+
+    it "returns a list of errors if records does not pass validations"  do
+      c = Club.new :name=>'Fight Club'
+      c.valid?
+      c.errors.size.should_not == []
+    end
+
+  end
+
   describe User do
 
     describe '.create' do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Martynas Miliauskas