traka 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Andrew Buntine (info@andrewbuntine.com)
+
+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,120 @@
+# Traka
+
+A Rails 3+ plugin for simple tracking of changes to resources over time.
+
+Traka will keep track of *create*, *update* and *destroy* actions over time in your application. It uses a simple versioning
+system so you can complie groups of changes into blocks.
+
+Changes that cancel each other out will be automatically cleansed from a changeset. For example, if one record is
+created and then destroyed later in the same changeset, the two will cancel each other out.
+
+Traka is useful in conjunction with APIs that need to be able to have simple versioning. A common use-case is when your
+API needs to send out a succinct changeset when a new version of the data is published. This way your API can send just the data
+that has been created/updated/destroyed instead of sending out everything every time.
+
+## Install
+
+```
+  gem install traka
+  rails g traka:install
+```
+
+## Setup
+
+Add the following to each model you want to keep track of:
+
+```ruby 
+  is_trakable
+```
+
+Each model should have a string "uuid" column. If you want to use a different column name, just specify it:
+
+```ruby 
+  is_trakable :traka_uuid => "code"
+```
+
+## Use
+
+To access the current set of staged changes:
+
+```ruby 
+  TrakaChange.staged_changes ## => [traka_change_record, ...]
+```
+
+Each TrakaChange record can be resolved to the original record (except "destroy"):
+
+```ruby 
+  TrakaChange.staged_changes.first.get_record ## => record
+```
+
+To fetch a changeset across multiple versions. Assuming current version is 5, to get changes from v2 onwards:
+
+```ruby 
+  TrakaChange.changes_from(2) ## => [traka_change_record, ...]
+```
+
+Or just get changes from v2 to v4:
+
+```ruby 
+  TrakaChange.changes_in_range(2, 4) ## => [traka_change_record, ...]
+```
+
+The above methods will automatically cleanse obsolete changes. To see everything:
+
+```ruby 
+  TrakaChange.changes_from(2, false)        ## => [traka_change_record, ...]
+  TrakaChange.changes_in_range(2, 4, false) ## => [traka_change_record, ...]
+```
+
+To see the current version:
+
+```ruby 
+  TrakaChange.latest_version
+```
+
+To publish a new version:
+
+```ruby 
+  TrakaChange.latest_version       ## => 1
+  TrakaChange.publish_new_version!
+  TrakaChange.latest_version       ## => 2
+```
+
+## Example
+
+Assuming models called Product and Car exist.
+
+```ruby 
+  a = Product.create(:name => "Product 1")
+  b = Product.create(:name => "Product 2")
+  c = Car.create(:name => "Car 1")
+
+  TrakaChange.staged_changes #=> [TrakaChange<create>, TrakaChange<create>, TrakaChange<create>]
+
+  b.name = "New name"
+  b.save
+
+  # The "update" above is filtered out because we already know to fetch "b" because it's just been created.
+  TrakaChange.staged_changes #=> [TrakaChange<create>, TrakaChange<create>, TrakaChange<create>]
+
+  TrakaChange.publish_new_version!
+
+  b.destroy
+  a.name = "New name"
+  a.save
+
+  TrakaChange.staged_changes #=> [TrakaChange<destroy>, TrakaChange<update>]
+  TrakaChange.staged_changes.last.get_record #=> a
+
+  a.name = "Another name"
+  a.save
+
+  # The update above is filtered because we already know "a" has been updated in this changeset.
+  TrakaChange.staged_changes #=> [TrakaChange<destroy>, TrakaChange<update>]
+  TrakaChange.staged_changes.last.get_record #=> a
+
+  # All interactions with "b" are filtered out because we've created and destroyed it in the same changeset: v1+v2.
+  TrakaChange.changes_from(1) #=> [TrakaChange<create>, TrakaChange<create>, TrakaChange<update>]
+```
+
+See the unit tests for a bunch more examples.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Traka'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/generators/traka/install_generator.rb

@@ -0,0 +1,17 @@
+module Traka
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Installs Traka into the app."
+
+      def create_model
+        generate "model", "traka_change klass:string uuid:string action_type:string version:integer"
+      end
+
+      def create_version_file
+        directory "public/system"
+      end
+    end
+  end
+end

data/lib/generators/traka/templates/public/system/api/version.txt

@@ -0,0 +1 @@
+1

data/lib/tasks/traka_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :traka do
+#   # Task goes here
+# end

data/lib/templates/active_record/model/model.rb

@@ -0,0 +1,5 @@
+class TrakaChange < ActiveRecord::Base
+  attr_accessible :klass, :action_type, :uuid, :version
+
+  is_traka
+end

data/lib/traka/is_traka.rb

@@ -0,0 +1,100 @@
+module Traka
+  module IsTraka
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+ 
+    module ClassMethods
+      def is_traka(options={})
+        before_save :set_version
+
+        include Traka::IsTraka::LocalInstanceMethods
+      end
+
+      def latest_version
+        begin
+          File.read(version_path).to_i
+        rescue
+          tc = self.last
+          v  = tc ? tc.version : 1
+
+          logger.warn "Latest Traka version not found. Defaulting to v#{v}"
+
+          v
+        end
+      end
+
+      def publish_new_version!
+        set_version!(latest_version + 1)
+      end
+
+      def set_version!(v)
+        File.open(version_path, "w") do |f|
+          f.write(v.to_s)
+        end
+      end
+
+      def staged_changes(concise=true)
+        changes_for_v(latest_version + 1, concise)
+      end
+
+      def changes_for_v(v, concise=true)
+        changes_in_range(v, v, concise)
+      end
+
+      def changes_from(v, concise=true)
+        changes_in_range(v, latest_version + 1, concise=true)
+      end
+
+      def changes_in_range(from=1, to=latest_version + 1, concise=true)
+        c = where(["version >= ? AND version <= ?", from, to])
+        concise ? filter_changes(c) : c
+      end
+
+      private
+
+      def version_path
+        File.join(
+          Rails.root, "public", "system",
+          "api", "version.txt")
+      end
+
+
+      # Filters out obsolete changes in the given set. For example,
+      # there is no point giving out 4 "update" changes, just one will
+      # suffice. And if you "create" and then "destroy" a record in one
+      # changeset, they should cancel each other out.
+      # This is not an efficient algorithm. May need to re-think
+      # for huge change-sets.
+      def filter_changes(changes)
+        changes.reject do |c|
+          if c.action_type == "create"
+            changes.any? { |cc| cc.action_type == "destroy" and cc.uuid == c.uuid }
+          elsif c.action_type == "destroy"
+            changes.any? { |cc| cc.action_type == "create" and cc.uuid == c.uuid } or
+            changes.any? { |cc| cc.action_type == "update" and cc.uuid == c.uuid }
+          elsif c.action_type == "update"
+            changes.any? { |cc| cc.action_type == "create" and cc.uuid == c.uuid } or
+            changes.any? { |cc| cc.action_type == "destroy" and cc.uuid == c.uuid } or
+            changes.any? { |cc| cc.action_type == "update" and cc.uuid == c.uuid and cc.id > c.id }
+          end
+        end
+      end
+    end
+
+    module LocalInstanceMethods
+      def set_version
+        self.version = self.class.latest_version + 1
+      end
+
+      def get_record
+        ar = ActiveRecord::Base.const_get(self.klass)
+        ar.where(ar.traka_uuid => self.uuid).first
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Traka::IsTraka

data/lib/traka/is_trakable.rb

@@ -0,0 +1,49 @@
+module Traka
+  module IsTrakable
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+ 
+    module ClassMethods
+      def is_trakable(options={})
+        cattr_accessor :traka_uuid
+        self.traka_uuid = (options[:traka_uuid] || :uuid).to_s
+
+        before_create :set_uuid, :record_create
+        before_update :record_update
+        before_destroy :record_destroy
+
+        include Traka::IsTrakable::LocalInstanceMethods
+      end
+    end
+
+    module LocalInstanceMethods
+      private
+
+      def set_uuid
+        write_attribute(self.class.traka_uuid, SecureRandom.hex(20))
+      end
+
+      def record_create
+        record_traka_change("create")
+      end
+
+      def record_update
+        record_traka_change("update")
+      end
+
+      def record_destroy
+        record_traka_change("destroy")
+      end
+
+      def record_traka_change(action_type)
+        TrakaChange.create(:klass => self.class.to_s,
+                           :uuid => self.attributes[self.class.traka_uuid],
+                           :action_type => action_type)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Traka::IsTrakable

data/lib/traka/version.rb

@@ -0,0 +1,3 @@
+module Traka
+  VERSION = "0.0.1"
+end

data/lib/traka.rb

@@ -0,0 +1,12 @@
+require 'traka/is_trakable'
+require 'traka/is_traka'
+
+module Traka
+
+  class Railtie < Rails::Railtie
+    config.app_generators do |g|
+      g.templates.unshift File::expand_path('../templates', __FILE__)
+    end 
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end