rspec-english 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7002859a5f733bdd08c4319c7adeb21a158694a1
+  data.tar.gz: 824d6ffa35c6a37903e6b15172ebbf4d87dafd60
+SHA512:
+  metadata.gz: d16df6942437d70d62a0475ebf87f9c9afb7b57c2fa9ffdc675038bb26e186d61210dc54471f7c198ef2938b87bf4103a94600c40f255d71066696c2377c924c
+  data.tar.gz: 39709c7528ff68184c24043b187e590e6c46fdd764441353522b55eb2dad7efa19c4b6b90c60972eb8b24d614d40253ebcd0c6929a796ec3be65ece8822327bb

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Matthew Lanigan <rintaun@gmail.com>
+
+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,43 @@
+# rspec-english
+Better English for RSpec descriptions
+
+## Description
+rspec-english aims to modify how RSpec builds descriptions of specs/tests in
+order to make them read like more natural English.
+
+Specifically, `context` example groupings are modified to be placed _after_
+the test description in the full description output, such that the following
+code would read "RSpec outputs real English when rspec-english is available":
+
+```ruby
+describe RSpec do
+    context 'when rspec-english is available' do
+        it 'outputs real English' do
+            RSpec.english.should be_true
+            end
+        end
+    end
+end
+```
+
+## Motivation
+RSpec `context` groups are usually adverbial clauses, e.g. 'with ...' or 'when
+...'. Following RSpec's standard description generation, these are placed
+directly after the subject of the sentence (i.e. the description of the
+preceeding `describe` groups). However, in standard English, these clauses are
+nearly always placed either at the *beginning* of the sentence, if emphasis is
+desired, or, more commonly, at the *end* of the sentence.
+
+## Known Defects
+1. Currently `describe` blocks nested within a `context` are still placed
+   before the test description. I have not yet decided if this is desirable or
+   not.
+2. It is possible for some nested contexts to come out still reading as
+   less-than-standard English. They are normally ordered as _manner_, _place_,
+   and then _time_, but the string will be generated in order of nesting, not
+   in their natural English order.
+
+## Future
+I would like to rewrite this so that it takes into account a rudimentary model
+of a normal English sentence, in order to fix defect 2, above. Other
+suggestions are, of course, welcome.

data/lib/rspec-english.rb

@@ -0,0 +1,49 @@
+require 'rspec/core/example_group'
+require 'rspec/core/metadata'
+require 'rspec/core/formatters/progress_formatter'
+module ::RSpec
+    def english; true end
+    module Core
+        class ExampleGroup
+            def self.context(*args, &example_group_block)
+                o = self.describe *args, &example_group_block
+                o.metadata[:example_group][:type] = :context
+                o
+            end
+        end
+        class Metadata < Hash
+            module GroupMetadataHash
+                def full_description
+                    desc_parts = container_stack.reverse.collect { |a|
+                        this_part = a[:description_args]
+                        this_part = this_part.join(' ')
+                        if a[:type] == :context
+                            def this_part.after?; end
+                        end
+                        this_part
+                    }
+                end
+            end
+            module MetadataHash
+                def build_description_from(context, *parts)
+                    front = []
+                    if context.is_a?(Array)
+                        context.each do |this_part|
+                            if this_part.respond_to? :after?
+                                parts.push this_part
+                            else
+                                front.push this_part
+                            end
+                        end
+                    else
+                        parts.unshift context
+                    end
+                    front.reverse.each do |part|
+                        parts.unshift part
+                    end
+                    parts.join(' ')
+                end
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: rspec-english
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Lanigan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.1
+description: |2
+          Modifies RSpec's description generator to produce more
+          natural-sounding English.
+email: rintaun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/rspec-english.rb
+- LICENSE
+- README.md
+homepage: https://github.com/rintaun/rspec-english
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Better English for RSpec descriptions
+test_files: []