activerecord-model-spaces 0.2.0

data/.document

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+script: "JRUBY_OPTS=-J-Djruby.objectspace.enabled=true rake"
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem "rake", ">= 0.8.7"
+gem "activerecord", ">= 2.3.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.12.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.2.3"
+  gem "jeweler", "~> 1.8.4"
+  gem "rcov", ">= 0", :platforms => :mri_18
+  gem "simplecov", ">= 0", :platforms => :mri_19
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rcov (1.0.0)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 2.3.0)
+  bundler (~> 1.2.3)
+  jeweler (~> 1.8.4)
+  rake (>= 0.8.7)
+  rcov
+  rdoc (~> 3.12)
+  rspec (~> 2.12.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 mccraig mccraig of the clan mccraig
+
+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.rdoc

@@ -0,0 +1,98 @@
+= activerecord-model-spaces
+
+{<img src="https://travis-ci.org/mccraigmccraig/activerecord-model-spaces.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mccraigmccraig/activerecord-model-spaces]
+{<img src="https://codeclimate.com/badge.png" alt="Code Climate"/>}[https://codeclimate.com/github/mccraigmccraig/activerecord-model-spaces]
+
+Provides a means of contextually associating sets of ActiveRecord models with database tables through a <tt>table_name</tt> method implementation
+
+This can be used to maintain multiple independent versions of model datasets, for applications including multi-tenancy
+
+Additionally, each model participating in a ModelSpace can optionally be assigned a number of "history versions", and methods are provided to create new or updated versions of the datasets in a ModelSpace without causing locks or large transactions
+
+Models which participate in a ModelSpace need only make sure that they use the <tt>table_name</tt> method whenever they refer to the database table. Since all ActiveRecord methods already do this, it is only application methods which generate SQL which must take care
+
+== Installation
+
+  gem "activerecord-model-spaces", "~> 0.1.0"
+
+== Usage
+
+Include the <tt>ActiveRecord::ModelSpaces</tt> module in a model Class, and declare the model to be part of a ModelSpace, optionally specifying a number of history versions (which defaults to 0) and a base table name (from which contextual table names are constructed, and which defaults to the normal table name)
+
+  require 'active_record/model_spaces'
+
+  class AModel < ActiveRecord::Base
+    include ActiveRecord::ModelSpaces
+
+    in_model_space :metadata, :history_versions=>1, :base_table_name=>"unusual_models"
+  end
+
+Each ModelSpace may have many models associated with it, but each model may only be associated with a single ModelSpace
+
+At this point, the model can be used in ModelSpaces context, and data will be sourced from a different table according to the context, the context key and any history version. Outside of a ModelSpaces context the model will source data from it's usual table
+
+To establish a context use the <tt>with_context</tt> method, which provides a key to be used along with the ModelSpace name to generate the name of the database table to be used by the model for the duration of the context
+
+  AModel.table_name # "unusual_models"
+
+  ActiveRecord::ModelSpaces.with_context(:metadata, :one) do
+    AModel.table_name # "metadata__one__unusual_models"
+  end
+
+If the table to be used by a model within a context does not exist it will be created when the context is created. The created table will have the same schema as the normal model table
+
+If a model is declared as having history_versions then historical copies of the tables will be maintained. New or updated versions of a model can be created using the new_version and updated_version class methods on the model Class, while a context for the ModelSpace is established. The new versions are only visible within the context that they are created in, until the context complete without Error, at which point any new context established for that ModelSpace will use the newly created versions. Table names wrap once the given number of history version tables have been used
+
+  class BModel < ActiveRecord::Base
+    include ActiveRecord::ModelSpaces
+
+    in_model_space :metadata, :history_versions=>1
+  end
+
+  ActiveRecord::ModelSpaces.with_context(:metadata, :one) do
+    AModel.table_name # "metadata__one__unusual_models"
+
+    AModel.new_version do
+      AModel.table_name # "metadata__one__unusual_models__1"
+    end
+
+    AModel.table_name # "metadata__one__unusual_models__1"
+
+    BModel.table_name # "metadata__one__b_models"
+
+    BModel.updated_version do
+      BModel.table_name # "metadata__one__b_models__1"
+    end
+
+    BModel.table_name # "metadata__one__b_models__1"
+  end
+
+  ActiveRecord::ModelSpaces.with_context(:metadata, :one) do
+    AModel.table_name # "metadata__one__unusual_models__1"
+    BModel.table_name # "metadata__one__b_models__1"
+
+    AModel.new_version do
+        AModel.table_name # "metadata__one__unusual_models"
+    end
+
+    AModel.table_name # "metadata__one__unusual_models"
+  end
+
+  ActiveRecord::ModelSpaces.with_context(:metadata, :one) do
+    AModel.table_name # "metadata__one__unusual_models"
+  end
+
+== Contributing to activerecord-model-spaces
+
+* 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) 2013 mccraig mccraig of the clan mccraig. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,55 @@
+# 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 = "activerecord-model-spaces"
+  gem.homepage = "http://github.com/mccraigmccraig/activerecord-model-spaces"
+  gem.license = "MIT"
+  gem.summary = %Q{manage activerecord model to table mappings}
+  gem.description = %Q{map activerecord models to tables depending on context}
+  gem.email = "mccraigmccraig@gmail.com"
+  gem.authors = ["mccraig mccraig of the clan mccraig"]
+  # dependencies defined in Gemfile
+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
+
+RSpec::Core::RakeTask.new(:simplecov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  ENV['SIMPLECOV'] = "true"
+  # `open coverage/index.html`
+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 = "activerecord-model-spaces #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/activerecord-model-spaces.gemspec

@@ -0,0 +1,87 @@
+# 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 = "activerecord-model-spaces"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mccraig mccraig of the clan mccraig"]
+  s.date = "2013-02-20"
+  s.description = "map activerecord models to tables depending on context"
+  s.email = "mccraigmccraig@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "activerecord-model-spaces.gemspec",
+    "lib/active_record/model_spaces.rb",
+    "lib/active_record/model_spaces/context.rb",
+    "lib/active_record/model_spaces/model_space.rb",
+    "lib/active_record/model_spaces/persistor.rb",
+    "lib/active_record/model_spaces/registry.rb",
+    "lib/active_record/model_spaces/table_manager.rb",
+    "lib/active_record/model_spaces/table_names.rb",
+    "lib/active_record/model_spaces/util.rb",
+    "spec/active_record/model_spaces/context_spec.rb",
+    "spec/active_record/model_spaces/model_space_spec.rb",
+    "spec/active_record/model_spaces/persistor_spec.rb",
+    "spec/active_record/model_spaces/registry_spec.rb",
+    "spec/active_record/model_spaces/table_manager_spec.rb",
+    "spec/active_record/model_spaces/table_names_spec.rb",
+    "spec/active_record/model_spaces/util_spec.rb",
+    "spec/active_record/model_spaces_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/mccraigmccraig/activerecord-model-spaces"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "manage activerecord model to table mappings"
+
+  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<rake>, [">= 0.8.7"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.12.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0.8.7"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.12.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/active_record/model_spaces.rb

@@ -0,0 +1,89 @@
+require 'active_record'
+
+require 'active_record/model_spaces/registry'
+
+# Include this module in an ActiveRecord model to enable participation of the model
+# in a ModelSpace.
+#
+# A ModelSpace has a name and, for each model, a number of history versions >= 0
+#
+# Once participating in a ModelSpace, a Context must be established before
+# the model can be used. The context specifies a prefix and manages versioning
+#
+module ActiveRecord
+  module ModelSpaces
+
+    REGISTRY = Registry.new
+
+    def self.included(mod)
+      class << mod
+        include ClassMethods
+      end
+    end
+
+    module_function
+
+    def with_context(model_space_name, model_space_key, &block)
+      REGISTRY.with_context(model_space_name, model_space_key, &block)
+    end
+
+    def active_key(model_space_name)
+      REGISTRY.active_key(model_space_name)
+    end
+
+    def kill_context(model_space_name, model_space_key)
+      REGISTRY.kill_context(model_space_name, model_space_key)
+    end
+
+    def enforce_context
+      REGISTRY.enforce_context
+    end
+
+    def set_enforce_context(ec)
+      REGISTRY.set_enforce_context(ec)
+    end
+
+    module ClassMethods
+
+      # register a model as belonging to a model space
+      def in_model_space(model_space_name, opts={})
+        REGISTRY.register_model(self, model_space_name, opts)
+      end
+
+      def set_table_name(table_name)
+        REGISTRY.set_base_table_name(self, table_name)
+      end
+
+      def table_name=(table_name)
+        REGISTRY.set_base_table_name(self, table_name)
+      end
+
+      def table_name
+        ActiveRecord::ModelSpaces::REGISTRY.table_name(self)
+      end
+
+      def current_table_name
+        REGISTRY.current_table_name(self)
+      end
+
+      def working_table_name
+        REGISTRY.working_table_name(self)
+      end
+
+      # create a new version of the model
+      def new_version(&block)
+        REGISTRY.new_version(self, &block)
+      end
+
+      # create an updated version of the model
+      def updated_version(&block)
+        REGISTRY.updated_version(self, &block)
+      end
+
+      def hoover
+        REGISTRY.hoover(self)
+      end
+    end
+
+  end
+end