acts_as_aliased 0.0.4

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "activerecord", ">= 3.0.0"
+
+group :development do
+  gem "rdoc"
+  gem "bundler"
+  gem "jeweler"
+  gem "rspec"
+  gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+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)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    multi_json (1.3.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0.0)
+  bundler
+  jeweler
+  rdoc
+  rspec
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Thilo Rusche
+
+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,87 @@
+acts_as_aliased
+===============
+
+Extends `ActiveRecord::Base` with a mechanism to create aliases for resources.
+
+Installation
+------------
+
+    gem 'acts_as_aliased'
+
+After updating your bundle, run
+
+    rails generate acts_as_aliased:install
+    rake db:migrate
+
+This will create a new table `aliases`.
+
+Usage
+-----
+
+Let's say you have a model `Company` that requires aliasing because there are different versions of the company name. Enable
+aliasing in your model by using `acts_as_aliased`:
+
+    model Company < ActiveRecord::Base
+      acts_as_aliased
+    end
+
+This assumes a column called `name` on your company model. You can specify a different column by passing a `column` argument:
+
+   model Company < ActiveRecord::Base
+     acts_as_aliased :column => 'title'
+   end
+
+An alias can be created manually like this:
+
+    company = Company.create(name: "foo")
+    ActsAsAliased.create(name: "bar", aliased: company)
+
+But a more common use case is that you have two instances of a model and would like to convert one into an alias of the other. Say
+you have these two companies:
+
+    foo = Company.create(name: "Foo")
+    foollc = Company.create(name: "Foo LLC")
+
+Then you can convert one into an alias for the other like this:
+
+    foo.to_alias!(foollc) # this will DESTROY foo and create a new alias for foollc in it's place
+
+Now let's say you also have a model called `Project` and that a company has many projects:
+
+    model Company < ActiveRecord::Base
+      has_many :projects
+    end
+
+This implies a foreign key `company_id` in the `projects` table. When you convert a company into
+an alias, you'll also want to update those foreign keys. You can accomplish this by passing the associations
+to be updated to `acts_as_alias`:
+
+    model Company < ActiveRecord::Base
+      has_many :projects
+      acts_as_aliased associations: [:projects]
+    end
+
+Finally, to find a model by it's alias, acts_as_aliased implements a `lookup` class method on your model:
+
+    company = Company.create(name: "foo")
+    ActsAsAliased.create(name: "bar", aliased: company)
+
+    Company.lookup("foo")  # returns company
+    Company.lookup("bar")  # also returns company
+
+
+### Contributing to acts_as_aliased
+
+* 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 LegitScript. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# 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 = "acts_as_aliased"
+  gem.homepage = "http://github.com/trusche/acts_as_aliased"
+  gem.license = "MIT"
+  gem.summary = %Q{Alias names for your models}
+  gem.description = %Q{Provides aliases and lookup methods for ActiveRecord models.}
+  gem.email = "thilo.rusche@legitscript.com"
+  gem.authors = ["Thilo Rusche"]
+  gem.version = "0.0.4"
+  gem.files = FileList["[A-Z]*", "{lib,spec}/**/*"]
+  gem.require_paths = ['lib']
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_aliased_2 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/acts_as_aliased.rb

@@ -0,0 +1,53 @@
+require 'active_record'
+
+module ActsAsAliased
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  class Alias < ActiveRecord::Base
+    belongs_to :aliased, polymorphic: true
+    attr_accessible :aliased, :name
+  end
+
+  module ClassMethods
+    def acts_as_aliased options = {}
+      has_many :aliases, as: :aliased, class_name: ::ActsAsAliased::Alias
+
+      cattr_accessor :associations
+      cattr_accessor :column
+      self.associations = options[:associations] || []
+      self.column       = options[:column]       || 'name'
+
+      class_eval <<-EOV
+        include ActsAsAliased::InstanceMethods
+
+        def self.lookup(value)
+          return nil if value.blank?
+          self.send("find_by_#{column}", value) ||
+          Alias.where(["aliased_type = ? AND name = ?", self.to_s, value]).first.try(:aliased)
+        end
+      EOV
+    end
+  end
+
+  module InstanceMethods
+    def to_alias! aliased
+      raise "Cannot create alias for myself" if aliased == self
+      self.class.transaction do
+        a = ::ActsAsAliased::Alias.create(aliased: aliased, name: self[column])
+        associations.each do |association|
+          klass = association.to_s.classify.constantize
+          key   = self.class.to_s.foreign_key
+          klass.where(key => id).update_all(key => aliased.id)
+        end
+        self.destroy
+        a
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActsAsAliased
+end

data/lib/generators/acts_as_aliased/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record/migration'
+
+module ActsAsAliased
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    extend ActiveRecord::Generators::Migration
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_migration_file
+      puts "Adding a migration..."
+      migration_template 'migration.rb', 'db/migrate/create_acts_as_alias_table.rb' rescue puts $!.message
+    end
+
+  end
+end

data/lib/generators/acts_as_aliased/templates/migration.rb

@@ -0,0 +1,13 @@
+class CreatesActsAsAliasedTable < ActiveRecord::Migration
+  def change
+    create_table :aliases do |t|
+      t.integer :aliased_id,    null: false
+      t.string  :aliased_type,  null: false
+      t.string  :name,          null: false
+      t.timestamps
+    end
+
+    add_index :aliases, [:aliased_id, :aliased_type]
+    add_index :aliases, :name
+  end
+end

data/spec/acts_as_aliased_spec.rb

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActsAsAliased" do
+
+  let(:company1) { Company.create(name: "Foo LLC") }
+  let(:company2) { Company.create(name: "Foo") }
+  let(:department1) { Department.create(title: "Technical Staff") }
+  let(:department2) { Department.create(title: "Techies") }
+  let(:project1) { Project.create(name: "Project 1", company: company1, department: department1) }
+  let(:project2) { Project.create(name: "Project 2", company: company2, department: department2) }
+  let(:project3) { Project.create(name: "Project 3", company: company2, department: department2) }
+
+
+  context "creating an alias" do
+    before { clean_database }
+
+    it "should work" do
+      expect {
+        al = ActsAsAliased::Alias.create(name: "Foo", aliased: company1)
+        al.aliased_id.should    == company1.id
+        al.aliased_type.should  == 'Company'
+        al.name.should          == "Foo"
+      }.to change{ ActsAsAliased::Alias.count }.by(1)
+    end
+  end
+
+  context "converting to alias" do
+    before { clean_database }
+
+    it "should create a new alias" do
+      expect {
+        al = company2.to_alias!(company1)
+        al.should be_an(ActsAsAliased::Alias)
+        al.aliased.should == company1
+        al.name.should    == "Foo"
+      }.to change{ ActsAsAliased::Alias.count }.by(1)
+    end
+
+    it "should destroy the resource" do
+      company1
+      company2
+      expect {
+        company2.to_alias!(company1)
+      }.to change{ Company.count }.by(-1)
+    end
+
+    it "should raise an exception on self" do
+      lambda { company1.to_alias!(company1) }.should raise_error
+    end
+
+    context "with associations" do
+      before(:each) do
+        clean_database
+        project1
+        project2
+        project3
+      end
+
+      it "should reassign associations" do
+        company2.to_alias!(company1)
+        company1.reload.should have(3).projects
+      end
+    end
+
+    context "with a different column name" do
+      before(:each) do
+        clean_database
+        department2.to_alias!(department1)
+      end
+
+      it "should work" do
+        Department.lookup("Techies").should == department1
+      end
+    end
+  end
+
+  context "lookup" do
+    before(:each) do
+      clean_database
+      company2.to_alias!(company1)
+    end
+
+    it "should find by aliased name" do
+      Company.lookup("Foo LLC").should == company1
+    end
+
+    it "should find by alias name" do
+      Company.lookup("Foo").should == company1
+    end
+
+    it "should return nil if not found" do
+      Company.lookup("Bar").should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'acts_as_aliased'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end
+
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :aliases do |t|
+    t.integer :aliased_id,    null: false
+    t.string  :aliased_type,  null: false
+    t.string  :name,          null: false
+    t.timestamps
+  end
+
+  add_index :aliases, [:aliased_id, :aliased_type]
+  add_index :aliases, :name
+
+
+  create_table :companies do |t|
+    t.string :name, null: false
+  end
+
+  create_table :departments do |t|
+    t.string :title, null: false
+  end
+
+  create_table :projects do |t|
+    t.string :name, null: false
+    t.integer :company_id, null: false
+    t.integer :department_id, null: false
+  end
+  add_index :projects, :company_id
+  add_index :projects, :department_id
+end
+
+class Project < ActiveRecord::Base
+  belongs_to :company
+  belongs_to :department
+end
+
+class Company < ActiveRecord::Base
+  has_many :projects
+  acts_as_aliased associations: [:projects]
+end
+
+class Department < ActiveRecord::Base
+  has_many :projects
+  acts_as_aliased column: 'title', associations: [:projects]
+end
+
+
+def clean_database
+  models = [ActsAsAliased::Alias, Project, Company, Department]
+  models.each do |model|
+    ActiveRecord::Base.connection.execute "DELETE FROM #{model.table_name}"
+  end
+end
+
+
+

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_aliased
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Thilo Rusche
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides aliases and lookup methods for ActiveRecord models.
+email: thilo.rusche@legitscript.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/acts_as_aliased.rb
+- lib/generators/acts_as_aliased/install_generator.rb
+- lib/generators/acts_as_aliased/templates/migration.rb
+- spec/acts_as_aliased_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/trusche/acts_as_aliased
+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: -3303482588023467799
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Alias names for your models
+test_files: []