diffrent 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'diffy'
+gem 'vestal_versions', :git => "git://github.com/futurechimp/vestal_versions.git"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "simplecov", :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GIT
+  remote: git://github.com/futurechimp/vestal_versions.git
+  revision: e7e14a35d6ef42d96fbbd8b8c02ff4358f06cfa8
+  specs:
+    vestal_versions (1.2.2)
+      activerecord (>= 3.0.0)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diffy (2.0.6)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.12.1)
+    multi_json (1.3.2)
+    rake (0.9.2.2)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  diffy
+  jeweler (~> 1.6.4)
+  minitest
+  simplecov
+  vestal_versions!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Dave Hrycyszyn
+
+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,144 @@
+diffrent
+========
+
+Diffrent is a very simple way to do ActiveRecord version diffing. It provides
+a convenient interface to two other libraries 
+([Diffy](https://github.com/samg/diffy) and [Vestal Versions](https://github.com/laserlemon/vestal_versions)), combining their functionality. 
+
+It makes no assumption about what web framework you're using - it can be used in
+Sinatra, Padrino, Rails, or with no framework at all. 
+
+Installation:
+-------------
+
+    gem install diffrent
+
+In a Gemfile:
+
+    gem 'diffrent'
+
+Usage
+-----
+
+Let's say you've got a `Post` model, with a title and a body. You've already
+set up Vestal Versions, and
+your Post model looks like this:
+
+```ruby
+class Post
+  versioned
+end
+```
+
+With this all set up, you'll get a new version every time you save a Post object
+instance. How to get the differences between arbitrary versions? This is where
+diffrent comes in. 
+
+After adding 'diffrent' to your Gemfile and running 'bundle install', you can 
+change your Post model so it looks like this:
+
+```ruby
+class Post
+   versioned
+   include Diffrent
+end
+```
+
+This give you the ability to pick up changes between different versions of your
+Post objects. For example:
+
+    > @post = Post.create(:title => "Arnold says", :body => "What you talking about, Willis?")
+    > @post.body = "This is what Willis is talking about"
+    > @post.save # creates a new version
+
+Now we can:
+
+    > @post.diff_for(:body, 1,2)
+
+    => "<div class=\"diff\">\n  <ul>\n    <li class=\"del\"><del><strong>This is w</strong>hat <strong>Willis is</strong> talking about</del></li>\n    <li class=\"ins\"><ins><strong>W</strong>hat <strong>you</strong> talking about<strong>, Willis?</strong></ins></li>\n  </ul>\n</div>\n" 
+
+By default, you'll get back HTML in your diffs. There's a final options hash 
+on the `diff_for` method call, so that you can pass a :format option to Diffy:
+
+    > # get back raw text
+    >   p.diff_for(:body, 1, 2, :format => :text)
+    => "-This is what Willis is talking about\n\\n+What you talking about, Willis?\n\\n" 
+
+    > # get back coloured text
+    > p.diff_for(:body, 1, 2, :format => :color)
+    => "\e[31m-This is what Willis is talking about\e[0m\n\\n\e[32m+What you talking about, Willis?\e[0m\n\\n" 
+
+You can also pass a format of `nil` to get back a raw Diffy object if you need one.
+
+
+Using it in a web app
+---------------------
+
+Here's one way to incorporate Diffrent into a webapp to provide a user interface
+for viewing change. It's a Padrino example, but Sinatra or Rails will be 
+substantially the same.
+
+First, you'll need a controller action:
+
+```ruby
+get :view_differences, :map => "/posts/:id/view_differences/:old/:new" do
+  @post = Post.find(params[:id])
+  render 'posts/view_differences'
+end
+```
+
+Your view code can then look like this (please excuse my awesome HTML):
+
+```erb
+<% new_version = params[:new].to_i %>
+<% old_version = params[:old].to_i %>
+
+<p>Title:
+  <%= @post.diff_for(:title, old_version, new_version) %>
+</p>
+<p>Body:
+  <%= @post.diff_for(:body, old_version, new_version) %>
+</p>
+
+<p>
+  <% if @post.has_versions_before?(new_version) %>
+      <%= link_to("<< earlier", 
+          url(:posts, :view_differences, :id => @post.to_param, 
+              :old => new_version - 2,
+              :new => new_version - 1)) %>
+  <% end %>
+
+  <% if @post.has_versions_after?(new_version) %>
+    <%= link_to("later >>", 
+          url(:posts, :view_differences, :id => @post.to_param, 
+              :old => new_version,
+              :new => new_version + 1)) %>
+  <% end %>
+</p>
+```
+
+As you can see, it's a bit manual - it seemed best to make very few assumptions
+about how people will want to use this. 
+
+Because of the (wonderful and simple) way that Vestal Versions works, you can 
+diff arbitrary versions using this controller action and view - for instance, 
+hitting a route like `/posts/1/view_differences/3/50` would give you a diff
+on the title and body for all revisions between r3 and r50. 
+
+
+Contributing to diffrent
+------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Dave Hrycyszyn. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "diffrent"
+  gem.homepage = "http://github.com/futurechimp/diffrent"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple}
+  gem.description = %Q{A}
+  gem.email = "dave.hrycyszyn@headlondon.com"
+  gem.authors = ["Dave Hrycyszyn"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "diffrent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/diffrent.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "diffrent"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dave Hrycyszyn"]
+  s.date = "2012-04-18"
+  s.description = "A"
+  s.email = "dave.hrycyszyn@headlondon.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "diffrent.gemspec",
+    "lib/diffrent.rb",
+    "test/helper.rb",
+    "test/test_diffrent.rb"
+  ]
+  s.homepage = "http://github.com/futurechimp/diffrent"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "Simple"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<diffy>, [">= 0"])
+      s.add_runtime_dependency(%q<vestal_versions>, [">= 0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<diffy>, [">= 0"])
+      s.add_dependency(%q<vestal_versions>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<diffy>, [">= 0"])
+    s.add_dependency(%q<vestal_versions>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/diffrent.rb

@@ -0,0 +1,20 @@
+module Diffrent
+  
+  def diff_for(attr, old_version, new_version, options={:format => :html})
+    changes = self.changes_between(new_version, old_version)
+    if changes.key?(attr)
+      Diffy::Diff.new(changes[attr].first, changes[attr].last).to_s(options[:format])
+    else
+      self.send(attr)
+    end
+  end
+
+  def has_versions_before?(v)
+    self.versions.at(v - 1)
+  end
+
+  def has_versions_after?(v)
+    self.versions.at(v + 1)
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'diffrent'
+
+require 'simplecov'
+SimpleCov.start
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest::Unit.autorun

data/test/test_diffrent.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestDiffrent < MiniTest::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: diffrent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dave Hrycyszyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: &2174695800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2174695800
+- !ruby/object:Gem::Dependency
+  name: vestal_versions
+  requirement: &2174695300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2174695300
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2174694820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2174694820
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2174694340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2174694340
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2174693860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2174693860
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2174693360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2174693360
+description: A
+email: dave.hrycyszyn@headlondon.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- diffrent.gemspec
+- lib/diffrent.rb
+- test/helper.rb
+- test/test_diffrent.rb
+homepage: http://github.com/futurechimp/diffrent
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3278078638270233273
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Simple
+test_files: []