code-spec 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Kristian Mandrup
+
+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.markdown

@@ -0,0 +1,43 @@
+# Code spec
+
+RSpec 2 matchers to facilitate making specs regarding Ruby code files, f.ex as generated or modified/mutated by a code generator.
+
+## Install
+
+gem install code-spec
+
+## Usage
+
+See specs for examples on how to use it.
+
+Example: Nested DSL
+<pre>  ...   
+  with_subclass = %q{
+      class Hello < Greeting
+        def hello
+          # howdy
+        end
+      end}    
+  
+  it "should not have subclass Greeting" do            
+    with_subclass.should have_subclass :hello, :greeting do |content|
+      content.should have_method :hello do |hello|
+        hello.should have_comment 'howdy'
+      end
+    end
+  end
+</pre>
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "code-spec"
+    gem.summary = %Q{Code file RSpec 2 matchers}
+    gem.description = %Q{Code file RSpec 2 matchers that make it easy to spec Ruby code files, fx updated or generated by a Thor generator}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/code-spec"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.19"
+    gem.add_dependency "require_all", ">= 1.1.0"
+    gem.add_dependency "activesupport", ">= 3.0.0.rc"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/code-spec.rb

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'require_all'      
+require 'active_support/inflector'      
+
+module RSpec
+  module RubyContentMatchers
+  end
+end
+
+require 'code_spec/matchers/content_matcher'
+require_all File.dirname(__FILE__) + '/code_spec/matchers'
+
+RSpec.configure do |config|
+  config.include(RSpec::RubyContentMatchers)  
+end

data/lib/code_spec/matchers/content_matcher.rb

@@ -0,0 +1,110 @@
+module RSpec
+  class RubyContentMatcher
+    attr_reader :content, :end_option, :alt_end, :content_matches
+
+    def initialize name
+      @end_option = name
+    end
+
+    def index
+      0
+    end
+
+    def indexes
+      nil
+    end
+
+    def debug?
+      false
+    end
+         
+    def matches? content, &block
+      @content = content
+      match = is_match? content                                                        
+      content_to_yield = if indexes
+        content_matches[indexes.first] || content_matches[indexes.last]
+      else
+        content_matches[index]
+      end          
+      handle_result(content_to_yield, match, &block)
+    end
+
+    def is_match? content
+      expr = get_expr(content) 
+      debug "match expression: #{expr}"
+      match = (content =~ expr)
+      @content_matches = [$1, $2, $3]
+      match
+    end
+
+    def handle_result content, match, &block 
+      if block && match && content
+        ruby_content = content.strip
+        yield ruby_content        
+      end
+      match
+    end      
+
+    def get_expr content
+      expr = /#{main_expr}#{comment_end}/m            
+      if (content =~ expr).nil?                             
+        /#{main_expr}#{end_expr}/m  
+      else
+        expr  
+      end        
+    end
+
+    Q_ANY_GROUP = '(.*?)'
+    ANY_GROUP = '(.*)'
+        
+    SPACES = '\s+'
+    OPT_SPACES = '\s*'
+    LPAR = '(\()'
+    RPAR = '(\))'  
+    OPT_ARGS = '(\(.+\))?'
+
+    def opt expr
+      "#{expr}?"
+    end
+
+    def args_msg
+      args ? " with arguments #{args}" : ''
+    end      
+
+    def any_args_expr
+      OPT_SPACES + OPT_ARGS
+    end
+
+    def args_expr
+      args ? OPT_SPACES + opt(LPAR) + OPT_SPACES + "#{args}" + OPT_SPACES + opt(RPAR) : ''
+    end
+
+    def main_expr
+      raise "Must override main_expr"
+    end
+
+    def end_expr
+      "$"
+    end
+
+    def comment_end 
+      alt_end != nil ? '#' + SPACES + "(#{end_option}|#{alt_end})" : '#' + SPACES + "#{end_option}"
+    end
+    
+    def failure_message
+      debug_content
+    end
+
+    def negative_failure_message
+      debug_content
+    end
+      
+    def debug_content
+      debug "Content: #{content}"
+    end
+    
+    def debug msg
+      puts msg if debug?
+    end      
+  end
+end

data/lib/code_spec/matchers/have_block.rb

@@ -0,0 +1,57 @@
+module RSpec::RubyContentMatchers
+  class HaveBlock < RSpec::RubyContentMatcher
+    attr_reader :name, :args, :block_args, :do_option, :end_option
+
+    def initialize(name, options={})
+      super options[:end] || name      
+      @name = name.to_s
+      @args = options[:args] 
+      @do_option = options[:do].nil? ? true : options[:do]      
+      @block_args = options[:block_args]
+    end
+  
+    def failure_message   
+      super
+      return "Expected there to be a block #{name}#{args_msg}#{block_args_msg}, but there wasn't"
+    end 
+    
+    def negative_failure_message  
+      super
+      return "Did not expect there to be a block #{name}#{args_msg}, but there was"
+    end               
+    
+    protected
+
+    def block_args_msg
+      " and block arguments #{block_args}" if block_args
+    end
+    
+    def indexes
+      [0, 2]
+    end
+
+    def main_expr
+      "#{name}" + SPACES + "#{args_expr}#{do_expr}" + ANY_GROUP
+    end
+
+    def do_expr
+      do_option == false ? '' : 'do' + SPACES + "#{block_args_expr}"
+    end
+
+    def args_expr
+      args ? '(\()?\s*' + args + '\s*(\))?\s+' : ''
+    end      
+
+    def block_args_expr
+      block_args ? '\|\s*' + block_args + '\s*\|' : ''
+    end    
+
+    def alt_end
+      'do'
+    end
+  end
+  
+  def have_block(name, options={})
+    HaveBlock.new(name, options)
+  end
+end

data/lib/code_spec/matchers/have_call.rb

@@ -0,0 +1,62 @@
+# This method tries to see if a specific method is contained in the generated file.
+# It can operate (should) on either a file name or the raw content 
+#
+#   generated_file_name.should have_method "hello" # 'my/path/say_hello.rb'.should have_method "hello"
+#
+#   say_hello_file_content.should have_method "hello"
+#
+module RSpec::RubyContentMatchers
+  class HaveCall < RSpec::RubyContentMatcher
+    attr_reader :method, :args, :dot
+
+    def initialize(method, options = {})
+      @method = method.to_s
+      @args = options[:args] || options if !options.kind_of? Hash
+      @dot = options[:dot]
+    end
+
+    def matches?(content)
+      @content = content                        
+      has_def = (content =~ /def(.*)#{method}/)
+      expr = if has_def
+        /#{dot_expr}#{method}#{args_expr}/m        
+      else
+        /#{dot_expr}?#{method}#{args_expr}/m
+      end   
+      debug "expr = #{expr}"
+      debug "content = %{#{content}}"
+      debug "content =~ #{expr}"      
+      (content =~ expr)
+    end          
+  
+    def failure_message
+      super
+      "Expected there to be a call to #{method}#{args_msg}, but there wasn't"
+    end 
+    
+    def negative_failure_message
+      super
+      "Did not expect there to be a call to #{method}#{args_msg}, but there was"
+    end
+             
+    protected
+
+    def not_def
+      '[^def\s]'
+    end
+
+    def dot_expr
+      return Regexp.escape(dot) if dot.kind_of?(String)
+      dot == true ? "#{not_def}\." : not_def
+    end
+                   
+  end
+  
+  def have_call(method, options = {})
+    HaveCall.new(method, options)
+  end  
+
+  def have_dot_call(method, options = {})
+    HaveCall.new(method, options.merge(:dot => true))
+  end  
+end

data/lib/code_spec/matchers/have_calls.rb

@@ -0,0 +1,60 @@
+module RSpec::RubyContentMatchers
+  class HaveCalls < HaveCall
+    attr_reader :calls, :method, :args
+
+    def initialize(*calls)
+      case calls.first
+      when Array, Hash
+        @calls = calls.first
+      else    
+        @calls = calls
+      end
+    end
+
+    def matches?(content)
+      super
+      case calls
+      when Array
+        do_list
+      when Hash
+        do_hash
+      end
+    end                              
+    
+    protected
+
+    def do_list
+      calls.each do |method|
+        @method = method.to_s   
+        expr = 
+        has_def = (content =~ /def(.*)#{method}/)
+        expr = if has_def
+          /#{not_def}\s*#{method}/m
+        else
+          /#{not_def}?\s*#{method}/m
+        end
+        return false if (content =~ expr) == nil
+      end
+      true
+    end    
+
+    def do_hash
+      calls.each_pair do |method, args|
+        @method = method.to_s
+        @args = args
+        has_def = (content =~ /def(.*)#{method}/)
+        expr = if has_def
+          /#{not_def}\s*#{method}\s*#{args_expr}/m
+        else
+          /#{not_def}?\s*#{method}\s*#{args_expr}/m
+        end         
+        return false if (content =~ expr) == nil
+      end
+      true
+    end    
+  end
+  
+  def have_calls(*calls)
+    HaveCalls.new(*calls)
+  end  
+end

data/lib/code_spec/matchers/have_class_self.rb

@@ -0,0 +1,40 @@
+# This method tries to see if a specific method is contained in the generated file.
+# It can operate (should) on either a file name or the raw content 
+#
+#   generated_file_name.should have_method "hello" # 'my/path/say_hello.rb'.should have_method "hello"
+#
+#   say_hello_file_content.should have_method "hello"
+#
+module RSpec::RubyContentMatchers
+  class HaveClassSelf < RSpec::RubyContentMatcher
+
+    def initialize
+      @end_option = 'class'
+    end
+  
+    def failure_message
+      super
+      return "Expected there to be a: class << self"
+    end 
+    
+    def negative_failure_message
+      super
+      "Did not expect there to be a: class << self"
+    end
+
+    protected
+    
+    def main_expr
+      'class\s*<<\s*self' + ANY_GROUP
+    end
+
+    def alt_end
+      'class self'
+    end             
+  end
+
+  def have_class_self
+    HaveClassSelf.new
+  end
+  
+end

data/lib/code_spec/matchers/have_comment.rb

@@ -0,0 +1,42 @@
+# This method tries to see if a specific method is contained in the generated file.
+# It can operate (should) on either a file name or the raw content 
+#
+#   generated_file_name.should have_method "hello" # 'my/path/say_hello.rb'.should have_method "hello"
+#
+#   say_hello_file_content.should have_method "hello"
+#
+module RSpec::RubyContentMatchers
+  class HaveComment < RSpec::RubyContentMatcher
+    attr_accessor :comment
+
+    def initialize comment
+      @comment = comment
+    end
+
+    def matches?(content)
+      @content = content                        
+      (content =~ /#{main_expr}/)
+    end
+  
+    def failure_message
+      super
+      "Expected there to be the comment '# #{comment}'" 
+    end 
+    
+    def negative_failure_message
+      super
+      "Did not expect there to be the comment '# #{comment}'" 
+    end
+
+    protected
+    
+    def main_expr
+      '\s*#\s*' + "#{comment}"
+    end
+  end
+
+  def have_comment comment
+    HaveComment.new comment
+  end
+  
+end

data/lib/code_spec/matchers/have_method.rb

@@ -0,0 +1,66 @@
+# This method tries to see if a specific method is contained in the generated file.
+# It can operate (should) on either a file name or the raw content 
+#
+#   generated_file_name.should have_method "hello" # 'my/path/say_hello.rb'.should have_method "hello"
+#
+#   say_hello_file_content.should have_method "hello"
+#
+module RSpec::RubyContentMatchers
+  class HaveMethod < RSpec::RubyContentMatcher
+    attr_reader :method, :type, :args
+
+    def initialize(method, type=nil, options = {})
+      @method = method.to_s
+      super method
+      @type = type      
+      @args = options[:args]
+    end
+
+    def index
+      1
+    end          
+  
+    def failure_message
+      super
+      "Expected there to be the #{class_msg} method #{method}, but there wasn't"
+    end 
+    
+    def negative_failure_message                                      
+      super
+      "Did not expect there to be the #{class_msg} method #{method}, but there was"
+    end
+
+    protected
+
+    def class_msg
+      (type == :class) ? 'class' : ''
+    end
+
+    def main_expr
+      'def' + SPACES + "#{self_expr}#{method}#{args_expr}" + ANY_GROUP
+    end
+
+    def args_expr
+      return super if args
+      any_args_expr
+    end
+       
+    def self_expr 
+      type == :class ? 'self.' : ''
+    end
+            
+    def alt_end
+      'def'
+    end               
+    
+  end
+  
+  def have_method(method, type = nil)
+    HaveMethod.new(method, type)
+  end  
+
+  def have_args_method(method, options = {})
+    HaveMethod.new(method, options[:type], options)
+  end  
+
+end

data/lib/code_spec/matchers/have_module.rb

@@ -0,0 +1,50 @@
+module RSpec::RubyContentMatchers
+  class HaveModule < RSpec::RubyContentMatcher
+    attr_reader :name, :type, :postfix
+
+    def initialize(name, postfix=nil)
+      @name = name.to_s.camelize
+      super @name
+      @postfix = postfix.to_s.camelize if postfix
+      @type = :module
+    end
+  
+    def failure_message
+      super
+      "Expected there to be the #{type} #{name}"
+    end 
+    
+    def negative_failure_message
+      super
+      "Did not expected there to be the #{type} #{name}"
+    end
+
+    protected
+    
+    def main_expr
+      "#{type}" + SPACES + "#{name}#{postfix}" + SPACES + ANY_GROUP
+    end
+    
+    def alt_end
+      type
+    end
+  end
+
+  class HaveClass < HaveModule
+
+    def initialize(name, postfix) 
+      super name, postfix
+      @type = :class
+    end    
+  end
+  
+  def have_module(module_name, postfix=nil)
+    HaveModule.new(module_name, postfix)
+  end       
+  alias_method :be_module, :have_module  
+  
+  def have_class(klass, postfix = nil)
+    HaveClass.new(klass, postfix)
+  end    
+  alias_method :be_class, :have_class  
+end  

data/lib/code_spec/matchers/have_region.rb

@@ -0,0 +1,48 @@
+module RSpec::RubyContentMatchers
+  class HaveRegion < RSpec::RubyContentMatcher
+    attr_reader :region
+
+    def initialize(region)
+      @region = region.to_s
+      super @region      
+    end
+  
+    def failure_message 
+      super
+      "Expected there to be a #{region} region"
+    end 
+    
+    def negative_failure_message    
+      super
+      "Did no expected there to be a #{region} region"
+    end               
+    
+    protected
+
+    def main_expr
+      "#{region}" + ANY_GROUP     
+    end
+    
+    def end_expr
+      '(private|protected|public|$)'
+    end
+  end
+
+  def have_region name
+    HaveRegion.new name
+  end    
+  
+  def have_public
+    HaveRegion.new :public
+  end    
+
+  def have_protected
+    HaveRegion.new :protected
+  end    
+
+  def have_private
+    HaveRegion.new :private
+  end    
+end
+      
+