respectable 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9573aa714bfb9221aa80b0632f9547861aaf776d
-  data.tar.gz: 2141a67cdce9d1fd0411b6ef4d001c951edeea79
+  metadata.gz: b3c0bcc9e014d61f695000c265275561c737bf59
+  data.tar.gz: ef138f804d1cc905ef53f143d302f221c7a464fd
 SHA512:
-  metadata.gz: e586552b082fe3f98b57fb3530acd17a8187f612de7f286119796d5a938a1a52cf6eb1d314674db3c5bad73dc6a9d1dc13e5039b3336a17caddcbf13a759661d
-  data.tar.gz: ed908a57599cb0aa8b9e71358da923d6a585eb303f8355b55c35e69541dc7946dea41e112743936060f7d21e58be27e2e9787b4260702719081efd1a4bf9111b
+  metadata.gz: c0cfc6d9d96d0d983c2bfa203a82275137ce6d2e0cd0858167a2a1fa3b9e7043a6faaab2d274f67e4083849725034098c34937f162fbcd8605c8a8f5811d920a
+  data.tar.gz: 9f4f27dc30d5efc6893f9a507cd6939067e20c3d4fcb71c36e7e1f00e39f13fc17045a27a60876e5363c44b9e5f19189e4a55b352d468ef0abc1500081811460

data/.gitlab-ci.yml

@@ -1,8 +1,18 @@
-image: ruby:2.3
-
-spec:
+.spec: &spec
   tags:
     - docker
   script:
     - bundle install --path vendor --without production --jobs $(nproc) > /dev/null
-    - bin/rspec
+    - bin/rspec
+
+spec2.0:
+  image: ruby:2.0
+  <<: *spec
+
+spec2.1:
+  image: ruby:2.1
+  <<: *spec
+
+spec2.3:
+  image: ruby:2.3
+  <<: *spec

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+## unreleased
+
+### Fixed/Added/Deprecated/Removed
+
+ * ...
+
+## 0.3.0 / 2016-10-26
+
+### Added
+
+ * `specify_each` replaces `each_row`
+ * **BREAKING**: the block you pass to `specify_each` will be wrapped in an it-block.
+ 
+    This means that an error will occur if your block contains an it-block **or** specify_each is wrapped in an it-block (i.e. in all cases ;).  
+    Solution: remove any it-block surrounding or contained in the specify_each-block.
+
+ * Have a default description
+ 
+    The format is `first: "Foo", last: "Bar" yields "Foo Bar"`.  
+    Customize this by passing `desc: "full_name(%{first}, %{last}) => %{result}"` to `specify_each`
+
+### Deprecated
+
+ * `each_row`. Use `specify_each` instead.

data/README.md

@@ -11,19 +11,19 @@ So instead of:
 ```ruby
 describe '#full_name' do
   it 'concats first and last' do
-    expect(build(:user, first: 'Foo', last: 'Bar').full_name).to eq 'Foo Bar'
+    expect(User.new(first: 'Foo', last: 'Bar').full_name).to eq 'Foo Bar'
   end
 
   it 'does smart casing stuff' do
-    expect(build(:user, first: 'Foo', last: 'Van Bar').full_name).to eq 'Foo van Bar'
+    expect(User.new(first: 'Foo', last: 'Van Bar').full_name).to eq 'Foo van Bar'
   end
 
   it 'handles last being nil' do
-    expect(build(:user, first: 'First', last: nil).full_name).to eq 'Foo'
+    expect(User.new(first: 'First', last: nil).full_name).to eq 'Foo'
   end
 
   it 'handles first being nil' do
-    expect(build(:user, first: nil, last: 'Bar').full_name).to eq 'Bar'
+    expect(User.new(first: nil, last: 'Bar').full_name).to eq 'Bar'
   end
 end
 ```
@@ -32,23 +32,67 @@ end
 
 ```ruby
 describe '#full_name' do
-  it 'concats first and last' do
-    each_row(<<-TABLE) do |first, last, expected|
-      #| first | last    | expected    |
-       | Foo   | Bar     | Foo Bar     |
-       | Foo   | Van Bar | Foo van Bar |
-       | Foo   | `nil`   | Foo         |
-       | `nil` | Bar     | Bar         |
-      TABLE
-
-      expect(build(:user, first: first, last: last).full_name).to eq expected
-    end
+  specify_each(<<-TABLE) do |first, last, expected|
+    #| first | last    | expected    |
+     | Foo   | Bar     | Foo Bar     |
+     | Foo   | Van Bar | Foo van Bar |
+     | Foo   | `nil`   | Foo         |
+     | `nil` | Bar     | Bar         |
+    TABLE
+
+    expect(User.new(first: first, last: last).full_name).to eq expected
   end
 end
 ```
 
 You just got yourself a *table* in your *rspec*! (who told you naming was hard?)
 
+## Details
+
+### Literal values
+
+By default values from the table are passed to the block as stripped strings. For more expressiveness you can use backticks; this allows you to pass literal values (e.g. \`nil\`, \`:some_symbol\`, \`true\`, \`1 + 1\`) to the block.
+
+### Description
+
+For every row in the table an it-block is created. The description of this block will be of the format:  
+`column1-name: "cell-value", column2-name: "cell-value" yields "value of last column"`.  
+So for the full_name-example above the full RSpec-output (using `--format documentation`) is:  
+```
+#full_name
+  first: "Foo", last: "Bar" yields "Foo Bar"
+  first: "Foo", last: "Van Bar" yields "Foo van Bar"
+  first: "Foo", last: "`nil`" yields "Foo"
+  first: "`nil`", last: "Bar" yields "Bar"
+```
+
+You can customize the description by passing a template to `specify_each` in which you can use the block parameters, e.g.:  
+```ruby
+specify_each(<<-TABLE, desc: 'full_name(%{first}, %{last}) => %{expected}') do |first, last, expected|
+```
+
+If you want the standard RSpec-description you can pass `desc: nil` to `specify_each`.
+
+### Comments
+
+Just like in Ruby, you can comment (the remainder of) a line by using `#`. This helps to document the table:  
+```ruby
+specify_each(<<-TABLE) do |arg1, arg2, result|
+  # | arg1 (never negative) | arg2 | +  |
+    | 1                     |   2  | 3  |
+    | 10                    |   2  | 12 | # <= important edge-case
+TABLE
+  expect(...)
+end
+```
+
+### Various
+
+You can escape the pipe character (`|`) by prefixing it with `\\`:
+```
+| This table has one cell with a \\| |
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/respectable.rb

@@ -1,23 +1,56 @@
-require "respectable/version"
-require 'csv'
+require 'respectable/version'
 
 module Respectable
   def self.included(base)
-    base.extend Meat
+    base.extend Interface
     base.class_eval do
-      include Meat
+      include Interface
     end
   end
 
-  module Meat
-    def each_row(string, &block)
-      string.split(/\n */).reject {|line| line[/^ *#/] }.map do |line|
-        yield(*line.split(/ *(?<!\\)\| */)[1..-1].map do |i|
-          i = i.sub(/\\(?=|)/, '') # remove escapes for '|'
-          # handle `...`
-          r = i[/\A`([^`]+)`\z/, 1]
-          r ? eval(r) : i
-        end)
+  module Interface
+    def specify_each(table, **options, &block)
+      desc_template = options.has_key?(:desc) ? options[:desc] : Util.desc_template(block.parameters)
+
+      define_method(:specify_each) do |*, &block|
+        block.call(*@args) if @args
+      end
+
+      Util.table_data(table).each do |row|
+        # TODO: can we use raw row-value? (for outline)
+        desc_data = Hash[block.parameters.map(&:last).zip(row.map(&:inspect))]
+        description = desc_template % desc_data if desc_template
+        instance_eval(<<-IT, *block.source_location)
+          it(description) do
+            @args = Util.eval_row_items(row, binding)
+            eval(block.source, binding, *block.source_location)
+          end
+        IT
+      end
+    end
+  end
+
+  module Util
+    def self.desc_template(block_params)
+      *desc_args, desc_result = *block_params.map(&:last)
+      desc_args.map {|arg| "#{arg}: %{#{arg}}" }.join(', ') + " yields %{#{desc_result}}"
+    end
+
+    def self.table_data(table)
+      table.split(/\n */).reject {|line| line[/^ *#/] }.map do |line|
+        cols = line.split(/ *(?<!\\)\| */)[1..-1]
+        comment_col = cols.size
+        cols.each_with_index {|col, ix| comment_col = ix if col[/^ *#/] }
+        cols[0, comment_col]
+      end
+    end
+
+    def self.eval_row_items(row, binding)
+      row.map do |i|
+        i = i.sub(/\\(?=|)/, '') # remove escapes for '|'
+        # handle `...`
+        r = i[/\A`([^`]+)`\z/, 1]
+        r ? binding.eval(r) : i
       end
     end
   end

data/lib/respectable/version.rb

@@ -1,3 +1,3 @@
 module Respectable
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: respectable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-09 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - ".gitlab-ci.yml"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Scenario outlines for rspec