raka 0.3.8 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 011d4dda2d79391c732fb51b383a015ee6f0e6b10f4bd1eb8e976af16100bdf5
-  data.tar.gz: 3e83d92014c4360dd0180db04e4d7abed90973e35a986dfa9b7afd25c16a1b86
+  metadata.gz: 8c18ff3ef2a33821e333fec106d2f64ade89ca0f416d02c914ce5b5eb1601ba0
+  data.tar.gz: ca858c3ea2807d209cceebe85ae1d4e987bd125597fd9575bb82d907785ed109
 SHA512:
-  metadata.gz: 8fa7be1a0d0e86851c36cb6a57a1638a10eb52a15f03ebc73819dbf1e6984524ecf909ddbad754d72542f800a6ff10bdd80d6feb7e5f4dbe56b9b53d86f26f04
-  data.tar.gz: f77dbe680509b21ceac1f13c1abe583c96d91ba6156efa88afc94519c4a837b220361851b5e4f56c7d2002eda79d6022c4cebcab6c341eea6af582d92ce919b8
+  metadata.gz: 9d8089d3f500a7f57789be879cd7f4f2fbadd2fd64ba0ca2957694289813587a5b603d7c0cb5fe8b5e84c442eccd7274f3203aef4f1e94f5830039e53cc7c3da
+  data.tar.gz: 37625d41c5e2d09d47254d0be9497a95fcbc2b33810fb5ab942050763db35f4c2b3d1958c52a478b72eefe2c65e48ae619be52ec252e0365d58978bafaa2b0f9

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.8
+0.3.11

data/bin/raka

@@ -63,8 +63,12 @@ opt_str = "-f #{entry}"
 opt_str += " -m -j #{options[:jobs]}" if options.key?(:jobs)
 cmd += "#{env}rake #{opt_str} #{extra_args} #{targets}"
 dry_cmd = 'RUBYOPT="-W0" ' + cmd + ' --dry-run'
-_, dry_msg, status = Open3.capture3(dry_cmd)
-exit(status) if status != 0
+dry_out, dry_msg, status = Open3.capture3(dry_cmd)
+if status != 0
+  puts dry_out
+  puts dry_msg
+  exit(status.exitstatus)
+end
 unless (dry_msg.lines.first.chomp =~ /^.*\(.*not_needed.*\)$/).nil?
   puts 'All targets are up to date'
   exit(0)

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

@@ -49,7 +49,7 @@ class Psql
     param_str = (@params || {}).map { |k, v| "-v #{k}=\"#{v}\"" }.join(' ')
 
     bash env, %(
-    #{sh_cmd(task.scope)} #{param_str} -v _name_=#{task.stem} \
+    #{sh_cmd(task.rule_scopes.join('__'))} #{param_str} -v _name_=#{task.output_stem} \
       -f #{fname} | tee #{fname}.log
     mv #{fname}.log #{task.name}
     )

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
@@ -80,7 +80,7 @@ class Token
 
   # attach a new item to the chain
   def _attach_(item)
-    Token.new(@compiler, @context, @chain + [item], @inline_scope, @options)
+    Token.new(@compiler, @context, @chain + [item], @inline_scope, **@options)
   end
 
   # rubocop:disable Style/MissingRespondToMissing  # for DSL not essential
@@ -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.8
+  version: 0.3.11
 platform: ruby
 authors:
 - yarray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake