lab42_speculate 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3427d6436310d4254e6b44eab9bf4bb987e7baf944c30844e6c5ba3d321f4f5
+  data.tar.gz: b470196d41cc3f1ce0a842c4432ab413f961db0c2f947597beb2517cb179ee54
+SHA512:
+  metadata.gz: 151f993021994a91eb565ea2bedf2d56ccded40629fbb1211ab2ac69b522a5dff72255f1a8aa6a1ce9049abb3a63c5ccb457c728f8a89022d55fa8e86d9e09f5
+  data.tar.gz: f0c0c60a70a94de2ae905b638192b10a04bde6f5890acd4303fff66a3c50f3f0bceecabf129be71ae58bd3a6dc0eccfe570b3e0e953a02a25f71182003deacc4

data/bin/speculate

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require_relative '../lib/speculate.rb'
+
+Speculate.run ARGV

data/lib/speculate.rb

@@ -0,0 +1,57 @@
+module Speculate extend self
+  require_relative 'speculate/args'
+  require_relative 'speculate/dirs'
+  require_relative 'speculate/generator'
+
+  BASE_DIR = 'spec/speculations'
+
+  attr_reader :args
+
+  def base_dir
+    @__base_dir__ ||= args.fetch!(:dest, BASE_DIR) 
+  end
+
+  def speculations
+    @__speculations__ ||= _speculations
+  end
+
+  def speculations_dir
+    @__speculations_dir__ ||= args.fetch!(:dir, 'spec/speculations')
+  end
+
+  def speculations_glob
+    @__speculations_glob__ ||= args.fetch!(:glob, '**/*.md')
+  end
+
+  def run args
+    @args = Args.new args
+    if @args.flag!(:force)
+      _force speculations
+    end
+    speculations
+      .filter(&:outdated?)
+      .each(&Generator.method(:generate))
+  end
+
+
+  private
+
+  def _force speculations
+    speculations.each do |speculation|
+      puts "touching #{speculation.speculation.path} as :force was passed in"
+      FileUtils.touch speculation.speculation
+    end
+  end
+
+  def _speculations
+    speculations = Dir.glob(File.join(speculations_dir, speculations_glob))
+    if speculations.any?
+      puts "Speculations found: #{speculations}"
+    else
+      puts "No Speculations found!!!! :O :O :O"
+      return []
+    end
+    speculations.map{ |speculation| Dirs.speculation_to_dir(speculation, base_dir) }
+  end
+
+end

data/lib/speculate/args.rb

@@ -0,0 +1,76 @@
+class Speculate::Args
+
+  FLAG_RGX = %r{\A:}
+  KEYWORD_RGX = %r{:\z}
+
+  attr_reader :args
+
+  def empty?; args.empty? end
+
+  def fetch symbol, default=nil, &block
+    index = args.index("#{symbol}:")
+    return default unless index
+    args.fetch( index.succ, default ).tap do |value|
+      return block.(value) if block
+    end
+  end
+
+  def fetch! symbol, default=nil, &block
+    index = args.index("#{symbol}:")
+    return default unless index
+    args.delete_at index
+    args.fetch( index ) {
+      return default
+    }.tap{ |value|
+      args.delete_at index
+      return block.(value) if block
+    }
+  end
+
+  def flag? value
+    args.index ":#{value}"
+  end
+
+  def flag! value
+    flag?(value).tap do |idx|
+      return unless idx
+      args.delete_at(idx)
+    end
+  end
+
+  def positionals
+    args.inject [false, []] do |(last_was_keyword, result), ele|
+      if last_was_keyword
+        [false, result]
+      else
+        case ele
+        when KEYWORD_RGX
+          [true, result]
+        when FLAG_RGX
+          [false, result]
+        else
+          [false, result << ele]
+        end
+      end
+    end.last
+  end
+
+  def to_a
+    args.dup
+  end
+
+
+  private
+
+  def initialize with
+    @args = with.dup
+  end
+
+  def _flag arg
+    FLAG_RGX.match? arg
+  end
+
+  def _keyword? arg
+    KEYWORD_RGX.match arg
+  end
+end

data/lib/speculate/dirs.rb

@@ -0,0 +1,36 @@
+require 'fileutils'
+
+require_relative './spec_pair'
+module Speculate::Dirs extend self
+  Error = Class.new RuntimeError
+
+  DEFAULT_BASENAME = "__default"
+  SPECULATION_RGX  = %r{\ASPECULATE[-_]*(.*)\.md\z}
+
+  attr_reader :base_dir
+
+  def speculation_to_dir speculation_file, base_dir
+    @base_dir = base_dir
+
+    _assure_dir
+    speculation_file, spec_path = _assure_speculation speculation_file
+
+    Speculate::SpecPair.new speculation_file, spec_path
+  end
+
+
+  private
+
+  def _assure_dir
+    FileUtils.mkdir_p(base_dir)
+  end
+
+  def _assure_speculation speculation_file
+
+    basename = File.basename(speculation_file).sub(%r{\..*\z}i, "").downcase
+    specname = File.join(base_dir, "#{basename}_spec.rb")
+
+    [speculation_file, specname]
+  end
+
+end

data/lib/speculate/generator.rb

@@ -0,0 +1,29 @@
+require_relative './parser.rb'
+module Speculate::Generator extend self
+  Error = Class.new RuntimeError
+
+  def generate pair
+    unless pair.outdated?
+      raise Error,
+        "Must not call generate for #{pair.speculation.path} -> #{pair.spec.path}, because it is not outdated"
+    end
+    puts "Generating: #{pair.speculation.path} -> #{pair.spec.path}"
+    text = Speculate::Parser.new(pair.speculation).parse
+    File.open(pair.spec.path, "w"){ |f|
+      f.puts _header(pair.speculation.path)
+      f.puts text
+      f.puts _footer
+    }
+  end
+
+
+  private
+
+  def _footer
+    %{end}
+  end
+
+  def _header name
+    %{RSpec.describe #{name.inspect} do}
+  end
+end

data/lib/speculate/parser.rb

@@ -0,0 +1,61 @@
+class Speculate::Parser
+  Error = Class.new RuntimeError
+
+  SPECULATION_END_RGX   = %r{\A\s{0,3}(?:```)|(?:~~~)\s*\z}
+  SPECULATION_START_RGX = %r{\A\s{0,3}(?:```)|(?:~~~)(\w+)speculate}
+
+  attr_reader :state, :stream
+
+  def parse
+    @state = :outer
+    _parse
+    lines
+  end
+
+
+  private
+
+  def initialize speculation
+    @stream =
+      speculation
+        .each_line(chomp: true)
+        .lazy
+  end
+
+
+  # Memos
+  # =====
+  def lines
+     @__lines__ ||= []
+  end
+
+
+  # Parser
+  # ======
+  def _parse
+    stream.each do |line|
+      case state
+      when :outer
+        _parse_outer line
+      when :inner
+        _parse_inner line
+      else
+        raise Error, "illegal state #{state}"
+      end
+    end
+  end
+
+  def _parse_inner line
+    if SPECULATION_END_RGX =~ line
+      @state = :outer
+    else
+      lines << line
+    end
+  end
+
+  def _parse_outer line
+    if SPECULATION_START_RGX =~ line
+      @state = :inner
+    end
+  end
+end

data/lib/speculate/spec_pair.rb

@@ -0,0 +1,26 @@
+require 'fileutils'
+class Speculate::SpecPair
+
+  attr_reader :spec, :speculation
+
+  def outdated?
+    speculation.mtime >= spec.mtime
+  end
+
+
+  private
+
+  def initialize speculation_name, spec_path 
+    @speculation = File.new speculation_name
+
+    FileUtils.touch(spec_path, mtime: speculation.mtime - 1) unless File.exists? spec_path
+    @spec        = File.new spec_path
+  end
+
+  def _spec_pair basename
+    specname = File.join(base_dir, "#{basename}_spec.rb")
+    FileUtils.touch(specname, mtime: speculation.mtime - 1) unless File.exists? specname
+    OpenStruct.new(speculation: speculation, spec: File.new(specname))
+  end
+  
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: lab42_speculate
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Robert Dober
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Extract RSpecs from Markdown
+email: robert.dober@gmail.com
+executables:
+- speculate
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/speculate
+- lib/speculate.rb
+- lib/speculate/args.rb
+- lib/speculate/dirs.rb
+- lib/speculate/generator.rb
+- lib/speculate/parser.rb
+- lib/speculate/spec_pair.rb
+homepage: https://github.com/robertdober/speculate
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Extract RSpecs from Markdown
+test_files: []