can_be 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log/*.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Starkman
+
+MIT License
+
+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,84 @@
+# CanBe [![Build Status](https://secure.travis-ci.org/mstarkman/can_be.png?branch=master)](https://travis-ci.org/mstarkman/can_be)
+
+Adds helper methods to your Active Record models to control the type of record.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'can_be'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install can_be
+
+## Usage
+
+Before adding it to your model, you will need to add a database field to
+your model.  By default, the `can_be` gem expects your field to be
+called `can_be_type`.  However, this can be changed.
+
+```ruby
+class AddCanBeTypeToAddresses < ActiveRecord::Migration
+  def change
+    add_column :addresses, :can_be_type, :string
+    add_index :addresses, :can_be_type
+  end
+end
+```
+
+Once you've installed the gem, you will have access to the `can_be` method in your models.  The `can_be` method will take a list of types (as symbols) that your model can be represented as.
+
+```ruby
+class Address < ActiveRecord::Base
+  can_be :home_address, :work_address, :vacation_address
+end
+```
+
+### Methods Added to your model
+
+The following methods will then be added to your model for each of the types based on the example above.
+
+#### Class Methods
+
+* `create_home_address` - Creates a new address model in the database with the type of `home_address`
+* `find_by_can_be_types` - Accepts a list of types and returns the results of the database query (note: this is only added once, not for each type)
+* `home_addresses` - Returns a list of the records with a type of `home_address`
+* `new_home_address` - Instantiates a new address model instance with the type of `home_address`
+
+#### Instance Methods
+
+* `change_to_home_address` - Changes the record to a `home_address` type (does not save it to the database)
+* `change_to_home_address!` - Changes the record to a `home_address` type and saves it to the database
+* `home_address?` - Returns true if the record is a `home_address` type
+
+### Options
+
+The following options can be added to the `can_be` method call.
+
+* `default_type` - Sets the default value for when a new record is instantiated (it is the first value in the list by default)
+* `field_name` - Sets the ActiveRecord field name that is to be used (by default it expects a `can_be_type` field to be present)
+
+Here is an example.
+
+```ruby
+class Person < ActiveRecord::Base
+  can_be :male, :female, field_name: :gender, default_type: :female
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See [LICENSE.txt](https://github.com/mstarkman/can_be/blob/master/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/can_be.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'can_be/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "can_be"
+  gem.version       = CanBe::VERSION
+  gem.authors       = ["Mark Starkman"]
+  gem.email         = ["mrstarkman@gmail.com"]
+  gem.description   = %q{Adds helper methods to your Active Record models to control the type of record.}
+  gem.summary       = %q{Adds helper methods to your Active Record models to control the type of record.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('rspec', '~> 2.0')
+  gem.add_development_dependency('sqlite3')
+  gem.add_development_dependency('database_cleaner')
+  gem.add_development_dependency('rake')
+
+  gem.add_dependency("activerecord", "~> 3.1")
+  gem.add_dependency("activesupport", "~> 3.1")
+end

data/lib/can_be.rb

@@ -0,0 +1,8 @@
+require "can_be/version"
+require "can_be/initializer"
+require "can_be/model_extensions"
+require "can_be/railtie" if defined? Rails
+
+module CanBe
+end
+

data/lib/can_be/initializer.rb

@@ -0,0 +1,90 @@
+module CanBe
+  class Initializer
+    def initialize(klass, types, options = {})
+      @klass = klass
+      @types = types
+      @options = parse_options(options)
+    end
+
+    def define_methods
+      define_instance_methods
+      define_class_methods
+      define_validations
+    end
+
+    private
+    def parse_options(options)
+      if options.nil?
+        default_options
+      else
+        default_options.merge(options)
+      end
+    end
+
+    def default_options
+      {
+        field_name: :can_be_type,
+        default_type: @types.first
+      }
+    end
+
+    def define_instance_methods
+      field_name = @options[:field_name]
+
+      @types.each do |t|
+        @klass.instance_eval do
+          define_method "#{t}?" do
+            send(field_name) == t
+          end
+
+          define_method "change_to_#{t}" do
+            send("#{field_name}=", t)
+          end
+
+          define_method "change_to_#{t}!" do
+            update_attributes(field_name => t)
+          end
+        end
+      end
+    end
+
+    def define_class_methods
+      field_name = @options[:field_name]
+      default_type = @options[:default_type]
+
+      @types.each do |t|
+        @klass.class_eval <<-EVAL
+          def self.create_#{t}(attributes = {}, options = {}, &block)
+            attributes[:#{field_name}] = '#{t}'
+            create(attributes, options, &block)
+          end
+
+          def self.new_#{t}(attributes = {}, options = {})
+            attributes[:#{field_name}] = '#{t}'
+            new(attributes, options)
+          end
+
+          def self.find_by_can_be_types(*types)
+            where(#{field_name}: types)
+          end
+
+          def self.#{t.pluralize}
+            where(#{field_name}: '#{t}')
+          end
+
+          after_initialize do |model|
+            model.#{field_name} = '#{default_type}' if model.#{field_name}.nil?
+          end
+        EVAL
+      end
+    end
+
+    def define_validations
+      field_name = @options[:field_name]
+
+      @klass.class_eval <<-EVAL
+        validates_inclusion_of :#{field_name}, in: ['#{@types.join(',').gsub(/,/, "', '")}']
+      EVAL
+    end
+  end
+end

data/lib/can_be/model_extensions.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+
+module CanBe
+  module ModelExtensions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def can_be(*types)
+        if types.last.is_a?(Hash)
+          options = types.last
+          types.delete types.last
+        end
+
+        CanBe::Initializer.new(self, types.map(&:to_s), options).define_methods
+      end
+    end
+  end
+end

data/lib/can_be/railtie.rb

@@ -0,0 +1,9 @@
+module CanBe
+  class Railtie < Rails::Railtie
+    initializer 'can_be.model_additions' do
+      ActiveSupport.on_load :active_record do
+        include CanBe::ModelExtensions
+      end
+    end
+  end
+end

data/lib/can_be/version.rb

@@ -0,0 +1,3 @@
+module CanBe
+  VERSION = "0.1.0"
+end

data/spec/can_be/model_additions_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+describe CanBe::ModelExtensions do
+  context "instance methods" do
+    describe "boolean record methods" do
+      it "are created" do
+        rec = new_address
+        rec.should respond_to :home_address?
+        rec.should respond_to :work_address?
+      end
+
+      it "responds true" do
+        new_address(:home_address).should be_home_address
+        new_address(:work_address).should be_work_address
+      end
+
+      it "responds false" do
+        new_address(:work_address).should_not be_home_address
+      end
+    end
+
+    describe "change_to methods" do
+      it "are created" do
+        rec = new_address
+        rec.should respond_to :change_to_home_address
+        rec.should respond_to :change_to_work_address
+      end
+
+      it "updates the record" do
+        rec = new_address(:work_address)
+        rec.change_to_home_address
+        rec.should be_home_address
+      end
+
+      it "does not update the database" do
+        rec = create_address(:work_address)
+        rec.change_to_home_address
+        Address.first.should_not be_home_address
+      end
+    end
+
+    describe "change_to! methods" do
+      it "are created" do
+        rec = create_address
+        rec.should respond_to :change_to_home_address!
+        rec.should respond_to :change_to_work_address!
+      end
+
+      it "updates the record" do
+        rec = create_address(:work_address)
+        rec.change_to_home_address!
+        rec.should be_home_address
+      end
+
+      it "updates the database" do
+        rec = create_address(:work_address)
+        rec.change_to_home_address!
+        Address.first.should be_home_address
+      end
+    end
+  end
+
+  context "class methods" do
+    describe "create methods" do
+      it "are created" do
+        Address.should respond_to :create_home_address
+        Address.should respond_to :create_work_address
+      end
+
+      it "create the records in the database" do
+        a = Address.create_home_address
+        Address.find(a.id).should be_home_address
+
+        a = Address.create_work_address
+        Address.find(a.id).should be_work_address
+      end
+
+      it "creates the records changing to the correct type" do
+        a = Address.create_home_address can_be_type: 'work_address'
+        Address.find(a.id).should be_home_address
+      end
+    end
+
+    describe "new methods" do
+      it "are created" do
+        Address.should respond_to :new_home_address
+        Address.should respond_to :new_work_address
+      end
+
+      it "create the correct type" do
+        Address.new_home_address.should be_home_address
+        Address.new_work_address.should be_work_address
+      end
+
+      it "create the records changing to the correct type" do
+        Address.create_home_address(can_be_type: 'work_address').should be_home_address
+      end
+
+      it "don't create the records in the database" do
+        Address.new_home_address
+        Address.new_work_address
+        Address.count.should == 0
+      end
+    end
+
+    describe "finder methods" do
+      let(:home_count) { 5 }
+      let(:work_count) { 4 }
+      let(:vacation_count) { 3 }
+
+      before :each do
+        home_count.times { Address.create_home_address }
+        work_count.times { Address.create_work_address }
+        vacation_count.times { Address.create_vacation_address }
+      end
+
+      it "are created" do
+        Address.should respond_to :find_by_can_be_types
+        Address.should respond_to 'home_address'.pluralize
+        Address.should respond_to 'work_address'.pluralize
+      end
+
+      it "#find_by_can_be_types returns the correct records" do
+        recs = Address.find_by_can_be_types(:home_address, :work_address)
+        recs.should have(home_count + work_count).items
+        recs.each do |a|
+          a.can_be_type.should =~ /^home_address|work_address$/
+        end
+      end
+
+      it "returns the correct records" do
+        recs = Address.home_addresses
+        recs.should have(home_count).items
+        recs.each { |a| a.should be_home_address }
+
+        recs = Address.work_addresses
+        recs.should have(work_count).items
+        recs.each { |a| a.should be_work_address }
+      end
+    end
+  end
+
+  context "default type" do
+    it "uses the first type as the default" do
+      Address.new.should be_home_address
+    end
+
+    it "uses the specified default_type option" do
+      Person.new.should be_female
+    end
+  end
+
+  context "database field" do
+    it "uses the :can_be_type field (default)" do
+      Address.new_home_address.can_be_type.should == 'home_address'
+    end
+
+    it "uses the specified field" do
+      Person.new_female.gender.should == 'female'
+    end
+  end
+
+  context "validity of type value" do
+    it "should be valid" do
+      Address.new_home_address.should be_valid
+      Address.new_work_address.should be_valid
+    end
+
+    it "should not be valid" do
+      Address.new(can_be_type: 'invalid type').should_not be_valid
+    end
+  end
+end

data/spec/can_be_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe CanBe do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'active_record'
+require 'database_cleaner'
+require 'logger'
+require 'support/model_macros'
+
+require 'can_be'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "../log/debug.log"))
+ActiveRecord::Base.send(:include, CanBe::ModelExtensions)
+
+# now that we have the database configured, we can create the models and
+# migrate the database
+require 'support/models'
+
+RSpec.configure do |config|
+  config.include ModelMacros
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/model_macros.rb

@@ -0,0 +1,9 @@
+module ModelMacros
+  def new_address(can_be_type = 'home')
+    Address.new(can_be_type: can_be_type.to_s)
+  end
+
+  def create_address(can_be_type = 'home')
+    Address.create(can_be_type: can_be_type.to_s)
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+load File.dirname(__FILE__) + '/schema.rb'
+
+# The Address model will use the default options
+class Address < ActiveRecord::Base
+  can_be :home_address, :work_address, :vacation_address
+end
+
+class Person < ActiveRecord::Base
+  can_be :male, :female, field_name: :gender, default_type: :female
+end

data/spec/support/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :addresses, :force => true do |t|
+    t.string :can_be_type
+    t.timestamps
+  end
+
+  create_table :people, :force => true do |t|
+    t.string :gender
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: can_be
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Starkman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: rake
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Adds helper methods to your Active Record models to control the type
+  of record.
+email:
+- mrstarkman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- can_be.gemspec
+- lib/can_be.rb
+- lib/can_be/initializer.rb
+- lib/can_be/model_extensions.rb
+- lib/can_be/railtie.rb
+- lib/can_be/version.rb
+- log/.gitkeep
+- spec/can_be/model_additions_spec.rb
+- spec/can_be_spec.rb
+- spec/spec_helper.rb
+- spec/support/model_macros.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Adds helper methods to your Active Record models to control the type of record.
+test_files:
+- spec/can_be/model_additions_spec.rb
+- spec/can_be_spec.rb
+- spec/spec_helper.rb
+- spec/support/model_macros.rb
+- spec/support/models.rb
+- spec/support/schema.rb