informed 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba5433e00f3520fb5d488f0597c86df6a260a57f
-  data.tar.gz: c8cdfb9e6130b1c503204062c5b09b03e2b69167
+  metadata.gz: adf838ca0c97d9b596e359fbf1f00b3b3ed43741
+  data.tar.gz: d5b0f8cf5710c337de5a1fe6829c68eebd9554f2
 SHA512:
-  metadata.gz: 0bed52a50511a9201dc57fbd52f8cf52e1c954f5e5dc28657dc20cd6d7ffb527d94fbb61b972f3df94b94446e110d2d063296515a7176bc44a4bf074558d924f
-  data.tar.gz: f35acc7f08150778f5808ff033eabb777232e0745182f74dcaf2db8ef5f816679b4a348963c10cf06596318f344f46be6c17de64bf8859841e79d6b5bfe78932
+  metadata.gz: af8d33e7c1438f0139f50274b93f9b87090678a0545ea8802174d0d0c28978b0bae952d0f1accb6ad73211b503e902023daaaf0a53e962df9c6f3414d92db758
+  data.tar.gz: e4aa31fa863c16b9dcb65684b94b77b58a718941e8be381eb136dc9a814c95686eda2e941055eccec3ca40f0e2a65130a18865b6dbb5b46fd59a4e881ab2feac

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+### 1.1.1
+#### Bug Fixes
+* [#11](https://github.com/wecohere/informed/pull/11) - Prioritize keyword args over method calls when there are name collisions
+
+### 1.1.0 
+
+#### Enhancements
+* [#2](https://github.com/wecohere/informed/pull/2) - Support methods that take blocks
+* [#1](https://github.com/wecohere/informed/pull/1) - Include the class name in log messages
+
+### 1.0.0
+Initial release, provides `inform_on` syntax at the class level.

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+## Contributing to Informed Ruby
+This extends the [Informed Contributor Document](../CONTRIBUTING.md) to add Ruby specific guidance.
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+If you want to  test across all supported ruby versions, make sure you have [`rbenv`](https://github.com/rbenv/rbenv) and [ruby-build](https://github.com/rbenv/ruby-build) installed; then run `bin/setup-matrix` to install all the gems across all the versions and `bin/test-matrix` to run all the tests.
+
+To install this gem on your local machine, run `bundle exec rake install`. 
+
+### Releasing
+
+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).
+
+

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    informed (1.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.3)
+    minitest-documentation (1.0.0)
+      minitest (~> 5.2)
+    rake (10.5.0)
+    yard (0.9.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  informed!
+  minitest (~> 5.0)
+  minitest-documentation (~> 1.0)
+  rake (~> 10.0)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -1,23 +1,4 @@
-# Informed
-![build status](https://api.travis-ci.org/wecohere/informed.svg?branch=primary)
-
-Informed improves application debuggability by:
-* Logging which methods were called.
-* Aggregating useful data, such as the result of the call, keyword arguments provided, or the result of related instance methods
-* Exposing when a method starts and finishes
-
-Informed does *not*:
-* Format logs. It provides a hash to the logger you provide, and it's up to you
-  to format your logs in a useful manner. This will depend on what log
-  aggregation system you are using.
-* Store logs. You will need to configure your applications logger correctly to
-  ensure logs will actually reach your log aggregator.
-* Provide useful analytics or performance tuning data. Logs are for informing
-  your incident detection system, debugging, and auditing. While one may get
-  *some* amount of metrics utility out of them, products oriented towards
-  exposing the insights you are looking for are generally better equipped for
-  that.
-
+Ruby language implementation of [Informed](../README.md), an event-logging library that helps you understand what's happening in your application.
 
 ## Usage
 
@@ -101,29 +82,6 @@ To do so either:
 * Define an instance method `logger` on the informed upon class and have it
   return whatever logger you want.
 
+## Contributing and Local Development
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`bin/test` 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/zincmade/informed. 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](http://opensource.org/licenses/MIT).
-
+See the [informed-ruby CONTRIBUTING.md](./CONTRIBUTING.md) for details.

data/bin/setup

@@ -3,6 +3,14 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install
+if [ ! -d "$(rbenv root)/plugins" ]; then
+  echo "Installing ruby-build"
+  mkdir -p "$(rbenv root)"/plugins
+  git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build
+fi
 
-# Do any other automated setup that you need to do here
+if [ ! -z ${RBENV_VERSION+x} ]; then
+  rbenv install -s $RBENV_VERSION
+  gem install bundler
+fi
+bundle install

data/bin/setup-matrix

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+supported_versions=(2.1.10 2.2.8 2.3.5 2.4.2)
+for version in "${supported_versions[@]}" ; do
+  RBENV_VERSION=$version bin/setup
+done

data/bin/test

@@ -1,14 +1,6 @@
 #!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
 
-set -e
-
-for version in $(rbenv versions --bare); do
-  export RBENV_VERSION=$version
-  ruby --version
-  ruby test/informed_test.rb
-done
-
-export RBENV_VERSION=''
-ruby --version
-ruby test/informed_test.rb --documentation
-
+bundle exec ruby test/informed_test.rb --documentation

data/bin/test-matrix

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+supported_versions=(2.1.10 2.2.8 2.3.5 2.4.2)
+for version in "${supported_versions[@]}" ; do
+  RBENV_VERSION=$version bundle exec ruby test/informed_test.rb --documentation
+done
+

data/lib/informed.rb

@@ -197,8 +197,8 @@ module Informed
         if also_log[:values]
           message[:values] = {}
           also_log[:values].each do |local|
-            message[:values][local] = keyword_arguments[local] if keyword_arguments.key?(local)
-            message[:values][local] = informee.send(local) if informee.respond_to?(local, true)
+            message[:values][local] ||= keyword_arguments[local] if keyword_arguments.key?(local)
+            message[:values][local] ||= informee.send(local) if informee.respond_to?(local, true)
           end
         end
         message

data/lib/informed/version.rb

@@ -1,3 +1,3 @@
 module Informed
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: informed
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Zee Spencer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,16 +87,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- bin/setup-matrix
 - bin/test
+- bin/test-matrix
 - bin/yard
 - bin/yardoc
 - bin/yri
@@ -124,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Informs on method calls so you know what your app is doing and why

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.2
-before_install: gem install bundler -v 1.15.4
-script: ruby test/informed_test.rb --documentation

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 zee@zincma.de. 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/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Zee Spencer
-
-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.