procbuddy 0.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.0.1 - Released August 11, 2011
+ * Initial release

data/README

@@ -0,0 +1,46 @@
+== Rails SQL Procs
+
+Library which adds SQL Stored Procedures to Rails. Adds create_proc and drop_proc to the ActiveRecord::ConnectionAdapters::AbstractAdapter (which makes them available to migrations) and adds support for dumping procs in the ActiveRecord::SchemaDumper.
+
+== Installation
+
+To install:
+
+  gem install procbuddy
+ 
+Then add the following to your Rails config/environment.rb:
+
+  require_gem 'procbuddy'
+  require 'procbuddy'
+
+== Usage
+
+You can then use create_proc and drop_proc in your migrations. For example:
+
+  class CreateLameProc < ActiveRecord::Migration
+    def self.up
+      create_proc :lameness, <<EOSQL
+SELECT 1 + 1 as lame
+EOSQL
+    end
+
+    def self.down
+      drop_proc :lameness
+    end
+  end
+  
+This extension also adds support for procs in the ActiveRecord::SchemaDumper class.
+
+The following drivers are supported:
+
+ SQL Server
+
+== Known Issues
+
+* Drivers not mentioned above are not supported.
+
+If you find any issues please send an email to stewbawka@gmail.com .
+
+== Contributing
+
+If you would like to implement stored procedure support for other adapters then please drop me an email. Better yet, write up the adapter modifications and send them to me. :-)

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "procbuddy"
+    gemspec.summary = "sql stored procedures in migrations"
+    gemspec.description = "Provide create_proc and drop_proc in migrations. Also extends SchemaDumper to clue in about procs"
+    gemspec.email = "stewbawka@gmail.com"
+    gemspec.homepage = "http://blog.stewbawka.com""
+    gemspec.authors = ["Stuart Wade"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end

data/lib/procbuddy/connection_adapters/abstract/schema_definitions.rb

@@ -0,0 +1,14 @@
+module Procbuddy
+  module ConnectionAdapters #:nodoc:
+    # Abstract definition of a View
+    class ProcDefinition
+      attr_accessor :name, :sql
+      
+      def initialize(base, name, sql)
+        @base = base
+        @name = name
+        @sql = sql
+      end
+    end
+  end
+end

data/lib/procbuddy/connection_adapters/abstract/schema_statements.rb

@@ -0,0 +1,29 @@
+module Procbuddy
+  module ConnectionAdapters # :nodoc:
+    module SchemaStatements
+      # Create a proc.
+      def create_proc(name, sql, options={})
+        if supports_procs?
+          proc_definition = ProcDefinition.new(self, name, sql)
+
+          if options[:force]
+            drop_proc(name) rescue nil
+          end
+
+          create_sql = "CREATE PROCEDURE "
+          create_sql << "#{name}"
+          create_sql << proc_definition.sql
+          execute create_sql
+        end
+      end
+
+      # Drop a proc.
+      def drop_proc(name, options={})
+        if supports_procs?
+          drop_sql = "DROP PROCEDURE #{name}"
+          execute drop_sql
+        end
+      end
+    end
+  end
+end

data/lib/procbuddy/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractAdapter
+      # Subclasses should override and return true if they support triggers.
+      def supports_procs?
+        return false
+      end
+      
+      # Get a list of all triggers for the current database
+      def procs(name = nil)
+        raise NotImplementedError, "procs is an abstract method"
+      end
+      
+      # Get the code for the specified trigger
+      def proc_code(proc, name=nil)
+        raise NotImplementedError, "proc_code is an abstract method"
+      end
+    end
+  end
+end

data/lib/procbuddy/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,35 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class MysqlAdapter
+      # Returns true as this adapter supports views.
+      def supports_views?
+        true
+      end
+      
+      def tables(name = nil) #:nodoc:
+        tables = []
+        execute("SHOW TABLE STATUS", name).each { |row| tables << row[0] if row[17] != 'VIEW' }
+        tables
+      end
+      
+      def views(name = nil) #:nodoc:
+        views = []
+        execute("SHOW TABLE STATUS", name).each { |row| views << row[0] if row[17] == 'VIEW' }
+        views
+      end
+      
+      # Get the view select statement for the specified table.
+      def view_select_statement(view, name=nil)
+        row = execute("SHOW CREATE VIEW #{view}", name).each do |row|
+          return convert_statement(row[1]) if row[0] == view
+        end
+        raise "No view called #{view} found"
+      end
+      
+      private
+      def convert_statement(s)
+        s.gsub!(/.* AS (select .*)/, '\1')
+      end
+    end
+  end
+end

data/lib/procbuddy/connection_adapters/sqlserver_adapter.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class SQLServerAdapter
+      # Returns true as this adapter supports views.
+      def supports_procs?
+        true
+      end
+      
+      # Returns all the trigger names from the currently connected schema.
+      def procs(name = nil)
+        select_values("SELECT name FROM sysobjects WHERE type = 'P'", name)
+      end
+
+      def proc_sp_helptext(proc, name=nil)
+       q =<<-ENDSQL
+SELECT OBJECT_DEFINITION(OBJECT_ID('#{trigger}'));
+ENDSQL
+
+       proc_def = select_value(q, name)
+ 
+       if !proc_def.blank?
+          return proc_def
+        else
+          raise "No proc called #{proc} found"
+        end
+ 
+      end
+
+      def proc_code(proc, name=nil)
+        proc_def = proc_sp_helptext(proc, name)
+        proc_def.sub(/^CREATE PROCEDURE \w+\s+/, '')      
+      end 
+     
+    end
+  end
+end

data/lib/procbuddy/schema_dumper.rb

@@ -0,0 +1,66 @@
+module ActiveRecord
+  class SchemaDumper
+    
+    # A list of triggers which should not be dumped to the schema. 
+    # Acceptable values are strings as well as regexp.
+    # This setting is only used if ActiveRecord::Base.schema_format == :ruby
+    cattr_accessor :ignore_procs
+    @@ignore_procs = []
+    
+    def trailer_with_procs(stream)
+      # do nothing...we'll call this later
+    end
+    alias_method_chain :trailer, :triggers
+    
+    # Add procs to the end of the dump stream
+    def dump_with_procs(stream)
+      dump_without_procs(stream)
+      begin
+        if @connection.supports_procs?
+          procs(stream)
+        end
+      rescue => e
+        ActiveRecord::Base.logger.error "Unable to dump procs: #{e}"
+      end
+      trailer_without_procs(stream)
+      stream
+    end
+    alias_method_chain :dump, :procs
+    
+    # Add procs to the stream
+    def procs(stream)
+      @connection.procs.sort.each do |t|
+        next if ["schema_info", ignore_procs].flatten.any? do |ignored|
+          case ignored
+          when String: t == ignored
+          when Regexp: t =~ ignored
+          else
+            raise StandardError, 'ActiveRecord::SchemaDumper.ignore_procs accepts an array of String and / or Regexp values.'
+          end
+        end 
+        proc(t, stream)
+      end
+    end
+    
+    # Add the specified proc to the stream
+    def proc(proc, stream)
+      begin
+        t = StringIO.new
+        t.print "  proc_code = <<EOSQL\n"
+        t.print @connection.proc_code(proc)
+        t.print "EOSQL\n"
+        t.print "  create_proc(#{proc.to_sym.inspect}, "
+        t.print "proc_code, "
+        t.print ":force => true)\n"
+        t.rewind
+        stream.print t.read
+      rescue => e
+        stream.puts "# Could not dump proc #{proc.inspect} because of following #{e.class}"
+        stream.puts "#   #{e.message}"
+        stream.puts "#   #{e.trace}"
+      end
+      
+      stream
+    end
+  end
+end

data/lib/procbuddy/version.rb

@@ -0,0 +1,9 @@
+module Procbuddy
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/procbuddy.rb

@@ -0,0 +1,55 @@
+# Procbuddy is based the rails_sql_views gem developped by Anthony Eden
+# I have included his original copyright notice since this gem is derivative of his work.
+#
+#--
+# Copyright (c) 2006 Anthony Eden 
+#
+# 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.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
+require 'rubygems'
+
+#unless Kernel.respond_to?(:gem)
+#  Kernel.send :alias_method, :gem, :require_gem
+#end
+  
+unless defined?(ActiveRecord)
+  begin
+    $:.unshift(File.dirname(__FILE__) + "/../../activerecord/lib")
+    require 'active_record'
+  rescue LoadError
+    gem 'activerecord'
+  end
+end
+
+#require 'core_ext/module'
+
+require 'procbuddy/connection_adapters/abstract/schema_definitions'
+require 'procbuddy/connection_adapters/abstract/schema_statements'
+#require 'procbuddy/connection_adapters/mysql_adapter'
+require 'procbuddy/connection_adapters/sqlserver_adapter'
+require 'procbuddy/schema_dumper'
+
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  include Procbuddy::ConnectionAdapters::SchemaStatements
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: procbuddy
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stuart Wade
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-11 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Provide create_proc and drop_proc in migrations. Also extends SchemaDumper to clue in about stored procedures
+email: stewbawka@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/procbuddy/version.rb
+- lib/procbuddy/schema_dumper.rb
+- lib/procbuddy/connection_adapters/mysql_adapter.rb
+- lib/procbuddy/connection_adapters/sqlserver_adapter.rb
+- lib/procbuddy/connection_adapters/abstract_adapter.rb
+- lib/procbuddy/connection_adapters/abstract/schema_statements.rb
+- lib/procbuddy/connection_adapters/abstract/schema_definitions.rb
+- lib/procbuddy.rb
+- CHANGELOG
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://blog.stewbawka.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: procbuddy
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: sql stored procedures in migrations
+test_files: []
+