webtranslateit-version_fu 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4871354c79d2e70b5f2730b4017bf48246025e650cb267f3114c31f732bc7a3d
+  data.tar.gz: a56e7c8a82be42f777c88bff3e9a18ff01005f8d539b05101f94242d06e99bb1
+SHA512:
+  metadata.gz: 1deea4674b48d01e206ce24dcdfc70e95d707a90d1b0f6d6000f4726a17a0dce0546a140879a22dd7c2a33eb469a6410fe98c03e62a2708ee724b9b8d6a99da9
+  data.tar.gz: 51d15ca7c3090a5ce123e6f6dfa40020188c67a9dff77066797efea08b0a9e20a412954472e5297cae92161d80f4f68c5a90f84a551f76b3d92f98b3e9de5289

data/MIT-LICENSE

@@ -0,0 +1,24 @@
+== version_fu
+Copyright (c) 2008-9 Jordan McKible
+
+== acts_as_versioned
+Copyright (c) 2005 Rick Olson
+====================================================================
+
+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,126 @@
+# version_fu
+
+[![Ruby](https://github.com/webtranslateit/version_fu/actions/workflows/ci.yml/badge.svg)](https://github.com/webtranslateit/version_fu/actions/workflows/ci.yml)
+
+version_fu is a ActiveRecord versioning plugin that that is based on the dirty attribute checking introduced in Rails 2.1.
+
+## Installation
+
+Add below to your Gemfile
+
+  `gem 'version_fu'`
+
+## Usage
+
+Let's say I have a pages table:
+
+```ruby
+  class Page < ActiveRecord::Base
+    # attributes: id, type, title, body, created_at, updated_at, creator_id, author_id
+  end
+```
+
+I want to track any changes made.  First step will be to make a new page_versions table:
+
+```ruby
+  class CreatePageVersions < ActiveRecord::Migration
+    def self.up
+      create_table :page_versions do |t|
+        t.integer :page_id, :version, :author_id
+        t.string  :title
+        t.text    :body
+        t.timestamps
+      end
+    end
+
+    def self.down
+      drop_table :page_versions
+    end
+  end
+```
+
+In this case, the author_id column represents the last person to edit the page.  We want to track this attribute with every version.  However, the creator_id is the person who created the page.  The will never change, so it's not part of the versioned table.
+
+Don't forget to add a version column to your pages table.  Have it default to 1 just to be safe (although the plugin should account for this):
+
+```ruby
+  class AddVersionToPages < ActiveRecord::Migration
+    def self.up
+      add_column :pages, :version, :integer, :default=>1
+    end
+    def self.down
+      remove_column :pages, :version
+    end
+  end
+```
+
+Of course if you're adding this plugin to a table with existing data, you'll probably want to instantiate some initial versions to start with.
+
+Alright, so now that the database tables are in place, we can fire up version_fu.  It's quite simple:
+
+```
+  class Page < ActiveRecord::Base
+    version_fu
+  end
+```
+
+That's it.
+
+
+## Configuration
+
+You can pass a few configuration options if need be.  If you stick with the defaults above, you can skip all this.
+
+```ruby
+  class Page < ActiveRecord::Base
+    version_fu :class_name=>'Version', :foreign_key=>'page_id', :table_name=>'page_versions', :version_column=>'version'
+  end
+```
+
+* :class_name - The name of the versioned class.  It will be a submodule of the versioning class - e.g. Page::Version
+
+* :foreign_key - The column in the versioned table associated with the versioning class
+
+* :table_name - The name of the versioned table
+
+* :version_column - The name of the version column
+
+
+## Extensions
+
+Now that you've got some versions, it would be nice to use ActiveRecord associations on it.  For example, Page.first.versions.latest.author wouldn't currently work because the Page::Version class doesn't know about the author method.  The version_fu call does all you to pass a block which is executed by the versioned class.  There is just one gotcha for associations:
+
+```ruby
+  class Page < ActiveRecord::Base
+    version_fu do
+      belongs_to :author, :class_name=>'::Author'
+    end
+  end
+```
+
+Don't forget the class name, or you'll get a warning
+
+## When to Version
+
+By default a new version will be saved whenever a versioned column is changed.  However, you can control this at a more fine grained level.  Just override the create_new_version? method.  For example, let's say you only want to save a new version if both the page title and body changed.  Taking advantage of the dirty attribute methods, you could do something like this:
+
+```ruby
+  class Page < ActiveRecord::Base
+    version_fu do
+      belongs_to :author, :class_name=>'::Author'
+    end
+    def create_new_version?
+      title_changed? && body_changed?
+    end
+  end
+```
+
+## Author
+
+* version_fu was created by Jordan McKible http://jordan.mckible.com
+
+* Available on GitHub at http://github.com/jmckible/version_fu
+
+* Available on RubyGems.org at http://rubygems.org/gems/version_fu
+
+* acts_as_versioned by Rick Olson http://github.com/technoweenie/acts_as_versioned/tree/master

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: %i[spec rubocop]
+RSpec::Core::RakeTask.new
+
+desc 'Run RuboCop checks'
+RuboCop::RakeTask.new
+
+desc 'Default: run unit tests.'
+task default: :test
+
+desc 'Test the version_fu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.libs << 'test/models'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'version_fu'
+ActiveRecord::Base.class_eval { include VersionFu }

data/lib/version_fu/version.rb

@@ -0,0 +1,3 @@
+module Version_fu
+  VERSION = '1.1.0'.freeze
+end

data/lib/version_fu/version_fu.rb

@@ -0,0 +1,112 @@
+module VersionFu
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def version_fu(options = {}, &block)
+      return if included_modules.include? VersionFu::InstanceMethods
+
+      __send__ :include, VersionFu::InstanceMethods
+
+      cattr_accessor :versioned_class_name, :versioned_foreign_key, :versioned_table_name,
+                     :version_column, :versioned_columns
+
+      self.versioned_class_name         = options[:class_name]  || 'Version'
+      self.versioned_foreign_key        = options[:foreign_key] || to_s.foreign_key
+      self.versioned_table_name         = options[:table_name]  || "#{table_name_prefix}#{base_class.name.demodulize.underscore}_versions#{table_name_suffix}"
+      self.version_column               = options[:version_column] || 'version'
+
+      # Setup versions association
+      class_eval do
+        has_many :versions, class_name: "#{self}::#{versioned_class_name}",
+                            foreign_key: versioned_foreign_key,
+                            dependent: :destroy do
+          def latest
+            order(version: :desc).first
+          end
+        end
+
+        before_save :check_for_new_version
+      end
+
+      # Versioned Model
+      const_set(versioned_class_name, Class.new(ActiveRecord::Base)).class_eval do
+        # find first version before the given version
+        def self.before(version)
+          where("#{original_class.versioned_foreign_key} = ? and version < ?",
+                version.send(original_class.versioned_foreign_key), version.version)
+            .order(version: :desc).first
+        end
+
+        # find first version after the given version.
+        def self.after(version)
+          where("#{original_class.versioned_foreign_key} = ? and version > ?",
+                version.send(original_class.versioned_foreign_key), version.version)
+            .order(version: :asc).first
+        end
+
+        def previous
+          self.class.before(self)
+        end
+
+        def next
+          self.class.after(self)
+        end
+      end
+
+      # Housekeeping on versioned class
+      versioned_class.cattr_accessor :original_class
+      versioned_class.original_class = self
+      versioned_class.table_name = versioned_table_name
+
+      # Version parent association
+      versioned_class.belongs_to to_s.demodulize.underscore.to_sym,
+                                 class_name: "::#{self}",
+                                 foreign_key: versioned_foreign_key
+
+      # Block extension
+      versioned_class.class_eval(&block) if block_given?
+
+      if versioned_class.table_exists?
+        # Finally setup which columns to version
+        self.versioned_columns = versioned_class.new.attributes.keys -
+                                 [versioned_class.primary_key, versioned_foreign_key, version_column, 'created_at',
+                                  'updated_at']
+      else
+        ActiveRecord::Base.logger.warn 'Version Table not found'
+      end
+    end
+
+    def versioned_class
+      const_get versioned_class_name
+    end
+  end
+
+  module InstanceMethods
+    def find_version(number)
+      versions.find_by_version(number)
+    end
+
+    def check_for_new_version
+      instantiate_revision if create_new_version?
+      true # Never halt save
+    end
+
+    # This the method to override if you want to have more control over when to version
+    def create_new_version?
+      # Any versioned column changed?
+      self.class.versioned_columns.detect { |a| __send__ "#{a}_changed?" }
+    end
+
+    def instantiate_revision
+      new_version = versions.build
+      versioned_columns.each do |attribute|
+        new_version.__send__ "#{attribute}=", __send__(attribute)
+      end
+      version_number = new_record? ? 1 : version + 1
+      new_version.version = version_number
+      self.version = version_number
+    end
+  end
+end

data/lib/version_fu.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+require 'version_fu/version_fu'
+ActiveRecord::Base.class_eval { include VersionFu }

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: webtranslateit-version_fu
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Jordan McKible
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rails-observers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: factory_girl_rails
+  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: guard-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: guard-rubocop
+  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: mocha
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 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'
+description: version_fu helps version your ActiveRecord models. It is based on Rick
+  Olson's acts_as_versioned and is compatible with Rails 3.
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/version_fu.rb
+- lib/version_fu/version.rb
+- lib/version_fu/version_fu.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage: https://github.com/webtranslateit/version_fu
+  changelog_uri: https://github.com/webtranslateit/webtranslateit/blob/master/history.md
+  documentation_uri: https://github.com/webtranslateit/webtranslateit#readme
+  homepage_uri: https://webtranslateit.com
+  source_code_uri: https://github.com/webtranslateit/webtranslateit
+  wiki_uri: https://github.com/webtranslateit/webtranslateit/wiki
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Gemified version of the version_fu plugin.
+test_files: []