caset 1.0.0

data/lib/caset/gen_pytest.rb

@@ -0,0 +1,211 @@
+#coding:utf-8
+require 'yaml'
+
+=begin
+INPUT: PYCODE.py + ABSTRACT.yml
+OUTPUT: tests/PYTEST
+=end
+
+=begin # ABSTRACT TEMPLATE
+--- # MODULE_NAME
+
+# [basic header]
+path: THE_FOLDER_PATH_OF_MODULE_SOURCE
+module: MODULE_NAME
+file:
+  FILENAME: # FILENAME INCLUDE ".py"
+
+  # [import]
+  import:
+    - REFMOD_NAME # => import REFMOD_NAME
+    - [REFMOD_NAME, SUB_REFMOD_NAME] # => from REFMOD_NAME import SUB_REFMOD_NAME
+    - [REFMOD_NAME, SUB_REFMOD_NAME, ALIAS_NAME] # => from REFMOD_NAME import SUB_REFMOD_NAME as ALIAS_NAME
+
+  # [external variables and functions]
+  varc:
+    - VAR_GLOBAL
+    - [VAR_GLOBAL, MODE]
+    - [VAR_GLOBAL, MODE, OG_VAR]
+    - [VAR_GLOBAL, MODE, OG_VAR, TYPE] # => [VAR_NAME|WRAPPER_NAME, null, null, TYPE|null]
+  func:
+    - [[EXTN_FUN_NAME, ARGV...], [REF_VAR_NAME|REF_FUN_NAME...], [RETN_VAL...]] # => [[MUST, OPTIONAL...], [OPTIONAL...], [OPTIONAL...]]
+    # no need to complete REF_STATEMENT and RETN_STATEMENT
+  
+  # [two way to note vars and funs in class]
+  # one: only one class
+  CLASS: 
+    BODY
+  # two: two or more classes
+  CLASSES:
+    - BODY
+
+  # [body of class]
+  CLASS:
+    name: CLASS_NAME
+    base: PARENT_CLASS_NAME
+
+    varc: 
+    - CLASS_VAR
+    - [CLASS_VAR, MODE]
+    - [CLASS_VAR, MODE, OG_VAR]
+    - [CLASS_VAR, MODE, OG_VAR, TYPE] # => [VAR_NAME|WRAPPER_NAME, c|null, null, TYPE|null]
+    func:
+    - [[CLS_FUN_NAME]]
+    - [[CLS_FUN_NAME, ARGV...]]
+    - [[CLS_FUN_NAME, ARGV...], [REF_VAR_NAME|REF_FUN_NAME...]]
+    - [[CLS_FUN_NAME, ARGV...], [REF_VAR_NAME|REF_FUN_NAME...], [RETN_VAL...]] # => [[MUST, OPTIONAL...], [OPTIONAL...], [OPTIONAL...]]
+    # no need to complete REF_STATEMENT and RETN_STATEMENT
+
+    attr: 
+    - INS_VAR
+    - [INS_VAR, MODE]
+    - [INS_VAR, MODE, OG_VAR]
+    - [INS_VAR, MODE, OG_VAR, TYPE] # => [VAR_NAME|WRAPPER_NAME, r|w|rw|i|null, ORIGINAL_VAR_NAME|null, TYPE|null]
+    fun:
+    - [[INS_FUN_NAME]]
+    - [[INS_FUN_NAME, ARGV...]]
+    - [[INS_FUN_NAME, ARGV...], [REF_VAR_NAME|REF_FUN_NAME...]]
+    - [[INS_FUN_NAME, ARGV...], [REF_VAR_NAME|REF_FUN_NAME...], [RETN_VAL...]] # => [[MUST, OPTIONAL...], [OPTIONAL...], [OPTIONAL...]]
+    # no need to complete REF_STATEMENT and RETN_STATEMENT
+=end
+
+
+=begin # EXAMPLE
+--- # SERVICE_A
+path: ~/workspace/dev/server/service_a
+module: service_a
+
+file: 
+  service_a.py: 
+    import: 
+      - [__future__, absolute_import]
+      - sys
+      - [server.base_template, base_service, Service]
+      - [server.service_b, ServiceB]
+
+    classes: # or class and the value is only one item of hash
+      - name: ServiceA
+        base: Service
+        attr: 
+          - [result, rw, dict, ResultA] # attr as r|w|rw methods
+          - [tmp, null, null]
+        fun: 
+          - [[__init__],[tmp]]
+          - [[tmp_cal, tmp_val],[tmp, result], [result,size(result)]]
+        varc:
+          - a
+          - [b, null, null, str]
+          - c
+        func: 
+          - [[tmp_zzZ, a,b,c]]
+    
+    varc:
+      - d
+      - [e, null, null]
+      - [f, null, null, int]
+    func: 
+      - [[tmp_ooO, d, e, f]]
+
+=end
+
+
+module Caset
+  module Pytest
+    module_function
+
+    def gen option
+      path, head, level = option[:path], option[:head], option[:level]
+      doc = YAML.load(File.read(path))
+      ohead = "#{doc['path']}/#{doc['module'] ? doc['module']+"/" : ''}"
+      pkgroute = head+ohead.split(head)[-1].gsub('/','.')
+      `mkdir -p tests/#{path.sub('.yml','')}`
+    
+      doc['file'].each do|filename, abstract|
+        inner_fun_set = []
+        classes = (abstract['classes'] || [abstract['class']] || []).compact
+        classes.each do|klass|
+          inner_funcs,inner_funs = [], []
+    
+          vars = klass['varc'] || []
+          vars.each do|var|
+            varname,varattr = var.instance_of?(Array) ? var[0..1] : [var,nil]
+            handle = level.include?(:strict) ? "raise Exception(\"No Implement\")" : ""
+            handle = level.include?(:fail) ? "assert False" : ""
+            tips   = level.include?(:pending) ? "\"TODO: #{varname}#{varattr ? " :#{varattr}" : varattr}\"" : ""
+            adaptr = level.include?(:pending) ? "  @pytest.mark.unfinished\n" : ""
+            inner_funcs << "#{adaptr}  def test_#{varname}(self):\n    #{handle}#{tips.empty? ? tips : "\n    "+tips}\n"
+          end
+    
+          funcs = klass['func'] || []
+          funcs.each do|func|
+            sign = func[0]
+            next if sign[0]=='__init__'
+            handle = level.include?(:strict) ?  "raise Exception(\"No Implement\")" : ""
+            handle = level.include?(:fail) ? "assert False" : ""
+            tips   = level.include?(:pending) ? "\"TODO: #{sign[0]}(#{sign[1..-1].join(', ')})\"" : ""
+            adaptr = level.include?(:pending) ? "  @pytest.mark.unfinished\n" : ""
+            inner_funcs << "#{adaptr}  def test_#{sign[0]}(self):\n    #{handle}#{tips.empty? ? tips : "\n    "+tips}\n"
+          end
+    
+          vars = klass['attr'] || []
+          vars.each do|var|
+            varname,varattr = var.instance_of?(Array) ? var[0..1] : [var,nil]
+            handle = level.include?(:strict) ? "raise Exception(\"No Implement\")" : ""
+            handle = level.include?(:fail) ? "assert False" : ""
+            tips   = level.include?(:pending) ? "\"TODO: #{varname}#{varattr ? " :#{varattr}" : varattr}\"" : ""
+            adaptr = level.include?(:pending) ? "  @pytest.mark.unfinished\n" : ""
+            inner_funs << "#{adaptr}  def test_#{varname}(self):\n    #{handle}#{tips.empty? ? tips : "\n    "+tips}\n"
+          end
+    
+          funs = klass['fun'] || []
+          funs.each do|fun|
+            sign = fun[0]
+            next if sign[0]=='__init__'
+            handle = level.include?(:strict) ?  "raise Exception(\"No Implement\")" : ""
+            handle = level.include?(:fail) ? "assert False" : ""
+            tips   = level.include?(:pending) ? "\"TODO: #{sign[0]}(#{sign[1..-1].join(', ')})\"" : ""
+            adaptr = level.include?(:pending) ? "  @pytest.mark.unfinished\n" : ""
+            inner_funs << "#{adaptr}  def test_#{sign[0]}(self):\n    #{handle}#{tips.empty? ? tips : "\n    "+tips}\n"
+          end 
+    
+          unless inner_funcs.empty?
+            inner_funcs.unshift "  def teardown_class(self):\n    \"TODO: TEARDOWN CLASSMETHOD\"\n"
+            inner_funcs.unshift "  def setup_class(self):\n    \"TODO: SETUP CLASSMETHOD\"\n"
+          end
+          unless inner_funs.empty?
+            inner_funs.unshift "  def teardown_method(self):\n    \"TODO: TEARDOWN METHOD\"\n"
+            inner_funs.unshift "  def setup_method(self):\n    \"TODO: SETUP METHOD\"\n"
+          end
+    
+          inner_tmp = inner_funcs + inner_funs
+          inner_tmp.unshift "class #{klass['name']}Test():" unless inner_tmp.empty?
+          inner_fun_set += inner_tmp
+        end
+        
+        outer_funcs = []
+        funcs = abstract['func'] || []
+        funcs.each do|func|
+          sign = func[0]
+          handle = level.include?(:strict) ?  "raise Exception(\"No Implement\")" : ""
+          handle = level.include?(:fail) ? "assert False" : ""
+          tips   = level.include?(:pending) ? "\"TODO: #{sign[0]}(#{sign[1..-1].join(', ')})\"" : ""
+          adaptr = level.include?(:pending) ? "@pytest.mark.unfinished\n" : ""
+          outer_funcs << "#{adaptr}def test_#{sign[0]}():\n  #{handle}#{tips.empty? ? tips : "\n  "+tips}\n"
+        end
+    
+        unless outer_funcs.empty?
+          outer_funcs.unshift "def teardown_function():\n  \"TODO: TEARDOWN FUNCTION\"\n"
+          outer_funcs.unshift "def setup_function():\n  \"TODO: SETUP FUNCTION\"\n"
+        end
+    
+        content = (inner_fun_set + outer_funcs)
+        unless content.empty?
+          content.unshift "# import sys\n# sys.path.append(\".\")\n# PACKAGE ROUTE: #{pkgroute}#{filename[0..-4]}\n"
+          content.unshift "#coding:utf-8\nimport pytest\n"
+          testpath = "tests/#{path.sub('.yml','')}/test_#{filename}"
+          File.write testpath, content.join("\n") unless File.exist?(testpath)
+        end
+      end
+    end
+  end
+end

data/lib/caset/gen_spec.rb

@@ -0,0 +1,36 @@
+#coding:utf-8
+
+# Usage:
+# Spec.gen(ARGV,template)
+
+module Spec
+  THE_SPEC_TEMPLATE = %Q{#coding:utf-8
+$LOAD_PATH << "spec"
+
+describe ((name)) do
+  context "..." do
+    before(:each) do
+      
+    end
+
+    it "..." do
+      pending
+    end
+    
+    after(:each) do
+      
+    end
+  end
+end}
+
+  def self.gen names,template=THE_SPEC_TEMPLATE
+    Dir.mkdir("spec") unless File.exist?("spec")
+    ["middleware","asset","support"].each do|subdir|
+      Dir.mkdir("spec/#{subdir}") unless File.exist?("spec/#{subdir}")
+    end
+    File.write("spec/spec_helper.rb","#coding:utf-8\n\n") unless File.exist?("spec/spec_helper.rb")
+    names.each do|name|
+      File.write("spec/#{name}_spec.rb",template.gsub("((name))",name)) unless File.exist?("spec/#{name}_spec.rb")
+    end
+  end
+end

data/lib/caset/version.rb

@@ -0,0 +1,3 @@
+module Caset
+  VERSION = "1.0.0"
+end

data/lib/caset.rb

@@ -0,0 +1,272 @@
+#coding:utf-8
+require "caset/version"
+require 'caset/gen_caset'
+require 'caset/gen_bdd'
+require 'caset/gen_spec'
+require 'caset/gen_pytest'
+
+module Caset
+  class Error < StandardError; end
+  
+  #### 基础管道 ####
+  def self.construct
+    @__caset_register__ = { before_each: [], after_each: [], before_all: [], after_all: [], steps: {}, story: [] }
+    @__caset_report__ = []
+    @__caset_document__ = []
+    @__caset_indent__ = ""
+  end
+  
+  def self.register
+    @__caset_register__
+  end
+  
+  def self.report
+    @__caset_report__
+  end
+  
+  def self.document
+    @__caset_document__
+  end
+  
+  def self.indent
+    @__caset_indent__
+  end
+  
+  def msg context
+    if context.instance_of?(Array)
+      context.each do|pile|
+        Caset.report << Caset.indent+pile.to_s
+      end
+    else
+      Caset.report << Caset.indent+context.to_s
+    end
+    Caset.report[-1]
+  end
+  alias :记录 :msg
+  
+  def mark context
+    if context.instance_of?(Array)
+      context.each do|pile|
+        Caset.document << Caset.indent+pile.to_s
+      end
+    else
+      Caset.document << Caset.indent+context.to_s
+    end
+    Caset.document[-1]
+  end
+  alias :标记 :mark
+  
+  def pending reason=nil
+    mark "pending"+(reason ? ":#{reason}" : '')
+    msg "pending"+(reason ? ":#{reason}" : '')
+  end
+  
+  def 待定 原因=nil
+    mark "待定"+(原因 ? ":#{原因}" : '')
+    msg "待定"+(原因 ? ":#{原因}" : '')
+  end
+  
+  def star context
+    mark "* #{context}"
+  end
+  alias :星 :star
+  
+  def plus context
+    mark "+ #{context}"
+  end
+  alias :加 :plus
+
+  def minus context
+    mark "- #{context}"
+  end
+  alias :减 :minus
+  
+  def Give context
+    mark "Give #{context}"
+  end
+  
+  def When context
+    mark "When #{context}"
+  end
+  
+  def Then context
+    mark "Then #{context}"
+  end
+  
+  def And context
+    mark "     #{context}"
+  end
+  
+  def 如果 上下文
+    mark "如果#{上下文}"
+  end
+  
+  def 当 上下文
+    mark "当#{上下文}"
+  end
+  
+  def 那么 上下文
+    mark "那么#{上下文}"
+  end
+  
+  def 而且 上下文
+    mark "而且#{上下文}"
+  end
+  
+  def self.indent= indent
+    @__caset_indent__ = indent
+  end
+  
+  #### 设定结构 ####
+  def scenario description,options=[],&block
+    # registration
+    Caset.construct
+    unless options.include?(:bm_story) or options.include?(:bm_step)
+      block.call # all blocks regist
+    else
+      require 'benchmark'
+    end
+    Benchmark.bm{|x| @_bm_story_ = x;block.call } if options.include?(:bm_story)
+    Benchmark.bm{|x| @_bm_step_ = x;block.call } if options.include?(:bm_step)
+    
+    # execution
+    msg "====#{description}===="
+    mark "====#{description}===="
+    
+    Caset.indent = "  " # for before-all
+    msg "== before all ==" unless Caset.register[:before_all].empty?
+    mark "preconfig:" unless Caset.register[:before_all].empty?
+    Caset.register[:before_all].each do|before_all_transaction|
+      Caset.indent = "    " # for inner before-all
+      before_all_transaction.call
+    end
+    
+    Caset.register[:story].each do|stories|
+      description,story = stories
+      run_case(description,story)
+    end
+    
+    Caset.indent = "  " # for after-all
+    msg "== after all ==" unless Caset.register[:after_all].empty?
+    mark "postconfig:" unless Caset.register[:after_all].empty?
+    Caset.register[:after_all].each do|after_all_transaction|
+      Caset.indent = "    " # for inner after-all
+      after_all_transaction.call
+    end
+    
+    Caset.indent = "" # for scenario
+    msg "==== end scenario ===="
+    mark "==== end scenario ===="
+  end
+  
+  def before options=[:each],&block
+    if options.include?(:each)
+      Caset.register[:before_each] << block
+    elsif options.include?(:all)
+      Caset.register[:before_all] << block
+    else
+      # :off
+    end
+  end
+  
+  def after options=[:each],&block
+    if options.include?(:each)
+      Caset.register[:after_each] << block
+    elsif options.include?(:all)
+      Caset.register[:after_all] << block
+    else
+      # :off
+    end
+  end
+  
+  def usecase description,options=[],&block
+    unless options.include?(:off)
+      Caset.register[:story] << [description,block]
+    end
+  end
+  alias :ustory :usecase
+  
+  def ustep id, description=nil,options=[], &block
+    unless options.include?(:off)
+      Caset.register[:step] ||= {}
+      Caset.register[:step][id] = block
+    end
+  end
+  
+  #### 控制结构 ####
+  def run_step(id, description=nil, *args)
+    Caset.indent = "    "
+    mark "#{id}.#{description}"
+    if Caset.register[:step][id]
+      msg "<#{id}>#{description}"
+      Caset.indent = "      "
+      
+      unless @_bm_step_
+        Caset.register[:step][id].call(*args)
+      else
+        @_bm_step_.report(id.to_s+"."+description.to_s){Caset.register[:step][id].call(*args)}
+      end
+  
+    else
+      msg "<Warning>You are trying to call a step(#{id}) yet defined!"
+    end
+    Caset.indent = "    "
+  end
+  
+  # steps = [step,...]
+  # step = {:id=>id, :desc=>description, :args=>args}
+  def run_steps(steps)
+    steps.each do|step|
+      run_step step[:id],step[:desc],*(step[:args]||[])
+    end
+  end
+  
+  def run_case description,block
+    Caset.indent = "  " # for before-each
+    msg "== before_each ==" unless Caset.register[:before_each].empty?
+    mark "prepare:" unless Caset.register[:before_each].empty?
+    Caset.indent = "    " # for inner before-each
+    Caset.register[:before_each].each do|before_each_transaction|
+      before_each_transaction.call
+    end
+    
+    Caset.indent = "  " # for ustory
+    msg "#{description}"
+    mark "[#{description}]"
+    Caset.indent = "    " # for inner ustory
+    unless @_bm_story_
+      block.call
+    else
+      @_bm_story_.report(description){block.call}
+    end
+    
+    Caset.indent = "  " # for after-each 
+    msg "== after each ==" unless Caset.register[:after_each].empty?
+    mark "posthandle:" unless Caset.register[:after_each].empty?
+    Caset.indent = "    " # for inner after-each
+    Caset.register[:after_each].each do|after_each_transaction|
+      after_each_transaction.call
+    end
+    
+    Caset.indent = "  " # return to ustory level
+  end
+end
+
+class Numeric
+  def is title,left='(',right=')'
+    Caset.document
+    Caset.document << "#{Caset.indent}#{left}#{self}#{right}#{title}\n"
+  end
+  
+  def 是 标题,左='（',右='）';is 标题,左,右;end
+end
+
+class String
+  def is title,left='(',right=')'
+    Caset.document
+    Caset.document << "#{Caset.indent}#{left}#{self}#{right}#{title}\n"
+  end
+  
+  def 是 标题,左='（',右='）';is 标题,左,右;end
+end
+

data/lib/casetdown/casetable.rb

@@ -0,0 +1,121 @@
+#coding:utf-8
+require 'csv'
+
+#------------------------------------------------------------------------------
+# CSV 表格读写与渲染
+#------------------------------------------------------------------------------
+module CasetDown
+  module_function
+
+  # 读取 CSV 文件并转换为二维表。
+  #
+  # 编码策略（对齐 SimTab.读取csv）：优先按 UTF-8 解析（自动剥离 BOM），
+  # 内容不是合法 UTF-8 时回退按 GBK 转码，兼容历史报表。
+  # 支持表头解析（format == :csv 时解析表头）。
+  #
+  # @param path [String] CSV 文件路径
+  # @param format [Symbol] 解析模式，:raw 或 :csv（默认 :raw）
+  # @return [Object] 绑定表头的二维数组对象（含 绑定表头 方法）
+  def loadcsv path,format=:raw
+    raw = File.binread(path)
+    raw = raw.sub(/\A\xEF\xBB\xBF/n, '') # 剥离 UTF-8 BOM
+    csv = raw.dup.force_encoding('UTF-8')
+    csv = raw.dup.force_encoding('GBK').encode('UTF-8') unless csv.valid_encoding?
+    content = CSV.parse(csv, headers:(format==:csv))
+    table = content.绑定表头 content[0]
+    return table
+  end
+  
+  # 将二维表转换为 Markdown 表格字符串。
+  #
+  # 自动生成 |---|---| 分隔行。
+  #
+  # @param table [Array<Array>] 二维表数据
+  # @return [String] Markdown 格式表格字符串
+  # @example
+  #   CasetDown.maketab([["a", "b"], ["1", "2"]])
+  #   # => "|a|b|\n|---|---|\n|1|2|"
+  def maketab table
+    printab = table.map{|row|"|"+row.join("|")+"|"}
+    printab.insert 1, Array.new(table[0].size, '|---').join+"|"
+    return printab.join("\n")
+  end
+
+  # 渲染文档中的表格，支持 CSV 读写与表格替换回文档。
+  #
+  # 两种工作模式：
+  # 1. 将文档中的 table 写入 CSV 文件（:wtab）
+  # 2. 将代码块加载的 CSV 表格替换回文档（:rtab）
+  #
+  # @param cds [Hash] 解析结果
+  # @param option [Hash] 控制选项
+  # @option option [String] :stream 覆盖原始文档文本
+  # @option option [Array<Symbol>] :opt 渲染标志
+  #   - :wtab      将文档中的 table 写入 CSV 文件
+  #   - :rtab      将代码块加载的 CSV 替换回文档
+  #   - :rendfile  保存为带时间戳的新文件
+  # @return [Hash] 渲染结果
+  #   - :text [String] 处理后的文档文本
+  #   - :data [String, nil] Ruby 脚本尾部数据（endata 格式）
+  #   - :fact [String, nil] Erlang 脚本尾部数据（fact 函数子句）
+  # @note 表格名前需要从 ((TableName)) 格式段落提取
+  # @note 数据尾部使用局部变量累积：cml 会同一进程内反复调用本方法，
+ #       若沿用全局变量累积，重复渲染会使 __END__ 数据段与 erlang fact
+  #       子句叠加（同名 fact 子句 erlang 首个匹配优先，旧数据会遮蔽新数据）
+  def render_table cds, option={ stream: nil, opt: []} # empty, :wtab, :rtab, :rendfile
+    endata = {}
+    # write table to csv file
+    docs = CasetDown::Check.all(cds)
+    docs.each_with_index do|doc,index|
+      if doc[:name]=='table'
+        table_name = ( index-1 >= 0 && docs[index-1][:name]=='p' && docs[index-1][:text].strip[0..1]=='(('  && docs[index-1][:text].strip[-2..-1]=='))' ) ? docs[index-1][:text][2..-3].strip : 'Anonymous'
+        table_body = [doc[:head]]+doc[:body]
+        endata["[table@endata ~]$ruby #{table_name}"] = table_body.to_s
+        CSV.open(table_name+".csv","w")do|writer|
+          table_body.each do|record|
+            writer << record
+          end
+        end if option[:opt].include?(:wtab)
+      end
+    end
+
+    # load table from csv file
+    result = {}
+    codtab = docs.select{|doc|doc[:name]=='code'}
+    codtab.each do|code|
+      interpreter, namespace, config, target, flow, segment, input, output, rows, cols = magic_head code
+      next unless output.to_s[-4..-1]=='.csv'
+      tab = loadcsv(output)
+      seltab = rows.inject([tab[0]]) do|seltab,row|
+        seltab += [tab[row]] if row.is_a?(Integer)
+        seltab += tab[row]   if row.is_a?(Range)
+        seltab
+      end
+      seltab.绑定表头 seltab[0]
+      newtab = seltab.选择(*cols)
+      result[output] = maketab(newtab)
+      endata["[table@endata ~]$ruby #{output}"] = newtab.to_s
+    end
+
+    scr_tail, erl_tail = nil, ''
+    endata.each do|head, table|
+      (scr_tail ||= "__END__") << "\n#{head}\n#{table}\n"
+      erl_tail << "\n\n"+ToErlang.fact(head.split('$ruby ')[1], ToErlang.table(eval(table)))
+    end
+    origin_text = option[:stream] || cds[:doc].text
+    result.each do|output, newtab|
+      wrapped = "((#{output}))\n\n#{newtab}"
+      origins = CasetDown.search_output(origin_text, output)
+      origins.each do|origin|
+        origin_text = origin_text.gsub(origin, wrapped)
+      end
+    end if option[:opt].include?(:rtab)
+
+    if option[:opt].include?(:rendfile)
+      pazz = cds[:path].split('.')
+      pazz.insert(-2,Time.new.strftime("%Y%m%d%H%M%S"))
+      File.write pazz.join('.'), origin_text
+    end
+    return { text: origin_text, data: scr_tail, fact: (erl_tail.empty? ? nil : erl_tail)}
+  end
+end