cacchern 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cada82336b3402cd99bbf835bfd3e6b1bb8188f3481a42832e0221505abb008b
-  data.tar.gz: 64e923503de48ada4e5d4203fb39bb86e4be592bbbbae85f6e88e1fac0dfba74
+  metadata.gz: 59d307f8d9365a1f5154a2584f58f0b74b09c88a19c5e58d9f7e205692e51d8c
+  data.tar.gz: 3b83aa1c03998c439e1ee63c0838563eb11e82268933ec53fa5c46d8d393d241
 SHA512:
-  metadata.gz: b36a6076033a42c7f68efbe37cd6497b3ab2bf6c9c70892e37ea1d8aa62d632ccd23223795f182ddc18b81ebfd30ea3f5a8b045a055c97b164ba92e8ea4efd4a
-  data.tar.gz: 7c1c2c95e2270fbdb48cd179325ab63b3bb81932aedf2a0e3396f7e2630e1112ac3325267d32f3d7d47676dbea31508acd41d0cc603df6f7b60a862c4d2bd46c
+  metadata.gz: 230469df9e4bb596d0dac5d15030cb00547b7abf98b818bd2ab9c58c1edc1402b457d6708374646e56d1a0ad02639c2c181f20ca9e4afd54c8c898d0f5592935
+  data.tar.gz: '025968b870076cb72b696049cc390049045b4d197f17cb2ff1e22d5fde86617cbaa3fdb755f98c66b202836a27e2084199c8dec5eab3cf7bba149e040460abbc'

data/.rubocop.yml

@@ -1 +1,4 @@
 inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -10,19 +10,8 @@
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 56
-
-# Offense count: 6
-Style/Documentation:
   Exclude:
     - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/cacchern.rb'
-    - 'lib/cacchern/incrementable_sorted_set.rb'
-    - 'lib/cacchern/member.rb'
-    - 'lib/cacchern/set.rb'
-    - 'lib/cacchern/sorted_set.rb'
-    - 'lib/cacchern/value.rb'
 
 # Offense count: 6
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cacchern (0.0.3)
+    cacchern (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,7 +20,100 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Create classes
+
+Create class that overrides Cacchern::Value
+
+```ruby
+class Score < Cacchern::Value
+  validates :key, presence: true, numericality: { only_integer: true }
+  validates :value, presence: true, numericality: true
+end
+```
+
+Create class that overrides Cacchern::Value
+
+```ruby
+class ScoreSet < Cacchern::SortedSet
+  contain_class Score
+end
+```
+
+2. Add value
+
+```ruby
+base_set = ScoreSet.new('base')
+#=> #<ScoreSet:0x000056544559a520 @key="score_set:base">
+score = Score.new(1, 100)
+#=> #<Score:0x00005654456194b0
+# @errors=#<ActiveModel::Errors:0x0000565445619050 @base=#<Score:0x00005654456194b0 ...>, @details={}, @messages={}>,
+# @key=1,
+# @validation_context=nil,
+# @value=100>
+base_set.add(score)
+base_set.add(Score.new(2,50))
+
+base_set.add_all([Score.new(3,50),Score.new(4,40)])
+```
+
+
+3. Get Values
+
+```ruby
+base_set.order(:desc)
+#=> [#<Score:0x000056544570ebb8
+#  @errors=#<ActiveModel::Errors:0x000056544570ea28 @base=#<Score:0x000056544570ebb8 ...>, @details={}, @messages={}>,
+#  @key="1",
+#  @validation_context=nil,
+#  @value=100.0>,
+# #<Score:0x000056544570e230
+#  @errors=#<ActiveModel::Errors:0x000056544570e0a0 @base=#<Score:0x000056544570e230 ...>, @details={}, @messages={}>,
+#  @key="2",
+#  @validation_context=nil,
+#  @value=50.0>]
+```
+
+```ruby
+base_set.order(:asc)
+#=> [#<Score:0x000056544579aaa0
+#  @errors=#<ActiveModel::Errors:0x000056544579a910 @base=#<Score:0x000056544579aaa0 ...>, @details={}, @messages={}>,
+#  @key="2",
+#  @validation_context=nil,
+#  @value=50.0>,
+# #<Score:0x000056544579a168
+#  @errors=#<ActiveModel::Errors:0x0000565445799fd8 @base=#<Score:0x000056544579a168 ...>, @details={}, @messages={}>,
+#  @key="1",
+#  @validation_context=nil,
+#  @value=100.0>]
+```
+
+4. Remove value
+
+```ruby
+base_set.remove(2)
+#=> true
+base_set.order(:asc)
+#=> [#<Score:0x0000565445850990
+#  @errors=#<ActiveModel::Errors:0x0000565445850800 @base=#<Score:0x0000565445850990 ...>, @details={}, @messages={}>,
+#  @key="1",
+#  @validation_context=nil,
+#  @value=100.0>]
+base_set.remove_all 
+```
+
+- IncrementableSortedSet
+
+```ruby
+class IScoreSet < Cacchern::IncrementableSortedSet
+  contain_class Score
+end
+```
+
+```ruby
+base_set = IScoreSet.new('base')
+base_set.add(Score.new(2,50))
+base_set.increment(Score.new(2,50))
+```
 
 ## Development
 

data/lib/cacchern.rb

@@ -10,5 +10,6 @@ require 'cacchern/version'
 require 'cacchern/incrementable_sorted_set'
 require 'cacchern/sorted_set'
 require 'cacchern/set'
-require 'cacchern/value'
+require 'cacchern/sortable_member'
 require 'cacchern/member'
+require 'cacchern/object'

data/lib/cacchern/object.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Cacchern
+  class Object
+    include ActiveModel::Model
+
+    attr_reader :id
+    attr_reader :key
+    attr_reader :value
+
+    define_model_callbacks :save
+    before_save { throw(:abort) unless valid? }
+
+    def initialize(id, value)
+      @id = id
+      @key = "#{self.class.name.underscore}:#{id}"
+      @value = value
+    end
+
+    def save
+      valid? ? create_or_update : false
+    end
+
+    def save!
+      valid? ? create_or_update : raise_validation_error
+    end
+
+    def delete
+      Redis.current.del(key)
+    end
+
+    class << self
+      def key(id)
+        "#{name.underscore}:#{id}"
+      end
+
+      def find(id)
+        key = self.key(id)
+        value = Redis.current.get(key)
+
+        new(id, value) if value
+      end
+    end
+
+    private
+
+    def create_or_update
+      Redis.current.set(key, value) == 'OK'
+    end
+  end
+end

data/lib/cacchern/{value.rb → sortable_member.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Cacchern
-  class Value
+  class SortableMember
     include ActiveModel::Model
 
     attr_reader :key, :value

data/lib/cacchern/sorted_set.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cacchern/value'
+require 'cacchern/sortable_member'
 
 module Cacchern
   class SortedSet
@@ -12,7 +12,7 @@ module Cacchern
       end
 
       def value_class
-        @value_class ||= Value
+        @value_class ||= SortableMember
       end
     end
 

data/lib/cacchern/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cacchern
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cacchern
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Shuhei TAKASUGI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -90,9 +90,10 @@ files:
 - lib/cacchern.rb
 - lib/cacchern/incrementable_sorted_set.rb
 - lib/cacchern/member.rb
+- lib/cacchern/object.rb
 - lib/cacchern/set.rb
+- lib/cacchern/sortable_member.rb
 - lib/cacchern/sorted_set.rb
-- lib/cacchern/value.rb
 - lib/cacchern/version.rb
 - redis.yml.erb
 homepage: https://github.com/shuyuhey/cacchern