summaryse 1.0.0

data/lib/summaryse/version.rb

@@ -0,0 +1,14 @@
+module Summaryse
+  module Version
+  
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+  
+    def self.to_s
+      [ MAJOR, MINOR, TINY ].join('.')
+    end
+  
+  end 
+  VERSION = Version.to_s
+end

data/spec/readme_spec.rb

@@ -0,0 +1,112 @@
+require File.expand_path('../spec_helper', __FILE__)
+describe "README file" do
+
+  it 'should provide correct examples' do
+
+    # :count, same as #size
+    [1, 4, 12, 7].summaryse(:count).should eq(4)
+
+    # :sum, same as #inject(:+)
+    [1, 4, 12, 7].summaryse(:sum).should eq(24)
+
+    # :avg, same as #inject(:+)/size
+    [1, 4, 12, 7].summaryse(:avg).should eq(6.0)
+
+    # :min, same as #min
+    [1, 4, 12, 7].summaryse(:min).should eq(1)
+
+    # :max, same as #max
+    [1, 4, 12, 7].summaryse(:max).should eq(12)
+
+    # :first, same as #first
+    [1, 4, 12, 7].summaryse(:first).should eq(1)
+
+    # :last, same as #last
+    [1, 4, 12, 7].summaryse(:last).should eq(7)
+
+    # :union, same as #inject(:|)
+    [ [1, 4], [12, 1, 7], [1] ].summaryse(:union).should eq([1, 4, 12, 7])
+
+    # :intersection, same as #inject(:&)
+    [ [1, 4], [12, 1, 7], [1] ].summaryse(:intersection).should eq([1])
+
+    [
+      { :hobbies => [:ruby],  :size => 12 },
+      { :hobbies => [:music], :size => 17 }
+    ].summaryse(:hobbies => :union, :size => :max).should eq(
+      :hobbies => [:ruby, :music], :size => 17
+    )
+
+    [
+      { :hobbies => [:ruby],  :size => 12 },
+      { :hobbies => [:music], :size => 17 }
+    ].summaryse(:hobbies => :union, nil => :first).should eq(
+      :hobbies => [:ruby, :music], :size => 12
+    )
+
+    [
+      { :hobbies => [:ruby],  :size => 12 },
+      { :hobbies => [:music], :size => 17 }
+    ].summaryse(:hobbies => :union, :size => lambda{|a|
+      a.inject(:+).to_f
+    }).should eq(:hobbies => [:ruby, :music], :size => 29.0)
+
+    [
+      { :hobbies => [:ruby],  :size => 12 },
+      { :hobbies => [:music], :size => 17 }
+    ].summaryse(:hobbies => :union, :size => lambda{|a|
+      a.join(', ')
+    }).should eq(:hobbies => [:ruby, :music], :size => "12, 17")
+
+    [ 
+      { :hobbies => {:day => [:ruby], :night => [:ruby] } },
+      { :hobbies => {:day => [],      :night => [:sleep]} }
+    ].summaryse(:hobbies => {:day => :union, :night => :union}).should eq(
+      :hobbies => {:day => [:ruby], :night => [:ruby, :sleep]}
+    )
+
+  end
+
+  it 'should provide a correct integration example' do
+    # This is left.yaml
+    left = YAML.load <<-Y
+      hobbies:
+        - ruby
+        - rails
+      dependencies:
+        - {name: rspec, version: '2.6.4', for: [ runtime ]}
+    Y
+
+    # This is right.yaml
+    right = YAML.load <<-Y
+      hobbies:
+        - ruby
+        - music
+      dependencies:
+        - {name: rails, version: '3.0',   for: [ runtime ]}
+        - {name: rspec, version: '2.6.4', for: [ test    ]}
+    Y
+
+    # This is merge.yaml
+    merge = YAML.load <<-M
+      hobbies: 
+        :union
+      dependencies: 
+        - [name, version]
+        - for: :union
+    M
+    
+    # Merge and re-dump
+    exp = YAML.load <<-Y
+      hobbies:
+        - ruby
+        - rails
+        - music
+      dependencies:
+        - {name: rspec, version: '2.6.4', for: [ runtime, test ]}
+        - {name: rails, version: '3.0',   for: [ runtime       ]}
+    Y
+    [ left, right ].summaryse(merge).should eq(exp)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'summaryse'

data/spec/summaryse_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path('../spec_helper', __FILE__)
+describe Summaryse do
+  
+  it "should have a version number" do
+    Summaryse.const_defined?(:VERSION).should be_true
+  end
+
+  describe "when called with a Proc argument" do
+
+    let(:numbers){ [15, 3, 17, 4, 12] } 
+
+    it "should simply call the proc with the array" do
+      numbers.summaryse(lambda{|a| "hello"}).should eq("hello")
+    end
+   
+  end 
+
+  describe "when called with a Symbol argument" do
+    
+    let(:numbers){ [15, 3, 17, 4, 12] } 
+    let(:arrays){ [[15, 3, 12], [17, 4, 12]] } 
+
+    it "should recognize avg" do
+      numbers.summaryse(:avg).should eq((15 + 3 + 17 + 4 + 12)/5.0)
+    end
+    
+    it "should recognize count" do
+      numbers.summaryse(:count).should eq(5)
+      arrays.summaryse(:count).should eq(2)
+    end
+
+    it "should recognize first" do
+      numbers.summaryse(:first).should eq(15)
+    end
+
+    it "should recognize intersection" do
+      arrays.summaryse(:intersection).should eq([12])
+    end
+
+    it "should recognize last" do
+      numbers.summaryse(:last).should eq(12)
+    end
+
+    it "should recognize min" do
+      numbers.summaryse(:min).should eq(3)
+    end
+
+    it "should recognize max" do
+      numbers.summaryse(:max).should eq(17)
+    end
+
+    it "should recognize sum" do
+      numbers.summaryse(:sum).should eq(15 + 3 + 17 + 4 + 12)
+      arrays.summaryse(:sum).should eq([ 15, 3, 12, 17, 4, 12])
+    end
+
+    it "should recognize union" do
+      arrays.summaryse(:union).should eq([15, 3, 12, 17, 4])
+    end
+
+  end # Symbol argument
+
+  describe "when called with a Hash argument" do
+
+    let(:rel){[
+      { :size => 12, :hobbies => [:ruby] },
+      { :size => 1,  :hobbies => [:music] }
+    ]}
+
+    it "should allow simple sub-summarizations" do
+      control = { :size => :max, :hobbies => :union }
+      rel.summaryse(control).should eq(:size => 12, :hobbies => [:ruby, :music])
+    end
+
+    it "should not keep non summarysed arguments by default" do
+      control = {:size => :max}
+      rel.summaryse(control).should eq(:size => 12)
+    end
+
+    it "should allow specifying a default behavior" do
+      control = {:size => :max, nil => :union}
+      rel.summaryse(control).should eq(:size => 12, :hobbies => [:ruby, :music])
+    end
+
+    it "should support having inner Procs" do
+      control = {:size => lambda{|a| "hello"}}
+      rel.summaryse(control).should eq(:size => "hello")
+    end
+
+  end # Hash argument
+
+  describe "when called with an Array argument" do
+    let(:array){[
+      [ {:version => "1.9", :size => 16},
+        {:version => "1.8", :size => 12} ],
+      [ {:version => "2.0", :size => 99},
+        {:version => "1.8", :size => 10} ]
+    ]}
+
+    it "should union then summaryse while respecting by key order" do
+      control = [ [:version], {:size => :min} ]
+      array.summaryse(control).should eq([
+        {:version => "1.9", :size => 16},
+        {:version => "1.8", :size => 10},
+        {:version => "2.0", :size => 99}
+      ])
+    end
+
+  end
+  
+end

data/summaryse.gemspec

@@ -0,0 +1,190 @@
+# We require your library, mainly to have access to the VERSION number. 
+# Feel free to set $version manually.
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require "summaryse/version"
+$version = Summaryse::Version.to_s
+
+#
+# This is your Gem specification. Default values are provided so that your library
+# should be correctly packaged given what you have described in the .noespec file.
+#
+Gem::Specification.new do |s|
+  
+  ################################################################### ABOUT YOUR GEM
+  
+  # Gem name (required) 
+  s.name = "summaryse"
+  
+  # Gem version (required)
+  s.version = $version
+  
+  # A short summary of this gem
+  #
+  # This is displayed in `gem list -d`.
+  s.summary = "Array#summaryse"
+
+  # A long description of this gem (required)
+  #
+  # The description should be more detailed than the summary.  For example,
+  # you might wish to copy the entire README into the description.
+  s.description = "summaryse arrays with full power. Among others, this gem allows merging YAML\nconfiguration files,... "
+  
+  # The URL of this gem home page (optional)
+  s.homepage = "http://github.com/blambeau/summaryse"
+
+  # Gem publication date (required but auto)
+  #
+  # Today is automatically used by default, uncomment only if
+  # you know what you do!
+  #
+  # s.date = Time.now.strftime('%Y-%m-%d')
+  
+  # The license(s) for the library.  Each license must be a short name, no
+  # more than 64 characters.
+  #
+  # s.licences = %w{}
+
+  # The rubyforge project this gem lives under (optional)
+  #
+  # s.rubyforge_project = nil
+
+  ################################################################### ABOUT THE AUTHORS
+  
+  # The list of author names who wrote this gem.
+  #
+  # If you are providing multiple authors and multiple emails they should be
+  # in the same order.
+  # 
+  s.authors = ["Bernard Lambeau"]
+  
+  # Contact emails for this gem
+  #
+  # If you are providing multiple authors and multiple emails they should be
+  # in the same order.
+  #
+  # NOTE: Somewhat strangly this attribute is always singular! 
+  #       Don't replace by s.emails = ...
+  s.email  = ["blambeau@gmail.com"]
+
+  ################################################################### PATHS, FILES, BINARIES
+  
+  # Paths in the gem to add to $LOAD_PATH when this gem is 
+  # activated (required).
+  #
+  # The default 'lib' is typically sufficient.
+  s.require_paths = ["lib"]
+  
+  # Files included in this gem.
+  #
+  # By default, we take all files included in the Manifest.txt file on root
+  # of the project. Entries of the manifest are interpreted as Dir[...] 
+  # patterns so that lazy people may use wilcards like lib/**/*
+  #
+  here = File.expand_path(File.dirname(__FILE__))
+  s.files = File.readlines(File.join(here, 'Manifest.txt')).
+                 inject([]){|files, pattern| files + Dir[File.join(here, pattern.strip)]}.
+                 collect{|x| x[(1+here.size)..-1]}
+
+  # Test files included in this gem.
+  #
+  s.test_files = Dir["test/**/*"] + Dir["spec/**/*"]
+
+  # The path in the gem for executable scripts (optional)
+  #
+  s.bindir = "bin"
+
+  # Executables included in the gem.
+  #
+  s.executables = (Dir["bin/*"]).collect{|f| File.basename(f)}
+
+  ################################################################### REQUIREMENTS & INSTALL
+  # Remember the gem version requirements operators and schemes:
+  #   =  Equals version
+  #   != Not equal to version
+  #   >  Greater than version
+  #   <  Less than version
+  #   >= Greater than or equal to
+  #   <= Less than or equal to
+  #   ~> Approximately greater than
+  #
+  # Don't forget to have a look at http://lmgtfy.com/?q=Ruby+Versioning+Policies 
+  # for setting your gem version.
+  #
+  # For your requirements to other gems, remember that
+  #   ">= 2.2.0"              (optimistic:  specify minimal version)
+  #   ">= 2.2.0", "< 3.0"     (pessimistic: not greater than the next major)
+  #   "~> 2.2"                (shortcut for ">= 2.2.0", "< 3.0")
+  #   "~> 2.2.0"              (shortcut for ">= 2.2.0", "< 2.3.0")
+  #
+
+  #
+  # One call to add_dependency('gem_name', 'gem version requirement') for each
+  # runtime dependency. These gems will be installed with your gem. 
+  # One call to add_development_dependency('gem_name', 'gem version requirement')
+  # for each development dependency. These gems are required for developers
+  #
+  s.add_development_dependency("rake", "~> 0.9.2")
+  s.add_development_dependency("bundler", "~> 1.0")
+  s.add_development_dependency("rspec", "~> 2.4.0")
+  s.add_development_dependency("yard", "~> 0.7.2")
+  s.add_development_dependency("bluecloth", "~> 2.0.9")
+  s.add_development_dependency("wlang", "~> 0.10.1")
+  
+
+  # The version of ruby required by this gem
+  #
+  # Uncomment and set this if your gem requires specific ruby versions.
+  #
+  # s.required_ruby_version = ">= 0"
+
+  # The RubyGems version required by this gem
+  #
+  # s.required_rubygems_version = ">= 0"
+
+  # The platform this gem runs on.  See Gem::Platform for details.
+  #
+  # s.platform = nil
+
+  # Extensions to build when installing the gem.  
+  #
+  # Valid types of extensions are extconf.rb files, configure scripts 
+  # and rakefiles or mkrf_conf files.
+  #
+  s.extensions = []
+  
+  # External (to RubyGems) requirements that must be met for this gem to work. 
+  # It’s simply information for the user.
+  #
+  s.requirements = nil
+  
+  # A message that gets displayed after the gem is installed
+  #
+  # Uncomment and set this if you want to say something to the user
+  # after gem installation
+  #
+  s.post_install_message = nil
+
+  ################################################################### SECURITY
+
+  # The key used to sign this gem.  See Gem::Security for details.
+  #
+  # s.signing_key = nil
+
+  # The certificate chain used to sign this gem.  See Gem::Security for
+  # details.
+  #
+  # s.cert_chain = []
+  
+  ################################################################### RDOC
+
+  # An ARGV style array of options to RDoc
+  #
+  # See 'rdoc --help' about this
+  #
+  s.rdoc_options = []
+
+  # Extra files to add to RDoc such as README
+  #
+  s.extra_rdoc_files = Dir["README.md"] + Dir["CHANGELOG.md"] + Dir["LICENCE.md"]
+
+end

data/summaryse.noespec

@@ -0,0 +1,28 @@
+# Noe template for ruby gem libraries (https://github.com/blambeau/noe) - short version
+# Run 'noe show-spec' and 'noe help show-spec' for additional details.
+template-info:
+  name: "ruby"
+  version: 1.3.0
+variables:
+  lower: 
+    summaryse
+  upper:
+    summaryse
+  version:
+    1.0.0
+  summary: |-
+    Array#summaryse
+  description: |-
+    summaryse arrays with full power. Among others, this gem allows merging YAML
+    configuration files,... 
+  authors: 
+    - { name: "Bernard Lambeau", email: blambeau@gmail.com }
+  links:
+    - http://github.com/blambeau/summaryse
+  dependencies: 
+    - {name: rake,      version: "~> 0.9.2", groups: [development]}
+    - {name: bundler,   version: "~> 1.0",   groups: [development]}
+    - {name: rspec,     version: "~> 2.4.0", groups: [development]}
+    - {name: yard,      version: "~> 0.7.2", groups: [development]}
+    - {name: bluecloth, version: "~> 2.0.9", groups: [development]}
+    - {name: wlang,     version: "~> 0.10.1", groups: [development]}