alf-shell 0.15.0 → 0.16.0

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.16.0 / 2014-02-18
+
+* Added highline '~> 1.6' to runtime dependencies.
+* Fixed --pretty behavior when stdout is a terminal.
+* Fix `metadata` command when using input sources that do not provide heading
+  information (heading is infered through Relation coercion).
+* Take 'alfrc' into account too (without the dot, for WIN32 users)
+
+# 0.15.0 / 2013-11-01
+
+* Removed all commands corresponding to operators. Use ruby expressions instead.
+
 # 0.14.0 / 2013-10-01
 
 * Added a .alfrc abstraction

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    alf-shell (0.15.0)
-      alf-core (~> 0.15.0)
+    alf-shell (0.16.0)
+      alf-core (= 0.16.0)
+      highline (~> 1.6)
       quickl (~> 0.4.3)
 
 PATH
   remote: ../alf-core
   specs:
-    alf-core (0.15.0)
+    alf-core (0.16.0)
       domain (~> 1.0)
       myrrha (~> 3.0)
       path (~> 1.3)
@@ -17,8 +18,8 @@ PATH
 PATH
   remote: ../alf-doc
   specs:
-    alf-doc (0.15.0)
-      alf-core (~> 0.15.0)
+    alf-doc (0.16.0)
+      alf-core (= 0.16.0)
 
 GEM
   remote: http://rubygems.org/

data/doc/man/alf-repl.man

@@ -0,0 +1,13 @@
+.TH alf\-repl
+.PP
+Launches Alf's Read\-Eval\-Print\-Loop (REPL) web application.
+.SH Synopsis
+.PP
+\fB\fCalf\fR [\fB\fC--db=...\fR] repl
+.SH Description
+.PP
+This command launches the REPL in the current data context defined by the
+\fB\fC.alfrc\fR file and common alf options (e.g. \fB\fC--db\fR).
+.SH Example
+.PP
+\fB\fCalf\fR \fB\fC--db=postgres://...\fR repl

data/doc/man/alf.man

@@ -72,6 +72,9 @@ Relational algebra at your fingertips
 .TP
 \fB\fCexplain\fR
     Show the logical (optimizer) and physical (compiler) plans of a query.
+.TP
+\fB\fCrepl\fR
+    Launches Alf's Read\-Eval\-Print\-Loop (REPL) web application.
 .PP
 See \fB\fCalf help COMMAND\fR for details about a specific command or \fB\fCalf help
 OPERATOR\fR for documentation of a relational operator.

data/doc/man/extend.man

@@ -29,5 +29,5 @@ In other words, all computations are done in ruby, which may seriously
 hurt performance.
 .PP
 Similarly, as \fB\fCextend\fR tends to be a showstopper during compilation, it is
-strongly recommanded to use it as high as possible in query expressions
+strongly recommended to use it as high as possible in query expressions
 trees so as to delegate the largest possible query parts to data engines.

data/doc/man/image.man

@@ -0,0 +1,50 @@
+.TH Image
+.PP
+Extend the left operand with a new relation\-valued attribute, image of the
+tuple in the right relation.
+.SH Signature
+.PP
+.RS
+.nf
+image(left: Relation, right: Relation, as: AttrName) -> Relation
+.fi
+.RE
+.SH Examples
+.PP
+.RS
+.nf
+image(suppliers, supplies, :supplying)
+.fi
+.RE
+.SH Description
+.PP
+This operator extends each tuple of the left operand, say \fB\fCt\fR, with a new
+attribute called \fB\fCas\fR\&. The latter is a relation\-valued attribute, and is the
+image of \fB\fCt\fR with respect to the right relation. The image is defined as a
+restriction\-projection: restriction on tuples that match \fB\fCt\fR and projection
+on all but common attributes between left and right.
+.PP
+In other words, this operator is a shortcut for the following longer
+expression:
+.PP
+.RS
+.nf
+def image(left, right, as)
+  extend(left, as => ->(t){
+    allbut(
+      matching(right, 
+.BR Relation (t)),
+      left.attr_list & right.attr_list)
+  })
+end
+image(suppliers, supplies, :supplying)
+.fi
+.RE
+.PP
+Note that the image operator is such that every tuple of the left operand
+appears in the result, including those whose image is empty on right. As
+expected, an empty relation of correct relation type is used for those.
+.SH Implementation notes
+.PP
+As of current Alf version, the current SQL compilation is not optimal and
+partly relies on in\-memory operations. Please check the compilation plans.

data/doc/man/page.man

@@ -41,6 +41,7 @@ def page(operand, order, nth, page_size)
       lte((nth-1)*page_size, :rank) & lt(:rank, nth*page_size)),
     [:rank])
 end
+page(suppliers, [:status, :sid], 1, 3)
 .fi
 .RE
 .PP

data/doc/man/restrict.man

@@ -35,4 +35,4 @@ predicate evaluates to TRUE.
 .PP
 As of current Alf version, native predicates (through ruby \fB\fCProc\fR objects)
 cannot be optimized nor compiled to SQL. The use of predicate factories
-(\fB\fCeq\fR, \fB\fCgt\fR, etc.) is strongly recommanded.
+(\fB\fCeq\fR, \fB\fCgt\fR, etc.) is strongly recommended.

data/doc/man/summarize.man

@@ -41,5 +41,5 @@ That means that all computations are done in ruby, which may seriously
 hurt performance.
 .PP
 Similarly, as \fB\fCsummarize\fR tends to be a showstopper during compilation, it
-is strongly recommanded to use it as high as possible in query expressions
+is strongly recommended to use it as high as possible in query expressions
 trees so as to delegate the largest possible query parts to data engines.

data/doc/txt/alf-repl.man

@@ -0,0 +1,16 @@
+# alf-repl
+
+Launches Alf's Read-Eval-Print-Loop (REPL) web application.
+
+## Synopsis
+
+`alf` [`--db=...`] repl
+
+## Description
+
+This command launches the REPL in the current data context defined by the
+`.alfrc` file and common alf options (e.g. `--db`).
+
+## Example
+
+`alf` `--db=postgres://...` repl

data/doc/txt/alf.man

@@ -76,5 +76,8 @@ Relational algebra at your fingertips
   `explain`
     Show the logical (optimizer) and physical (compiler) plans of a query.
 
+  `repl`
+    Launches Alf's Read-Eval-Print-Loop (REPL) web application.
+
 See `alf help COMMAND` for details about a specific command or `alf help
 OPERATOR` for documentation of a relational operator.

data/doc/txt/extend.txt

@@ -25,5 +25,5 @@ In other words, all computations are done in ruby, which may seriously
 hurt performance.
 
 Similarly, as `extend` tends to be a showstopper during compilation, it is
-strongly recommanded to use it as high as possible in query expressions
+strongly recommended to use it as high as possible in query expressions
 trees so as to delegate the largest possible query parts to data engines.

data/doc/txt/image.txt

@@ -0,0 +1,41 @@
+# Image
+
+Extend the left operand with a new relation-valued attribute, image of the
+tuple in the right relation.
+
+## Signature
+
+image(left: Relation, right: Relation, as: AttrName) -> Relation
+
+## Examples
+
+image(suppliers, supplies, :supplying)
+
+## Description
+
+This operator extends each tuple of the left operand, say `t`, with a new
+attribute called `as`. The latter is a relation-valued attribute, and is the
+image of `t` with respect to the right relation. The image is defined as a
+restriction-projection: restriction on tuples that match `t` and projection
+on all but common attributes between left and right.
+
+In other words, this operator is a shortcut for the following longer
+expression:
+
+def image(left, right, as)
+  extend(left, as => ->(t){
+    allbut(
+      matching(right, Relation(t)),
+      left.attr_list & right.attr_list)
+  })
+end
+image(suppliers, supplies, :supplying)
+
+Note that the image operator is such that every tuple of the left operand
+appears in the result, including those whose image is empty on right. As
+expected, an empty relation of correct relation type is used for those.
+
+## Implementation notes
+
+As of current Alf version, the current SQL compilation is not optimal and
+partly relies on in-memory operations. Please check the compilation plans.

data/doc/txt/page.txt

@@ -30,6 +30,7 @@ def page(operand, order, nth, page_size)
       lte((nth-1)*page_size, :rank) & lt(:rank, nth*page_size)),
     [:rank])
 end
+page(suppliers, [:status, :sid], 1, 3)
 
 As of current Alf version, for this operator to be semantically sound and
 deterministic, `order` MUST be a total order, that is, it must at least

data/doc/txt/restrict.txt

@@ -23,4 +23,4 @@ predicate evaluates to TRUE.
 
 As of current Alf version, native predicates (through ruby `Proc` objects)
 cannot be optimized nor compiled to SQL. The use of predicate factories
-(`eq`, `gt`, etc.) is strongly recommanded.
+(`eq`, `gt`, etc.) is strongly recommended.

data/doc/txt/summarize.txt

@@ -29,5 +29,5 @@ That means that all computations are done in ruby, which may seriously
 hurt performance.
 
 Similarly, as `summarize` tends to be a showstopper during compilation, it
-is strongly recommanded to use it as high as possible in query expressions
+is strongly recommended to use it as high as possible in query expressions
 trees so as to delegate the largest possible query parts to data engines.

data/lib/alf-shell.rb

@@ -1 +1 @@
-require_relative "alf/shell"
+require_relative "alf/shell"

data/lib/alf/shell/command.rb

@@ -3,3 +3,4 @@ require_relative 'command/help'
 require_relative 'command/show'
 require_relative 'command/metadata'
 require_relative 'command/explain'
+require_relative 'command/repl'

data/lib/alf/shell/command/main.rb

@@ -95,7 +95,7 @@ module Alf
 
       def load_config
         config = Alf::Shell::DEFAULT_CONFIG.dup
-        if alfrc_file = Path.pwd.backfind('.alfrc')
+        if alfrc_file = Path.pwd.backfind('.alfrc') || Path.pwd.backfind('alfrc')
           config.alfrc(alfrc_file)
         end
         config
@@ -114,10 +114,8 @@ module Alf
 
       def rendering_options
         options = { float_format: config.float_format }
-        if config.pretty? and (hl = highline) and (hl.output_cols)
-          options[:pretty]  = config.pretty?
-          options[:trim_at] = hl.output_cols - 1
-        end
+        options[:pretty]  = config.pretty?
+        options[:trim_at] = trim_at if options[:pretty]
         options
       end
 
@@ -126,6 +124,12 @@ module Alf
         renderer.execute(out)
       end
 
+      def trim_at
+        return nil unless hl = highline
+        return nil unless cols = hl.output_cols
+        hl.output_cols - 1
+      end
+
       def highline
         require 'highline'
         HighLine.new($stdin, $stdout)

data/lib/alf/shell/command/metadata.rb

@@ -24,7 +24,12 @@ module Alf
       end
 
       def compile(argv)
-        operand(argv.shift)
+        op = operand(argv.shift)
+        op.heading
+        op
+      rescue Alf::NotSupportedError
+        op = op.to_relation
+        op
       end
 
     end # class Metadata

data/lib/alf/shell/command/repl.rb

@@ -0,0 +1,22 @@
+module Alf
+  module Shell
+    class Repl < Shell::Command(__FILE__, __LINE__)
+
+      options do |opt|
+
+        opt.on_tail('-h', "--help", "Show help") do
+          show_help("alf-repl")
+        end
+
+      end
+
+      def run(argv, requester)
+        require 'alf-repl'
+        Alf::Repl.database = requester.config.database
+        Alf::Repl.launch
+        Kernel.exit
+      end
+
+    end # class Repl
+  end # module Shell
+end # module Alf

data/lib/alf/shell/support.rb

@@ -22,7 +22,7 @@ module Alf
       end
 
       def show_help(who)
-        who = "alf-#{who}" if /explain|metadata|show/ =~ who
+        who = "alf-#{who}" if /explain|metadata|show|repl/ =~ who
         if p = Path.backfind("doc/man/#{who}.man")
           exit if system("man #{p}")
           puts Path.backfind("doc/txt/#{who}.txt").read

data/lib/alf/shell/version.rb

@@ -3,7 +3,7 @@ module Alf
     module Version
 
       MAJOR = 0
-      MINOR = 15
+      MINOR = 16
       TINY  = 0
 
       def self.to_s
@@ -13,4 +13,4 @@ module Alf
     end
     VERSION = Version.to_s
   end
-end
+end

data/spec/integration/alf/alf_yaml.stdout

@@ -1,22 +1,21 @@
 ---
-- :sid: S1
-  :name: Smith
-  :status: 20
-  :city: London
-- :sid: S2
-  :name: Jones
-  :status: 10
-  :city: Paris
-- :sid: S3
-  :name: Blake
-  :status: 30
-  :city: Paris
-- :sid: S4
-  :name: Clark
-  :status: 20
-  :city: London
-- :sid: S5
-  :name: Adams
-  :status: 30
-  :city: Athens
-
+- sid: S1
+  name: Smith
+  status: 20
+  city: London
+- sid: S2
+  name: Jones
+  status: 10
+  city: Paris
+- sid: S3
+  name: Blake
+  status: 30
+  city: Paris
+- sid: S4
+  name: Clark
+  status: 20
+  city: London
+- sid: S5
+  name: Adams
+  status: 30
+  city: Athens

data/spec/integration/show/show_yaml.stdout

@@ -1,22 +1,21 @@
 ---
-- :sid: S1
-  :name: Smith
-  :status: 20
-  :city: London
-- :sid: S2
-  :name: Jones
-  :status: 10
-  :city: Paris
-- :sid: S3
-  :name: Blake
-  :status: 30
-  :city: Paris
-- :sid: S4
-  :name: Clark
-  :status: 20
-  :city: London
-- :sid: S5
-  :name: Adams
-  :status: 30
-  :city: Athens
-
+- sid: S1
+  name: Smith
+  status: 20
+  city: London
+- sid: S2
+  name: Jones
+  status: 10
+  city: Paris
+- sid: S3
+  name: Blake
+  status: 30
+  city: Paris
+- sid: S4
+  name: Clark
+  status: 20
+  city: London
+- sid: S5
+  name: Adams
+  status: 30
+  city: Athens

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alf-shell
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-31 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,41 +48,41 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
-  name: highline
+  name: quickl
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
+        version: 0.4.3
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.4.3
 - !ruby/object:Gem::Dependency
-  name: alf-core
+  name: highline
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,23 +90,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: quickl
+  name: alf-core
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.16.0
 description: This project implements the `alf` commandline tool.
 email:
 - blambeau at gmail.com
@@ -121,6 +121,7 @@ files:
 - bin/alf
 - doc/man/alf-explain.man
 - doc/man/alf-metadata.man
+- doc/man/alf-repl.man
 - doc/man/alf-show.man
 - doc/man/alf.man
 - doc/man/allbut.man
@@ -136,6 +137,7 @@ files:
 - doc/man/group.man
 - doc/man/gt.man
 - doc/man/gte.man
+- doc/man/image.man
 - doc/man/intersect.man
 - doc/man/join.man
 - doc/man/lt.man
@@ -163,6 +165,7 @@ files:
 - doc/man/wrap.man
 - doc/txt/alf-explain.man
 - doc/txt/alf-metadata.man
+- doc/txt/alf-repl.man
 - doc/txt/alf-show.man
 - doc/txt/alf.man
 - doc/txt/allbut.txt
@@ -178,6 +181,7 @@ files:
 - doc/txt/group.txt
 - doc/txt/gt.txt
 - doc/txt/gte.txt
+- doc/txt/image.txt
 - doc/txt/intersect.txt
 - doc/txt/join.txt
 - doc/txt/lt.txt
@@ -208,6 +212,7 @@ files:
 - lib/alf/shell/command/help.rb
 - lib/alf/shell/command/main.rb
 - lib/alf/shell/command/metadata.rb
+- lib/alf/shell/command/repl.rb
 - lib/alf/shell/command/show.rb
 - lib/alf/shell/command.rb
 - lib/alf/shell/loader.rb
@@ -277,7 +282,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1197934734732335619
+      hash: -1823649938307432080
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -286,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1197934734732335619
+      hash: -1823649938307432080
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25