alf 0.10.1 → 0.11.0

data/lib/alf-shell/alf/shell.rb

@@ -0,0 +1,40 @@
+require_relative 'shell/doc_manager'
+module Alf
+  module Shell
+
+    # This is the main documentation extractor
+    DOC_EXTRACTOR = DocManager.new
+
+    # Delegator command factory
+    def self.Delegator() 
+      Quickl::Delegator(){|builder|
+        builder.doc_extractor = DOC_EXTRACTOR
+        builder.class_module Command::ClassMethods
+        yield(builder) if block_given?
+      }
+    end
+
+    # Command factory
+    def self.Command() 
+      Quickl::Command(){|builder|
+        builder.command_parent = Alf::Shell::Main
+        builder.doc_extractor  = DOC_EXTRACTOR
+        builder.class_module Command::ClassMethods
+        yield(builder) if block_given?
+      }
+    end
+
+    # Operator factory
+    def self.Operator() 
+      Quickl::Command(){|builder|
+        builder.command_parent = Alf::Shell::Main
+        builder.doc_extractor  = DOC_EXTRACTOR
+        builder.class_module Operator::ClassMethods
+        yield(builder) if block_given?
+      }
+    end
+
+  end # module Shell
+end # module Alf
+require_relative 'shell/command'
+require_relative 'shell/operator'

data/lib/{alf/extra/yaml.rb → alf-yaml/alf/yaml/renderer.rb}

@@ -1,13 +1,12 @@
 module Alf
   module YAML
-
     #
     # Implements Alf::Renderer contract for outputing YAML files.
     #
     class Renderer < ::Alf::Renderer
-      
+
       protected 
-      
+
       # (see Alf::Renderer#render)
       def render(input, output)
          require "yaml"
@@ -16,9 +15,8 @@ module Alf
         output << input.to_a.to_yaml << "\n"
         output
       end
-  
-      ::Alf::Renderer.register(:yaml, "as a yaml output",  self)
+
+      Alf::Renderer.register(:yaml, "as a yaml output",  self)
     end # class Renderer
-    
   end # module YAML
-end # module Alf
+end # module Alf

data/lib/alf-yaml/alf/yaml.rb

@@ -0,0 +1 @@
+require_relative 'yaml/renderer'

data/lib/alf.rb

@@ -13,363 +13,17 @@ require 'myrrha/coerce'
 # Classy data-manipulation dressed in a DSL (+ commandline)
 #
 module Alf
-
-  #
-  # Encapsulates all types
-  #
-  module Types
-    require 'alf/types/attr_name'
-    require 'alf/types/boolean'
-    require 'alf/types/heading'
-    require 'alf/types/ordering'
-    require 'alf/types/attr_list'
-    require 'alf/types/renaming'
-    require 'alf/types/tuple_expression'
-    require 'alf/types/tuple_predicate'
-    require 'alf/types/summarization'
-    require 'alf/types/tuple_computation'
-
-    # Install all types on Alf now
-    constants.each do |s|
-      Alf.const_set(s, const_get(s))
-    end
-  end
-
-  #
-  # Provides tooling methods that are used here and there in Alf.
-  # 
-  module Tools
-    require 'alf/tools/coerce'
-    require 'alf/tools/to_ruby_literal'
-    require 'alf/tools/to_lispy'
-    require 'alf/tools/tuple_handle'
-    require 'alf/tools/miscellaneous'
-
-    extend Tools
-  end # module Tools
-  
-  #
-  # Encapsulates the interface with the outside world, providing base iterators
-  # for named datasets, among others.
-  #
-  # An environment is typically obtained through the factory defined by this
-  # class:
-  #
-  #   # Returns the default environment (examples, for now)
-  #   Alf::Environment.default
-  #
-  #   # Returns an environment on Alf's examples
-  #   Alf::Environment.examples
-  #
-  #   # Returns an environment on a specific folder, automatically
-  #   # resolving datasources via Readers' recognized file extensions
-  #   Alf::Environment.folder('path/to/a/folder')
-  #
-  # You can implement your own environment by subclassing this class and 
-  # implementing the {#dataset} method. As additional support is implemented 
-  # in the base class, Environment should never be mimiced.
-  #
-  # This class provides an extension point allowing to participate to auto 
-  # detection and resolving of the --env=... option when alf is used in shell.
-  # See Environment.register, Environment.autodetect and Environment.recognizes?
-  # for details. 
-  # 
-  class Environment
-    require 'alf/environment/class_methods'
-    require 'alf/environment/base'
-    require 'alf/environment/explicit'
-    require 'alf/environment/folder'
-
-  end # class Environment
-
-  #
-  # Marker module for all elements implementing tuple iterators.
-  #
-  # At first glance, an iterator is nothing else than an Enumerable that serves 
-  # tuples (represented by ruby hashes). However, this module helps Alf's internal
-  # classes to recognize enumerables that may safely be considered as tuple 
-  # iterators from other enumerables. For this reason, all elements that would
-  # like to participate to an iteration chain (that is, an logical operator 
-  # implementation) should be marked with this module. This is the case for 
-  # all Readers and Operators defined in Alf.
-  #
-  # Moreover, an Iterator should always define a {#pipe} method, which is the
-  # natural way to define the input and execution environment of operators and 
-  # readers. 
-  # 
-  module Iterator
-    include Enumerable
-
-    require 'alf/iterator/class_methods'
-    require 'alf/iterator/base'
-    require 'alf/iterator/proxy'
-  end # module Iterator
-
-  #
-  # Implements an Iterator at the interface with the outside world.
-  #
-  # The contrat of a Reader is simply to be an Iterator. Unlike operators, 
-  # however, readers are not expected to take other iterators as input, but IO 
-  # objects, database tables, or something similar instead. This base class 
-  # provides a default behavior for readers that works with IO objects. It can 
-  # be safely extended, overriden, or even mimiced (provided that you include 
-  # and implement the Iterator contract).
-  #
-  # This class also provides a registration mechanism to help getting Reader 
-  # instances for specific file extensions. A typical scenario for using this
-  # registration mechanism is as follows:
-  #
-  #   # Registers a reader kind named :foo, associated with ".foo" file 
-  #   # extensions and the FooFileDecoder class (typically a subclass of 
-  #   # Reader)
-  #   Reader.register(:foo, [".foo"], FooFileDecoder)   
-  #
-  #   # Later on, you can request a reader instance for a .foo file, as 
-  #   # illustrated below.  
-  #   r = Reader.reader('/a/path/to/a/file.foo')
-  #
-  #   # Also, a factory method is automatically installed on the Reader class
-  #   # itself. This factory method can be used with a String, or an IO object.
-  #   r = Reader.foo([a path or a IO object])
-  #
-  class Reader
-    include Iterator
-
-    require 'alf/reader/class_methods'
-    require 'alf/reader/base'
-    require 'alf/reader/rash'
-    require 'alf/reader/alf_file'
-  end # class Reader
-
-  #
-  # Renders a relation (given by any Iterator) in a specific format.
-  #
-  # A renderer takes an Iterator instance as input and renders it on an output
-  # stream. Renderers are **not** iterators themselves, even if they mimic the
-  # {#pipe} method. Their usage is made via the {#execute} method.
-  #
-  # Similarly to the {Reader} class, this one provides a registration mechanism
-  # for specific output formats. The common scenario is as follows:
-  #
-  #   # Register a new renderer for :foo format (automatically provides the 
-  #   # '--foo   Render output as a foo stream' option of 'alf show') and with
-  #   # the FooRenderer class for handling rendering.  
-  #   Renderer.register(:foo, "as a foo stream", FooRenderer)
-  #
-  #   # Later on, you can request a renderer instance for a specific format
-  #   # as follows (wiring input is optional) 
-  #   r = Renderer.renderer(:foo, [an Iterator])
-  #
-  #   # Also, a factory method is automatically installed on the Renderer class
-  #   # itself.
-  #   r = Renderer.foo([an Iterator])
-  #
-  class Renderer
-    require 'alf/renderer/class_methods'
-    require 'alf/renderer/base'
-    require 'alf/renderer/rash'
-    require 'alf/renderer/text'
-
-  end # class Renderer
-
-  #
-  # Marker module and namespace for Alf main commands, those that are **not** 
-  # operators at all. 
-  #
-  module Command
-    require 'alf/command/class_methods'
-    require 'alf/command/doc_manager'
-
-    # This is the main documentation extractor
-    DOC_EXTRACTOR = DocManager.new
-
-    #
-    # Delegator command factory
-    #
-    def Alf.Delegator() 
-      Quickl::Delegator(){|builder|
-        builder.doc_extractor = DOC_EXTRACTOR
-        yield(builder) if block_given?
-      }
-    end
-
-    #
-    # Command factory
-    #
-    def Alf.Command() 
-      Quickl::Command(){|builder|
-        builder.command_parent = Alf::Command::Main
-        builder.doc_extractor  = DOC_EXTRACTOR
-        yield(builder) if block_given?
-      }
-    end
-
-    require 'alf/command/main'
-    require 'alf/command/exec'
-    require 'alf/command/help'
-    require 'alf/command/show'
-  end # module Command
-  
-  #
-  # Marker for all operators, relational and non-relational ones.
-  # 
-  module Operator
-    include Iterator, Tools
-
-    #
-    # Operator factory
-    #
-    def Alf.Operator()
-      Alf.Command() do |b|
-        b.instance_module Alf::Operator
-      end
-    end
-
-    require 'alf/operator/class_methods'
-    require 'alf/operator/signature'
-    require 'alf/operator/base'
-    require 'alf/operator/nullary'
-    require 'alf/operator/unary'
-    require 'alf/operator/binary'
-    require 'alf/operator/cesure'
-    require 'alf/operator/transform'
-    require 'alf/operator/shortcut'
-    require 'alf/operator/experimental'
-
-    
-    #
-    # Marker module and namespace for non relational operators
-    #
-    module NonRelational
-      require 'alf/operator/non_relational/autonum'
-      require 'alf/operator/non_relational/defaults'
-      require 'alf/operator/non_relational/compact'
-      require 'alf/operator/non_relational/sort'
-      require 'alf/operator/non_relational/clip'
-      require 'alf/operator/non_relational/coerce'
-      require 'alf/operator/non_relational/generator'
-  
-      #
-      # Yields the block with each operator module in turn
-      #
-      def self.each
-        constants.each do |c|
-          val = const_get(c)
-          yield(val) if val.ancestors.include?(Operator::NonRelational)
-        end
-      end
-      
-    end # NonRelational
-    
-    #
-    # Marker module and namespace for relational operators
-    #
-    module Relational
-      require 'alf/operator/relational/extend'
-      require 'alf/operator/relational/project'
-      require 'alf/operator/relational/restrict'
-      require 'alf/operator/relational/rename'
-
-      require 'alf/operator/relational/union'
-      require 'alf/operator/relational/minus'
-      require 'alf/operator/relational/intersect'
-      require 'alf/operator/relational/join'
-
-      require 'alf/operator/relational/matching'
-      require 'alf/operator/relational/not_matching'
-
-      require 'alf/operator/relational/wrap'
-      require 'alf/operator/relational/unwrap'
-
-      require 'alf/operator/relational/group'
-      require 'alf/operator/relational/ungroup'
-
-      require 'alf/operator/relational/summarize'
-      require 'alf/operator/relational/rank'
-      require 'alf/operator/relational/quota'
-
-      require 'alf/operator/relational/heading'
-  
-      # 
-      # Yields the block with each operator module in turn
-      #
-      def self.each
-        constants.each do |c|
-          val = const_get(c)
-          yield(val) if val.ancestors.include?(Operator::Relational)
-        end
-      end
-    
-    end # module Relational
-    
-  end # module Operator
-
-  #
-  # Aggregation operator.
-  #
-  class Aggregator
-    require 'alf/aggregator/class_methods'
-    require 'alf/aggregator/base'
-    require 'alf/aggregator/aggregators'
-
-  end # class Aggregator
-  
-  #
-  # Base class for implementing buffers.
-  # 
-  class Buffer
-    require 'alf/buffer/sorted'
-
-  end # class Buffer
-
-  #
-  # Defines an in-memory relation data structure.
-  #
-  # A relation is a set of tuples; a tuple is a set of attribute (name, value)
-  # pairs. The class implements such a data structure with full relational
-  # algebra installed as instance methods.
-  #
-  # Relation values can be obtained in various ways, for example by invoking
-  # a relational operator on an existing relation. Relation literals are simply
-  # constructed as follows:
-  #
-  #     Alf::Relation[
-  #       # ... a comma list of ruby hashes ...
-  #     ]
-  #
-  # See main Alf documentation about relational operators.
-  #
-  class Relation
-    include Iterator
-
-    require "alf/relation/class_methods"
-    require "alf/relation/instance_methods"
-
-    DEE = Relation.coerce([{}])
-    DUM = Relation.coerce([])
-  end # class Relation
-
-  # Implements a small LISP-like DSL on top of Alf.
-  #
-  # The lispy dialect is the functional one used in .alf files and in compiled
-  # expressions as below:
-  #
-  #   Alf.lispy.compile do
-  #     (restrict :suppliers, lambda{ city == 'London' })
-  #   end
-  #
-  # The DSL this module provides is part of Alf's public API and won't be broken 
-  # without a major version change. The module itself and its inclusion pre-
-  # conditions are not part of the DSL itself, thus not considered as part of 
-  # the API, and may therefore evolve at any time. In other words, this module 
-  # is not intended to be directly included by third-party classes. 
-  #
-  module Lispy
-    require 'alf/lispy/instance_methods'
-    
-    DUM = Relation::DUM
-    DEE = Relation::DEE
-  end # module Lispy
+  require 'alf/types'
+  require 'alf/tools'
+  require 'alf/environment'
+  require 'alf/iterator'
+  require 'alf/reader'
+  require 'alf/renderer'
+  require 'alf/operator'
+  require 'alf-shell/alf/shell'
+  require 'alf/aggregator'
+  require 'alf/relation'
+  require 'alf/lispy'
 
   #
   # Builds and returns a lispy engine on a specific environment.
@@ -394,4 +48,9 @@ module Alf
   end
   
 end # module Alf
-require "alf/extra"
+
+require_relative "alf-engine/alf/engine"
+require_relative "alf-sequel/alf/sequel"
+require_relative 'alf-yaml/alf/yaml'
+require_relative 'alf-csv/alf/csv'
+require_relative 'alf-logs/alf/logs'

data/spec/integration/shell/alf/alf_env.cmd

@@ -0,0 +1 @@
+alf --env=$(_("shell/alf",__FILE__)) show rel

data/spec/integration/shell/alf/alf_env_sqlite.cmd

@@ -0,0 +1 @@
+alf --env=$(_("shell/alf/alf.db",__FILE__)) show suppliers

data/spec/integration/shell/alf/alf_implicit_exec.cmd

@@ -0,0 +1 @@
+alf $(_("shell/alf/alf_implicit.alf",__FILE__))

data/spec/integration/shell/autonum/autonum_1.cmd

@@ -0,0 +1 @@
+alf --text autonum suppliers -- unique_id

data/spec/integration/shell/clip/clip_0.cmd

@@ -0,0 +1 @@
+alf --text clip suppliers -- name city

data/spec/integration/shell/clip/clip_1.cmd

@@ -0,0 +1 @@
+alf --text clip suppliers --allbut -- name city

data/spec/integration/{command → shell}/rank/rank_1.stdout

@@ -4,7 +4,7 @@
 | P1   | Nut   | Red    |  12.000 | London |     0 |
 | P5   | Cam   | Blue   |  12.000 | Paris  |     0 |
 | P4   | Screw | Red    |  14.000 | London |     2 |
-| P2   | Bolt  | Green  |  17.000 | Paris  |     3 |
 | P3   | Screw | Blue   |  17.000 | Oslo   |     3 |
+| P2   | Bolt  | Green  |  17.000 | Paris  |     3 |
 | P6   | Cog   | Red    |  19.000 | London |     5 |
 +------+-------+--------+---------+--------+-------+