stringento 1.0.0

data/spec/stringento/formatter_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+require './spec/examples/custom_formatter'
+
+describe ::Stringento::Formatter do
+  describe 'when not specifying a formatter' do
+    it 'should return value as a string' do
+      value = 'some value'
+
+      actual = described_class.new.format(value)
+
+      expect(actual).to eq(value)
+    end
+  end
+
+  describe 'when specifying a formatter that does not exist' do
+    it 'should return value as a string' do
+      value = 'some value'
+
+      actual = described_class.new.format(value, 'doesnt_exist')
+
+      expect(actual).to eq(value)
+    end
+  end
+
+  describe 'custom formatters' do
+    it 'yes_no formatter should be called' do
+      formatter = CustomFormatter.new
+      method    = 'yes_no'
+
+      expect(formatter.format(true, method)).to eq('Yes')
+      expect(formatter.format('true', method)).to eq('Yes')
+      expect(formatter.format('', method)).to eq('Yes')
+      expect(formatter.format('false', method)).to eq('Yes')
+
+      expect(formatter.format(false, method)).to eq('No')
+      expect(formatter.format(nil, method)).to eq('No')
+    end
+  end
+
+  it 'yes_no_unknown formatter should be called' do
+    formatter = CustomFormatter.new
+    method    = 'yes_no_unknown'
+
+    expect(formatter.format(true, method)).to eq('Yes')
+    expect(formatter.format('true', method)).to eq('Yes')
+    expect(formatter.format('', method)).to eq('Yes')
+    expect(formatter.format('false', method)).to eq('Yes')
+
+    expect(formatter.format(false, method)).to eq('No')
+
+    expect(formatter.format(nil, method)).to eq('Unknown')
+  end
+end

data/spec/stringento/placeholder_spec.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe ::Stringento::Placeholder do
+  let(:tests) do
+    [
+      [
+        '',
+        {
+          arg: '',
+          formatter: '',
+          name: '',
+          value: ''
+        }
+      ],
+      [
+        nil,
+        {
+          arg: '',
+          formatter: '',
+          name: '',
+          value: ''
+        }
+      ],
+      [
+        1,
+        {
+          arg: '',
+          formatter: '',
+          name: '1',
+          value: '1'
+        }
+      ],
+      [
+        false,
+        {
+          arg: '',
+          formatter: '',
+          name: 'false',
+          value: 'false'
+        }
+      ],
+      [
+        'string-value',
+        {
+          arg: '',
+          formatter: '',
+          name: 'string-value',
+          value: 'string-value'
+        }
+      ],
+      [
+        'dob::date::short',
+        {
+          arg: 'short',
+          formatter: 'date',
+          name: 'dob',
+          value: 'dob::date::short'
+        }
+      ],
+      [
+        'created_at::time_ago',
+        {
+          arg: '',
+          formatter: 'time_ago',
+          name: 'created_at',
+          value: 'created_at::time_ago'
+        }
+      ]
+    ]
+  end
+
+  it 'should properly initialize attributes' do
+    tests.each do |test|
+      expression      = test.first
+      expected_values = test.last
+
+      placeholder = described_class.new(expression)
+
+      expect(placeholder.arg).to        eq(expected_values[:arg])
+      expect(placeholder.formatter).to  eq(expected_values[:formatter])
+      expect(placeholder.name).to       eq(expected_values[:name])
+      expect(placeholder.value).to      eq(expected_values[:value])
+    end
+  end
+end

data/spec/stringento/resolver_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+require './spec/examples/custom_formatter'
+
+class Person
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+  end
+end
+
+describe ::Stringento::Resolver do
+  context 'input is hash' do
+    let(:input) do
+      {
+        name: 'Matt'
+      }
+    end
+
+    it 'should resolve for existing key' do
+      expect(described_class.new.resolve(:name, input)).to eq(input[:name])
+    end
+
+    it 'should resolve nil for missing key' do
+      expect(described_class.new.resolve(:doesnt_exist, input)).to eq(nil)
+    end
+  end
+
+  context 'input is null' do
+    let(:input) { nil }
+
+    it 'should resolve to null' do
+      expect(described_class.new.resolve(:name, input)).to eq(nil)
+    end
+  end
+
+  context 'input is an object' do
+    let(:input) { Person.new('Matt') }
+
+    it 'should resolve to null' do
+      expect(described_class.new.resolve(:name, input)).to eq(input.name)
+    end
+  end
+end

data/spec/stringento/stringento_spec.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+require './spec/examples/custom_formatter'
+require './spec/examples/indifferent_hash_resolver'
+require './spec/examples/nested_hash_resolver'
+
+describe ::Stringento do
+  context 'without custom formatter and resolver' do
+    describe '#evaluate' do
+      let(:tests) do
+        [
+          [
+            'matt is a {animal}',
+            { 'animal' => 'giraffe' },
+            'matt is a giraffe'
+          ],
+          [
+            'matt is a {animal}',
+            { animal: 'giraffe' },
+            'matt is a '
+          ]
+        ]
+      end
+
+      it 'should evaluate' do
+        tests.each do |test|
+          expression  = test[0]
+          input       = test[1]
+          output      = test[2]
+
+          actual = described_class.evaluate(expression, input)
+
+          expect(actual).to eq(output)
+        end
+      end
+    end
+  end
+
+  context 'with custom formatter and resolver' do
+    describe '#evaluate' do
+      let(:tests) do
+        [
+          [
+            'matt is a {animal}',
+            { 'animal' => 'giraffe' },
+            'matt is a giraffe'
+          ],
+          [
+            'matt is a {animal}',
+            { animal: 'giraffe' },
+            'matt is a giraffe'
+          ],
+          [
+            '{other} {value} {types} {are} {ok} {bro}',
+            {
+              are: nil,
+              bro: 0,
+              ok: nil,
+              other: 1,
+              types: 12.3,
+              value: false
+            },
+            '1 false 12.3   0'
+          ],
+          [
+            'matt is an elephant: {elephant::yes_no}',
+            { elephant: true },
+            'matt is an elephant: Yes'
+          ],
+          [
+            'matt is an ostrich: {ostrich::yes_no}',
+            { ostrich: false },
+            'matt is an ostrich: No'
+          ],
+          [
+            'matt is a cat: {cat::yes_no}',
+            { cat: nil },
+            'matt is a cat: No'
+          ],
+          [
+            'matt is a bird: {bird::yes_no_unknown}',
+            { bird: true },
+            'matt is a bird: Yes'
+          ],
+          [
+            'matt is an airplane: {airplane::yes_no_unknown}',
+            { airplane: false },
+            'matt is an airplane: No'
+          ],
+          [
+            'matt is a dog: {dog::yes_no_unknown}',
+            { dog: nil },
+            'matt is a dog: Unknown'
+          ]
+        ]
+      end
+
+      let(:resolver) { IndifferentHashResolver.new }
+
+      let(:formatter) { CustomFormatter.new }
+
+      it 'should evaluate' do
+        tests.each do |test|
+          expression  = test[0]
+          input       = test[1]
+          output      = test[2]
+
+          actual = described_class.evaluate(
+            expression,
+            input,
+            resolver: resolver,
+            formatter: formatter
+          )
+
+          expect(actual).to eq(output)
+        end
+      end
+    end
+  end
+
+  describe 'README examples' do
+    specify 'Getting Started example works' do
+      example = 'The {fox_speed} brown fox jumps over the {dog_speed} dog'
+      input = { 'fox_speed' => 'quick', 'dog_speed' => 'lazy' }
+      result = Stringento.evaluate(example, input)
+
+      expect(result).to eq('The quick brown fox jumps over the lazy dog')
+    end
+
+    specify 'Custom Resolution example works' do
+      example = 'The {fox.speed} brown fox jumps over the {dog.speed} dog'
+      input = { fox: { speed: 'quick' }, dog: { speed: 'lazy' } }
+
+      result = Stringento.evaluate(example, input, resolver: NestedHashResolver.new)
+
+      expect(result).to eq('The quick brown fox jumps over the lazy dog')
+    end
+
+    specify 'Custom Formatting example works' do
+      example = 'The fox is quick: {fox.quick::yes_no_unknown}'
+      input = { fox: { quick: true } }
+
+      result = Stringento.evaluate(
+        example,
+        input,
+        resolver: NestedHashResolver.new,
+        formatter: CustomFormatter.new
+      )
+
+      expect(result).to eq('The fox is quick: Yes')
+    end
+  end
+end

data/spec/stringento/template_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+require './spec/examples/custom_formatter'
+require './spec/examples/indifferent_hash_resolver'
+
+describe ::Stringento::Template do
+  describe '#placeholders' do
+    let(:tests) do
+      [
+        [
+          '',
+          []
+        ],
+        [
+          nil,
+          []
+        ],
+        [
+          1,
+          []
+        ],
+        [
+          false,
+          []
+        ],
+        [
+          'string with none',
+          []
+        ],
+        [
+          '{one {inside} another one}',
+          ['one {inside']
+        ],
+        [
+          'matt {is} a {monkeys} uncle.',
+          %w[is monkeys]
+        ],
+        [
+          'matt {is::date::short} a {monkeys::timeAgo} uncle.',
+          %w[is::date::short monkeys::timeAgo]
+        ]
+      ]
+    end
+
+    it 'should parse' do
+      tests.each do |test|
+        expression      = test.first
+        expected_values = test.last
+
+        template            = described_class.new(expression)
+        placeholder_values  = template.placeholders.map(&:value)
+
+        expect(placeholder_values).to eq(expected_values)
+      end
+    end
+  end
+end

data/stringento.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require './lib/stringento/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'stringento'
+  s.version     = Stringento::VERSION
+  s.summary     = 'Configurable Data Shaper'
+
+  s.description = <<-DESCRIPTION
+    Stringento is a configuration-based object graphing tool which can turn a flat, single dimensional dataset into a structure of deeply nested objects.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/stringento'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_development_dependency('faker', '~>1')
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pdf-inspector', '~>1')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rspec', '~> 3.8')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: stringento
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: "    Stringento is a configuration-based object graphing tool which can
+  turn a flat, single dimensional dataset into a structure of deeply nested objects.\n"
+email:
+- mruggio@bluemarblepayroll.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- bin/console
+- lib/stringento.rb
+- lib/stringento/formatter.rb
+- lib/stringento/placeholder.rb
+- lib/stringento/resolver.rb
+- lib/stringento/stringento.rb
+- lib/stringento/template.rb
+- lib/stringento/version.rb
+- spec/examples/custom_formatter.rb
+- spec/examples/indifferent_hash_resolver.rb
+- spec/examples/nested_hash_resolver.rb
+- spec/spec_helper.rb
+- spec/stringento/formatter_spec.rb
+- spec/stringento/placeholder_spec.rb
+- spec/stringento/resolver_spec.rb
+- spec/stringento/stringento_spec.rb
+- spec/stringento/template_spec.rb
+- stringento.gemspec
+homepage: https://github.com/bluemarblepayroll/stringento
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Configurable Data Shaper
+test_files:
+- spec/examples/custom_formatter.rb
+- spec/examples/indifferent_hash_resolver.rb
+- spec/examples/nested_hash_resolver.rb
+- spec/spec_helper.rb
+- spec/stringento/formatter_spec.rb
+- spec/stringento/placeholder_spec.rb
+- spec/stringento/resolver_spec.rb
+- spec/stringento/stringento_spec.rb
+- spec/stringento/template_spec.rb