maintain 0.2.1 → 0.2.2

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/maintain/backend/active_record.rb

@@ -7,7 +7,7 @@ module Maintain
       end
 
       def read(instance, attribute)
-        instance.attributes[attribute.to_s]
+        instance.read_attribute(attribute)
       end
 
       def state(maintainee, name, attribute, value)

data/lib/maintain/backend/data_mapper.rb

@@ -0,0 +1,29 @@
+module Maintain
+  module Backend
+    class DataMapper < Maintain::Backend::Base
+      def aggregate(maintainee, name, attribute, states)
+        # named_scope will handle the array of states as "IN" in SQL
+        state(maintainee, name, attribute, states)
+      end
+
+      def read(instance, attribute)
+        instance.attributes[attribute.to_s]
+      end
+
+      def state(maintainee, name, attribute, value)
+        conditions = {:conditions => {attribute => value}}
+        maintainee.class_eval <<-scope
+          def self.#{name}
+            all(#{conditions.inspect})
+          end
+        scope
+      end
+
+      def write(instance, attribute, value)
+        property = instance.send(:properties)[attribute]
+        instance.persisted_state = instance.persisted_state.set(property, value)
+        instance.persisted_state.get(property)
+      end
+    end
+  end
+end

data/lib/maintain/backend.rb

@@ -3,8 +3,27 @@ require 'maintain/backend/base'
 module Maintain
   module Backend
     class << self
+      def add(name, owner)
+        classes[name.to_sym] = owner
+        modules = owner.split('::')
+        if Object.const_defined?(modules.first) && owner = Object.const_get(modules.shift)
+          while modules.length > 0
+            owner = owner.const_get(modules.shift)
+          end
+          if owner.is_a? Module
+            owner.class_eval do
+              class << self
+                include Maintain
+              end
+            end
+          else
+            owner.extend Maintain
+          end
+        end
+      end
+
       def build(back_end, maintainer)
-        back_end = back_end.split('_').map(&:capitalize).join('')
+        back_end = back_end.to_s.split('_').map(&:capitalize).join('')
         if constants.include? back_end.to_s
           const_get(back_end.to_sym).new
         else
@@ -16,6 +35,10 @@ module Maintain
         end
       end
 
+      def classes
+        @classes ||= {}
+      end
+
       def const_missing(constant)
         underscore_constant = constant.to_s.dup
         underscore_constant.gsub!(/::/, '/')
@@ -30,6 +53,23 @@ module Maintain
           super
         end
       end
+
+      # Detect if we've loaded a backend for this class - that means if its ancestors or
+      # parent classes include any of our back-end classes.
+      def detect(owner)
+        ancestors = owner.ancestors.map(&:to_s)
+        # While owner does not refer to "Object"
+        while owner.superclass
+          ancestors.push(owner.to_s)
+          owner = owner.superclass
+        end
+        classes.each do |back_end, class_name|
+          if ancestors.include? class_name
+            return back_end
+          end
+        end
+        nil
+      end
     end
   end
 end

data/lib/maintain.rb

@@ -1,11 +1,11 @@
 # encoding: UTF-8
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__))
+require 'maintain/backend'
 
 module Maintain
   # We're not really interested in loading anything into memory if we don't need to,
   # so Maintainer, Value, and the Value subclasses are ignored until they're needed.
   autoload(:Maintainer, 'maintain/maintainer')
-  autoload(:Backend, 'maintain/backend')
   autoload(:Value, 'maintain/value')
   autoload(:BitmaskValue, 'maintain/bitmask_value')
   autoload(:IntegerValue, 'maintain/integer_value')
@@ -31,17 +31,7 @@ module Maintain
   # This method is aliased as `maintains` with the intention of allowing developers
   # to code imperatively ("maintain, damn you!") or descriptively ("it maintains, man")
   def maintain(attribute, options = {}, &block)
-    # Detect if this is ActiveRecord::Base or a subclass of it
-    # TODO: Make this not suck
-    if defined?(ActiveRecord::Base)
-      active_record = self == ActiveRecord::Base
-      superclass = self
-      while !active_record && superclass.superclass
-        active_record = superclass == ActiveRecord::Base
-        superclass = superclass.superclass
-      end
-      options[:back_end] = 'active_record' if active_record
-    end
+    options[:back_end] ||= Maintain::Backend.detect(self)
 
     # Create an instance of the maintainer class. It handles all of the state
     # configuration, hooking, aggregation, named_scoping, etc.
@@ -67,22 +57,20 @@ module Maintain
 
           # Allow the back end to write values in an ORM-specific way
           if maintainer.back_end
-            maintainer.back_end.write(self, :#{attribute}, value)
+            maintainer.back_end.write(self, :#{attribute}, #{attribute}.value)
           end
 
           # Last but not least, run the enter hooks for the new value - cause that's how
           # we do.
           maintainer.hook(:enter, #{attribute}.name, self) if changed
+        else
+          @#{attribute} = value
         end
       end
 
       def #{attribute}
         if maintainer = self.class.maintainers[:#{attribute}]
-          if @#{attribute}
-            @#{attribute}
-          else
-            @#{attribute} = maintainer.value(self)
-          end
+          @#{attribute} ||= maintainer.value(self)
         else
           @#{attribute}
         end
@@ -107,6 +95,5 @@ module Maintain
   end
 end
 
-if defined?(ActiveRecord::Base)
-  ActiveRecord::Base.extend Maintain
-end
+Maintain::Backend.add(:active_record, 'ActiveRecord::Base')
+Maintain::Backend.add(:data_mapper, 'DataMapper::Resource')

data/maintain.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{maintain}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Flip Sasser"]
-  s.date = %q{2011-02-03}
+  s.date = %q{2011-02-23}
   s.description = %q{
       Maintain is a simple state machine mixin for Ruby objects. It supports comparisons, bitmasks,
       and hooks that really work. It can be used for multiple attributes and will always do its best to
@@ -20,30 +20,59 @@ Gem::Specification.new do |s|
     "README.markdown"
   ]
   s.files = [
-     "Rakefile",
-     "VERSION",
-     "lib/maintain.rb",
-     "lib/maintain/backend.rb",
-     "lib/maintain/backend/active_record.rb",
-     "lib/maintain/backend/base.rb",
-     "lib/maintain/bitmask_value.rb",
-     "lib/maintain/integer_value.rb",
-     "lib/maintain/maintainer.rb",
-     "lib/maintain/value.rb",
-     "maintain.gemspec"
+    ".rspec",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "autotest/discover.rb",
+    "lib/maintain.rb",
+    "lib/maintain/backend.rb",
+    "lib/maintain/backend/active_record.rb",
+    "lib/maintain/backend/base.rb",
+    "lib/maintain/backend/data_mapper.rb",
+    "lib/maintain/bitmask_value.rb",
+    "lib/maintain/integer_value.rb",
+    "lib/maintain/maintainer.rb",
+    "lib/maintain/value.rb",
+    "maintain.gemspec",
+    "spec/active_record_spec.rb",
+    "spec/aggregates_spec.rb",
+    "spec/bitwise_spec.rb",
+    "spec/comparing_state_spec.rb",
+    "spec/data_mapper_spec.rb",
+    "spec/defining_states_spec.rb",
+    "spec/hooks_spec.rb",
+    "spec/integer_spec.rb",
+    "spec/maintain_spec.rb",
+    "spec/object_spec.rb",
+    "spec/proxy_spec.rb",
+    "spec/setting_state_spec.rb",
+    "spec/spec.opts"
   ]
   s.homepage = %q{http://github.com/flipsasser/maintain}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby state machine that lets your code do the driving}
-  s.test_files = Dir["spec/**/*"]
+  s.test_files = [
+    "spec/active_record_spec.rb",
+    "spec/aggregates_spec.rb",
+    "spec/bitwise_spec.rb",
+    "spec/comparing_state_spec.rb",
+    "spec/data_mapper_spec.rb",
+    "spec/defining_states_spec.rb",
+    "spec/hooks_spec.rb",
+    "spec/integer_spec.rb",
+    "spec/maintain_spec.rb",
+    "spec/object_spec.rb",
+    "spec/proxy_spec.rb",
+    "spec/setting_state_spec.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/spec/active_record_spec.rb

@@ -27,6 +27,7 @@ if proceed
           ActiveRecord::Schema.define do
             create_table :active_maintain_tests, :force => true do |t|
               t.string :status
+              t.integer :permissions
             end
           end
         end
@@ -55,12 +56,49 @@ if proceed
         ActiveMaintainTest.first.status.should == 'old'
       end
 
+      it "should allow us to update statuses using update_attributes" do
+        active_maintain_test = ActiveMaintainTest.new
+        active_maintain_test.update_attributes(:status => :bar)
+        ActiveMaintainTest.first.status.should == :bar
+      end
+
+      it "should allow us to update statuses using update_attribute" do
+        active_maintain_test = ActiveMaintainTest.new
+        active_maintain_test.update_attribute(:status, :bar)
+        ActiveMaintainTest.first.status.should == :bar
+      end
+
       it "should return the correct name when told to" do
         active_maintain_test = ActiveMaintainTest.create(:status => 'old')
         ActiveMaintainTest.first.status.name.should == 'old'
       end
     end
 
+    describe "bitmasks" do
+      before :each do
+        ActiveMaintainTest.maintain :permissions, :bitmask => true do
+          state :add, 0
+          state :delete, 1
+          state :foo, 2
+          state :bar, 3
+
+          aggregate :everything, :as => [:new, :old, :foo, :bar]
+          aggregate :fakes, :as => [:foo, :bar]
+        end
+      end
+
+      it "should allow me to set a bitmask value" do
+        active_maintain_test = ActiveMaintainTest.create(:permissions => 'add')
+        ActiveMaintainTest.last.permissions.add?.should be_true
+      end
+
+      it "should allow me to set multiple bitmask values" do
+        active_maintain_test = ActiveMaintainTest.create(:permissions => ['add', 'delete'])
+        ActiveMaintainTest.last.permissions.add?.should be_true
+        ActiveMaintainTest.last.permissions.delete?.should be_true
+      end
+    end
+
     describe "named_scopes" do
       it "should create named_scopes for all states" do
         ActiveMaintainTest.should respond_to(:old)
@@ -84,4 +122,4 @@ if proceed
 
     end
   end
-end
+end

data/spec/data_mapper_spec.rb

@@ -1,87 +1,86 @@
-# # Some specs to check against ActiveRecord conflicts. Rails tends to blow
-# # shit up when you build it outside of Rails. We'll see how this goes...
-# 
-# proceed = false
-# begin
-#   require 'rubygems'
-#   gem 'datamapper'
-#   require 'datamapper'
-#   proceed = true
-# rescue Gem::LoadError, LoadError
-#   puts 'Not testing DataMapper (unavailable)'
-# end
-# 
-# if proceed = false
-#   # Use load to have it evaluate the ActiveRecord::Base extension logic again, in the event
-#   # that we've already done that with a previous test.
-#   load 'lib/maintain.rb'
-#   describe Maintain, "Datamapper::Resource" do
-#     it "should automatically be extended" do
-#       ActiveRecord::Base.should respond_to(:maintain)
-#     end
-#     describe "accessors" do
-#       before :each do
-#         ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', :database => ':memory:', :pool => 5, :timeout => 5000})
-#         class ::ActiveMaintainTest < ActiveRecord::Base; end
-#         silence_stream(STDOUT) do
-#           ActiveRecord::Schema.define do
-#             create_table :active_maintain_tests, :force => true do |t|
-#               t.string :status
-#             end
-#           end
-#         end
-# 
-#         ActiveMaintainTest.maintain :status do
-#           state :new, :default => true
-#           state :old
-#           state :foo
-#           state :bar
-#           aggregate :everything, :as => [:new, :old, :foo, :bar]
-#           aggregate :fakes, :as => [:foo, :bar]
-#         end
-#       end
-# 
-#       it "should default to 'new'" do
-#         ActiveMaintainTest.new.status.should == 'new'
-#         ActiveMaintainTest.new.status.should == :new
-#       end
-# 
-#       it "should allow us to update its status to 'old'" do
-#         active_maintain_test = ActiveMaintainTest.new(:status => 'old')
-#         active_maintain_test.status.should == 'old'
-#         lambda {
-#           active_maintain_test.save!
-#         }.should_not raise_error
-#         ActiveMaintainTest.first.status.should == 'old'
-#       end
-# 
-#       it "should return the correct name when told to" do
-#         active_maintain_test = ActiveMaintainTest.create(:status => 'old')
-#         ActiveMaintainTest.first.status.name.should == 'old'
-#       end
-#     end
-# 
-#     describe "named_scopes" do
-#       it "should create named_scopes for all states" do
-#         ActiveMaintainTest.should respond_to(:old)
-#         ActiveMaintainTest.old.should respond_to(:each)
-#       end
-# 
-#       it "should create named_scopes for all aggregates" do
-#         ActiveMaintainTest.should respond_to(:everything)
-#         ActiveMaintainTest.everything.should respond_to(:each)
-#       end
-# 
-#       it "should return the correct collections on aggregates" do
-#         ActiveMaintainTest.destroy_all
-#         one = ActiveMaintainTest.create(:status => :foo)
-#         two = ActiveMaintainTest.create(:status => :bar)
-#         three = ActiveMaintainTest.create(:status => :new)
-#         four = ActiveMaintainTest.create(:status => :old)
-#         ActiveMaintainTest.fakes.should == [one, two]
-#         ActiveMaintainTest.everything.should == [one, two, three, four]
-#       end
-# 
-#     end
-#   end
-# end
+proceed = false
+begin
+  require 'rubygems'
+  gem 'datamapper'
+  require 'datamapper'
+  proceed = true
+rescue Gem::LoadError, LoadError
+  puts 'Not testing DataMapper (unavailable)'
+end
+
+if proceed
+  # Use load to have it evaluate the DataMapper extension logic again, in the event
+  # that we've already done that with a previous test.
+  load 'lib/maintain.rb'
+
+  DataMapper.setup(:default, "sqlite3::memory:")
+
+  class ::DataMapperMaintainTest
+    include DataMapper::Resource
+    extend Maintain
+
+    property :id, Serial
+    property :status, String
+
+    maintain :status do
+      state :new, :default => true
+      state :old
+      state :foo
+      state :bar
+      aggregate :everything, :as => [:new, :old, :foo, :bar]
+      aggregate :fakes, :as => [:foo, :bar]
+    end
+  end
+
+  DataMapper.auto_upgrade!
+
+  describe Maintain, "Datamapper::Resource" do
+    it "should automatically be extended" do
+      DataMapper::Resource.instance_methods.should include('maintain')
+    end
+
+    describe "accessors" do
+      it "should default to 'new'" do
+        DataMapperMaintainTest.new.status.should == 'new'
+        DataMapperMaintainTest.new.status.should == :new
+      end
+
+      it "should allow us to update its status to 'old'" do
+        active_maintain_test = DataMapperMaintainTest.new(:status => 'old')
+        active_maintain_test.status.should == 'old'
+        lambda {
+          active_maintain_test.save!
+        }.should_not raise_error
+        DataMapperMaintainTest.first.status.should == 'old'
+      end
+
+      it "should return the correct name when told to" do
+        active_maintain_test = DataMapperMaintainTest.create(:status => 'old')
+        DataMapperMaintainTest.first.status.name.should == 'old'
+      end
+    end
+
+    describe "named_scopes" do
+      it "should create named_scopes for all states" do
+        DataMapperMaintainTest.should respond_to(:old)
+        DataMapperMaintainTest.old.should respond_to(:each)
+      end
+
+      it "should create named_scopes for all aggregates" do
+        DataMapperMaintainTest.should respond_to(:everything)
+        DataMapperMaintainTest.everything.should respond_to(:each)
+      end
+
+      it "should return the correct collections on aggregates" do
+        DataMapperMaintainTest.all.destroy!
+        one = DataMapperMaintainTest.create(:status => :foo)
+        two = DataMapperMaintainTest.create(:status => :bar)
+        three = DataMapperMaintainTest.create(:status => :new)
+        four = DataMapperMaintainTest.create(:status => :old)
+        DataMapperMaintainTest.fakes.should == [one, two]
+        DataMapperMaintainTest.everything.should == [one, two, three, four]
+      end
+
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: maintain
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Flip Sasser
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -05:00
+date: 2011-02-23 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - lib/maintain/backend.rb
 - lib/maintain/backend/active_record.rb
 - lib/maintain/backend/base.rb
+- lib/maintain/backend/data_mapper.rb
 - lib/maintain/bitmask_value.rb
 - lib/maintain/integer_value.rb
 - lib/maintain/maintainer.rb
@@ -46,6 +47,7 @@ files:
 - spec/aggregates_spec.rb
 - spec/bitwise_spec.rb
 - spec/comparing_state_spec.rb
+- spec/data_mapper_spec.rb
 - spec/defining_states_spec.rb
 - spec/hooks_spec.rb
 - spec/integer_spec.rb
@@ -54,7 +56,6 @@ files:
 - spec/proxy_spec.rb
 - spec/setting_state_spec.rb
 - spec/spec.opts
-- spec/data_mapper_spec.rb
 has_rdoc: true
 homepage: http://github.com/flipsasser/maintain
 licenses: []