acts_as_contextable 0.0.2

data/.gitignore

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

data/.project

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>acts_as_contextable</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>org.radrails.rails.core.railsnature</nature>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sergiy Nikitin
+
+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,70 @@
+# Acts As Contextable
+
+Acts As Contextable is aruby gem written for Rails/ActiveRecord models.
+The gem allows:
+- Any model can refer to any other model by adding it to its own context  
+- Any model can have multiple various models in context
+- Context can be queryed by the class (type) of a model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_contextable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_contextable
+
+### Database Migrations
+
+Acts As Contextable uses a votes table to store all voting information.  
+To generate and run the migration just use.
+
+    rails generate acts_as_votable:migration
+    rake db:migrate
+
+## Usage
+
+### Contextable Models
+
+```ruby
+class Meeting < ActiveRecord::Base
+  acts_as_contextable
+end
+
+@meeting = Meeting.new(:name => 'my meeting!')
+@meeting.save
+
+@meeting.add_to_context @user
+@meeting.add_to_context @place
+
+```
+
+### Working with context
+
+```ruby
+if @meeting.has_contexts_of_a_type User
+	@meeting.contexts_of_a_type(User).each do |user|
+		...
+	end 
+end
+```
+
+### Removing from context
+
+```ruby
+@meeting.remove_from_context @user
+```
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/acts_as_contextable.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_contextable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_contextable"
+  spec.version       = ActsAsContextable::VERSION
+  spec.authors       = ["Sergiy Nikitin"]
+  spec.email         = ["sn@inno-w.com"]
+  spec.description   = %q{This gem provides basic linking functionality of active record objects. In cases when hard-coded references are not needed, you may refer to other objects by adding them to context}
+  spec.summary       = %q{Context linking is a flexible mechanizm for dynamic referencing between active record objects.}
+  spec.homepage      = "https://github.com/senikiti/acts_as_contextable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/acts_as_contextable.rb

@@ -0,0 +1,22 @@
+require "acts_as_contextable/version"
+require 'active_record'
+require 'active_support/inflector'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module ActsAsContextable
+
+  if defined?(ActiveRecord::Base)
+    require 'acts_as_contextable/extenders/contextable'
+    require 'acts_as_contextable/extenders/context'
+    require 'acts_as_contextable/context_reference'
+    ActiveRecord::Base.extend ActsAsContextable::Extenders::Contextable
+    ActiveRecord::Base.extend ActsAsContextable::Extenders::Context
+  end
+
+end
+
+require 'acts_as_contextable/extenders/controller'
+ActiveSupport.on_load(:action_controller) do
+  include ActsAsContextable::Extenders::Controller
+end

data/lib/acts_as_contextable/context.rb

@@ -0,0 +1,19 @@
+module ActsAsContextable
+  module Context
+    def self.included(base)      
+
+      base.class_eval do
+        
+        has_many :in_context_of, :class_name => 'ActsAsContextable::ContextReference', :as => :context, :dependent => :destroy do
+          
+          def contextables
+            includes(:contextable).map(&:contextable)
+          end
+          
+        end
+        
+      end
+
+    end
+  end
+end

data/lib/acts_as_contextable/context_reference.rb

@@ -0,0 +1,10 @@
+module ActsAsContextable
+  class ContextReference < ActiveRecord::Base
+    belongs_to :contextable, polymorphic: true
+    belongs_to :context, polymorphic: true
+    
+    validates_presence_of :contextable_id
+    validates_presence_of :context_id
+    
+  end
+end

data/lib/acts_as_contextable/contextable.rb

@@ -0,0 +1,81 @@
+module ActsAsContextable
+  module Contextable
+    def self.included(base)      
+      base.class_eval do
+        has_many :context_items, :class_name => 'ActsAsContextable::ContextReference', :as => :contextable, :dependent => :destroy do
+          def contexts
+            includes(:context).map(&:context)
+          end
+        end
+      end
+      
+    end
+    
+    def add_to_context context, options = {}
+      self.add_to_ctx :context => context #, :context_weight => options[:context_weight]
+    end
+    
+    # put to context
+    def add_to_ctx args = {}
+      
+      options = {}.merge(args)
+      
+      if options[:context].nil?
+        return false
+      end
+
+      # find the context
+      _context_refs_ = find_contexts_for({
+        :context_id => options[:context].id,
+        :context_type => options[:context].class.base_class.name
+      })
+
+      if _context_refs_.count == 0 or options[:duplicate]
+        # this item has never been in context
+        context_ref = ActsAsContextable::ContextReference.new(
+          :contextable => self,
+          :context => options[:context]
+        )
+      else
+        # this context is potentially changing his vote
+        context_ref = _context_refs_.last
+      end
+      
+      context_ref.save
+    end
+    
+    def remove_from_context context, options = {}
+      self.remove_from_ctx :context => context
+    end
+    
+    def remove_from_ctx args = {}
+      return false if args[:context].nil?
+      _context_refs_ = find_contexts_for(:context_id => args[:context].id, :context_type => args[:context].class.base_class.name)
+
+      return true if _context_refs_.size == 0
+      _context_refs_.each(&:destroy)
+      return true
+    end
+    
+    def has_context?
+      find_contexts_for().count > 0
+    end
+    
+    def contexts
+      find_contexts_for().map(&:context)
+    end
+    
+    def has_contexts_of_a_type? ctxclass
+      find_contexts_for(:context_type => ctxclass.base_class.name).count > 0
+    end
+    
+    def contexts_of_a_type ctxclass
+      find_contexts_for(:context_type => ctxclass.base_class.name).map(&:context)
+    end
+    
+    def find_contexts_for extra_conditions = {}
+      context_items.where(extra_conditions)
+    end
+    
+  end
+end

data/lib/acts_as_contextable/extenders/context.rb

@@ -0,0 +1,24 @@
+module ActsAsContextable
+  module Extenders
+
+    module Context
+
+      def context?
+        false
+      end
+
+      def acts_as_context(*args)
+        require 'acts_as_contextable/context'
+        include ActsAsContextable::Context
+
+        class_eval do
+          def self.context?
+            true
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/acts_as_contextable/extenders/contextable.rb

@@ -0,0 +1,25 @@
+module ActsAsContextable
+  module Extenders
+
+    module Contextable
+
+      def contextable?
+        false
+      end
+
+      def acts_as_contextable
+        require 'acts_as_contextable/contextable'
+        include ActsAsContextable::Contextable
+
+        class_eval do
+          def self.contextable?
+            true
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/acts_as_contextable/extenders/controller.rb

@@ -0,0 +1,19 @@
+module ActsAsContextable
+  module Extenders
+
+    module Controller
+=begin
+      def context_params(params_object = params[:context_reference])
+        params_object.permit(:votable_id, :votable_type,
+          :voter_id, :voter_type,
+          :votable, :voter,
+          :vote_flag, :vote_scope)
+      end
+      
+      def contextable_params(params_object = params[:context_reference])
+        params_object.permit(:vote_registered)
+      end
+=end
+    end
+  end
+end

data/lib/acts_as_contextable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsContextable
+  VERSION = "0.0.2"
+end

data/lib/generators/acts_as_contextable/migration/migration_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+module ActsAsContextable
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for contextable (context_references table)"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(path)
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/acts_as_contextable_migration.rb'
+      end
+    end
+  end
+end

data/lib/generators/acts_as_contextable/migration/templates/active_record/migration.rb

@@ -0,0 +1,18 @@
+class ActsAsContextableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :context_references do |t|
+      t.references :contextable, :polymorphic => true
+      t.references :context, :polymorphic => true
+      t.timestamps
+    end
+
+    if ActiveRecord::VERSION::MAJOR < 4
+      add_index :context_references, [:contextable_id, :contextable_type]
+      add_index :context_references, [:context_id, :context_type]
+    end
+  end
+
+  def self.down
+    drop_table :context_references
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_contextable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Sergiy Nikitin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: This gem provides basic linking functionality of active record objects.
+  In cases when hard-coded references are not needed, you may refer to other objects
+  by adding them to context
+email:
+- sn@inno-w.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .project
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_contextable.gemspec
+- lib/acts_as_contextable.rb
+- lib/acts_as_contextable/context.rb
+- lib/acts_as_contextable/context_reference.rb
+- lib/acts_as_contextable/contextable.rb
+- lib/acts_as_contextable/extenders/context.rb
+- lib/acts_as_contextable/extenders/contextable.rb
+- lib/acts_as_contextable/extenders/controller.rb
+- lib/acts_as_contextable/version.rb
+- lib/generators/acts_as_contextable/migration/migration_generator.rb
+- lib/generators/acts_as_contextable/migration/templates/active_record/migration.rb
+homepage: https://github.com/senikiti/acts_as_contextable
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Context linking is a flexible mechanizm for dynamic referencing between active
+  record objects.
+test_files: []
+has_rdoc: