can_be 0.2.1 → 0.3.0

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/CHANGELOG.md

@@ -1,11 +1,20 @@
-## Version 0.1.0
+## [Version 0.3.0](https://github.com/mstarkman/can_be/tree/v0.3.0)
 
-Initial release.
+* Allowed the options to be specified inside the can_be method call block
+* Added a block processor to each of the `change_to` methods
+* Added the ability to configure the relationship name
+* Implemented a set of custom RSpec matcher
+* History can be kept to easily get back to data after switching can_be types
+* Fixed issue where calling a change_to method didn't destroy the original details record upon save
+
+## [Version 0.2.1](https://github.com/mstarkman/can_be/tree/v0.2.1)
+
+Changed the way that the details models are added.
 
-## Version 0.2.0
+## [Version 0.2.0](https://github.com/mstarkman/can_be/tree/v0.2.0)
 
 Added details functionality for storing custom fields per type.
 
-## Version 0.2.1
+## [Version 0.1.0](https://github.com/mstarkman/can_be/tree/v0.1.0)
 
-Changed the way that the details models are added.
+Initial release.

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    can_be (0.3.0)
+      activerecord (~> 3.1)
+      activesupport (~> 3.1)
+
+GEM
+  remote: https://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)
+    coderay (1.0.8)
+    database_cleaner (0.9.1)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (10.0.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    slop (3.3.3)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  can_be!
+  database_cleaner
+  pry
+  rake
+  rspec (~> 2.0)
+  sqlite3

data/README.md

@@ -1,6 +1,12 @@
-# CanBe [![Build Status](https://secure.travis-ci.org/mstarkman/can_be.png?branch=master)](https://travis-ci.org/mstarkman/can_be) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mstarkman/can_be)
+# CanBe [![Build Status](https://secure.travis-ci.org/mstarkman/can_be.png?branch=master)](https://travis-ci.org/mstarkman/can_be) [![Gem Version](https://badge.fury.io/rb/can_be.png)](http://badge.fury.io/rb/can_be) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mstarkman/can_be)
 
-CanBe allows you to track the type of your ActiveRecord model in a consistent simple manner.  With just a little configuration on your part, each type of record can contain different attributes that are specifc to that type of record.  From a data modelling perspective this is preferred over [ActiveRecord STI](http://api.rubyonrails.org/classes/ActiveRecord/Base.html#label-Single+table+inheritance) since you will not have many columns in your database that have null values.  Under the hood, CanBe uses one-to-one [Polymorphic Associations](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations) to accomplish the different attributes per type.
+CanBe allows you to track the type of your ActiveRecord model in a consistent simple manner.  With just a little configuration on your part, each type of record can contain different attributes that are specific to that type of record.  From a data modeling perspective this is preferred over [ActiveRecord STI](http://api.rubyonrails.org/classes/ActiveRecord/Base.html#label-Single+table+inheritance) since you will not have many columns in your database that have null values.  Under the hood, CanBe uses one-to-one [Polymorphic Associations](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations) to accomplish the different attributes per type.
+
+Here is a blog post that will describe more of the rationale behind the CanBe gem: [http://blog.markstarkman.com/blog/2013/01/09/writing-my-first-rubygem-canbe/](http://blog.markstarkman.com/blog/2013/01/09/writing-my-first-rubygem-canbe/)
+
+## Versioning
+
+I will be following [Semantic Versioning](http://semver.org/) as closely as possible.  The `master` branch will be the latest development version and may not match the version of the code you are using. There is a git tag for each released version.  The [CHANGELOG.md](https://github.com/mstarkman/can_be/blob/master/CHANGELOG.md) will contain the correct links to each version.
 
 ## Installation
 
@@ -8,13 +14,21 @@ Add this line to your application's Gemfile:
 
     gem 'can_be'
 
+If you feel like living on the edge, you can add this to your applications' Gemfile:
+
+    gem 'can_be', git: "git://github.com/mstarkman/can_be.git"
+
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Documentation 
+
+The documentation for the basic implementation of CanBe can be found in this readme.  Here is the documentation for the other features.
 
-    $ gem install can_be
+* [Different Attributes per CanBe Type (details)](https://github.com/mstarkman/can_be/blob/master/docs/details.md)
+* [Keeping Details History When Changing CanBe Types](https://github.com/mstarkman/can_be/blob/master/docs/history.md)
+* [Custom RSpec Matchers](https://github.com/mstarkman/can_be/blob/master/docs/rspec_matcher.md)
 
 ## Database Configuration (via migrations)
 
@@ -31,23 +45,7 @@ class AddCanBeTypeToAddresses < ActiveRecord::Migration
 end
 ```
 
-### Details Configuration
-
-If you want to store different attributes (columns), there are some more columns that you will need to add to your model, `details_id` and `details_type`.  These fields will be used to store the relationships to the details information.  Indexing these columns is your choice.
-
-Example migration:
-
-```ruby
-class AddCanBeDetailsToAddresses < ActiveRecord::Migration
-  def change
-    add_column :addresses, :details_id, :integer
-    add_column :addresses, :details_type, :string
-    add_index :addresses, [:details_id, :details_type]
-  end
-end
-```
-
-You will also need to create the models that will be used to represent the details attributes for each type.  You will need to configure the model to be a details model be calling the `can_be_detail` method in your model.  You do not need to specify a details model for each CanBe type if there are not any extra attributes required for that type.
+**NOTE:** Examples of the database migrations can be found in the [`spec/support/schema.rb`](https://github.com/mstarkman/can_be/blob/master/spec/support/schema.rb) file.
 
 ## Model Configuration
 
@@ -73,44 +71,36 @@ class Person < ActiveRecord::Base
 end
 ```
 
-### Details Model Configuration
-
-In order to wire up a model to be a CanBe details model, you will need to call the `can_be_detail` method on that model.
-
-```ruby
-class HomeAddressDetail < ActiveRecord::Base
-  can_be_detail :address
-end
-```
-The `can_be_detail` method take in one parameter.  The parameter is the link to the CanBe model.  This must be a symbol that will reference the CanBe model.  In order to create the proper symbol, you can execute the following into your Rails console: `<ModelName>.name.underscore.to_sym`.  Here is an example: `Address.name.underscore.to_sym`.  In the above example, this will be used for the `Address` CanBe model.
-
-You will also need to call the `add_details_model` method in the `can_be` block, passing in the CanBe type and a symbol that represets the details model class.
+Or you can set the options in a block when calling `can_be`.
 
 ```ruby
-class Address < ActiveRecord::Base
-  can_be :home_address, :work_address, :vacation_address do
-    add_details_model :home_address, :home_address_detail
+class Person < ActiveRecord::Base
+  can_be :male, :female do
+    field_name :gender
+    default_type :female
   end
 end
 ```
 
+**NOTE:** Examples of the model configurations can be found in the [`spec/support/models.rb`](https://github.com/mstarkman/can_be/blob/master/spec/support/models.rb) file.
+
 ## Usage
 
 The CanBe gem will provide you a lot methods to handle your type processing in an easy and consistent manner.
 
 ### Instantiating New Models
 
-You can continue to instantiate your CanBe models by using the `new` method.  When you do, CanBe will ensure that the type of the record is assigned the detault CanBe type for your model.
+You can continue to instantiate your CanBe models by using the `new` method.  When you do, CanBe will ensure that the type of the record is assigned the default CanBe type for your model.
 
 There are also some helper methods put on your model to make it easier to instantiate the type of model that you want.  These methods will take the form of `new_<CanBe type>`.  For example, you can call `Address.new_home_address`.  These methods will take the same parameters as the base `new` method provided by ActiveRecord.
 
 ### Creating New Models
 
-You can continue to create your CanBe models by using the `create` method.  When you do, CanBe will ensure that the type of the record is assigned the detault CanBe type for your model.
+You can continue to create your CanBe models by using the `create` method.  When you do, CanBe will ensure that the type of the record is assigned the default CanBe type for your model.
 
 There are also some helper methods put on your model to make it easier to create the type of model that you want.  These methods will take the form of `create_<CanBe type>`.  For example, you can call `Address.create_home_address`.  These methods will take the same parameters as the base `create` method provided by ActiveRecord.
 
-### Changing CanBe Types
+### Changing CanBe Types (the "change_to" methods)
 
 There are several ways to change the type of record that you are working with.  You can access the `can_be_type` attribute (or other attribute if you specified the field to be used) and change the value directly.
 
@@ -120,9 +110,7 @@ You can change the type of record and not persist it immediately to the database
 
 If you want to change the type of the record and persist it to the database immediately, you can call the appropriate `change_to_<CanBe type>!` method.  For example, this method call will change the type of record to `:work_address` and persist the change to the database: `Address.create.change_to_work_address!`
 
-There is a validator for the CanBe field, that will unsure that the CanBe field is set to one of the CanBe types before persisting the record. 
-
-NOTE: that when you are changing the type of record the details record will be changed to the correct CanBe details record.  New records will only be persisted to the database when the CanBe model is persisted.  If you change the CanBe model to a type that does not have a corresponding details model, `nil` will be stored for the details.
+There is a validator for the CanBe field, that will ensure that the CanBe field is set to one of the CanBe types before persisting the record.
 
 ### Boolean Evaluation
 
@@ -134,12 +122,6 @@ There are two ways to find specific types of records.  You can use the `find_by_
 
 Methods are also defined on your CanBe model that will find all of the records for a specific CanBe type.  These methods take the form of `<pluralized CanBe type>`.  For example, `Address.home_addresses` would return all of the records with a type of `:home_address`.
 
-### Accessing the Details
-
-If you want to access the details model, you can call the `details` method on your instance and the instance of your model will be returned.  If the type of model that you are using does not have a details model, `nil` will be returned.
-
-When you persist your CanBe model to the database, your details model will automatically be persisted.
-
 ## Contributing
 
 1. Fork it

data/can_be.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('sqlite3')
   gem.add_development_dependency('database_cleaner')
   gem.add_development_dependency('rake')
+  gem.add_development_dependency('pry')
 
   gem.add_dependency("activerecord", "~> 3.1")
   gem.add_dependency("activesupport", "~> 3.1")

data/docs/details.md

@@ -0,0 +1,94 @@
+# Different Attributes per CanBe Type (details) #
+
+CanBe can all you to store different attributes (columns) for each CanBe type that you define.  This document will show you the implementation details.
+
+## Database Migrations ##
+
+If you want to store different attributes (columns), there are some more columns that you will need to add to your model, `details_id` and `details_type`.  These fields will be used to store the relationships to the details information.  Indexing these columns is your choice.  Example migration:
+
+```ruby
+class AddCanBeDetailsToAddresses < ActiveRecord::Migration
+  def change
+    add_column :addresses, :details_id, :integer
+    add_column :addresses, :details_type, :string
+    add_index :addresses, [:details_id, :details_type]
+  end
+end
+```
+
+You will also need to create the models that will be used to represent the details attributes for each type.  You will need to configure the model to be a details model be calling the `can_be_detail` method in your model.  You do not need to specify a details model for each CanBe type if there are not any extra attributes required for that type.
+
+If you planning to use a different `details_name` for the relationship, you will need to change the names of the database columns to have the appropriate `id` and `type` columns. For example, if you wanted to use `:address_details` as the `details_name`, you would do this.
+
+```ruby
+class AddCanBeDetailsToAddresses < ActiveRecord::Migration
+  def change
+    add_column :addresses, :address_details_id, :integer
+    add_column :addresses, :address_details_type, :string
+    add_index :addresses, [:address_details_id, :address_details_type]
+  end
+end
+```
+
+**NOTE:** Examples of the database migrations can be found in the [`spec/support/schema.rb`](https://github.com/mstarkman/can_be/blob/master/spec/support/schema.rb) file.
+
+## Models ##
+
+In order to wire up a model to be a CanBe details model, you will need to call the `can_be_detail` method on that model.
+
+```ruby
+class HomeAddressDetail < ActiveRecord::Base
+  can_be_detail :address
+end
+```
+
+The `can_be_detail` method takes in one parameter.  The parameter is the link to the CanBe model.  This must be a symbol that will reference the CanBe model.  In order to create the proper symbol, you can execute the following into your Rails console: `<ModelName>.name.underscore.to_sym`.  Here is an example: `Address.name.underscore.to_sym`.  In the above example, this will be used for the `Address` CanBe model.
+
+You will also need to call the `add_details_model` method in the `can_be` block, passing in the CanBe type and a symbol that represets the details model class.
+
+```ruby
+class Address < ActiveRecord::Base
+  can_be :home_address, :work_address, :vacation_address do
+    add_details_model :home_address, :home_address_detail
+  end
+end
+```
+
+If you are using a different `details_name` for the relationship, you will also need to add the configuration options like this.
+
+```ruby
+class Address < ActiveRecord::Base
+  can_be :home_address, :work_address, :vacation_address do
+    add_details_model :home_address, :home_address_detail
+    details_name :address_details
+  end
+end
+```
+
+```ruby
+class HomeAddressDetail < ActiveRecord::Base
+  can_be_detail :address, :address_details
+end
+```
+
+**NOTE:** Examples of the model configurations can be found in the [`spec/support/models.rb`](https://github.com/mstarkman/can_be/blob/master/spec/support/models.rb) file.
+
+## Accessing the Details
+
+If you want to access the details model, you can call the `details` method on your instance and the instance of your model will be returned.  If the type of model that you are using does not have a details model, `nil` will be returned.
+
+When you persist your CanBe model to the database, your details model will automatically be persisted.
+
+If you are using a different `details_name`, you will access the details by calling a method of the same name.  For example, if you assigned `:address_details` to the `details_name, then you can access the details by calling the `address_details` method.
+
+## Calling the "change_to" methods
+
+When you are changing the type of record the details record will be changed to the correct CanBe details record.  New records will only be persisted to the database when the CanBe model is persisted.  If you change the CanBe model to a type that does not have a corresponding details model, `nil` will be stored for the details.
+
+Changing the CanBe type with the "change_to" methods can also accept a block to allow you to set the data on the new details record.
+
+```ruby
+upload.change_to_image_upload do |details|
+  details.format = "jpeg"
+end
+```

data/docs/history.md

@@ -0,0 +1,71 @@
+# Keeping Details History When Changing CanBe Types #
+
+CanBe provides a history facility that will allow the [details](https://github.com/mstarkman/can_be/blob/master/docs/details.md) data to be preserved when switching between CanBe types.  This way if you switch back to a CanBe type that was previously used, the specific data for the new CanBe type will still be available.
+
+## Database Migrations ##
+
+To implement this history facility, there are no modifications necessary to your existing CanBe tables.  You will only need to create a table (via migration) that will store the references for the CanBe types.  All of the attribute (column) names **must** be named as shown in the example below.
+
+``` ruby
+create_table :address_can_be_histories, :force => true do |t|
+  t.integer :can_be_model_id
+  t.string :can_be_type
+  t.integer :can_be_details_id
+  t.string :can_be_details_type
+  t.timestamps
+end
+```
+
+**NOTE:** Examples of the database migrations can be found in the [`spec/support/schema.rb`](https://github.com/mstarkman/can_be/blob/master/spec/support/schema.rb) file.
+
+## Models ##
+
+There are only a few changes that are required to wire up the history model to the CanBe and CanBe details models.
+
+First, you must create an Active Record model for the history table.
+
+``` ruby
+class AddressHistory < ActiveRecord::Base
+end
+```
+
+### CanBe Model ###
+
+You will have to tell your current CanBe model to use the history model that you defined by adding a call to the `#keep_history_in` method.
+
+```ruby
+class Address < ActiveRecord::Base
+  can_be :home_address, :work_address, :vacation_address do
+    add_details_model :home_address, :home_address_detail
+    keep_history_in :address_history
+  end
+end
+```
+
+### CanBe Details Models ###
+
+For each of the details models, you will also have to pass in the history model when calling the `#can_be_detail` method.
+
+```ruby
+class HomeAddressDetail < ActiveRecord::Base
+  can_be_detail :address, history_model: :address_history
+end
+```
+
+**NOTE:** If you also want to change the `details_name` for the CanBe model, you will also need to specify that in the `options` parameter of the `#can_be_detail` method call.
+
+```ruby
+class HomeAddressDetail < ActiveRecord::Base
+  can_be_detail :address, history_model: :address_history, details_name: :address_details
+end
+```
+
+## Calling the "change_to" methods ##
+
+When you are not storing history for a CanBe model and you call a "change_to" method, the details record that is no longer active will be destroyed.  However, when you are storing the history, that record will *not* be destroy by default.
+
+The "change_to" methods can now take in a parameter that, when set to `true`, will destroy the details record that is no longer active.
+
+## Access the CanBe model from an inactive details model ##
+
+You can access the CanBe model from any details model that is in the database.  This is done in the same way as accessing it from the active details model.

data/docs/rspec_matcher.md

@@ -0,0 +1,11 @@
+# Custom RSpec Matchers
+
+Included in this gem are a set of matchers for RSpec that can be used to ensure the `can_be` and `can_be_detail` configuration in your models.  To use these matchers, you will need to include this line in your `spec_helper.rb` file.
+
+`require 'can_be/rspec/matchers'`
+
+You can then use the `implement_can_be` matcher as follows.  There are a number of fluent methods that you can use as well.  These methods can be seen in the [`spec/can_be/rspec/matchers/can_be_matcher_spec.rb`](https://github.com/mstarkman/can_be/blob/master/spec/can_be/rspec/matchers/can_be_matcher_spec.rb) file.
+
+`Address.should implement_can_be(:home_address, :work_address, :vacation_address)`
+
+Examples of the `implement_can_be_detail` matcher can be found in the [`spec/can_be/rspec/matchers/can_be_detail_matcher_spec.rb`](https://github.com/mstarkman/can_be/blob/master/spec/can_be/rspec/matchers/can_be_detail_matcher_spec.rb) file.

data/lib/can_be/builder/can_be.rb

@@ -15,6 +15,7 @@ module CanBe
         define_class_methods
         define_validations
         define_details
+        define_history
       end
 
       private
@@ -47,12 +48,12 @@ module CanBe
               can_be_processor.boolean_eval(t)
             end
 
-            define_method "change_to_#{t}" do
-              can_be_processor.update_field(t)
+            define_method "change_to_#{t}" do |force_history_removal = false, &block|
+              can_be_processor.update_field(t, force_history_removal: force_history_removal, &block)
             end
 
-            define_method "change_to_#{t}!" do
-              can_be_processor.update_field(t, true)
+            define_method "change_to_#{t}!" do |force_history_removal = false, &block|
+              can_be_processor.update_field(t, save: true, force_history_removal: force_history_removal, &block)
             end
           end
         end
@@ -94,11 +95,29 @@ module CanBe
 
       def define_details
         @klass.class_eval do
-          belongs_to :details, polymorphic: true, autosave: true, dependent: :destroy
+          belongs_to self.can_be_config.details_name.to_sym, polymorphic: true, autosave: true, dependent: :destroy
 
           after_initialize do |model|
             model.can_be_processor.initialize_details
           end
+
+          after_save do |model|
+            model.can_be_processor.clean_details
+          end
+        end
+      end
+
+      def define_history
+        return unless @klass.can_be_config.keeps_history?
+
+        @klass.class_eval do
+          after_save do |model|
+            model.can_be_processor.save_history
+          end
+
+          after_destroy do |model|
+            model.can_be_processor.destroy_histories
+          end
         end
       end
     end