augmentor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3338e4fc05b991fc6efe290d597900bfc9255b7b
+  data.tar.gz: c86b54664ac2efd2948cc6c0871b43385cddad5e
+SHA512:
+  metadata.gz: 97e003096833906a362dc0adb295b48bab2c85bcb4354b6c91b3fc72260581ff82c9bfaeaa666c0f16897f5b488450911eb84b28faecff73288e3abbf0eb4d02
+  data.tar.gz: 36112dfbaca7c47441639ce3d8c4f7c6f5a9450996633fc71b4238862d5c42f31454d8012aac52270d94f4d7c048853d12fb4d02c0dc5d814be3a5c5c5ba173f

data/.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+pkg
+*.gem
+*.rbc
+.bundle
+.config
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 chaunce - chaunce.slc@gmail.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,62 @@
+# augmentor
+
+Augment an ActiveRecord class by including additional ActiveRecord classes
+
+The Augmentor gem allows an ActiveRecord class to inherit all attributes and methods from one or more other ActiveRecord classes, including those provided by ActiveRecord such as getters and setters, as local.
+
+This allows you to effectively span the data stored for an ActiveRecord class across multiple table without using ActiveRecord relations to get or set the data.  To ensure best performance, data 
+
+## Dependencies
+
+the following gems are required
+
+    gem 'rails', '>= 3.2'
+
+## Installation
+
+install manually
+
+    gem install augmentor
+
+or add it to your Gemfile
+
+    gem 'augmentor'
+
+## Usage
+
+### Update Database
+
+#### create migration to add augmentor associations field to an existing class
+
+    rails generate augmentor:augment user person
+    rake db:migrate
+
+#### or create migration to add augmentor associations field to a new class
+
+    rails generate model person first_name:string, last_name:string, user:augment
+    rake db:migrate
+
+### Update Models
+
+#### include in the augmented class
+
+    class User < ActiveRecord::Base
+      augmented_by :person
+    
+    end
+
+#### include in the augmenting class
+
+    class Person < ActiveRecord::Base
+      augment :user
+    
+    end
+
+##### Notes
+
+augmentor associations accepts many ActiveRecord association options, but will only associate one level deep and can not use :through
+
+    class User < ActiveRecord::Base
+      augmented_by :individual, class_name: :person, inverse_of: :user
+      
+    end

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the augmentor gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the augmentor gem.'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'augmentor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/augmentor.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'augmentor/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name    = 'augmentor'
+  s.version = Augmentor::Version.string
+  s.date    = Date.today
+
+  s.summary     = 'Augment an ActiveRecord class by including additional extension classes'
+  s.description = 'Augment an ActiveRecord class by including one or moe additional ActiveRecord extension classes.  The augmented class will inherit all attributes and methods, including those provided by ActiveRecord such as getters and setters, as local.'
+  s.license     = 'MIT'
+
+  s.author   = 'chaunce'
+  s.email    = 'chaunce.slc@gmail.com'
+  s.homepage = 'http://github.com/chaunce/augmentor'
+
+  s.has_rdoc = false
+  s.rdoc_options = ['--line-numbers', '--inline-source', '--main', 'README.rdoc']
+
+  s.require_paths = ['lib']
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency('rails', ['>= 3.2'])
+  s.add_development_dependency('sqlite3')
+end

data/lib/augmentor.rb

@@ -0,0 +1,91 @@
+require 'active_support'
+require 'active_record'
+
+module Augmentor
+  autoload :Version, 'augmentor/version'
+
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def augment(*args)
+        validate_augmentor_args(args)
+        klass, options, klass_name = parse_augmentor_args(args)
+        belongs_to klass, options
+        validates_presence_of :"#{klass}"
+      end
+
+      def augmented_by(*args)
+        validate_augmentor_args(args)
+        klass, options, klass_name = parse_augmentor_args(args)
+        has_one klass, {dependent: :destroy, inverse_of: :"#{self.name.underscore}"}.merge(options)
+        define_method "#{klass}_must_be_valid" do
+          if self.send(klass).valid?
+            true
+          else
+            self.errors.messages.merge!(self.send(klass).errors.messages)
+            false
+          end
+        end
+        validate :"#{klass}_must_be_valid"
+
+        define_method "#{klass}_with_autobuild" do
+          self.send(:"#{klass}_without_autobuild") || self.send(:"build_#{klass}")
+        end
+        alias_method_chain :"#{klass}", :autobuild
+
+        after_initialize do
+          all_attributes = klass_name.constantize.content_columns.map(&:name)
+          attributes_to_delegate = all_attributes - self.class.content_columns.map(&:name)
+          attributes_to_delegate.each do |attrib|
+            class_eval <<-RUBY
+              def #{attrib}
+                #{klass}.#{attrib}
+              end
+              def #{attrib}=(value)
+                self.#{klass}.#{attrib} = value
+              end
+              def #{attrib}?
+                self.#{klass}.#{attrib}?
+              end
+            RUBY
+          end
+        end
+      end
+
+    private
+
+      def validate_augmentor_args(args)
+        raise ArgumentError, "wrong number of arguments (#{args.length} for 1+)" unless args.length >= 1
+      end
+      def parse_augmentor_args(args)
+        parse_args = args.dup
+        options = args.extract_options!
+        klass = args.first
+        klass_name = options[:class_name] || klass.to_s.classify
+        return klass, options, klass_name
+      end
+    end
+
+  end
+
+  module SchemaDefinitions
+    module AugmentMethod
+      def augment(*args)
+        options = (args.extract_options!).merge({index:true})
+        args.each do |col|
+          column("#{col}_id", :integer, options)
+        end
+      end
+    end
+    def self.load!
+      ::ActiveRecord::ConnectionAdapters::TableDefinition.class_eval { include Augmentor::SchemaDefinitions::AugmentMethod }
+    end
+  end
+
+end
+
+ActiveSupport.on_load :active_record do
+  Augmentor::SchemaDefinitions.load!
+  ActiveRecord::Base.send(:include, Augmentor::ActiveRecord)
+end

data/lib/augmentor/version.rb

@@ -0,0 +1,17 @@
+module Augmentor
+  # Contains information about this gem's version
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
+    #
+    # Example
+    #
+    #   Version.string # '1.0.2'
+    def self.string
+      [MAJOR, MINOR, PATCH].join('.')
+    end
+  end
+end

data/lib/generators/augmentor/augment_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module Augmentor
+  module Generators
+    class AugmentGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :augmented_class, :type => :string
+      argument :extension_class, :type => :string
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def copy_migration
+        migration_template 'augment_migration.rb', "db/migrate/add_#{extension_class.underscore.singularize}_as_augmentor_to_#{augmented_class.underscore.singularize}.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/augmentor/templates/augment_migration.rb

@@ -0,0 +1,7 @@
+class Add<%= extension_class.camelize.singularize %>AsAugmentorTo<%= augmented_class.camelize.singularize %> < ActiveRecord::Migration
+  def change
+    change_table :<%= extension_class.underscore.pluralize %> do |t|
+      t.augment :<%= augmented_class.underscore.singularize %>, index: true
+    end
+  end
+end

data/test/augmentor_test.rb

@@ -0,0 +1,83 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class AugmentorTest < Test::Unit::TestCase
+  def setup
+    @name = 'John Doe'
+    @password = 'p@$$w0rd'
+    @login = 'john'
+    @user_count = User.count
+    @person_count = Person.count
+  end
+
+  def test_associations_are_implemented
+    user = User.new
+    assert user.person.present?
+  end
+
+  def test_can_set_save_and_get_augmentor_attributes
+    user = User.new
+    user.name = @name
+    user.login = @login
+    user.password = @password
+    user.save!
+    user = User.find(user.id)
+    assert_equal @name, user.name
+    assert_equal @login, user.login
+    assert_equal @password, user.password
+    assert_equal @user_count+1, User.count
+    assert_equal @person_count+1, Person.count
+    assert_equal @name, Person.last.attributes['name']
+    assert_equal @login, User.last.attributes['login']
+    assert_equal @password, User.last.attributes['password']
+  end
+
+  def test_destroy_augmented_will_destroy_augmentor
+    user = User.new
+    user.name = @name
+    user.login = @login
+    user.password = @password
+    user.save
+    assert_equal @user_count+1, User.count
+    assert_equal @person_count+1, Person.count
+    user_id = user.id
+    person_id = user.person.id
+    user.destroy
+    assert_equal @user_count, User.count
+    assert_equal @person_count, Person.count
+    assert !User.exists?(user_id)
+    assert !Person.exists?(person_id)
+  end
+  
+  def test_inherits_augmentor_methods
+    person_jim = Person.new
+    person_jim.name = 'jim'
+    assert person_jim.is_jim?
+    person_jim.name = 'bob'
+    assert !person_jim.is_jim?
+
+    user_jim = User.new
+    assert user_jim.respond_to? :is_jim?
+    user_jim.name = 'jim'
+    assert user_jim.is_jim?
+    user_jim.name = 'bob'
+    assert !user_jim.is_jim?
+  end
+  
+  def test_may_override_augmentor_methods
+    person_bob = Person.new
+    person_bob.name = 'bob'
+    assert person_bob.is_bob?
+    person_bob.name = 'robert'
+    assert !person_bob.is_bob?
+
+    user_bob = User.new
+    assert user_bob.respond_to? :is_bob?
+    user_bob.name = 'bob'
+    assert user_bob.is_bob?
+    user_bob.name = 'robert'
+    assert user_bob.is_bob?
+    user_bob.name = 'jim'
+    assert !user_bob.is_bob?
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,41 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+require 'augmentor'
+
+require 'active_record'
+require 'sqlite3'
+require 'test/unit'
+require 'debugger'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :people do |t|
+    t.string :name
+    t.augment :user
+  end
+  create_table :users do |t|
+    t.string :login
+    t.string :password
+  end
+end
+
+class Person < ActiveRecord::Base
+  augment :user
+
+  def is_bob?
+    self.name == 'bob'
+  end
+
+  def is_jim?
+    self.name == 'jim'
+  end
+end
+
+class User < ActiveRecord::Base
+  augmented_by :person
+
+  def is_bob?
+    ['robert', 'rob', 'bob'].include?(self.name)
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: augmentor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- chaunce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Augment an ActiveRecord class by including one or moe additional ActiveRecord
+  extension classes.  The augmented class will inherit all attributes and methods,
+  including those provided by ActiveRecord such as getters and setters, as local.
+email: chaunce.slc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- MIT-LICENSE
+- README.md
+- Rakefile
+- augmentor.gemspec
+- lib/augmentor.rb
+- lib/augmentor/version.rb
+- lib/generators/augmentor/augment_generator.rb
+- lib/generators/augmentor/templates/augment_migration.rb
+- test/augmentor_test.rb
+- test/test_helper.rb
+homepage: http://github.com/chaunce/augmentor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: Augment an ActiveRecord class by including additional extension classes
+test_files:
+- test/augmentor_test.rb
+- test/test_helper.rb
+has_rdoc: false