aub-record_filter 0.9.6 → 0.9.7

data/.gitignore

@@ -0,0 +1,9 @@
+coverage
+perf
+pkg
+rdoc
+*.gem
+*.swp
+tmp
+_site
+

data/CHANGELOG

@@ -0,0 +1,207 @@
+= 0.9.7
+
+* Fix a bug where explicit joins would not honor different aliases if joining
+the same class twice.
+
+= 0.9.6
+
+* Build the alias for explicit join tables correctly for multi-word class
+names.
+
+* Set params[:readonly] to false by default. Not sure why we need to do that.
+
+* If nil is passed as the argument to a comparison operator, don't fail with a
+lack of bind variables, just do what AR does and compare against NULL.
+
+* Add ability to order on columns in tables that were explicitly joined.
+
+= 0.9.5
+
+* Added 'and' and 'or' methods to the DSL::Restriction class so that you can do
+things like with(:expired_at).gt(Time.now).or.is_null
+
+= 0.9.4
+
+* Stop forcing order to take a real column name and let it accept a string
+
+* Added an offset method to the DSL so that we can do offsets separately from
+limits
+
+* Some small performance improvements
+
+* Added a test to make sure that the IN restriction can take a range
+
+* Changed the default rake task to run db:spec:prepare first
+
+* Added metric_fu for code quality metrics tests
+
+* Refactored a bunch of code to improve the metric numbers
+
+= 0.9.3
+
+* Fix a bug when using class_name on belongs_to associations without
+foreign_key
+
+= 0.9.2
+
+* Ruby 1.9 compatability
+
+= 0.9.1
+
+* Change group_by so that it will not throw an exception for missing column
+names, since we want to be able to group by arbitrary things.
+
+= 0.9.0 
+
+* Added a github pages page with a quick intro.
+
+* Add tests for working with default scopes.
+
+* de-hackify the default aliases for explicit joins.
+
+* Fix a bug where strings wouldn't work as the names of associations in
+implicit joins.
+
+* Improve the README
+
+* Fix a bug when combining joins across multiple named filters that introduce
+the same join.
+
+= 0.8.0
+
+* Raise an exception when calling order with something that isn't :asc or
+:desc
+
+* Use hanna for spiffy rdocs.
+
+* Raise an exception when attempting to add a named filter to a class if there
+is already an existing filter with the same name.
+
+* Documentation. 
+
+* Refactored the custom DSL subclass creation code into a DSLFactory class.
+
+* Added a (fairly simple) performance test.
+
+* Get source_type option working for has_many.
+
+* Correct hard-coded primary key columns.
+
+= 0.6.0
+
+* 100% test coverage. That's right, 100%.
+
+* Added fixes for various options on AR associations.
+
+* Support calling named filters from within joins in filters.
+
+* Stop using _inheritable_attribute for accessing the named filters and just recurse for
+them.
+
+* Change the tests for named filters to use anonymous classes so that we're
+sure we're starting from a blank slate.
+
+* Make the API work correctly for anonymous classes.
+
+* Correctly handle the case where nil or [] is passed as an argument to the IN
+restriction.
+
+* Added is_not_null as a nicer version of is_null.not
+
+= 0.2.0 
+
+* Changed the available join types to inner, left and right.
+
+* Fix a bug where we used the wrong type in polymorphic association joins.
+
+* Use with_scope when chaining filters, named_filters, and AR associations in
+order to keep the filter data instead of passing the query parameters directly
+and combining them in order to make this work correctly with AR.
+
+* Fix a bug when calling .filter in a chain of associations and named filters.
+
+* Don't include conditions unless there are actually conditions specified.
+
+* Fix a bug where the first and last methods would fail.
+
+* Delegate array methods through to the result of the filter.
+
+* Add proxy_options to mimic the API of named_scope for getting the options
+that result from a given query.
+
+* Support chaining with AR associations... (i.e. Blog.posts.published)
+
+* Support has_many and has_one :through
+
+= 0.1.4
+
+* Join on both the id and type for polymorphic joins.
+
+* Fix a bug where we were using the incorrect table names in joins and
+ordering with joins.
+
+* Change != to the SQL standard <>.
+
+* Fix invalid SQL generated by not_all and not_any.
+
+* Detect count/size/length queries and do the appropriate distinct clause for
+those count queries.
+
+* Do DISTINCT searches for queries that involve specific types of joins.
+
+* Allow passing a join type as the first argument to having.
+
+* Restructured the explicit join API
+
+* Raise exceptions when doing an explicit join using columns that don't exist.
+
+* Allow explicit joins on values: left_join(:class_name, :table_alias, :rcol
+=> 'Post'...)
+
+* Added a filter_class method to the DSL for getting the class that is being
+filtered.
+
+* Added custom join feature: left_join(:table_name, :table_alias, :rcol =>
+:lcol...)
+
+* Changed custom exceptions to subclass StandardError and not crash the entire
+app when throwing one (thanks RailsEnvy).
+
+= 0.1.3
+
+* Fixed a bug in filter.rb when trying to chain to named_scopes or things that
+are otherwise not named_filters.
+
+* Made a named_filters accessor for getting the list of filters that apply to
+a particular class.
+
+* Added none_of and not_all_of conjunctions.
+
+* Changed the between restriction to take either a range, a tuple, or two
+values.
+
+* Support multiple joins in one having statement through having(:posts =>
+:comments)
+
+* Added a CHANGELOG
+
+= 0.1.2
+
+* Add LIKE and NOT LIKE restrictions
+
+* Replace active record objects with their ids if passed as the value for a
+resriction.
+
+= 0.1.1
+
+* Add group_by
+
+* Raise informative exceptions when columns or associations are not found for
+a given filter
+
+* Alias is_null restriction to nil and null
+
+* Alias comparison restrictions to gt, lt, lte, gte
+
+* Add greater_than_or_equal_to and less_than_or_equal_to restrictions.
+

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 9
-:patch: 6
+:patch: 7

data/config/roodi.yml

@@ -0,0 +1,14 @@
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 300 }
+ClassNameCheck:                  { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+CyclomaticComplexityBlockCheck:  { complexity: 4 }
+CyclomaticComplexityMethodCheck: { complexity: 8 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+MethodLineCountCheck:            { line_count: 20 }
+MethodNameCheck:                 { pattern: !ruby/regexp /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ }
+ModuleLineCountCheck:            { line_count: 300 }
+ModuleNameCheck:                 { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+ParameterNumberCheck:            { parameter_count: 5 }
+

data/lib/record_filter/table.rb

@@ -48,21 +48,29 @@ module RecordFilter
     end
 
     def join_class(clazz, join_type, table_alias, conditions)
-      @joins_cache[clazz] ||= 
+      use_alias = table_alias || alias_for_class(clazz)
+      @joins_cache[use_alias] ||= 
         begin
-          join_table = Table.new(clazz, table_alias || alias_for_class(clazz))
+          join_table = Table.new(clazz, use_alias)
           @joins << (join = Join.new(self, join_table, conditions, join_type))
           join
         end
     end
 
-    def find_join(join_key)
-      @joins_cache[join_key]
+    def join_key_for(key)
+      case key
+      when Class then alias_for_class(key)
+      when String, Symbol then key
+      end
+    end
+
+    def find_join(key)
+      @joins_cache[join_key_for(key)]
     end
 
-    def find_join!(join_key)
-      join = find_join(join_key)
-      raise InvalidJoinException.new("The join #{join_key} was not found.") unless join
+    def find_join!(key)
+      join = find_join(key)
+      raise InvalidJoinException.new("The join #{key} was not found.") unless join
       join
     end
 

data/record_filter.gemspec

@@ -0,0 +1,97 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{record_filter}
+  s.version = "0.9.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aubrey Holland", "Mat Brown"]
+  s.date = %q{2009-06-03}
+  s.description = %q{RecordFilter is a Pure-ruby criteria API for building complex queries in ActiveRecord. It supports queries that are built on the fly as well as named filters that can be added to objects and chained to create complex queries. It also gets rid of the nasty hard-coded SQL that shows up in most ActiveRecord code with a clean API that makes queries simple and intuitive to build.}
+  s.email = %q{aubreyholland@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "config/roodi.yml",
+     "lib/record_filter.rb",
+     "lib/record_filter/active_record.rb",
+     "lib/record_filter/column_parser.rb",
+     "lib/record_filter/conjunctions.rb",
+     "lib/record_filter/dsl.rb",
+     "lib/record_filter/dsl/class_join.rb",
+     "lib/record_filter/dsl/conjunction.rb",
+     "lib/record_filter/dsl/conjunction_dsl.rb",
+     "lib/record_filter/dsl/dsl.rb",
+     "lib/record_filter/dsl/dsl_factory.rb",
+     "lib/record_filter/dsl/group_by.rb",
+     "lib/record_filter/dsl/join.rb",
+     "lib/record_filter/dsl/join_condition.rb",
+     "lib/record_filter/dsl/join_dsl.rb",
+     "lib/record_filter/dsl/limit.rb",
+     "lib/record_filter/dsl/named_filter.rb",
+     "lib/record_filter/dsl/order.rb",
+     "lib/record_filter/dsl/restriction.rb",
+     "lib/record_filter/filter.rb",
+     "lib/record_filter/group_by.rb",
+     "lib/record_filter/join.rb",
+     "lib/record_filter/order.rb",
+     "lib/record_filter/query.rb",
+     "lib/record_filter/restriction_factory.rb",
+     "lib/record_filter/restrictions.rb",
+     "lib/record_filter/table.rb",
+     "record_filter.gemspec",
+     "script/console",
+     "spec/active_record_spec.rb",
+     "spec/exception_spec.rb",
+     "spec/explicit_join_spec.rb",
+     "spec/implicit_join_spec.rb",
+     "spec/limits_and_ordering_spec.rb",
+     "spec/models.rb",
+     "spec/named_filter_spec.rb",
+     "spec/proxying_spec.rb",
+     "spec/restrictions_spec.rb",
+     "spec/select_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/test.db",
+     "tasks/db.rake",
+     "tasks/rcov.rake",
+     "tasks/spec.rake",
+     "test/performance_test.rb",
+     "test/test.db"
+  ]
+  s.homepage = %q{http://github.com/aub/record_filter/tree/master}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{An ActiveRecord query API for replacing SQL with awesome}
+  s.test_files = [
+    "spec/active_record_spec.rb",
+     "spec/exception_spec.rb",
+     "spec/explicit_join_spec.rb",
+     "spec/implicit_join_spec.rb",
+     "spec/limits_and_ordering_spec.rb",
+     "spec/models.rb",
+     "spec/named_filter_spec.rb",
+     "spec/proxying_spec.rb",
+     "spec/restrictions_spec.rb",
+     "spec/select_spec.rb",
+     "spec/spec_helper.rb",
+     "test/performance_test.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
+    else
+    end
+  else
+  end
+end

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'spec', 'spec_helper')
+
+require 'logger'
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+IRB.start

data/spec/explicit_join_spec.rb

@@ -104,4 +104,29 @@ describe 'explicit joins' do
       @blog.last_find[:joins].should == [%q(INNER JOIN "ads" AS blogs__ads ON "blogs".id = blogs__ads.blog_id), %q(LEFT OUTER JOIN "posts" AS blogs__post ON "blogs".id = blogs__post.blog_id), %q(INNER JOIN "comments" AS blogs__post__comment ON blogs__post.id = blogs__post__comment.post_id AND (blogs__post__comment.offensive = 't'))]
     end
   end
+
+  describe 'using the same join multiple times' do
+    before do
+      @blog = Class.new(Blog)
+      @blog.named_filter(:things) do
+        join(Post, :inner, 'blogs_posts_1') do
+          on(:id => :blog_id)
+          with(:title, 'ack')
+        end
+        join(Post, :inner, 'blogs_posts_2') do
+          on(:id => :blog_id)
+          with(:title, 'hmm')
+        end
+      end
+      @blog.things.inspect
+    end
+
+    it 'should create the correct join' do
+      @blog.last_find[:joins].should == [%q(INNER JOIN "posts" AS blogs_posts_1 ON "blogs".id = blogs_posts_1.blog_id), %q(INNER JOIN "posts" AS blogs_posts_2 ON "blogs".id = blogs_posts_2.blog_id)] 
+    end
+
+    it 'should create the correct conditions' do
+      @blog.last_find[:conditions].should == [%q((blogs_posts_1.title = ?) AND (blogs_posts_2.title = ?)), 'ack', 'hmm'] 
+    end
+  end
 end

data/tasks/db.rake

@@ -0,0 +1,106 @@
+namespace :db do
+  namespace :spec do
+    desc 'drop database and recreate from test schema'
+    task :prepare do
+      require File.join(File.dirname(__FILE__), '..', 'spec', 'spec_helper')
+
+      db_file = File.join(File.dirname(__FILE__), '..', 'spec', 'test.db')
+
+      FileUtils.rm(db_file) if File.exists?(db_file)
+
+      ActiveRecord::Schema.define do
+
+        create_table :ads do |t|
+          t.integer :blog_id
+          t.string :content
+        end
+
+        create_table :articles do |t|
+          t.string :contents
+          t.timestamps
+        end
+
+        create_table :assets do |t|
+          t.timestamps
+          t.string :format
+        end
+
+        create_table :asset_attachments do |t|
+          t.integer :to_id
+          t.string  :to_type
+          t.integer :from_id
+        end
+
+        create_table :authors do |t|
+          t.references :post
+          t.string :nickname
+          t.references :user
+        end
+
+        create_table :blogs do |t|
+          t.string :name
+          t.boolean :published
+          t.integer :special_id
+          t.timestamps
+        end
+
+        create_table :comments do |t|
+          t.references :post
+          t.references :user
+          t.string :contents
+          t.boolean :offensive
+          t.timestamps
+        end
+
+        create_table :features do |t|
+          t.references :blog
+          t.integer :featurable_id
+          t.string :featurable_type
+          t.integer :priority
+        end
+
+        create_table :news_stories do |t|
+          t.references :blog
+          t.string :permalink
+          t.text :contents
+        end
+
+        create_table :photos do |t|
+          t.integer :post_id
+          t.string :path
+          t.string :format
+        end
+
+        create_table :posts do |t|
+          t.integer :blog_id
+          t.integer :special_blog_id
+          t.string :permalink
+          t.timestamp :created_at
+          t.boolean :published
+          t.string :content
+          t.string :title
+        end
+
+        create_table :posts_tags, :id => false do |t|
+          t.integer :post_id
+          t.integer :tag_id
+        end
+
+        create_table :reviews do |t|
+          t.integer :reviewable_id
+          t.string :reviewable_type
+          t.integer :stars_count
+        end
+
+        create_table :tags do |t|
+          t.string :name
+        end
+
+        create_table :users do |t|
+          t.string :first_name
+          t.string :last_name
+        end
+      end
+    end
+  end
+end

data/tasks/rcov.rake

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+desc 'run specs with rcov'
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_dir = File.join('coverage', 'all')
+  t.rcov_opts.concat(['--exclude', 'spec', '--sort', 'coverage', '--only-uncovered'])
+end

data/tasks/spec.rake

@@ -0,0 +1,10 @@
+gem 'rspec', '~>1.1'
+
+require 'spec'
+require 'spec/rake/spectask'
+
+desc 'run specs'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList[File.join(File.dirname(__FILE__), '..', 'spec', '**', '*_spec.rb')]
+  t.spec_opts = ['--color']
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aub-record_filter
 version: !ruby/object:Gem::Version 
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors: 
 - Aubrey Holland
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 -07:00
+date: 2009-06-03 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -23,9 +23,12 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
+- CHANGELOG
 - README.rdoc
 - Rakefile
 - VERSION.yml
+- config/roodi.yml
 - lib/record_filter.rb
 - lib/record_filter/active_record.rb
 - lib/record_filter/column_parser.rb
@@ -52,6 +55,8 @@ files:
 - lib/record_filter/restriction_factory.rb
 - lib/record_filter/restrictions.rb
 - lib/record_filter/table.rb
+- record_filter.gemspec
+- script/console
 - spec/active_record_spec.rb
 - spec/exception_spec.rb
 - spec/explicit_join_spec.rb
@@ -64,9 +69,12 @@ files:
 - spec/select_spec.rb
 - spec/spec_helper.rb
 - spec/test.db
+- tasks/db.rake
+- tasks/rcov.rake
+- tasks/spec.rake
 - test/performance_test.rb
 - test/test.db
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/aub/record_filter/tree/master
 post_install_message: 
 rdoc_options: