sqlyzer 0.1

data/lib/sqlyzer/request.rb

@@ -0,0 +1,151 @@
+# SQLYZER Ruby Object serializer to SQL.
+# For more information visit http://sqlyzer.rubyforge.org
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+#
+
+require 'sqlyzer/errors'
+require 'sqlyzer/create'
+require 'sqlyzer/parameters'
+
+module  Sqlyzer
+
+  module  Sql
+    
+    #
+    #Handle generation of all Sql requests that a Sqlyzer::Serializer could ask
+    #for :
+    #* sql_select,
+    #* sql_insert,
+    #* sql_update,
+    #* sql_delete,
+    #* sql_table.    
+    #
+    module    Request
+      include Create
+  
+      private
+  
+      #
+      #Run given block code and store return value. The return value is considered
+      #as a format which will be applied on _keys_ and _values_ Sqlyzer::Parameter::List
+      #in a new or redefined method called _symbol_.
+      #This method call permit to generate the format only once.
+      #
+      def     _sql_request(symbol, keys, values = false)
+        fmt = yield
+        if values
+          self.class.module_eval <<-"end_eval"
+            def #{symbol}(table, keys, values)
+              sprintf("#{fmt}", *(values.to_sql(self) + keys.to_sql(self)))
+            end
+          end_eval
+          sprintf(fmt, *(values.to_sql(self) + keys.to_sql(self)))
+        else
+          self.class.module_eval <<-"end_eval"
+            def #{symbol}(table, keys, values = false)
+              sprintf("#{fmt}", *keys.to_sql(self))
+            end
+          end_eval
+          sprintf(fmt, *keys.to_sql(self))
+        end
+      end
+  
+      #
+      #Proxy method to apply Sqlyzer::Parameter::List join method for each member
+      #of _datas_ array with _suffix_ string.
+      #
+      def     _sql_data_join(suffix, *datas)
+        res = ''
+        for list in datas
+          if res.empty?
+            res = list.join(', ', suffix)
+          else
+            tmp = list.join(', ', suffix)
+            res += ', ' + tmp unless tmp.empty?
+          end
+        end
+        res
+      end
+  
+      protected
+  
+      #
+      #Generate a Sql SELECT command on table called _table_ with Sqlyzer::Parameter::List
+      #_keys_ as primary keys and _values_ as regular fields.
+      #Command format will be generated once thanks to _sql_request.      
+      #
+      def   sql_select(table, keys, values)
+        _sql_request(:sql_select, keys) {
+          "SELECT #{_sql_data_join('', values)} " +
+          "FROM #{table} " +
+          "WHERE #{keys.join ' AND ', ' = %s'};"
+        }
+      end
+  
+      #
+      #Generate a Sql INSERT command on table called _table_ with Sqlyzer::Parameter::List
+      #_keys_ as primary keys and _values_ as regular fields.
+      #Command format will be generated once thanks to _sql_request.      
+      #
+      def   sql_insert(table, keys, values)
+        _sql_request(:sql_insert, keys, values) {
+          "INSERT INTO #{table} (" +
+            _sql_data_join('', values, keys) +
+          ") VALUES (#{'%s, ' * (values.length + keys.length - 1)}%s);"
+        }
+      end
+  
+      #
+      #Generate a Sql UPDATE command on table called _table_ with Sqlyzer::Parameter::List
+      #_keys_ as primary keys and _values_ as regular fields.
+      #Command format will be generated once thanks to _sql_request.      
+      #
+      def   sql_update(table, keys, values)
+        _sql_request(:sql_update, keys, values) {
+          "UPDATE #{table} SET " +
+            _sql_data_join(' = %s', values) +
+          " WHERE #{keys.join ' AND ', ' = %s'};"
+        }
+      end
+  
+      #
+      #Generate a Sql DELETE command on table called _table_ with Sqlyzer::Parameter::List
+      #_keys_ as primary keys and _values_ as regular fields.
+      #Command format will be generated once thanks to _sql_request.
+      #  
+      def   sql_delete(table, keys, values = false)
+        _sql_request(:sql_delete, keys) {
+          "DELETE * FROM #{table} " +
+          "WHERE #{keys.join ' AND ', ' = %s'};"
+        }
+      end
+  
+      #
+      #Generate a Sql table called _table_ with Sqlyzer::Parameter::List
+      #_keys_ as primary keys and _values_ as regular fields.
+      #Unique index will be created on _keys_.
+      #
+      def   sql_table(table, keys, values)
+        sql_create_table(table, keys, values) +
+        sql_create_table_index!(table, keys) +
+        sql_alter_table_pk(table, keys)
+      end
+  
+    end #~  Request
+    
+  end #~  Sql
+  
+end #~  Sqlyzer

data/lib/sqlyzer/serializer.rb

@@ -0,0 +1,200 @@
+# SQLYZER Ruby Object serializer to SQL.
+# For more information visit http://sqlyzer.rubyforge.org
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+#
+require 'sqlyzer/errors'
+require 'sqlyzer/request'
+require 'sqlyzer/container'
+require 'sqlyzer/parameters'
+require 'sqlyzer/handler'
+
+module  Sqlyzer
+
+  #
+  #Permit to any Ruby object to be serialized on unserialized to an automatically
+  #generated Sql table through following methods :
+  #* sql_new,
+  #* sql_load,
+  #* sql_save,
+  #* sql_dispose.
+  #
+  module    Serializer
+    include Container
+    include Sql::Request
+    include Parameter::Types::Alias
+
+    public
+
+    #
+    #Request generation of _action_ Sql request for current object.
+    #
+    def     sql_serialize(action)
+      method(action).call(
+        sql_container_table,
+        sql_container_keys,
+        sql_container_values
+      )
+    end
+    alias   to_sql sql_serialize
+
+    public
+
+    #
+    #Try to load the object from associated table through a SELECT command.
+    #If command failed, insert a new row in the table through an INSERT command.
+    #
+    #See Sqlyzer::Request.
+    #
+    def     sql_new
+      begin
+        Handler::request self, :sql_select
+      rescue Sqlyzer::RequestError
+        Handler::request self, :sql_insert
+        false
+      else
+        true
+      end
+    end
+
+    #
+    #Load the object from associated table through a SELECT command.
+    #
+    #See Sqlyzer::Request.
+    #
+    def     sql_load
+      Handler::request self, :sql_select
+    end
+
+    #
+    #Try to update the object on associated table through an UPDATE command.
+    #If command failed, insert a new row in the table through an INSERT command.
+    #
+    #See Sqlyzer::Request.
+    #
+    def     sql_save
+      begin
+        Handler::request self, :sql_update
+      rescue Sqlyzer::RequestError
+        Handler::request self, :sql_insert
+        false
+      else
+        true
+      end
+    end
+
+    #
+    #Delete the object from associated table through a DELETE command.
+    #
+    #See Sqlyzer::Request.
+    #
+    def     sql_dispose
+      Handler::request self, :sql_delete
+    end
+
+    public
+
+    #
+    #Methods to add on extended class.
+    #
+    module  Serializer_Class
+
+      private
+
+      #
+      #Declare an Sql attibute for each _data_, alias to attr_accessor.
+      #This method will assert that each _data_ is a kind of Sqlyzer::Parameter::Default.
+      #
+      def   sql_attr(*data)
+        for id in data
+          if id.kind_of?(Parameter::Default)
+            attr_accessor id.symbol
+          else
+            attr_accessor id
+          end
+        end
+      end
+
+      #
+      #Declare each _data_ as a primary key of future Sql table.
+      #Call sql_attr on _data_.
+      #
+      def   sql_has_keys(*data)
+        sql_attr(*data)
+        extend Sqlyzer::Sql::Request
+        Sqlyzer::Container::sql_has_keys self, data
+      end
+
+      #
+      #Declare each _data_ as a regular field of future Sql table.
+      #Call sql_attr on _data_.
+      #
+      def   sql_has_values(*data)
+        sql_attr(*data)
+        extend Sqlyzer::Sql::Request
+        Sqlyzer::Container::sql_has_values self, data
+      end
+
+      #
+      #Set wished _name_ for future Sql table.
+      #
+      def   sql_use_table(name)
+        Sqlyzer::Container::sql_set_table self, name
+      end
+
+      #
+      #Shortcut to :
+      #1. sql_use_table self.class.name
+      #2. sql_has_keys _key_
+      #3. sql_has_values _values_
+      #
+      #First step will be ignored if table has already a name set.
+      #
+      def   sql_has(key, *values)
+        sql_use_table self.inspect.gsub('::', '_') unless
+          self.const_defined?(:SQL_CONTAINER_TABLE)
+        sql_has_keys key
+        sql_has_values(*values)
+      end
+      
+      def   sql_has_many(key, klass)
+        require 'sqlyzer/associate'
+        include Sqlyzer::Associate::One unless
+          include?(Sqlyzer::Associate::One)
+        Sqlyzer::Associate::One::link self, key, klass
+      end
+
+      def   sql_has_one(key, klass)
+        require 'sqlyzer/associate'
+        include Sqlyzer::Associate::One unless
+          include?(Sqlyzer::Associate::One)
+        Sqlyzer::Associate::One::link self, key, klass
+      end      
+
+    end #~  Serializer_Class
+
+    #
+    #Extend the class will Serializer_Class methods.
+    #
+    class << self
+      def included(klass)
+        super
+        klass.__send__(:extend, Serializer_Class)
+      end
+    end
+
+  end #~  Serializer
+  
+end #~  Sqlyzer

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: sqlyzer
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-05-02 00:00:00 +02:00
+summary: A complete Ruby Object to Sql serialize solution. Generate automatically all needed Sql objects without any of Sql from the user.
+require_paths: 
+- lib
+email: paul.quemin@gmail.com
+homepage: http://sqlyzer.rubyforge.org
+rubyforge_project: sqlyzer
+description: Sqlyzer is a Ruby Mixin able to store, load, update and delete Ruby objects and their relationships in a database by automatically generating adapted tables and queries without a line of Sql.
+autorequire: sqlyzer
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDODCCAiCgAwIBAgIBADANBgkqhkiG9w0BAQUFADBCMRQwEgYDVQQDDAtwYXVs
+  LnF1ZW1pbjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMB4XDTA3MDUxMjAwNTkzNloXDTA4MDUxMTAwNTkzNlowQjEUMBIGA1UEAwwL
+  cGF1bC5xdWVtaW4xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMGz6qvavTSN
+  LXXZx93o2o0s6GpwO5CIHe5U05kl2Bp116PObKipguxHkGqXliXgNQztJun/IIdV
+  Tglre5AgraCA9rQregB8tYhhKcsbZ/MnpyYKKpelxtgVW3zELUe+fcvdzNLmF2rP
+  Q6vuqfkfsmC80OQlcwp9PBXHOLP9XEjl6Ea+vHEvWzJT3h2DhzKoaKqrsb7Gq6hw
+  AQphUzFSPy80IW/LXGXFg8XtxbfkK8itgXtOmwyeSb0ip7NLhPLoJYBHChwQmhmW
+  xZD0E5HJ5p6yD5K0qv4jkRGoC5mCqnLKHw7dGTWhNFWqoxvNGtuj0jzIulRH2BFb
+  2FkwSIvxV9cCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFA5dDDK/hmhCKCDfw41ILZpXh4MCMA0GCSqGSIb3DQEBBQUAA4IBAQA86iar
+  kNqfVFBv7IEsHGBGEmKivDNFRgibyj7O8RzR/QkGuSGeFBEzPs34r/MeqT1FJDze
+  XKbyL9EMQQMQk6nwgrQVTt/M4Ba4VgW+BLG4yKWg4ovgCTNsXevup9YJRKk0Y6Mr
+  HhmDFlmlq28v5ZZSMr64XPi9L4QH6uYhkelW6qdmKIDLHNfYZXHWmkO69SMmjBvI
+  VuuPJbK5CU0A7Ojmttp++pBvTv1VXLFi7LsjaQ4MXR5PmbwHW1hFS8XLYIrntFBZ
+  prHBm/3lDy7y47+VxD3wqJdQLfq3AhEjdduNdFLSWBsonIPV4J9skJhn8LioRk8J
+  6nMtd6SBoidhjHqA
+  -----END CERTIFICATE-----
+
+post_install_message: 
+authors: 
+- Paul Quemin
+files: 
+- COPYING.txt
+- README.txt
+- lib/sqlyzer.rb
+- lib/sqlyzer/associate.rb
+- lib/sqlyzer/create.rb
+- lib/sqlyzer/errors.rb
+- lib/sqlyzer/parameters.rb
+- lib/sqlyzer/serializer.rb
+- lib/sqlyzer/container.rb
+- lib/sqlyzer/db.rb
+- lib/sqlyzer/handler.rb
+- lib/sqlyzer/request.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- COPYING.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+