train_track 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13b665f35dbf21fdcfa2734d36ef9d5fe700b205
+  data.tar.gz: bbc8b3dbf6bd2fbca004734cae3229161745a08a
+SHA512:
+  metadata.gz: 87b2f3e6619d27eaf033711af4e30f3429afe6b705dad7b38c478bedb89efb2a794b550ce577412fde8cea1af5864cd5ee96f44c50b16adb142f49ec7d2f08f8
+  data.tar.gz: fc7b60c170c51556f2f3d64a7ba741cff9e1f3bb6e70dd9424a8ddfc448664053fed524e26e6782b3ad2ffef25acc5f8ff9899e00b1b9ad95de75368249e03d8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.2.2
+
+addons:
+  code_climate:
+    repo_token:
+      secure: "2e38d4c3fd0efbc27263ff9b68e0578c02febf90d2c5727ad9fe48c2d11e4150"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+Don't be a jerk.
+
+Bringing up somebody's personal business is almost certainly necessary. 

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in train_track.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anthony Super
+
+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,154 @@
+# :steam_locomotive: TrainTrack :steam_locomotive: 
+
+[![Code Climate](https://codeclimate.com/github/AnthonySuper/train_track/badges/gpa.svg)](https://codeclimate.com/github/AnthonySuper/train_track)
+[![Test Coverage](https://codeclimate.com/github/AnthonySuper/train_track/badges/coverage.svg)](https://codeclimate.com/github/AnthonySuper/train_track/coverage)
+[![Build Status](https://travis-ci.org/AnthonySuper/train_track.svg?branch=master)](https://travis-ci.org/AnthonySuper/train_track)
+
+TrainTrack is a gem that makes it easier to track changes in your rails projects.
+It doesn't make any decisions on how to do that.
+That part is up to you.
+All it does is provide some nice helpers to make that task easier.
+
+TrainTrack may gain features in the future that also manage the actual tracking side.
+If you want to help develop that, shoot us a pull request!
+### Why not just use ActiveRecord callbacks?
+
+Well, you could use those.
+In fact, for very simple tracking, those are probably better.
+However, that has some limitations:
+
+1. Doesn't fully work with collections: a `has_many` is going to cause severe trouble for your code, since some methods will trigger `before_update` and `after_update`, while others won't.
+
+2. Will run on records updated by automated tasks, when you probably care more about what users are doing
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'train_track'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install train_track
+
+## Usage
+
+Include TrainTrack in your controller:
+
+```ruby
+class ImagesController < ApplicationController
+  include TrainTrack
+
+end
+```
+
+Call the `record` method in the controller when there's a state you wish to track.
+What do I mean by this?
+Well, in the create method, you probably only want to track that it has been created
+```ruby
+  def create
+    i = Image.new(image_params)
+    if i.save
+      track i 
+      redirect_to i
+    else
+      # handle error
+    end
+  end
+```
+
+Whereas in an update action, you probably want to manage multiple states:
+
+```ruby
+  def update
+    i = Image.find(params[:id])
+    track i 
+    if i.update(image_params)
+      track i
+      redirect_to i
+    else
+      # handle error
+    end
+  end
+```
+
+### Trackers
+Now, all those calls to track are pretty useless right now.
+In order to make them do something, you have to specify a tracker.
+We recommend you put those in `/app/trackers/`
+
+A tracker looks like this:
+```ruby
+class ImageTracker < ApplicationTracker
+  # user is taken from the `current_user` method on your controller
+  def initialize(user, record)
+    @user = user
+    @record = record
+  end
+  # Called on the create action
+  def create
+    # assuming we have a model called "ImageEdit" that tracks modifications of Images
+    # also assume that this uses Postgres' arrays
+    ImageEdit.create(user: @user,
+                     image: @record,
+                     action: :created,
+                     old_tags: [],
+                     new_tags: @record.tags.pluck(:id))
+  end
+
+  # Called on the first call to "track" in the edit action
+  def update_before
+    @old_tags = @record.tags.pluck(:id)
+  end
+
+  def update_after
+    @new_tags = @record.tags.reload.pluck(:id)
+    # Assuming ImageEdit makes use of Postgres' arrays 
+    ImageEdit.create(user: @user,
+                     image: @record,
+                     action: :edited,
+                     old_tags: @old_tags,
+                     new_tags: @new_tags)
+  end
+end
+```
+
+Much like in [Pundit](https://github.com/elabs/pundit), a tracker is a PORO.
+This gives TrainTracks a higher level of flexibility.
+
+Also like in pundit, we infer the name of the tracker from the class name.
+If you want to over-ride this behavior, simple include a method called `train_tracker_class` on the class.
+
+```ruby
+class Noided < ActiveRecord::Base
+  def self.train_tracker_class
+    ParanoidTracker
+  end
+end
+```
+You can also define it as an instance method.
+This lets you do fancy things:
+```ruby
+class ElfmanSong < ActiveRecord::Base
+  def train_tracker_class
+    if band == "Oingo Boingo"
+      BoingoTracker
+    else
+      SoloTracker
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/AnthonySuper/train_track/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

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: [:spec]

data/bin/console

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

data/bin/setup

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

data/lib/generators/train_track/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+  Generates an application tracker as a starting point for your app, as well as relevant directories

data/lib/generators/train_track/install/install_generator.rb

@@ -0,0 +1,11 @@
+module TrainTrack
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), "templates"))
+      def copy_application_tracker
+        template 'application_tracker.rb', 'app/trackers/application_tracker.rb'
+      end
+    end
+  end
+end
+

data/lib/generators/train_track/install/templates/application_tracker.rb

@@ -0,0 +1,26 @@
+class ApplicationTracker
+  attr_reader :user, :record
+
+  def initialize(user, record)
+    @user = user
+    @record = record
+  end
+
+  def create
+
+  end
+
+  def update_before
+
+  end
+
+  def update_after
+
+  end
+
+  def destroy
+
+  end
+
+end
+

data/lib/generators/train_track/tracker/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Generates a new tracker for a model with the given name
+
+Example:
+  rails g traintracks:tracker user
+
+  This will create:
+    app/trackers/user_tracker.rb
+

data/lib/generators/train_track/tracker/templates/tracker.rb

@@ -0,0 +1,5 @@
+<% module_namespacing do %>
+class <%= class_name %>Tracker < ApplicationTracker
+
+end
+<% end %>

data/lib/generators/train_track/tracker/tracker_generator.rb

@@ -0,0 +1,11 @@
+module TrainTrack
+  module Generators
+    class TrackerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      def create_tracker
+        template 'tracker.rb', File.join('app/trackers', class_path, "#{file_name}_tracker.rb")
+      end
+
+     end
+  end
+end

data/lib/train_track.rb

@@ -0,0 +1,48 @@
+require "train_track/version"
+require 'active_support/concern'
+require 'active_support/core_ext/string/inflections'
+module TrainTrack
+  extend ActiveSupport::Concern
+  ##
+  # Find the tracker class for a given model
+  def self.tracker_class(model)
+    if model.respond_to? :train_tracker_class
+      model.train_tracker_class
+    elsif model.class.respond_to? :train_tracker_class
+      model.class.train_tracker_class
+    else
+      (model.class.name.to_s + "Tracker").constantize
+    end
+  end
+  ##
+  # Methods to add to a controller when included
+  included do
+    ##
+    # Track a model
+    #
+    def track(model)
+      @_tracker ||= TrainTrack.tracker_class(model).new(user_method, model)
+      if params[:action] == :update && _tracker_times_called == 0
+        @_tracker.update_before
+        @_tracker_times_called += 1
+      elsif params[:action] == :update && _tracker_times_called == 1
+        @_tracker.update_after
+      else
+        @_tracker.send(params[:action])
+      end
+    end
+
+
+    ##
+    # Find the current_user of the controller
+    # Done by using current_user
+    def user_method
+      current_user
+    end
+
+    def _tracker_times_called
+      @_tracker_times_called ||= 0
+      @_tracker_times_called
+    end
+  end
+end

data/lib/train_track/version.rb

@@ -0,0 +1,3 @@
+module TrainTrack
+  VERSION = "0.2.0"
+end

data/train_track.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'train_track/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "train_track"
+  spec.version       = TrainTrack::VERSION
+  spec.authors       = ["Anthony Super"]
+  spec.email         = ["anthony@noided.media"]
+
+
+  spec.summary       = %q{Track changes to rails models in a generic way}
+  spec.homepage      = "https://github.com/ANthonySUper/train_track"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_dependency "activesupport", ">= 4.0.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: train_track
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Anthony Super
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: 
+email:
+- anthony@noided.media
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/train_track/install/USAGE
+- lib/generators/train_track/install/install_generator.rb
+- lib/generators/train_track/install/templates/application_tracker.rb
+- lib/generators/train_track/tracker/USAGE
+- lib/generators/train_track/tracker/templates/tracker.rb
+- lib/generators/train_track/tracker/tracker_generator.rb
+- lib/train_track.rb
+- lib/train_track/version.rb
+- train_track.gemspec
+homepage: https://github.com/ANthonySUper/train_track
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Track changes to rails models in a generic way
+test_files: []
+has_rdoc: