one_touch 1.0.0 → 1.0.1

data/lib/one_touch/models/acts_as_favor.rb

@@ -8,7 +8,7 @@ module OneTouch
       class_attribute :cons_context, :cons_context_match, :context_relation, :instance_writer => false
       self.cons_context = self::CONTEXT
       self.cons_context_match = self::CONTEXT_MATCH
-      self.context_relation = self::CONTEXT_RELATION if defined? CONTEXT_RELATION
+      self.context_relation = self::CONTEXT_RELATION if defined? self::CONTEXT_RELATION
 
       # Seems there are many hook work to do, oppose hook, belongs hook ....
       #   All needed hook should be just about relations between contexts

data/lib/one_touch/version.rb

@@ -1,3 +1,3 @@
 module OneTouch
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/one_touch.gemspec

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

data/readme.md

@@ -13,63 +13,58 @@ version ~> 2 will support Rails3.1 and need squeel
 Suppose we have User, Post and Tag model.We also has a Favor model which record the relations between users or between user and post.Favor model could be anyother model.
 
 Then we define:
-```ruby
-    class User; as_favor_host; as_favorable; end;
 
+    class User; as_favor_host; as_favorable; end;
     class Post; as_favorable; end;
-
     class Tag; as_favorable; end;
-
-    # Make sure Favor has defined constants CONTEXT and CONTEXT_MATCH before acts_as_favor
-    # The Favor column depend on the relations you defined
-    # In this case, it would be id, user_id, favorable_id, favorable_type, context
-    # Don't forget context column
+Make sure Favor has defined constants CONTEXT and CONTEXT_MATCH before acts_as_favor
+The Favor columns depend on the relations you defined
+In this case, it would be id, user_id, favorable_id, favorable_type, context.
+Don't forget context column.
     class Favor
       CONTEXT = Set.new(%w[focus favorite follow agree oppose buy subscribe])
       CONTEXT_MATCH = { :focus => [:Tag, :Post], :follow => [:User] }
 
       acts_as_favor
     end
-    # The real relations between them are:
-    #   User has_many :favors, :class_name => "Favor", :as => :host
-    #   Post has_many :be_favors, :class_name => "Favor", :as => :favorable
-    #   Favor belongs_to :host, :class_name => "User"; belongs_to :favorable, :polymorphic => true
-    # This is default setting
-```ruby
+The generated relations between them are:
+    User has_many :favors, :class_name => "Favor", :as => :host
+    Post has_many :be_favors, :class_name => "Favor", :as => :favorable
+    Favor belongs_to :host, :class_name => "User"; belongs_to :favorable, :polymorphic => true
+This is default setting.
+
 You can define the relation by yourself.
-```ruby
+
     class Favor
       belongs_to :host, :polymorphic => true
       belongs_to :favorable, :polymorphic => true
       acts_as_favor :no_default_relations => true
     end
-    # make sure the relation name are host and favorable, they can not be changed
-```ruby
+Make sure the relation name are host and favorable, they can not be changed
+
 Or you want Favor model to be another name, Bridge.
-```ruby
+
     class User
        as_favor_host :klass => "Bridge"
     end
-```ruby
+
 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.
 
 ## Features
     Favor.add_context and Favor.del_context can add or del favors. Ex:
-```ruby
-    # @host focus on @favorable
+
+    # add a record that @host focus on @favorable
     Favor.add_focus(@host, @favorable)
     #=> success return true, fail return error @favor object
     #=> could also
 
-    # @host remove focus on @favorable
+    # remove a record. @host remove focus on @favorable
     Favor.del_focus(@host, @favorable)
 
-```ruby
-
 ### Query Methods
 The most useful methods would be: favor_to, favored_by, allstars. They are all class methods.
-```ruby
+
     User.favor_to(@user1, :follow) #=> return guys(an ActiveRelation object) who follows @user1, so you can define fans
     def fans
       User.favor_to(self, :follow)
@@ -84,27 +79,26 @@ The most useful methods would be: favor_to, favored_by, allstars. They are all c
     @user1.focus_tags
     # => return the tags which was focused by @user1
     @user1.favor?(@tag1, :focus) #=> return true if @user1 focus on @tag1
-```ruby
+
 Actually the favor_to and favored_by are fundmental methods which many other methods based on
 
 #### Analyze Relation Data
 
 Use Favor.host_relations to get the relations of Users.
 But first you should define the relation mark rule.
-```ruby
+
     class Favor
       def self.relation_rules
         { [:agree, :Answer] => 3, [:follow, :User] => 2, [:focus, :Tag] => 1 }
       end
     end
-```ruby
 
 The results like:
-```ruby
+
     Favor.host_relations
     # It a Hash, the first element is
     # => @user1 => { @user2 => 100, @user3 => 50, .... }
-```ruby
+
 This means @user1 is more close to @user2 than @user3.Maybe the answers that @user1 and @user2 both agree are more than the answers that @user1 and @user2 both agree.Actually it depends on your mark rule, but it really shows there must be more common betweens @user1 and @user2.
 ##### Becare running host_relations is really time consumer, so run it in backend job and keep the results.
 
@@ -120,3 +114,6 @@ This means @user1 is more close to @user2 than @user3.Maybe the answers that @us
 ### 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: one_touch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-11 00:00:00.000000000Z
+date: 2011-11-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &25065280 !ruby/object:Gem::Requirement
+  requirement: &25054060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,8 +21,8 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *25065280
-description: ! ' One Touch makes one click operation simple '
+  version_requirements: *25054060
+description: ! ' Make one click operation simple '
 email:
 - raykincoldxiao@gmail.com
 executables: []
@@ -76,6 +76,6 @@ rubyforge_project: one_touch
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: One Touch is used for recording relation between resources
+summary: It is used for recording relation between resources
 test_files: []
 has_rdoc: