search_object 0.1 → 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc173628e2536b5964d951dbf6dd41b193cd52b8
+  data.tar.gz: 82b714d47dc48c540c64503589d50872f9156446
+SHA512:
+  metadata.gz: e3e9f0fae74e4a5a6d620c6f6db1f8fbc744ac85bc918b98ed30c2c91920b06d7213c94af0f1fb823e54ea681c162018db4c0073513f60e8eec11ade31db443d
+  data.tar.gz: 4c5fed9dc2f8dae633b1cf8507ff66a79c620e356bdde2a9ebddcc455256ecf49823acc93cf2e9f4d24e8fc76fcea05d064e902707a6f88f67f2a5768a9d01d4

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0
-  - rbx-19mode
+  - 2.1
 script: bundle exec rspec spec
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Version 0.2
+
+* Added `.results` shortcut for `new(*arg).results`
+
+* Fix wrong limit and offset in default paging
+
 ## Version 0.1
 
-* initial release
+* Initial release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Radoslav Stankov
+Copyright (c) 2013-2014 Radoslav Stankov
 
 MIT License
 

data/README.md

@@ -1,16 +1,19 @@
+[![Gem Version](https://badge.fury.io/rb/search_object.png)](http://badge.fury.io/rb/search_object)
 [![Code Climate](https://codeclimate.com/github/RStankov/SearchObject.png)](https://codeclimate.com/github/RStankov/SearchObject)
 [![Build Status](https://secure.travis-ci.org/RStankov/SearchObject.png)](http://travis-ci.org/RStankov/SearchObject)
 [![Code coverage](https://coveralls.io/repos/RStankov/SearchObject/badge.png?branch=master)](https://coveralls.io/r/RStankov/SearchObject)
 
 # SearchObject
 
-In many of my projects I've needed an object that performs several fairly complicated queries. Or, just some multi-field search forms. Most times I hand-coded them, but they would get complicated over time when other concerns were added like sorting, pagination and so on. So I decided to abstract this away and created ```SearchObject```, a DSL for creating such objects.
+In many of my projects I needed an object that performs several fairly complicated queries. Or, just some multi-field search forms. Most times I hand-coded them, but they would get complicated over time when other concerns were added like sorting, pagination and so on. So I decided to abstract this away and created ```SearchObject```, a DSL for creating such objects.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'search_object'
+```ruby
+gem 'search_object'
+```
 
 And then execute:
 
@@ -52,13 +55,13 @@ search.results?                    # => is there any results found
 search.results                     # => found results
 
 # params for url generations
-search.params                     # => option values
-search.params opened: false       # => overwrites the 'opened' option
+search.params                      # => option values
+search.params opened: false        # => overwrites the 'opened' option
 ```
 
 ## Example
 
-You can find example of most imporatant features and plugins - [here](https://github.com/RStankov/SearchObject/tree/master/example).
+You can find example of most important features and plugins - [here](https://github.com/RStankov/SearchObject/tree/master/example).
 
 ## Plugins
 
@@ -68,7 +71,7 @@ Plugins are just plain Ruby modules, which are included with ```SearchObject.mod
 
 ### Paginate plugin
 
-Really simple paginte plugin, which uses the plain ```.limit``` and ```.offset``` methods.
+Really simple paginate plugin, which uses the plain ```.limit``` and ```.offset``` methods.
 
 ```ruby
 class ProductSearch
@@ -113,7 +116,8 @@ end
 ```
 
 ```erb
-# in some view:
+<%# in some view: %>
+
 <%= form_for ProductSearch.new do |form| %>
   <% form.label :name %>
   <% form.text_field :name %>
@@ -168,7 +172,7 @@ end
 
 # first arguments is treated as scope (if no scope option is provided)
 search = ProductSearch.new(Product.visible, params[:f])
-search.results #=> products
+search.results # => products
 ```
 
 

data/lib/search_object/base.rb

@@ -10,7 +10,7 @@ module SearchObject
     end
 
     def initialize(*args)
-      @search = self.class.search args
+      @search = self.class.build_internal_search args
     end
 
     def results
@@ -40,7 +40,8 @@ module SearchObject
     end
 
     module ClassMethods
-      def search(args)
+      # :api: private
+      def build_internal_search(args)
         scope  = (@scope && @scope.call) || args.shift
         params = @defaults.merge(Helper.select_keys Helper.stringify_keys(args.shift || {}), @actions.keys)
 
@@ -59,6 +60,10 @@ module SearchObject
 
         define_method(name) { @search.param name }
       end
+
+      def results(*args)
+        new(*args).results
+      end
     end
   end
 end

data/lib/search_object/plugin/paging.rb

@@ -25,7 +25,7 @@ module SearchObject
       end
 
       def apply_paging(scope)
-        scope.limit(page * per_page).offset(per_page)
+        scope.limit(per_page).offset(page * per_page)
       end
 
       module ClassMethods

data/lib/search_object/version.rb

@@ -1,3 +1,3 @@
 module SearchObject
-  VERSION = '0.1'
+  VERSION = '0.2'
 end

data/search_object.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'activerecord', '>= 3.0.0'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'active_model_lint-rspec'
   spec.add_development_dependency 'will_paginate'
   spec.add_development_dependency 'kaminari'
 end

data/spec/search_object/base_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 module SearchObject
   describe Base do
-    def new_search(default_scope = [], filters = {}, &block)
-      search_class = Class.new do
+    def search_class(default_scope = [], &block)
+      Class.new do
         include SearchObject.module
 
         scope { default_scope }
@@ -16,8 +16,10 @@ module SearchObject
           class_eval &block
         end
       end
+    end
 
-      search_class.new filters
+    def new_search(default_scope = [], filters = {}, &block)
+      search_class(default_scope, &block).new filters
     end
 
     it "can had its #initialize method overwritten" do
@@ -129,6 +131,13 @@ module SearchObject
       end
     end
 
+    describe ".results" do
+      it "shortcut for creating new search and immediately returning results" do
+        klass = search_class [1 ,2 ,3]
+        expect(klass.results(value: 1)).to eq [1]
+      end
+    end
+
     describe "#results" do
       it "returns only the filtered search results" do
         search = new_search [1 ,2 ,3], value: 1

data/spec/search_object/plugin/model_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-require 'active_model_lint-rspec'
+require 'active_model/lint'
 
 module SearchObject
   module Plugin
@@ -8,15 +8,31 @@ module SearchObject
       include SearchObject.module(:model)
 
       # Fake errors
-      # Since SearchObject is focused to plain search forms,
-      # which don't have validation most of the time
+      # Since SearchObject is focused on plain search forms,
+      # validations are not needed most of the time
       def errors
         Hash.new([])
       end
     end
 
     describe ExtendedModel do
-      it_behaves_like 'an ActiveModel'
+      include ActiveModel::Lint::Tests
+
+      before do
+        @model = subject
+      end
+
+      def assert(condition, message = nil)
+        expect(condition).to be_true, message
+      end
+
+      def assert_kind_of(expected_kind, object, message = nil)
+        expect(object).to be_kind_of(expected_kind), message
+      end
+
+      ActiveModel::Lint::Tests.public_instance_methods.map { |method| method.to_s }.grep(/^test/).each do |method|
+        example(method.gsub('_', ' ')) { send method }
+      end
     end
   end
 end

metadata

@@ -1,174 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: search_object
 version: !ruby/object:Gem::Version
-  version: '0.1'
-  prerelease: 
+  version: '0.2'
 platform: ruby
 authors:
 - Radoslav Stankov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.3
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: active_model_lint-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Search object DSL
@@ -178,9 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -250,33 +215,26 @@ files:
 homepage: https://github.com/RStankov/SearchObject
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2271564720281692758
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2271564720281692758
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides DSL for creating search objects
 test_files:
 - spec/search_object/base_spec.rb
@@ -290,3 +248,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/spec_helper_active_record.rb
 - spec/support/kaminari_setup.rb
+has_rdoc: