dumb-logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a310511e9401162dbea1264cfc0688d9bd1b4fb
+  data.tar.gz: 811167e870e502ece41b9ec4a0172036c506ec84
+SHA512:
+  metadata.gz: 3c6dc6168a885f2c18284fdc58cafa7cb14dee853795216007462e702717ca4530f1dc4268c25b90d6e2b755d5a5dd119d2613495a4a8a94f31fcf8b90e8fdfc
+  data.tar.gz: 1004d15fe2bf9e469e47fa90621821ef47ff877c41289c67b115a73357ab4fb62ddbd7cb1aca9453ee29bbec08545b064fcc9b39c4d2cf72bcb2495199e01e6b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.yardopts

@@ -0,0 +1,7 @@
+--title 'DumbLogger Simple Logger'
+--no-private
+--charset utf-8
+--markup markdown
+--files 'LICENCE*'
+'lib/**/*.rb'
+'features/**/*.rb'

data/Gemfile

@@ -0,0 +1,37 @@
+source('https://rubygems.org/')
+
+#
+# All the dependencies *were* in jene.gemspec, but Bundler is
+# remarkably stupid about gems needed *by* the gemspec.
+#
+#gemspec
+
+RUBY_ENGINE	= 'ruby' unless (defined?(RUBY_ENGINE))
+
+group(:default, :development, :test) do
+  gem('bundler',	'>= 1.0.7')
+  gem('versionomy',	'>= 0.4.4')
+  gem('debugger',	'>= 0',
+      :platforms	=> [
+                            :mri_19,
+                            :mri_20,
+                           ])
+  gem('ruby-debug',	'>= 0',
+      :platforms	=> [
+                            :mri_18,
+                           ])
+
+  gem('dumb-logger',
+      :path		=> '.')
+end
+
+group(:test, :development) do
+  gem('aruba')
+  gem('cucumber')
+  gem('rake')
+  gem('redcarpet',	'< 3.0.0')
+  gem('test-unit',
+      :require		=> 'test/unit')
+  gem('rdoc')
+  gem('yard',		'~> 0.8.6')
+end

data/LICENCE.md

@@ -0,0 +1,203 @@
+```
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```

data/README.md

@@ -0,0 +1,166 @@
+# DumbLogger
+
+*As though there weren't enough Ruby gems for logging.. here's another one!*
+
+`DumbLogger` is a very simple package for logging messages, typically
+for command-line applications.  You simply instantiate the class, set
+the maximum log-level required for messages to be displayed, and
+subsequently invoke the `#message` method with the text and
+appropriate level associated with it.  If the logger's maximum level
+is greater than or equal to the message's, the text will be written to
+the logging sink.
+
+Alternatively, you can instead treat logging levels as bitmasks
+(*e.g.*, "bit 3 means log network activity"), and messages will be
+sent to the logging sink if any of the set bits in their mask are also
+set in the logger's mask.
+
+Messages with a loglevel (or mask) of `0` **always** get written to
+the sink.
+
+By default, `DumbLogger` uses a sink of `$stderr`, but you can tell it
+to write messages somewhere else.  If the sink is a file that needs to
+be opened, by default new text will be appended to any existing
+content, but you can cause it to rewind and truncate the file before
+writing.  If you change sinks and the current one was opened as a
+file, it will be closed before switching to the new sink.
+
+Sinks can be filenames, symbols, or streams (instances of `IO`);
+append-mode doesn't apply to streams.
+
+Two special sink symbols are recognised: **:$stderr** and
+**:$stdout**.  Assigning the logger sink to either of these will
+result in the sink stream being re-evaluated on each and every message
+transmission.  This can be useful if `$stderr` or `$stdout` might get
+redirected during application operation.
+
+Text is logged using the `#message` method, which takes an arbitrary
+number of strings, symbols, integers, and hashes as arguments.
+
+* The last integer in the argument list will be used as the message's
+  level;
+* Any hashes in the argument list will be merged and used as options;
+  and
+* If the argument contains multiple strings, each one will be written
+  on a separate line.
+
+Global options that can be set with `#new` include:
+
+* whether files should be opened in append mode;
+* whether loglevels are integers or bitmasks; 
+* what the maximum logging level, or active logging bitmask, is;
+* where messages should be sent (the sink); and
+* a string that should be prefixed to each line written to the sink.
+
+You can define labels (names) for logging level values, so you can use
+them in subsequent calls.  In addition, defining a named level creates
+that method on the instance tied to that level.  That is, these are
+equivalent:
+
+```
+daml = DumbLogger.new(:labels => { :info => 0, :debug => 4 })
+daml.info('Level 0 message')
+daml.debug('Level 4 message')
+
+daml = DumbLogger.new
+daml.message(0, 'Level 0 message')
+daml.message(4, 'Level 4 message')
+```
+
+Options that can be set on a per-`#message` basis include:
+
+* a prefix string specific to the message (temporarily overriding the
+  default set at instantiation time); and
+* whether the (last) line of the message should be terminated with a
+  newline or not.  (Useful for multi-stage "`Doing foo: done`" type
+  messages.) **Note:** This is done by either including `DumbLogger::NO_NL`
+  in the argument list, or `{ :newline => false }` as part of an option
+  hash.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem('dumb-logger')
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dumb-logger
+
+## Usage
+
+```ruby
+require('dumb-logger')
+
+#
+# Create a logger with integer levels, a max level of 5, and
+# everything else defaulted:
+#
+duml = DumbLogger.new(:loglevel => 5)
+
+#
+# Will not be written to the sink ($stderr):
+#
+duml.message(6, 'Silent message!')
+
+#
+# Will be written to the sink no matter what:
+#
+# => "Logger started!  Neener, neener!\n"
+#
+duml.message(0, 'Logger started!  Neener, neener!')
+
+#
+# Two lines will be logged with the prefix '[DEMO] ':
+#
+# => "[DEMO] This is line 1\n[DEMO] This is line 2\n"
+#
+# Note that the default loglevel is 0, which means 'always send'.
+#
+duml.message('This is line 1', { :prefix => '[DEMO] ' }, 'This is line 2')
+
+#
+# Two lines will be sent to the sink, but the second one will *not*
+# end with a newline:
+#
+# => "This will destroy your life.\nAre you sure? "
+#
+duml.message(DumbLogger::NO_NL,
+             'This will destroy your life',
+             'Are you sure? ')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/RoUS/dumb-logger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Licence
+
+`DumbLogger` is copyright © 2015 by Ken Coar, and is made available
+under the terms of the Apache Licence 2.0:
+
+```
+   Copyright © 2015 Ken Coar
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```

data/Rakefile

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+#--
+#   Copyright © 2015 Ken Coar
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#++
+
+require('rubygems')
+require('fileutils')
+
+Proc.new {
+  libdir = File.join(File.dirname(__FILE__), 'lib')
+  xlibdir = File.expand_path(libdir)
+  $:.unshift(xlibdir) unless ($:.include?(libdir) || $:.include?(xlibdir))
+}.call
+
+require('dumb-logger')
+
+require('rake')
+
+topdir = File.dirname(__FILE__)
+
+include Rake::DSL
+
+require('bundler/gem_tasks')
+
+require('rake/testtask')
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern	= 'test/**/test_*.rb'
+  test.verbose	= true
+end
+
+require('cucumber/rake/task')
+Cucumber::Rake::Task.new(:features)
+
+task(:default => :test)
+
+require('yard')
+#require('yard-method-overrides')
+YARD::Rake::YardocTask.new
+
+Dir['tasks/**/*.rake'].each { |t| load t }