raka 0.3.10 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b60f08a9cd2e6eab01c50ffb66d376ea5ec8844f0bab5833b50c2815bd72c54
-  data.tar.gz: a22f6674301f4aa432e6fcc7ce385f69814e0cc41bdae8fa5a4bc3f443523592
+  metadata.gz: e7433868304f673611a2ce9b5e847a8a78cd6bbd0be86fe18d576090acf7009f
+  data.tar.gz: ebe65786208dfd8bf1e35ea83a6ad625279018aa3a73df14599392bbaa91d684
 SHA512:
-  metadata.gz: aaf7d321bca22ee70c6872673a4b10421f9451c6d45c11803ff766a08ed1d16ec0acd754755af19bd16519e7d2e95ed8365caf4b8c1a4b5d1f5b70b79485a0f1
-  data.tar.gz: e305b710ba485174ad423a15aba7e9a7f72deea4101829dcf880531e58a651cefbd88c54259b951a851120ccc3241a2849a4a5a18b3a55d5ffaceb6f92a36ddf
+  metadata.gz: d8498aa76cd3a4ec7277fb0d7e7618c030c70cab306258bec7b5806c0da249108943e56f2b78bf41eb9fddc54d0f0aada4cfb21e59abca81db5dc8fc7495f18c
+  data.tar.gz: 7eef06176d02da633b5fc2138d675ec66809f479a84e155800f25d6797ed0aa463a58d76a77d1540d1d6b9eb8c6abfed39d60f78881344634cbd37610fdae579

data/README.md

