amistad-actions 0.1.0

data/.document

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "amistad", ">= 0.7.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "activerecord"
+  gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    amistad (0.7.5)
+    arel (2.2.1)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    rake (0.9.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    sqlite3 (1.3.4)
+    tzinfo (0.3.30)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  amistad (>= 0.7.5)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jan Dupal
+
+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,19 @@
+= amistad-actions
+
+Description goes here.
+
+== Contributing to amistad-actions
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Jan Dupal. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "amistad-actions"
+  gem.homepage = "http://github.com/JanDupal/amistad-actions"
+  gem.license = "MIT"
+  gem.summary = %Q{Amistad Action logging}
+  gem.description = %Q{Action logging for Amistad friendship model}
+  gem.email = "dupal.j@gmail.com"
+  gem.authors = ["Jan Dupal"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "amistad-actions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/amistad-actions.rb

@@ -0,0 +1,9 @@
+if defined?(ActiveRecord)
+  require 'amistad/active_record/action_model'
+  require 'amistad/active_record/has_actions'
+  require 'amistad/active_record/is_subject'
+end
+
+require 'amistad/action_model'
+require 'amistad/has_actions'
+require 'amistad/is_subject'

data/lib/amistad/action_model.rb

@@ -0,0 +1,13 @@
+module Amistad
+  module ActionModel
+    def self.included(receiver)
+      if receiver.ancestors.map(&:to_s).include?("ActiveRecord::Base")
+        receiver.class_exec do
+          include Amistad::ActiveRecord::ActionModel
+        end
+      else
+        raise "Amistad-action only supports ActiveRecord"
+      end
+    end
+  end
+end

data/lib/amistad/active_record/action_model.rb

@@ -0,0 +1,22 @@
+module Amistad
+  module ActiveRecord
+    module ActionModel
+      extend ActiveSupport::Concern
+
+      included do
+        belongs_to :user
+        belongs_to :subject, :polymorphic => true
+
+        validates :user, :presence => true
+      end
+
+      module ClassMethods
+
+      end
+
+      module InstanceMethods
+
+      end
+    end
+  end
+end

data/lib/amistad/active_record/has_actions.rb

@@ -0,0 +1,41 @@
+module Amistad
+  module ActiveRecord
+    module HasActions
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :actions
+      end
+
+      module ClassMethods
+        def predefined_actions
+          @@predefined_actions ||= {}
+        end
+
+        def predefine_action(action, options = nil)
+          predefined_actions[action] = Action.new(options)
+        end
+
+        def has_predefined_action(action)
+          predefined_actions.has_key?(action)
+        end
+
+        def remove_all_predefined_actions
+          @@predefined_actions = {}
+        end
+      end
+
+      module InstanceMethods
+        def did(what)
+          action = if what.is_a? Symbol
+                     self.class.predefined_actions[what].dup
+                   else
+                     Action.new(:description => what)
+                   end
+          actions << action
+          action
+        end
+      end
+    end
+  end
+end

data/lib/amistad/active_record/is_subject.rb

@@ -0,0 +1,19 @@
+module Amistad
+  module ActiveRecord
+    module IsSubject
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :concerning_actions, :class_name => 'Action', :as => 'subject'
+      end
+
+      module ClassMethods
+
+      end
+
+      module InstanceMethods
+
+      end
+    end
+  end
+end

data/lib/amistad/has_actions.rb

@@ -0,0 +1,13 @@
+module Amistad
+  module HasActions
+    def self.included(receiver)
+      if receiver.ancestors.map(&:to_s).include?("ActiveRecord::Base")
+        receiver.class_exec do
+          include Amistad::ActiveRecord::HasActions
+        end
+      else
+        raise "Amistad-action only supports ActiveRecord"
+      end
+    end
+  end
+end

data/lib/amistad/is_subject.rb

@@ -0,0 +1,13 @@
+module Amistad
+  module IsSubject
+    def self.included(receiver)
+      if receiver.ancestors.map(&:to_s).include?("ActiveRecord::Base")
+        receiver.class_exec do
+          include Amistad::ActiveRecord::IsSubject
+        end
+      else
+        raise "Amistad-action only supports ActiveRecord"
+      end
+    end
+  end
+end

data/spec/activerecord/active_record_action_model_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Amistad::ActiveRecord::ActionModel do
+  before(:all) do
+    %w(Jane David).each do |name|
+      instance_variable_set("@#{name.downcase}".to_sym, User.create(:name => name))
+    end
+  end
+
+  it "should validate presence of the user's id" do
+    action = Action.new
+    action.valid?.should be_false
+    action.errors.should include(:user)
+    action.errors.size.should == 1
+  end
+
+  it "should store subject" do
+    action = Action.create(:user => @jane,
+                           :description => "#{@jane.name} sent message to #{@david.name}",
+                           :subject => @david)
+    action.valid?.should be_true
+  end
+end

data/spec/activerecord/active_record_has_actions_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Amistad::ActiveRecord::HasActions do
+  before(:each) do
+    %w(Jane David).each do |name|
+      instance_variable_set("@#{name.downcase}".to_sym, User.create(:name => name))
+    end
+  end
+
+  context "when defining action for user" do
+    before(:each) do
+      User.remove_all_predefined_actions
+      User.predefined_actions.empty?.should be_true
+    end
+
+    it "should add action to predefined actions" do
+      User.has_predefined_action(:something).should be_false
+      User.predefine_action :something
+      User.has_predefined_action(:something).should be_true
+    end
+
+    it "should add action with description to available actions" do
+      User.has_predefined_action(:something).should be_false
+      User.predefine_action :something, { :description => 'Something' }
+      User.has_predefined_action(:something).should be_true
+      User.predefined_actions[:something].description.should == 'Something'
+    end
+  end
+
+  context "when creating action for user" do
+    before(:each) do
+      Action.delete_all
+      User.remove_all_predefined_actions
+
+      User.has_predefined_action(:anything).should be_false
+      User.predefine_action :anything, { :description => 'Anything'}
+      User.has_predefined_action(:anything).should be_true
+    end
+
+    it "should create action" do
+      @jane.did('nothing').should be_true
+      @jane.actions.size.should == 1
+      @jane.actions.first.description.should == 'nothing'
+    end
+
+    it "should use predefined action" do
+      @jane.did(:anything).should be_true
+      @jane.actions.size.should == 1
+      @jane.actions.first.description.should == 'Anything'
+    end
+
+    it "should leave predefined action untouched" do
+      @jane.did(:anything).should be_true
+
+      User.predefined_actions[:anything].user_id.should be_nil
+    end
+  end
+
+  context "when listing actions for user" do
+    before(:each) do
+      Action.delete_all
+
+      (@something = @jane.did('something')).should be_true
+      @something.description.should == 'something'
+
+      (@anything = @jane.did('anything')).should be_true
+      @anything.description.should == 'anything'
+    end
+
+    it "should list all actions" do
+      @jane.actions.should =~ [@something, @anything]
+      @david.actions.should =~ []
+    end
+  end
+end

data/spec/activerecord/active_record_is_subject_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Amistad::ActiveRecord::IsSubject do
+  before(:all) do
+    Action.delete_all
+    %w(Jane David).each do |name|
+      instance_variable_set("@#{name.downcase}".to_sym, User.create(:name => name))
+    end
+  end
+
+  it "should store concerning actions" do
+    action = Action.create(:user => @jane,
+                           :description => "#{@jane.name} sent message to #{@david.name}",
+                           :subject => @david)
+
+    @david.concerning_actions.size.should == 1
+    @david.concerning_actions.first.should == action
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'amistad-actions'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/activerecord_spec_helper.rb

@@ -0,0 +1,43 @@
+require 'amistad'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.string :name, :null => false
+  end
+
+  create_table :friendships, :force => true do |t|
+    t.integer :user_id
+    t.integer :friend_id
+    t.integer :blocker_id
+    t.boolean :pending, :default => true
+  end
+
+  add_index :friendships, [:user_id, :friend_id], :unique => true
+
+  create_table :actions, :force => true do |t|
+    t.integer :user_id
+    t.string :description
+    t.references :subject, :polymorphic => true
+  end
+end
+
+class User < ActiveRecord::Base
+  include Amistad::FriendModel
+  include Amistad::HasActions
+  include Amistad::IsSubject
+end
+
+class Friendship < ActiveRecord::Base
+  include Amistad::FriendshipModel
+end
+
+class Action < ActiveRecord::Base
+  include Amistad::ActionModel
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: amistad-actions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Dupal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amistad
+  requirement: &78671610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *78671610
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &78671340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *78671340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &78645780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *78645780
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &78645480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *78645480
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &78645180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78645180
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &78644870 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78644870
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &78644520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78644520
+description: Action logging for Amistad friendship model
+email: dupal.j@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/amistad-actions.rb
+- lib/amistad/action_model.rb
+- lib/amistad/active_record/action_model.rb
+- lib/amistad/active_record/has_actions.rb
+- lib/amistad/active_record/is_subject.rb
+- lib/amistad/has_actions.rb
+- lib/amistad/is_subject.rb
+- spec/activerecord/active_record_action_model_spec.rb
+- spec/activerecord/active_record_has_actions_spec.rb
+- spec/activerecord/active_record_is_subject_spec.rb
+- spec/spec_helper.rb
+- spec/support/activerecord_spec_helper.rb
+homepage: http://github.com/JanDupal/amistad-actions
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 501012815
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Amistad Action logging
+test_files: []