pretty_feed 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17c30588dd58871f5a984e967e4e808d52da0acabebdf584a26c2dae1b347949
-  data.tar.gz: a1f8d1b0a9a535c479db007b81df251a480f231a7b8748cf565a57b31f36cbb0
+  metadata.gz: 33dc8684562bed8df172595936b8fd7669c442e65c436dc4fca6a7c535a69c27
+  data.tar.gz: 2ad30b05ca9d1122336ad43056dc7fe0fcb139df671c6affc5e504da6cf97b59
 SHA512:
-  metadata.gz: 15ed9ff39b39eec2cd158cdd4812e771b125ed07cb2c380b92063db59bc37f9600c7e85598b85a54c22478afa843574744020997647242fac4685753013eea7c
-  data.tar.gz: d399c722f2e9c964e7214e3cb519be946ca14625e23c6098bb73e2d51f56e27ac8cc25317286a0f3d7cdbdd7c53e84b1d4fcd2bc317f939015d4a6b7f5f4bf2d
+  metadata.gz: 58bbaf39fb718f7c2b8f0a2d6f701cb9434e89713901dbfc5f3ab1eb47154b118c93df2ccc5ec32243e1395e7696a58b223647822aa94f354f3e8caaf9fa2ecf
+  data.tar.gz: b2e92fdad45349185671ebe130a1156844afb935f94d0af8e579a834d55262ad44a03e9c7bc82e6f534dd783ce1b4f1739e882615b5da5fca2de78dcb02a5656

data/CHANGELOG.md

@@ -11,6 +11,27 @@
 
 ### Removed
 
+## [0.2.0] - 2022-03-21
+
+### Fixed
+
+* Misleading documentation has been corrected
+
+
+## [0.1.1] - 2022-03-21
+
+### Added
+
+* 100% test coverage
+
+### Changed
+
+* Improved `warn` text when stub color methods added to instances of String.
+
+### Fixed
+
+* Handling of frozen strings
+
 
 ## [0.1.0] - 2022-03-21
 

data/README.md

@@ -2,8 +2,6 @@
 
 PrettyFeed is a modulizer you can include in a job, worker, class, rake task, etc, which allows for simple pass/fail logging colorization.  Defaults are `truthy: 'green'` and `falsey: 'red'`.
 
-If `ColorizedString` (from the [`colorize` gem](https://github.com/fazibear/colorize) is defined it will use that.  It is preferred because it doesn't pollute the `String` class with color methods.  Alternatively, it will work with strings that respond to the colors you select as methods on the `String` instance.  This means it should work with `colored2`, `awesome_print`, and many other similar gems.  If your strings do not respond to color methods there will be a `warn` message printed to STDERR.  Colors available depend on the gem you use to provide the color methods!
-
 While this gem has no direct dependencies, it won't accomplish do much for you unless you are using a "console output coloring" gem of some kind.
 
 ## Installation
@@ -23,9 +21,9 @@ namespace :scrub do
     task :blurb => :environment do |_t, _args|
         include PrettyFeed::PfTf.new(truthy: 'green', falsey: 'blue')
         pftf("this will be green", true)
-        # => "this will be green" # in the console
+        # => "this will be green: true" # in the console
         pftf("this will be blue", false)
-        # => "this will be blue" # in the console
+        # => "this will be blue: false" # in the console
     end
 end
 ```
@@ -37,11 +35,21 @@ namespace :scrub do
     task :blurb => :environment do |_t, someth|
         include PrettyFeed::PfTf.new(truthy: 'green', falsey: 'blue')
         pftf("might be green or blue", someth, ->(a) { a })
-        # => the color will depend on what someth is and how the proc evaluates it.
+        # => "might be green or blue: #{someth}" # in the console
+        #     NOTE: the color will depend on what someth is and whether the proc evaluates as truthy or falsey.
     end
 end
 ```
 
+### Defaults
+
+`ColorizedString` (from the [`colorize` gem](https://github.com/fazibear/colorize)) will be used if it is `defined?`.  I prefer it because it doesn't pollute the `String` class with color methods.
+
+### Options
+
+It will also work with strings that respond to the colors you select as methods on the `String` instance.  This means it should work with `colored2`, `awesome_print`, and many other similar gems.  If your strings do not respond to color methods there will be a `warn` message printed to STDERR.  Colors available depend on the gem you use to provide the color methods!  The various gems do not have uniform sets of colors, nor names of colors.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pretty_feed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrettyFeed
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pretty_feed
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Boling
@@ -126,10 +126,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/pboling/pretty_feed
-  source_code_uri: https://github.com/pboling/pretty_feed/tree/v0.1.1
-  changelog_uri: https://github.com/pboling/pretty_feed/blob/v0.1.1/CHANGELOG.md
+  source_code_uri: https://github.com/pboling/pretty_feed/tree/v0.2.0
+  changelog_uri: https://github.com/pboling/pretty_feed/blob/v0.2.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/pboling/pretty_feed/issues
-  documentation_uri: https://www.rubydoc.info/gems/pretty_feed/0.1.1
+  documentation_uri: https://www.rubydoc.info/gems/pretty_feed/0.2.0
   wiki_uri: https://github.com/pboling/pretty_feed/wiki
   rubygems_mfa_required: 'true'
 post_install_message: