mdlsql 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a3f1ee3724c8d5dcbd702d9d4f3a2cd61a2c54a
-  data.tar.gz: 41929822db8d6b30ccbf4436de1744c36c669940
+  metadata.gz: 8cc48c0d204d23a1b157084b6c2020dbf6a1ba54
+  data.tar.gz: f0a78964c5ca8fe37e67168f5044a60e391e1c34
 SHA512:
-  metadata.gz: 13d5056116222b9ece1fe97b9d7972a2061b541206fc4f246fb0c0860c01bb7bf017ebf828e6dd3d5e51432e873595a1fe5c756a835cd492d775f2ca15c73ebe
-  data.tar.gz: bbb2aa3d807bb5aec7327af9d505bdd0723a187f961c664a472a3424cc199a3ae9f03ec0219f5d3034f8cb2bb11ef0c366d2e791099d9b1b65a4f1b4a0daef02
+  metadata.gz: 1e1e2b2da31b46fdf530691510f7e60f5abd3cfa7468dfdb31cae147ec4a35c0d547f4cb45f089ef47da671aaa051a7efd6cbb6ed6cb782a8b714f6d94ac2691
+  data.tar.gz: f10f5794bb5978bbd6e92e4be5c4e528a394252d0b477eae20d5d7eadaaecea660b6611cfdb97fca4b8f601e5eff38db438152b363af17581ff4de77217d565b

data/README.rdoc

@@ -7,8 +7,9 @@ Modular Sql is a modular query builder that enables a high database compatibilit
 It actually does a similar job to ActiveRecord, but I believe it may allow a better control in some aspects as it lies somehow between raw queries and that uberuseful gem.
 
 <b>Actual situation:</b>
-* Simple mysql queries (select, insert, update)
-* No joins
+* Simple mysql queries (select, insert, update).
+* No <i>joins</i>.
+* Just one <i>where</i> condition (if you need more than one, use #where(all_conditions_together).
  
 == Usage
 
@@ -33,14 +34,34 @@ When selecting columns use .cols()/.columns(), which can receive a Hash or an Ar
  
 <b>Update:</b> 
  result = MdlSql::update(:users).set(:role => '1').where(@username = 'default'").execute
- 
-Updating follows mysql building way. Remember that you can still use .table() if you feel more comfortable.
 
+Updating follows mysql building way. Remember that you can still use .table() if you feel more comfortable. 
  
- 
+== Fast documentation
+
+===#table(table_name, table_alias) (#from, #into):
+Select table to use.
+
+=== #where(first_term, sencond_term, operator):
+Where condition.
+This can be used both passing each separate term (recommended) and introducing the whole comparison as the first_term (i.e. .where('id = 1')). The first way will provide a higher compatibility with other databases, but may not be as useful when needing more than a simple condition.
+
+TODO: expand where to include AND, OR, etc. in order to be able to concatenate many conditions.
+
+=== #columns(*values)
+
+
+== Installing
+
+	gem install mdlsql
+
+If you're going to use mysql, mysql2 is required. Please follow these instructions to install: https://github.com/brianmario/mysql2#installing (really worth it, even if you're not going to use mdlsql ;) ).
+
 == Useful Links
 
 * Mysql2: https://github.com/brianmario/mysql2usage
+
+* RubyGems: https://rubygems.org/gems/mdlsql
  
 == License
  

data/lib/mdlsql/col.rb

@@ -0,0 +1,38 @@
+# Copyright (C) 2013 All MdlSql contributers
+
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
+# In order to contact the author of this gem, please write to sikian@gmail.com.
+
+module MdlSql
+	class Col
+		# @!attribute table [Table]
+		# @!attribute col [Symbol]
+		attr_accessor :col, :table
+
+		# @param table [Table]
+		# @param col [Symbol]
+		def initialize col, table
+			# table = table.to_sym if table.is_a? String
+			col = col.to_sym if col.is_a? String
+
+			if table.is_a? String || table.is_a?
+				table = Table.new table
+			end
+
+			@table = table
+			@col = col
+		end
+	end
+end

data/lib/mdlsql/join.rb

@@ -0,0 +1,50 @@
+# Copyright (C) 2013 All MdlSql contributers
+
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
+# In order to contact the author of this gem, please write to sikian@gmail.com.
+
+module MdlSql
+	class Join
+		# @!attribute type [Symbol]
+		# @!attribute table [Table]
+		# @!attribute col1 [Symbol/String]
+		# @!attribute col2 [Symbol/String]
+		# @!attribute op [Symbol]
+
+		attr_accessor :type, :table, :cond1, :cond2, :op
+
+		def initialize opts={}
+			@cond1 = opts[:cond1]
+			@cond2 = opts[:cond2]
+			@table = Table.new opts[:table], opts[:as]
+			@type = opts[:type]
+
+			opts[:op].to_sym if opts[:op].is_a? String
+			@op = opts[:op]
+			@op ||= '='.to_sym
+		end
+
+		# Literals must be made explicit with apostrophes.
+		def to_mysql
+			# query = String.new
+			query = "\n"
+			query << @type.to_s.upcase << ' ' if @type
+			query << 'JOIN'
+			query << " " << @table.to_mysql
+			query << "\nON #{@cond1} #{@op} #{@cond2}"
+			return query
+		end
+	end
+end

data/lib/mdlsql/sockets/mysql.rb

@@ -28,8 +28,9 @@ class MysqlBuilder < QueryBuilder
 	class << self
 		def select(values={})
 			cols = values[:cols]
-			table = values[:table]
+			tables = values[:tables]
 			where = values[:where]
+			join = values[:join]
 
 			query = String.new
 			query = "SELECT"
@@ -44,24 +45,40 @@ class MysqlBuilder < QueryBuilder
 			end
 			
 			# From (with possible alias)
-			if table
-				query << " FROM #{table}"
-				# query << " AS #{table_alias}" if table_alias
+			if tables
+				query << ' FROM'
+				tables.each do |tab|
+					query << ' ' << tab.to_mysql
+					# query << " #{tab.name}"
+					# query << " AS #{tab.as}" if tab.as
+					query << ","
+				end
+				query.chop!
+
 			else
 				raise "No table at select query."
 			end
 			
-			# @leftjoin = {:tablealias => {:name => "tablename", :on => "oncondition"}...}
-			if @leftjoin && @leftjoin.length > 0
-				@leftjoin.each do |key, value|
-					query << " LEFT JOIN #{value[:name]} AS #{key} ON #{value[:on]}"
+			# @join, see Join
+			if join && join.length > 0
+				join.each do |j|
+					query << j.to_mysql
+					# query << ' ' << value[:type] if value[:type]
+					# query << ' ' << value[:table].to_s
+					# query << " ON #{value[:cond1]} #{value[:op]} #{value[:cond2]}"
 				end
 			end
 			# @where = Array
 			if where && where.length > 0
-				query << " WHERE"
-				where.each do |dec|
-					query << " #{dec}"
+				query << "\nWHERE"
+				# where.each do |dec|
+				# 	query << " #{dec}"
+				# end
+				first = true
+				where.each do |wh|
+					query << " #{wh.concat}" unless first
+					query << " #{wh.cond1} #{wh.op} #{wh.cond2}"
+					first = false
 				end
 			end
 
@@ -80,7 +97,6 @@ class MysqlBuilder < QueryBuilder
 				raise "No table at insert query."
 			end
 
-			puts @cols.inspect
 			if @cols && @cols.count > 0
 				query << ' ('
 				@cols.each do |key,col|

data/lib/mdlsql/sqlquery.rb

@@ -15,9 +15,6 @@
 
 # In order to contact the author of this gem, please write to sikian@gmail.com.
 
-require_relative './sockets/mysql.rb'
-require 'yaml'
-
 module MdlSql
 	class SqlQuery	
 
@@ -55,8 +52,6 @@ module MdlSql
 			@@password = values[:password]
 			@@db = values[:database]
 			@@socket = values[:socket]
-
-			puts values.inspect
 		end
 	  
 		###
@@ -68,7 +63,7 @@ module MdlSql
 
 	  def select()
 	    # Sets method to select
-			#		@return (@see initialize)
+			#	@return (@see initialize)
 	    @method = :select
 			
 			return self
@@ -94,10 +89,10 @@ module MdlSql
 	  # 	set
 	  #
 
-	  def columns(*values)
-	  	# @todo check column uniqueness in hash
-	  	# @todo revise 
+  	#	@todo check column uniqueness in hash
+  	#	@todo revise 
 		# @return (@see initialize)
+	  def columns(*values)
 			@cols ||= Hash.new
 
 
@@ -114,43 +109,85 @@ module MdlSql
 			return self
 		end
 
-		alias_method :cols, :column
+		alias_method :cols, :columns
 
-	  def table(table, table_alias=nil)
-			# Selects table from which to select (or insert, update) with possible alias.
-			# @todo use a hash here to allow many tables (for a select, for example).
-			# @note use into() when inserting for readability.
-			#	@return (@see initialize)
-			table = table.to_sym if table.is_a? String
-			table_alias = table_alias if table_alias.is_a? String
+		###
+		#
+		# Selects table from which to select (or insert, update) with possible alias.
+		# @todo use a hash here to allow many tables (for a select, for example).
+		# @note use from() when selecting & into() when inserting for readability.
+		#	@return (@see initialize)
+	  def tables(tables = {})
+			# table = table.to_sym if table.is_a? String
+			# table_alias = table_alias if table_alias.is_a? String
+
+			@tables ||= Array.new
+			tables.each do |table,table_alias|
+				@tables.push Table.new table, table_alias
+			end
 
-			@table = table
-			@table_alias = table_alias unless table_alias.nil?
+			# @table = table
+			# @table_alias = table_alias unless table_alias.nil?
 			return self
 		end
 
 		# alias into() and from() select table 
-		alias_method :into, :table
-		alias_method :from, :table
+		alias_method :into, :tables
+		alias_method :from, :tables
 	  
 
-	  def where(first, second=nil, comp=nil)
-			# @param first [String, Array] as a string it can be the whole WHERE declaration or just the first element. As an Array, it contains a list of where declarations
-			
+		# Generates a where clause
+		# Maybe it's a good idea to make a Where object.
+		#
+		# FFS, HAVE A CLEAR IDEA BEFORE WRITING!
+		#
+		# @option opts [String] :op default is =
+		# @option opts [Symbol] :concat AND, OR..., default is AND.
+		# @note First where clause's concat is ignored.
+		# 
+		# @todo Add IN, BETWEEN and LIKE (can be done with actual where).
+		def where(cond1, cond2, opts={})
+			opts[:op] ||= '='
+			opts[:concat] ||= :AND
+
+			# if cond1.is_a? Hash
+			# 	if cond1[:table] && cond1[:col]
+			# 		cond1 = Col.new cond[:col], cond[:table]
+
 			@where ||= Array.new
-			if second.nil?
-				@where << first
-			else
-				if comp.nil?
-					raise "Don't know which logical operator to use in the where statement."
-				else
-					@where << "#{first} #{comp} '#{second}'"
-				end
-			end
+			wh = Where.new(
+				:cond1 => cond1,
+				:cond2 => cond2,
+				:op => opts[:op],
+				:concat => opts[:concat]
+			)
+			@where.push wh
 
 			return self
 		end
 
+		# @option opts [Symbol/String] :op
+		# @option opts [Symbol] :type
+		def join(table, cond1, cond2, opts={})
+			@join ||= Array.new
+
+			vars = {
+				:table => table, 
+				:cond1 => cond1, 
+				:cond2 => cond2, 
+				:op => opts[:op], 
+				:type => opts[:type]
+			}
+			@join.push Join.new vars
+
+			return self
+		end
+
+		def leftjoin(table, cond1, cond2, opts={})
+			opts.update({:type => :left})
+			join(table,cond1,cond2, opts)
+		end
+
 		def values(*val)
 			if @method == :insert
 				@values ||= Array.new
@@ -176,12 +213,12 @@ module MdlSql
 		end
 
 		###
+		# @!method execute()
 		# Exacution command
-
+	 	# @todo return true/false when inserting/updating 
+		# @todo config for different db
 	  def execute
-	 		# @todo return true/false when inserting/updating 
-			# @todo config for different db
-			unless @@host && @@username && @@password && @@db
+			if @@host.nil? || @@username.nil? || @@password.nil? || @@db.nil?
 				raise 'MdlSql has not been correctly configured, please use config() to set host, username, password and db.'
 			end
 	    client = Mysql2::Client.new(
@@ -199,20 +236,23 @@ module MdlSql
 			case @@socket
 			when :mysql
 				sock = MysqlBuilder
-				puts sock.class
 			end
 
 			query = sock.send("#{@method}", 
-				{:table => @table, 
+				{:tables => @tables, 
 					:where => @where, 
 					:cols => @cols,
-					:values => @values
+					:values => @values,
+					:join => @join
 			})
 
 
 			@result = client.query query
 			return @result
 
+			return query
 		end
 	end
 end
+
+

data/lib/mdlsql/table.rb

@@ -0,0 +1,36 @@
+# Copyright (C) 2013 All MdlSql contributers
+
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
+# In order to contact the author of this gem, please write to sikian@gmail.com.
+
+module MdlSql
+	class Table
+		attr_accessor :name, :as
+		def initialize name, as=nil
+			name = name.to_sym if name.is_a? String
+			as = as.to_sym if as.is_a? String
+
+			@name = name
+			@as = as if as
+		end
+
+		def to_mysql
+			s = String.new
+			s << @name.to_s
+			s << ' AS ' << @as.to_s if @as
+			return s
+		end
+	end
+end

data/lib/mdlsql/version.rb

@@ -1,3 +1,3 @@
 module MdlSql
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/mdlsql/where.rb

@@ -0,0 +1,35 @@
+# Copyright (C) 2013 All MdlSql contributers
+
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
+# In order to contact the author of this gem, please write to sikian@gmail.com.
+
+module MdlSql
+	class Where
+		# @!attribute col1 [Symbol/String]
+		# @!attribute col2 [Symbol/String]
+		# @!attribute op [Symbol]
+
+		attr_accessor :cond1, :cond2, :op, :concat
+
+		def initialize opts={}
+			@cond1 = opts[:cond1]
+			@cond2 = opts[:cond2]
+
+			opts[:op].to_sym if opts[:op].is_a? String
+			@op = opts[:op]
+			@concat = opts[:concat]
+		end
+	end
+end

data/lib/mdlsql.rb

@@ -18,26 +18,23 @@
 path = File.dirname(__FILE__) + "/mdlsql/"
 
 [
- 	"version"
+ 	"version",
 	"sqlquery",
 
-	"sockets/mysql"
+	"sockets/mysql",
+
+	"table",
+	"col",
+	"where",
+	"join"
 ].each do |library|
 	require path + library
-	puts path + library
 end
 
-module MdlSql
-  # @!method select()
-	# @!method insert()
-	# @!method update()
-	# @!method config()
-	# 	Calls SqlQuery.config to configurate futures queries. 
-	# 	@todo Allow many simultaneous configurations. For the moment being, use different config files.
-	# 	@option values [Symbol]
-	
-	# module_function :select, :insert, :update, :config
+require 'yaml'
+require 'mysql2'
 
+module MdlSql
 	@host = String.new
 
 	def select()
@@ -55,6 +52,9 @@ module MdlSql
 	  return query
 	end
 
+	# Calls SqlQuery.config to configurate futures queries. 
+	# @todo Allow many simultaneous configurations. For the moment being, use different config files.
+	# @option values [Symbol]
 	def config(values={})
 		SqlQuery.config(values)
 	end

data/test/test_tables.rb

@@ -0,0 +1,20 @@
+require_relative '../lib/mdlsql'
+
+MdlSql.config({
+	:host => 'localhost',
+	:username => 'root',
+	:password => 'candyholaesternocow',
+	:database => 'anvyl'
+	})
+
+puts results = MdlSql.select
+	.from(:users => :u)
+	.join(:jobs, :'u.uid', 'jobs.uid')
+	.where(:status, 1, :op => :>)
+	.execute
+	# .where(:'u.id', 3)
+	# 
+
+results.each do |r|
+	puts "#{r[:username]} :: #{r[:name]}"
+end	

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdlsql
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -70,10 +70,15 @@ files:
 - README.rdoc
 - Rakefile
 - lib/mdlsql.rb
+- lib/mdlsql/col.rb
+- lib/mdlsql/join.rb
 - lib/mdlsql/sockets/mysql.rb
 - lib/mdlsql/sqlquery.rb
+- lib/mdlsql/table.rb
 - lib/mdlsql/version.rb
+- lib/mdlsql/where.rb
 - mdlsql.gemspec
+- test/test_tables.rb
 homepage: https://github.com/Sikian/mdlsql
 licenses:
 - GPL-3.0
@@ -99,5 +104,6 @@ signing_key:
 specification_version: 4
 summary: A modular query builder to enable a high database compatibility, usage easiness
   and dynamic construction.
-test_files: []
+test_files:
+- test/test_tables.rb
 has_rdoc: