goodread 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6088e5eebb70dc235fab80821df7e26454bc1058
-  data.tar.gz: e9a7db495590ffeccd4eff3e2800d835b42df7f1
+SHA256:
+  metadata.gz: 2dd0cac02f1796fe0b626e32cc6cc6f4c85424f59457fde0db95a70e8cb8b26a
+  data.tar.gz: 55e79251fd7b7dc19aa6f7534b21778697ee53036f0d66283d641b5db894352b
 SHA512:
-  metadata.gz: c481de27e24bb80d857aa1e6c6e4c1c251b734bdf5b563aaf0b262e769779318ff507da10255ccdd9a8e03112255671a5155df15c0898db29b75d64b161c81c9
-  data.tar.gz: 6ef8ff9e48104e65c299fe9656de15b3cb152ee38a57ba985a2cc0667bb32c1fa047196bc9533aabb7e097ada3ef5fccbd5c161433f14e934beed6d5fe880f2a
+  metadata.gz: 30d152a2f6868a1a50a2c9620680e0c3bba6b0294d0783b4e1e5a30d29a996693bc2c91c849ef3f720a56f76289b0adf687c8f9fc9b6aba64e17be76cf119e23
+  data.tar.gz: 73c5aa278a4480f2599ad6038b46689d5589286b5d8c09343c3dfaf26b56f888d8d27f3e0edd4f34920adb5239ae489ffb4aaa661f8631c9bf7028806130c871

data/.gitignore

@@ -52,3 +52,4 @@ build-iPhoneSimulator/
 # Extra
 Gemfile.lock
 .rspec_status
+goodread.yml

data/goodread.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "goodread"
-  spec.version       = "0.1.3"
+  spec.version       = "0.2.1"
   spec.authors       = ["Evgeny Karev\n"]
   spec.email         = ["eskarev@gmail.com"]
 

data/lib/cli.rb

@@ -2,415 +2,45 @@ require 'json'
 require 'yaml'
 require 'emoji'
 require 'colorize'
+require_relative 'document'
+require_relative 'helpers'
 
 
-# Helpers
-
-def parse_specs(path)
-
-  # Paths
-  paths = []
-  if !path
-    paths =  Dir.glob('package.*')
-    if paths.empty?
-      path = 'packspec'
-    end
-  end
-  if File.file?(path)
-    paths = [path]
-  elsif File.directory?(path)
-    for path in Dir.glob("#{path}/*.*")
-      paths.push(path)
-    end
-  end
-
-  # Specs
-  specs = []
-  for path in paths
-    spec = parse_spec(path)
-    if spec
-      specs.push(spec)
-    end
-  end
-
-  return specs
-
-end
-
-
-def parse_spec(path)
-
-  # Documents
-  documents = []
-  if !path.end_with?('.yml')
-    return nil
-  end
-  contents = File.read(path)
-  YAML.load_stream(contents) do |document|
-    documents.push(document)
-  end
-
-  # Package
-  feature = parse_feature(documents[0][0])
-  if feature['skip']
-    return nil
-  end
-  package = feature['comment']
-
-  # Features
-  skip = false
-  features = []
-  for feature in documents[0]
-    feature = parse_feature(feature)
-    features.push(feature)
-    if feature['comment']
-      skip = feature['skip']
-    end
-    feature['skip'] = skip || feature['skip']
-  end
-
-  # Scope
-  scope = {}
-  scope['$import'] = BuiltinFunctions.new().public_method(:builtin_import)
-  if documents.length > 1 && documents[1]['rb']
-    eval(documents[1]['rb'])
-    hook_scope = Functions.new()
-    for name in hook_scope.public_methods
-      # TODO: filter ruby builtin methods
-      scope["$#{name}"] = hook_scope.public_method(name)
-    end
-  end
-
-  # Stats
-  stats = {'features' => 0, 'comments' => 0, 'skipped' => 0, 'tests' => 0}
-  for feature in features
-    stats['features'] += 1
-    if feature['comment']
-      stats['comments'] += 1
-    else
-      stats['tests'] += 1
-      if feature['skip']
-        stats['skipped'] += 1
-      end
-    end
-  end
-
-  return {
-    'package' => package,
-    'features' => features,
-    'scope' => scope,
-    'stats' => stats,
-  }
-
-end
-
-
-def parse_feature(feature)
-
-  # General
-  if feature.is_a?(String)
-    match = /^(?:\((.*)\))?(\w.*)$/.match(feature)
-    skip, comment = match[1], match[2]
-    if !!skip
-      skip = !skip.split(':').include?('rb')
-    end
-    return {'assign' => nil, 'comment' => comment, 'skip' => skip}
-  end
-  left, right = Array(feature.each_pair)[0]
-
-  # Left side
-  call = false
-  match = /^(?:\((.*)\))?(?:([^=]*)=)?([^=].*)?$/.match(left)
-  skip, assign, property = match[1], match[2], match[3]
-  if !!skip
-    skip = !skip.split(':').include?('rb')
-  end
-  if !assign && !property
-    raise Exception.new('Non-valid feature')
-  end
-  if !!property
-    call = true
-    if property.end_with?('==')
-      property = property[0..-3]
-      call = false
-    end
-  end
-
-  # Right side
-  args = []
-  kwargs = {}
-  result = right
-  if !!call
-    result = nil
-    for item in right
-      if item.is_a?(Hash) && item.length == 1
-        item_left, item_right = Array(item.each_pair)[0]
-        if item_left == '=='
-          result = item_right
-          next
-        end
-        if item_left.end_with?('=')
-          kwargs[item_left[0..-2]] = item_right
-          next
-        end
-      end
-      args.push(item)
-    end
-  end
-
-  # Text repr
-  text = property
-  if !!assign
-    text = "#{assign} = #{property || JSON.generate(result)}"
-  end
-  if !!call
-    items = []
-    for item in args
-      items.push(JSON.generate(item))
-    end
-    for name, item in kwargs.each_pair
-      items.push("#{name}=#{JSON.generate(item)}")
-    end
-    text = "#{text}(#{items.join(', ')})"
-  end
-  if !!result && !assign
-    text = "#{text} == #{result == 'ERROR' ? result : JSON.generate(result)}"
-  end
-  text = text.gsub(/{"([^{}]*?)": null}/, '\1')
-
-  return {
-    'comment' => nil,
-    'skip' => skip,
-    'call' => call,
-    'assign' => assign,
-    'property' => property,
-    'args' => args,
-    'kwargs' => kwargs,
-    'result' => result,
-    'text' => text,
-  }
-
-end
-
-
-def test_specs(specs)
-
-  # Message
-  message = "\n #  Ruby\n".bold
-  puts(message)
-
-  # Test specs
-  success = true
-  for spec in specs
-    spec_success = test_spec(spec)
-    success = success && spec_success
-  end
-
-  return success
-
-end
-
-
-def test_spec(spec)
-
-  # Message
-  message = Emoji.find_by_alias('heavy_minus_sign').raw * 3 + "\n\n"
-  puts(message)
-
-  # Test spec
-  passed = 0
-  for feature in spec['features']
-    result = test_feature(feature, spec['scope'])
-    if result
-      passed += 1
-    end
-  end
-  success = (passed == spec['stats']['features'])
-
-  # Message
-  color = 'green'
-  message = ("\n " + Emoji.find_by_alias('heavy_check_mark').raw + '  ').green.bold
-  if !success
-    color = 'red'
-    message = ("\n " + Emoji.find_by_alias('x').raw + '  ').red.bold
-  end
-  message += "#{spec['package']}: #{passed - spec['stats']['comments'] - spec['stats']['skipped']}/#{spec['stats']['tests'] - spec['stats']['skipped']}\n".colorize(color).bold
-  puts(message)
-
-  return success
-
-end
-
-
-def test_feature(feature, scope)
-
-  # Comment
-  if !!feature['comment']
-    message = "\n # #{feature['comment']}\n".bold
-    puts(message)
-    return true
-  end
-
-  # Skip
-  if !!feature['skip']
-    message = " #{Emoji.find_by_alias('heavy_minus_sign').raw}  ".yellow
-    message += feature['text']
-    puts(message)
-    return true
-  end
-
-  # Dereference
-  # TODO: deepcopy feature
-  if !!feature['call']
-    feature['args'] = dereference_value(feature['args'], scope)
-    feature['kwargs'] = dereference_value(feature['kwargs'], scope)
-  end
-  feature['result'] = dereference_value(feature['result'], scope)
-
-  # Execute
-  exception = nil
-  result = feature['result']
-  if !!feature['property']
-    begin
-      property = scope
-      for name in feature['property'].split('.')
-        property = get_property(property, name)
-      end
-      if !!feature['call']
-        args = feature['args'].dup
-        if !feature['kwargs'].empty?
-          args.push(Hash[feature['kwargs'].map{|k, v| [k.to_sym, v]}])
-        end
-        if property.respond_to?('new')
-          result = property.new(*args)
-        else
-          result = property.call(*args)
-        end
-      else
-        result = property
-        if result.is_a?(Method)
-          result = result.call()
-        end
-      end
-    rescue Exception => exc
-      exception = exc
-      result = 'ERROR'
-    end
-  end
-
-  # Assign
-  if !!feature['assign']
-    owner = scope
-    names = feature['assign'].split('.')
-    for name in names[0..-2]
-      owner = get_property(owner, name)
-    end
-    # TODO: ensure constants are immutable
-    set_property(owner, names[-1], result)
-  end
+# Main program
 
-  # Compare
-  if feature['result'] != nil
-    success = result == feature['result']
+# Parse
+paths = []
+edit = false
+sync = false
+exit_first = false
+for arg in ARGV
+  if ['-e', '--edit'].include?(arg)
+    edit = true
+  elsif ['-s', '--sync'].include?(arg)
+    sync = true
+  elsif ['-x', '--exit-first'].include?(arg)
+    exit_first = true
   else
-    success = result != 'ERROR'
+    paths.push(arg)
   end
-  if success
-    message = " #{Emoji.find_by_alias('heavy_check_mark').raw}  ".green
-    message += feature['text']
-    puts(message)
-  else
-    begin
-      result_text = JSON.generate(result)
-    rescue Exception
-      result_text = result.to_s
-    end
-    message = " #{Emoji.find_by_alias('x').raw}  ".red
-    message += "#{feature['text']}\n"
-    if exception
-      message += "Exception: #{exception}".red.bold
-    else
-      message += "Assertion: #{result_text} != #{JSON.generate(feature['result'])}".red.bold
-    end
-    puts(message)
-  end
-
-  return success
-
 end
 
+# Prepare
+config = read_config()
+documents = DocumentList.new(paths, config)
 
-class BuiltinFunctions
-  def builtin_import(package)
-    attributes = {}
-    require(package)
-    for item in ObjectSpace.each_object
-      if package == String(item).downcase
-        begin
-          scope = Kernel.const_get(item)
-        rescue Exception
-          next
-        end
-        for name in scope.constants
-          attributes[String(name)] = scope.const_get(name)
-        end
-      end
-    end
-    return attributes
-  end
-end
+# Edit
+if edit
+  documents.edit()
 
+# Sync
+elsif sync
+  documents.sync()
 
-def dereference_value(value, scope)
-  if value.is_a?(Hash) && value.length == 1 && Array(value.each_value)[0] == nil
-    result = scope
-    for name in Array(value.each_key)[0].split('.')
-      result = get_property(result, name)
-    end
-    value = result
-  elsif value.is_a?(Hash)
-    for key, item in value
-      value[key] = dereference_value(item, scope)
-    end
-  elsif value.is_a?(Array)
-    for item, index in value.each_with_index
-      value[index] = dereference_value(item, scope)
-    end
+# Test
+else
+  success = documents.test(exit_first:exit_first)
+  if not success
+    exit(1)
   end
-  return value
-end
-
-
-def get_property(owner, name)
-  if owner.is_a?(Method)
-    owner = owner.call()
-  end
-  if owner.class == Hash
-    return owner[name]
-  elsif owner.class == Array
-    return owner[name.to_i]
-  end
-  return owner.method(name)
-end
-
-
-def set_property(owner, name, value)
-  if owner.class == Hash
-    owner[name] = value
-    return
-  elsif owner.class == Array
-    owner[name.to_i] = value
-    return
-  end
-  return owner.const_set(name, value)
-end
-
-
-# Main program
-
-path = ARGV[0] || nil
-specs = parse_specs(path)
-success = test_specs(specs)
-if !success
-  exit(1)
 end

data/lib/document.rb

@@ -0,0 +1,266 @@
+require 'net/http'
+require_relative 'helpers'
+
+
+# Module API
+
+class DocumentList
+
+  # Public
+
+  def initialize(paths, config)
+    @documents = []
+    if paths.empty?
+      for item in config['documents']
+        paths.push(item['main'])
+      end
+    end
+    for path in !paths.empty? ? paths : ['README.md']
+      main_path = path
+      edit_path = nil
+      sync_path = nil
+      for item in config['documents']
+        if path == item['main']
+          edit_path = item.fetch('edit', nil)
+          sync_path = item.fetch('sync', nil)
+          break
+        end
+      end
+      document = Document.new(main_path, edit_path:edit_path, sync_path:sync_path)
+      @documents.push(document)
+    end
+  end
+
+  def edit()
+    for document in @documents
+      document.edit()
+    end
+  end
+
+  def sync()
+    success = true
+    for document in @documents
+      valid = document.test(sync:true)
+      success = success && valid
+      if valid
+        document.sync()
+      end
+    end
+    return success
+  end
+
+  def test(exit_first:false)
+    success = true
+    for document, index in @documents.each_with_index
+      number = index + 1
+      valid = document.test(exit_first:exit_first)
+      success = success && valid
+      print_message(nil, (number < @documents.length ? 'separator' : 'blank'))
+    end
+    return success
+  end
+
+end
+
+
+class Document
+
+  # Public
+
+  def initialize(main_path, edit_path:nil, sync_path:nil)
+    @main_path = main_path
+    @edit_path = edit_path
+    @sync_path = sync_path
+  end
+
+  def edit()
+
+    # No edit path
+    if !@edit_path
+      return
+    end
+
+    # Check synced
+    if @main_path != @edit_path
+      main_contents = _load_document(@main_path)
+      sync_contents = _load_document(@sync_path)
+      if main_contents != sync_contents
+        raise Exception.new("Document '#{@edit_path}' is out of sync")
+      end
+    end
+
+    # Remote document
+    # TODO: supress commands output
+    if !@edit_path.start_with?('http')
+      Kernel.system('editor', @edit_path)
+
+    # Local document
+    else
+      Kernel.system('xdg-open', @edit_path)
+    end
+
+  end
+
+  def sync()
+
+    # No sync path
+    if !@sync_path
+      return
+    end
+
+    # Save remote to local
+    contents = Net::HTTP.get(URI(@sync_path))
+    File.write(@main_path, contents)
+
+  end
+
+  def test(sync:false, return_report:false, exit_first:false)
+
+    # No test path
+    path = sync ? @sync_path : @main_path
+    if !path
+      return true
+    end
+
+    # Test document
+    contents = _load_document(path)
+    elements = _parse_document(contents)
+    report = _validate_document(elements, exit_first:exit_first)
+
+    return return_report ? report : report['valid']
+  end
+
+end
+
+
+# Internal
+
+def _load_document(path)
+
+  # Remote document
+  if path.start_with?('http')
+    return Net::HTTP.get(URI(path))
+
+  # Local document
+  else
+    return File.read(path)
+  end
+
+end
+
+
+def _parse_document(contents)
+  elements = []
+  codeblock = ''
+  capture = false
+
+  # Parse file lines
+  for line in contents.strip().split("\n")
+
+    # Heading
+    if line.start_with?('#')
+      heading = line.strip().tr('#', '')
+      level = line.length - line.tr('#', '').length
+      if (!elements.empty? &&
+          elements[-1]['type'] == 'heading' &&
+          elements[-1]['level'] == level)
+        next
+      end
+      elements.push({
+        'type' => 'heading',
+        'value' => heading,
+        'level' => level,
+      })
+    end
+
+    # Codeblock
+    if line.start_with?('```ruby')
+      if line.include?('goodread')
+        capture = true
+      end
+      codeblock = ''
+      next
+    end
+    if line.start_with?('```')
+      if capture
+        elements.push({
+          'type' => 'codeblock',
+          'value' => codeblock,
+        })
+      end
+      capture = false
+    end
+    if capture && !line.empty?
+      codeblock += line + "\n"
+      next
+    end
+
+  end
+
+  return elements
+end
+
+
+def _validate_document(elements, exit_first:false)
+  scope = binding()
+  passed = 0
+  failed = 0
+  skipped = 0
+  title = nil
+  exception = nil
+
+  # Test elements
+  for element in elements
+
+    # Heading
+    if element['type'] == 'heading'
+      print_message(element['value'], 'heading', level:element['level'])
+      if title == nil
+        title = element['value']
+        print_message(nil, 'separator')
+      end
+
+    # Codeblock
+    elsif element['type'] == 'codeblock'
+      exception_line = 1000  # infinity
+      begin
+        eval(instrument_codeblock(element['value']), scope)
+      rescue Exception => exc
+        exception = exc
+        # TODO: get a real exception line
+        exception_line = 1
+      end
+      lines = element['value'].strip().split("\n")
+      for line, index in lines.each_with_index
+        line_number = index + 1
+        if line_number < exception_line
+          print_message(line, 'success')
+          passed += 1
+        elsif line_number == exception_line
+          print_message(line, 'failure', exception:exception)
+          if exit_first
+            print_message(scope, 'scope')
+            raise exception
+          end
+          failed += 1
+        elsif line_number > exception_line
+          print_message(line, 'skipped')
+          skipped += 1
+        end
+      end
+    end
+
+  end
+
+  # Print summary
+  if title != nil
+    print_message(title, 'summary', passed:passed, failed:failed, skipped:skipped)
+  end
+
+  return {
+    'valid' => exception == nil,
+    'passed' => passed,
+    'failed' => failed,
+    'skipped' => skipped,
+  }
+end

data/lib/helpers.rb

@@ -0,0 +1,85 @@
+require 'yaml'
+require 'emoji'
+require 'colorize'
+$state = {'last_message_type' => nil}
+
+
+# Module API
+
+def read_config()
+  config = {'documents' => ['README.md']}
+  if File.file?('goodread.yml')
+    config = YAML.load(File.read('goodread.yml'))
+    for document, index in config['documents'].each_with_index
+      if document.is_a?(Hash)
+        if !document.include?('main')
+          raise Exception.new('Document requires "main" property')
+        end
+      end
+      if document.is_a?(String)
+        config['documents'][index] = {'main' => document}
+      end
+    end
+  end
+  return config
+end
+
+
+def instrument_codeblock(codeblock)
+  lines = []
+  for line in codeblock.strip().split("\n")
+    if line.include?(' # ')
+      left, right = line.split(' # ')
+      left = left.strip()
+      right = right.strip()
+      if left && right
+        message = "#{left} != #{right}"
+        line = "raise '#{message}' unless #{left} == #{right}"
+      end
+    end
+    lines.push(line)
+  end
+  return lines.join("\n")
+end
+
+
+def print_message(message, type, level: nil, exception: nil, passed: nil, failed: nil, skipped: nil)
+  text = ''
+  if type == 'blank'
+    return puts('')
+  elsif type == 'separator'
+    text = Emoji.find_by_alias('heavy_minus_sign').raw * 3
+  elsif type == 'heading'
+    text = " #{'#' * (level || 1)}" + message.bold
+  elsif type == 'success'
+    text = " #{Emoji.find_by_alias('heavy_check_mark').raw}  ".green + message
+  elsif type == 'failure'
+    text = " #{Emoji.find_by_alias('x').raw}  ".red + message + "\n"
+    text += "Exception: #{exception}".red.bold
+  elsif type == 'scope'
+    text += "---\n\n"
+    text += "Scope (current execution scope):\n"
+    text += "#{message}\n"
+    text += "\n---\n"
+  elsif type == 'skipped'
+    text = " #{Emoji.find_by_alias('heavy_minus_sign').raw}  ".yellow + message
+  elsif type == 'summary'
+    color = :green
+    text = (' ' + Emoji.find_by_alias('heavy_check_mark').raw + ' ').green.bold
+    if (failed + skipped) > 0
+      color = :red
+      text = ("\n " + Emoji.find_by_alias('x').raw + ' ').red.bold
+    end
+    text += "#{message}: #{passed}/#{passed + failed + skipped}".colorize(color).bold
+  end
+  if ['success', 'failure', 'skipped'].include?(type)
+    type = 'test'
+  end
+  if text
+    if $state['last_message_type'] != type
+      text = "\n" + text
+    end
+    puts(text)
+    $state['last_message_type'] = type
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goodread
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - |
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,8 @@ files:
 - bin/setup
 - goodread.gemspec
 - lib/cli.rb
+- lib/document.rb
+- lib/helpers.rb
 homepage: https://github.com/goodread/goodread-rb
 licenses:
 - MIT
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.1
 signing_key: 
 specification_version: 4
 summary: goodread