rubocop-yast 0.0.4 → 0.0.5

data/spec/ops_spec.rb

@@ -2,14 +2,14 @@
 
 require "spec_helper"
 
-def config(safe_mode: true)
-  conf = { "Yast/Ops" => { "SafeMode" => safe_mode } }
-  RuboCop::Config.new(conf)
-end
-
 describe RuboCop::Cop::Yast::Ops do
   context("In safe mode") do
-    subject(:cop) { described_class.new(config(safe_mode: true)) }
+    let(:config) do
+      conf = { "Yast/Ops" => { "SafeMode" => true } }
+      RuboCop::Config.new(conf)
+    end
+
+    subject(:cop) { described_class.new(config) }
 
     it "finds trivial Ops.add call" do
       inspect_source(cop, ["Ops.add(2, 4)"])
@@ -99,7 +99,12 @@ describe RuboCop::Cop::Yast::Ops do
   end
 
   context("In unsafe mode") do
-    subject(:cop) { described_class.new(config(safe_mode: false)) }
+    let(:config) do
+      conf = { "Yast/Ops" => { "SafeMode" => false } }
+      RuboCop::Config.new(conf)
+    end
+
+    subject(:cop) { described_class.new(config) }
 
     it "finds unsafe Ops.add calls" do
       inspect_source(cop, ["if true\nOps.add(foo, 4)\nend"])

data/spec/rspec_code.rb

@@ -0,0 +1,47 @@
+
+# this module provides code block generators for RSpecRenderer
+module RspecCode
+  # rubocop:disable Metrics/MethodLength
+  def generate_translation_code
+    [
+      "original_code = code_cleanup(<<-EOT)",
+      Code.indent(@original_code),
+      "EOT",
+      "",
+      "translated_code = code_cleanup(<<-EOT)",
+      Code.indent(@translated_code),
+      "EOT",
+      "",
+      "cop = RuboCop::Cop::Yast::Builtins.new",
+      "expect(autocorrect_source(cop, original_code)).to eq(translated_code)"
+    ].join("\n")
+  end
+
+  def generate_offense_code
+    [
+      "code = code_cleanup(<<-EOT)",
+      Code.indent(@offense),
+      "EOT",
+      "",
+      "cop = RuboCop::Cop::Yast::Builtins.new",
+      "inspect_source(cop, [code])",
+      "",
+      "expect(cop.offenses.size).to eq(1)",
+      "expect(cop.messages.first).to match(/Builtin call `.*` is obsolete/)"
+    ].join("\n")
+  end
+
+  def generate_accepted_code
+    [
+      "code = code_cleanup(<<-EOT)",
+      Code.indent(@accepted_code),
+      "EOT",
+      "",
+      "cop = RuboCop::Cop::Yast::Builtins.new",
+      "inspect_source(cop, [code])",
+      "",
+      "expect(cop.offenses).to be_empty"
+    ].join("\n")
+  end
+  # rubocop:enable Metrics/MethodLength
+end

data/spec/rspec_renderer.rb

@@ -0,0 +1,206 @@
+require "redcarpet"
+
+require_relative "rspec_code"
+
+# Utility functions for manipulating code.
+module Code
+  INDENT_STEP = 2
+
+  class << self
+    def join(lines)
+      lines.map { |l| "#{l}\n" }.join("")
+    end
+
+    def indent(s)
+      s.gsub(/^(?=.)/, " " * INDENT_STEP)
+    end
+  end
+end
+
+# Represents RSpec's "it" block.
+class It
+  def initialize(attrs)
+    @description = attrs[:description]
+    @code        = attrs[:code]
+    @skip        = attrs[:skip]
+  end
+
+  def render
+    [
+      "#{@skip ? "xit" : "it"} #{@description.inspect} do",
+      Code.indent(@code),
+      "end"
+    ].join("\n")
+  end
+end
+
+# Represents RSpec's "describe" block.
+class Describe
+  attr_reader :blocks
+
+  def initialize(attrs)
+    @description = attrs[:description]
+    @blocks      = attrs[:blocks]
+  end
+
+  def render
+    parts = []
+    parts << "describe #{@description.inspect} do"
+    parts << Code.indent(@blocks.map(&:render).join("\n\n")) if !blocks.empty?
+    parts << "end"
+    parts.join("\n")
+  end
+end
+
+# Renders a Markdown file to an RSpec test script
+class RSpecRenderer < Redcarpet::Render::Base
+  include RspecCode
+
+  IGNORED_HEADERS = [
+    "Table Of Contents",
+    "Description"
+  ]
+
+  def initialize
+    super
+
+    @next_block_type = :unknown
+    @describe = Describe.new(description: "RuboCop-Yast", blocks: [])
+  end
+
+  # preprocess the MarkDown input - remove comments
+  def preprocess(fulldoc)
+    # use multiline regexp pattern
+    fulldoc.gsub(/<!--.*-->/m, "")
+  end
+
+  def header(text, header_level)
+    return nil if header_level == 1 || IGNORED_HEADERS.include?(text)
+
+    if header_level > describes_depth + 1
+      raise "Missing higher level header: #{text}"
+    end
+
+    describe_at_level(header_level - 1).blocks << Describe.new(
+      description: text + ":",
+      blocks:      []
+    )
+
+    nil
+  end
+
+  def paragraph(text)
+    if text =~ /^\*\*(.*)\*\*$/
+      @next_block_type = Regexp.last_match[1].downcase.to_sym
+    else
+      first_sentence = text.split(/\.(\s+|$)/).first
+      @description = first_sentence.sub(/^RuboCop-Yast /, "").sub(/\n/, " ")
+    end
+
+    nil
+  end
+
+  # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity:
+  def block_code(code, _language)
+    escaped_code = escape(code[0..-2])
+
+    case @next_block_type
+    when :original
+      @original_code = escaped_code
+    when :translated
+      @translated_code = escaped_code
+    when :unchanged
+      @original_code = @translated_code = escaped_code
+    when :offense
+      @offense = escaped_code
+    when :accepted
+      @accepted_code = escaped_code
+    else
+      raise "Invalid next code block type: #{@next_block_type}.\n#{code}"
+    end
+
+    @next_block_type = :unknown
+
+    add_translation_block if @original_code && @translated_code
+    add_offense_block if @offense
+    add_accepted_block if @accepted_code
+
+    nil
+  end
+  # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity:
+
+  # escape ruby interpolation
+  def escape(code)
+    code.gsub("\#{", "\\\#{")
+  end
+
+  def doc_header
+    Code.join([
+      "# Automatically generated -- DO NOT EDIT!",
+      "",
+      "require \"spec_helper\"",
+      ""
+    ])
+  end
+
+  def doc_footer
+    "#{@describe.render}\n"
+  end
+
+  private
+
+  def describes_depth
+    describe = @describe
+    depth = 1
+    while describe.blocks.last.is_a?(Describe)
+      describe = describe.blocks.last
+      depth += 1
+    end
+    depth
+  end
+
+  def current_describe
+    describe = @describe
+    describe = describe.blocks.last while describe.blocks.last.is_a?(Describe)
+    describe
+  end
+
+  def describe_at_level(level)
+    describe = @describe
+    2.upto(level) do
+      describe = describe.blocks.last
+    end
+    describe
+  end
+
+  def add_translation_block
+    current_describe.blocks << It.new(
+      description: @description,
+      code:        generate_translation_code,
+      skip:        @description =~ /XFAIL/
+    )
+
+    @original_code   = nil
+    @translated_code = nil
+  end
+
+  def add_offense_block
+    current_describe.blocks << It.new(
+      description: @description,
+      code:        generate_offense_code,
+      skip:        @description =~ /XFAIL/
+    )
+
+    @offense = nil
+  end
+
+  def add_accepted_block
+    current_describe.blocks << It.new(
+      description: @description,
+      code:        generate_accepted_code,
+      skip:        @description =~ /XFAIL/
+    )
+
+    @accepted_code = nil
+  end
+end

