tableware 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdf63d976f7bc10b88173faff66b1648b68f121e
-  data.tar.gz: 5ec2eeb4cc455f7732329d5d1720c792327cae7e
+  metadata.gz: 726ade1c9944387517bd3d7bbac38f5ba2584a30
+  data.tar.gz: e2fddc4507e8fa04c3144290e104b9d171c30e26
 SHA512:
-  metadata.gz: 9118c0d6f8c9d9e17b5521e6b08c51f5a221627c4168b5f452612790e75bcca1cbd63bc517a010d55620a9aca02b55ce27e264e3f6099436e9cfbe1544ed31b8
-  data.tar.gz: 99e85bec1a7fd1a8e72f1e64536ec2454227e65e023af07adb2038ca0eb6686900658118829f8ab8f813356729bdb66dfb369ad023fc7a1eabe7eaeb1b167830
+  metadata.gz: 6f8611a0c543306410ac5e9252e8614c386931d83d1511f5edf41ef4bd198a10fdf63f2cc98f807edaea2d9a221903151a8fa6371a9ab585e2a4f1d98e78eb93
+  data.tar.gz: 3e4ec20fcd80ef69f7ff38d05d6ec0bbcc02ad14775a468ba3ba5eadb21c52843865bb5ba08b430606ce5d4db61a9218031ad5f873e3ec729e76770a07011b2b

data/.semver

@@ -0,0 +1,6 @@
+---
+:major: 0
+:minor: 1
+:patch: 1
+:special: ''
+:metadata: ''

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+== v0.1.1 (16 August 2016)
+
+# v0.1.0
+
+* Initial release
+* Parsing basic tables into 2D arrays or an array of hashes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tableware (0.1.0)
+    tableware (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -85,6 +85,7 @@ GEM
       parser (>= 2.2.0, < 3.0)
       reek (= 3.8.1)
       virtus (~> 1.0)
+    semver2 (3.4.2)
     sexp_processor (4.6.1)
     simplecov (0.11.2)
       docile (~> 1.1.0)
@@ -121,6 +122,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop
   rubycritic
+  semver2
   simplecov
   tableware!
 

data/README.md

@@ -3,43 +3,42 @@
 Tableware is a tiny gem for making it easier to define data in an text table.
 Table rows are parsed into either arrays or hashes.
 
-For example, writing:
+For example:
 
-```
-[
- [ "Type A",   true,   false,   2016 ],
- [ "Type B",   "only on alternating Wednesdays",   false,   2017 ],
- [ "Type C",   :never,   true,   2016 ]
-].each do |args|
-  // Some test or permissions check or something
-end
-```
-is fine but it can be a pain to format at work with, especially for larger data sets.
+```ruby
+stats = ' Hero        |    Value     |  Hours Played
+          ------------------------------------------
+          Phara       |       10     |      22
+          Mercy       |        9     |      11
+          Winston     |        3     |       2        '
 
-Tableware lets you trade a bit of parsing for nicer text tables. Instead of the above, you could write:
+Tableware.arrays(stats)
+ # => [
+        ['Phara', '10', '22'],
+        ['Mercy', '9', '11'],
+        ['Winston', '3', '2']
+      ]
 
+Tableware.hashes(stats)
+  #=> [
+        { hero: 'Phara', value: '10', hours_played: 22 },
+        { hero: 'Mercy', value: '9', hours_played: 11 },
+        { hero: 'Winston', value: '3', hours_played: 2 }
+      ]
 ```
-table = %q[
-  |    Type      |  Valid                           | Infinite   | Year Introduced |
-  ----------------------------------------------------------------------------------
-  |  Type A      | true                             | false      | 2016            |
-  |  Type B      | Only on alternating Wednesdays   | false      | 2017            |
-  |  Type C      | never                            | true       | 2016            |
-]
-Tableware.arrays.each do |args|
-  // Some test or permissions check or something
-end
-```
 
-The upside is that you get a much more human friendly table to read, which will save you time by making it something you can quickly scan over.
-The downside is that everything appears on the other side as a string, so you may need to do some `.to_i`ing to convert things back into the type you're expecting.
+Writing test data or a matrix of permissions in a big hash or nested array is fine, but it can be a pain to format at work with, especially for larger data setsa or with item of very different lengths.
+
+Tableware lets you use a more human friendly format so that you can more easily scan and understand the data.
 
-*Please note* that this isn't always going to be better than defining your data in another format; arrays, giant hashes of doom, JSON/YAML or even CSV may me easier to work with. This is another option and one which may be better for that middle ground when your data makes arrays hard to format but it's not big enough for you to want to extract it to an external file. Or perhaps you just like Cucumber scenario outlines and want something similar in rspec!
-Whatever your reasoning, this is just one more option for formatting your data.
+The downside is that everything is treated as a string, so you may need to do some `.to_i`ing to convert things back into the type you're expecting. However, this is a one-time cost and [optimising for reading code is a good idea](http://va.lent.in/optimize-for-readability-first/).
 
-This gem has been created as a quick experiement to see if or how ofen this feature could be useful.
+This isn't always going to be better than defining your data in another format, but it is another option. Or perhaps you just like Cucumber scenario outlines and want something similar in rspec!
+
+This gem has been created as a quick experiment to see if or how ofen this feature could be useful.
 If you find it useful, please like it or better yet, extend it!
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -70,38 +69,8 @@ Tableware provides two main methods for getting your data back out of the table:
   1. `Tableware.arrays` returns an array of arrays
   2. `Tableware.hashes` returns an array of hashes, where the keys come from the headings row
 
+  Both of these can be seen in use in the example at the top of this README.
 
-For example:
-
-```
-input = '
-      Hero        |    Value     |  Hours Played
-      ------------------------------------------
-      Phara       |       10     |      22
-      Mercy       |        9     |      11
-      Winston     |        3     |       2
-    '
-
-Tableware.arrays(input)
- # => [
-        ['Phara', '10', '22'],
-        ['Mercy', '9', '11'],
-        ['Winston', '3', '2']
-      ]
-
-Tableware.hashes(input)
-  #=> [
-        { hero: 'Phara', value: '10', hours_played: 22 },
-        { hero: 'Mercy', value: '9', hours_played: 11 },
-        { hero: 'Winston', value: '3', hours_played: 2 }
-      ]
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -5,7 +5,6 @@ require 'rake-n-bake'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: [
-  :clean,
   :"bake:code_quality:all",
   :"bake:rspec",
   :"bake:coverage:check_specs",

data/lib/tableware/parser.rb

@@ -25,7 +25,7 @@ class Tableware
     private def prepare_lines(input)
       lines = input.strip.lines
 
-      @data_start = lines[1] =~ /^\s*[-=]+\s*$/ ? 2 : 0
+      @data_start = lines[1] =~ /^\s*[-=\|]+\s*$/ ? 2 : 0
       if @data_start.nonzero?
         @headers = parse_line(lines[0])
                    .map!(&:downcase)

data/lib/tableware/version.rb

@@ -1,5 +1,5 @@
 class Tableware
 
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 
 end

data/tableware.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubycritic'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'semver2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tableware
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Whittingham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-13 00:00:00.000000000 Z
+date: 2016-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: semver2
+  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: A nice way of parsing text tables into Ararys or Hashes, for clearer
   code. Great for tests and permissions matrixes!
 email:
@@ -135,6 +149,9 @@ files:
 - ".rubocop-https---raw-githubusercontent-com-dvmtn-house-style-master-rubocop-yml"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".semver"
+- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock