gendarme 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+*.swp
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@gendarme

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Franck Verrot
+
+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,63 @@
+# Gendarme
+
+## Introductio
+
+Gendarme will bring order to chaos (well... that's the role of Gendarme ma bonne Dame...).
+Gendarme checks for preconditions and postrelations on the methods you want it to monitor.
+
+It does not replace a regular test framework (Rspec, Test::Unit,
+you-name-it), it all started when I have been asked how to replicate an
+annotation system with Ruby. This is more or less how I would implement
+it in real life (but I highly doubt I would ever want to do that).
+
+## Usage
+
+Put this in your Gemfile:
+
+    gem install gendarme
+
+Once Gendarme is installed, add it to your classes:
+
+    # Eventually configure where you want the messages to be displayed
+    Gendarme::Configuration.logger = $stderr # Standard error
+
+    class Foo
+      include Gendarme::Gendarme # Add Gendarme's method to your class
+
+      precondition(0,"Argument 0 is a String") { |bar| bar.respond_to?(:to_str) }
+      precondition(1,"Argument 1 is 10")       { |baz| baz == 10 }
+      postrelation(0,"Result is an Integer")   { |res| res.is_a?(Integer)}
+      def foo(bar,baz)
+        ...
+        "not an integer"
+      end
+    end
+
+    # Now let's try it, neither the inputs nor the output are valid
+    Foo.new.foo(42, "hello")
+    => "not an integer"
+
+   # You should see this in the standard error output
+     This precondition is false: Argument 0 is a String
+     This precondition is false: Argument 1 is 10
+     This postrelation is false: Result is an Integer
+
+##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.
+
+
+Contributors
+------------
+* Franck Verrot
+
+Copyright
+---------
+
+Copyright (c) 2010 Franck Verrot. MIT LICENSE. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("../lib", __FILE__)
+
+require 'rubygems'
+require 'rubygems/specification'
+require 'gendarme'
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run specs"
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(-fs --color)
+    t.ruby_opts  = %w(-w)
+  end
+
+rescue LoadError
+  task :spec do
+    abort "Run `gem install rspec` to be able to run specs"
+  end
+end
+
+task :default => :spec

data/gendarme.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gendarme/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gendarme"
+  s.version     = Gendarme::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Franck Verrot"]
+  s.email       = ["franck@verrot.fr"]
+  s.homepage    = "https://github.com/cesario/gendarme"
+  #0 Gendarmes have been during the implementation of that gem, I promise
+  s.summary     = %q{Gendarme will bring order to chaos (well... that's the role of Gendarme ma bonne Dame...)}
+  s.description = %q{Gendarme checks for preconditions and postrelations on the methods you want it to.}
+
+  s.rubyforge_project = "gendarme"
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'i18n'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-core'
+  s.add_development_dependency 'rspec-expectations'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/gendarme.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+module Gendarme
+	extend ActiveSupport::Concern
+	autoload :Configuration, 'gendarme/configuration'
+	autoload :Gendarme     , 'gendarme/gendarme'
+	end
+

data/lib/gendarme/configuration.rb

@@ -0,0 +1,13 @@
+module Gendarme
+	class Configuration
+		class << self
+			attr_accessor :log_stream
+			def logger=(log)
+				self.log_stream = log
+			end
+			def logger
+				self.log_stream
+			end
+		end
+	end
+end

data/lib/gendarme/gendarme.rb

@@ -0,0 +1,75 @@
+module Gendarme
+  module Gendarme
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr_accessor :metadata
+      def apply_gendarme_rules(m)
+        class_eval do
+          alias :"original_#{m}" :"#{m}"
+          define_method :"process_preconditions_on_#{m}" do |*args|
+            preconditions = self.class.metadata[m][:preconditions]
+            method = self.class.instance_method(m)
+            preconditions.each_pair do |parameter_position, precondition|
+              Configuration.logger.puts "Won't validate a nil parameter##{parameter_position}" if args[parameter_position].nil?
+              unless precondition[:block].call(args[parameter_position])
+                Configuration.logger.puts "This precondition is false: #{precondition[:message]}"
+              end
+            end
+          end
+
+          define_method :"process_postrelations_on_#{m}" do |result|
+            postrelations = self.class.metadata[m][:postrelations]
+            postrelations.each_pair do |assertion_number, postrelation|
+              expected_assertion = postrelation[:block].call(result)
+              unless expected_assertion
+                Configuration.logger.puts "This postrelation is false: #{postrelation[:message]}"
+              end
+            end if postrelations
+
+            result
+          end
+
+          define_method(m) do |*args|
+            send(:"process_preconditions_on_#{m}", *args)
+            result = send(:"original_#{m}", *args)
+            send(:"process_postrelations_on_#{m}", result)
+          end
+        end
+        #end
+      end
+
+      def clear_metadata
+        @__current_preconditions = @__current_postrelations = nil
+      end
+
+      def precondition(parameter, message, &block)
+        @__current_preconditions ||= {}
+        @__current_preconditions[parameter] = { :message => message, :block => block }
+      end
+
+      def postrelation(parameter, message, &block)
+        @__current_postrelations ||= {}
+        @__current_postrelations[parameter]= { :message => message, :block => block }
+
+      end
+
+      def method_added(m)
+        @already_processed ||= []
+
+        return if /^(original_|process_)/ =~ m or @already_processed.include?(m)
+
+        @already_processed << m
+        @__last_method = m
+
+        self.metadata ||= {}
+        self.metadata[@__last_method] = {
+          :preconditions => @__current_preconditions,
+          :postrelations => @__current_postrelations
+        }
+        clear_metadata
+        apply_gendarme_rules(m)
+      end
+    end
+  end
+end

data/lib/gendarme/version.rb

@@ -0,0 +1,3 @@
+module Gendarme
+  VERSION = "0.0.1"
+end

data/spec/gendarme_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+class Foo
+	include Gendarme::Gendarme
+
+	#Should be OK
+	precondition(0,"Bar responds to :to_i")   { |bar|    bar.respond_to? :to_i  }
+	#Should not be OK
+	precondition(0,"Bar responds to :to_str") { |bar|    bar.respond_to? :to_str  }
+	#Should be OK
+	postrelation(0,"Result is an integer")    { |result| result.is_a?(Integer) }
+	#Should not be OK
+	postrelation(0,"Result is a string")      { |result| result.is_a?(String) }
+	def foo(bar)
+		bar * 2
+	end
+end
+
+describe "Gendarme" do
+	describe "should print to stderr" do
+		before(:each) do
+			Gendarme::Configuration.logger = $stderr
+		end
+
+		it "on failed preconditons and failed preconditions" do
+			output = capture(:stdout,:stderr) do
+				Foo.new.foo(2)
+			end
+			output.should == /failed/
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+require 'gendarme'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb' ))].each {|f| require f}
+			
+RSpec.configure do |rspec_config|
+end

data/spec/support/capture.rb

@@ -0,0 +1,13 @@
+require 'stringio'
+def capture(*streams)
+	streams.map! { |stream| stream.to_s }
+	begin
+		result = StringIO.new
+		streams.each { |stream| eval "$#{stream} = result" }
+		yield
+	ensure
+		streams.each { |stream| eval("$#{stream} = #{stream.upcase}") }
+	end
+	result.string
+end
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: gendarme
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Franck Verrot
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec-expectations
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Gendarme checks for preconditions and postrelations on the methods you want it to.
+email: 
+- franck@verrot.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gendarme.gemspec
+- lib/gendarme.rb
+- lib/gendarme/configuration.rb
+- lib/gendarme/gendarme.rb
+- lib/gendarme/version.rb
+- spec/gendarme_spec.rb
+- spec/spec_helper.rb
+- spec/support/capture.rb
+has_rdoc: true
+homepage: https://github.com/cesario/gendarme
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: gendarme
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Gendarme will bring order to chaos (well... that's the role of Gendarme ma bonne Dame...)
+test_files: 
+- spec/gendarme_spec.rb
+- spec/spec_helper.rb
+- spec/support/capture.rb