contract_acceptance_framework 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README

@@ -0,0 +1,53 @@
+== ContractAcceptanceFramework
+
+This gem is meant to be used to allow ActiveRecord objects to signify agreement with versioned contracts.  It requires some database tables.
+
+To that end, you need a migration that looks something like this:
+
+class CreateContractAcceptanceFrameworkTables < ActiveRecord::Migration
+  def self.up
+    create_table :contracts do |t|
+      t.string :key
+      t.text :content
+      t.integer :major_version
+      t.integer :minor_version
+      t.integer :maintenance_version
+      t.timestamps
+    end
+    add_index :contracts, [:major_version, :minor_version, :maintenance_version, :key], :name => 'contracts_version_index'
+    add_index :contracts, [:key]
+
+    create_table :contract_acceptances do |t|
+      t.integer :contract_id
+      t.timestamps
+      t.integer :acceptable_id
+      t.string  :acceptable_type
+    end
+    add_index :contract_acceptances, [:acceptable_id, :acceptable_type]
+    add_index :contract_acceptances, :contract_id
+  end
+
+  def self.down
+    remove_index :contract_acceptances, :column => :contract_id
+    remove_index :contract_acceptances, :column => [:acceptable_id, :acceptable_type]
+    drop_table :contract_acceptances
+
+    remove_index :contracts, :column => [:key]
+    remove_index :contracts, 'contracts_version_index'
+    drop_table :contracts
+  end
+end
+
+After that, you just include a module in your class that accepts contracts like so:
+
+class SomeClass < ActiveRecord::Base
+  include ContractAcceptanceFramework
+end
+
+That's it, you're done.  Now the class will respond to the following methods:
+
+    # where version looks like '1.2.3' and will be parsed into the appropriate major, minor, maintenance query
+    - has_agreed_to?(contract)
+    - agree_to!(contract)
+
+If you've already agreed to a contract and try to agree again, it will raise a ContractDuplicateAgreementError

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/contract_acceptance_framework.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "contract_acceptance_framework/version"
+
+Gem::Specification.new do |s|
+  s.name        = "contract_acceptance_framework"
+  s.version     = ContractAcceptanceFramework::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Adams"]
+  s.email       = ["josh@isotope11.com"]
+  s.homepage    = "http://rubygems.org/gems/contract_acceptance_framework"
+  s.summary     = %q{Allow rails objects to agree to versioned contracts}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = "contract_acceptance_framework"
+
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.6"
+  s.add_development_dependency "rspec", "~> 2.4.0"
+  s.add_development_dependency "sqlite3", "~> 1.3.3"
+
+  s.add_dependency 'activesupport', '~> 3.0.0'
+  s.add_dependency 'activerecord', '~> 3.0.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/contract_acceptance_framework.rb

@@ -0,0 +1,24 @@
+require 'contract_acceptance_framework/contract'
+require 'contract_acceptance_framework/contract_acceptance'
+
+module ContractAcceptanceFramework
+  extend ActiveSupport::Concern
+
+  included do
+    raise "class must inherit from ActiveRecord::Base" unless self < ActiveRecord::Base
+
+    has_many :contract_acceptances, :as => :acceptable
+    has_many :contracts, :through => :contract_acceptances
+
+    def has_agreed_to?(contract)
+      contracts.include?(contract)
+    end
+
+    def agree_to!(contract)
+      raise ContractDuplicateAgreementError if has_agreed_to?(contract)
+      contract_acceptances.create(:contract => contract)
+    end
+  end
+end
+
+class ContractDuplicateAgreementError < StandardError; end

data/lib/contract_acceptance_framework/contract.rb

@@ -0,0 +1,26 @@
+class Contract < ActiveRecord::Base
+  has_many :contract_acceptances
+
+  validates :maintenance_version, :uniqueness => { :scope => [:minor_version, :major_version, :key] }
+  validates :maintenance_version, :minor_version, :major_version, :key, :content, :presence => true
+
+  scope :accepted_by, lambda{|acceptable| joins(:contract_acceptances).where({ :contract_acceptances => { :acceptable_id => acceptable.id, :acceptable_type => acceptable.type } }) }
+  scope :for_key, lambda{|key| where("`key` = ?", key) }
+  scope :by_version, order("major_version DESC, minor_version DESC, maintenance_version DESC")
+
+  # Find the latest contract for a given key, by version number
+  def self.latest(key)
+    for_key(key).by_version.find(:first)
+  end
+
+  # Find the latest accepted contract for a given acceptable, by key
+  def self.latest_accepted(key, acceptable)
+    accepted_by(acceptable).for_key(key).by_version.find(:first)
+  end
+
+  def version=(version_string) # Expects "1.0.2"
+    versions = version_string.split(".")
+    raise "invalid version_string" unless versions.size == 3
+    self.major_version, self.minor_version, self.maintenance_version = versions
+  end
+end

data/lib/contract_acceptance_framework/contract_acceptance.rb

@@ -0,0 +1,8 @@
+class ContractAcceptance < ActiveRecord::Base
+  belongs_to :acceptable, :polymorphic => true
+  belongs_to :contract
+
+  validates_presence_of :acceptable_id
+  validates_presence_of :acceptable_type
+  validates_presence_of :contract_id
+end

data/lib/contract_acceptance_framework/version.rb

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

data/spec/contract_acceptance_framework_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe 'Contract Acceptance Framework' do
+  let(:person) { Person.create }
+  let(:contract) do
+    Contract.create(:major_version => 0, :minor_version => 0,
+                    :maintenance_version => 0, :key => 'unique string',
+                    :content => 'content')
+  end
+
+  describe '.agree_to!' do
+    it 'should agree to the contract' do
+      person.agree_to!(contract)
+      person.contracts.include?(contract).should be_true
+    end
+
+    context 'when the contract has been previously agreed to' do
+      before { person.agree_to!(contract) }
+
+      it 'should raise a contract duplicate agreement error' do
+        lambda { person.agree_to!(contract) }.should raise_error ContractDuplicateAgreementError
+      end
+    end
+  end
+
+  describe '.has_agreed_to?' do
+    subject { person.has_agreed_to?(contract) }
+
+    context 'when the contract has been agreed to' do
+      before { person.agree_to!(contract) }
+      it { should be_true }
+    end
+
+    context 'when the contract has not been agreed to' do
+      it { should be_false }
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+require 'contract_acceptance_framework'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Base.connection.create_table(:contracts) do |t|
+  t.string  :key
+  t.text    :content
+  t.integer :major_version
+  t.integer :minor_version
+  t.integer :maintenance_version
+  t.timestamps
+end
+
+ActiveRecord::Base.connection.create_table(:contract_acceptances) do |t|
+  t.integer :contract_id
+  t.integer :acceptable_id
+  t.string  :acceptable_type
+end
+
+ActiveRecord::Base.connection.create_table(:people)
+
+class Person < ActiveRecord::Base
+  include ContractAcceptanceFramework
+end
+

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification 
+name: contract_acceptance_framework
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Josh Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15424057
+        segments: 
+        - 1
+        - 0
+        - 0
+        - rc
+        - 6
+        version: 1.0.0.rc.6
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 3
+        - 3
+        version: 1.3.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id005
+description: 
+email: 
+- josh@isotope11.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- contract_acceptance_framework.gemspec
+- lib/contract_acceptance_framework.rb
+- lib/contract_acceptance_framework/contract.rb
+- lib/contract_acceptance_framework/contract_acceptance.rb
+- lib/contract_acceptance_framework/version.rb
+- spec/contract_acceptance_framework_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/contract_acceptance_framework
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: contract_acceptance_framework
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Allow rails objects to agree to versioned contracts
+test_files: []
+