has_changelogs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1869edef6186e5ad2e9cd9c9b22270005cff43e0
+  data.tar.gz: f4c0e30bc0ec59be808b12bb64410f61bcc9e4f5
+SHA512:
+  metadata.gz: 05d3d5ec172f9268bc21e23d1e6f825b27ea73651de45d9bdd2d47a72096158d60b9185152f1ca62b183606b583606501581ae38f323425ffe979d97003c9073
+  data.tar.gz: e43ec882886adfaf94d50f8d196066d838d60528c9f03b27533865db757a411a48b9d4afd3a38ef26cb2e7ca81d33322d1da15a79f5bb0718b45ed0dd24b3ba9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/.DS_Store
+/spec/has_changelogs.sqlite3

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,81 @@
+# HasChangelogs
+
+has_changelogs tracks changes on a model and it's associations for applications that need to have change history. The version is however, 0.1.0, so use at your own perril.
+
+Especially a generator for the changelog model is missing - see /spec/fixtures/active_record/changelog.rb for it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_changelogs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_changelogs
+
+## Usage
+
+Given you had a fitting Changelog Model (see ./spec/fixtures/active_record/changelog.rb) you can do the following:
+
+```ruby
+class User < ActiveRecord::Base
+  has_changelogs
+
+  def my_condition
+    name == "True Condition"
+  end
+end
+
+class LogEverythingUser < User
+  has_changelogs ignore: [:type, :id]
+end
+
+class OnlyName < User
+  has_changelogs only: :name
+end
+
+class IgnoreName < User
+  has_changelogs ignore: :name
+end
+
+class IfCondition < User
+  has_changelogs if: :my_condition
+end
+
+class UnlessCondition < User
+  has_changelogs unless: :my_condition
+end
+
+class WithPassportsUser < LogEverythingUser
+  has_many :passports, foreign_key: :user_id
+end
+
+class Passport < ActiveRecord::Base
+  belongs_to :user, class_name: "WithPassportsUser"
+  has_changelogs at: :user
+end
+
+```
+
+## 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/bitcrowd/has_changelogs.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+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 "has_changelogs"
+
+# 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/has_changelogs.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_changelogs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'has_changelogs'
+  spec.version       = HasChangelogs::VERSION
+  spec.authors       = ['Elizabeth Brae', 'Christoph Beck']
+  spec.email         = ["info@bitcrowd.net"]
+
+  spec.summary       = %q{has_changelogs tracks changes on a model and it's associations for applications that need to have change history.}
+  spec.description   = %q{has_changelogs tracks changes on a model and it's associations for applications that need to have change history. This is not about versioning your model, and the version is however, 0.1.0, so use at your own perril. The changelogs contain a JSON representation of the changes.}
+  spec.homepage      = "https://github.com/bitcrowd/has_changelogs"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+end

data/lib/has_changelogs/version.rb

@@ -0,0 +1,3 @@
+module HasChangelogs
+  VERSION = "0.1.0"
+end

data/lib/has_changelogs.rb

@@ -0,0 +1,173 @@
+require 'active_record'
+require 'has_changelogs/version'
+
+module HasChangelogs
+  module ClassMethods
+
+    def has_changelogs(options = {})
+      send :include, InstanceMethods
+
+      after_create   :record_created                           if !options[:on] || options[:on].include?(:create)
+      before_destroy :record_will_be_destroyed                 if !options[:on] || options[:on].include?(:destroy)
+
+      after_update   :record_updated, :if => :change_relevant? if !options[:on] || options[:on].include?(:update)
+
+      prepare_class_options(options)
+
+      has_many :changelogs, as: :logable
+    end
+
+    private
+
+    def prepare_class_options(options)
+      class_attribute :has_changelog_options
+      self.has_changelog_options = options.dup
+
+      has_changelog_options[:ignore]  = (Array(has_changelog_options[:ignore]) | [:updated_at, :created_at, :id] ).map &:to_s
+      has_changelog_options[:only]    =  Array(has_changelog_options[:only]).map &:to_s
+      has_changelog_options[:force]   =  Array(has_changelog_options[:force]).map &:to_s
+    end
+
+  end
+
+  module InstanceMethods
+
+    def change_relevant?
+      if_condition     = self.class.has_changelog_options[:if]
+      unless_condition = self.class.has_changelog_options[:unless]
+
+      conditions_met?(if_condition, unless_condition) && object_changed_notably?
+    end
+
+    def conditions_met?(if_condition, unless_condition)
+      (if_condition.blank? || if_condition.call(self)) &&
+        (unless_condition.blank? || !unless_condition.call(self))
+    end
+
+    def notable_changes
+      notable_attributes
+    end
+
+    def notable_attributes
+      only    = self.class.has_changelog_options[:only]
+      force   = self.class.has_changelog_options[:force]
+      notable = only.empty? ? changed_and_not_ignored : (changed_and_not_ignored & only)
+      notable + force
+    end
+
+    def changed_and_not_ignored
+      ignore = self.class.has_changelog_options[:ignore]
+      changed - ignore
+    end
+
+    def object_changed_notably?
+      notable_changes.any?
+    end
+    # the actions
+
+    def record_created
+      log_change(log_scope: log_scope, log_action: 'created', changed_data: log_data, log_origin: log_origin)
+    end
+
+    def record_updated
+      log_change(log_scope: log_scope, log_action: 'updated', changed_data: log_data, log_origin: log_origin)
+    end
+
+    def record_will_be_destroyed
+      log_change(log_scope: log_scope, log_action: 'destroyed', changed_data: self.attributes, log_origin: log_origin)
+    end
+
+    def log_change(options = {})
+      changelog_association.create(options)
+    end
+
+    def log_scope
+      has_changelog_options[:at].present? ? :association : :instance
+    end
+
+    def logged_model
+      has_changelog_options[:at].present? ?
+        send(has_changelog_options[:at]) : self
+    end
+
+    def log_origin
+      self.class.to_s
+    end
+
+    def changelog_association
+      logged_model.send changelog_association_name
+    end
+
+    def changelog_association_name
+      self.class.has_changelog_options[:changelogs_association] || :changelogs
+    end
+
+    def log_data(options = {})
+      raw_changed_data(options).select do |key, value|
+        notable_changes.include? key.to_s
+      end
+    end
+
+    def raw_changed_data(options = {})
+      options[:change_data] || self.changes || {}
+    end
+
+    # def epic_hero!(options = {})
+    #   options[:epic_hero]
+    # end
+
+    # def epic_action!(options = {})
+    #   options[:epic_action] || "updated"
+    # end
+
+    # def epic_action_by_admin!(options = {})
+    #   !!options[:epic_action_by_admin]
+    # end
+
+    # def log_item(options = {})
+    #   options[:log_item] || self
+    # end
+
+    # def epic_item_nickname!(options = {})
+    #   options[:log_item_nickname]
+    # end
+
+    # def epic_item_owner!(options = {})
+    #   options[:log_item_owner]
+    # end
+
+
+    # def epic_treasure!(options = {})
+    #   options[:epic_treasure]
+    # end
+    # def epic_treasure_nickname!(options = {})
+    #   options[:epic_treasure_nickname]
+    # end
+    # def epic_treasureguard!(options = {})
+    #   options[:epic_treasureguard]
+    # end
+
+    # def epic_change_data!(options = {})
+    #   raw_change_data.to_json
+    # end
+
+    # def epic_change_attributes!(options = {})
+    #   options[:epic_change_attributes] || raw_change_data(options).keys.join(",")
+    # end
+
+    # private
+
+    # def raw_change_data(options = {})
+    #   options[:epic_change_data] || self.changes || {}
+    # end
+
+  end
+
+  def self.included(receiver)
+    receiver.extend ClassMethods
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include HasChangelogs
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: has_changelogs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elizabeth Brae
+- Christoph Beck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: activerecord
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: has_changelogs tracks changes on a model and it's associations for applications
+  that need to have change history. This is not about versioning your model, and the
+  version is however, 0.1.0, so use at your own perril. The changelogs contain a JSON
+  representation of the changes.
+email:
+- info@bitcrowd.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_changelogs.gemspec
+- lib/has_changelogs.rb
+- lib/has_changelogs/version.rb
+homepage: https://github.com/bitcrowd/has_changelogs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: has_changelogs tracks changes on a model and it's associations for applications
+  that need to have change history.
+test_files: []