teer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3feb0b6fd084b70a977ec9cc6676ee6e5b8ac62b10a726890e0c18315236e44c
+  data.tar.gz: '018a9115975f3b770654c3696d9282a591928d632dfc8011e16ee27b472bb8d3'
+SHA512:
+  metadata.gz: 81d1f5f94e88805d9619c6ca33667da5739f1dc0ba6835201e8bdfe3b4b6e7fddfa08ed32c3d3c02e77532937f7229c6ffc11ea0c0f04740acc62eb485463814
+  data.tar.gz: cf7c09a290131637e246e3973c90a20456ce7bf7b1653432662baeeaa4f3fc72b6242c58d1a6b7f696c6688131cdc88f427bddbe23c3c5aaa39ff280d0508f70

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mark.tint.ramotowski@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in teer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mark Ramotowski
+
+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,282 @@
+[![Build Status](https://travis-ci.com/Rambatino/teer.svg?branch=master)](https://travis-ci.com/Rambatino/teer)
+
+# Teer - Template Engingeering Rebourn
+
+Picture the scene. You have a lot of data and you want to present the results of that data on a chart or a web page. How would you go about turning variable data into a human readable format - let's say you wanted to summarise a chart?
+
+This small library aims to solve that problem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teer
+
+## Usage
+
+### Simple Use-Case
+
+Given a table and the dream of translating it into human readable format:
+
+|             | count |
+| ----------- | ----- |
+| <b>name</b> |       |
+| Bob         | 4     |
+| Alan        | 14    |
+| Jeff        | 2     |
+
+You can pass it in with a template yaml/hash with the format:
+
+```yaml
+names: # only run if names is a variable in the template scope
+  worst_name: "names.sort[-1].key"
+  worst_value: "names.sort[-1].value"
+  text:
+    GB_en: "{{ worst_name }} has the least apples, having only {{ worst_value }}"
+    FR: "{{ worst_name }} a le moins de pommes, n'en ayant que {{ worst_value }}"
+```
+
+(under the hood the yaml gets converted into a hash anyway)
+
+and by running:
+
+```ruby
+teer = Teer::Template.create([
+  { 'name' => 'Bob', 'count' => 4 },
+  { 'name' => 'Alan', 'count' => 14 },
+  { 'name' => 'Jeff', 'count' => 2 }
+], 'count', template).finding
+```
+
+It parses the template and substitutes the values into the text:
+
+```ruby
+=> "Jeff has the least apples, having only 2"
+```
+
+#### Key Principles to the example
+
+As the teer parses the data, it takes a mandatory argument "name", in this case `count` which is what the data is indexed against. The teer takes each index (there could be many) and defines new variables by pluralising the index. In this example, `names` becomes a variable (as it's one of the indexes) that we can apply methods to.
+
+The template passed in has a first key (`names`) which checks for the presence of that variable (it's actually optional to do that check).
+
+Variables can also be defined in the template itself, and substituted into the output text. In the example above, `worst_name` is defined as variable, defined by: `names.sort[-1].key` which means take each row, and sort (ascending is false) the `names` by `count` and take the last row and the `key` is the row member of name and the `value` is the `count` associated with that name.
+
+As well as this, as count is a column, it can be accessed like `counts` and simple arithmetic operations can be applied to it, such as `counts.mean` or `counts.sum` to get the required value _if filtering is not required_. If filtering _is required_ then the correct approach is to filter using the indexes.
+
+We can inspect the `names` variable, as it elucidates how these methods interact with it:
+
+```ruby
+teer.data.names # teer is defined above
+=> <DataStore:0x007f83bd3e1398 @data=[["Bob", 4], ["Alan", 14], ["Jeff", 2]], @locale=:GB_en>
+# it's useful to try methods here before adding them to the template:
+teer.data.names.keys
+=> <Teer::VectorStore:0x00007fbaa7373200 @data=["Bob", "Alan", "Jeff"], @locale=:GB_en>
+
+teer.data.names.values
+=> <Teer::VectorStore:0x00007fbaa739a378 @data=[4, 14, 2], @locale=:GB_en>
+
+teer.data.names.max.key
+=> "Alan"
+
+teer.data.names.min.value
+=> 2
+
+teer.data.names.slice("Jeff")
+=> <Teer::DataStore:0x00007fbaa8a02188 @data=[["Jeff", 2]], @locale=:GB_en>
+```
+
+Here each index row is associated with the value of the data and methods can be applied to that (defined in `lib/teer/data_store.rb`) such as `min`, `count`, `[]`, `sort` and also conditionals (such as `gt`, `lt`, `ne`, `eq`) which are able to create rich verbatims from the underlying data.
+
+#### Multiple Language Support
+
+If you notice, the key inside `text` is `GB_en` this is the default. However, other languages and keys are supported and can be used like:
+
+```ruby
+teer = Teer::Template.create([
+  { 'name' => 'Bob', 'count' => 4 },
+  { 'name' => 'Alan', 'count' => 14 },
+  { 'name' => 'Jeff', 'count' => 2 }
+], 'count', template, {}, :FR).finding
+
+=> "Jeff a le moins de pommes, n'en ayant que 2"
+```
+
+#### Conditional Switch Statements
+
+To expand on the previous example:
+
+```yaml
+names:
+  best_name: names.max.key
+  best_value: names.max.value
+  text:
+    GB_en: "{{ best_name }} has the most apples."
+
+  second_best_value: "names.sort.second.value"
+  much_larger: best_value > second_best_value + 5
+  much_larger:
+    second_best_name: names.sort.second.key
+    text:
+      GB_en: "It's a lot more than {{ second_best_name }} who came in second place."
+  not much_larger:
+    text:
+      GB_en: "However, {{ second_best_name }}'s {{ second_best_value }} was close behind."
+```
+
+With this template, the results concatenate (in a top down fashion) and it results in:
+
+```ruby
+=> "Alan has the most apples. It's a lot more than Bob who came in second place."
+```
+
+You can also collect them all separately (using the method `findings`) so as to join them anyway you like:
+
+```ruby
+Teer::Template.create([
+  { 'name' => 'Bob', 'count' => 4 },
+  { 'name' => 'Alan', 'count' => 14 },
+  { 'name' => 'Jeff', 'count' => 2 }
+], 'count', template).findings.join("\n")
+
+=> "Alan has the most apples.\nIt's a lot more than Bob who came in second place."
+```
+
+#### Passing in extra Variables
+
+```ruby
+teer = Teer::Template.create([
+  { 'name' => 'Bob', 'count' => 4 },
+  { 'name' => 'Alan', 'count' => 14 },
+  { 'name' => 'Jeff', 'count' => 2 }
+], 'count', template, {'some_other_var' => 'my special variable'}).finding
+```
+
+`{{ some_other_var }}` will yield 'my special variable' when placed inside the template
+
+#### A more complex example - linking between rows
+
+Note: This library is not turing complete, which means it's not for programming inside
+of the template. For instance, filtering the indexes less than or greater than a value is
+not appropriate to do inside of the template - you can filter the data before passing it in, using
+your favourite library.
+
+Having said that, there is a helper method, which translates as "only select the rows from this index
+that match these other index keys":
+
+```ruby
+kpis.slice_from(names, 'Bob') # translates as select only Bob's KPIs
+```
+
+Also see `teer_spec.rb`. Markdown can be written, returning a result such as:
+
+Behaviour change was worst for respondents who selected:
+
+-   `West` for `regUS`
+-   `Female` for `gender`
+
+for `Would you change your response to Apple?`
+
+### Importing Google Sheets rules into Teer
+
+Our use-case internally was to pull in 'rules' from Google Sheets and alongside the data, display key findings. Using this library you can easily achieve this. Let's say you have wide data with many columns and you don't care about the indexes:
+
+|            | banana | apple | pear  | orange |
+|------------|--------|-------|-------|--------|
+| person_id |        |       |       |        |
+| a          | 0.3    | 0.5   | 1     | 0.45   |
+| b          | 0.5    | 0.1   | 2     | 0.1    |
+| c          | 0.8    | 0.7   | 5     | 0.6    |
+| d          | 0.9    | 0.7   | 9     | 10     |
+
+``` ruby
+data = [
+  {'person_id' => 'a', 'banana' => 0.3, 'apple' => 0.5, 'pear' => 1, 'orange' => 0.45},
+  {'person_id' => 'b', 'banana' => 0.5, 'apple' => 0.1, 'pear' => 2, 'orange' => 0.1},
+  {'person_id' => 'c', 'banana' => 0.8, 'apple' => 0.7, 'pear' => 5, 'orange' => 0.6},
+  {'person_id' => 'd', 'banana' => 0.9, 'apple' => 0.7, 'pear' => 9, 'orange' => 10}
+]
+```
+
+Google Sheets rules in 2d array format [[condition, text], ...]:
+
+
+``` ruby
+rules = [
+  ['bananas.mean > 2', 'Lots of bananas'],
+  ['bananas.mean > 1 && bananas.mean < 2', 'Not that many bananas'],
+  ['bananas.mean < 1', 'No bananas'],
+  .
+  .
+  .
+]
+```
+* N.B. because there are multiple columns, the variables are accessed as the column name with an `s` on the end (plural columns will return an error) and to access the index data now, you have to access it by the column name e.g. `banana.person_ids.slice("a").value # = 0.3`
+
+The results of which can be calculated by doing
+``` ruby
+template = Teer::Template.create(data, data.first.keys - ['person_id'], rules)
+template.findings # = ['No bananas'...]
+```
+
+#### Helpers | Formatters
+
+To format variables as the template is interpolated, helpers are used to do things such as round numbers of format time. They take the form of `{{METHOD VARIABLE}}`
+
+Examples below:
+
+```ruby
+horrible_floats_and_time = [
+  { 'time' => Time.new(1993, 02, 24, 12, 0, 0, "+09:00"), 'name' => 'Bob', 'count' => 4.213432 },
+  { 'time' => Time.new(1993, 02, 24, 12, 0, 0, "+09:00"), 'name' => 'Alan', 'count' => 14.35 },
+  { 'time' => Time.new(1993, 02, 24, 12, 0, 0, "+09:00"), 'name' => 'Jeff', 'count' => 2.1 }
+]
+
+text = '{{round best_value }}'
+template = { 'best_value' => 'names.sort[0].value', 'text' => { 'GB_en' => text } }
+Teer::Template.create(horrible_floats_and_time, 'count', template).finding
+=> "14.4"
+
+text = '{{month month_key }}'
+template = { 'month_key' => 'times.sort[0].key', 'text' => { 'GB_en' => text } }
+Teer::Template.create(horrible_floats_and_time, 'count', template).finding
+=> "February"
+```
+
+Although only those two currently come out of the box, it's easy to add more when your app initialises:
+
+```ruby
+Teer::Template.handlebars.register_helper(:year) do |_context, condition, _block|
+  Time.at(condition).strftime('%Y')
+end
+```
+
+See [here](https://github.com/cowboyd/handlebars.rb) for more advanced usage. If you feel the helper will benefit all, please submit a PR!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/Rambatino/teer>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Teer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Rambatino/teer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "teer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/teer/data_store.rb

@@ -0,0 +1,124 @@
+require_relative 'vector_store'
+
+module Teer
+  class DataStore
+    def initialize(data, locale)
+      @data = data
+      @locale = locale
+    end
+
+    def key
+      @data.transpose[0][0]
+    end
+
+    def value
+      @data.transpose[1][0]
+    end
+
+    def keys
+      VectorStore.new(@data.transpose[0], @locale)
+    end
+
+    def values
+      VectorStore.new(@data.transpose[1], @locale)
+    end
+
+    def uniq
+      VectorStore.new(@data.transpose[0].uniq, @locale)
+    end
+
+    def group_count
+      DataStore.new(@data.transpose[0].each_with_object(Hash.new(0)) { |key, hsh| hsh[key] += 1 }.to_a, @locale)
+    end
+
+    def count
+      @data.count
+    end
+
+    def max
+      VectorStore.new(@data.max_by(&:last), @locale)
+    end
+
+    def min
+      VectorStore.new(@data.min_by(&:last), @locale)
+    end
+
+    def [](i)
+      VectorStore.new(@data[i], @locale)
+    end
+
+    def sort
+      DataStore.new(@data.sort_by(&:last).reverse, @locale)
+    end
+
+    def pluck_by_value(value)
+      DataStore.new(@data.select { |_, val| val == value }, @locale)
+    end
+
+    def first
+      VectorStore.new(@data[0], @locale)
+    end
+
+    def second
+      VectorStore.new(@data[1], @locale)
+    end
+
+    def third
+      VectorStore.new(@data[2], @locale)
+    end
+
+    def fourth
+      VectorStore.new(@data[3], @locale)
+    end
+
+    def last
+      VectorStore.new(@data[-1], @locale)
+    end
+
+    def eq(num)
+      DataStore.new(@data.select { |a| a[-1] == num }, @locale)
+    end
+
+    def gt(num)
+      DataStore.new(@data.select { |a| a[-1] > num }, @locale)
+    end
+
+    def lt(num)
+      DataStore.new(@data.select { |a| a[-1] < num }, @locale)
+    end
+
+    def ne(num)
+      DataStore.new(@data.reject { |a| a[-1] == num }, @locale)
+    end
+
+    def slice(key)
+      DataStore.new(@data.select { |a| a[0] == key }, @locale)
+    end
+
+    def slice_from(data_store, key)
+      idx = data_store.data.map { |a| a[0] == key }
+      DataStore.new(@data.select.with_index { |_a, i| idx[i] }, @locale)
+    end
+
+    def map(*others)
+      @data.each_with_index.map do |a, i|
+        yield(VectorStore.new(a, @locale),
+          *(others || []).map { |other| VectorStore.new(other.data[i], @locale) })
+      end
+    end
+
+    def to_s
+      "DataStore.new(#{@data}, #{@locale})"
+    end
+
+    def eql(value) # for equality checks
+      DataStore.new(@data.select { |a| a[1] == value }, @locale)
+    end
+
+    attr_reader :data
+
+    def as_json(options = nil)
+      @data.as_json(options)
+    end
+  end
+end

data/lib/teer/engine.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+require 'teer/data_store'
+require 'teer/vector_store'
+require 'ostruct'
+
+module Teer
+  class Engine
+    def initialize(data, names, template, handlebars, locale, kwargs)
+      @template = template
+      @handlebars = handlebars
+      @locale = locale
+      @findings = []
+      setup_store(data, names)
+      @data_store = @store.clone
+      kwargs.each { |k, v| @store[k] = v }
+      @store.interpolate = interpolate
+    end
+
+    def setup_store(data, names)
+      n_arr = Array(names)
+      if n_arr.count == 1
+        @store = OpenStruct.new((data[0].keys - n_arr).map do |idx|
+          [idx.pluralize, DataStore.new(data.map { |r| [r[idx], r[n_arr[0]]] }, @locale)]
+        end.to_h)
+      else
+        @store = OpenStruct.new.tap do |struct|
+          idxs = (data[0].keys - n_arr)
+          names.each do |name|
+            raise ArgumentError, "column name cannot be plural: #{name}" if name == name.pluralize
+            struct[name] = OpenStruct.new(idxs.map do |idx|
+              [idx.pluralize, DataStore.new(data.map { |r| [r[idx], r[name]] }, @locale)]
+            end.to_h)
+          end
+        end
+      end
+      n_arr.each do |name|
+        @store[name.pluralize] = VectorStore.new(data.map { |r| r[name] }, @locale)
+      end
+    end
+
+    def finding
+      @finding ||= parse_template(@template)
+    end
+
+    def findings
+      @finding ||= parse_template(@template)
+      @findings
+    end
+
+    def pre_parsed_finding
+      @finding ||= parse_template(@template)
+      @pre_parsed_finding
+    end
+
+    def data
+      @data ||= @data_store
+    end
+
+    def value_for_store_key(key)
+      finding if @finding.nil?
+      @store[key]
+    end
+
+    def interpolate
+      @interpolate ||= proc { |string| @handlebars.compile(string).call(@store.to_h) }
+    end
+
+    def add_to_store(template)
+      template.each do |k, v|
+        if v.is_a?(String) && k != 'text'
+          @store[k] = eval(v, @store.instance_eval { binding })
+        elsif !!v == v
+          @store[k] = v
+        end
+      end
+    end
+
+    def parse_template(template)
+      text = ''
+      pre_parsed_text = ''
+      add_to_store(template)
+      template.each do |k, v|
+        new_text = nil
+        unparsed_new_text = nil
+        if k == 'text' && (!v.nil? && !v.empty?)
+          @findings << (new_text = interpolate.call(v[@locale.to_s]))
+          unparsed_new_text = v[@locale.to_s]
+        elsif v.is_a?(Hash) && eval(k, @store.instance_eval { binding })
+          new_text = parse_template(v)
+        end
+        text += new_text + ' ' if new_text
+        pre_parsed_text += unparsed_new_text + ' ' if unparsed_new_text
+      end
+      @pre_parsed_finding = CGI.unescapeHTML(pre_parsed_text[0...-1]) if !pre_parsed_text.nil? && !pre_parsed_text.empty?
+      CGI.unescapeHTML(text[0...-1]) if !text.nil? && !text.empty?
+    end
+  end
+end

data/lib/teer/vector_store.rb

@@ -0,0 +1,48 @@
+module Teer
+  class VectorStore
+    def initialize(data, locale)
+      @data = data
+      @locale = locale || :GB_en
+    end
+
+    def key
+      @data[0]
+    end
+
+    def value
+      @data[1]
+    end
+
+    def count
+      @data.count
+    end
+
+    def sum
+      @data.reduce(:+)
+    end
+
+    def mean
+      @data.reduce(:+) / @data.count
+    end
+
+    def to_s
+      length = @data.length
+      case length
+      when 0
+        ''
+      when 1
+        @data[0]
+      else
+        sentence = @data.join(', ')
+        # should support all languages at some point
+        sentence.reverse.sub(' ,', ' dna ').reverse
+      end
+    end
+
+    attr_reader :data
+
+    def as_json(options = nil)
+      @data.as_json(options)
+    end
+  end
+end

data/lib/teer/version.rb

@@ -0,0 +1,3 @@
+module Teer
+  VERSION = "1.0.0"
+end

data/lib/teer.rb

@@ -0,0 +1,48 @@
+require 'teer/version'
+require 'teer/engine'
+require 'handlebars'
+require 'yaml'
+
+module Teer
+  class Error < StandardError; end
+
+  class Template
+    def self.create(data, names, rules_path_or_obj, kwargs = {}, locale = :GB_en)
+      return OpenStruct.new(data: nil, finding: nil) if data.empty?
+      register_helpers
+      data_keys = data.first.keys
+      raise ArgumentError, "#{names} not present in data" if (Array(names) - data_keys).count != 0
+      @template = Engine.new(data, names, template(rules_path_or_obj, locale), handlebars, locale, kwargs)
+    end
+
+    def pre_parsed_finding
+      @template.pre_parsed_finding
+    end
+
+    def self.template(rules_path_or_obj, locale)
+      case rules_path_or_obj
+      when String
+        YAML.safe_load(File.read(rules_path_or_obj))
+      when Array
+        rules_path_or_obj.map { |condition, text| [condition, { 'text' => { locale.to_s => text } } ] }.to_h
+      when Hash
+        return rules_path_or_obj
+      else
+        raise ArgumentError, "Unknown template structure: #{rules_path_or_obj.class}"
+      end
+    end
+
+    def self.handlebars
+      @handlebars ||= Handlebars::Context.new
+    end
+
+    def self.register_helpers
+      handlebars.register_helper(:round) do |_context, condition, _block|
+        condition < 1 ? condition.round(2) : condition.round(1)
+      end
+      handlebars.register_helper(:month) do |_context, condition, _block|
+        Time.at(condition).strftime('%B')
+      end
+    end
+  end
+end

data/teer.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'teer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'teer'
+  spec.version       = Teer::VERSION
+  spec.authors       = ['Mark Ramotowski']
+  spec.email         = ['mark.tint.ramotowski@gmail.com']
+
+  spec.summary       = 'Create human readable summation of data'
+  spec.description   = 'Turns data into human readable format using templates with simple logic statements'
+  spec.homepage      = 'https://www.github.com/Rambatino/teer'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+    # if spec.respond_to?(:metadata)
+    #   spec.metadata['allowed_push_host'] = 'http://mygemserver.com'
+    #
+    #   spec.metadata['homepage_uri'] = spec.homepage
+    #   spec.metadata['source_code_uri'] = spec.homepage
+    #   spec.metadata['changelog_uri'] = spec.homepage + '/blob/master/CHANGELOG.md'
+    # else
+    #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+    #     'public gem pushes.'
+    # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'handlebars'
+  spec.add_dependency 'activesupport'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: teer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Ramotowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: handlebars
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rubocop
+  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: Turns data into human readable format using templates with simple logic
+  statements
+email:
+- mark.tint.ramotowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/teer.rb
+- lib/teer/data_store.rb
+- lib/teer/engine.rb
+- lib/teer/vector_store.rb
+- lib/teer/version.rb
+- teer.gemspec
+homepage: https://www.github.com/Rambatino/teer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Create human readable summation of data
+test_files: []