SpecMe 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 039da57027c51ea0dcab8bcf05abc9f58b380976
+  data.tar.gz: 68eb5cf7432a180e0c97eb61b01300470920ec03
+SHA512:
+  metadata.gz: 1fcf51d6eeff16395523aebce2781aad0b2d903067686f99da7287b45811b79b33cba0e4545591cac5809cbf9536d616793d9817dbc038173783cbbb1961a9e3
+  data.tar.gz: fa6b6f2dd0cb56b39c0a8238aec892a74da5d047aee6d7713ec54f126566671e5d4607d4048f75548e72009707e6462bd7b195825f2dc2786c2c1312b0dd8ef0

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Robert Dober
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# SpecMe
+
+You have a great README, with great code examples, just make sure they are correct
+
+## How?
+
+Simply by writing code blocks like this one
+
+```md
+    <!-- SpecMe -->
+    ```ruby
+
+        completelyNewAdder = MyShinyCodeGenerator.new( :adder )
+        completelyNewAdder(1, 2, 3)   #-->    6
+
+    ```
+```
+
+Which will create specs like this
+```ruby
+
+    describe "Some generated or provided name" do
+      it "some other generated or provided name" do
+        completelyNewAdder = MyShinyCodeGenerator.new( :adder )
+        expect(
+          completelyNewAdder(1, 2, 3)
+        ).to eq(
+          6
+        )
+      end
+    end
+```
+
+## And How exactly?
+
+
+[See here](dox/UserManual.md)

data/lib/spec_me/config.rb

@@ -0,0 +1,13 @@
+require 'ostruct'
+
+class SpecMe
+  Config = OpenStruct.new \
+    spec_me_root:   File.join( 'spec', 'spec_me' ),
+    spec_me_helper: 'spec_helper',
+    spec_me_tag:    'spec_me',
+
+    start_code_block: %r{\A```ruby\z},
+    end_code_block:   %r{\A```\z},
+    code_comment:     %r{\A\s*#\s*(.*)\z},
+    equality_xp:      %r{\A\s*(.*)#-->(.*)\z}
+end # class SpecMe

data/lib/spec_me/renderer.rb

@@ -0,0 +1,57 @@
+class SpecMe
+  class Renderer
+    attr_accessor :config
+
+    def render( ast, file_name:, count:1, spec_helper: nil, **params)
+      (
+        spec_helper_lines(spec_helper) +
+        description( file_name: file_name, count: count, **params ) +
+        example( count: count ) +
+        code(ast) +
+        end_lines( 2 )
+      ) # .tap{ |r| puts r }
+    end
+
+    def code(ast)
+      ast.map{ |node| render_node node }.flatten
+    end
+
+    def description( file_name:, count: 1, **params)
+      example_group_name = params.fetch :example_group_name, "#{file_name} #{count}"
+      rspec_tag = params.fetch :rspec_tag, config.spec_me_tag
+      [%{describe '#{example_group_name}', :#{rspec_tag} do}] #.tap{|r| p description: r}
+    end
+
+    def end_lines n
+      n.times.map{ |i|
+        '  ' * (n-i.succ) + 'end'
+      }
+    end
+
+    def example( count:)
+      [%{  it 'example #{count}' do}] 
+    end
+
+    def render_node node
+      case node.first
+      when :comment
+        %{    # #{node.last}}
+      when :ruby
+        %{    #{node.last}}
+      when :equality_xp
+        [%{    expect( #{node[1]} ).to eq(},
+         %{      #{node.last}},
+           %{    )}]
+      end
+    end
+    def spec_helper_lines spec_helper
+      spec_helper ||= config.spec_me_helper
+      [ %{require '#{spec_helper}'}, '' ]
+    end
+    private
+
+    def initialize config
+      self.config = config
+    end
+  end # module Renderer
+end # class SpecMe

data/lib/spec_me/version.rb

@@ -0,0 +1,3 @@
+class SpecMe
+  VERSION = "0.0.1.pre"
+end # class SpecMe

data/lib/spec_me.rb

@@ -0,0 +1,75 @@
+require_relative 'spec_me/config'
+require_relative 'spec_me/renderer'
+
+class SpecMe
+  attr_accessor :ast, :config, :file
+
+  def run args
+    file = args.shift or raise ArgumentError, "Missing file name"
+    raise ArgumentError, "Input file `#{file}' missing or not readable" unless File.readable? file
+    self.file = file
+    parse File.readlines( file )
+    generate_spec
+  end
+
+  def initialize
+    self.config = SpecMe::Config
+  end
+
+  def ast_to_spec
+    Renderer.new( config ).render ast, count: 1, file_name: @base_file_name 
+  end
+
+  def generate_spec
+    return if ast.empty?
+    @base_file_name = File
+      .basename( file )
+      .sub( %r{\..*\z}, "" )
+    @output_file = File.join config.spec_me_root, "#{@base_file_name}_spec.rb"
+
+    File.open( @output_file, "w" ) do | f | 
+      f.puts ast_to_spec
+    end 
+  end
+
+  def parse lines
+    self.ast = []
+    @state = :outside
+    lines.each do | line |
+      state_machine line.chomp
+    end
+    post_parse
+  end
+
+  def parse_line line
+    case line
+    when config.code_comment
+      [:comment, Regexp.last_match[1]]
+    when config.equality_xp
+      [:equality_xp] + Regexp.last_match[1..2].map(&:strip)
+    else
+      [:ruby, line.strip]
+    end
+  end
+
+  def post_parse
+    # No need to create specs if there are no expectations
+    self.ast = [] unless ast.any?{ |node| %r{_xp\z} === node.first }
+  end
+  private
+
+  def state_machine line
+    case @state
+    when :outside
+      # update_config_from line if config.instruction_line === line
+      return unless config.start_code_block === line
+      @state = :inside
+    when :inside
+      if config.end_code_block === line
+        @state = :outside
+      else
+        self.ast << parse_line( line )
+      end
+    end
+  end
+end # class SpecMe

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: SpecMe
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Robert Dober
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+description: Generating rspecs from ruby code blocks in README files
+email: robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/spec_me.rb
+- lib/spec_me/config.rb
+- lib/spec_me/renderer.rb
+- lib/spec_me/version.rb
+homepage: https://github.com/RobertDober/SpecMe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Assuring you code examples pass, with RSpec
+test_files: []