data/spec/spec_helper.rb

@@ -1,21 +1,23 @@
 # encoding: utf-8
 
-if ENV["COVERAGE"]
-  require "simplecov"
+require "simplecov"
 
-  # use coveralls for on-line code coverage reporting at Travis CI
-  if ENV["TRAVIS"]
-    require "coveralls"
+# use coveralls for on-line code coverage reporting at Travis CI
+if ENV["TRAVIS"]
+  require "coveralls"
 
-    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-      SimpleCov::Formatter::HTMLFormatter,
-      Coveralls::SimpleCov::Formatter
-    ]
-  end
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+end
 
-  SimpleCov.minimum_coverage 95
+SimpleCov.minimum_coverage 95
 
-  SimpleCov.start
+SimpleCov.start do
+  # don't check code coverage in these subdirectories
+  add_filter "/vendor/"
+  add_filter "/spec/"
 end
 
 # allow only the new "expect" RSpec syntax
@@ -29,11 +31,17 @@ RSpec.configure do |config|
   end
 end
 
-# As much as possible, we try to reuse RuboCop's spec environment.
+# reuse the Rubocop helper, provides some nice methods used in tests
 require File.join(
   Gem::Specification.find_by_name("rubocop").gem_dir, "spec", "spec_helper.rb"
 )
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
+def code_cleanup(s)
+  s.split("\n").reject { |l| l =~ /^\s*$/ }.first =~ /^(\s*)/
+  return s.dup if Regexp.last_match.nil?
+  s.gsub(Regexp.new("^#{Regexp.last_match[1]}"), "")[0..-2]
+end
+
 require "rubocop-yast"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yast
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ladislav Slezák
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-03 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,13 +99,23 @@ files:
 - lib/rubocop-yast.rb
 - lib/rubocop/cop/yast/builtins.rb
 - lib/rubocop/cop/yast/ops.rb
+- lib/rubocop/yast/builtins/builtin.rb
+- lib/rubocop/yast/builtins/getenv.rb
+- lib/rubocop/yast/builtins/time.rb
+- lib/rubocop/yast/builtins/y2log.rb
 - lib/rubocop/yast/config.rb
 - lib/rubocop/yast/niceness.rb
+- lib/rubocop/yast/node_helpers.rb
+- lib/rubocop/yast/reformatter.rb
+- lib/rubocop/yast/track_variable_scope.rb
 - lib/rubocop/yast/variable_scope.rb
 - lib/rubocop/yast/version.rb
 - rubocop-yast.gemspec
+- spec/builtins_spec.md
 - spec/builtins_spec.rb
 - spec/ops_spec.rb
+- spec/rspec_code.rb
+- spec/rspec_renderer.rb
 - spec/spec_helper.rb
 homepage: http://github.com/yast/rubocop-yast
 licenses:
@@ -118,6 +142,9 @@ signing_key:
 specification_version: 4
 summary: Specific YaST Rubocop checks
 test_files:
+- spec/builtins_spec.md
 - spec/builtins_spec.rb
 - spec/ops_spec.rb
+- spec/rspec_code.rb
+- spec/rspec_renderer.rb
 - spec/spec_helper.rb