caset 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 550521bf86c2bc1c07ffa40bd723ff0acb2a3ec41603a48967194eb27bb8bd99
+  data.tar.gz: c8f625fc9a6887f44124c6a389ec2f1656197ac4a5533d2d4d047e77f62401de
+SHA512:
+  metadata.gz: 1e086a834e7f0b3d6e10abb73a150cbd1cbf84ad4265a981ba5ecff6b123576e08074ef2b58d7dbb1c8bb1e6d00c896171e0d9f3f8743d063f53e2baea20119f
+  data.tar.gz: 35f881a333bf72b03772344457dc1aaf1392f9f7a8c2dd3c1d870bba6a5dfe0eb669ea2bdeaa3eddf435860fff5d2b343bfb6edcebb895d9415a4013dd29b871

data/README.md

@@ -0,0 +1,180 @@
+# caset
+
+这是一个用例组织框架，是学习block的基本练手
+
+简化spec，在一些没有spec的场合组织代码用（现在应该没有这样的地方了）
+
+## CasetDown
+
+自 v1.0.0 起，caset 融合了 `imdoc/casetdown` 项目的全部功能，提供 `cm`、`cml` 两个命令，
+对 Markdown 文档做形式化执行与生成（文档既是文稿，也是可执行程序）。
+
+- `cm`：解析文档结构、导入导出表格、执行文档内代码块、把运行结果回写渲染成新文档
+- `cml`：监听目录下的 `.md` 文档，内容一变就自动执行一次 `cm`，并把最新渲染版同步为
+  `<文件名>.latest.md`
+
+```shell
+cm --check doc/sample.md   # 检查文档结构
+cm doc/sample.md           # 默认渲染：表格 + 代码执行 + 时间戳渲染文件
+cm --rtab doc/sample.md    # 导入外部 CSV 表格到文档
+cm --wtab doc/sample.md    # 导出文档内表格到 CSV
+cm --preview doc/sample.md # 生成 *.preview.md 预览
+cml                        # 监听当前目录，自动渲染并维护 .latest.md
+```
+
+Markdown 扩展语法（全局配置、内置表格、代码输入输出通道、数据绑定）见
+[doc/MANUAL.md](doc/MANUAL.md)，样例见 [doc/sample.md](doc/sample.md)，
+**可运行的功能演示见 [example/](example/) 目录**（六个递进例子 + 运行说明）。
+
+### 依赖与结构
+
+原 casetdown 的松散集成依赖（`imdoc/XMLUtils`、`imdoc/Tabot` 的 Excel 读写、`gem:rdiscount`）
+已完全重写并入 [manticore](../manticore)（gem:manticore-smash）：
+
+| 原 imdoc 组件 | 现归属 |
+|------|------|
+| `XMLUtils/XmlUtils`（XmlParser） | manticore `xmlutils` / `xml_doc` |
+| `Tabot` Excel 读写 | manticore `xlsxkit` |
+| `gem:rdiscount`（Markdown 解析） | manticore `mdutils/rediscount`（ReDiscount） |
+| `Tabot/simtab`（二维表操作） | caset `lib/casetdown/support/simtab.rb` |
+| `TextUtils/text_abstract`（段落匹配） | caset `lib/casetdown/support/text_abstract.rb` |
+| `EnData`（内嵌数据绑定） | caset `lib/casetdown/support/endata.rb` |
+| `TinText/tum/cache`（模板替换） | caset `lib/casetdown/support/tintext.rb` |
+| `EnData/api-app`（API-Request） | caset `lib/casetdown/support/api_app.rb`（需另装 gem webot，未装则自动跳过） |
+
+执行文档中的 ruby 代码块时，子进程通过 `require "casetdown"` 获得与 cm 主进程一致的
+数据绑定环境（`EnData.table`、SimTab 表操作、TinText 模板、XlsxKit），
+仓库直跑与 gem 安装两种方式均可。
+
+```shell
+gem install manticore-smash   # 唯一运行时依赖（或 gem build 本地安装）
+gem build caset.gemspec && gem install --local caset-1.0.0.gem
+rake test                     # 全量测试（66 用例：caset + casetdown + support + cli）
+```
+
+### 相对旧版 casetdown 的修正
+
+- 解析链切换为 manticore（ReDiscount + XmlParser），修复 tokenizer 吞空格缺陷：
+  实体引用旁的空格/换行是有效内容（`lines &lt;&lt; &quot;x&quot;` 此前会被解析成 `lines <<"x"`）
+- `loadcsv` 编码策略改为 UTF-8 优先 + BOM 剥离 + GBK 回退：修复旧版把 UTF-8 表头
+  强转 GBK 造成的乱码（表头 `"a"` 被污染成 `"锘縜"`，导致 `#col>` 按名投影退化为占位符）
+- `cml` 变更检测由 atime 改为 mtime（Windows 卷常见关闭 atime 更新导致漏检）；
+  修复带目录/通配符参数即误判"No file exist"退出、以及首次渲染时 `File.delete`
+  删除不存在的 `.latest.md` 报错两个缺陷
+- 渲染数据尾部改用局部量：同进程反复渲染（cml）不再叠加 `__END__` 数据段与
+  erlang fact 子句（同名 fact 子句首个匹配优先，旧数据会遮蔽新数据）
+- `cm`/`cml` 薄启动器 + `CLI`/`Live` 实现移入 lib，仓库直跑与 gem 安装共用一套代码
+
+## How To Use
+
+```ruby
+require 'caset'
+include Caset
+
+scenario 'Your scenario name',[:bm_step] do
+  before [:all] do
+    msg "起床"
+  end
+  
+  before [:each] do
+    mark "准备"
+  end
+  
+  ustep 1,"符号" do|param|
+    star "梳头"
+    plus "刷牙"
+    minus "洗脸"
+  end
+  
+  ustep 2,"符号简写" do|param|
+    星 "穿鞋"
+    加 "喝粥"
+    减 "出行"
+  end
+  
+  ustep 3,"序号" do|param|
+    1.is "卖蛋"
+    2.is "买茶"
+  end
+  
+  ustep 4,"文字" do|param|
+    '一'.是 "为了维生"
+    '二'.是 "为了兴趣"
+    "当然".是 "也不一定的", '咳咳,','...'
+  end
+  
+  ustep '5',"Cucumber" do|param|
+    Give "some conditions"
+    When "something happen"
+    Then "will get the results"
+    And "some exceptions maybe"
+  end
+  
+  ustep '6',"中文Cucumber" do|param|
+    如果 "存在某种条件"
+    而且 "处于这种场合"
+    当 "发生某些行为"
+    那么 "会有这些结果"
+  end
+  
+  ustory "书写方法1" do
+    run_step(1,"使用符号简写")
+    run_step(2,"使用符号简写")
+    run_step(3,"使用序号")
+    run_step(4,"使用文字")
+  end
+  
+  ustory "书写方法2" do
+    run_steps [ {id:'5',desc: "使用Cucumber"}, {id:'6', desc:"使用中文Cucumber"} ]
+  end
+  
+  ustory "待定" do
+    pending
+  end
+  
+  after [:each] do
+    记录 "躺下"
+  end
+  
+  after [:all] do
+    标记 "放松"
+  end
+end
+
+puts "","The Running Report is",Caset.report,"","The Specific Document is",Caset.document
+```
+
+## AutoGenerate
+
+运行下列脚本生成用例集
+
+```ruby
+include Caset
+auto_story(casename)
+```
+
+如果你想使用BDD/Spec框架，也可以通过一些方法生成对应的简单模板
+
+```ruby
+BDD::gen((ARGV[0] || "xxx"),(ARGV[1] || "standard" || "background" || "outlines" || "steptables"))
+
+Spec.gen ARGV,template 
+```
+
+## Pytest.gen
+
+对于一个或一组python代码，给出其YAML摘要文件，生成对应pytest的单元测试框架tests
+
+```ruby
+Caset::Pytest.gen option={path: 'xxx.yml', level: %{pending false}.map{|a|a.to_sym}, head: 'xxx'}
+```
+
+```shell
+vim ./pytest.ini
+[pytest]
+markers = 
+  unfinished: aaa
+  finished: zzz
+
+pytest .
+```

data/bin/cm

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#coding:utf-8
+# ============================================================================
+# cm 可执行 Markdown 渲染命令 —— 薄启动器
+#
+#   仓库内直跑：ruby bin/cm <options> <filename>[.md]
+#               （require_relative 解析到本仓库 lib/，需已安装 gem manticore-smash）
+#   gem 安装后：cm <options> <filename>[.md]
+#               （RubyGems shim 调本文件，lib/ 随 gem 打包）
+#
+#   实现位于 lib/casetdown/cli.rb（CasetDown::CLI.run）。
+# ============================================================================
+require_relative '../lib/casetdown'
+
+exit(CasetDown::CLI.run(ARGV))

data/bin/cml

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#coding:utf-8
+# ============================================================================
+# cml Markdown 监听渲染命令 —— 薄启动器
+#
+#   仓库内直跑：ruby bin/cml [<dir>] [<glob>]
+#   gem 安装后：cml [<dir>] [<glob>]
+#
+#   持续监视目录下 .md 文档，内容变更时自动执行 cm 默认渲染流程，
+#   并把最新渲染版本同步为 "<文件名>.latest.md"。
+#   实现位于 lib/casetdown/live.rb（CasetDown::Live.run）。
+# ============================================================================
+require_relative '../lib/casetdown'
+
+exit(CasetDown::Live.run(ARGV))

data/doc/MANUAL.md

@@ -0,0 +1,100 @@
+
+# 这是一个可执行Markdown扩展文档的例子
+
+文档的描述随便写，不影响markdown原本的语意。
+以下是给Markdown一些增强的功能：
+
+## 1. 全局配置
+
+如果要做一些全局配置参数，使用如下shell，并以“.yml”、“.yaml”结尾（其实也可以没有后缀，但内容格式一定要是YAML全局散列）。
+
+```shell
+#conf>配置文件名.yml
+```
+
+它的内容应该形如：
+
+```shell
+--- # 文档名称
+配置名1: 属性值1
+配置名2: 属性值2
+配置名3: 属性值3
+………………
+```
+
+全局配置的好处就是渲染表格时，它不会渲染出来，可以隐藏一些信息。 如果需要检查参数设置，可以以打印代码的方式查阅，默认占用表名"global"，参考`EnData.table('global')`。
+
+没有全局配置也没有任何问题，找不到配置文件全局变量会置空。
+
+## 2. 内置表格
+
+如下编辑会生成一个表格：
+
+((表名))
+
+|字段名1 |字段名2 |字段名3  |…………|
+|--------|-------|---------|----|
+|字段值1 |字段值2 |${绑定名}|…………|
+
+如果没有表名，那么会生成一个Anonymous的表。
+
+使用`${绑定名}`可以生成一个引用名和引用内容的绑定，用以替换复杂的文本内容，生成表格时会自动绑定替换。
+
+## 3. 外部表格
+
+使用如下shell导入一个外部表格文件：
+
+```shell
+#output>表名.csv
+#row>1
+#col>path,server,protocol,access-key
+```
+
+内置表名会是"表名.csv"。
+由于文件格式支持问题仅支持CSV文件引入，其他格式要自行编写代码读取和解析。
+
+可以追加`#row>`和`#col>`用来筛选、投影特定的行和列，构成新的子表。
+行筛选通过行号，可以是数字，也可以是范围，比如`1,2,4,11~17`。
+列投影投影的是表头字段名，比如`field1, field2 ... field65535`。
+
+## 4. 代码输入输出通道
+
+使用如下shell来输入一段代码：
+
+```shell
+#input>代码段名
+#src>解释引擎
+
+书写你自己的代码
+………………
+```
+
+使用如下shell来展示代码执行的结果：
+
+```shell
+#output>代码段名
+写什么无所谓，渲染后这一段会被替换掉
+```
+
+input管道下的代码，执行后会被输出到output管道下。
+
+代码根据“代码段名”关联，可以目录/树状命名，但不推荐以相同前缀子串整体做命名（比如一个是“/path/to/folder”另一个是“/path/to/folder/subfolder”，暂未修复<b>[TODO]</b>）。
+
+代码解释引擎就是常见的语言或命令行工具。
+默认支持lm、tm、ruby、python、erlang和bash，其他语言可以基于shell扩展，但windows平台要注意cmd、ps本身和bash有差异，执行并不稳定。
+多版本/环境管理解释器的执行主要取决于渲染文档时的shell环境，比如执行python使用conda构建环境，那么调用`cm`命令时shell需要能进入并选择env（改造启动脚本或sublime构建工具）。
+
+## 5. 数据绑定
+
+表格的数据是默认和代码数据段绑定的，这个特性基于ruby的`endata`开发，也可以应用到lm、tm等工具上。
+
+配置文件会以全局变量的形式记录在`$_tmp_global_`中。
+表格一行是一条记录，以全局变量的形式记录在`$_tmp_endata_`。
+
+在ruby中，数据直接放置在`__END__`中，使用`EnData/ApiRequest`的`EnData::table`来导入表，全局变量则放在`global`这样一个特殊的表中，注意EnData的数据定义是有顺序的（见`EnData/api-app.rb`）。
+
+在erlang中，数据以函数的形式附着在escript末尾，我们将其做成prolog等效的事实函数（形如`fact(A,B,C,...)->{D,E,F}.`）。
+
+其他语言的传递方式收集中……
+
+

data/doc/sample.csv

@@ -0,0 +1,12 @@
+a,b,c,d,e,f,g,h,i
+a,b,c,d,e,f,g,h,i
+A,B,C,D,E,F,G,H,I
+1,2,3,4,5,6,7,8,9
+9,8,7,6,5,4,3,2,1
+I,H,G,F,E,D,C,B,A
+i,h,g,f,e,d,c,b,a
+
+x,x,x,x,x,x,x,x,x
+X,X,X,X,X,X,X,X,X
+CASETDOWN,,,,,,,,
+,,,,,,,,casetdown

data/doc/sample.md

@@ -0,0 +1,60 @@
+
+# Title1
+
+![png](1.png)
+
+## Title2
+
+[run.rb](run.rb)
+
+### Title3
+
+((table_name))
+
+| a   | b   | c   |
+| --- | --- | --- |
+| A   | B   | C   |
+| A2  | B2  | C2  |
+
+```shell
+#output>sample.csv
+#row>1~2,5, 9~10
+#col>a, d, g
+```
+
+#### Title4
+
+- 1
+  > 1.1
+- 2
+  2.2
+- `3`
+- [4](4.md)
+
+##### Title5
+
+> 1
+>> 2
+>>> 3
+
+列表和引文都只能到一层
+
+###### Title6
+
+```shell
+#in>1.txt
+echo 1,2,3
+```
+
+```shell
+#out>1.txt
+```
+
+`run.bat`
+
+$A=B$
+
+$$
+A = B
+B = C
+$$

data/lib/caset/gen_bdd.rb

@@ -0,0 +1,121 @@
+#coding:utf-8
+
+# Usage:
+# BDD::gen((ARGV[0] || "xxx"),(ARGV[1] || "standard" || "background" || "outlines" || "steptables"))
+
+module BDD
+  module_function
+  def step
+%Q{
+Given(//) do||
+
+end
+
+When(//) do||
+
+end
+
+Then(//) do||
+
+end
+
+And(//) do||
+
+end
+
+Then(//) do||
+
+end
+}
+  end
+
+  def standard
+%Q{
+Feature: 
+  As a 
+  I 
+  so that 
+  
+  # 
+  @
+  Scenario: 
+    Given 
+    When 
+    Then 
+    And 
+    But 
+      """
+      
+      """
+}
+  end
+
+  def background
+%Q{
+Feature: 
+  As a 
+  I 
+  so that 
+  
+  Background:
+    Given 
+
+  Scenario: 
+    When 
+    Then 
+
+  Scenario: 
+    When 
+    Then 
+}
+  end
+
+  def outlines
+%Q{
+Feature: 
+  As a
+  I 
+  so that 
+  
+  Scenario Outline: 
+    Given 
+    When 
+    Then 
+    And 
+    
+    Examples: 
+      |  |  |
+      |  |  |
+      |  |  |
+}
+  end
+
+  def steptables
+%Q{
+Feature: 
+  As a 
+  I 
+  so that 
+  
+  Scenario: 
+    Given 
+    When 
+    Then 
+    And 
+    But 
+      |  |
+      |  |
+      |  |
+}
+  end
+
+  def gen name,type 
+    Dir.mkdir("features") unless File.exist?("features")
+    Dir.mkdir("features/support") unless File.exist?("features/support")
+    Dir.mkdir("features/step_definitions") unless File.exist?("features/step_definitions")
+    
+    File.write("features/support/env.rb","#coding:utf-8\n\n") unless File.exist?("features/support/env.rb")
+    File.write("features/#{name}.feature",self.send(type.to_sym)) unless File.exist?("features/#{name}.feature")
+    File.write("features/step_definitions/#{name}.rb",step) unless File.exist?("features/step_definitions/#{name}.rb")
+  end
+end

data/lib/caset/gen_caset.rb

@@ -0,0 +1,41 @@
+#coding:utf-8
+
+# Usage:
+# include Caset
+# casename = ARGV[0] || "temp"
+# auto_story casename
+
+module Caset
+THE_USTORY_TEMPLATE = %Q{#coding:utf-8
+$:
+require 'caset'
+include Caset
+
+scenario 'Your scenario name' do # options = [ :bm_step | :bm_story ]
+  before do # options = [:each | :all ]
+  end
+  
+  ustep :x,"your step" do|param|
+    # msg/记录
+    # mark/star/plus/minus/标记/星/加/减
+    # number/"string".is/是
+    # Give/When/Then/And/如果/当/那么/而且
+    # pending/待定
+  end
+  
+  ustory "your ustory" do
+    # run_step()
+    # run_steps [ ]
+  end
+  
+  after do # options = [:each | :all ]
+  end
+end
+
+puts "","运行报告：",Caset.report
+File.write "<<pathname>>_doc.txt",Caset.document.join("\\n")}
+
+  def auto_story pathname = ""
+    File.write "#{pathname}_case.rb",THE_USTORY_TEMPLATE.gsub("<<pathname>>",pathname.split("/")[-1])
+  end
+end