alf 0.10.1 → 0.11.0

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+# 0.11.0 / FIX ME
+
+## Broken APIs (private sections only)
+
+* All pipe() methods have been removed and replaced by arguments taken at
+  construction time. This affects the implementation of operators and may
+  require changes to contributed readers and renderers.
+* Alf::Operator::Base    -> Alf::Operator::InstanceMethods
+* Alf::Reader::Base      -> Alf::Reader::InstanceMethods
+* Alf::Rendered::Base    -> Alf::Rendered::InstanceMethods
+* Alf::Environment::Base -> Alf::Environment::InstanceMethods
+* Alf::Aggregator::Base  -> Alf::Aggregator::InstanceMethods
+* Alf::Buffer has been removed as well as the Sorted specialization.
+* Alf::Environment::Explicit has been removed as well as associated tools.
+* Ordering#order_of has been removed
+* Ordering#order_by has been removed
+* Alf::Tools.coerce now raise a Alf::CoercionError instead of a Myrrha::Error
+  in case of coercion failure
+
+## On the development side
+
+* Bumped ruby.noe to 1.7.0
+* Bumped rspec to 2.8.0
+* Bumped sequel to 3.30.0
+
 # 0.10.1 / 2011-08-31
 
 ## Miscellaneous enhancements

data/Gemfile

@@ -1,32 +1,32 @@
 source 'http://rubygems.org'
 
 group :runtime do
-  gem "quickl", "~> 0.4.1"
+  gem "quickl", "~> 0.4.2"
   gem "myrrha", "~> 1.2.1"
-  gem "highline", "~> 1.6.2"
+  gem "backports", "~> 2.3.0"
 end
 
 group :test do
   gem "rake", "~> 0.9.2"
-  gem "rspec", "~> 2.6.0"
+  gem "rspec", "~> 2.8.0"
 end
 
 group :release do
   gem "rake", "~> 0.9.2"
-  gem "rspec", "~> 2.6.0"
+  gem "rspec", "~> 2.8.0"
   gem "wlang", "~> 0.10.2"
 end
 
 group :doc do
   gem "yard", "~> 0.7.2"
-  gem "bluecloth", "~> 2.1.0"
-  gem "redcarpet", "~> 1.17.2"
+  gem "bluecloth", "~> 2.2.0"
+  gem "redcarpet", "~> 2.1.0"
 end
 
 group :extra do
   gem "fastercsv", "~> 1.5.4"
   gem "request-log-analyzer", "~> 1.11.0"
-  gem "sequel", "~> 3.25.0"
+  gem "sequel", "~> 3.30"
   gem "sqlite3", "~> 1.3.0"
+  gem "highline", "~> 1.6.2"
 end
-

data/Gemfile.lock

@@ -1,43 +1,45 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    bluecloth (2.1.0)
+    backports (2.3.0)
+    bluecloth (2.2.0)
     diff-lcs (1.1.3)
     fastercsv (1.5.4)
-    highline (1.6.2)
+    highline (1.6.11)
     myrrha (1.2.1)
-    quickl (0.4.1)
-    rake (0.9.2)
-    redcarpet (1.17.2)
+    quickl (0.4.2)
+    rake (0.9.2.2)
+    redcarpet (2.1.0)
     request-log-analyzer (1.11.1)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    sequel (3.25.0)
-    sqlite3 (1.3.4)
+    rspec-mocks (2.8.0)
+    sequel (3.31.0)
+    sqlite3 (1.3.5)
     wlang (0.10.2)
-    yard (0.7.2)
+    yard (0.7.4)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  bluecloth (~> 2.1.0)
+  backports (~> 2.3.0)
+  bluecloth (~> 2.2.0)
   fastercsv (~> 1.5.4)
   highline (~> 1.6.2)
   myrrha (~> 1.2.1)
-  quickl (~> 0.4.1)
+  quickl (~> 0.4.2)
   rake (~> 0.9.2)
-  redcarpet (~> 1.17.2)
+  redcarpet (~> 2.1.0)
   request-log-analyzer (~> 1.11.0)
-  rspec (~> 2.6.0)
-  sequel (~> 3.25.0)
+  rspec (~> 2.8.0)
+  sequel (~> 3.30)
   sqlite3 (~> 1.3.0)
   wlang (~> 0.10.2)
   yard (~> 0.7.2)

data/Rakefile

@@ -19,5 +19,5 @@ task :default => :test
 # See .rake files there for complete documentation.
 #
 Dir["tasks/*.rake"].each do |taskfile|
-  instance_eval File.read(taskfile), taskfile
+  load taskfile
 end

data/alf.gemspec

@@ -1,4 +1,4 @@
-# We require your library, mainly to have access to the VERSION number. 
+# 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 "alf/version"
@@ -9,15 +9,15 @@ $version = Alf::Version.to_s
 # should be correctly packaged given what you have described in the .noespec file.
 #
 Gem::Specification.new do |s|
-  
+
   ################################################################### ABOUT YOUR GEM
-  
-  # Gem name (required) 
+
+  # Gem name (required)
   s.name = "alf"
-  
+
   # Gem version (required)
   s.version = $version
-  
+
   # A short summary of this gem
   #
   # This is displayed in `gem list -d`.
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   # The description should be more detailed than the summary.  For example,
   # you might wish to copy the entire README into the description.
   s.description = "Alf brings the relational algebra both in Shell and in Ruby. In Shell, because \nmanipulating any relation-like data source should be as straightforward as a \none-liner. In Ruby, because I've never understood why programming languages \nprovide data structures like arrays, hashes, sets, trees and graphs but not \n_relations_... Let's stop the segregation ;-)"
-  
+
   # The URL of this gem home page (optional)
   s.homepage = "http://blambeau.github.com/alf"
 
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   # 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.
   #
@@ -49,35 +49,35 @@ Gem::Specification.new do |s|
   # 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! 
+  # 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 
+
+  # 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[...] 
+  # 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__))
@@ -107,7 +107,7 @@ Gem::Specification.new do |s|
   #   <= Less than or equal to
   #   ~> Approximately greater than
   #
-  # Don't forget to have a look at http://lmgtfy.com/?q=Ruby+Versioning+Policies 
+  # 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
@@ -119,23 +119,24 @@ Gem::Specification.new do |s|
 
   #
   # One call to add_dependency('gem_name', 'gem version requirement') for each
-  # runtime dependency. These gems will be installed with your gem. 
+  # 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("rspec", "~> 2.6.0")
+  s.add_development_dependency("rspec", "~> 2.8.0")
   s.add_development_dependency("wlang", "~> 0.10.2")
   s.add_development_dependency("yard", "~> 0.7.2")
-  s.add_development_dependency("bluecloth", "~> 2.1.0")
-  s.add_development_dependency("redcarpet", "~> 1.17.2")
+  s.add_development_dependency("bluecloth", "~> 2.2.0")
+  s.add_development_dependency("redcarpet", "~> 2.1.0")
   s.add_development_dependency("fastercsv", "~> 1.5.4")
   s.add_development_dependency("request-log-analyzer", "~> 1.11.0")
-  s.add_development_dependency("sequel", "~> 3.25.0")
+  s.add_development_dependency("sequel", "~> 3.30")
   s.add_development_dependency("sqlite3", "~> 1.3.0")
-  s.add_dependency("quickl", "~> 0.4.1")
+  s.add_development_dependency("highline", "~> 1.6.2")
+  s.add_dependency("quickl", "~> 0.4.2")
   s.add_dependency("myrrha", "~> 1.2.1")
-  s.add_dependency("highline", "~> 1.6.2")
+  s.add_dependency("backports", "~> 2.3.0")
 
   # The version of ruby required by this gem
   #
@@ -151,18 +152,18 @@ Gem::Specification.new do |s|
   #
   # s.platform = nil
 
-  # Extensions to build when installing the gem.  
+  # Extensions to build when installing the gem.
   #
-  # Valid types of extensions are extconf.rb files, configure scripts 
+  # 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. 
+
+  # 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
@@ -180,7 +181,7 @@ Gem::Specification.new do |s|
   # details.
   #
   # s.cert_chain = []
-  
+
   ################################################################### RDOC
 
   # An ARGV style array of options to RDoc

data/alf.noespec

@@ -1,6 +1,6 @@
 template-info:
   name: "ruby"
-  version: 1.5.0
+  version: 1.7.0
   manifest:
     tasks/spec_test.rake:
       ignore: true
@@ -10,13 +10,15 @@ template-info:
       safe-override: false
     tasks/debug_mail.txt:
       safe-override: false
+    lib/__lower__/loader.rb:
+      ignore: true
 variables:
   lower: 
     alf
   upper:
     Alf
   version:
-    0.10.1
+    0.11.0
   summary: |-
     Relational Algebra at your fingertips
   description: |-
@@ -33,18 +35,18 @@ variables:
     - http://rubygems.org/gems/alf
     - http://rubydoc.info/gems/alf
   dependencies: 
-    - {name: quickl,       version: "~> 0.4.1",  groups: [runtime      ]}
+    - {name: quickl,       version: "~> 0.4.2",  groups: [runtime      ]}
     - {name: myrrha,       version: "~> 1.2.1",  groups: [runtime      ]}
-    - {name: highline,     version: "~> 1.6.2",  groups: [runtime      ]}
+    - {name: backports,    version: "~> 2.3.0",  groups: [runtime      ]}
     - {name: rake,         version: "~> 0.9.2",  groups: [test, release]}
-    - {name: rspec,        version: "~> 2.6.0",  groups: [test, release]}
+    - {name: rspec,        version: "~> 2.8.0",  groups: [test, release]}
     - {name: wlang,        version: "~> 0.10.2", groups: [release      ]}
-    #- {name: rcov,         version: "~> 0.9.9",  groups: [doc          ]}
     - {name: yard,         version: "~> 0.7.2",  groups: [doc          ]}
-    - {name: bluecloth,    version: "~> 2.1.0",  groups: [doc          ]}
-    - {name: redcarpet,    version: "~> 1.17.2", groups: [doc          ]}
+    - {name: bluecloth,    version: "~> 2.2.0",  groups: [doc          ]}
+    - {name: redcarpet,    version: "~> 2.1.0",  groups: [doc          ]}
     - {name: fastercsv,    version: "~> 1.5.4",  groups: [extra        ]}
     - {name: request-log-analyzer, version: "~> 1.11.0", groups: [extra]}
-    - {name: sequel,       version: "~> 3.25.0", groups: [extra        ]}
+    - {name: sequel,       version: "~> 3.30",   groups: [extra        ]}
     - {name: sqlite3,      version: "~> 1.3.0",  groups: [extra        ]}
+    - {name: highline,     version: "~> 1.6.2",  groups: [extra        ]}
 

data/bin/alf

@@ -20,7 +20,7 @@ module AlfLauncher
     if ENV["ALF_OPTS"]
       argv = Quickl.parse_commandline_args(ENV["ALF_OPTS"]) + argv
     end
-    Alf::Command::Main.run(argv, __FILE__)
+    Alf::Shell::Main.run(argv, __FILE__)
   end
 
 end # module AlfLaucher

data/lib/alf/aggregator/avg.rb

@@ -0,0 +1,39 @@
+module Alf
+  class Aggregator
+    #
+    # Defines a `avg()` aggregation operator.
+    #
+    # Example:
+    #
+    #   # direct ruby usage
+    #   Alf::Aggregator.avg{ qty }.aggregate(...)
+    #
+    #   # lispy 
+    #   (summarize :supplies, [:sid], :avg => avg{ qty })
+    #
+    class Avg < Aggregator
+
+      # Returns [0.0, 0.0] as least value.
+      #
+      # @see Aggregator::InstanceMethods#least
+      def least()
+        [0.0, 0.0]
+      end
+
+      # Aggregates on a tuple occurence.
+      #
+      # @see Aggregator::InstanceMethods#_happens
+      def _happens(memo, val) 
+        [memo.first + val, memo.last + 1]
+      end
+
+      # Finalizes the computation.
+      #
+      # @see Aggregator::InstanceMethods#finalize
+      def finalize(memo) 
+        memo.first / memo.last 
+      end
+
+    end # class Avg
+  end # class Aggregator
+end # module Alf

data/lib/alf/aggregator/class_methods.rb

@@ -1,30 +1,42 @@
 module Alf
   class Aggregator
+    #
+    # This module installs class-level utilities of Alf's aggregators.
+    #
+    # Subclasses of Aggregator are automatically tracked so as to add
+    # factory methods on the Aggregator class itself. Example: 
+    #
+    #   class Sum < Aggregate   # will give a method Aggregator.sum
+    #     ...
+    #   end
+    #   Aggregator.sum{ size }
+    #
+    # All registered aggregators are available under `Aggregator.aggregators`
+    # Those aggregators may also be iterated as follows:
+    #
+    #   Alf::Aggregator.each do |agg_class|
+    #
+    #     # agg_class is a subclass of Aggregator
+    #
+    #   end
+    #
     module ClassMethods
-      
-      #
+
       # Returns registered aggregators as an Array of classes
       #
+      # @return [Array<Class>] The list of registered aggregator classes
       def aggregators
         @aggregators ||= []
       end
 
-      #
-      # Yields aggregator classes in turn
-      # 
+      # Yields each aggregator class in turn
       def each
         aggregators.each(&Proc.new)
       end
 
-      #
       # Automatically installs factory methods for inherited classes.
       #
-      # Example: 
-      #   class Sum < Aggregate   # will give a method Aggregator.sum
-      #     ...
-      #   end
-      #   Aggregator.sum{ size }
-      # 
+      # @param [Class] clazz a class that extends Aggregator
       def inherited(clazz)
         aggregators << clazz
         basename = Tools.ruby_case(Tools.class_name(clazz))
@@ -34,10 +46,16 @@ module Alf
           end
         EOF
       end
-  
+
+      # Coerces `arg` to an Aggregator
       #
-      # Coerces `arg` as an Aggregator
+      # Implemented coercions are:
+      # - Aggregator -> self
+      # - String     -> through factory methods on self
       #
+      # @param [Object] arg a value to coerce to an aggregator
+      # @return [Aggregator] the coerced aggregator
+      # @raise [ArgumentError] if the coercion fails
       def coerce(arg)
         case arg
         when Aggregator

data/lib/alf/aggregator/collect.rb

@@ -0,0 +1,32 @@
+module Alf
+  class Aggregator
+    #
+    # Defines a `collect()` aggregation operator.
+    #
+    # Example:
+    #
+    #   # direct ruby usage
+    #   Alf::Aggregator.collect{ qty }.aggregate(...)
+    #
+    #   # lispy 
+    #   (summarize :supplies, [:sid], :col => collect{ qty })
+    #
+    class Collect < Aggregator
+
+      # Returns [] as least value.
+      #
+      # @see Aggregator::InstanceMethods#least
+      def least()
+        []
+      end
+
+      # Aggregates on a tuple occurence.
+      #
+      # @see Aggregator::InstanceMethods#_happens
+      def _happens(memo, val) 
+        memo << val
+      end
+
+    end # class Collect
+  end # class Aggregator
+end # module Alf

data/lib/alf/aggregator/concat.rb

@@ -0,0 +1,47 @@
+module Alf
+  class Aggregator
+    #
+    # Defines a `concat()` aggregation operator.
+    #
+    # Example:
+    #
+    #   # direct ruby usage
+    #   Alf::Aggregator.concat{ qty }.aggregate(...)
+    #
+    #   # lispy 
+    #   (summarize :supplies, [:sid], :cat => concat{ qty })
+    #
+    class Concat < Aggregator
+
+      # Sets default options.
+      #
+      # @see Aggregator::InstanceMethods#default_options
+      def default_options
+        {:before => "", :after => "", :between => ""}
+      end
+
+      # Returns least value (defaults to "")
+      #
+      # @see Aggregator::InstanceMethods#least
+      def least()
+        ""
+      end
+
+      # Aggregates on a tuple occurence.
+      #
+      # @see Aggregator::InstanceMethods#_happens
+      def _happens(memo, val) 
+        memo << options[:between].to_s unless memo.empty?
+        memo << val.to_s
+      end
+
+      # Finalizes computation
+      #
+      # @see Aggregator::InstanceMethods#finalize
+      def finalize(memo)
+        options[:before].to_s + memo + options[:after].to_s
+      end
+
+    end # class Concat
+  end # class Aggregator
+end # module Alf

data/lib/alf/aggregator/count.rb

@@ -0,0 +1,32 @@
+module Alf
+  class Aggregator
+    #
+    # Defines a `count()` aggregation operator.
+    #
+    # Example:
+    #
+    #   # direct ruby usage
+    #   Alf::Aggregator.count.aggregate(...)
+    #
+    #   # lispy 
+    #   (summarize :supplies, [:sid], :num_orders => count)
+    #
+    class Count < Aggregator
+
+      # Returns 0 as least value.
+      #
+      # @see Aggregator::InstanceMethods#least
+      def least()
+        0
+      end
+
+      # Aggregates on a tuple occurence through `memo + 1`
+      #
+      # @see Aggregator::InstanceMethods#happens
+      def happens(memo, tuple) 
+        memo + 1
+      end
+
+    end # class Count
+  end # class Aggregator
+end # module Alf