simple_stats 1.0.0 → 1.1.0

data/.travis.yml

@@ -3,9 +3,9 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode # currently in active development, may or may not work for your project
+  - rbx
 # uncomment this line if your project needs to run something other than `rake`:
-script: bundle exec rspec spec
+# script: bundle exec rspec spec

data/Gemfile

@@ -3,4 +3,6 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in simple_stats.gemspec
 gemspec
 
-gem 'rspec'
+gem 'rubysl', :platform => :rbx
+gem 'rake'
+gem 'rspec'

data/README.md

@@ -77,7 +77,7 @@ samples.sorted_frequencies
 [].frequencies        # {}
 [].sorted_frequencies # []
 
-# if elements are preset, mean and median always return floats
+# if elements are present, mean and median always return floats
 [1, 2, 3].mean      # 2.0
 [1, 2, 3].median    # 2.0
 [1, 2, 3, 4].mean   # 2.5
@@ -92,6 +92,30 @@ samples.sorted_frequencies
 [2,   2.0, 1].modes # [2.0]
 ```
 
+## Mapping
+
+If the thing you want stats on is buried in your objects, you can pass a block to any SimpleStats method.
+
+```ruby
+# these two lines do the same thing
+cities.mean {|city| city.population}
+cities.map  {|city| city.population}.mean
+
+# other examples
+cities.sum(&:public_school_count)
+cities.mean(&:public_school_count)
+cities.frequencies(&:professional_team_count)
+
+# more complicated examples
+cities.median {|city| city.municipal_income / city.schools.sum(&:students)}
+cities.map(&:schools).flatten.modes(&:team_name) # most common school sports team name
+cities.map(&:professional_teams).flatten.sorted_frequencies(&:kind) # number of different kinds of sports teams
+```
+
+## Interaction with other gems
+
+If any of SimpleStats' methods are already defined on Enumerable, SimpleStats _will not_ replace them with its own definition. In particular, ActiveSupport [defines a `sum` method](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/enumerable.rb). If both ActiveSupport and SimpleStats are used, the `sum` method will come from ActiveSupport. Don't worry, ActiveSupport and SimpleStats should work fine together.
+
 ## Help make it better!
 
 Need something added? [Open an issue](https://github.com/brianhempel/simple_stats/issues). Or, even better, code it yourself and send a pull request:
@@ -106,4 +130,4 @@ Need something added? [Open an issue](https://github.com/brianhempel/simple_stat
 
 ## License
 
-Public domain. (I, Brian Hempel, the original author release this code to the public domain.)
+Public domain. (I, Brian Hempel, the original author release this code to the public domain. February 10, 2012.)

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+
+task :default => :test
+
+desc "Run the tests (rspec)"
+task(:test) do
+  require 'rspec/autorun'
+  $LOAD_PATH.unshift(File.expand_path '../spec', __FILE__)
+  Dir.glob(File.expand_path '../spec/**/*_spec.rb', __FILE__).each {|s| require s}
+end

data/lib/simple_stats/core_ext/enumerable.rb

@@ -1,65 +1,91 @@
 module Enumerable
-  def sum
-    inject(0) { |sum, x| sum + x }
-  end
-
-  def mean
-    count = self.count # count has to iterate if there's no size method
-    return nil if count == 0
-    sum / count.to_f
+  unless method_defined? :sum
+    def sum(&block)
+      return map(&block).sum if block_given?
+      inject(0) { |sum, x| sum + x }
+    end
   end
 
-  def median
-    sorted = sort
-    count  = sorted.size
-    i      = count / 2
+  unless method_defined? :mean
+    def mean(&block)
+      return map(&block).mean if block_given?
 
-    return nil if count == 0
-    if count % 2 == 1
-      sorted[i].to_f
-    else
-      ( sorted[i-1] + sorted[i] ) / 2.0
+      count = self.count # count has to iterate if there's no size method
+      return nil if count == 0
+      (sum / count.to_f).to_f
     end
   end
 
-  def modes
-    sorted_frequencies = self.sorted_frequencies
-    sorted_frequencies.select do |item, frequency|
-      frequency == sorted_frequencies.first[1]
-    end.map do |item, frequency|
-      item
+  unless method_defined? :median
+    def median(&block)
+      return map(&block).median if block_given?
+
+      sorted = sort
+      count  = sorted.size
+      i      = count / 2
+
+      return nil if count == 0
+      if count % 2 == 1
+        sorted[i]
+      else
+        ( sorted[i-1] + sorted[i] ) / 2.0
+      end.to_f
     end
   end
 
-  def frequencies
-    begin
-      sorted = sort
-    rescue NoMethodError # i.e. undefined method `<=>' for :my_symbol:Symbol
-      sorted = sort_by do |item|
-        item.respond_to?(:"<=>") ? item : item.to_s
+  unless method_defined? :modes
+    def modes(&block)
+      return map(&block).modes if block_given?
+
+      sorted_frequencies = self.sorted_frequencies
+      sorted_frequencies.select do |item, frequency|
+        frequency == sorted_frequencies.first[1]
+      end.map do |item, frequency|
+        item
       end
     end
-    current_item = nil;
+  end
 
-    Hash[
-      sorted.reduce([]) do |frequencies, item|
-        if frequencies.size == 0 || item != current_item
-          current_item = item
-          frequencies << [item, 1]
-        else
-          frequencies.last[1] += 1
-          frequencies
+  unless method_defined? :frequencies
+    # This function is oddly written in order to group 1 (integer) and 1.0 (float) together.
+    # If we loaded a hash or used group_by, 1 and 1.0 would be counted as separate things.
+    # Instead, we use the == operator for grouping.
+    def frequencies(&block)
+      return map(&block).frequencies if block_given?
+
+      begin
+        sorted = sort
+      rescue NoMethodError # i.e. undefined method `<=>' for :my_symbol:Symbol
+        sorted = sort_by do |item|
+          item.respond_to?(:"<=>") ? item : item.to_s
         end
       end
-    ]
+      current_item = nil;
+
+      Hash[
+        sorted.reduce([]) do |frequencies, item|
+          if frequencies.size == 0 || item != current_item
+            current_item = item
+            frequencies << [item, 1]
+          else
+            frequencies.last[1] += 1
+            frequencies
+          end
+        end
+      ]
+    end
   end
 
-  def sorted_frequencies
-    frequencies.sort_by do |item, frequency|
-      if item.respond_to?(:"<=>")
-        [-frequency, item]
-      else
-        [-frequency, item.to_s]
+  unless method_defined? :sorted_frequencies
+    def sorted_frequencies(&block)
+      return map(&block).sorted_frequencies if block_given?
+
+      frequencies.sort_by do |item, frequency|
+        if item.respond_to?(:"<=>")
+          [-frequency, item]
+        else
+          [-frequency, item.to_s]
+        end
       end
     end
   end

data/lib/simple_stats/version.rb

@@ -1,3 +1,3 @@
 module SimpleStats
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/enumerable/frequencies_spec.rb

@@ -25,5 +25,15 @@ describe Enumerable do
         frequencies.class.should == expected.class
       end
     end
+
+    it "calls map first if a block is given" do
+      f = Struct.new(:x)
+      data = [f.new(:a), f.new(:b), f.new(:b)]
+      frequencies = data.frequencies(&:x)
+      frequencies.should == {
+        :a => 1,
+        :b => 2
+      }
+    end
   end
-end
+end

data/spec/enumerable/mean_spec.rb

@@ -24,5 +24,11 @@ describe Enumerable do
         mean.class.should == expected.class
       end
     end
+
+    it "calls map first if a block is given" do
+      f = Struct.new(:x)
+      data = [f.new(4), f.new(1), f.new(6)]
+      data.mean(&:x).should == 11 / 3.0
+    end
   end
 end

data/spec/enumerable/median_spec.rb

@@ -24,5 +24,11 @@ describe Enumerable do
         median.class.should == expected.class
       end
     end
+
+    it "calls map first if a block is given" do
+      f = Struct.new(:x)
+      data = [f.new(4), f.new(1), f.new(6)]
+      data.median(&:x).should == 4.0
+    end
   end
 end

data/spec/enumerable/modes_spec.rb

@@ -25,5 +25,11 @@ describe Enumerable do
         modes.class.should == expected.class
       end
     end
+
+    it "calls map first if a block is given" do
+      f = Struct.new(:x)
+      data = [f.new(:a), f.new(:b), f.new(:b)]
+      data.modes(&:x).should == [:b]
+    end
   end
 end

data/spec/enumerable/sorted_frequencies_spec.rb

@@ -28,5 +28,11 @@ describe Enumerable do
         ["White-breasted Nuthatch", 1]
       ]
     end
+
+    it "calls map first if a block is given" do
+      f = Struct.new(:x)
+      data = [f.new(:a), f.new(:b), f.new(:b)]
+      data.sorted_frequencies(&:x).should == [[:b, 2], [:a, 1]]
+    end
   end
 end

data/spec/enumerable/sum_spec.rb

@@ -23,5 +23,11 @@ describe Enumerable do
         sum.class.should == expected.class
       end
     end
+
+    it "calls map first if a block is given" do
+      f = Struct.new(:x)
+      data = [f.new(4), f.new(1), f.new(6)]
+      data.sum(&:x).should == 11
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simple_stats
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Brian Hempel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-10 00:00:00 Z
+date: 2013-12-16 00:00:00 Z
 dependencies: []
 
 description: Simple mean, median, modes, sum, and frequencies for Ruby arrays and enumerables. Tested and sensible.
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.26
 signing_key: 
 specification_version: 3
 summary: Simple mean, median, modes, sum, and frequencies for Ruby arrays and enumerables. Tested and sensible.