cinnamon_serial 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4b1f1e130c735d90a575a5526bb4ff4b8d1b8e7
-  data.tar.gz: b021efb4fd143f8deb4ed52392b2227c0873e643
+SHA256:
+  metadata.gz: 85e032792b5bfaa51e52499f47b3c43c8367342330a43e4d3995b0c6eeb3437e
+  data.tar.gz: 7795256430a84d39483ceb14ea8d1c9c35eee2d20d67912076762080d3373ca7
 SHA512:
-  metadata.gz: 48a8172d0abc8757bd2ffaa53e3aed4b02b9f982edf0ec9d7c6be8a4f2dfde9d83c46ccb900a31d55efb7c9938385b298192bff0dfbbd7a8175e673a26b9569e
-  data.tar.gz: a6c314e747ad984603bcbe3975e0254f481f12fdd7aed6f5aff5b9c34852027d09471d5029bba6691392a187ed951fbb6468d47fef31d2ddad8c463eaa037744
+  metadata.gz: f847c7f35e95f58b59348c337700ed0a05fa231f5586a384e2613583d8ad0b2ba090b64f74a9dadf76b1f60b3cfa582e2a3403f9ce8956604acc8238d829f14b
+  data.tar.gz: 001d1ab8ad80bc2eaf7f64bc8702472f8cb0c6f30c2826e1454b131db52319bea44a50b8a9e41e94321a9968b3cd5bc8cef4be7352f410b69c16774a6d483981

data/.gitignore

@@ -1,2 +1,4 @@
 .DS_Store
 *.gem
+/tmp
+/coverage

data/.rubocop.yml

@@ -5,3 +5,9 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   Max: 20
+
+Metrics/BlockLength:
+  ExcludedMethods: ['it', 'describe', 'context', 'let', 'specify']
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+2.6.0

data/.travis.yml

@@ -1,8 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=929b1dd2a9ccbfa28740405a6471ca20da6aa8eacbf8cf1b6c4c7e632bbe9acd
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.3.7
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script:
   - bundle exec rubocop
   - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 2.1.1 (January 30th, 2019)
+
+Maintenance Release
+
+* Added bin/console script
+* Added CHANGELOG
+* Updated README with publication steps, additional testing steps
+* Bumped minimum Ruby to 2.3.8
+* Added Guard

data/Gemfile.lock

@@ -1,24 +1,56 @@
 PATH
   remote: .
   specs:
-    cinnamon_serial (2.1.0)
+    cinnamon_serial (2.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    jaro_winkler (1.5.1)
-    method_source (0.9.0)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    docile (1.3.1)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    pry (0.11.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rainbow (3.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -32,25 +64,39 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.2)
+    rubocop (0.63.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   cinnamon_serial!
-  pry (~> 0.11)
+  guard-rspec (~> 4.7)
   rspec (~> 3.8)
-  rubocop (~> 0.59.2)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
-   1.16.3
+   1.17.2

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,6 +1,6 @@
 # Cinnamon Serial
 
-[![Build Status](https://travis-ci.org/bluemarblepayroll/cinnamon_serial.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/cinnamon_serial)
+[![Gem Version](https://badge.fury.io/rb/cinnamon_serial.svg)](https://badge.fury.io/rb/cinnamon_serial) [![Build Status](https://travis-ci.org/bluemarblepayroll/cinnamon_serial.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/cinnamon_serial)  [![Maintainability](https://api.codeclimate.com/v1/badges/0e4c93d2bde984836e97/maintainability)](https://codeclimate.com/github/bluemarblepayroll/cinnamon_serial/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0e4c93d2bde984836e97/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/cinnamon_serial/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 A common issue is that we typically want different data going
 outbound than what we have available server-side.  Some example motivations could be:
@@ -204,9 +204,37 @@ Basic steps to take to get this repository compiling:
 To execute the test suite run:
 
 ````
-rspec
+bundle exec rspec spec --format documentation
 ````
 
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+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/cinnamon_serial/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 cinnamon_serial`
+7. Publish package to RubyGems: `gem push cinnamon_serial-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`
+
 ## License
 
 This project is MIT Licensed.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cinnamon_serial'
+
+# 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

data/cinnamon_serial.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/cinnamon_serial'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.1'
+  s.required_ruby_version = '>= 2.3.8'
 
-  s.add_development_dependency('pry', '~> 0.11')
+  s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('rspec', '~> 3.8')
-  s.add_development_dependency('rubocop', '~> 0.59.2')
+  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

data/lib/cinnamon_serial/formatting.rb

@@ -24,7 +24,7 @@ module CinnamonSerial
       end
 
       def percent(num)
-        present?(num) ? format('%.2f %', num) : ''
+        present?(num) ? format('%.2f %%', num) : ''
       end
 
       def present?(value)

data/lib/cinnamon_serial/version.rb

@@ -8,5 +8,5 @@
 #
 
 module CinnamonSerial
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

data/spec/{base_spec.rb → cinnamon_serial/base_spec.rb}

@@ -7,9 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require 'date'
-require 'pry'
-require './lib/cinnamon_serial'
+require './spec/spec_helper'
 require './spec/examples'
 
 describe CinnamonSerial::Base do

data/spec/{dsl_spec.rb → cinnamon_serial/dsl_spec.rb}

@@ -7,10 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require 'date'
-require 'pry'
-require './lib/cinnamon_serial'
-require './spec/examples'
+require './spec/spec_helper'
 
 describe CinnamonSerial::Dsl do
   let(:employee_list_keys) do

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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 'date'
+require 'pry'
+
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
+require './lib/cinnamon_serial'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cinnamon_serial
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,18 +44,47 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.63.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        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: "    Domain-specific language for serialization specification.\n"
 email:
 - mruggio@bluemarblepayroll.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,10 +94,13 @@ files:
 - ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
+- bin/console
 - cinnamon_serial.gemspec
 - lib/cinnamon_serial.rb
 - lib/cinnamon_serial/base.rb
@@ -78,9 +110,10 @@ files:
 - lib/cinnamon_serial/resolver.rb
 - lib/cinnamon_serial/specification.rb
 - lib/cinnamon_serial/version.rb
-- spec/base_spec.rb
-- spec/dsl_spec.rb
+- spec/cinnamon_serial/base_spec.rb
+- spec/cinnamon_serial/dsl_spec.rb
 - spec/examples.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/cinnamon_serial
 licenses:
 - MIT
@@ -93,19 +126,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Domain-specific language for serialization specification.
 test_files:
-- spec/base_spec.rb
-- spec/dsl_spec.rb
+- spec/cinnamon_serial/base_spec.rb
+- spec/cinnamon_serial/dsl_spec.rb
 - spec/examples.rb
+- spec/spec_helper.rb