mdlsql 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4b47e84e03b2688dec439802afb5753beb7145f
+  data.tar.gz: 44b74787cdae12822cea936cde79184c476e0de8
+SHA512:
+  metadata.gz: efca8e547b004629a23c2c16458c2f2b69fda84d88fd9373e0dde986acc3d21b76df6fd197e1dafecda7d9748858a995d6263b0005aaf1818b2dafa8463991d6
+  data.tar.gz: eae8ca9196c88355be64ec4d2a63e0bdcecf6a25b371969e09e1e5859650a45fb2bbdea6321076a790cfd7682b63ec124ce99a220c6dff4c04b9be7c82aba995

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+md
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Configs and tests
+test.rb
+*.yml
+*.yaml
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Linux generated files #
+#########################
+*~
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+ehthumbs.db
+Thumbs.db
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mdlsql.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    mdlsql (0.0.1)
+      mysql2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mysql2 (0.3.11)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  mdlsql!
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sikian
+
+MIT License
+
+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,22 @@
+= MdlSql
+
+Modular Sql
+
+Modular Sql is a modular query builder that enables a high database compatibility, usage easiness and dynamic construction. It is intended to allow any kind of query in any database, but will, at the moment, only handle relatively simple ones to most common databases.
+
+<b>Actual situation:</b>
+Simple mysql queries (select, insert, update)
+No joins
+ 
+<b>Mysql output:</b> MysqlResult object, more info @ https://github.com/brianmario/mysql2usage
+
+== Usage
+
+Simple select:
+ result = Array.new
+ result = MdlSql::select.from(:users).where(:id, 1, '=').execute
+
+When selecting columns use .cols()/.columns, which can receive a Hash or an Array. In case a Hash is passed, the key will be the alias and the value the actual name of the column (f.e. 'users.username').
+
+Simple insert
+ result = MdlSql::insert.into(:users).cols(:user, :role).values('admin',2).execute

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mdlsql/sockets/mysql.rb

@@ -0,0 +1,135 @@
+class QueryBuilder
+	def select; end
+	def insert; end
+	def update; end
+end
+
+class MysqlBuilder < QueryBuilder
+	def initialize
+	end
+
+	class << self
+		def select(values={})
+			cols = values[:cols]
+			table = values[:table]
+			where = values[:where]
+
+			query = String.new
+			query = "SELECT"
+
+			# Columns (with alias)
+			if cols	
+				cols.each do |key,value|
+					query << " #{value} AS #{key}"
+				end
+			else
+				query << " *"
+			end
+			
+			# From (with possible alias)
+			if table
+				query << " FROM #{table}"
+				# query << " AS #{table_alias}" if table_alias
+			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]}"
+				end
+			end
+			# @where = Array
+			if where && where.length > 0
+				query << " WHERE"
+				where.each do |dec|
+					query << " #{dec}"
+				end
+			end
+
+			return query
+		end
+
+		def insert(values={})
+			# INSERT INTO table (column1, column2) VALUES (v1c1, v1c2), (v2c1, v2c2)
+
+			query = String.new
+			query = 'INSERT INTO'
+
+			if @from
+				query << " #{@from}"
+			else
+				raise "No table at insert query."
+			end
+
+			puts @cols.inspect
+			if @cols && @cols.count > 0
+				query << ' ('
+				@cols.each do |key,col|
+					query << "#{col},"
+				end
+
+				query.chop! << ')'
+			end
+
+			query << ' VALUES'
+
+			if @values
+				@values.each do |row|
+					query << ' ('
+					row.each do |val|
+						query << "'#{val}'" << ','
+					end
+					query.chop!
+					query << '),'
+				end
+				query.chop!
+			else
+				raise 'No values to insert.'
+			end
+
+			return query
+		end
+
+		def update(values={})
+			# UPDATE example SET age='22' WHERE age='21'
+
+			table = values[:table]
+			set = values[:values]
+			where = values[:where]
+
+			query = String.new()
+
+			if table
+				query << "UPDATE #{table} "
+			else
+				raise "No table at update query."
+			end
+
+			query << 'SET'
+
+			if set && set.count > 0
+				set.each do |key, value|
+					query << " #{key} = '#{value}',"
+				end
+				query.chop!
+			else
+				raise 'Nothing to be set.'
+			end
+
+			query << ' WHERE'
+
+			if where && where.count > 0
+				where.each do |con|
+					query << ' ' << con << ','
+				end
+				query.chop!
+			else
+				raise 'No WHERE condition in update.'
+			end
+
+			return query
+		end
+	end
+end

data/lib/mdlsql/sqlquery.rb

