netshade-sql_valued_columns 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 netshade
+
+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,48 @@
+= sql_valued_columns
+
+SqlValuedColumns is an ActiveRecord plugin that will let you have specific
+SQL statements executed on INSERT / UPDATE.  It will call the SQL function
+you provide, passing the arguments specified in the call to sql_column.
+
+See the documentation for SqlValuedColumns::ClassMethods#sql_column for more 
+information regarding usage, including passing Strings and Proc objects as
+arguments to your SQL function.
+
+Example:  You have a model with two columns, one named "another_column" and 
+the other named "size_of_another_column".  Whenever you insert data into 
+"another_column", you want to have size_of_another_column have the result
+of the SQL function LENGTH inserted into it.
+
+  class MyModel < ActiveRecord::Base
+    sql_column :size_of_another_column, "LENGTH", :another_column
+  end
+
+Example 2:  You have a model with three columns, position, latitude and longitude.
+Latitude and longitude are values expressed as angles, and position is a special
+datatype for your database that represents the X/Y/Z projection of that particular
+latitude and longitude (example: http://www.postgresql.org/docs/8.3/static/earthdistance.html )
+
+When you insert data with latitude and longitude, you want to automatically call a function
+in your database to transform the latitude and longitude into the appropriate represenation.
+
+  class MyModel < ActiveRecord::Base
+    sql_column :position, "ll_to_earth", :latitude, :longitude
+  end
+
+Example 3:  You are an insane criminal who has somehow learned SQL.  You would like to 
+make anyone who runs your code to suffer database punishing queries and odd security and
+data formatting issues that will make them rue the day they ever learned of computers.
+
+  class MyModel < ActiveRecord::Base
+    sql_column :a_column, "(SELECT count(id) FROM large_list_of_things)", :raw => true
+    sql_column :another_column, '(SELECT count(other_id) FROM other_large_list_of_things WHERE some_column = \'#{some_model_method}\')', :raw => true
+  end
+
+
+== Notes
+
+No tests yet, am lazy.
+
+== Copyright
+
+Copyright (c) 2009 Chris Zelenak. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sql_valued_columns"
+    gem.summary = %Q{Specify values to be inserted into the database as the result of specific SQL functions}
+    gem.email = "netshade@gmail.com"
+    gem.homepage = "http://github.com/netshade/sql_valued_columns"
+    gem.authors = ["netshade"]
+    gem.add_dependency("activerecord", ">= 2.3.2") 
+    gem.files.include "rails/**"
+    gem.description = File.read("README.rdoc")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sql_valued_columns #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/sql_valued_columns.rb

@@ -0,0 +1,80 @@
+module SqlValuedColumns
+  def self.included(base)
+    base.extend(SqlValuedColumns::ClassMethods)
+    base.class_eval {  include SqlValuedColumns::InstanceMethods }
+    base.alias_method_chain(:attributes_with_quotes, :sqlcolumns)    
+  end
+
+  # Includes the SqlValuedColumns module to ActiveRecord, overriding existing value insertion functionality.
+  def self.activate!
+    ActiveRecord::Base.class_eval { include ::SqlValuedColumns }
+  end
+
+  module ClassMethods
+
+    # Indicates the given column will have its value filled by the result of an SQL function.  Pass a hash as the last 
+    # argument with any optional args.
+    #
+    # ==== Arguments
+    # * <tt>column</tt> - +Symbol+, the name of the column to fill
+    # * <tt>function</tt> - +String+, the name of the function to execute, or the literal SQL to call if options[:raw] is true
+    # * <tt>args</tt> - +Array+ of arguments to pass to the SQL function specified.  If an argument is a +Symbol+, the name it 
+    #   represents will be called on the model at save time.  If it is a +Proc+, it will be called with the
+    #   model passed as the only argument to the +Proc+.  If it is a +String+, the +String+ will evaluated if
+    #   the pattern #{some_code} appears within it.  Once all these conditions have been exhausted, the
+    #   resultant values will be quoted as appropriate by your database adapter and populate the arguments
+    #   list of the SQL function you specified.
+    # * <tt>options</tt> (optional) - Hash of optional arguments ( :raw ) .
+    def sql_column(column, function, *args)
+      options = args.extract_options!
+      raw = options[:raw] == true
+      @sql_columns ||= { }
+      @sql_columns[column] = [function, args, raw]
+    end
+
+    def sql_columns
+      @sql_columns ||= { }
+    end
+    
+  end
+
+  module InstanceMethods
+    
+    def attributes_with_quotes_with_sqlcolumns(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
+      h = self.attributes_with_quotes_without_sqlcolumns(include_primary_key, include_readonly_attributes, attribute_names)
+      names = h.keys
+      names.each do |name|
+          if self.class.sql_columns[name]
+            function, args, raw = self.class.sql_columns[name]
+            unless raw 
+              fmt_args = args.collect do |a|
+                case a
+                when Symbol
+                  connection.quote(read_attribute(a.to_s))
+                when Proc
+                  connection.quote(a.call(self))
+                when String
+                  str = a
+                  if a =~ /\#\{[^\}]+\}/
+                    str = val('"' + str + '"')
+                  end
+                  connection.quote(str)
+                else
+                  connection.quote(a)
+                end
+              end
+              h[name] = "#{function}(#{fmt_args.join(",")})"
+            else
+              h[name] = function
+            end
+          end
+      end
+      h
+    end
+    
+  end
+
+
+  
+end
+

data/rails/bootstrap.rb

@@ -0,0 +1 @@
+SqlValuedColumns.activate!

data/sql_valued_columns.gemspec

@@ -0,0 +1,100 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sql_valued_columns}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["netshade"]
+  s.date = %q{2009-05-18}
+  s.description = %q{= sql_valued_columns
+
+SqlValuedColumns is an ActiveRecord plugin that will let you have specific
+SQL statements executed on INSERT / UPDATE.  It will call the SQL function
+you provide, passing the arguments specified in the call to sql_column.
+
+See the documentation for SqlValuedColumns::ClassMethods#sql_column for more 
+information regarding usage, including passing Strings and Proc objects as
+arguments to your SQL function.
+
+Example:  You have a model with two columns, one named "another_column" and 
+the other named "size_of_another_column".  Whenever you insert data into 
+"another_column", you want to have size_of_another_column have the result
+of the SQL function LENGTH inserted into it.
+
+  class MyModel < ActiveRecord::Base
+    sql_column :size_of_another_column, "LENGTH", :another_column
+  end
+
+Example 2:  You have a model with three columns, position, latitude and longitude.
+Latitude and longitude are values expressed as angles, and position is a special
+datatype for your database that represents the X/Y/Z projection of that particular
+latitude and longitude (example: http://www.postgresql.org/docs/8.3/static/earthdistance.html )
+
+When you insert data with latitude and longitude, you want to automatically call a function
+in your database to transform the latitude and longitude into the appropriate represenation.
+
+  class MyModel < ActiveRecord::Base
+    sql_column :position, "ll_to_earth", :latitude, :longitude
+  end
+
+Example 3:  You are an insane criminal who has somehow learned SQL.  You would like to 
+make anyone who runs your code to suffer database punishing queries and odd security and
+data formatting issues that will make them rue the day they ever learned of computers.
+
+  class MyModel < ActiveRecord::Base
+    sql_column :a_column, "(SELECT count(id) FROM large_list_of_things)", :raw => true
+    sql_column :another_column, '(SELECT count(other_id) FROM other_large_list_of_things WHERE some_column = \'#{some_model_method}\')', :raw => true
+  end
+
+
+== Notes
+
+No tests yet, am lazy.
+
+== Copyright
+
+Copyright (c) 2009 Chris Zelenak. See LICENSE for details.
+}
+  s.email = %q{netshade@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sql_valued_columns.rb",
+     "rails/bootstrap.rb",
+     "rails/bootstrap.rb",
+     "sql_valued_columns.gemspec",
+     "test/sql_valued_columns_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/netshade/sql_valued_columns}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Specify values to be inserted into the database as the result of specific SQL functions}
+  s.test_files = [
+    "test/sql_valued_columns_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.2"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.3.2"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.3.2"])
+  end
+end

data/test/sql_valued_columns_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class SqlValuedColumnsTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sql_valued_columns'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: netshade-sql_valued_columns
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- netshade
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: "= sql_valued_columns  SqlValuedColumns is an ActiveRecord plugin that will let you have specific SQL statements executed on INSERT / UPDATE.  It will call the SQL function you provide, passing the arguments specified in the call to sql_column.  See the documentation for SqlValuedColumns::ClassMethods#sql_column for more  information regarding usage, including passing Strings and Proc objects as arguments to your SQL function.  Example:  You have a model with two columns, one named \"another_column\" and  the other named \"size_of_another_column\".  Whenever you insert data into  \"another_column\", you want to have size_of_another_column have the result of the SQL function LENGTH inserted into it.  class MyModel < ActiveRecord::Base sql_column :size_of_another_column, \"LENGTH\", :another_column end  Example 2:  You have a model with three columns, position, latitude and longitude. Latitude and longitude are values expressed as angles, and position is a special datatype for your database that represents the X/Y/Z projection of that particular latitude and longitude (example: http://www.postgresql.org/docs/8.3/static/earthdistance.html )  When you insert data with latitude and longitude, you want to automatically call a function in your database to transform the latitude and longitude into the appropriate represenation.  class MyModel < ActiveRecord::Base sql_column :position, \"ll_to_earth\", :latitude, :longitude end  Example 3:  You are an insane criminal who has somehow learned SQL.  You would like to  make anyone who runs your code to suffer database punishing queries and odd security and data formatting issues that will make them rue the day they ever learned of computers.  class MyModel < ActiveRecord::Base sql_column :a_column, \"(SELECT count(id) FROM large_list_of_things)\", :raw => true sql_column :another_column, '(SELECT count(other_id) FROM other_large_list_of_things WHERE some_column = \\'#{some_model_method}\\')', :raw => true end   == Notes  No tests yet, am lazy.  == Copyright  Copyright (c) 2009 Chris Zelenak. See LICENSE for details."
+email: netshade@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sql_valued_columns.rb
+- rails/bootstrap.rb
+- sql_valued_columns.gemspec
+- test/sql_valued_columns_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/netshade/sql_valued_columns
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Specify values to be inserted into the database as the result of specific SQL functions
+test_files: 
+- test/sql_valued_columns_test.rb
+- test/test_helper.rb