@@ -338,7 +338,7 @@ In the host protocol and the block versions of other protocols, a raka task (the
 | scope                 | scope for current task, i.e. the common directory for output, input and dependencies |
 | target_scope          | the inline scope defined in target                                                   |
 | target_scope_captures | captured values by inline scope defined in target                                    |
-| rule_scopes           | the inline scope defined in target                                                   |
+| rule_scopes           | the scope components bounded by the rule scopes                                                   |
 
 ```ruby
 require 'raka'
@@ -469,13 +469,61 @@ The `input_types` involves the strategy to find inputs. All possible input types
 
 ### Scope
 
-Scopes define constraints which help users create rules more precisely. A scope generally refer to a folder and can happen in several places.
+Scopes represent the context of a running task and its components, which are generally folders physically. Users can define scope constraints with rules to help users create rules more precisely. and can happen in several places.
 
-**Task scope** is the scope when executing a task, a.k.a. **scope**.  When a rule is matched given a desired output, a task is generated and its scope is the common folder of the output and all dependencies. For example, a rule `csv.out = [csv.in] | ...` can be matched given *out/out.csv* and the task scope is resolved *out/*. The task will thus search for *out/in.csv* as dependency. 
+Scope constraints:
 
-**Rule scope** is the scope to restrict possible task scope, given by `Raka::scope`. In the following example, the rule scopes are 
+**Rule scope** is the scope to restrict possible task scope. Rule scopes can be layered, each layer with several options, like:
 
-**Target scope.**
+```ruby
+dsl.scope :de, :fr
+  dsl.scope :food, :med 
+    ...rules
+  end
+end
+```
+
+**Target scope** is the scope to restrict a single target. It can be used in the left-hand part of a rule, or as dependencies in the right-hand. For example:
+
+```ruby
+# The constraint "de" only apply to food.csv and fruit__food.csv, not classifier.csv
+csv('de').food.fruit = [csv.classifier] | action
+```
+
+When resolved, scope constraints are verified and scopes are extracted and parsed, including the following concepts:
+
+**Scope**(**Task scope**) is the common scope of the task, every target is resolved under the scope.
+
+**Rule bounded scopes** (abbr. rule scopes) are the parts of scope bounded by the **Rule scope** constraints.
+
+**Target bounded scope** (abbr. target scope) is the part of scope bounded by the **Target scope** constraints.
+
+**Output scope** is the scope of output, while **Dep scope** is the scope of dependencies.
+
+The following example illustrates the relationships of the above concepts.
+
+Rule definition:
+
+```ruby
+dsl.scope :de, :fr, 
+  dsl.scope :food, :med
+    csv('percent_(\d+)').data.cheap = [csv('base').price] | ...
+  end
+end
+```
+
+When running `raka out/de/food/percent_50/cheap__data.csv`, the extracted scopes are as follows:
+
+![](https://cdn.rawgit.com/yarray/raka/master/doc/scope.svg)
+
+The auto variables are:
+
+|var|value|var|value|
+|---|-----|---|-----|
+|$(scope)|out/de/food|$(output_scope)|out/de/food/percent_50|
+|$(rule_scope0)|food|$(rule_scope1)|de|
+|$(target_scope)|percent_50|$(target_scope0)|50|
+|$(dep1_scope)|out/de/food/base|||
 
 ## Rakefile Template
 
@@ -483,4 +531,4 @@ Scopes define constraints which help users create rules more precisely. A scope
 
 ## Compare to other tools
 
-Raka borrows some ideas from Drake but not much (currently mainly the name "protocol"). Briefly we have different visions and maybe different suitable senarios.
+Raka borrows some ideas from Drake but not much (currently mainly the name "protocol"). Briefly, we have different visions and maybe different suitable scenarios.

data/VERSION

@@ -1 +1 @@
-0.3.10
+0.3.13

data/lib/raka/compile.rb

@@ -34,6 +34,7 @@ class DSLCompiler
       name: name,
       deps: deps,
       deps_str: deps.join(','),
+      dep_scopes: deps.map { |d| File.dirname(d) },
       input: deps.first || '',
       task: task
     }

data/lib/raka/lang/psql/impl.rb

@@ -17,9 +17,9 @@ end
 # postgresql protocol using psql, requires HOST, PORT, USER, DB
 class Psql
   # Sometimes we want to use the psql command with bash directly
-  def sh_cmd(scope)
+  def sh_cmd(schema)
     c = @conn
-    env_vars = "PGOPTIONS='-c search_path=#{scope ? scope + ',' : ''}public' "
+    env_vars = "PGOPTIONS='-c search_path=#{schema.empty? ? '' : schema + ','}public' "
     "PGPASSWORD=#{c.password} #{env_vars} psql -h #{c.host} -p #{c.port} -U #{c.user} -d #{c.db} -v ON_ERROR_STOP=1"
   end
 
@@ -35,10 +35,10 @@ class Psql
     raise 'argument conn required' if @conn.nil?
 
     if @create.to_s == 'table'
-      'DROP TABLE IF EXISTS :_name_;' \
+      'DROP TABLE IF EXISTS :_schema_.:_name_;' \
         'CREATE TABLE :_name_ AS (' + code + ');'
     elsif @create.to_s == 'mview'
-      'DROP MATERIALIZED VIEW IF EXISTS :_name_;' \
+      'DROP MATERIALIZED VIEW IF EXISTS :_schema_.:_name_;' \
         'CREATE MATERIALIZED VIEW :_name_ AS (' + code + ');'
     else
       code
@@ -47,10 +47,11 @@ class Psql
 
   def run_script(env, fname, task)
     param_str = (@params || {}).map { |k, v| "-v #{k}=\"#{v}\"" }.join(' ')
+    schema = task.rule_scopes.join('__')
 
     bash env, %(
-    #{sh_cmd(task.rule_scopes.join('__'))} #{param_str} -v _name_=#{task.output_stem} \
-      -f #{fname} | tee #{fname}.log
+    #{sh_cmd(schema)} #{param_str} -v _name_=#{task.output_stem} \
+      -v _schema_=#{schema} -f #{fname} | tee #{fname}.log
     mv #{fname}.log #{task.name}
     )
   end

data/lib/raka/token.rb

@@ -58,7 +58,7 @@ class Token
     res = Hash[info.names.zip(info.captures)]
     unless info[:scope].nil?
       rule_scopes = Regexp.new(_scope_pattern_).match(info[:scope]).captures
-      res[:rule_scopes] = rule_scopes[1..-1].reverse
+      res[:rule_scopes] = rule_scopes[2..-1].reverse
     end
     if !@inline_scope.nil? && !info[:target_scope].nil?
       segs = Regexp.new(@inline_scope).match(info[:target_scope]).captures
@@ -130,8 +130,12 @@ class Token
     [auto_input]
   end
 
+  def _rule_scope_pattern_
+    (@context.scopes.map { |layer| "(#{layer.join('|')})" }).join('/') + ')'
+  end
+
   def _scope_pattern_
-    '((?:(\S+)/)?' + (@context.scopes.map { |layer| "(#{layer.join('|')})" }).join('/') + ')'
+    '((?:(\S+)/)?' + _rule_scope_pattern_
   end
 
   def _pattern_

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raka
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.13
 platform: ruby
 authors:
 - yarray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake