sunspot_stats 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sunspot_stats.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Duccio Giovannelli
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# Sunspot Stats
+
+Sunspot is a Ruby library for expressive, powerful interaction with the Solr search engine. I use the latest version [2.0.0.pre.120417](https://rubygems.org/gems/sunspot/versions/2.0.0.pre.120417) but i need the statsComponent in order to get the sum on a given indexed field. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sunspot_stats'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sunspot_stats
+
+## Usage
+
+The statComponent let you to have *min*, *max*, *count*, *missing*, *sum*, *sumOfsquare*, *mean* and *stdev*.
+
+### An usage example
+
+```ruby
+Model.search do
+  #Filters
+	...
+  #Facets
+  ...
+	#Stats
+  stat(:your_field, :facet => :your_facet_filed, :type => "min")  
+  ...
+end
+```
+
+**:facet** and **:type** are optional the default type is the "sum" (you can pass: *min*, *max*, *count*, *missing*, *sum*, *sumOfsquare*, *mean*, *stdev* as string)
+
+Remember to stats on a non multi valued field and update to the solr3.6, because the solr3.5 has a bug with stats.
+
+the Sunspot::SearchStatRow has the method *stat_field* and the *value*. 
+
+If you enable faceting on stats the stat_field is the facet and the value is the type defined.
+
+[Upgrade solr in sunspot](https://github.com/sunspot/sunspot/wiki/Upgrading-sunspot_solr-Solr-Instance) 
+
+### Boolean Searches
+
+Usually Suspot use the dismax for searches, here we extend to edismax to manage also boolean logic searches
+
+a OR (b AND c) works.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/dsl/field_query.rb

@@ -0,0 +1,22 @@
+module Sunspot
+  module DSL
+    # 
+    # Provides an API for areas of the query DSL that operate on specific
+    # fields. This functionality is provided by the query DSL and the dynamic
+    # query DSL.
+    #
+    class FieldQuery < Scope
+      def initialize(search, query, setup) #:nodoc:
+        @search, @query = search, query
+        super(query.scope, setup)
+      end
+
+      def stat(field_name, options = {})
+        field = @setup.field(field_name)
+        options[:facet] = @setup.field(options[:facet]) if options[:facet].present?
+        stat = @query.add_stat(Sunspot::Query::FieldStat.new(field, options))
+        @search.add_field_stat(field, options)
+      end
+    end    
+  end
+end

data/lib/edismax.rb

@@ -0,0 +1,20 @@
+OriginalDismax = Sunspot::Query::Dismax
+
+class PatchedDismax < OriginalDismax
+
+  def to_params
+    params = super
+    params[:defType] = 'edismax'
+    params
+  end
+
+  def to_subquery
+    query = super
+    query = query.sub '{!dismax', '{!edismax'
+    query
+  end
+
+end
+
+Sunspot::Query.send :remove_const, :Dismax
+Sunspot::Query::Dismax = PatchedDismax

data/lib/query/field_stat.rb

@@ -0,0 +1,31 @@
+module Sunspot
+  module Query
+    #
+    # A FieldStat stats by the unique values of a given field.
+    #
+    class FieldStat
+
+      def initialize(field, options = {})
+        if field.multiple?
+          raise(ArgumentError, "#{field.name} cannot be used for stats because it is a multiple-value field")
+        end
+        @field = field
+        @options = options
+        @sort = SortComposite.new
+      end
+
+      def add_sort(sort)
+        @sort << sort
+      end
+
+      def to_params
+        params = {
+          :stats  => 'true',
+          :"stats.field" => @field.indexed_name
+        }
+        params.merge!({:"stats.facet"    => @options[:facet].indexed_name}) if @options[:facet].present?
+        params
+      end
+    end
+  end
+end

data/lib/query/stat_query.rb

@@ -0,0 +1,12 @@
+module Sunspot
+  module Query #:nodoc:
+    class CommonQuery
+
+      def add_stat(stat)
+        @components << stat
+        stat
+      end
+
+    end
+  end
+end

data/lib/search/stat_facet.rb

@@ -0,0 +1,46 @@
+module Sunspot
+  module Search
+    class StatFacet
+
+      def initialize(field, search, options)
+        @field, @search, @options = field, search, options
+      end
+
+      def field_name
+        @field.name
+      end
+
+      def rows
+        @options[:type] ||= "sum"
+        @sort = false
+        @rows ||=
+        begin
+          if !@search.stat_response['stats_fields'].nil?
+            if @options[:facet].present?
+              stat = @search.stat_response['stats_fields'][@field.indexed_name]
+              data = stat.nil? ? [] : stat['facets'][@options[:facet].indexed_name]
+              @sort = true
+            else
+              data = @search.stat_response['stats_fields'].to_a
+            end
+          end
+
+          rows = []
+
+          data.collect do |stat, value|
+            rows << StatRow.new(stat, value[@options[:type]], self)
+          end
+
+          if @options[:sort] == :type
+            rows.sort! { |lrow, rrow| rrow.count <=> lrow.count }
+          else
+            rows.sort! { |lrow, rrow| lrow.stat_field <=> rrow.stat_field }
+          end if @sort
+          rows
+        rescue Exception => e
+          puts "Error: #{e}"
+        end
+      end
+    end
+  end
+end

data/lib/search/stat_row.rb

@@ -0,0 +1,28 @@
+module Sunspot
+  module Search
+    class StatRow
+      attr_reader :stat_field, :value
+      attr_writer :instance #:nodoc:
+
+      def initialize(stat_field, value, stat) #:nodoc:
+        @stat_field, @value, @stat = stat_field, value, stat
+      end
+
+      # 
+      # Return the instance referenced by this stat row. Only valid for field
+      # stats whose fields are defined with the :references key.
+      #
+      
+      def instance
+        if !defined?(@instance)
+          @stat.populate_instances
+        end
+        @instance
+      end
+
+      def inspect
+        "<Sunspot::Search::StatRow:#{stat_field.inspect} (#{value})>"
+      end
+    end
+  end
+end

data/lib/search/stat_search.rb

@@ -0,0 +1,57 @@
+require 'sunspot/search/paginated_collection'
+require 'sunspot/search/hit_enumerable'
+
+module Sunspot
+  module Search #:nodoc:
+    
+    # 
+    # This class encapsulates the results of a Solr search. It provides access
+    # to search results, total result count, facets, and pagination information.
+    # Instances of Search are returned by the Sunspot.search and
+    # Sunspot.new_search methods.
+    #
+    class AbstractSearch
+      # 
+      # Retrieve all facet objects defined for this search, in order they were
+      # defined. To retrieve an individual facet by name, use #facet()
+      #
+      attr_reader :stats
+
+      def initialize(connection, setup, query, configuration) #:nodoc:
+        @connection, @setup, @query = connection, setup, query
+        @query.paginate(1, configuration.pagination.default_per_page)
+
+        @stats = []
+        @stats_by_name = {}
+
+        @facets = []
+        @facets_by_name = {}
+
+        @groups_by_name = {}
+        @groups = []
+      end
+
+
+      def stat(name)
+        if name
+          @stats_by_name[name.to_sym]
+        end
+      end
+
+      def stat_response #:nodoc:
+        @solr_result['stats']
+      end
+
+      def add_field_stat(field, options = {}) #:nodoc:
+        name = (options[:name] || field.name)
+        add_stat(name, StatFacet.new(field, self, options))
+      end
+      
+      def add_stat(name, stat)
+        @stats << stat
+        @stats_by_name[name.to_sym] = stat
+      end
+      
+    end
+  end
+end

data/lib/sunspot_stats.rb

@@ -0,0 +1,15 @@
+require "sunspot_stats/version"
+
+%w(field_query).each do |file|
+  require File.join(File.dirname(__FILE__), "dsl", file)
+end
+
+
+%w(stat_search stat_row stat_facet).each do |file|
+  require File.join(File.dirname(__FILE__), "search", file)
+end
+
+%w(stat_query field_stat).each do |file|
+  require(File.join(File.dirname(__FILE__), 'query', file))
+end
+

data/lib/sunspot_stats/version.rb

@@ -0,0 +1,3 @@
+module SunspotStats
+  VERSION = "0.0.2"
+end

data/sunspot_stats.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sunspot_stats/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["duccio giovannelli"]
+  gem.email         = ["giovannelli@extendi.it"]
+  gem.description   = <<-TEXT
+      Sunspot is a library providing a powerful, all-ruby API for the Solr search engine. This gem extend sunspot adding the 
+      statsComponent feature, which returns simple statistics for indexed numeric fields within the DocSet. Usually Suspot use the dismax
+      for searches, here we extend to edismax to manage also boolean logic searches.
+    TEXT
+  gem.summary       = "Added the statsComponent to sunspot"
+  gem.homepage      = "https://github.com/giovannelli/sunspot_stats"
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sunspot_stats"
+  gem.require_paths = ["lib"]
+  gem.version       = SunspotStats::VERSION
+  
+  gem.add_dependency "sunspot", "~> 2.0.0.pre.120417"
+  gem.add_development_dependency "rspec"
+  
+  gem.rdoc_options << '--webcvs=http://github.com/giovannelli/sunspot_stats/tree/master/%s' <<
+                   '--title' << 'Sunspot Stat - StatsComponent for sunspot - API Documentation' <<
+                   '--main' << 'README.rdoc'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: sunspot_stats
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- duccio giovannelli
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sunspot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - pre
+        - 120417
+        version: 2.0.0.pre.120417
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: "      Sunspot is a library providing a powerful, all-ruby API for the Solr search engine. This gem extend sunspot adding the \n      statsComponent feature, which returns simple statistics for indexed numeric fields within the DocSet. Usually Suspot use the dismax\n      for searches, here we extend to edismax to manage also boolean logic searches.\n"
+email: 
+- giovannelli@extendi.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/dsl/field_query.rb
+- lib/edismax.rb
+- lib/query/field_stat.rb
+- lib/query/stat_query.rb
+- lib/search/stat_facet.rb
+- lib/search/stat_row.rb
+- lib/search/stat_search.rb
+- lib/sunspot_stats.rb
+- lib/sunspot_stats/version.rb
+- sunspot_stats.gemspec
+has_rdoc: true
+homepage: https://github.com/giovannelli/sunspot_stats
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --webcvs=http://github.com/giovannelli/sunspot_stats/tree/master/%s
+- --title
+- Sunspot Stat - StatsComponent for sunspot - API Documentation
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Added the statsComponent to sunspot
+test_files: []
+