findable 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33cc41223d03de05c7983ae227f66bb4ee36d833
-  data.tar.gz: 2908c96f0a953f76a78d65bd9f12c8c0fb252c6a
+  metadata.gz: 0c5762db6fcb9200dd984f87ec167f1091ecfe26
+  data.tar.gz: 8c2386ee142b72c7bfd4814b45783f48a0a12367
 SHA512:
-  metadata.gz: b1260e9d9d210ef7ebfc40401c4d85b4cc7315407b76b53fc36e7dc73b34af976449a40222c428c96c52f7c2ecb5bd5ff10ebed629024dcb64be38fe1cb820f3
-  data.tar.gz: d1740da9cb2b9b14e2ed18b150814502d3c275c253cd2970d6db478a7d74944d25a3bc53a4c4b8cd8060843d046fcda5fea71655d80b0110bc6d77e29464b8af
+  metadata.gz: 107b796739e028571c553dee7aa04fb31d6ef6b374c38a1dd44c2225d7fbd735d124488a5c76d6b136007b729cb4808668c56a6ca4ef1fff81869d1782a9b2a2
+  data.tar.gz: f42800de1d903c60cb478b8c5981ddfebd27ec3d1542586f61f286bfb7d6ffbf6bbcd3fd459ba8793e8f385c1be56bda08b8e7c55823726058554667d7081695

data/README.md

@@ -1,15 +1,15 @@
 # Findable
 
 [![Gem Version](https://badge.fury.io/rb/findable.svg)](http://badge.fury.io/rb/findable)
-[![Build Status](https://travis-ci.org/i2bskn/findable.svg)](https://travis-ci.org/i2bskn/findable)
-[![Coverage Status](https://img.shields.io/coveralls/i2bskn/findable.svg)](https://coveralls.io/r/i2bskn/findable)
+[![Build Status](https://travis-ci.org/i2bskn/findable.svg?branch=master)](https://travis-ci.org/i2bskn/findable)
+[![Coverage Status](https://coveralls.io/repos/i2bskn/findable/badge.svg?branch=master)](https://coveralls.io/r/i2bskn/findable?branch=master)
 [![Code Climate](https://codeclimate.com/github/i2bskn/findable/badges/gpa.svg)](https://codeclimate.com/github/i2bskn/findable)
 
 Redis wrapper with API like ActiveRecord.
 
 ## Requirements
 
-- Redis
+- Redis 2.8 or later
 
 ## Installation
 
@@ -64,7 +64,7 @@ end
 Execute seed script if you create seed files.
 
 ```
-$ rake findable:seeds
+$ rake findable:seed
 ```
 
 Manipulate data with API like ActiveRecord.
@@ -72,13 +72,13 @@ Manipulate data with API like ActiveRecord.
 ```
 $ rails console
 pry(main)> Tag.find(1)
-=> #<Tag:0x00000108068430 @_attributes={:id=>1, :name=>"Ruby"}>
+=> #<Tag id: 1, name: "Ruby">
 pry(main)> golang = Tag.create(name: "Go")
-=> #<Tag:0x00000107ff6420 @_attributes={:name=>"Go", :id=>2}>
+=> #<Tag id: 2, name: "Go">
 pry(main)> Tag.all.each {|tag| p tag.name }
 "Ruby"
 "Go"
-=> [#<Tag:0x00000107f49568 @_attributes={:id=>1, :name=>"Ruby"}>, #<Tag:0x00000107f492e8 @_attributes={:name=>"Go", :id=>2}>]
+=> [#<Tag id: 1, name: "Ruby">, #<Tag id: 2, name: "Go">]
 ```
 
 ## Associations

data/Rakefile

@@ -7,8 +7,3 @@ desc "Run all specs"
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
-
-desc "Console with library"
-task :console do
-  sh "pry -I lib -r bundler/setup -r findable"
-end

data/findable.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport"
   spec.add_dependency "activemodel"
   spec.add_dependency "redis"
-  spec.add_dependency "oj"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/findable.rb

@@ -1,8 +1,9 @@
+require "json"
+
 require "active_support"
 require "active_support/core_ext"
 require "active_model"
 require "redis"
-require "oj"
 
 require "findable/version"
 require "findable/errors"

data/lib/findable/base.rb

@@ -5,7 +5,6 @@ module Findable
   class Base
     include ActiveModel::Model
     include ActiveModel::AttributeMethods
-
     include Associations
     include Inspection
 
@@ -18,13 +17,15 @@ module Findable
       def define_field(attr)
         unless public_method_defined?(attr)
           define_attribute_methods attr
-          define_method(attr) { attributes[attr.to_sym] }
+          define_method(attr) { attributes[attr] }
           column_names << attr.to_sym
         end
       end
 
       ## ActiveRecord like APIs
 
+      delegate :all, to: :query
+
       def primary_key
         "id"
       end
@@ -33,13 +34,9 @@ module Findable
         @_column_names ||= [:id]
       end
 
-      def all
-        data.map {|val| new(val) }
-      end
-
       def find(ids)
-        if values = find_by_ids(ids).compact.presence
-          ids.is_a?(Array) ? values.map {|val| new(val) } : new(values.first)
+        if records = find_by_ids(ids).presence
+          ids.is_a?(Array) ? records : records.first
         else
           raise RecordNotFound.new(self, id: ids)
         end
@@ -49,25 +46,22 @@ module Findable
         if conditions.is_a?(Hash)
           conditions.symbolize_keys!
           if id = conditions.delete(:id)
-            values = find_by_ids(id).compact
+            records = find_by_ids(id)
             case
-            when values.empty? then nil
-            when conditions.empty? then new(values.first)
+            when records.empty? then nil
+            when conditions.empty? then records.first
             else
-              value = values.detect {|val|
-                record = new(val)
+              records.detect {|record|
                 conditions.all? {|k, v| record.public_send(k) == v }
               }
-              value ? new(value) : nil
             end
           else
-            all.detect {|r|
-              conditions.all? {|k, v| r.public_send(k) == v }
+            all.detect {|record|
+              conditions.all? {|k, v| record.public_send(k) == v }
             }
           end
         else
-          values = find_by_ids(conditions).compact
-          values.empty? ? nil : new(values.first)
+          find_by_ids(conditions).first
         end
       end
 
@@ -76,19 +70,19 @@ module Findable
       end
 
       def where(conditions)
+        conditions.symbolize_keys!
         if id = conditions.delete(:id)
-          values = find_by_ids(id).compact
+          records = find_by_ids(id)
           if conditions.empty?
-            values.map {|val| new(val) }
+            records
           else
-            values.map {|val|
-              record = new(val)
-              conditions.all? {|k, v| record.public_send(k) == v } ? record : nil
-            }.compact
+            records.select {|record|
+              conditions.all? {|k, v| record.public_send(k) == v }
+            }
           end
         else
-          all.select {|r|
-            conditions.all? {|k, v| r.public_send(k) == v }
+          all.select {|record|
+            conditions.all? {|k, v| record.public_send(k) == v }
           }
         end
       end
@@ -102,14 +96,13 @@ module Findable
 
       [:first, :last].each do |m|
         define_method(m) do
-          value = self.data.public_send(m)
-          value ? new(value) : nil
+          self.all.public_send(m)
         end
       end
 
       ## Query APIs
 
-      delegate :find_by_ids, :data, to: :query
+      delegate :find_by_ids, :insert, to: :query
       delegate :count, :ids, :delete_all, to: :query
       alias_method :destroy_all, :delete_all
 
@@ -121,10 +114,6 @@ module Findable
         end
       end
 
-      def insert(obj)
-        query.insert(obj.attributes)
-      end
-
       def delete(obj)
         if _id = id_from(obj)
           query.delete(_id)
@@ -142,8 +131,7 @@ module Findable
     end
 
     def initialize(params = {})
-      params = Oj.load(params) if params.is_a?(String)
-      params.symbolize_keys!
+      params = params.with_indifferent_access
       params.keys.each {|attr| self.class.define_field(attr) }
       @_attributes = params
     end
@@ -169,8 +157,7 @@ module Findable
     end
 
     def save
-      @_attributes = self.class.insert(self)
-      self
+      self.class.insert(self)
     end
     alias_method :save!, :save
 
@@ -180,16 +167,15 @@ module Findable
     alias_method :destroy, :delete
 
     def attributes
-      @_attributes ||= {}
+      @_attributes ||= ActiveSupport::HashWithIndifferentAccess.new
     end
 
-    private
-      def attribute=(attr, value)
-        attributes[attr.to_sym] = value
-      end
+    def attribute=(attr, value)
+      attributes[attr.to_sym] = value
+    end
 
-      def attribute?(attr)
-        attributes[attr.to_sym].present?
-      end
+    def attribute?(attr)
+      attributes[attr.to_sym].present?
+    end
   end
 end

data/lib/findable/configuration.rb

@@ -2,6 +2,7 @@ module Findable
   class Configuration
     VALID_OPTIONS = [
       :redis_options,
+      :serializer,
       :seed_dir,
       :seed_file,
     ].freeze
@@ -27,6 +28,7 @@ module Findable
 
     def reset
       self.redis_options = nil
+      self.serializer = JSON
       self.seed_dir = defined?(Rails) ? Rails.root.join("db", "findable_seeds") : nil
       self.seed_file = defined?(Rails) ? Rails.root.join("db", "findable_seeds.rb") : nil
     end

data/lib/findable/inspection.rb

@@ -4,7 +4,12 @@ module Findable
 
     module ClassMethods
       def inspect
-        "#{self}(#{column_names.map(&:inspect).join(', ')})"
+        case
+        when self == Findable::Base
+          super
+        else
+          "#{self}(#{column_names.map(&:inspect).join(', ')})"
+        end
       end
     end
 

data/lib/findable/query.rb

@@ -1,14 +1,22 @@
 require "findable/query/connection"
 require "findable/query/namespace"
 require "findable/query/lock"
+require "findable/query/serializer"
 
 module Findable
   class Query
     include Connection
     include Namespace
 
-    def data
-      redis.hvals(data_key)
+    attr_reader :model
+
+    def initialize(model, serializer = nil)
+      @model = model
+      @serializer = serializer || Serializer.new
+    end
+
+    def all
+      @serializer.deserialize(redis.hvals(data_key), model)
     end
 
     def ids
@@ -20,19 +28,23 @@ module Findable
     end
 
     def find_by_ids(ids)
-      redis.hmget(data_key, *Array(ids))
+      @serializer.deserialize(redis.hmget(data_key, *Array(ids)), model)
     end
 
     def exists?(id)
       redis.hexists(data_key, id)
     end
 
-    def insert(hash)
+    def insert(object)
       lock do
-        hash[:id] = auto_incremented_id(hash[:id])
-        redis.hset(data_key, hash[:id], Oj.dump(hash))
+        object.id = auto_incremented_id(object.id)
+        redis.hset(
+          data_key,
+          object.id,
+          @serializer.serialize(object.attributes)
+        )
       end
-      hash
+      object
     end
 
     def import(hashes)
@@ -40,14 +52,14 @@ module Findable
         auto_incremented = hashes.each_with_object([]) do |hash, obj|
           hash["id"] = auto_incremented_id(hash["id"])
           obj << hash["id"]
-          obj << Oj.dump(hash)
+          obj << @serializer.serialize(hash)
         end
         redis.hmset(data_key, *auto_incremented)
       end
     end
 
     def delete(id)
-      redis.hdel data_key, id
+      redis.hdel(data_key, id)
     end
 
     def delete_all

data/lib/findable/query/namespace.rb

@@ -5,12 +5,8 @@ module Findable
       KEY_NAMES = %i(info data lock index).freeze
       AUTO_INCREMENT_KEY = :auto_increment
 
-      def initialize(model)
-        @_model = model
-      end
-
-      KEY_NAMES.each do |key|
-        define_method([key, "key"].join("_")) { namespaces[key] }
+      KEY_NAMES.each do |name|
+        define_method([name, "key"].join("_")) { namespaces[name] }
       end
 
       def thread_key
@@ -19,7 +15,7 @@ module Findable
 
       private
         def basename
-          @_model.model_name.plural
+          model.model_name.plural
         end
 
         # @return [Hash] namespaces

data/lib/findable/query/serializer.rb

@@ -0,0 +1,26 @@
+module Findable
+  class Query
+    class Serializer
+      def initialize(serializer = nil)
+        @serializer = serializer || Findable.config.serializer
+      end
+
+      def serialize(object)
+        @serializer.dump(object)
+      end
+
+      # @params raw_data [String] Serialized string
+      # @params raw_data [Array<String>] Array of serialized string
+      # @return [ActiveSupport::HashWithIndifferentAccess]
+      # @return [Array<ActiveSupport::HashWithIndifferentAccess>]
+      def deserialize(raw_data, klass = nil)
+        objects = Array(raw_data).compact.map {|data|
+          object = @serializer.load(data)
+          object = object.with_indifferent_access if object.is_a?(Hash)
+          klass ? klass.new(object) : object
+        }
+        raw_data.is_a?(String) ? objects.first : objects
+      end
+    end
+  end
+end

data/lib/findable/version.rb

@@ -1,3 +1,3 @@
 module Findable
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/generators/findable/templates/findable.rb

@@ -1,7 +1,13 @@
 Findable.configure do |config|
-  # Redis connection setting. (default: `Redis.current`)
+  # Redis connection setting. Default is `Redis.current`.
   # config.redis_options = {host: "localhost", port: 6379, db: 2}
 
+  # Serializer setting. Default is JSON.
+  # It can be specify an object with the following methods.
+  #   * dump - To string from an object.
+  #   * load - To object from a string.
+  # config.serializer = Oj
+
   # Directory of stored seed files.
   config.seed_dir = Rails.root.join("db", "findable_seeds")
 

data/lib/tasks/findable.rake

@@ -1,6 +1,6 @@
 namespace :findable do
   desc "Load seed file of findable."
-  task :seeds => :environment do
+  task :seed => :environment do
     if Findable.config.seed_file
       load Findable.config.seed_file
     end

data/spec/findable/query/namespace_spec.rb

@@ -4,7 +4,7 @@ describe Findable::Query::Namespace do
   include_context "TemporaryModel"
 
   before do
-    QueryEx = Class.new
+    QueryEx = Struct.new(:model)
     QueryEx.include Findable::Query::Namespace
   end
 
@@ -22,10 +22,6 @@ describe Findable::Query::Namespace do
     }
   end
 
-  describe "#initialize" do
-    it { expect(query.instance_eval { @_model }).to eq(model) }
-  end
-
   describe "#thread_key" do
     it { expect(query.thread_key).to be_kind_of(String) }
     it { expect(query.thread_key).to start_with(namespace::PREFIX) }

data/spec/findable/query_spec.rb

@@ -7,8 +7,8 @@ describe Findable::Query do
   let(:auto_increment_key) { Findable::Query::Namespace::AUTO_INCREMENT_KEY }
 
   describe "#data" do
-    it { expect(read_model.query.data).to be_kind_of(Array) }
-    it { expect(read_model.query.data.size).to eq(1) }
+    it { expect(read_model.query.all).to be_kind_of(Array) }
+    it { expect(read_model.query.all.size).to eq(1) }
   end
 
   describe "#ids" do
@@ -21,12 +21,11 @@ describe Findable::Query do
   end
 
   describe "#find_by_ids" do
-    let(:raw_value) { read_model.query.find_by_ids(1) }
-    let(:loaded_value) { Oj.load(raw_value.first) }
+    let(:data) { read_model.query.find_by_ids(1) }
 
-    it { expect(raw_value).to be_kind_of(Array) }
-    it { expect(raw_value.first).to be_kind_of(String) }
-    it { expect(loaded_value[:id]).to eq(1) }
+    it { expect(data).to be_kind_of(Array) }
+    it { expect(data.first).to be_kind_of(read_model) }
+    it { expect(data.first.id).to eq(1) }
   end
 
   describe "#exists?" do
@@ -35,12 +34,12 @@ describe Findable::Query do
   end
 
   describe "#insert" do
-    it { expect(model.query.insert(name: name)).to be_kind_of(Hash) }
-    it { expect(model.query.insert(name: name)[:id]).not_to be_nil }
-    it { expect(model.query.insert(name: name)[:name]).to eq(name) }
+    it { expect(model.create(name: name)).to be_kind_of(model) }
+    it { expect(model.create(name: name).id).not_to be_nil }
+    it { expect(model.create(name: name).name).to eq(name) }
     it {
       expect {
-        model.query.insert(name: name)
+        model.create(name: name)
       }.to change { model.query.count }.by(1)
     }
   end
@@ -49,18 +48,18 @@ describe Findable::Query do
   end
 
   describe "#delete" do
-    let!(:params) { model.query.insert(name: name) }
+    let!(:persisted_object) { model.create(name: name) }
 
     it {
       expect {
-        model.query.delete(params[:id])
+        model.query.delete(persisted_object.id)
       }.to change { model.query.count }.by(-1)
     }
   end
 
   describe "#delete_all" do
     before {
-      model.query.insert(name: name)
+      model.create(name: name)
       model.query.delete_all
     }
 

data/spec/spec_helper.rb

@@ -10,7 +10,6 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 SimpleCov.start do
   add_filter "spec"
   add_filter ".bundle"
-  add_filter "example"
 end
 
 require "bundler/setup"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: findable
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +192,7 @@ files:
 - lib/findable/query/connection.rb
 - lib/findable/query/lock.rb
 - lib/findable/query/namespace.rb
+- lib/findable/query/serializer.rb
 - lib/findable/railtie.rb
 - lib/findable/seed.rb
 - lib/findable/version.rb