activemodel-logger_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03cd8fdb5370f00778fdcf3a7d4952e8857bcacb29e30041014e194f3aac3235
+  data.tar.gz: 729af26cecf79d7ab156b9d1154fb8de7ce2c36c96f688b1cce6ad1aaf65ab72
+SHA512:
+  metadata.gz: 6c867469fb7c706b018120990b0799d694078807feaa4f44bd6da5ff4e430459b4bd6d2d4d817efe4a4ef2773619d8d9c71a6cd9d1e84c435c58a64d00499ee4
+  data.tar.gz: a378e97948ddd807d86696b7ac1536cde072d3fa626b2baed4525a02b4c871cfe4c5157768ddb292255107a74a44da3e972dd2d4ffe8fb489bb91041d9d10879

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 cbielinski@acorns.com. 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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activemodel-logger_attributes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    activemodel-logger_attributes (0.1.0)
+      activemodel (> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    awesome_print (1.8.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel-logger_attributes!
+  awesome_print (~> 1)
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chris Bielinski
+
+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.

data/README.md

@@ -0,0 +1,55 @@
+# ActiveModel::LoggerAttributes
+
+This gem provides a convenient way to save `Logger` messages to an attribute on your model. Multiple logger attributes are supported.
+
+You may be also be interested in the (ActiveRecord version)[https://github.com/chrisb/activerecord-logger_attributes].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activemodel-logger_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemodel-logger_attributes
+
+## Usage
+
+Your attribute should ideally be an `Array` or anything that responds to `<<`.
+
+Defining the attribute is straightforward with `logger_attr`.
+
+```ruby
+class Book
+  include ActiveModel::Model
+
+  logger_attr :activity_log
+
+  # expanded version with defaults:
+  # logger_attr :activity_log, logger_class: ::Logger, logger_name: :activity_log_logger, logger_init: -> {}
+end
+```
+
+If you prefer selectively mixing in functionality, simply `include ActiveModel::LoggerAttributes`. If you have multiple logger attributes take care to avoid clobbering logger names.
+
+```ruby
+book = Book.new # previous log history is supported: Book.new activity_log: [..]
+book.activity_log_logger.info 'Finished initializing book'
+book.activity_log_logger.error 'Something went wrong!'
+book.activity_log # => ["I, [2018-02-05T09:59:37.871594 #34988]  INFO -- : Finished initializing book", "E, [2018-02-05T09:59:37.871960 #34988] ERROR -- : Something went wrong!"]
+```
+
+As you would expect `book.activity_log_logger` is an instance of `Logger`.
+
+By default, `logger_attr` will use `Logger` for the log class the logger's name; additionally, the logger `progname` will be set to your model's class name and attribute. Passing a block to `logger_init` is a convenient way to perform custom initialization on your logger's class. You may wish to override the default `progname` or perhaps set a log level:
+
+```ruby
+logger_attr :activity_log, logger_init: ->(l) { l.level = Logger::WARN }
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activemodel-logger_attributes.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_model/logger_attributes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = 'activemodel-logger_attributes'
+  spec.version = ActiveModel::LoggerAttributes::VERSION
+  spec.authors = ['Chris Bielinski']
+  spec.email = ['chris@shadow.io']
+  spec.licenses = ['MIT']
+  spec.summary = 'Write Ruby logger messages to an ActiveModel attribute'
+  spec.description = 'Provides a Logger::LogDevice that can save Ruby Logger messages to an array in your model'
+  spec.homepage = "https://github.com/chrisb/activemodel-logger_attributes"
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency 'activemodel', '> 4', '< 6'
+  spec.add_development_dependency 'awesome_print', '~> 1'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_model/logger_attributes"
+require "awesome_print"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+class TestModel
+  include ActiveModel::Model
+
+  logger_attr :log, logger_class: ::Logger, logger_name: :logger, logger_init: ->(l) { l.level = ::Logger::WARN }
+end
+
+
+@foo = TestModel.new log: ['D, [2018-02-05T09:22:14.343646 #27967] DEBUG -- : logger_attr lives!']
+@foo.logger.debug "Debug message"
+@foo.logger.info "Info message"
+@foo.logger.warn "Warning message"
+@foo.logger.error "Error message"
+
+ap @foo.log
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_model/logger_attributes.rb

@@ -0,0 +1,59 @@
+require 'logger'
+require 'active_model'
+require 'active_model/logger_attributes/version'
+require 'active_model/logger_attributes/device'
+
+module ActiveModel
+  module LoggerAttributes
+    extend ActiveSupport::Concern
+
+    DEFAULT_OPTIONS = { logger_class: ::Logger, logger_name: nil, logger_init: -> {} }.freeze
+
+    InvalidAttributeValue = Class.new(RuntimeError)
+
+    module ClassMethods
+      def logger_attr(attribute, options = {})
+        attribute = attribute.to_sym
+        @logger_attributes ||= {}
+        @logger_attributes[attribute] = DEFAULT_OPTIONS.merge(options)
+        @logger_attributes[attribute][:logger_name] ||= "#{attribute}_logger"
+        define_logger_attr_initializer(attribute)
+        define_logger_attr_accessor(attribute)
+        attr_accessor(attribute)
+      end
+
+      def define_logger_attr_initializer(attribute)
+        options = @logger_attributes[attribute]
+        define_method(:"initialize_#{options[:logger_name]}") do
+          define_attr_logger_attribute(attribute)
+          logger = logger_for_logger_attribute(attribute, options[:logger_class], &options[:logger_init])
+          instance_variable_set :"@#{options[:logger_name]}", logger
+        end
+      end
+
+      def define_logger_attr_accessor(attribute)
+        options = @logger_attributes[attribute]
+        define_method(options[:logger_name]) do
+          instance_variable_get(:"@#{options[:logger_name]}") || send(:"initialize_#{options[:logger_name]}")
+        end
+      end
+    end
+
+    def logger_for_logger_attribute(attribute, logger_class, &block)
+      device = ActiveModel::LoggerAttributes::Device.new(attribute, self)
+      logger_class.new(device).tap do |l|
+        l.progname = "#{self.class.name}.#{attribute}" if l.respond_to?(:progname)
+        yield l if block_given?
+      end
+    end
+
+    # ensure the attribute itself has been initialized...
+    def define_attr_logger_attribute(attribute)
+      instance_variable_set(:"@#{attribute}", []) unless instance_variable_get(:"@#{attribute}")
+      return if instance_variable_get(:"@#{attribute}").respond_to?(:<<)
+      raise InvalidAttributeValue, "invalid type for attribute #{attribute}: #{send(attribute).class}"
+    end
+  end
+end
+
+ActiveModel::Model.send :include, ActiveModel::LoggerAttributes

data/lib/active_model/logger_attributes/device.rb

@@ -0,0 +1,18 @@
+module ActiveModel
+  module LoggerAttributes
+    class Device < ::Logger::LogDevice
+      def initialize(attribute, model)
+        @attribute = attribute
+        @model = model
+      end
+
+      def write(message)
+        @model.send(@attribute) << message.strip
+      end
+
+      def close
+        # noop
+      end
+    end
+  end
+end

data/lib/active_model/logger_attributes/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module LoggerAttributes
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-logger_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Bielinski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides a Logger::LogDevice that can save Ruby Logger messages to an
+  array in your model
+email:
+- chris@shadow.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activemodel-logger_attributes.gemspec
+- bin/console
+- bin/setup
+- lib/active_model/logger_attributes.rb
+- lib/active_model/logger_attributes/device.rb
+- lib/active_model/logger_attributes/version.rb
+homepage: https://github.com/chrisb/activemodel-logger_attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Write Ruby logger messages to an ActiveModel attribute
+test_files: []