proforma 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fd1263c98986b0fe066881b0707f68a32b8c75262d40f4a1fb2da89b3caa1d3
-  data.tar.gz: 3fa0bee1c0ad96a6dfa8843fd419b9fbdfd4e199257746fd8e5729a6f8f1c44f
+  metadata.gz: c260f1210b23a42c9252116430e3993d63416d5c43e5e93e9bf1f6e3483ed550
+  data.tar.gz: 6fca2c4ab0df35f25bb3fc820cc086bdd13938b60a6d8964266d18ea3bb3a3d4
 SHA512:
-  metadata.gz: 1767931c31dc9c6cefae98b1e44e5c0726c21cc7a582ca9a69e547fdc70831a1d39a021d3d018c7caadd282715c95af8ba95f92daeb873551863824d9ca8e74a
-  data.tar.gz: 69eca8215670ca19c8c33d1d9b3cbd3bf3cdae4fe0f8c2bfc564443cfe2858e5678fa9600292529f8c17e989b0c02b285ddb67f31a2acc166d7f1ba40b65446d
+  metadata.gz: 0ef5837dd2296c4fcd60957157a0ac5b9c916c1b8eb8aa1d9e65e3cb5546c58fe25a0bc908c366fdcedc09da42de63bd23f830cb659f38b303d6394e0d9a0f87
+  data.tar.gz: f26bf7b4a7c0a6313ddfde158b09d6fd1f15294e228712cfdea3a16a4cceeafff7fc0a3545fbb27eec0c8c265582ea4f865ef68d2e5c80271919a325246bf33a

data/.gitignore

@@ -2,3 +2,4 @@
 *.gem
 /tmp
 /coverage
+/pkg

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+# 1.0.2 (May 3rd, 2019)
+
+* Updated acts_as_hashable dependency and removed extracted classes in favor of acts_as_hashable.
+
 # 1.0.1 (April 24th, 2019)
 
-* Image and aggregation property values should resolve to nil
+* Image and aggregation values should resolve to nil when property is blank.
 
 # 1.0.0 (April 24th, 2019)
 

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 oss@bluemarblepayroll.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.lock

@@ -1,15 +1,16 @@
 PATH
   remote: .
   specs:
-    proforma (1.0.1)
-      acts_as_hashable (~> 1)
+    proforma (1.0.2)
+      acts_as_hashable (~> 1, >= 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    acts_as_hashable (1.0.5)
+    acts_as_hashable (1.1.0)
     ansi (1.5.0)
     ast (2.4.0)
+    byebug (11.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
@@ -49,7 +50,11 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     rainbow (3.0.0)
+    rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
@@ -95,7 +100,9 @@ PLATFORMS
 DEPENDENCIES
   guard-rspec (~> 4.7)
   proforma!
-  pry (~> 0)
+  pry
+  pry-byebug (~> 3)
+  rake (~> 10.0)
   rspec (~> 3.8)
   rubocop (~> 0.63.1)
   simplecov (~> 0.16.1)

data/Guardfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-guard :rspec, cmd: 'bundle exec rspec' do
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 

data/README.md

@@ -316,14 +316,16 @@ Note: ensure you have proper authorization before trying to publish new versions
 After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
 
 1. Merge Pull Request into master
-2. Update ```lib/proforma/version.rb``` using [semantic versioning](https://semver.org/)
-3. Install dependencies: ```bundle```
-4. Update ```CHANGELOG.md``` with release notes
+2. Update `lib/proforma/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
 5. Commit & push master to remote and ensure CI builds master successfully
-6. Build the project locally: `gem build proforma`
-7. Publish package to RubyGems: `gem push proforma-X.gem` where X is the version to push
-8. Tag master with new version: `git tag <version>`
-9. Push tags remotely: `git push origin --tags`
+6. 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).
+
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/proforma/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/proforma.rb

@@ -15,13 +15,11 @@ require 'stringio'
 require_relative 'proforma/compiling'
 require_relative 'proforma/document'
 require_relative 'proforma/hash_evaluator'
-require_relative 'proforma/hash_refinements'
 require_relative 'proforma/model_factory'
 require_relative 'proforma/modeling'
 require_relative 'proforma/plain_text_renderer'
 require_relative 'proforma/prototype'
 require_relative 'proforma/template'
-require_relative 'proforma/type_factory'
 
 # The top-level API that should be seen as the main entry point into this library.
 module Proforma

data/lib/proforma/model_factory.rb

@@ -12,29 +12,26 @@ require_relative 'modeling'
 module Proforma
   # This class serves as a singleton that can make Proforma::Modeling components.
   class ModelFactory
-    REGISTRY = {
-      'Banner': Modeling::Banner,
-      'Collection': Modeling::Collection,
-      'DataTable': Modeling::DataTable,
-      'Grouping': Modeling::Grouping,
-      'Header': Modeling::Header,
-      'Pane': Modeling::Pane,
-      'Separator': Modeling::Separator,
-      'Spacer': Modeling::Spacer,
-      'Table': Modeling::Table,
-      'Text': Modeling::Text
-    }.freeze
-
-    class << self
-      extend Forwardable
-
-      def_delegators :factory, :array, :make
-
-      private
-
-      def factory
-        @factory ||= TypeFactory.new(REGISTRY)
-      end
-    end
+    acts_as_hashable_factory
+
+    register 'Banner', Modeling::Banner
+
+    register 'Collection', Modeling::Collection
+
+    register 'DataTable', Modeling::DataTable
+
+    register 'Grouping', Modeling::Grouping
+
+    register 'Header', Modeling::Header
+
+    register 'Pane', Modeling::Pane
+
+    register 'Separator', Modeling::Separator
+
+    register 'Spacer', Modeling::Spacer
+
+    register 'Table', Modeling::Table
+
+    register 'Text', Modeling::Text
   end
 end

data/lib/proforma/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Proforma
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/proforma.gemspec

@@ -23,10 +23,12 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.8'
 
-  s.add_dependency('acts_as_hashable', '~>1')
+  s.add_dependency('acts_as_hashable', '~>1', '>=1.1.0')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
-  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('pry-byebug', '~> 3')
+  s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency('rspec', '~> 3.8')
   s.add_development_dependency('rubocop', '~>0.63.1')
   s.add_development_dependency('simplecov', '~>0.16.1')

data/spec/spec_helper.rb

@@ -8,13 +8,18 @@
 #
 
 require 'yaml'
-
 require 'pry'
+require 'pry-byebug'
+
+unless ENV['DISABLE_SIMPLECOV'] == 'true'
+  require 'simplecov'
+  require 'simplecov-console'
 
-require 'simplecov'
-require 'simplecov-console'
-SimpleCov.formatter = SimpleCov::Formatter::Console
-SimpleCov.start
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter %r{\A/spec/}
+  end
+end
 
 require './lib/proforma'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: proforma
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +48,44 @@ dependencies:
   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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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
@@ -126,11 +160,13 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/console
 - bin/render
 - lib/proforma.rb
@@ -140,7 +176,6 @@ files:
 - lib/proforma/compiling/counter.rb
 - lib/proforma/document.rb
 - lib/proforma/hash_evaluator.rb
-- lib/proforma/hash_refinements.rb
 - lib/proforma/model_factory.rb
 - lib/proforma/modeling.rb
 - lib/proforma/modeling/banner.rb
@@ -166,7 +201,6 @@ files:
 - lib/proforma/plain_text_renderer.rb
 - lib/proforma/prototype.rb
 - lib/proforma/template.rb
-- lib/proforma/type_factory.rb
 - lib/proforma/version.rb
 - proforma.gemspec
 - spec/fixtures/bringing_it_all_together.txt

data/lib/proforma/hash_refinements.rb

@@ -1,20 +0,0 @@
-# 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.
-#
-
-module Proforma
-  # Let's provide a refinenment instead of monkey-patching Hash.  That way we can stop
-  # polluting other libraries and internalize our specific needs.
-  module HashRefinements
-    refine Hash do
-      def symbolize_keys
-        map { |k, v| [k.to_sym, v] }.to_h
-      end
-    end
-  end
-end

data/lib/proforma/type_factory.rb

@@ -1,46 +0,0 @@
-# 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.
-#
-
-module Proforma
-  # A TypeFactory object understands how to build objects using a special designated '$type' key.
-  class TypeFactory
-    using HashRefinements
-
-    DEFAULT_TYPE_KEY = :type
-
-    attr_reader :registry, :type_key
-
-    def initialize(registry = {}, type_key = DEFAULT_TYPE_KEY)
-      @registry = registry.symbolize_keys
-      @type_key = type_key
-
-      freeze
-    end
-
-    def array(objects = [])
-      objects = objects.is_a?(Hash) ? [objects] : Array(objects)
-
-      objects.map do |object|
-        object.is_a?(Hash) ? make(object) : object
-      end
-    end
-
-    def make(config = {})
-      config        = (config || {}).symbolize_keys
-      type          = config[type_key].to_s.to_sym
-      object_class  = registry[type]
-
-      raise ArgumentError, "cannot find section from type: #{type}" unless object_class
-
-      config_without_type = config.reject { |k| k == type_key }
-
-      object_class.new(config_without_type)
-    end
-  end
-end