kappamaki 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 960f9aaf3f5c2e884699282e0cda5b44b4026b0f
-  data.tar.gz: c35b41b43bf956587aba8e0099a064083c925db5
+  metadata.gz: 10ed7a3b93d835a5c218b8ef5580105f2f9fbe66
+  data.tar.gz: 5999f91ecf1e906886a602191f10e59d8604cf76
 SHA512:
-  metadata.gz: 5344d48ba377716604389d71312859a8a7391fc82989aa85f658a60edc960874199bf09e645b78f9424f668e92af3c05396368714feceb75192b13b51e43b6b6
-  data.tar.gz: 23dcd71028f962236686ee2042ee5cbeb4b97f742120654026ba3b7163d24d5bdc563b9cab3e6279766c351cc7868c3b076c052441d344a7006b14202694afe1
+  metadata.gz: 6c80afb2dc07f5aded681535d1f355682517016a6a0730f9a9bc79401cc3a7283a6135d55db7ea9c1b545df2c30b8fcda01f248ee315da7b73146bb3f347c1bf
+  data.tar.gz: 4174272fab1d6528bf87efb8fd970d309a5f893ed8f7b4a5b289b60164dfe305edad6ef3ef78975b4a83fe32b3080bc67880b8420e3e91a3f7299d559bcfb969

data/README.md

@@ -10,29 +10,92 @@ which adds naturalness and freshness to a meal.
 
 Kappamaki provides a number of helper methods that can be used directly
 in your Cucumber step definitions.
-It allows for Cucumber steps that look like this:
+
+### from_sentence
+
+Parses a list of values from a sentence.
+
+```cucumber
+Given the restaurant offers cucumber rolls, philadelphia rolls, and avocado rolls
+```
+
+Your step definition would look like this:
+
+```ruby
+Given /^the restaurant offers (.+)$/ do |menu_list|
+
+  # menu_list is this string:
+  'cucumber rolls, philadelphia rolls, and avocado rolls'
+
+  # Let's parse this into an array
+  menu = Kappamaki.from_sentence menu_list
+
+  # The result, menu, is this array:
+  ['cucumber rolls', 'philadelphia rolls', 'avocado rolls']
+
+  # Now we can set up our menu here...
+end
+```
+
+
+### attributes_from_sentence
+
+Parses key-value pairs from natural sentences.
 
 ```cucumber
-Given I have a dinner with starter: "miso soup" and entree: "sushi"
+When I order a dinner with starter: "miso soup" and entree: "cucumber rolls"
 ```
 
 Your step definition would look like this:
 
 ```ruby
-Given /^I have a dinner with (.+)$/ do |dinner_attributes|
+When /^I order a dinner with (.+)$/ do |order_items|
 
-  # dinner_attributes is this string:
-  'starter: "miso soup" and entree: "sushi"'
+  # order_items is this string:
+  'starter: "miso soup" and entree: "cucumber rolls"'
 
   # Let's parse that string using Kappamaki
-  dinner_data = Kappamaki.attributes_from_sentence(dinner_attributes)
+  order_data = Kappamaki.attributes_from_sentence(order_items)
 
-  # The result, dinner_data, is this hash:
+  # The result, order_data, is this hash:
   { starter: "miso soup",
-    entree: "sushi" }
+    entree: "cucumber rolls" }
+
+  # now we can set up our order...
+  create :order, order_data
+end
+```
+
+
+### symbolize_keys_deep
+
+Converts the keys of a hash into symbols.
+
+```cucumber
+Then I am served these items
+  | name          | count |
+  | miso soup     | 1     |
+  | cucumber roll | 8     |
+```
+
+Your step definition would look like this:
+
+```ruby
+Then ^I am served these items do |entrees|
+  entrees.hashes.each do |entree|
+
+    # entree is this hash:
+    { 'name' => 'miso soup', 'count' => '1' }
+
+    # Let's convert the keys to symbols.
+    Kappamaki.symbolize_keys_deep! entree
+
+    # Now entree is this hash:
+    { name: 'miso soup', count: '1' }
 
-  # now we can set up our system using this data
-  create :dinner, dinner_data
+    # Now we can use this hash in places that expect hashes with symbols
+    expect(order).to include entree
+  end
 end
 ```
 

data/kappamaki.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name     = 'kappamaki'
-  spec.version  = '0.0.2'
+  spec.version  = '0.0.3'
   spec.authors  = ['Kevin Goslar']
   spec.email    = ['kevin.goslar@originate.com']
   spec.summary  = 'Tools for natural, high-level, sophisticated Cucumber steps'
@@ -20,9 +20,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep('spec')
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 0'
-  spec.add_development_dependency 'rake', '~> 0'
-  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
 
   spec.required_ruby_version = '>= 1.9.3'
 end

data/lib/kappamaki.rb

@@ -21,4 +21,14 @@ module Kappamaki
             .map{|s| s.gsub '"', ''}
   end
 
+
+  # Converts all keys in the given hash to symbols
+  def self.symbolize_keys_deep!(h)
+    h.keys.each do |k|
+      ks    = k.to_sym
+      h[ks] = h.delete k
+      symbolize_keys_deep! h[ks] if h[ks].kind_of? Hash
+    end
+  end
+
 end

data/spec/kappamaki_spec.rb

@@ -35,5 +35,21 @@ describe Kappamaki do
       end
     end
   end
+
+
+  describe 'symbolize_keys_deep!' do
+
+    it 'converts string keys to symbols' do
+      actual = { 'one' => 'two', 'alpha' => 'beta' }
+      Kappamaki.symbolize_keys_deep! actual
+      expect(actual).to eq({ one: 'two', alpha: 'beta' })
+    end
+
+    it 'converts nested keys' do
+      actual = { 'one' => { 'alpha' => 'beta' }}
+      Kappamaki.symbolize_keys_deep! actual
+      expect(actual).to eq({ one: { alpha: 'beta' }})
+    end
+  end
 end
 

metadata

@@ -1,55 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: kappamaki
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kevin Goslar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !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: 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'
 description: |2