alf-shell 0.14.0 → 0.15.0

data/doc/operators/relational/minus.md

@@ -1,12 +0,0 @@
-
-Relational minus (aka difference)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator computes the difference between its two operands. The 
-difference is simply the set of LEFT tuples non present in RIGHT.
-

data/doc/operators/relational/not-matching.md

@@ -1,20 +0,0 @@
-
-Relational not matching (inverse of matching)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator restricts LEFT tuples to those for which there does not 
-exist any tuple in RIGHT that (naturally) joins. This is a shortcut 
-operator for the following longer expression: 
-
-    (minus xxx, (matching xxx, yyy))
-
-EXAMPLE
-
-    # Which suppliers do not supply any part?
-    !(alf not-matching suppliers supplies)
-

data/doc/operators/relational/page.md

@@ -1,31 +0,0 @@
-
-Relational pagination (like frame, but easier)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This command provides pagination over the input relation.
-
-When page_index is positive (resp. striclty negative), this operator returns
-`page_size` tuples whose ranking according to `ordering` (resp. reverse
-ordering) is between `page_size * (page_index - 1)` and `page_size * page_index`
-(excluded).
-
-To be sound, this operator requires the ordering to include a candidate key
-for the input relation. Alf will automatically extend the ordering you provide
-to guarantee this, provided key inference is possible.
-
-EXAMPLE
-
-    # Take the first two suppliers ordered by name (then by id)
-    !(alf page --page-size=2 suppliers -- name -- 1)
-
-    # Take the next two suppliers
-    !(alf page --page-size=2 suppliers -- name -- 2)
-
-    # Take the last two suppliers
-    !(alf page --page-size=2 suppliers -- name -- -1)
-

data/doc/operators/relational/project.md

@@ -1,28 +0,0 @@
-
-Relational projection (clip + compact)
-
-SYNOPSIS
-
-    #(signature)
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This operator projects tuples on attributes whose names are specified in 
-ATTRIBUTES. Unlike SQL, this operator **always** removes duplicates in the
-result so that the output is a set of tuples, that is, a relation.
-
-With the allbut option, the operator projects ATTRIBUTES away instead of 
-keeping them. 
-
-EXAMPLE
-
-    # What are supplier cities ?
-    !(alf project suppliers -- city)
-
-    # What are all but supplier's id and name
-    !(alf project --allbut suppliers -- sid name)
-

data/doc/operators/relational/quota.md

@@ -1,21 +0,0 @@
-
-Generalized quota-queries (position, sum progression, etc.)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-**This operator is a work in progress and should be used with care.**
-
-This operator is an attempt to generalize RANK in two directions:
-
-* Use a full SUMMARIZATION instead of hard-coding a ranking attribute via count()
-* Providing a BY key so that summarizations can actually be done on sub-groups
-
-EXAMPLE
-
-    # Compute linear progression of quantities by supplier number
-    !(alf quota supplies -- sid -- qty -- position count  sum_qty "sum{ qty }")
-

data/doc/operators/relational/rank.md

@@ -1,27 +0,0 @@
-
-Relational ranking (explicit tuple positions)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator computes the ranking of input tuples, according to ORDER. 
-
-Precisely, it extends its operand with an attribute called AS whose value 
-is the number of tuples which are considered strictly less according to the
-order relation denoted by ORDER.
-
-Note that, unless the ordering includes a candidate key for the input relation, 
-the new AS attribute is not necessarily a candidate key for the output. 
-
-EXAMPLE
-
-    # Rank parts by weight 
-    !(alf rank parts -- weight -- position)
-
-    # Rank parts by weight in descending order. Ensure that position is a 
-    # candidate key by including a key in ordering
-    !(alf rank parts -- weight desc pid asc -- position)
-

data/doc/operators/relational/rename.md

@@ -1,17 +0,0 @@
-
-Relational renaming (rename some attributes)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This command renames attributes as specified in RENAMING, taken as successive 
-(old name, new name) pairs
-
-EXAMPLE
-
-    # Rename a few supplier attributes
-    !(alf rename suppliers -- name supplier_name  city supplier_city)
-

data/doc/operators/relational/restrict.md

@@ -1,25 +0,0 @@
-
-Relational restriction (aka where, predicate filtering)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This command restricts restricts relations to those tuples for which PREDICATE 
-evaluates to true.
-
-PREDICATE must be a valid tuple expression that returns a truth-value. It 
-may be specified as a ruby code literal, or a mapping between (name, value) 
-pairs. In the latter case, PREDICATE is built as a conjunction of attribute 
-equalities.
-
-EXAMPLE
-
-    # Who are suppliers with a status greater than 20?
-    !(alf restrict suppliers -- "status > 20")
-
-    # Which suppliers live in London?
-    !(alf restrict suppliers -- city "'London'")
-

data/doc/operators/relational/summarize.md

@@ -1,25 +0,0 @@
-
-Relational summarization (group-by + aggregate ops)
-
-SYNOPSIS
-
-    #(signature)
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This operator summarizes input tuples over a projection given by BY. 
-SUMMARIZATION is a mapping between attribute names and summarizing 
-expressions.
-
-With the allbut option, the operator uses all attributes not specified 
-in BY as the projection key.
-
-EXAMPLE
-
-    # Compute the sum of supplied quantities, by supplier id
-    !(alf summarize supplies -- sid -- total_qty "sum{ qty }")
-

data/doc/operators/relational/ungroup.md

@@ -1,20 +0,0 @@
-
-Relational un-grouping (inverse of group)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator flattens its operand by ungrouping the relation-valued 
-attribute ATTR. 
-
-EXAMPLE
-
-    # Given `pid` and `qty` groupped as `supplying`
-    !(alf group supplies -- pid qty -- supplying)
-
-    # Let's ungroup them
-    !(alf group supplies -- pid qty -- supplying | alf ungroup -- supplying)
-

data/doc/operators/relational/union.md

@@ -1,14 +0,0 @@
-
-Relational union
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator computes the union of its operands, that is the set of 
-tuples that appear in LEFT or in RIGHT. 
-
-The result is a valid relation in that it never contains duplicates.
-

data/doc/operators/relational/unwrap.md

@@ -1,20 +0,0 @@
-
-Relational un-wrapping (inverse of wrap)
-
-SYNOPSIS
-
-    #(signature)
-
-DESCRIPTION
-
-This operator flattens its operand by unwrapping the tuple-valued 
-attribute ATTR.
-
-EXAMPLE
-
-    # Given, `city` and `status` wrapped as `loc_and_status` 
-    !(alf wrap suppliers -- city status -- loc_and_status)
-
-    # Let's unwrap them
-    !(alf wrap suppliers -- city status -- loc_and_status | alf unwrap -- loc_and_status)
-

data/doc/operators/relational/wrap.md

@@ -1,24 +0,0 @@
-
-Relational wrapping (tuple-valued attributes)
-
-SYNOPSIS
-
-    #(signature)
-
-OPTIONS
-
-    #(summarized_options)
-
-DESCRIPTION
-
-This operator wraps attributes in ATTRIBUTES as a new, tuple-valued attribute 
-named AS.
-
-With the allbut option, it wraps all attributes not specified in ATTRIBUTES 
-instead.
-
-EXAMPLE
-
-    # Wrap `city` and `status` and a tuple-value attribute named `loc_and_status` 
-    !(alf wrap suppliers -- city status -- loc_and_status)
-

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

@@ -1,16 +0,0 @@
-module Alf
-  module Shell
-    class Exec < Shell::Command()
-
-      def execute(args)
-        cmd = if f = args.first
-          Path(f).read
-        else
-          $stdin.read
-        end
-        connection.query(cmd)
-      end
-
-    end # class Exec
-  end # module Shell
-end # module Alf

data/lib/alf/shell/doc_manager.rb

@@ -1,84 +0,0 @@
-module Alf
-  module Shell
-    class DocManager
-
-      # Main documentation folder
-      DOC_FOLDER = Path.backfind("doc")
-
-      #
-      # Called by Quickl when it's time to generate documentation of `cmd`.
-      #
-      def call(cmd, options = {})
-        if (file = find_file(cmd)).file?
-          text = file.read
-
-          # Replace occurences of #{signature} to #{signature.to_xxx}
-          # according to options
-          method = (options[:method] || "shell").to_s
-          text = text.gsub('#(signature)', '#(signature.to_' + method + ')')
-
-          # Replace occurences of #{...} on single lines
-          text = text.gsub(/^([ \t]*)#\(([^\)]+)\)/){|match|
-            spacing, invocation  = $1, $2
-            res = cmd.instance_eval(invocation).to_s
-            realign(res, spacing, true)
-          }
-
-          # Replace occurences of #{...} in other places
-          text = text.gsub(/#\(([^\)]+)\)/){|match|
-            cmd.instance_eval($1).to_s
-          }
-
-          # Replace occurences of !{...} by the execution of the example
-          text = text.gsub(/^([ \t]*)!\(([^\)]+)\)/){|match|
-            spacing, invocation  = $1, $2
-            args = Quickl.parse_commandline_args(invocation)[1..-1]
-            op   = run_alf_command(args)
-            res  = op.to_relation.to_s
-            res  = realign(res, spacing, false)[0...-1]
-            if options[:method] == :lispy
-              invocation = Alf::Support.to_lispy(op)
-            end
-            realign("$ #{invocation}\n\n#{res}", spacing, false)
-          }
-
-        else
-          "Sorry, no documentation available for #{cmd.command_name}"
-        end
-      end
-
-    private
-
-      def run_alf_command(argv, requester = nil)
-        argv = Quickl.parse_commandline_args(argv) if argv.is_a?(String)
-        argv = Quickl.split_commandline_args(argv, '|')
-        argv.inject(nil) do |cmd,arr|
-          arr.shift if arr.first == "alf"
-          main = Alf::Shell::Main.new(Alf::Shell::DEFAULT_CONFIG)
-          main.config.adapter = Alf.examples_adapter
-          main.stdin_operand = cmd unless cmd.nil?
-          main.run(arr, requester)
-        end
-      end
-
-      def realign(txt, spacing, strip)
-        rx = strip ? /^[ \t]*/ : /^/
-        txt.gsub(rx, spacing)
-      end
-
-      def find_file(cmd)
-        where = if cmd.command?
-          "commands"
-        elsif cmd.operator? && cmd.relational?
-          File.join("operators", "relational")
-        elsif cmd.operator? && cmd.non_relational?
-          File.join("operators", "non_relational")
-        else
-          raise "Unexpected command #{cmd}"
-        end
-        DOC_FOLDER/where/"#{cmd.command_name}.md"
-      end
-
-    end # class DocManager
-  end # module Shell
-end # module Alf

data/lib/alf/shell/ext/signature.rb

@@ -1,45 +0,0 @@
-module Alf
-  module Algebra
-    class Signature
-
-      # Converts commandline arguments to operator constructor arguments
-      def argv2args(argv)
-        # First split over --
-        argv = Quickl.split_commandline_args(argv)
-
-        # Parse the options and replace argv[0] by remaining arguments
-        opts = {}
-        argv[0] = option_parser(opts).parse!(argv[0])
-        opts = default_options.merge(opts)
-
-        # Operands are argv[0], and can be removed
-        oper = argv.shift
-
-        # Coerce each remaining argument according to the signature
-        args = []
-        with_each_arg(argv) do |name,dom,value|
-          invalid_args!(args) if value.nil?
-          args << Shell.from_argv(Array(value), dom)
-        end
-
-        [oper, args, opts]
-      end
-
-      # Returns a shell synopsis for this signature.
-      #
-      # Example:
-      #
-      #     Alf::Algebra::Project.signature.to_shell
-      #     # => "alf project [--allbut] [OPERAND] -- ATTRIBUTES"
-      def to_shell
-        oper = operator.nullary? ? "" :
-              (operator.unary? ? "[OPERAND]" : "[LEFT] RIGHT")
-        opts =   options.map{|opt|   "[#{option_name(opt)}]" }.join(" ")
-        args = arguments.map{|arg,_| "#{arg.to_s.upcase}"    }.join(" -- ")
-        optargs = "#{opts} #{oper} " + (args.empty? ? "" : "-- #{args}")
-        "alf #{operator.rubycase_name} #{optargs.strip}".strip
-      end
-
-    end # class Signature
-  end # module Algebra
-end # module Alf