one_touch 1.3.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a98a57687f0a2ec6b1dcaac63bafdc44c16134c
+  data.tar.gz: 30dab1a2ccc18f7f79456a16fb7592602bcb49ca
+SHA512:
+  metadata.gz: 29f2f5752cb2a54d169552fdbf29e624f8b8f0dc58fbb88957a206b2b493fdc4de23c4fce90694f909e80a67a67dc7270fbff5f45a88926a18b3315c6b407403
+  data.tar.gz: 009567cdfd4e1b1ea37ddee259e90c4a164ba41cac5b8e5113679b8a1f9728ce56a9e1d346aa8d451962f5c758c08cdad4775fec401c4aab928f359c41ebf3ab

data/Gemfile

@@ -7,8 +7,8 @@ gemspec
 gem 'rake'
 gem 'rspec'
 gem 'rspec-rails'
-gem 'ruby-debug19'
-# gem 'rails', '3.1.0'
-gem 'rails', '3.0.11'
-gem 'squeel'
+gem 'debugger'
+gem 'rails', '~> 3.2.0'
+# gem 'rails', '~> 3.1.0'
+# gem 'rails', '~> 3.0.0'
 gem 'sqlite3', '~> 1.3.0', :group => :test

data/Rakefile

@@ -2,5 +2,7 @@ require 'bundler/gem_tasks'
 
 desc "Running Test"
 task :test do
-  system "bundle exec rspec spec/models/*.rb --debugger --backtrace --fail-fast"
+  # forgot how to include all spec files
+  system "bundle exec rspec spec/models/*spec.rb --debugger --backtrace --fail-fast"
+  system "bundle exec rspec spec/core/*spec.rb --debugger --backtrace --fail-fast"
 end

data/lib/one_touch/core/bridge.rb

@@ -0,0 +1,83 @@
+module OneTouch
+  class RelationRecorder
+    @@recorders = []
+
+    # port_group is Hash as {portname: [klass_name, ...]}
+    attr_accessor :bridge_klass, :bridge_class, :port_group
+    def initialize(opts)
+      # loop and set attr as bridge_klass = opts[:bridge_klass]
+      opts.each do |k,v|
+        if respond_to?("#{k}=")
+          send "#{k}=", v
+        end
+      end
+      @@recorders << self
+    end
+
+    def self.find(bridge_klass)
+      @@recorders.select {|rr| rr.bridge_klass.to_sym == bridge_klass.to_sym}.first
+    end
+
+    # update an existed instance or create a new instance
+    def self.update_or_new(opts)
+      if rr = find(opts[:bridge_klass])
+        rr.add_new_port(opts[:port_group]) if opts.has_key? :port_group
+        rr.bridge_class ||= opts[:bridge_class] if opts.has_key? :bridge_class
+        rr
+      else
+        new(opts)
+      end
+    end
+
+    # add only one port, make sure pg is {portname: klassname}
+    def add_new_port(pg)
+      portname = pg.keys.first
+      if port_group.has_key? portname
+        self.port_group[portname].concat pg[portname]
+      else
+        self.port_group[portname] = pg[portname]
+      end
+    end
+
+    def portname_of(klass)
+      port_group.select {|k,v| v.include? klass}.keys
+    end
+
+  end # END RelationRecorder
+
+  module PortBuild
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def append_relation(opts={})
+        opts.reverse_merge!(bridge_klass: :Bridge, portname: :host)
+        opts.merge!(port_group: {opts[:portname] => [name.to_sym]})
+        RelationRecorder.update_or_new(opts)
+        define_singleton_method "#{opts[:bridge_klass].underscore}_class" do
+          opts[:bridge_klass].constantize
+        end
+        define_singleton_method "#{opts[:bridge_klass].underscore}_klass" do
+          opts[:bridge_klass]
+        end
+      end
+    end
+
+    def portname_on(bridge_klass)
+      (rr = RelationRecorder.find(bridge_klass)) &&
+        rr.portname_of(self.class.name.to_sym)
+    end
+
+  end # END PortBuild
+
+  module Bridge
+
+    def self.included(base)
+      RelationRecorder.update_or_new(bridge_klass: base.name, bridge_class: base)
+    end
+
+
+  end # END Bridge
+end

data/lib/one_touch/models/active_record_extension.rb

@@ -26,11 +26,11 @@ module OneTouch
       #       belongs_to :tag
       #       acts_as_favor :no_default_relations => true
       def acts_as_favor(opt={})
-
+        include ::OneTouch::Bridge
         opt.reverse_merge!({:include_host_relation_module => true, :host_class_name => "User", :no_default_relations => false})
         class_attribute :host_relation_type, :favorable_relation_type, :instance_writer => false
 
-        method_name_of_host_klasses = "host_klasses_for_#{name.underscore}"
+        # method_name_of_host_klasses = "host_klasses_for_#{name.underscore}"
 
         include ActsAsFavor
 
@@ -57,46 +57,47 @@ module OneTouch
         # I should add more files to make here more clear
         # Some methods should be include first
         # And others should be include later
-        # This code should be in another file
-        #
+        # The following code should be in another file
 
         if opt[:include_host_relation_module]
           class_attribute :include_host_relation_module, :instance_writer => false
           self.include_host_relation_module = true
-          add_host_relation_map(favorable_klasses, :be_favors, :host)
+          add_host_relation_map(relation_recorder.port_group[:favorable], :be_favors, :host)
         end
 
-        if respond_to? method_name_of_host_klasses
-          send(method_name_of_host_klasses).each do |k|
-            k.to_s.constantize.after_load_acts_as_favor if k.to_s.constantize.respond_to? :after_load_acts_as_favor
-          end
+        relation_recorder.port_group[:host].each do |klassname|
+          klass = klassname.to_s.constantize
+          klass.after_load_acts_as_favor if klass.respond_to? :after_load_acts_as_favor
         end
-      end
 
+      end
 
       # Used in host class
       # Ex:
-      #   as_favor_host :klass => "OtherClass"
+      #   as_favor_host :bridge_klass => "AClass"
       #
       def as_favor_host(opt={})
-        opt = { :klass => "Favor", :no_default_relations => false }.merge opt
-
-        assign_cattr_in_favor_class(:host_klasses,opt)
+        include ::OneTouch::PortBuild
+        opt.reverse_merge!(bridge_klass: "Favor", no_default_relations: false, portname: :host)
+        append_relation(opt)
+        # assign_cattr_in_favor_class(:host_klasses,opt)
+        # Programmer Doc
         # The Name of has_many is stick to favors, to make it changable would cause some query problem
-        # :as => :host can not be configured too, cause in act_as_favor, the relation name was sticked
+        # :as => :host can not be configured too, cause in act_as_favor the relation name was sticked
         unless opt[:no_default_relations]
-          has_many :favors, :class_name => opt[:klass], :as => :host
+          has_many :favors, :class_name => opt[:bridge_klass], :as => :host
         end
         include AsFavorHost
       end
 
-      # Used in favorable class
+      # Used in favorable class, so self is a class
       def as_favorable(opt={})
-        opt = { :klass => "Favor", :no_default_relations => false }.merge opt
-
-        assign_cattr_in_favor_class(:favorable_klasses,opt)
+        include ::OneTouch::PortBuild
+        opt.reverse_merge!(bridge_klass: "Favor", no_default_relations: false, portname: :favorable)
+        append_relation(opt)
+        # assign_cattr_in_favor_class(:favorable_klasses,opt)
         unless opt[:no_default_relations]
-          has_many :be_favors, :class_name => opt[:klass], :as => :favorable
+          has_many :be_favors, :class_name => opt[:bridge_klass], :as => :favorable
         end
         include AsFavorable
         include HostRelation if favor_class.respond_to? :include_host_relation_module and favor_class.include_host_relation_module = true
@@ -105,14 +106,6 @@ module OneTouch
       private
 
       def add_host_relation_map(favorable_klasses, *two_connection_name)
-        class_attribute :favorable_to_media, :media_to_host, :instance_writer => false
-        unless respond_to? :favorable_klasses
-          class_attribute :favorable_klasses
-          self.favorable_klasses = favorable_klasses
-        end
-        self.favorable_to_media = two_connection_name.first
-        self.media_to_host = two_connection_name[1]
-
         include Relations
         self.target_to_media = :be_favors
         self.media_to_host = :host
@@ -123,24 +116,14 @@ module OneTouch
         end
       end
 
-      # Programmer Doc
-      #   To maintain the connection betwwen host, favorable and favor class,
-      #   defined class_attribute in their super class AR::Base
-      #   I don't know if there is any good solution to not disturb AR::Base
-      def assign_cattr_in_favor_class(cattr_name,opt)
-        class_attribute :favor_klass, :favor_class, :instance_writer => false
-        self.favor_klass = opt[:klass]
-        self.favor_class = favor_klass.constantize
-
-        cattr_name = "#{cattr_name}_for_#{opt[:klass].underscore}".to_sym
-        unless ::ActiveRecord::Base.respond_to? cattr_name
-          ::ActiveRecord::Base.class_attribute cattr_name, :instance_writer => false
-          ::ActiveRecord::Base.send "#{cattr_name}=", []
-        end
-        (::ActiveRecord::Base.send cattr_name) << self.name.to_sym
-      end
-
     end # End ClassMethods
 
   end # ActiveRecordExtension
 end
+
+# Programmer Doc
+# The most difficult is the loading order between host classes,favor class and favorable classes.
+# For example in host class, some methods must defined after favor class was load.
+# So if favor class was not load ,these methods define should be skipped and
+# after favor class was loaded, we should call these method define.
+# And I thought i should refactor the order design because there must be some duplicated cattr and class method

data/lib/one_touch/models/acts_as_favor.rb

@@ -9,11 +9,13 @@ module OneTouch
       self.cons_context_match = self::CONTEXT_MATCH
       self.context_relation = self::CONTEXT_RELATION if defined? self::CONTEXT_RELATION
 
-      # Seems there are many hook work to do, oppose hook, belongs hook ....
+      # Seems there are many hook need to implement, oppose hook, belongs hook ....
       #   All needed hook should be just about relations between contexts
       #   Other hooks should be write by user
       after_save :context_relation_hook if context_relation.presence
 
+      # TODO
+      # Add I18n support on message
       validates_inclusion_of :context,:in => cons_context, :message => "%{value} not included in CONTEXT"
 
       validate :context_should_match_favorable_type
@@ -40,7 +42,7 @@ module OneTouch
       #  for example,follow_investors retrive all record which context is follow and favorable type is investor
       # sample output :
       #   scope :focus_tags , where(:favorable_type => "Tag",:context => "focus")
-      # This function seems not useful in real life
+      # This function seems not useful in real life, So comment it
       #
       # cons_context_match.each do |context,favorable|
       #   favorable.each do |klass|
@@ -49,7 +51,7 @@ module OneTouch
       #   end
       # end
 
-      # just used in test
+      # Used in test
       # But in production, I think it should be run once at init
       # write how to use it in readme.md
       def self.context_match_keys_should_belongs_to_context
@@ -116,23 +118,17 @@ module OneTouch
         end
       end
 
+      def relation_recorder
+        RelationRecorder.find(self.name)
+      end
+
       # seems just used for OneTouch::Relations module
       def host_klasses
-        attr = "host_klasses_for_#{name.underscore}".to_sym
-        respond_to?(attr) ? send(attr) : []
+        relation_recorder.port_group[:host]
       end
 
       def favorable_klasses
-        attr = "favorable_klasses_for_#{name.underscore}".to_sym
-        respond_to?(attr) ? send(attr) : []
-      end
-
-      def favorable_to_media
-        :be_favors
-      end
-
-      def media_to_host
-        :host
+        relation_recorder.port_group[:favorable]
       end
 
       def build_by_three_elements(h, f, context)
@@ -143,6 +139,8 @@ module OneTouch
 
     private
 
+    # TODO
+    #   ADD i18n support on error message
     def host_should_differ_favorable
       if host_id == favorable_id and host_type == favorable_type
         errors.add(:favorable_id," can not the same as the host_id when types of host and favorable are the same ")
@@ -156,7 +154,6 @@ module OneTouch
       end
     end
 
-    # TODO: how to reslove two or more hook
     def context_relation_hook
       context_relation.each do |key,contexts|
         if contexts.include? context.to_sym

data/lib/one_touch/models/as_favor_host.rb

@@ -10,17 +10,26 @@ module OneTouch
       # when User as favorable, defined a method called favorable_context_as, here define another method to distinct the former
       scope :host_context_as, lambda { |context| joins(:favors).where(favor_class.table_name.to_sym => { :context => context } ) }
 
-      if favor_class.respond_to? :host_relation_type # means favor class has load acts_as_favor
+      if favor_class.respond_to? :host_relation_type # means favor class has load model ActsAsFavor
         build_context_klass_methods
       end
     end
 
     module ClassMethods
 
+      # TODO
+      #   favor_to(@favorable, focus) could extend to focus_to(@favorable)
+      #   favor_to(@favorable, like) could extend to like_to(@favorable)
+      #   means add more dynamic methods relies on context
+      # Ex:
+      #   User.favor_to(@user1, :follow)
+      #     => return guys(an ActiveRelation object) who follows @user1, so you can define fans
       def favor_to(favorable,context=default_context_in_host)
         host_context_as(context).merge(Favor.favorable_as favorable)
       end
 
+      # Programmer Doc
+      #   This method is not used in otherwhere
       def cached_favor_to(favorable,context=default_context_in_host)
         key = "#{self.name}_favor_to_#{favorable.class.name}_#{favorable.id}_#{context}"
         Rails.cache.fetch key do
@@ -32,6 +41,9 @@ module OneTouch
         build_context_klass_methods
       end
 
+      # Generate instance methods like
+      #   @user.focus_tags
+      #   => return a list of tags (ActiveRelation object) that focus by @user
       def build_context_klass_methods
         favor_class.cons_context_match.each do |context, klasses|
           klasses.each do |klass|

data/lib/one_touch/version.rb

@@ -1,3 +1,3 @@
 module OneTouch
-  VERSION = "1.3.0"
+  VERSION = "2.0.0"
 end

data/lib/one_touch.rb

@@ -1,3 +1,4 @@
 require "one_touch/version"
 require File.join(File.dirname(__FILE__), 'one_touch/railtie')
 require File.join(File.dirname(__FILE__), 'one_touch/engine')
+require File.join(File.dirname(__FILE__), 'one_touch/core/bridge.rb')

data/one_touch.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["raykin"]
   s.email       = ["raykincoldxiao@gmail.com"]
   s.homepage    = ""
-  s.summary     = %q{ It is used for recording relation between resources }
+  s.summary     = %q{ It is used for recording relations between resources }
   s.description = %q{ Make one click operation simple }
 
   s.rubyforge_project = "one_touch"

data/readme.md

@@ -1,13 +1,12 @@
 ### Intro
 In webapp, many data is generated by just one click like focus someone, dislike some post.This gem make it easy.
 
-These one click data most are relation data and was managed in single model in this gem. So we can analyze the relation data easily.
-
-Version ~> 1.1.0 has a serious bug. Please update to ~> 1.2.0
+These one click data are most relation data and will be managed in single model in this gem. So we can analyze the relation data easily.
 
 ## Dependency
-Rails > 3.0.
-Conflict with gem meta_where and squeel. Cause it changes some AR query syntax.
+Rails > 3.0
+
+Conflict with gem meta_where and squeel.
 
 ## Usage
     gem install one_touch
@@ -36,7 +35,8 @@ The generated relations between them are:
     Favor belongs_to :host, :class_name => "User"; belongs_to :favorable, :polymorphic => true
 This is default setting.
 
-You can define the relation by yourself.
+You can define the relation by yourself and also define the favors columns to
+make them match the relation.
 
     class Favor
       belongs_to :host, :polymorphic => true
@@ -44,25 +44,28 @@ You can define the relation by yourself.
       acts_as_favor :no_default_relations => true
     end
 
+In this case, favors columns are id, host_id, host_type, favorable_id,
+favorable_type and context.
+
 Make sure the relation name are host and favorable, they can not be changed
 
 Or you want Favor model to be another name, Bridge.
 
     class User
-       as_favor_host :klass => "Bridge"
+       as_favor_host :bridge_klass => :Bridge
     end
 
 In short, there are four relation names can not be configured, favors, be_favors, host and favorable.
-And if you change the Favor model name, make sure it consists in all applications.
+And if you change the Favor model name, make sure it consists in whole applications.
 
 ## Features
     Favor.add_context and Favor.del_context can add or del favors. Ex:
 
     # add a record that @host focus on @favorable
     Favor.add_focus(@host, @favorable)
-    #=> return @favor object, @favor.errors returns error msg if add favor was failed, you can use @favor.errors.blank? to check if favor was added successfully
+    #=> return @favor object, @favor.valid? returns false if add favor was failed
 
-####In version 1.3.0, add_focus change a little. And a new method add_focus! has added.
+#### In version 1.3.0, add_focus was changed a little. And a new method add_focus! has added.
 
     Favor.add_focus!(@host, @favorable)
     #=> raise exception when add was failed
@@ -115,17 +118,16 @@ This means @user1 is more close to @user2 than @user3.Maybe the answers that @us
   Because We create or delete data in one click. No Form Needed.
 
 ### TODO
-  Change the dependency meta_where to squeel and make it support Rails3.1.
-
   Add cache to favored_by, favor_to.
 
   Add a generator to make install faster.
 
   Add another gem to supply view and controller template.
 
+  Add travis support
 ### Abstract Requirement
   Connect any two resource in one model.
   I really want to implement this gem as more abstract requirement.That means four relation names can be configured,  But's not easy.
 
 ### License
-MIT
+MIT

data/spec/core/relation_recorder_spec.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'one_touch'
+
+class Bridge; end
+
+class Favor; end
+
+class User
+  include OneTouch::PortBuild
+end
+
+class Admin; include OneTouch::PortBuild; end
+
+class Post; end
+
+class Comment; end
+
+class Port; end
+
+User.append_relation(bridge_klass: 'Favor', portname: :host)
+Admin.append_relation(bridge_klass: 'Favor', portname: :host)
+
+describe OneTouch::RelationRecorder do
+
+  it "add an instance of RelationRecorder which bridge_klass is 'Favor'" do
+    OneTouch::RelationRecorder.find('Favor').port_group.should eq(host: [:User, :Admin])
+    User.favor_class.should eq(Favor)
+  end
+
+  it " user's port name on Favor is host" do
+    User.new.portname_on(:Favor).should eq([:host])
+  end
+
+  it " host port_group are User and Admin" do
+    OneTouch::RelationRecorder.find(:Favor).port_group[:host].should eq([:User, :Admin])
+  end
+
+  it " add bridge_class when include OneTouch::Bridge into Favor class" do
+    Favor.class_eval do
+      include OneTouch::Bridge
+    end
+    OneTouch::RelationRecorder.find(:Favor).bridge_class.should eq(Favor)
+  end
+
+end

data/spec/models/as_favor_host_spec.rb

@@ -5,11 +5,8 @@ describe OneTouch::AsFavorHost do
   include OneTouch::LoadTestData
   context "foo" do
 
-    [:focus_tags,:favor_klass].each do |method_name|
-      it "should response #{method_name}, and ActiveRecord::Base not response to it" do
-        foo.should respond_to method_name
-        ActiveRecord::Base.should_not respond_to method_name
-      end
+    it "foo should response to focus_tags" do
+      foo.should respond_to :focus_tags
     end
 
     it "should find a favor on afavor" do

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ require 'rails'
 require 'one_touch'
 
 require File.join(File.dirname(__FILE__), 'fake_app')
-# require 'squeel'
 require 'rspec/rails'
 require 'models/load_test_data'
 
@@ -16,10 +15,6 @@ RSpec.configure do |config|
     #CreateAllTables.down if ActiveRecord::Base.connection.table_exists? 'favors'
     CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'favors'
 
-    # Squeel.configure do |config|
-    #   config.load_core_extensions :hash, :symbol
-    # end
-
     Tag.as_favorable
 
     User.as_favor_host
@@ -33,4 +28,3 @@ RSpec.configure do |config|
     # relation should be in another module
   end
 end
-

metadata

@@ -1,39 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: one_touch
 version: !ruby/object:Gem::Version
-  version: 1.3.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - raykin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-06 00:00:00.000000000Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &10068800 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *10068800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &10067760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - '>'
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *10067760
-description: ! ' Make one click operation simple '
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ' Make one click operation simple '
 email:
 - raykincoldxiao@gmail.com
 executables: []
@@ -44,6 +49,7 @@ files:
 - Gemfile
 - Rakefile
 - lib/one_touch.rb
+- lib/one_touch/core/bridge.rb
 - lib/one_touch/engine.rb
 - lib/one_touch/models/active_record_extension.rb
 - lib/one_touch/models/acts_as_favor.rb
@@ -57,6 +63,7 @@ files:
 - lib/one_touch/version.rb
 - one_touch.gemspec
 - readme.md
+- spec/core/relation_recorder_spec.rb
 - spec/fake_app.rb
 - spec/models/acts_as_favor_spec.rb
 - spec/models/array_spec.rb
@@ -66,27 +73,25 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 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: one_touch
-rubygems_version: 1.8.11
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
-summary: It is used for recording relation between resources
+specification_version: 4
+summary: It is used for recording relations between resources
 test_files: []
-has_rdoc: