activerecord-logger_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0a596fc30eb70879d8436fe31a77e137fa51104c3a8314e85163f85015cde35
+  data.tar.gz: 8e8278bd4d74391121b05ba095e399c5c668ff3041335aae6dc1b1190ac692cc
+SHA512:
+  metadata.gz: af460e7513e0e38844fd5d062f2081caac06adb2f9da2f918d6c86f5765c965ec9d5ca6465fc6d0fc717be13fe08671c1f4cfb2b4fadcd762adcedb7d5dc51d2
+  data.tar.gz: 7966eafcdb0fe92819a1dc5207d0f3bb72b6feeb4dc7791d662b2368e88683a82d5d6c3e7b559511e1f78d0b74f57bf72b451dd64cddfd016d0e75ada05ad407

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 active_record-logger_attributes.gemspec
+gemspec

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,65 @@
+# ActiveRecord::LoggerAttributes
+
+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/active_record/logger_attributes`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-logger_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-logger_attributes
+
+## Usage
+
+First, create a column to hold your log messages:
+
+```ruby
+class AddActivityLogToPosts < ActiveRecord::Migration[5.1]
+  def change
+    add_column :posts, :activity_log, :text, array: true, default: []
+  end
+end
+```
+
+Add the `logger_attr` to your model:
+
+```ruby
+class BlogPost < ActiveRecord::Base
+  logger_attr :activity_log
+end
+```
+
+Write to the logger as you normally would:
+
+```ruby
+@post = BlogPost.new
+@post.activity_log_logger.info "Setting up new blog post"
+@post.save
+```
+
+All of the options supported by [activemodel-logger_attributes](https://github.com/chrisb/acitvemodel-logger_attributes) are supported here with a few additions:
+
+```ruby
+logger_attr :activity_log, update_on_write: true
+```
+
+If the `update_on_write` option is enabled (`true` by default) the log column will be updated immediately when new messages are pushed to the logger (internally this happens via [`update_column`](http://api.rubyonrails.org/classes/ActiveRecord/Persistence.html#method-i-update_columns) so beware caveats, however this is generally what you want) _if the model is already persisted_, otherwise database updates will happen conventionally via `save`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecord::LoggerAttributes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activerecord-logger_attributes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/activerecord-logger_attributes.gemspec

@@ -0,0 +1,24 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/logger_attributes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "activerecord-logger_attributes"
+  spec.version = ActiveRecord::LoggerAttributes::VERSION
+  spec.authors = ['Chris Bielinski']
+  spec.email = ['chris@shadow.io']
+
+  spec.summary = "Save Ruby's Logger messages to a database column"
+  spec.description = "Save Ruby's Logger messages to a database column"
+  spec.homepage = 'https://github.com/chrisb/activerecord-logger_attributes'
+  spec.license = 'MIT'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+  spec.add_dependency 'activemodel-logger_attributes', '~> 0.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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record/logger_attributes"
+
+# 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
+
+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_record/logger_attributes.rb

@@ -0,0 +1,39 @@
+require 'active_model/logger_attributes'
+
+require "active_record/logger_attributes/version"
+require 'active_record/logger_attributes/device'
+
+module ActiveRecord
+  module LoggerAttributes
+    extend ActiveSupport::Concern
+    include ActiveModel::LoggerAttributes
+
+    module ClassMethods
+      def logger_attr_default_options
+        Class
+          .new
+          .extend(ActiveModel::LoggerAttributes::ClassMethods)
+          .logger_attr_default_options
+          .merge(save_on_write: true)
+      end
+
+      def logger_attr(attribute, options = {})
+        attribute = attribute.to_sym
+        setup_logger_attr(attribute, options)
+      end
+    end
+
+    def logger_for_logger_attribute(attribute, logger_class, &block)
+      device = ActiveRecord::LoggerAttributes::Device.new(attribute, self)
+      logger_class.new(device).tap do |l|
+        progname = [self.class.name]
+        progname << id if persisted?
+        progname << attribute
+        l.progname = progname.join('.') if l.respond_to?(:progname)
+        yield l if block_given?
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::LoggerAttributes

data/lib/active_record/logger_attributes/device.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module LoggerAttributes
+    class Device < ActiveModel::LoggerAttributes::Device
+      def initialize(attribute, model, save_on_write = true)
+        super(attribute, model)
+        @save_on_write = save_on_write
+      end
+
+      def write(message)
+        super
+        @model.update_column @attribute, @model.send(@attribute) if @save_on_write && @model.persisted?
+      end
+    end
+  end
+end

data/lib/active_record/logger_attributes/version.rb

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

data/lib/activerecord/logger_attributes.rb

@@ -0,0 +1 @@
+require 'active_record/logger_attributes'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-logger_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Bielinski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel-logger_attributes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.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: Save Ruby's Logger messages to a database column
+email:
+- chris@shadow.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-logger_attributes.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/logger_attributes.rb
+- lib/active_record/logger_attributes/device.rb
+- lib/active_record/logger_attributes/version.rb
+- lib/activerecord/logger_attributes.rb
+homepage: https://github.com/chrisb/activerecord-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: Save Ruby's Logger messages to a database column
+test_files: []