sr_log 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1466e960b28cf99511139bf5f9c2305fd8b3b804
-  data.tar.gz: aefdd526b4ada8a77cf2e089601086b133a8fbe5
+  metadata.gz: 5db7707c0a77a5d4bac7ed154ebd05f6bd1983df
+  data.tar.gz: 4f7060824e0dd840c9e9f2d0e8bb5c589c27be41
 SHA512:
-  metadata.gz: 80c1f636473ce50dab0fab67b9a85c9a6a273e2da049f799532ff23b2828fb83a20f0a2e4858b66d716c483dbc8a82a97091f62a5d7114a1e90d34c779ed72dc
-  data.tar.gz: 20599ffb7a856e227dbc372e2c26e4e443fe42ec8294f8d89374522c8c13f150ae953f1228dbbbe6064a9468d23dbd232e2edc1d140631f0bc1d80366cc32afd
+  metadata.gz: 4b8f8e4dadbfc0b5908e8f601ffc8dd179c1e6bb9c66300014d20f009f9fc8ec6fd2c6c95c9a750e6fed77ffffc1e9881bf4aa86d0f3358c498baffd9934cc61
+  data.tar.gz: 72fb5b9b1bd642f38dde09c3f344a455cfb870a9bfd0daa7f59ab13bbf6a3514a177e6d81dd37a6b9aace7d6b625893e9716dc033ff8013250b8c3e7c70bbe1a

data/.gitignore

@@ -6,4 +6,5 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/test_logs/
 /tmp/

data/README.md

@@ -1,8 +1,6 @@
-# SrLog
+# sr_log
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sr_log`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+**sr_log** is a simple wrapper method around ruby's native `Logger` class. It allows you to write to multiple custom logfiles and serves the purpose of log rotation by prefixing the logfiles with a month stamp.
 
 ## Installation
 
@@ -22,20 +20,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To write to a logfile, call the global `sr_log` method.  For example:
 
-## Development
+```ruby
+sr_log :user_updates, "This is my message"
+```
 
-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.
+`sr_log` will create a `./log/2016_12_user_updates.log` file if one does not already exist (except that it will use current year/month for the prefix).  Then it will write the line "This is my message" to the logfile after a timestamp.
 
-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).
+Optionally you can pass named arguments to the `sr_log` method:
 
-## Contributing
+Argument: `:dir`, type: `string`. Use `:dir` to set a custom path for where the logfile is saved.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sr_log.
+Argument: `:current_user`, type: `Object`. Use `:current_user` to specify that the message is being logged by a use.  This will add a `"Logged by user: #{current_user}"` line after the timestamp in the logfile.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/sr_log/version.rb

@@ -1,3 +1,3 @@
 module SrLog
-  VERSION = '0.1.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sr_log
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sean Huber