tree_branch 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8473f9c14965c2a57e95f136405bb04e54bf0b3d724d583ed9016db22f51a3c7
-  data.tar.gz: 0706b615ecf17999274cedb975ba943eaf9b07021645f762ba899f8ee79bbed7
+  metadata.gz: 295f232a71033c42f3fa2eede7a9f78637a9b1a2b8ca165f92a2cfe67f92c10a
+  data.tar.gz: 611148e278d08ab9bd90277ff04c4a1239a5faca97cb2d9a669a622e362354bd
 SHA512:
-  metadata.gz: 9a71be4ef99284701a9ab2c776beac29062bb874b197f000b8f9d8c24c74ba8464e840783e4300e1b8528f064e9ba3cea232e8554e0849147378c45d9028737d
-  data.tar.gz: 5560bc79fee28eed4570badba20ece7d269fd4b363f139f4fe6117292236739a711f9cf1d8666d5f634bd70e2ee8079895c0f21c44c208216936d7ad4fae62a6
+  metadata.gz: afe8a2a94158b18b76fb3c2a7021769c57ed607967a523e73c41b999b7ea3c5d7dbbc695ae48087d5abc76687c449b802e11fb0652a094cc47685a3e7b2e3998
+  data.tar.gz: 745fa57dacae0336f5f9fd312c53e65aa4a7b5312f706409c076c6b2a0d23b398e10962dc959b9a5c2a86d7dd5fe56d54b3f562d2a624cdc13b3f3ffa321252c

data/.gitignore

@@ -2,3 +2,6 @@
 *.gem
 /tmp
 /coverage
+
+# https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.6.0
+2.6.3

data/.travis.yml

@@ -5,9 +5,9 @@ language: ruby
 rvm:
   # 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
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
@@ -18,3 +18,8 @@ script:
   - bundle exec rspec
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -1,6 +1,16 @@
+# 1.0.1 (June 28th, 2019)
+
+Maintenance Release
+
+* Fixed a Readme bug where the StateComparator example incorrectly referenced context as an object instead of a Hash.
+* Other minor README.md changes to improve clarity.
+* Updated Ruby versions used for testing.
+* Added a default Rake task to run all checks.
+* Removed Gemfile.lock from version control.
+
 # 1.1.0 (February 5th, 2019)
 
-Maintance Release
+Maintenance Release
 
 * Updated Dependencies
 * Installed SimpleCov

data/README.md

@@ -12,7 +12,7 @@ And the output is defined as:
 
 1. Compared and/or converted tree structure (root node)
 
-The specific use-case this was designed for was a dynamic web application menu. In this specific example, we wanted either a static file or a database to store and define all possible menus. Then we wanted to input a request's lifecycle context (user, url, parameters, authorization, etc.) and return the menu that matched the current spot in the application.
+The specific use-case this was designed for was a dynamic web application menu. In this specific example, we wanted either a static file or a database to store and define all possible menus. Then we wanted to input a request's lifecycle context (user, URL, parameters, authorization, etc.) and return the menu that matched the current spot in the application.
 
 ## Installation
 
@@ -62,7 +62,7 @@ menu = {
       ]
     }
   ]
-}
+}.freeze
 ````
 
 There are three application states:
@@ -85,10 +85,11 @@ class StateComparator < ::TreeBranch::Comparator
     none: %i[open],
     passive: %i[open save close print],
     active: %i[open save close print cut copy paste]
-  }
+  }.freeze
+  private_constant :STATE_OPS
 
   def valid?
-    data.command.nil? || Array(STATE_OPS[context.state]).include?(data.command)
+    data.command.nil? || Array(STATE_OPS[context[:state]]).include?(data.command)
   end
 end
 ````
@@ -97,21 +98,21 @@ Finally, we can process this for all three states:
 
 ````ruby
 no_file_menu =
-  ::TreeBranch.process(
+  TreeBranch.process(
     node: menu,
     comparators: StateComparator,
     context: { state: :none }
   )
 
 passive_file_menu =
-  ::TreeBranch.process(
+  TreeBranch.process(
     node: menu,
     comparators: StateComparator,
     context: { state: :passive }
   )
 
 active_file_menu =
-  ::TreeBranch.process(
+  TreeBranch.process(
     node: menu,
     comparators: StateComparator,
     context: { state: :active }
@@ -291,8 +292,8 @@ Notice now our read-only menu is missing the 'save' item.
 
 There are two ways to create comparators:
 
-1. Subclass ::TreeBranch::Comparator and implement the ```valid?``` method to return true/false
-2. Create lambda/proc that accepts two arguments: data and context and returns true/false
+1. Subclass ::TreeBranch::Comparator and implement the ```valid?``` method to return true/false.
+2. Create lambda/proc that accepts two arguments: data and context and returns true/false.
 
 Option one is shown in the above example, while option two can be illustrated as:
 
@@ -302,7 +303,7 @@ auth_comparator = lambda do |data, context|
 end
 
 passive_read_only_menu =
-  ::TreeBranch.process(
+  TreeBranch.process(
     node: menu,
     comparators: [StateComparator, auth_comparator],
     context: { state: :passive }
@@ -313,14 +314,14 @@ passive_read_only_menu =
 
 After a node has been compared and is deemed to be valid, it will either return one of two things:
 
-1. ::TreeBranch::Node instance
-2. The return of the block passed into the process method produced *(Note: If nil it will be ignored as if it was invalid.)*
+1. A `TreeBranch::Node` instance.
+2. The return value of the block passed into the process method. *Note: If the block returns `nil` then it will be ignored as if it was invalid.*
 
-In our above example we did not pass in a block so they would all return Node instances.  The passed in block is your chance to return instances of another class, or even do some other post-processing routines.  For example, lets return an instance of a new type: MenuItem as shown below:
+In our above example, we did not pass in a block so they would all return Node instances.  The passed in block is your chance to return instances of another class, or even do some other post-processing routines.  For example, lets return an instance of a new type: MenuItem as shown below:
 
 ````ruby
 class MenuItem
-  acts_as_hashable
+  acts_as_hashable # Provided by https://github.com/bluemarblepayroll/acts_as_hashable
 
   attr_reader :menu_items, :name
 
@@ -333,9 +334,7 @@ class MenuItem
     name == other.name && menu_items == other.menu_items
   end
 
-  def ==(other)
-    eql?(other)
-  end
+  alias == eql?
 end
 ````
 
@@ -343,7 +342,7 @@ We can now convert this in the block:
 
 ````ruby
 passive_read_write_menu =
-  ::TreeBranch.process(
+  TreeBranch.process(
     node: menu,
     comparators: [StateComparator, auth_comparator],
     context: { state: :passive, rights: :write }
@@ -385,10 +384,10 @@ Our resulting data set (visualized as a hash):
 Basic steps to take to get this repository compiling:
 
 1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check tree_branch.gemspec for versions supported)
-2. Install bundler (gem install bundler)
-3. Clone the repository (git clone git@github.com:bluemarblepayroll/tree_branch.git)
-4. Navigate to the root folder (cd tree_branch)
-5. Install dependencies (bundle)
+2. Install bundler (`gem install bundler`)
+3. Clone the repository (`git clone git@github.com:bluemarblepayroll/tree_branch.git`)
+4. Navigate to the root folder (`cd tree_branch`)
+5. Install dependencies (`bundle`)
 
 ### Running Tests
 
@@ -410,6 +409,12 @@ Also, do not forget to run Rubocop:
 bundle exec rubocop
 ````
 
+Note that the default Rake tasks runs both test and Rubocop:
+
+```
+bundle exec rake
+```
+
 ### Publishing
 
 Note: ensure you have proper authorization before trying to publish new versions.
@@ -417,14 +422,13 @@ 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/tree_branch/version.rb``` using [semantic versioning](https://semver.org/)
-3. Install dependencies: ```bundle```
-4. Update ```CHANGELOG.md``` with release notes
+2. Update `lib/tree_branch/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 tree_branch`
-7. Publish package to RubyGems: `gem push tree_branch-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).
+
+Note: ensure you have proper authorization before trying to publish new versions.
 
 ## License
 

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/lib/tree_branch/version.rb

@@ -8,5 +8,5 @@
 #
 
 module TreeBranch
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/tree_branch.gemspec

@@ -19,11 +19,14 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/tree_branch'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.1'
+  s.required_ruby_version = '>= 2.3.8'
 
   s.add_dependency('acts_as_hashable', '~>1.0')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('pry-byebug')
+  s.add_development_dependency('rake', '~> 12')
   s.add_development_dependency('rspec', '~> 3.8')
   s.add_development_dependency('rubocop', '~>0.63.1')
   s.add_development_dependency('simplecov', '~>0.16.1')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tree_branch
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !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: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,10 +152,10 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
+- Rakefile
 - bin/console
 - lib/tree_branch.rb
 - lib/tree_branch/comparator.rb
@@ -143,14 +185,14 @@ 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: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Compare a tree structure and return the tree structure that matches

data/Gemfile.lock

@@ -1,104 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tree_branch (1.1.0)
-      acts_as_hashable (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    acts_as_hashable (1.0.5)
-    ansi (1.5.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    ffi (1.9.25)
-    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.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (3.0.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    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.4.0)
-    ruby-progressbar (1.10.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
-  guard-rspec (~> 4.7)
-  rspec (~> 3.8)
-  rubocop (~> 0.63.1)
-  simplecov (~> 0.16.1)
-  simplecov-console (~> 0.4.2)
-  tree_branch!
-
-BUNDLED WITH
-   1.17.2