cache_driver 0.3.6 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 829cd43eff521ca5544bae10210be7891ea5fa7c
-  data.tar.gz: fc86c370316a288f0046df7a0858e10da2a10187
+  metadata.gz: 6f3f643df601890d16e5c1548a91ca05029bbeba
+  data.tar.gz: 9d095542cf68507aa194fda41dfd16040679e879
 SHA512:
-  metadata.gz: 4217e017330f42414f9199a93abb34effd1c79019d227a9397f6dd74e59a4b108a703bcb0d918d8d9c315978bad6c05a09f1c9f3fd6faab9b660ac7f334b1995
-  data.tar.gz: 17d0bbcd58b314ec0394e8c45b3c07700fa0978933051df96667fa1c361e2b615e65404cf9fb06b438a7b27bb347842a5f71d72d050804db5e07af60630a96f6
+  metadata.gz: 59eb1cec1457a54727f6523d2526e8edd0b87c47d04324b242c2f29d8141074b9107fa295610fc1925787be681ddff21453eb52ad476beb2d930158b7a47bbdc
+  data.tar.gz: 7da2b27da62c36dbcfdc2c26d3dc344f408a752053a09173a428a96ca5227c14d263df53d3a5028c86b9caf58d41801403dcf9d90444695770682ada57f64eab

data/README.md

@@ -7,7 +7,7 @@ This gem makes rails model act as ActiveRecord, but not save data into database
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cache_driver'
+gem 'cache_driver', '~> 0.3'
 ```
 
 And then execute:
@@ -24,13 +24,13 @@ Add following code to environments/development.rb or environments/production.rb
 
 ```ruby
 CacheDriver.setup do |config|
-	# set cache store type, :file or :redis
-	config.store = :file
-	config.file_dir = Rails.root.join('tmp', 'cache')
-	#config.store = :redis
-	#config.redis_host = "127.0.0.1"
-	#config.redis_port = 6379
-	#config.redis_namespace = "namespace"
+  # set cache store type, :file or :redis
+  config.store = :file
+  config.file_dir = Rails.root.join('tmp', 'cache')
+  #config.store = :redis
+  #config.redis_host = "127.0.0.1"
+  #config.redis_port = 6379
+  #config.redis_namespace = "namespace"
 end
 ```
 
@@ -42,10 +42,10 @@ Just define model like below
 
 ```ruby
 class CacheModel < CacheRecord
-	# attribute name which is made as key to cache data
-	def self.key_attr
-		"attr_name"
-	end
+  # attribute name which is made as key to cache data
+  def self.key_attr
+    "attr_name"
+  end
 end
 ```
 
@@ -54,23 +54,34 @@ So you can use this model just like other ActiveRecord instance in controllers l
 ```ruby
 cache_models = CacheModel.find_all  # get all instance in cache  
 
-cache_model = CacheModel.find_by_key key  # get instance with key
+cache_model = CacheModel.find_by_key key  # get instance which has key_attr
 
-cache_model.save!  # save this instance to cache
+cache_model = CacheModel.find_current  # get instance which has no key_attr
+
+CacheModel.clear  # remove all cache
+
+cache_model.save  # save this instance to cache
 
 cache_model.destroy  # delete this instance
 ```
 
-Also you can customize the data which you want to cache. 
-Just override the two methods below
+By default, the attribute `Fixnum`, `String`, `Array`, `Hash` will be serialized to cache. But you should declare how to process other object such as Symbol or Class you creates
+So you can customize the serialization method to change data which you want to cache by overriding the two methods below
 
 ```ruby
 def to_cache
+  # super will process Fixnum, String, Array, Hash and return a new HashMap to use for serialization
+  # do other work with this hash to customize way of serialization
   # return a hashmap which you want to cache for this model
+  hash = super
 end
 
 def self.from_cache(obj)
-  # return this model instance from a hashmap obj include data you cached
+  # super will return a new instance for this class from a HashMap named `obj` which unserialized from cache, and the key of HashMap is String not Symbol.
+  # Only Fixnum, String, Array, Hash can be unserialized into HashMapexactly
+  # do other work with this new instance to customize way of unserialization
+  # return a instance of this Class which is unserialized from cache
+  ins = super obj
 end
 ```
 
@@ -87,11 +98,12 @@ Use the the command above to go to cache inspector and you will see the informat
 After this you can use the following six commands to do something with the cache set by current project
 
 ```sql
+CacheDriver > ?  # show all commands and descriptions
 CacheDriver > show models
-CacheDriver > desc <model>
-CacheDriver > select from <model> (where id=<id>)
-CacheDriver > insert to <model> values {'id' => 1, ...}
-CacheDriver > delete from <model> where id=<id>
+CacheDriver > show keys <model>
+CacheDriver > find <model> in <key>
+CacheDriver > save <model> to <key> withs <attr1>=<val1>,<attr2>=<val2>,...
+CacheDriver > delete <model> in <key>
 ```
 
 ## Contributing

data/cache_driver.gemspec

@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
 
   spec.add_runtime_dependency 'redis', '~> 3.3'
+  spec.add_runtime_dependency "tty-prompt", "~> 0.18"
+  spec.add_runtime_dependency "colorize", "~> 0.8"
 end

data/lib/cache_driver.rb

@@ -1,4 +1,6 @@
 require "redis"
+require 'tty-prompt'
+require 'colorize'
 
 require "cache_driver/version"
 require "cache_driver/config"
@@ -9,15 +11,15 @@ require "cache_driver/redis_cache_util"
 
 
 module CacheDriver
-	class Railtie < ::Rails::Railtie
-		rake_tasks do 
-			load 'tasks/cache.rake'
-		end
-	end
+  class Railtie < ::Rails::Railtie
+    rake_tasks do 
+      load 'tasks/cache.rake'
+    end
+  end
 end
 
 unless CacheDriver.configed?
-	CacheDriver.setup do |config|
-		config.store = :file
-	end
+  CacheDriver.setup do |config|
+    config.store = :file
+  end
 end

data/lib/cache_driver/cache_record.rb

@@ -1,33 +1,53 @@
 class CacheRecord
+  def self.key_attr
+    nil
+  end
 
   def self.find_all
     CacheRecord.cache_util.read_all CacheUtil.class_to_type(self)
   end
 
-  def self.find_by_key(key=0)
+  def self.find_by_key(key)
     CacheRecord.cache_util.read CacheUtil.class_to_type(self), key
   end
 
-  def save!
-    CacheRecord.cache_util.write CacheUtil.class_to_type(self.class), self.class.key_attr ? self.send(self.class.key_attr) : 0, self
+  def self.find_current
+    if self.key_attr
+      raise "#{self} is not a unique class, use method find_by_key instead"
+    else
+      self.find_by_key "current"
+    end
   end
 
-  def destroy
-    CacheRecord.cache_util.delete CacheUtil.class_to_type(self.class), self.class.key_attr ? self.send(self.class.key_attr) : 0
+  def self.clear
+    self.find_all.each(&:destroy)
   end
 
-  def self.key_attr
-    nil
+  def save
+    raise "attr key :#{self.class.key_attr} is missing" if self.key_attr_missing?
+
+    CacheRecord.cache_util.write CacheUtil.class_to_type(self.class), self.class.key_attr ? self.send(self.class.key_attr) : "current", self
+  end
+
+  def destroy
+    raise "attr key :#{self.class.key_attr} is missing" if self.key_attr_missing?
+
+    CacheRecord.cache_util.delete CacheUtil.class_to_type(self.class), self.class.key_attr ? self.send(self.class.key_attr) : "current"
   end
 
   def to_cache
-    self
+    res = {}
+    self.instance_variables.each do |var|
+      var_name = var.to_s.delete('@')
+      res[var_name.to_sym] = self.instance_variable_get("@#{var_name}")
+    end
+    res
   end
 
   def self.from_cache(obj)
-    ins = self.new
+    ins = self.allocate
     obj.each do |key, value|
-      ins.send "#{key}=", value
+      ins.instance_variable_set "@#{key}", value
     end
     ins
   end
@@ -36,4 +56,9 @@ class CacheRecord
   def self.cache_util
     CacheDriver.store_file? ? FileCacheUtil : CacheDriver.store_redis? ? RedisCacheUtil : nil
   end
+
+  protected
+  def key_attr_missing?
+    self.class.key_attr && self.instance_variable_get("@#{self.class.key_attr}").nil?
+  end
 end

data/lib/cache_driver/version.rb

@@ -1,3 +1,3 @@
 module CacheDriver
-  VERSION = "0.3.6"
+  VERSION = "0.3.9"
 end

data/lib/tasks/cache.rake

@@ -1,119 +1,230 @@
+class CacheDriverClient
+  def initialize
+    if CacheDriver.config.store == :file
+      @cli = CacheDriver.config.file_dir
+    elsif CacheDriver.config.store == :redis
+      @cli = Redis.new :host => CacheDriver.config.redis_host, :port => CacheDriver.config.redis_port
+    end
+  end
+
+  def show_models
+    models = []
+    if @cli.class == Pathname
+      @cli.each_child do |file|
+        filename = file.basename.to_s
+        if filename =~ /.+s/i
+          models << filename[0..-2]
+        end
+      end
+    elsif @cli.class == Redis
+      models = @cli.keys.map do |key|
+        key.gsub("#{CacheDriver.config.redis_namespace}:", '').gsub(/#.+/, '')
+      end.uniq
+    end
+    models.sort
+  end
+
+  def show_keys(model)
+    model = "#{model}s"
+    keys = []
+    if @cli.class == Pathname
+      @cli.join(model).each_child do |file|
+        filename = file.basename.to_s
+        if filename =~ /\.cache/i
+          keys << filename.gsub(/\.cache/, '')
+        end
+      end
+    elsif @cli.class == Redis
+      keys = @cli.keys("#{CacheDriver.config.redis_namespace}:#{model}*").map do |key|
+        key.gsub("#{CacheDriver.config.redis_namespace}:", '').gsub(/.+#/, '')
+      end
+    end
+    keys.sort
+  end
+
+  def find(model, key)
+    model = "#{model}s"
+    if @cli.class == Pathname
+      file = @cli.join(model, "#{key}.cache")
+      return nil unless file.exist? && file.file?
+      json = File.read file
+    elsif @cli.class == Redis
+      json = @cli.get("#{CacheDriver.config.redis_namespace}:#{model}##{key}")
+    end
+
+    return nil unless json
+
+    res = json.split ' --> '
+    res[1] = JSON.parse res[1]
+    res
+  end
+
+  def save(model, key, assignments)
+    rec = self.find model, key
+    rec = ['', {}] unless rec
+    rec[0] = Time.now
+    rec[1] = rec[1].merge(assignments).to_json
+
+    model = "#{model}s"
+    if @cli.class == Pathname
+      dir = @cli.join(model)
+      Dir.mkdir dir unless Dir.exist? dir
+      file = File.new dir.join("#{key}.cache"), 'w'
+      file.puts rec.join(' --> ')
+      file.close
+      res = "OK"
+    elsif @cli.class == Redis
+      res = @cli.set "#{CacheDriver.config.redis_namespace}:#{model}##{key}", rec.join(' --> ')
+    end
+
+    res = "OK"
+  end
+
+  def delete(model, key)
+    model = "#{model}s"
+    if @cli.class == Pathname
+      file = @cli.join(model, "#{key}.cache")
+      if file.exist? && file.file?
+        file.delete
+        res = 1
+      else
+        res = 0
+      end
+    elsif @cli.class == Redis
+      res = @cli.del("#{CacheDriver.config.redis_namespace}:#{model}##{key}")
+    end
+    res == 1
+  end
+
+  def clear(model)
+    res = self.show_keys(model).map do |key|
+      [key, self.delete(model, key)]
+    end
+    Hash[res]
+  end
+end
+
+
+
 namespace :cache do
-	desc "inspect cache content"
+	desc "inspect cache content with CacheDriver"
 	task :inspect => :environment do
+    quit = /exit/
+    help = /\?/
 		show_models = /show models/i
-		desc_model = /desc (\S+)/i
-		select = /select from (\S+)( where id\s?=\s?(\d+))?/i
-		insert = /insert into (\S+) values ({.*})/i
-		delete = /delete from (\S+) where id\s?=\s?(\d+)/i
+		show_keys = /show keys (\S+)/i
+		find = /find (\S+) in (\S+)/i
+		save = /save (\S+) to (\S+) with (.*)/i
+		delete = /delete (\S+) in (\S+)/i
+    clear = /clear (\S+)/i
 
+    prompt = TTY::Prompt.new interrupt: :exit
+    client = CacheDriverClient.new
 
-		# forbidden stdout info in CacheRecord
-		cache_out = StringIO.new
-		$stdout = cache_out
+    unless CacheDriver.configed?
+      prompt.erro "CacheDriver configure not found, setup config in environments first"
+      exit 1
+    end
 
 		while true
-			$stdout.truncate 0
-			STDOUT.print "CacheDriver > "
-			cmd = STDIN.gets
-			cmd.chomp!
-
-			if cmd == ""
-				next
-			elsif cmd == "exit"
-				break
-			end
-
-			if cmd =~ show_models
-				dir = Dir.new File.expand_path("../../../tmp/cache", __FILE__)
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts "models: "
-				STDOUT.puts "-------------------------------"
-				dir.each do |file|
-					if file =~ /.+s/i
-						STDOUT.puts file[0..-2]
-					end
-				end
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts ""
-			elsif cmd =~ desc_model
-				res = cmd.match desc_model
-				clazz = CacheUtil.type_to_class res[1].downcase.to_sym
-				ins = clazz.find_all.first
-				unless ins
-					STDOUT.puts "error: can not find model #{res[1]}"
-					next
-				end
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts "attributes: "
-				STDOUT.puts "-------------------------------"
-				ins.instance_variables.each do |var|
-					STDOUT.puts var
-				end
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts ""
-			elsif cmd =~ select
-				res = cmd.match select
-				clazz = CacheUtil.type_to_class res[1].downcase.to_sym
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts "#{clazz} records: "
-				STDOUT.puts "-------------------------------"
-				if res[2]        # where id = x
-					ins = clazz.find_by_id res[3].to_i
-					if ins
-						STDOUT.print "{"
-						ins.instance_variables.each_with_index do |var, index|
-							STDOUT.print "#{var} => #{ins.instance_variable_get var}#{index == ins.instance_variables.count ? "" : ", "}"
-						end
-						STDOUT.print "}\n"
-						STDOUT.puts "-------------------------------"
-						STDOUT.puts "1 records"
-					else
-						STDOUT.puts "0 records"
-					end
-				else    # no where
-					all_ins = clazz.find_all
-					all_ins.each do |ins|
-						STDOUT.print "{"
-						ins.instance_variables.each_with_index do |var, index|
-							STDOUT.print "#{var} => #{ins.instance_variable_get var}#{index == ins.instance_variables.count-1 ? "" : ", "}"
-						end
-						STDOUT.print "}\n"
-					end
-					STDOUT.puts "-------------------------------"
-					STDOUT.puts "#{all_ins.count} records"
-				end
-				STDOUT.puts ""
-			elsif cmd =~ insert
-				res = cmd.match insert
-				clazz = CacheUtil.type_to_class res[1].downcase.to_sym
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts "insert #{clazz} record: "
-				STDOUT.puts "-------------------------------"
-				ins = clazz.new
-				res[2].split(',').each do |assign|
-					ele = assign.match /(\S+)\s?=\s?(\S+)/i
-					ins.send "#{ele[1]}=", ele[2]
-				end
-				ins.save!
-				STDOUT.puts "inserted record"
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts ""
-			elsif cmd =~ delete
-				res = cmd.match delete
-				clazz = CacheUtil.type_to_class res[1].downcase.to_sym
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts "delete #{clazz} record: "
-				STDOUT.puts "-------------------------------"
-				ins = clazz.find_by_id res[2].to_i
-				ins.destroy
-				STDOUT.puts "deleted record"
-				STDOUT.puts "-------------------------------"
-				STDOUT.puts ""
-			else
-				STDOUT.puts "error: unknow command '#{cmd}'"
-			end
-		end
+      begin
+        cmd = prompt.ask "CacheDriver >", active_color: :cyan do |q|
+          q.modify :down, :trim
+          q.convert -> (input) do
+            if input =~ quit
+              {action: :exit}
+            elsif input =~ help
+              {action: :help}
+            elsif input =~ show_models
+              {action: :show_models}
+            elsif input =~ show_keys
+              res = input.match show_keys
+              {action: :show_keys, model: res[1].downcase}
+            elsif input =~ find
+              res = input.match find
+              {action: :find, model: res[1].downcase, key: res[2]}
+            elsif input =~ save
+              res = input.match save
+              assignments = JSON.parse "{#{res[3].gsub("'", "\"").gsub(/([^,=\s]+)\s?=\s?/, '"\1"=').gsub('=', ':')}}"
+              {action: :save, model: res[1].downcase, key: res[2], assignments: assignments}
+            elsif input =~ delete
+              res = input.match delete
+              {action: :delete, model: res[1].downcase, key: res[2]}
+            elsif input =~ clear
+              res = input.match clear
+              {action: :clear, model: res[1].downcase}
+            else
+              {action: :unknown}
+            end
+          end
+        end
+
+        next if cmd.nil?
+
+        case cmd[:action]
+        when :exit
+          prompt.say "Bye!".green.bold
+          exit
+        when :help
+          prompt.say "Commands:                                                                                       \r".on_green.bold
+          prompt.say "'?'                                            | show all commands and descriptions\n"
+          prompt.say "show models                                    | list all models\n"
+          prompt.say "show keys <model>                              | list all keys of model in cache\n"
+          prompt.say "find <model> in <key>                          | fetch data of model\n"
+          prompt.say "save <model> to <key> withs <attr1>=<val1>,... | update data of model, create one if not existed\n"
+          prompt.say "delete <model> in <key>                        | delete data of model\n"
+          prompt.say "clear <model>                                  | delete data of model\n"
+          prompt.say "------------------------------------------------------------------------------------------------\r"
+        when :show_models
+          prompt.say "Models:                                       \r".on_green.bold
+          client.show_models.each do |model|
+            prompt.say model
+          end
+          prompt.say "----------------------------------------------\r"
+        when :show_keys
+          prompt.say "Keys of #{cmd[:model]}:                                  \r".on_green.bold
+          client.show_keys(cmd[:model]).each do |key|
+            prompt.say key
+          end
+          prompt.say "-----------------------------------------------\r"
+        when :find
+          prompt.say "Cache of #{cmd[:model]}##{cmd[:key]}:                               \r".on_green.bold
+          res = client.find cmd[:model], cmd[:key]
+          if res && res.count >= 2
+            prompt.say "Last Modified Time: #{res[0]}".yellow
+            res[1].each do |key, val|
+              prompt.say "@#{key} => #{val.inspect}"
+            end
+          else
+            prompt.error "no records found"
+          end
+          prompt.say "-----------------------------------------------\r"
+        when :save
+          res = client.save cmd[:model], cmd[:key], cmd[:assignments]
+          if res
+            prompt.ok "save #{cmd[:model]}##{cmd[:key]} successed"
+          else
+            prompt.error "save #{cmd[:model]}##{cmd[:key]} failed"
+          end
+        when :delete
+          res = client.delete cmd[:model], cmd[:key]
+          if res
+            prompt.ok "delete #{cmd[:model]}##{cmd[:key]} successed"
+          else
+            prompt.error "delete #{cmd[:model]}##{cmd[:key]} failed"
+          end
+        when :clear
+          res = client.clear cmd[:model]
+          prompt.say "#{cmd[:model]}#(#{res.map { |k, v| v ? k.green : k.red}.join(',')}) was deleted"
+        else
+          prompt.error "error: unknow command"
+          next
+        end
+        prompt.say "\r"
+      rescue => e
+        prompt.error "error: #{e.message}"
+      end
+    end
 
 
 	end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: cache_driver
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.9
 platform: ruby
 authors:
 - goshan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: make rails model act as ActiveRecord, but not save data into database
   but cache system, file or redis
 email:
@@ -85,17 +113,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: A cache adapter for model accepting file or redis