timeliner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df92acc8153aed2d7f1ddc839c0ec09ed1e97268
+  data.tar.gz: edd188e42ec2265424ba16c81022bcb6a7788b81
+SHA512:
+  metadata.gz: 11b9e7beac0b80d0f411712e704e1408dc0d442df606365c123ac450a9548dd6c709d931a897de68ad8da188b2fa271aecbfc83f1f72845a77bbfef8d65a5eb8
+  data.tar.gz: af19c305686e1863f44668a2363d39dd5999b4502cc29c29626c2043870c5f956b764065e61031e56af44afae19742a49db48e4874355cc3693b19613efcdb4a

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.4.1
+before_install: gem install bundler -v 1.16.0

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 joost@spacebabies.nl. 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 timeliner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joost Baaij
+
+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,75 @@
+# Timeliner
+
+Keep track of activities in a Rails app.
+
+I use it to store activities; both for auditing in case someone does something
+bad, and for showing folks what's buzzing over here.
+
+I looked at [Public Activity](https://github.com/chaps-io/public_activity) but
+when I saw it doesn't work on Rails 5 and has a bunch of open issues, I just
+went ahead and created something similar.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'timeliner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timeliner
+
+Copy the included migrations to your main app:
+
+```
+bin/rails timeliner:install:migrations
+```
+
+## Usage
+
+A `TrackingConcern` injects itself into ActionController::Base, which makes it
+globally available. Track a thing in a controller like so:
+
+```
+track @course, 'course.created'
+```
+
+You are not meant to track the _person_, because we figure out who the current
+user is automatically. You're meant to track the thing that's changed.
+
+To track something outside of a controller, use this:
+
+```
+Timeliner.track @course, 'course.created'
+```
+
+This will not figure out the current user though. To keep record of
+whodunnit, pass them as the third parameter:
+
+```
+Timeliner.track @course, 'course.created', current_user
+```
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/spacebabies/timeliner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Timeliner project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/timeliner/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/app/jobs/timeliner/application_job.rb

@@ -0,0 +1,4 @@
+module Timeliner
+  class ApplicationJob < ::ApplicationJob
+  end
+end

data/app/jobs/timeliner/create_activity.rb

@@ -0,0 +1,9 @@
+require_dependency 'timeliner/application_job'
+
+module Timeliner
+  class CreateActivity < ApplicationJob
+    def perform(trackable:, key:, user:nil)
+      Activity.create! trackable: trackable, key: key, user: user
+    end
+  end
+end

data/app/models/timeliner/activity.rb

@@ -0,0 +1,10 @@
+require_dependency 'timeliner/application_record'
+
+module Timeliner
+  class Activity < ApplicationRecord
+    belongs_to :trackable, polymorphic: true, touch: true
+    belongs_to :user, optional: true
+
+    validates_presence_of :key
+  end
+end

data/app/models/timeliner/application_record.rb

@@ -0,0 +1,5 @@
+module Timeliner
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "timeliner"
+
+# 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/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/timeliner/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

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/timeliner.rb

@@ -0,0 +1,25 @@
+require "timeliner/engine"
+require "timeliner/tracking_concern"
+
+module Timeliner
+  def self.engine
+    Engine
+  end
+
+  def self.track(trackable, key, user=nil)
+    CreateActivity.perform_later(trackable: trackable, key: key, user: user)
+  end
+
+  def self.find(trackable, key)
+    Activity
+      .where(trackable: trackable)
+      .where(key: key)
+  end
+
+  def self.last_activity(trackable)
+    Activity
+      .where(trackable: trackable)
+      .order(created_at: :desc)
+      .limit(1)
+  end
+end

data/lib/timeliner/engine.rb

@@ -0,0 +1,19 @@
+require 'rails'
+
+module Timeliner
+  class Engine < ::Rails::Engine
+    isolate_namespace Timeliner
+
+    config.autoload_paths << config.root.join('lib')
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+    end
+
+    initializer 'timeliner.action_controller.tracking_concern' do
+      ActiveSupport.on_load(:action_controller_base) {
+        include TrackingConcern
+      }
+    end
+  end
+end

data/lib/timeliner/tracking_concern.rb

@@ -0,0 +1,12 @@
+module Timeliner
+  # Implements activity-related functionality for controllers.
+  module TrackingConcern
+    private
+
+    # Track a `trackable` with a certain key.
+    # The current user is found in the controller.
+    def track(trackable, key)
+      Timeliner.track trackable, key, current_user
+    end
+  end
+end

data/lib/timeliner/version.rb

@@ -0,0 +1,3 @@
+module Timeliner
+  VERSION = "1.0.0"
+end

data/timeliner.gemspec

@@ -0,0 +1,28 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "timeliner/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "timeliner"
+  spec.version       = Timeliner::VERSION
+  spec.authors       = ["Joost Baaij"]
+  spec.email         = ["joost@spacebabies.nl"]
+
+  spec.summary       = 'Track activities inside a Rails application'
+  spec.description   = 'Track activities inside a Rails application'
+  spec.homepage      = "https://github.com/spacebabies/timeliner"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: timeliner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joost Baaij
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: Track activities inside a Rails application
+email:
+- joost@spacebabies.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/jobs/timeliner/application_job.rb
+- app/jobs/timeliner/create_activity.rb
+- app/models/timeliner/activity.rb
+- app/models/timeliner/application_record.rb
+- bin/console
+- bin/rails
+- bin/setup
+- lib/timeliner.rb
+- lib/timeliner/engine.rb
+- lib/timeliner/tracking_concern.rb
+- lib/timeliner/version.rb
+- timeliner.gemspec
+homepage: https://github.com/spacebabies/timeliner
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Track activities inside a Rails application
+test_files: []