rspec-describe-method 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c980b97a7478ddfcb65daa147868a55c727f94ac
+  data.tar.gz: 86c7873513701191f6cf31d60de61936ebd465c2
+SHA512:
+  metadata.gz: 65255b454f71f07e1dbbd9247fcafe65ea5aee696007cbfa1eb3833ed8c885941b4719f4b6db87241122c278477bb4a2b6b18c724a8b27573a544b8ead1d09bf
+  data.tar.gz: f62d7c8733b0ffe12eb0a3969371e21a83c894ca4c1d34f125c680473c799492b3b9a0ca4d82bd2da4a47819313184382040de5e6c8b85ad9777146c73459465

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+
+guard 'bundler' do
+	watch 'Gemfile'
+	watch /^.+\.gemspec/
+end
+
+
+guard :rspec do
+	watch %r{^spec/.+_spec\.rb$}
+	watch( %r{^lib/.+\.rb$} ){ 'spec' }
+	watch( 'spec/spec_helper.rb' ){ 'spec' }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011, 2012, 2013 by Brett Richardson
+
+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,74 @@
+[![Build Status](https://travis-ci.org/brett-richardson/rspec-describe-method.png?branch=master)](https://travis-ci.org/brett-richardson/rspec-describe-method)
+
+Using Rspec DescribeMethod
+==========================
+
+Using Rspec DescribeMethod is super simple.
+
+
+In your Gemfile:
+```ruby
+group :development, :testing do
+  gem 'rspec-describe-method'
+end
+```
+
+
+In your spec_helper.rb:
+```ruby
+require 'rspec/describe-method'
+```
+
+And your specs can look like this:
+
+```ruby
+describe String do
+    describe_method '.new' do
+        it{ should be_a String }
+    end
+
+    describe_method '#concat', 'argument' do
+        it{ should match /argument/i }
+    end
+
+    context 'with an instance' do
+        subject{ String.new 'test' }
+
+        describe_method '#upcase' do
+            it{ should eq 'TEST' }
+        end
+    end
+end
+```
+
+
+Describe a method call on the current test `subject` in your specs with 'describe_method', and a `#` for instance methods and a `.` for class methods.
+
+Instances will automatically delagate to their class, and classes will automatically create an instance of themselves.
+
+
+Alias method: when_calling
+--------------------------
+
+The alias method `when_calling` is provided which makes specs more human-readable, especially when calls are nested within eachother:
+
+
+```ruby
+describe String do
+    subject{ String.new 'test' }
+
+    when_calling '#upcase' {
+        it{ should eq 'TEST' }
+
+        when_calling '#+', 'ING' {
+            it{ should eq 'TESTING' }
+        }
+    }
+end
+```
+
+
+NOTE
+----
+When the subject is a Class, and you call an instance method `describe_method "#something"`
+the class will call `.new` on itself with __NO ARGUMENTS__, you may not want this behavior.

data/lib/rspec/describe_method.rb

@@ -0,0 +1,8 @@
+module RSpec
+  module DescribeMethod
+  end
+end
+
+require 'rspec/describe_method/version'
+require 'rspec/describe_method/class_extensions'
+require 'rspec/describe_method/configure'

data/lib/rspec/describe_method/class_extensions.rb

@@ -0,0 +1,30 @@
+module RSpec
+  module DescribeMethod
+    module ClassExtensions
+
+      def describe_method( method, *args, &block )
+        throw ArgumentError.new 'Supplied method must be a String'      unless method.kind_of? String
+        throw ArgumentError.new 'No block supplied to .describe_method' unless block.kind_of? Proc
+
+        describe "when calling #{method}" do
+          subject do
+            old = super()
+
+            case method[0]
+            when '#' # Instance method ---
+              if old.kind_of? Class then old.new else old       end
+            when '.' # Class method ---
+              if old.kind_of? Class then old     else old.class end
+            else # Method type not recognized ---
+              throw ArgumentError.new 'describe_method expects method name to begin with # or .'
+            end.send method[1..-1], *args
+          end
+
+          instance_eval &block
+        end
+      end
+      alias_method :when_calling, :describe_method
+
+    end
+  end
+end

data/lib/rspec/describe_method/version.rb

@@ -0,0 +1,13 @@
+module RSpec
+	module DescribeMethod
+
+		VERSION_NUMBERS = [
+			VERSION_MAJOR = 0,
+			VERSION_MINOR = 0,
+			VERSION_BUILD = 1
+		]
+
+		VERSION = VERSION_NUMBERS.join '.'
+
+	end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rspec-describe-method
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brett Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Adds a #describe_method method for use within RSpecs, which set the
+  test subject to the defined method'
+email:
+- Brett.Richardson.NZ@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec/describe_method/class_extensions.rb
+- lib/rspec/describe_method/version.rb
+- lib/rspec/describe_method.rb
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+homepage: http://www.dablweb.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Tersely describe methods on Ruby objects in your RSpecs
+test_files: []