taupe 0.5.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1b548f21b57a427e78515d3ea17ac0974f3a9d0
-  data.tar.gz: d25d1f8a2dd03b30b583e48f99a353fa09597528
+  metadata.gz: 8a2c0a9f56009d2ce7ba093cd9069380c6b071b2
+  data.tar.gz: d1401fecf29967d599365dcfece011f69e788e27
 SHA512:
-  metadata.gz: ef228a38b35977d1cada2add8000afeacf0d7756b42714d27d3b5806eb134193a0aa5f376aa56582440c8bd9451c7e52cc94c4b24b65593a01c5f764be248581
-  data.tar.gz: 560d21ddc307e63daa65469bd566b9c8062ec1d99aabf7ade937be744e70fa4bf199047aceef660d2364604a7843ee16e7ae814480639b1462c4b0c02b6bdc91
+  metadata.gz: f660d2425a1766b1d829a38576d9bcdda563cbf1468a1569ce37db0a927f670fc620385073c6e7e20e1b37b54adbd6317978dad14fbb80bc46f04c0d0129134d
+  data.tar.gz: 5bf686251cfc41a9aef472295337c6306687ed74a1e4b590d2759f642295bb6deaf5e36cbedc752c86d9779f0fb3a14c85dc4cee9a425ab88c7e8c69ad1d693a

data/Gemfile

@@ -4,3 +4,7 @@ source 'https://rubygems.org'
 gem 'rake'
 gem 'rspec'
 gem 'yard'
+
+group :test do
+  gem 'sqlite3'
+end

data/README.md

@@ -1,5 +1,8 @@
 # Taupe
 
+[![Gem Version](https://badge.fury.io/rb/taupe.svg)](http://badge.fury.io/rb/taupe)
+[![Build Status](https://travis-ci.org/pierre-lecocq/taupe.svg?branch=master)](https://travis-ci.org/pierre-lecocq/taupe)
+
 ## What is it?
 
 **Taupe** is a simple and elegant database model manager.
@@ -37,7 +40,7 @@ Here are the main reasons:
 
 ## How to use it?
 
-### Prerequisites
+### Install
 
 In order to install the Taupe library, simply install the corresponding gem with
 
@@ -100,7 +103,7 @@ After that, you must have a few gems install on your system, depending on which
     Taupe::Cache.setup do
       type :memcached
       host :localhost
-      port :11211
+      port 11211 # A symbol can not start with an integer, so make it an integer
     end
 
 #### Redis
@@ -109,7 +112,7 @@ After that, you must have a few gems install on your system, depending on which
     Taupe::Cache.setup do
       type :redis
       host :localhost
-      port :6379
+      port 6379 # A symbol can not start with an integer, so make it an integer
     end
 
 ### Define some models
@@ -149,27 +152,98 @@ After that, you must have a few gems install on your system, depending on which
     # Reflect changes in database/cache (insert or update)
     article.save
 
-#### Query, query, query. But by yourself.
+#### Execute raw queries
+
+In order to execute raw queries like INERT, UPDATE or DELETE, the easiest method is to execute them directly on the database object. There is no specific need to execute them from a specific model's class.
 
-    # Execute a single query
+    # Execute raw queries
     Taupe::Database.exec "INSERT INTO article (title, state) VALUES ('Another article', 1)"
+    Taupe::Database.exec "UPDATE article SET title = 'Yet another article' WHERE article_id = 1"
+    Taupe::Database.exec "DELETE article WHERE article_id = 1"
+
+#### Fetching objects
+
+There are two ways of fetching objects that depend on the expecting results
+
+##### Fetch objects and get an Array of Hashes
+
+By executing a SELECT query on the database object, Taupe returns an Array of the Hash values of the object.
+
+For example:
 
     # Fetch results in an array
     articles = Taupe::Database.fetch "SELECT * FROM article"
 
-    # Fetch a single result
-    article = Taupe::Database.fetch "SELECT * FROM article WHERE article_id = 3", true
+gives:
+
+    [
+        { :article_id => 1, :title => 'An article'},
+        { :article_id => 2, :title => 'Another article'}
+    ]
 
-For more clarity, you can also exec or fetch from any model class. It is exactly the same.
+This is great if you need either raw or flexible data to deal with afterwards.
+Of course, you deal with this data like any ruby array of hashes.
 
-    # Execute an insert query
-    Taupe::Model::Article.exec "INSERT INTO article (title, state) VALUES ('Another article', 1)"
+##### Fetch objects and get an Array of Model Objects
+
+By executing a SELECT query on a specific model object, Taupe returns an Array of Objects.
+
+For example:
 
     # Fetch
     articles = Taupe::Model::Article.fetch "SELECT * FROM article"
 
-    # Fetch single
-    article = Taupe::Model::Article.fetch "SELECT * FROM article WHERE article_id = 3", true
+gives (these are dummy data):
+
+    [
+        <Taupe::Model::Article:0x000000014e3c88 @_table=:article, @_columns={:article_id=>{:type=>Integer, :primary_key=>true}, # skip...
+        <Taupe::Model::Article:0x000000014e38b8 @_table=:article, @_columns={:article_id=>{:type=>Integer, :primary_key=>true} # skip...
+    ]
+
+Therefore, it allows you to deal with all the objects contained in the result array like (for example):
+
+    articles.each do |article|
+        # Display some properties
+        puts article.article_id
+        puts "The title of this article is: #{article.title}"
+
+        # Modify some properties
+        article.title = '[Updated] ' + article.title
+
+        # And save the model
+        article.save
+    end
+
+And this methods allows you to play with extended models like described just below.
+
+#### Extend models
+
+Models can be extended to add some properties that are not stored (and will not be stored) in the database.
+
+Let's take an example to illustrate this, instead of talking:
+
+    module Taupe
+      class Model
+        class Article
+
+          def full_title
+            add_property :full_title, "Article #{article_id} - #{title}"
+          end
+
+          def tag_ids
+            add_property :tag_ids, [1, 2, 5]
+          end
+        end
+      end
+    end
+
+This adds two new dummy properties that can be uesd as any other property:
+
+    articles = Taupe::Model::Article.fetch "SELECT * FROM article"
+
+    articles.each do |r|
+      puts r.full_title
+    end
 
 ## License
 

data/lib/taupe.rb

@@ -1,5 +1,5 @@
 # File: taupe.rb
-# Time-stamp: <2014-09-11 16:27:47 pierre>
+# Time-stamp: <2014-12-10 14:53:34 pierre>
 # Copyright (C) 2014 Pierre Lecocq
 # Description: Taupe library main file
 
@@ -13,7 +13,7 @@ require 'taupe/model'
 # Main Taupe module
 module Taupe
   # Current version constant in the form major.minor.patch
-  VERSION = [0, 5, 3].join('.')
+  VERSION = [0, 6, 1].join('.')
 
   # Require a gem
   # @param gem_name [String] the gem name

data/lib/taupe/model/table.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 # File: table.rb
-# Time-stamp: <2014-09-11 16:28:23 pierre>
+# Time-stamp: <2014-12-10 14:46:01 pierre>
 # Copyright (C) 2014 Pierre Lecocq
 # Description: Taupe library model table class
 
@@ -62,6 +62,11 @@ module Taupe
         @_cache_key = options[:cache_key] || nil
         @_values = options[:values] || {}
 
+        # Clean up values (i.e SQLite duplicates values with numeric keys)
+        @_values.each do |k, _v|
+          @_values.delete(k) unless k.is_a? Symbol
+        end
+
         @_pkey = columns.select { |_k, v| v[:primary_key] == true }.first[0]
         fail "Primary key undefined for model #{table}" if @_pkey.nil?
 
@@ -95,8 +100,8 @@ module Taupe
 
         return nil if result.nil? || result.empty?
 
-        result.map do |k, v|
-          @_values[k.to_sym] = v unless k.is_a? Numeric
+        result.each do |k, v|
+          @_values[k.to_sym] = v if k.is_a? Symbol
         end
 
         Taupe::Cache.set @_cache_key, @_values unless @_cache_key.nil?
@@ -107,18 +112,20 @@ module Taupe
       def save(with_validations = true)
         Taupe::Validate.check(@_values, @_columns) if with_validations
 
+        real_values = @_values.keep_if { |k, _v| @_columns.key?(k) }
+
         if @_pkey_id.nil?
           query = "
             INSERT INTO #{@_table}
-               (#{@_values.keys.map(&:to_s).join(', ')})
+               (#{real_values.keys.map(&:to_s).join(', ')})
             VALUES
-               (#{@_values.values.map { |e| "'" + e.to_s + "'" }.join(', ')})
+               (#{real_values.values.map { |e| "'" + e.to_s + "'" }.join(', ')})
           "
 
           Taupe::Database.exec query
           @_pkey_id = Taupe::Database.last_id
         else
-          joined_values = @_values.map { |k, v| "#{k} = '#{v}'" }.join(', ')
+          joined_values = real_values.map { |k, v| "#{k} = '#{v}'" }.join(', ')
           query = "
             UPDATE #{@_table} SET #{joined_values}
             WHERE #{@_pkey} = #{@_pkey_id}
@@ -155,7 +162,7 @@ module Taupe
         ms = m.to_s
         if ms.include? '='
           ms = ms[0..-2]
-          if @_columns.include? ms.to_sym
+          if property? ms.to_sym
             @_values[ms.to_sym] = args[0]
             return true
           end
@@ -164,6 +171,30 @@ module Taupe
         super
       end
 
+      # Check if current model has a given property
+      # @param key [Symbol]
+      # @return [Boolean]
+      def property?(key)
+        @_columns.include? key.to_sym
+      end
+
+      # Add a propery to the current model
+      # @param key [Symbol]
+      # @param value [Mixed]
+      # @param column_properties [Hash]
+      # @return [Mixed]
+      def add_property(key, value = nil, column_properties = {})
+        key = key.to_sym
+        unless property? key
+          @_values[key] = value
+
+          # Include in database columns definition
+          @_columns[key] = {} unless column_properties.empty?
+        end
+
+        @_values[key]
+      end
+
       # Execute a single query
       # @param query [String] The query to execute
       # @return [Object]

data/spec/taupe_spec.rb

@@ -1,5 +1,5 @@
 # File: taupe_spec.rb
-# Time-stamp: <2014-08-01 12:00:00 pierre>
+# Time-stamp: <2014-12-10 14:53:22 pierre>
 # Copyright (C) 2014 Pierre Lecocq
 # Description: Taupe library main tests file
 
@@ -7,8 +7,8 @@ require_relative '../lib/taupe'
 
 describe Taupe do
   describe 'VERSION' do
-    it 'should return 0.5.3' do
-      expect(Taupe::VERSION).to eql '0.5.3'
+    it 'should return 0.6.1' do
+      expect(Taupe::VERSION).to eql '0.6.1'
     end
   end
 end

data/taupe.gemspec

@@ -1,5 +1,5 @@
 # File: taupe.gemspec
-# Time-stamp: <2014-09-11 16:31:28 pierre>
+# Time-stamp: <2014-12-10 14:50:35 pierre>
 # Copyright (C) 2014 Pierre Lecocq
 # Description: Taupe library gemspec file
 
@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.authors           = ['Pierre Lecocq']
   gem.email             = ['pierre.lecocq@gmail.com']
   gem.summary           = 'A model manager with database and cache backends in ruby'
-  gem.description       = 'Keep your database '
+  gem.description       = 'Access to your database and cache backends easily in ruby'
   gem.homepage          = 'https://github.com/pierre-lecocq/taupe'
-  gem.date              = '2014-08-01'
+  gem.date              = Date.today.to_s
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: taupe
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.1
 platform: ruby
 authors:
 - Pierre Lecocq
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies: []
-description: 'Keep your database '
+description: Access to your database and cache backends easily in ruby
 email:
 - pierre.lecocq@gmail.com
 executables: []