rspec-english 0.0.1 → 0.0.2

data/README.md

@@ -11,18 +11,17 @@ code would read "RSpec outputs real English when rspec-english is available":
 
 ```ruby
 describe RSpec do
-    context 'when rspec-english is available' 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
+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
@@ -37,7 +36,20 @@ desired, or, more commonly, at the *end* of the sentence.
    and then _time_, but the string will be generated in order of nesting, not
    in their natural English order.
 
+## Compatibility
+I've only tested this with rspec-core 2.13.1, but I see no reason why it
+wouldn't work with earlier versions as well. I've set a runtime dependency for
+`~> 2.13.1`, but I'd be glad to update it if you let me know an earlier
+version works.
+
 ## 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.
+suggestions are, of course, welcome. One benefit of doing it this way is that
+it will obsolete the modification to `RSpec::Core.context` and will slim down
+some of the other modifications a bit.
+
+In addition, I would like to eventually modify descriptions and join them with
+conjunctions where possible, e.g. turning "when one thing when another thing"
+into something more readable like "when one thing and another thing." Ideally,
+this can be done without requiring any modification to tests.

data/lib/rspec-english.rb

@@ -14,34 +14,24 @@ module ::RSpec
         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
-                    }
+                    front = []
+                    back = []
+                    container_stack.reverse.each do |part|
+                        target = part[:type] == :context ? back : front
+                        target.push part[:description_args]
+                    end
+                    [front, back].map {|s| [do_build_description(*s.flatten)] }
                 end
             end
             module MetadataHash
+                alias_method :do_build_description, :build_description_from
+
                 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(' ')
+                    context = [[context], [""]] unless context.is_a? Array
+                    front, back = context
+                    parts = front + parts + back
+                    parts.delete_if(&:empty?)
+                    do_build_description parts.shift, *parts
                 end
             end
         end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: rspec-english
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Matthew Lanigan
@@ -13,6 +14,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,13 +22,13 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.1
-description: |2
-          Modifies RSpec's description generator to produce more
-          natural-sounding English.
+description: ! "        Modifies RSpec's description generator to produce more\n        natural-sounding
+  English.\n"
 email: rintaun@gmail.com
 executables: []
 extensions: []
@@ -39,26 +41,27 @@ files:
 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
+  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: 2.0.0.rc.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Better English for RSpec descriptions
 test_files: []

checksums.yaml

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