sixarm_ruby_defining 1.1.0

data/README.md

@@ -0,0 +1,97 @@
+# SixArm.com » Ruby » <br> Class#defining and #redefining metaprogramming methods
+
+* Docs: <http://sixarm.com/sixarm_ruby_defining/doc>
+* Repo: <http://github.com/sixarm/sixarm_ruby_defining>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+
+## Introduction
+
+Meta-programming method that you call when you are defining
+a class method, to detect if your class may be accidentally
+overriding an existing method.
+
+For docs go to <http://sixarm.com/sixarm_ruby_defining/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+
+## Quickstart
+
+Install:
+
+    gem install sixarm_ruby_defining
+
+Bundler:
+
+    gem "sixarm_ruby_defining", "=1.1.0"
+
+Require:
+
+    require "sixarm_ruby_defining"
+
+
+## Install with high security (optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_defining --test --trust-policy HighSecurity
+
+
+## Example
+
+    class MyClass
+
+      # raise an error if 'foo' is already a method
+      defining 'foo'
+
+      # raise an error if 'to_s' is NOT already a method
+      redefining 'to_s'
+
+      # you can check many names at once
+      defining 'foo', 'goo', 'hoo', 
+      redefining 'to_s', 'equal?', 'clone'
+
+    end
+
+
+## Changes
+
+* 2012-03-17 1.1.0 Upgrade for Ruby 1.9.3, minitest/spec, and improved docs.
+* 2011-10-08 1.0.6 Updates for gem publishing
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+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.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2005-2013 Joel Parker Henderson

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*.rb'
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.6

data/lib/sixarm_ruby_defining.rb

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+
+class Class
+
+  # To protect your code, call this just before you define a new method.
+  #
+  # ==Example
+  #   class MyClass
+  #     defining :foo
+  #     def foo
+  #       "hello world"
+  #     end
+  #   end
+  #
+  # See #redefining
+
+  def defining(*method_names)
+    [*method_names].each{|m|
+      !method_defined?(m) ? defining_success(m) : defining_failure(m)
+    }
+  end
+
+
+  # Called when #defining sees that you are creating a new method.
+  #
+  # This method is blank; you can override it if you want to provide
+  # features like logging, coverage analysis, reporting, etc.
+
+  def defining_success(method_name)
+  end
+
+
+  # Called when #defining sees that you are creating a method that already exists.
+  #
+  # This method raises an error with a diagnostic message.
+
+  def defining_failure(method_name)
+    raise "Class#defining expects '#{method_name}' to be a new method, but it already exists: #{self}##{method_name}"
+  end
+
+
+  # To protect your code, call this just before you redefine an existing method.
+  #
+  # ==Example
+  #   class MyClass
+  #     redefining :to_s
+  #     def to_s
+  #       "hello world"
+  #     end
+  #   end
+  #
+  # See #redefining
+
+  def redefining(*method_names)
+    [*method_names].each{|m|
+      method_defined?(m) ? redefining_success(m) : redefining_failure(m)
+    }
+  end
+
+
+  # Called when #redefining sees that you are overriding an existing method.
+  #
+  # This method is blank; you can override it if you want to provide
+  # features like logging, coverage analysis, reporting, etc.
+
+  def redefining_success(method_name)
+  end
+
+
+  # Called when #redefining sees that you are creating a method that doesn't exist.
+  #
+  # This method raises an error with a diagnostic message.
+
+  def redefining_failure(method_name)
+    raise "Class#redefining expects '#{method_name}' to be overriding an existing method, but it doesn't exist"
+  end
+
+
+end

data/test/sixarm_ruby_defining_test.rb

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+require 'sixarm_ruby_defining'
+
+class Testing < Test::Unit::TestCase
+
+ def test_defining_one_should_be_success
+  assert_nothing_raised do
+   eval "class C 
+      defining 'nonexistant'
+    end"
+  end
+ end
+
+ def test_defining_many_should_be_success
+  assert_nothing_raised do
+   eval "class C 
+      defining 'nonexistant', 'nonexistant2', 'nonexistant3'
+    end"
+  end
+ end
+
+ def test_defining_one_should_be_failure
+  assert_raise RuntimeError do
+   eval "class C
+     defining 'to_s'
+    end"
+  end
+ end
+
+
+ def test_defining_many_should_be_failure
+  assert_raise RuntimeError do
+   eval "class C
+     defining 'to_s', 'clone', 'equal?'
+    end"
+  end
+ end
+
+ def test_redefining_one_should_be_success
+  assert_nothing_raised do
+   eval "class C 
+      redefining 'to_s'
+    end"
+  end
+ end
+
+ def test_redefining_many_should_be_success
+  assert_nothing_raised do
+   eval "class C 
+      redefining 'to_s', 'clone', 'equal?'
+    end"
+  end
+ end
+
+ def test_redefining_one_should_be_failure
+  assert_raise RuntimeError do
+   eval "class C
+     redefining 'nonexistant'
+    end"
+  end
+ end
+
+ def test_redefining_many_should_be_failure
+  assert_raise RuntimeError do
+   eval "class C
+     redefining 'nonexistant1', 'nonexistant2', 'nonexistant3'
+    end"
+  end
+ end
+
+end
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_defining
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- SixArm
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQW0yZ0F3SUJB
+  Z0lKQUtQd0VFVFU1YkhvTUEwR0NTcUdTSWIzRFFFQkJRVUFNR0F4Q3pBSkJn
+  TlYKQkFZVEFsVlRNUk13RVFZRFZRUUlFd3BEWVd4cFptOXlibWxoTVJZd0ZB
+  WURWUVFIRXcxVFlXNGdSbkpoYm1OcApjMk52TVE4d0RRWURWUVFLRXdaVGFY
+  aEJjbTB4RXpBUkJnTlZCQU1UQ25OcGVHRnliUzVqYjIwd0hoY05NVEF4Ck1q
+  RXpNak15TnpFeldoY05NVE13T1RBNE1qTXlOekV6V2pCZ01Rc3dDUVlEVlFR
+  R0V3SlZVekVUTUJFR0ExVUUKQ0JNS1EyRnNhV1p2Y201cFlURVdNQlFHQTFV
+  RUJ4TU5VMkZ1SUVaeVlXNWphWE5qYnpFUE1BMEdBMVVFQ2hNRwpVMmw0UVhK
+  dE1STXdFUVlEVlFRREV3cHphWGhoY20wdVkyOXRNSUdmTUEwR0NTcUdTSWIz
+  RFFFQkFRVUFBNEdOCkFEQ0JpUUtCZ1FDOTRtRDlKRHdCc3Vuc09JMFZSM0NY
+  WGJPV2c5Y1dhV2Npd0Z5Sk5GaU03QTlJOEtQTGZYVXcKUUM0Y3pVZTVadUc0
+  V0h2aW5yV2hrckNLKzFkV0Jxb0VDbHhkRi9Gb0tPNWErdG9uR0Nqam1meTgx
+  Sm1Gamp5eAplVHNqc0h5dncrUWlrOWtwZjlhajYrcG5rTnJWc3dnTkhWZWEy
+  bzl5YWJiRWlTNlZTZUpXb1FJREFRQUJvNEhGCk1JSENNQjBHQTFVZERnUVdC
+  QlF6UEp0cW1TZ2M1M2VETjdhU3pEUXdyOVRBTERDQmtnWURWUjBqQklHS01J
+  R0gKZ0JRelBKdHFtU2djNTNlRE43YVN6RFF3cjlUQUxLRmtwR0l3WURFTE1B
+  a0dBMVVFQmhNQ1ZWTXhFekFSQmdOVgpCQWdUQ2tOaGJHbG1iM0p1YVdFeEZq
+  QVVCZ05WQkFjVERWTmhiaUJHY21GdVkybHpZMjh4RHpBTkJnTlZCQW9UCkJs
+  TnBlRUZ5YlRFVE1CRUdBMVVFQXhNS2MybDRZWEp0TG1OdmJZSUpBS1B3RUVU
+  VTViSG9NQXdHQTFVZEV3UUYKTUFNQkFmOHdEUVlKS29aSWh2Y05BUUVGQlFB
+  RGdZRUFvb0VleFAvb1BhbTFUUDcxU3l1aHhNYit1VHJaYlNRZQpqVkIrRXhS
+  d1dhZEd3YU5QVUE1NmQzOXF3YXZ3UCtpdSszSnBlb25OTVZ2YldYRjVuYUNY
+  L2RORkllUkVIekVSClpEUlFZTXFydTlURU1uYTZIRDl6cGNzdEY3dndUaEdv
+  dmxPUSszWTZwbFE0bk16aXBYY1o5VEhxczY1UElMMHEKZWFid3BDYkFvcG89
+  Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
+date: 2012-03-19 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: sixarm@sixarm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemtest
+- Rakefile
+- README.md
+- VERSION
+- lib/sixarm_ruby_defining.rb
+- test/sixarm_ruby_defining_test.rb
+homepage: http://sixarm.com/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: SixArm.com Ruby Class#defining and Class#redfining methods to detect if you're
+  creating a class method, or overriding
+test_files:
+- test/sixarm_ruby_defining_test.rb
+has_rdoc: true