sql_record 0.1.2 → 0.2.0

data/Gemfile

@@ -6,6 +6,7 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem "rdoc"
   gem "rspec", "~> 2.3.0"
   gem "yard", "~> 0.6.0"
   gem "bundler", "~> 1.0.0"

data/Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       rake
     rake (0.8.7)
     rcov (0.9.9)
+    rdoc (3.5.3)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
       rspec-expectations (~> 2.3.0)
@@ -26,5 +27,6 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler (~> 1.5.2)
   rcov
+  rdoc
   rspec (~> 2.3.0)
   yard (~> 0.6.0)

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 vWorkApp
+Copyright (c) 2011 Visfleet Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -8,17 +8,15 @@ Well that's what SQLRecord does.
 
 == Example
 
-    class UserWithAccount
-      include SQLRecord
+    class UserWithAccount << SQLRecord::Base
 
-
-      with_class User do
+      with_opts :class => User do
         column :id
         column :user_email, :from => :email
         column :created_at
       end
 
-      with_class Account do
+      with_opts :class => Account do
         column :account_name, :from => :name
       end
 
@@ -44,6 +42,10 @@ Well that's what SQLRecord does.
     => Time
 
 
+== Contributers
+
+Thanks to {Loren Segal}[http://gnuu.org] for the big code review, and making me aware that sound OO principles are not dead in ruby.
+
 == Contributing to sql-record
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/Rakefile

@@ -16,12 +16,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/visfleet/sql_record"
   gem.license = "MIT"
   gem.summary = %Q{SQL direct mapping to ActiveRecord}
-  gem.description = %Q{Do you use ActiveRecord::Connection.execute for speed sometimes?
-
-Does it bother you that the results are not mapped to your schema and type-cast as ActiveRecord would?
-
-Well that's what SQLRecord does.
-}
+  gem.description = %Q{Do you use ActiveRecord::Connection.execute for speed sometimes? Does it bother you that the results are not mapped to your schema and type-cast as ActiveRecord would? Well that's what SQLRecord does.}
   gem.email = "rasheed@visfleet.com"
   gem.authors = ["Rasheed Abdul-Aziz"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/sql_record/attributes/mapper.rb

@@ -0,0 +1,68 @@
+# @author Rasheed Abdul-Aziz
+module SQLRecord
+  module Attributes
+    module Mapper
+
+      attr_reader :sql_select_columns
+
+      # with_opts blocks specify default options for calls to {#column}
+      #
+      # @param opts [Hash] anything that {#column} supports. Currently this should only be :class
+      #
+      # @example Longhand (not using with_opts)
+      #   column :name, :class => Account
+      #   column :id, :class => Account
+      #   ...snip...
+      #   column :created_at, :class => Account
+      #
+      # @example Shorthand (using with_opts)
+      #   with_opts :class => Account
+      #     column :name
+      #     column :id
+      #     ...snip...
+      #     column :created_at
+      #   end
+      #
+      def with_opts opts, &block
+        @default_opts = opts
+        block.arity == 2 ? yield(self) : self.instance_eval(&block)
+        @default_opts = nil
+      end
+
+      # Specifies the mapping from an ActiveRecord#column_definition to an SQLRecord instance attribute.
+      # @param [Symbol] attribute_name the attribute you are defining for this model
+      # @option opts [Class] :class the active record this attribute will use to type_cast from
+      # @option opts [Symbol,String] :from if it differs from the attribute_name, the schema column of the active record
+      #   to use for type_cast
+      #
+      # @example Simple mapping
+      #   # Account#name column maps to the "name" attribute
+      #   column :name, :class => Account
+      #
+      # @example Mapping a different column name
+      #   # Account#name column maps to the "account name" attribute
+      #   column :account_name, :class => Account, :from => :name
+      #
+      def column attribute_name, opts = {}
+        klass = opts[:class] || @default_opts[:class] || nil
+        raise ArgumentError, 'You must specify a :class option, either explicitly, or using with_opts' if klass.nil?
+
+        source_attribute = (opts[:from] || attribute_name).to_s
+
+        define_method attribute_name do
+          klass.columns_hash[source_attribute].type_cast(@raw_attributes[attribute_name.to_s])
+        end
+
+        # bit mucky, a lot here that feels like it should be a little method of its own
+        select_column = "#{klass.table_name}.#{source_attribute}"
+        select_column += " as #{attribute_name}" if opts[:from]
+        (@sql_select_columns ||= []) << select_column
+      end
+
+      def sql_select_helper
+         @sql_select_columns.join(', ')
+      end
+
+    end
+  end
+end

data/lib/sql_record/base.rb

@@ -0,0 +1,19 @@
+module SQLRecord
+  # Base provides a class that has a collection of raw_attributes.
+  # These can be set from a database abstraction (SQLRecord::SanitizedQuery), and are expected to be type_cast by a mixin
+  #   (SQLRecord::Attributes::Mapper)
+  #
+  # @todo Does it sound like the database abstraction could be a whole other class?
+  class Base
+    extend SQLRecord::SanitizedQuery
+    extend SQLRecord::Attributes::Mapper
+
+    # the raw attributes returned from a db query
+    attr_accessor :raw_attributes
+
+    def initialize raw_attributes = {}
+      @raw_attributes = raw_attributes
+    end
+
+  end
+end

data/lib/sql_record/sanitized_query.rb

@@ -0,0 +1,31 @@
+module SQLRecord
+  module SanitizedQuery
+    # Executes the {#query} proc on your database, building SQLRecords with the results.
+    # @param params [Hash] a hash of parameters that are yielded to the {#query} proc
+    # @return [Array] {SQLRecord::Base}s with their raw_attributes set to the row results.
+    def find params={}
+      rows = execute_query params
+
+      rows.map do |row|
+        new row
+      end
+    end
+
+    def query &deferred
+      @query_proc = deferred
+    end
+
+    protected
+
+    # @todo check that this logs the sql
+    def execute_query params={}
+      sql = ActiveRecord::Base.send(:sanitize_sql_array, get_query_array(params))
+      ActiveRecord::Base.connection.execute(sql)
+    end
+
+    def get_query_array(params)
+        @query_proc.call(params)
+    end
+
+  end
+end

data/lib/sql_record.rb

@@ -1,65 +1,3 @@
-module SQLRecord
-
-	def initialize(row)
-		@row = row
-	end
-
-	def self.included(base)
-		base.extend ClassMethods
-	end
-
-	module ClassMethods
-
-		def with_class klass, &block
-			@current_class = klass
-			block.arity == 2 ? yield(self) : self.instance_eval(&block)
-			@current_class = nil
-		end
-
-		def column attribute_name, opts = {}
-			klass = opts[:class] || @current_class || nil
-			raise ArgumentError, 'Either opts[:class] is not defined or you have not specified a with_class block' if klass.nil?
-
-			source_attribute = (opts[:from] || attribute_name).to_s
-
-			define_method attribute_name do
-				klass.columns_hash[source_attribute].type_cast(@row[attribute_name.to_s])
-			end
-
-			# bit mucky, a lot here that feels like it should be a little method of its own
-			select_column = "#{klass.table_name}.#{source_attribute}"
-			select_column += " as #{attribute_name}" if opts[:from]
-			(@sql_select_columns ||= []) << select_column
-		end
-
-		def query &deferred
-			@query_proc = deferred
-		end
-
-		def find params={}
-			rows = execute_query params
-
-			rows.map do |row|
-				new row
-			end
-		end
-
-		protected
-
-		def execute_query params={}
-			# does this log?
-			sql = ActiveRecord::Base.send(:sanitize_sql_array, get_query_array(params))
-			ActiveRecord::Base.connection.execute(sql)
-		end
-
-		def get_query_array(params)
-			if @query_proc.arity == 2
-				@query_proc.call(params, @sql_select_columns.join(", "))
-			else
-				@query_proc.call(params)
-			end
-		end
-
-	end
-
-end
+require 'sql_record/sanitized_query'
+require 'sql_record/attributes/mapper'
+require 'sql_record/base'

data/spec/spec_helper.rb

@@ -5,8 +5,8 @@ require 'sql-record'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-  
+
 end

data/sql_record.gemspec

@@ -5,17 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sql_record}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rasheed Abdul-Aziz"]
-  s.date = %q{2011-04-07}
-  s.description = %q{Do you use ActiveRecord::Connection.execute for speed sometimes?
-
-Does it bother you that the results are not mapped to your schema and type-cast as ActiveRecord would?
-
-Well that's what SQLRecord does.
-}
+  s.date = %q{2011-04-08}
+  s.description = %q{Do you use ActiveRecord::Connection.execute for speed sometimes? Does it bother you that the results are not mapped to your schema and type-cast as ActiveRecord would? Well that's what SQLRecord does.}
   s.email = %q{rasheed@visfleet.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -32,6 +27,9 @@ Well that's what SQLRecord does.
     "VERSION",
     "init.rb",
     "lib/sql_record.rb",
+    "lib/sql_record/attributes/mapper.rb",
+    "lib/sql_record/base.rb",
+    "lib/sql_record/sanitized_query.rb",
     "spec/spec_helper.rb",
     "spec/sql_record_spec.rb",
     "sql_record.gemspec"
@@ -50,12 +48,14 @@ Well that's what SQLRecord does.
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -63,6 +63,7 @@ Well that's what SQLRecord does.
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sql_record
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rasheed Abdul-Aziz
@@ -15,12 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 +00:00
+date: 2011-04-08 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rdoc
   version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -33,10 +47,10 @@ dependencies:
         version: 2.3.0
   prerelease: false
   type: :development
-  requirement: *id001
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,10 +63,10 @@ dependencies:
         version: 0.6.0
   prerelease: false
   type: :development
-  requirement: *id002
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
   name: bundler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,10 +79,10 @@ dependencies:
         version: 1.0.0
   prerelease: false
   type: :development
-  requirement: *id003
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,10 +95,10 @@ dependencies:
         version: 1.5.2
   prerelease: false
   type: :development
-  requirement: *id004
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   name: rcov
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -95,14 +109,8 @@ dependencies:
         version: "0"
   prerelease: false
   type: :development
-  requirement: *id005
-description: |
-  Do you use ActiveRecord::Connection.execute for speed sometimes?
-  
-  Does it bother you that the results are not mapped to your schema and type-cast as ActiveRecord would?
-  
-  Well that's what SQLRecord does.
-
+  requirement: *id006
+description: Do you use ActiveRecord::Connection.execute for speed sometimes? Does it bother you that the results are not mapped to your schema and type-cast as ActiveRecord would? Well that's what SQLRecord does.
 email: rasheed@visfleet.com
 executables: []
 
@@ -122,6 +130,9 @@ files:
 - VERSION
 - init.rb
 - lib/sql_record.rb
+- lib/sql_record/attributes/mapper.rb
+- lib/sql_record/base.rb
+- lib/sql_record/sanitized_query.rb
 - spec/spec_helper.rb
 - spec/sql_record_spec.rb
 - sql_record.gemspec