pose 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1059e7c72d577be6f7d5f3c0fc4fdc30b429bd4b
-  data.tar.gz: d0ed2c994af2326ec73a779b0fb61a44dca2602b
+  metadata.gz: 8db9b6071e06f6087a846679cdc670014c529912
+  data.tar.gz: 4a26e6c1f7eb94095ce043c0988bf52f2837042a
 SHA512:
-  metadata.gz: a9eb63377caee2f07d3e7c9118ee9715d9e386371ca766aeb35b98eabe8d76f2d2128a27188ce71dd5f05c61e8bc46dc9726a351278392fc478dcb38aeeb44f6
-  data.tar.gz: 28e599e762c76d35070e5d81c71c9b7069270dbd3f1da463db8eb1f6f546830062da027e6eb47a794d85efa475680f66052e7c8373462bbcbdb9b9b0bbd2d37f
+  metadata.gz: 3d3408a071bf09401875d1dfa9361d3c7957a83e922097301522e53471bdf94de90498a723ba4458de211620732c2bcdfbb369688ba6881d46e28d2176e14007
+  data.tar.gz: 77f315779994035ec62b32015d9030aa8a95684526d184c1584466cc331bc8b19c8dc47762126bb571e40d901d5d421d7e9ec1096faad4b22f46a08ea285134f

data/README.md

@@ -191,6 +191,22 @@ result = Pose.search 'foo',
 Combining ActiveRecord query clauses with fulltext search only works when searching over a single class.
 
 
+### Customize the SELECT clause with which results are loaded
+
+This feature only makes sense if you load one result class.
+It allows to only read the given set of attributes from the database.
+The only use case for this is performance optimization.
+
+```ruby
+result = Pose.search 'foo',
+                     Note,
+                     select: 'id, text'
+```
+
+This query returns all Notes that have 'foo' in their text, but loads only their
+`id` and `text` attributes from the database.
+
+
 ## Maintenance
 
 Besides an accasional search index cleanup, Pose is relatively maintenance free.

data/lib/pose/query.rb

@@ -22,7 +22,7 @@ module Pose
     # The names of the classes to search in.
     # @return [Array<String>]
     def class_names
-      classes.map &:name
+      classes.map(&:name)
     end
 
 
@@ -38,6 +38,11 @@ module Pose
     end
 
 
+    # Returns whether this query has a custom SELECT clause.
+    def has_select
+      @options[:select].present?
+    end
+
     # Returns whether this query contains WHERE clauses.
     def has_where?
       @options[:where].present?

data/lib/pose/search.rb

@@ -10,6 +10,7 @@ module Pose
     # @param options Additional search options:
     #    * where: additional where clauses
     #    * join: additional join clauses
+    #    * select: custom select clause
     def initialize classes, query_string, options = {}
       @query = Query.new classes, query_string, options
     end
@@ -68,6 +69,9 @@ module Pose
       result.each do |clazz, ids|
         if ids.size > 0
           result[clazz] = clazz.where(id: ids)
+          if @query.has_select
+            result[clazz] = result[clazz].select(@query.options[:select])
+          end
         end
       end
     end

data/lib/pose/version.rb

@@ -1,3 +1,3 @@
 module Pose
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/spec/lib/pose/query_spec.rb

@@ -39,31 +39,31 @@ module Pose
     describe 'is_url?' do
 
       it 'returns TRUE if the given string is a URL' do
-        expect(Query.is_url? 'http://web.com').to be_true
+        expect(Query.is_url? 'http://web.com').to be_truthy
       end
 
       it 'returns TRUE if the given string is localhost' do
-        expect(Query.is_url? 'http://localhost').to be_true
+        expect(Query.is_url? 'http://localhost').to be_truthy
       end
 
       it 'returns TRUE if localhost has a port' do
-        expect(Query.is_url? 'http://localhost:3000').to be_true
+        expect(Query.is_url? 'http://localhost:3000').to be_truthy
       end
 
       it 'returns TRUE if the given url has a port' do
-        expect(Query.is_url? 'http://web.com:8080').to be_true
+        expect(Query.is_url? 'http://web.com:8080').to be_truthy
       end
 
       it 'returns TRUE if the given string is a HTTPS URL' do
-        expect(Query.is_url? 'https://web.com').to be_true
+        expect(Query.is_url? 'https://web.com').to be_truthy
       end
 
       it 'returns FALSE if the given string is not a URL' do
-        expect(Query.is_url? 'foo').to be_false
+        expect(Query.is_url? 'foo').to be_falsy
       end
 
       it 'returns FALSE if the given string is a malformed URL' do
-        expect(Query.is_url? 'http://web').to be_false
+        expect(Query.is_url? 'http://web').to be_falsy
       end
     end
 

data/spec/lib/pose/search_spec.rb

@@ -120,7 +120,9 @@ module Pose
 
 
     describe :load_classes do
+
       context 'when the user wants ids' do
+
         it 'does nothing' do
           search = Search.new nil, nil, result_type: :ids
           result = { PosableOne => [1, 2] }
@@ -130,6 +132,7 @@ module Pose
       end
 
       context 'when the user wants classes' do
+
         it 'loads the classes' do
           object_1 = create :posable_one
           object_2 = create :posable_one
@@ -139,6 +142,23 @@ module Pose
           expect(result[PosableOne]).to eq [object_1, object_2]
         end
       end
+
+      context 'when the user specifies a select clause' do
+
+        it 'loads only the specified attributes' do
+          object_1 = create :posable_one
+          object_2 = create :posable_one
+          result = { PosableOne => [object_1.id, object_2.id] }
+          search = Search.new nil, nil, select: 'id'
+          search.load_classes result
+          expect(result[PosableOne][0].id).to eq object_1.id
+          expect(result[PosableOne][0].attribute_present? :text).to be_falsy
+          expect(result[PosableOne][0].attribute_present? :id).to be_truthy
+          expect(result[PosableOne][1].id).to eq object_2.id
+          expect(result[PosableOne][1].attribute_present? :text).to be_falsy
+          expect(result[PosableOne][1].attribute_present? :id).to be_truthy
+        end
+      end
     end
 
 

data/spec/pose_api_spec.rb

@@ -286,6 +286,24 @@ module Pose
 
         it 'allows to load data from joined tables'
       end
+
+
+      describe ':select parameter' do
+
+        before :each do
+          @one = create :posable_one, text: 'snippet one', user: @user_1
+          @two = create :posable_one, text: 'snippet two', user: @user_2
+        end
+
+        it 'makes Pose load only the given fields' do
+          result = Pose.search 'snippet',
+                               PosableOne,
+                               { select: 'id' }
+          first_result = result[PosableOne].first
+          expect(first_result.id).to eq @one.id
+          expect(first_result.attribute_present? :text).to be_falsy
+        end
+      end
     end
 
 
@@ -325,19 +343,19 @@ module Pose
 
       it 'recognizes mysql databases' do
         ActiveRecord::Base.connection.class.stub(:name).and_return 'ActiveRecord::ConnectionAdapters::Mysql2Adapter'
-        expect(Pose.has_sql_connection?).to be_true
+        expect(Pose.has_sql_connection?).to be_truthy
         ActiveRecord::Base.connection.class.stub(:name).and_return 'ActiveRecord::ConnectionAdapters::MysqlAdapter'
-        expect(Pose.has_sql_connection?).to be_true
+        expect(Pose.has_sql_connection?).to be_truthy
       end
 
       it 'recognizes postgres databases' do
         ActiveRecord::Base.connection.class.stub(:name).and_return 'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'
-        expect(Pose.has_sql_connection?).to be_true
+        expect(Pose.has_sql_connection?).to be_truthy
       end
 
       it 'recognizes sqlite3 databases' do
         ActiveRecord::Base.connection.class.stub(:name).and_return 'ActiveRecord::ConnectionAdapters::SQLite3Adapter'
-        expect(Pose.has_sql_connection?).to be_true
+        expect(Pose.has_sql_connection?).to be_truthy
       end
     end
   end

data/spec/spec_helper.rb

@@ -6,6 +6,8 @@ end
 require 'factory_girl'
 require 'faker'
 require 'pose'
+require 'rspec/its'
+require 'rspec/collection_matchers'
 
 Dir["#{File.dirname __FILE__}/factories/**/*.rb"].each {|f| require f}
 Dir["#{File.dirname __FILE__}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pose
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement