model_sorter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9ca7532ce31c4994d2f549197394533f76859f1
-  data.tar.gz: 2791263ed77cf387556f271758e3eb2b23a45627
+  metadata.gz: 10a92e51ba86308774599943ab345b332fa02cc8
+  data.tar.gz: e41dd8beaf3450599d40464f95bd6d18c40ed2b9
 SHA512:
-  metadata.gz: b34bbb45a357b491960739e1f8badf75121c2dcb3cee751f3d9592a73e7d7dfe90f9f32705d53516dc048ea01e11aa6a4a650bd7b37a997852a9ec437cbd7438
-  data.tar.gz: 628c93e34c77da07ec34b3c61a313752aeb568a71fdb20457eefa8811ddb6021d3d8fe0201cc5b9970c3f194f55dad523d70ce82caa08789b6dd75dc2cdf8f22
+  metadata.gz: 566d316f4d810ca4417db6100c2850c55ddc1e9dcf653e3ce5050c107bb62032060b249693eb98168ad59c6dd8721bfdc04eaed84267aa41dd344eb7f158f623
+  data.tar.gz: 19e0c2b0cea499e7cf3804b1691ec8f69576cc62e10f580538698f41201125398904b974d2ad6308523596f817a757522d0220e2cc68e3dc915fc1be95cc117f

data/README.md

@@ -1,6 +1,6 @@
 # ModelSorter
 
-用redis支持ActiveRecord的对象排序，免去在数据库中创建排序字段。
+用 Redis 来支持 ActiveRecord 或 DataMapper 的等 Ruby ORM 对象排序，免去在文件数据库中使用排序字段。
 
 ## Installation
 
@@ -8,12 +8,16 @@ Add this line to your application's Gemfile:
 
     gem 'model_sorter'
     
-add this to 'config/initializes/model_sorter.rb'
-    module ModelSorter
-      SORT_COLUMN = "what_column_you_want"
-    end
+Name your column, add this to 'config/initializes/model_sorter.rb'
+```
+module ModelSorter
+  SORT_COLUMN = "what_column_you_want"
+end
+```
 ## Usage
 
+As：需要 View 中配置 Post 结果集的对象排序（用 jquery-ui.sortable 等组件）。
+
 __In your Model__
 
 ```
@@ -25,13 +29,19 @@ end
 
 __In your Coffee__
 
-组装出Hash：{ id: index, id: index, ... }
+组装出 Hash 
+
+    hsh: { id: index, id: index, ... }
+    
+或 Array, 按你希望的顺序由小到大
+  
+    arr: [ id, id,  ... ] 
 
 ```
 $.ajax(
   type:     '...',
   url:      '...',
-  data:     { serial_hsh: {5:1, 6:2, 8:3, 1:4, 3:5} },
+  data:     { serial_list: [5, 3, 4, 2, ...] },
   dataType: '...',
   success:  () ->
     # ...
@@ -40,7 +50,7 @@ $.ajax(
 
 __In your Controller__
 
-用sort_serial_number方法，传入hsh
+用sort_serial_number方法，传入Hash, Array, ActiveRecord::Relation ...
 
 ```
 def index
@@ -48,8 +58,11 @@ def index
 end
 
 def update_serial_number
-  serial_hsh = params[:serial_hsh]
-  if Post.sort_serial_number(serial_hsh)
+  serial_list = params[:serial_list]
+  
+  # if Post.sort_serial_number(Post.all)
+  
+  if Post.sort_serial_number(serial_list)
     return render text: "success"
   else
     return render text: "fail"
@@ -59,10 +72,12 @@ end
 
 ## Note
 
-出现这个错误？请再看 Installation
+1. 出现这个错误？请再看 Installation
 
     uninitialized constant ModelSorter::SORT_COLUMN (NameError)
     
+2. 使用 DataMapper 需有 id 字段    
+    
 
 
 

data/lib/model_sorter/version.rb

@@ -1,3 +1,3 @@
 module ModelSorter
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/model_sorter.rb

@@ -8,11 +8,52 @@ module ModelSorter
         #定义counter
         counter ModelSorter::SORT_COLUMN.to_sym
 
-        #Redis批量写入所有klass对象counter
-        def self.sort_serial_number hsh
+        # Usage
+        #
+        # hsh 格式： {"id" => "index" ...}
+        # hsh = {2:1, 3:2, 1:3}
+        # Klass.sort_serial_number hsh
+        # =>
+        #   id  |  index
+        #    1  |    3
+        #    2  |    1
+        #    3  |    2
+        #
+        # ---------------------------------
+        #
+        # arr 格式： ["id", "id" ...]
+        # arr = [1, 2, 3]
+        # Klass.sort_serial_number arr
+        # =>
+        #   id  |  index
+        #    1  |    1
+        #    2  |    2
+        #    3  |    3
+        #
+        # ---------------------------------
+        #
+        # 使用ActiveRecord::Relation的实例
+        # relation_instance = Klass.all
+        # Klass.sort_serial_number relation_instance
+        # =>
+        #   id  |  index
+        #    1  |    1
+        #    2  |    2
+        #    3  |    3
+        #
+        # 用Redis批量写入所有klass对象counter
+        def self.sort_serial_number serial_list
           results = self.redis.multi do
-            hsh.each do |id, sn|
-              self.redis.set "#{self.name.downcase}:#{id}:#{ModelSorter::SORT_COLUMN}", sn.to_i
+            case
+            when serial_list.is_a?(Hash)
+              serial_list.each do |id, sn|
+                self.redis.set "#{self.name.downcase}:#{id}:#{ModelSorter::SORT_COLUMN}", sn.to_i
+              end
+            else
+              #Handle Array and ActiveRecord::Relation
+              serial_list.each_with_index do |id, index|
+                self.redis.set "#{self.name.downcase}:#{id}:#{ModelSorter::SORT_COLUMN}", index + 1
+              end
             end
           end
           results.uniq == ["OK"]

data/spec/model_sorter_spec.rb

@@ -33,7 +33,6 @@ describe ModelSorter do
       @hsh[i] = 6 - i
       i += 1
     end
-
   end
 
   it "set User's all serial_number to redis" do
@@ -45,4 +44,11 @@ describe ModelSorter do
     expect(arr).to eq([5, 4, 3, 2, 1])
   end
 
+  it "handle serial_number is Array" do
+    User.sort_serial_number @hsh.keys
+
+    arr = @users.sort_by{ |u| u.ex_column.value }.map{|u| u.id}
+    expect(arr).to eq([1, 2, 3, 4, 5])
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: model_sorter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Scott1743
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-objects