bmg 0.16.4 → 0.16.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec6ef6942310f94d0893f99b34c0d131bed54e0b0d3bee033b10998e09f5b1ef
-  data.tar.gz: a8fe62d1d072c78c96d9e171f17f8e8f039bd12714c443d7b3921e40d696ef6c
+  metadata.gz: 9e4b73e390d1670e392a0e8b69eec34bb0ea7fe837d7da213c2dd58372a56676
+  data.tar.gz: 557cc26029356c47b2f93ac960f485faf632b09992f41e53ebe05f7c1a1c735a
 SHA512:
-  metadata.gz: 973a0716b0602f10175eec3eff15cd3515b36f58fd2021d65eb1e6a307808534b58f4fc514bac8d742fd82115ba757b99401a6f50314a899331019f2bc3d961f
-  data.tar.gz: b0f7fb3dba7d8d3810b45b2b0342cacd100ba857969c423f88d28e6c076d1d11879b7a72ced07434ecd88088be93a2dfecb7572cda1a9f396aff4813018c8971
+  metadata.gz: 6962061ff3bb5243ea02569621c7b664af1b2659a90d8351c7b39a132abaabf3646bbe2b51dcc44a184bde0ee74b310377d60531670b63d80e70c710961f7493
+  data.tar.gz: 275e205ace8d529ffaa72ffbd017292300547899e3d6ca515ac0cfcef1f1fd15b3337dd657c31f5d8a39d12ad929076cc6d7a20b7c174b4f55c5f81a587ceb2a

data/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT Licence
 
-    Copyright (c) 2017 - Enspirit SPRL (Bernard Lambeau)
+    Copyright (c) 2019 - Enspirit SPRL (Bernard Lambeau)
 
     Permission is hereby granted, free of charge, to any person obtaining
     a copy of this software and associated documentation files (the

data/README.md

@@ -1,3 +1,82 @@
-## Bmg, Alf's successor, the relational algebra!
+# Bmg, a relational algebra (Alf's successor)!
 
-Coming soon.
+Bmg is a relational algebra implemented as a ruby library. It implements the
+[Relation as First-Class Citizen](http://www.try-alf.org/blog/2013-10-21-relations-as-first-class-citizen)
+paradigm contributed with Alf a few years ago.
+
+Like Alf, Bmg can be used to query relations in memory, from various files,
+SQL databases, and any data sources that can be seen as serving relations.
+Cross data-sources joins are supported, as with Alf.
+
+Unlike Alf, Bmg does not make any core ruby extension and exposes the
+object-oriented syntax only (not Alf's functional one). Bmg implementation is
+also much simpler, and make its easier to implement user-defined relations.
+
+## Example
+
+```
+require 'bmg'
+require 'json'
+
+suppliers = Bmg::Relation.new([
+  { 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" }
+])
+
+by_city = suppliers
+  .restrict(Predicate.neq(status: 30))
+  .extend(upname: ->(t){ t[:name].upcase })
+  .group([:sid, :name, :status], :suppliers_in)
+
+puts JSON.pretty_generate(by_city)
+```
+
+## Connecting to a SQL database
+
+Bmg requires `sequel >= 3.0` to connect to SQL databases.
+
+```
+require 'sqlite3'
+require 'bmg'
+require 'bmg/sequel'
+
+DB = Sequel.connect("sqlite://suppliers-and-parts.db")
+
+suppliers = Bmg.sequel(:suppliers, DB)
+
+puts suppliers
+  .restrict(Predicate.neq(status: 30))
+  .to_sql
+
+# SELECT `t1`.`sid`, `t1`.`name`, `t1`.`status`, `t1`.`city` FROM `suppliers` AS 't1' WHERE (`t1`.`status` != 30)
+```
+
+## Supported operators
+
+```
+r.allbut([:a, :b, ...])                      # remove specified attributes
+r.autowrap(split: '_')                       # structure a flat relation, split: '_' is the default
+r.autosummarize([:a, :b, ...], x: :sum)      # (experimental) usual summarizers supported
+r.constants(x: 12, ...)                      # add constant attributes (sometimes useful in unions)
+r.extend(x: ->(t){ ... }, ...)               # add computed attributes
+r.group([:a, :b, ...], :x)                   # relation-valued attribute from attributes
+r.image(right, :x, [:a, :b, ...])            # relation-valued attribute from another relation
+r.join(right, [:a, :b, ...])                 # natural join on a join key
+r.join(right, :a => :x, :b => :y, ...)       # natural join after right reversed renaming
+r.matching(right, [:a, :b, ...])             # semi join, aka where exists
+r.matching(right, :a => :x, :b => :y, ...)   # semi join, after right reversed renaming
+r.not_matching(right, [:a, :b, ...])         # inverse semi join, aka where not exists
+r.not_matching(right, :a => :x, ...)         # inverse semi join, after right reversed renaming
+r.page([[:a, :asc], ...], 12, page_size: 10) # paging, using an explicit ordering
+r.prefix(:foo_, but: [:a, ...])              # prefix kind of renaming
+r.project([:a, :b, ...])                     # keep specified attributes only
+r.rename(a: :x, b: :y, ...)                  # rename some attributes
+r.restrict(a: "foo", b: "bar", ...)          # relational restriction, aka where
+r.rxmatch([:a, :b, ...], /xxx/)              # regex match kind of restriction
+r.summarize([:a, :b, ...], x: :sum)          # relational summarization
+r.suffix(:_foo, but: [:a, ...])              # suffix kind of renaming
+r.union(right)                               # relational union
+```

data/lib/bmg/operator/autowrap.rb

@@ -152,6 +152,9 @@ module Bmg
           parts[0...-1].each do |part|
             sub = (sub[part] ||= {})
           end
+          unless sub.is_a?(Hash)
+            raise Bmg::Error, "Autowrap conflict on attribute `#{parts[-2]}`"
+          end
           sub[parts[-1]] = v
           h
         }

data/lib/bmg/relation.rb

@@ -75,10 +75,16 @@ module Bmg
     end
     protected :_visit
 
+    def y_by_x(y, x, options = {})
+      each_with_object({}) do |tuple, h|
+        h[tuple[x]] = tuple[y]
+      end
+    end
+
     def ys_by_x(y, x, options = {})
       ordering = options[:order]
       projection = [y, ordering].compact.uniq
-      by_x = each.each_with_object({}) do |tuple,h|
+      by_x = each_with_object({}) do |tuple,h|
         h[tuple[x]] ||= []
         h[tuple[x]] << TupleAlgebra.project(tuple, projection)
       end

data/lib/bmg/version.rb

@@ -2,7 +2,7 @@ module Bmg
   module Version
     MAJOR = 0
     MINOR = 16
-    TINY  = 4
+    TINY  = 5
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bmg
 version: !ruby/object:Gem::Version
-  version: 0.16.4
+  version: 0.16.5
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: predicate