@@ -0,0 +1,200 @@
+require_relative './sockets/mysql.rb'
+require 'yaml'
+
+module MdlSql
+	class SqlQuery	
+
+	  def initialize
+	    # Initializes query as a string
+	    #   @return self [SqlQuery] so other methods may be concatenated.
+	    
+			return self
+	  end
+
+	  ###
+	  # Configuration
+	  #
+
+	  def self.config(values={})
+	  	# Does config need to be parsed from a config file?
+	  	# @todo check relative paths so file is correctly found.
+	  	# 	Maybe should be wise to use full paths.
+	  	if values[:parse]
+				if values[:parse] == :yml || values[:parse] == :yaml
+					if values[:file]
+						values = YAML.load_file(values[:file])
+
+						# Convert keys to symbols
+						values = values.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+					else
+						raise ArgumentError, "File value missing, config file could not be parsed."
+					end
+				end
+
+			end
+
+			@@host = values[:host]
+			@@username = values[:username]
+			@@password = values[:password]
+			@@db = values[:database]
+			@@socket = values[:socket]
+
+			puts values.inspect
+		end
+	  
+		###
+		# Method selection:
+		# 	select()
+		# 	insert()
+		# 	update(table=nil)
+		#
+
+	  def select()
+	    # Sets method to select
+			#		@return (@see initialize)
+	    @method = :select
+			
+			return self
+	  end
+
+	  def insert()
+	  	@method = :insert
+			return self
+	  end
+
+	  def update(table=nil)
+	  	@method = :update
+	  	from table if table
+			return self
+	  end
+	  
+	  ###
+	  # Parameters setting:
+	  # 	columns / cols
+	  # 	from / into
+	  # 	where
+	  # 	values
+	  # 	set
+	  #
+
+	  def columns(*values)
+	  	# @todo check column uniqueness in hash
+	  	# @todo revise 
+		# @return (@see initialize)
+			@cols ||= Hash.new
+
+
+			if values[0].is_a? Hash
+				values.each do |val|
+					@cols.update(val)
+				end
+				
+			else
+				values.each do |val|
+					@cols.update({val => val})
+				end
+			end
+			return self
+		end
+
+		alias_method :cols, :column
+
+	  def from(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
+
+			@table = table
+			@table_alias = table_alias unless table_alias.nil?
+			return self
+		end
+
+		# alias into() and from() select table 
+		alias_method :into, :from
+	  
+
+	  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
+			
+			@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
+
+			return self
+		end
+
+		def values(*val)
+			if @method == :insert
+				@values ||= Array.new
+
+				@values << val
+			else
+				raise 'Use values() only for #insert.'
+			end
+
+			return self
+		end
+
+		def set(val={})
+			if @method == :update
+				@values ||= Hash.new
+
+				@values.update val
+			else
+				raise 'Use set() only for #update.'
+			end
+
+			return self
+		end
+
+		###
+		# Exacution command
+
+	  def execute
+	 		# @todo return true/false when inserting/updating 
+			# @todo config for different db
+			unless @@host && @@username && @@password && @@db
+				raise 'MdlSql has not been correctly configured, please use config() to set host, username, password and db.'
+			end
+	    client = Mysql2::Client.new(
+	    	:host => @host, 
+	    	:username => @@username, 
+	    	:password => @@password, 
+	    	:database => @@db,
+				:symbolize_keys => true
+			)
+			
+			query = String.new
+
+			@@socket ||= :mysql
+
+			case @@socket
+			when :mysql
+				sock = MysqlBuilder
+				puts sock.class
+			end
+
+			query = sock.send("#{@method}", 
+				{:table => @table, 
+					:where => @where, 
+					:cols => @cols,
+					:values => @values
+			})
+
+
+			@result = client.query query
+			return @result
+
+		end
+	end
+end

data/lib/mdlsql/version.rb

@@ -0,0 +1,3 @@
+module MdlSql
+  VERSION = "0.0.1"
+end

data/lib/mdlsql.rb

@@ -0,0 +1,46 @@
+path = File.dirname(__FILE__) + "/mdlsql/"
+
+[
+ 	"version"
+	"sqlquery",
+
+	"sockets/mysql"
+].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
+
+	@host = String.new
+
+	def select()
+	  query = SqlQuery.new.select()
+	  return query
+	end
+
+	def insert
+		query = SqlQuery.new.insert()
+	  return query
+	end
+
+	def update(table=nil)
+		query = SqlQuery.new.update(table)
+	  return query
+	end
+
+	def config(values={})
+		SqlQuery.config(values)
+	end
+
+	module_function :config, :select, :insert, :update
+end

data/mdlsql.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mdlsql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mdlsql"
+  spec.version       = MdlSql::VERSION
+  spec.authors       = ["Sikian"]
+  spec.email         = ["sikian@gmail.com"]
+  spec.homepage    = "https://github.com/Sikian/mdlsql"
+  spec.summary     = %q{A modular query builder to enable a high database compatibility, usage easiness and dynamic construction.
+}
+  spec.description = %q{Modular Sql is a modular query builder that enables a high database compatibility, usage easiness and dynamic construction. It is intended to allow any kind of query in any database, but will, at the moment, only handle relatively simple ones to most common databases.}
+
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mysql2"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: mdlsql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Modular Sql is a modular query builder that enables a high database compatibility,
+  usage easiness and dynamic construction. It is intended to allow any kind of query
+  in any database, but will, at the moment, only handle relatively simple ones to
+  most common databases.
+email:
+- sikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/mdlsql.rb
+- lib/mdlsql/sockets/mysql.rb
+- lib/mdlsql/sqlquery.rb
+- lib/mdlsql/version.rb
+- mdlsql.gemspec
+homepage: https://github.com/Sikian/mdlsql
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A modular query builder to enable a high database compatibility, usage easiness
+  and dynamic construction.
+test_files: []
+has_rdoc: