accountable 0.0.2

data/.document

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

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rake_tasks~

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.2 2010-05-10
+
+* Initial port from another project.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Harrelson (midas)
+
+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,105 @@
+= accountable
+
+http://github.com/midas/accountable
+
+
+== DESCRIPTION
+
+An abstraction of the account / user pattern.  The account owns all of the system assets and users are delegated 
+permissions to them.
+
+
+== FEATURES
+
+* Adds required associations.
+* Adds passive, active and suspended states for managing accounts (requires AASM or State Machine gem)
+* Adds associations for assets.
+
+
+== COMPATABILITY:
+
+* Ruby 1.9
+* Ruby 1.8
+* Rails 3
+* Rails 2
+
+== INSTALL
+
+  gem sources -a http://gemcutter.org
+  gem install guilded
+
+
+== INSTALL FOR RAILS
+
+Configure the Gem for use:
+
+  gem 'accountable'           # Rails 3
+  config.gem 'accountable'    # Rails 2
+
+Install the Gem:
+
+  bundle install              # Rails 3
+  rake gems:install           # Rails 2
+
+
+== USAGE
+
+=== SIMPLEST CASE
+
+  class Account < ActiveRecord::Base
+    acts_as_accountor
+  end
+
+  class User < ActiveRecord::Base  
+    acts_as_accountee
+  end
+
+  class Thing
+    acts_as_accountors_asset
+  end
+
+
+=== COMPLEX CASE
+
+  class Group < ActiveRecord::Base
+    acts_as_accountor :of => :members, :with_state => :state_machine, :assets => %w(things)
+  end
+
+  class Member < ActiveRecord::Base  
+    acts_as_accountee :of => :group
+  end
+
+  class Thing
+    acts_as_accountors_asset
+  end
+
+
+== OPTIONS
+
+=== acts_as_accountor
+
+:of:: 
+
+
+== LICENSE
+
+Copyright (c) 2009 Jason Harrelson (midas)
+
+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/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "accountable"
+    gem.summary = %Q{An abstraction of the account / user pattern.}
+    gem.description = %Q{An abstraction of the account / user pattern.  The account owns all of the system assets and users are delegated permissions to them.}
+    gem.email = "jason@lookforwardenterprises.com"
+    gem.homepage = "http://github.com/midas/accountable"
+    gem.authors = ["Jason Harrelson"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "accountable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/accountable.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{accountable}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Harrelson"]
+  s.date = %q{2010-05-10}
+  s.description = %q{An abstraction of the account / user pattern.  The account owns all of the system assets and users are delegated permissions to them.}
+  s.email = %q{jason@lookforwardenterprises.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "accountable.gemspec",
+     "lib/accountable.rb",
+     "lib/accountable/accountee.rb",
+     "lib/accountable/accountor.rb",
+     "lib/accountable/accountor/states.rb",
+     "lib/accountable/accountor/states/aasm_traits.rb",
+     "lib/accountable/accountor/states/state_machine_instance_methods.rb",
+     "lib/accountable/accountor/states/state_machine_traits.rb",
+     "lib/accountable/accountors_asset.rb",
+     "lib/accountable/active_record_extensions.rb",
+     "lib/accountable/controller_actions.rb",
+     "lib/accountable/controller_helpers.rb",
+     "lib/accountable/current_methods.rb",
+     "lib/accountable/matchers.rb",
+     "lib/accountable/matchers/acts_as_accountor_matcher.rb",
+     "lib/accountable/view_helpers.rb",
+     "spec/accountable_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/midas/accountable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{An abstraction of the account / user pattern.}
+  s.test_files = [
+    "spec/accountable_spec.rb",
+     "spec/spec_helper.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
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/accountable.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'accountable/active_record_extensions'
+
+module Accountable
+  VERSION = File.exist?(File.expand_path( '../VERSION', __FILE__ )) ? 
+    File.readlines( File.expand_path( '../VERSION', __FILE__ ) ).first : 
+    ""
+  
+  autoload :Accountee,                      'accountable/accountee'
+  autoload :Accountor,                      'accountable/accountor'
+  autoload :AccountorsAsset,                'accountable/accountors_asset'
+  autoload :ControllerActions,              'accountable/controller_actions'
+  autoload :ControllerHelpers,              'accountable/controller_helpers'
+  autoload :CurrentMethods,                 'accountable/current_methods'
+  autoload :ViewHelpers,                    'accountable/view_helpers'
+end
+
+ActiveRecord::Base.send( :include, Accountable::ActiveRecordExtensions ) if defined? ActiveRecord::Base
+if defined?( ActionView::Base )
+  ActionView::Base.send( :include, Accountable::ViewHelpers ) unless ActionView::Base.include? Accountable::ViewHelpers
+end
+if defined?( ActionController::Base )
+  ActionController::Base.send( :include, Accountable::ControllerHelpers ) unless ActionController::Base.include? Accountable::ControllerHelpers
+  ActionController::Base.send( :include, Accountable::ControllerActions ) unless ActionController::Base.include? Accountable::ControllerActions
+end

data/lib/accountable/accountee.rb

@@ -0,0 +1,21 @@
+module Accountable
+  module Accountee
+    def self.included( base )
+      unless included_modules.include? InstanceMethods
+        base.extend ClassMethods
+        base.extend CurrentMethods
+        base.class_eval { include InstanceMethods }
+      end
+    end
+
+    module ClassMethods
+      def accountee_options
+        @accountee_options ||= { :of => :account }
+      end
+    end
+    
+    module InstanceMethods
+      
+    end
+  end
+end

data/lib/accountable/accountor.rb

@@ -0,0 +1,29 @@
+module Accountable
+  module Accountor
+    autoload :States, 'accountable/accountor/states'
+    
+    def self.included( base )
+      unless included_modules.include? InstanceMethods
+        base.extend ClassMethods
+        base.extend CurrentMethods
+        base.class_eval { include InstanceMethods }
+      end
+    end
+
+    module ClassMethods
+      def accountor_options
+        @accountor_options ||= {
+          :of => :users,
+          :name => :name,
+          :with_state => false,
+          :dependent => :nullify,
+          :assets => []
+        }
+      end
+    end
+    
+    module InstanceMethods
+      
+    end
+  end
+end

data/lib/accountable/accountor/states.rb

@@ -0,0 +1,7 @@
+module Accountable::Accountor
+  module States
+    autoload :AasmTraits,                     'accountable/accountor/states/aasm_traits'
+    autoload :StateMachineInstanceMethods,    'accountable/accountor/states/state_machine_instance_methods'
+    autoload :StateMachineTraits,             'accountable/accountor/states/state_machine_traits'
+  end
+end

data/lib/accountable/accountor/states/aasm_traits.rb

@@ -0,0 +1,28 @@
+module Accountable::Accountor::States
+  module AasmTraits
+    
+    def self.included( base )
+      base.class_eval do
+        include AASM
+        include StateMachineInstanceMethods
+        
+        aasm_column :status
+        aasm_initial_state :passive
+        aasm_state :passive
+        aasm_state :active, :enter => :do_activate
+        aasm_state :suspended, :enter => :do_suspend
+
+        aasm_event :activate do
+          transitions :from => :passive, :to => :active
+        end
+        aasm_event :suspend do
+          transitions :from => [:passive, :active], :to => :suspended
+        end
+        aasm_event :unsuspend do
+          transitions :from => :suspended, :to => :active
+        end
+      end
+    end
+    
+  end
+end

data/lib/accountable/accountor/states/state_machine_instance_methods.rb

@@ -0,0 +1,13 @@
+module Accountable::Accountor::States
+  module StateMachineInstanceMethods
+    protected
+
+    def do_activate
+      self.activated_at = Time.now.utc if self.respond_to? :activated_at
+    end
+    
+    def do_suspend
+      self.suspended_at = Time.now.utc if self.respond_to? :suspended_at
+    end
+  end
+end

data/lib/accountable/accountor/states/state_machine_traits.rb

@@ -0,0 +1,29 @@
+module Accountable::Accountor::States
+  module StateMachineTraits
+    
+    def self.included( base )
+      base.class_eval do
+        include StateMachineInstanceMethods
+
+        state_machine :status, :initial => :passive do
+          state :passive, :active, :suspended
+
+          event :activate do
+            transition [:passive] => :active
+          end
+          after_transition :on => :active, :do => :do_activate
+
+          event :suspend do
+            transition  [:passive, :active] => :suspended
+          end
+          after_transition :on => :active, :do => :do_suspend
+          
+          event :unsuspend do
+            transition [:suspended] => :active
+          end
+        end
+      end
+    end
+  
+  end
+end

data/lib/accountable/accountors_asset.rb

@@ -0,0 +1,20 @@
+module Accountable
+  module AccountorsAsset
+    def self.included( base )
+      unless included_modules.include? InstanceMethods
+        base.extend ClassMethods
+        base.class_eval { include InstanceMethods }
+      end
+    end
+
+    module ClassMethods
+      def accountors_asset_options
+        @accountors_asset_options ||= { :of => :account }
+      end
+    end
+    
+    module InstanceMethods
+      
+    end
+  end
+end

data/lib/accountable/active_record_extensions.rb

@@ -0,0 +1,66 @@
+module Accountable
+  module ActiveRecordExtensions
+    
+    def self.included( base )
+      base.extend( ActsMethods ) unless base.included_modules.include? ActsMethods
+    end
+        
+    module ActsMethods
+      # Placed in the model desired to be the accountor (usually Account).
+      #
+      def acts_as_accountor( *args )
+        unless included_modules.include? Accountable::Accountor
+          include Accountable::Accountor
+          options = args.extract_options!
+          self.accountor_options.merge!( options.reject { |k,v| v.blank? } )
+        
+          self.class_eval do 
+            has_many self.accountor_options[:of], :dependent => accountor_options[:dependent]
+            unless accountor_options[:name] == false
+              validates_presence_of accountor_options[:name].to_sym
+              validates_length_of accountor_options[:name].to_sym, :maximum => 150, 
+                :allow_nil => true, :allow_blank => true
+              attr_accessible accountor_options[:name].to_sym
+            end
+            assets = self.accountor_options[:assets].is_a?( Array ) ? 
+                       self.accountor_options[:assets] : 
+                       [self.accountor_options[:assets]]
+            assets.each { |asset| has_many asset.to_sym, :dependent => accountor_options[:dependent] }
+            include Accountor::States::StateMachineInstanceMethods unless accountor_options[:with_state] == false
+            include Accountor::States::AasmTraits if accountor_options[:with_state] == :aasm
+            include Accountor::States::StateMachineTraits if accountor_options[:with_state] == :state_machine
+          end
+        end
+      end
+    
+      # Placed in the model desired to be the accountee (usually User).
+      #
+      def acts_as_accountee( *args )
+        unless included_modules.include? Accountable::Accountee
+          include Accountable::Accountee
+          options = args.extract_options!
+          self.accountee_options.merge!( options.reject { |k,v| v.blank? } )
+        
+          self.class_eval do 
+            belongs_to self.accountee_options[:of].to_sym
+            validates_presence_of self.accountee_options[:of].to_sym
+          end
+        end
+      end
+      
+      # Placed in the model(s) desired to be owned by the accountor.
+      #
+      def acts_as_accountors_asset( *args )
+        unless included_modules.include? Accountable::AccountorsAsset
+          include Accountable::AccountorsAsset
+
+          self.class_eval do 
+            belongs_to self.accountors_asset_options[:of]
+            validates_presence_of self.accountors_asset_options[:of]
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/accountable/controller_actions.rb

@@ -0,0 +1,19 @@
+module Accountable
+  module ControllerActions
+    def self.included( base )
+      base.instance_eval do
+        before_filter :set_currents
+      end
+      base.send( :include, InstanceMethods )
+    end
+
+    module InstanceMethods
+      protected
+
+      def set_currents
+        User.current = current_user
+        Account.current = current_account
+      end
+    end
+  end
+end

data/lib/accountable/controller_helpers.rb

@@ -0,0 +1,8 @@
+module Accountable
+  module ControllerHelpers
+    def current_account
+      return current_user.account unless current_user.blank?
+      nil
+    end
+  end
+end

data/lib/accountable/current_methods.rb

@@ -0,0 +1,15 @@
+module Accountable
+  module CurrentMethods
+    def current
+      Thread.current[self.class.name.tableize.singularize.to_sym]
+    end
+
+    def current=( something )
+      unless something.nil? || something.is_a?( self )
+        raise( ArgumentError,
+          "Exception occurred while trying to set #{self.name}.current. Expected an object of type '#{self.name}', got an object of type ''#{something.class.name}'")
+      end
+      Thread.current[self.class.name.tableize.singularize.to_sym] = something
+    end
+  end
+end

data/lib/accountable/matchers.rb

@@ -0,0 +1,10 @@
+module Accountable
+  module Matchers
+    # Rspec::Matchers.define :be_a_multiple_of do |expected|
+    #   match do |actual|
+    #     debugger
+    #     actual % expected == 0
+    #   end
+    # end
+  end
+end

data/lib/accountable/matchers/acts_as_accountor_matcher.rb

@@ -0,0 +1,16 @@
+module Accountable::Matchers
+  # class ActsAsAccountorMatcher < Remarkable::ActiveRecord::Base
+  #   arguments :instance
+  #   assertion :is_applied?
+  #   
+  #   protected
+  #   
+  #   def is_applied?
+  #     
+  #   end
+  # end
+  # 
+  # def act_as_accountor( *args )
+  #   ActsAsAccountorMatcher.new( *args ).spec( self )
+  # end
+end

data/lib/accountable/view_helpers.rb

@@ -0,0 +1,8 @@
+module Accountable
+  module ViewHelpers
+    def current_account
+      return current_user.account unless current_user.blank?
+      nil
+    end
+  end
+end

data/spec/accountable_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Accountable" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'accountable'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: accountable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: An abstraction of the account / user pattern.  The account owns all of the system assets and users are delegated permissions to them.
+email: jason@lookforwardenterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- History.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- accountable.gemspec
+- lib/accountable.rb
+- lib/accountable/accountee.rb
+- lib/accountable/accountor.rb
+- lib/accountable/accountor/states.rb
+- lib/accountable/accountor/states/aasm_traits.rb
+- lib/accountable/accountor/states/state_machine_instance_methods.rb
+- lib/accountable/accountor/states/state_machine_traits.rb
+- lib/accountable/accountors_asset.rb
+- lib/accountable/active_record_extensions.rb
+- lib/accountable/controller_actions.rb
+- lib/accountable/controller_helpers.rb
+- lib/accountable/current_methods.rb
+- lib/accountable/matchers.rb
+- lib/accountable/matchers/acts_as_accountor_matcher.rb
+- lib/accountable/view_helpers.rb
+- spec/accountable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/midas/accountable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An abstraction of the account / user pattern.
+test_files: 
+- spec/accountable_spec.rb
+- spec/spec_helper.rb