findable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd0c4843a980a02496e5e1b55e9466bd8755e968
+  data.tar.gz: e29742dc9478c09cccc03f868632b87abb367f66
+SHA512:
+  metadata.gz: 36948d3d3c45ff724706eeda3a35a368b83de3ebfe864c373b757ddadbae7467b4adce1ee2b55268ef2dd45b9f6db34d46a1472488ce4b5c3f40219f64deee11
+  data.tar.gz: 9d6d5d7e35b5cac170372ea0f549a82223aaec5cd33ffc02d74248766ca9ef5ecab66962255408e051ba7944a76489a9ede08d85015c4a5ec8451dfee8ebf548

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in findable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 i2bskn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Findable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'findable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install findable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/i2bskn/findable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+

data/findable.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'findable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "findable"
+  spec.version       = Findable::VERSION
+  spec.authors       = ["i2bskn"]
+  spec.email         = ["i2bskn@gmail.com"]
+  spec.summary       = %q{Static model to behave like ActiveRecord.}
+  spec.description   = %q{Static model to behave like ActiveRecord.}
+  spec.homepage      = "https://github.com/i2bskn/findable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel"
+  spec.add_dependency "redis"
+  spec.add_dependency "oj"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end
+

data/lib/findable.rb

@@ -0,0 +1,12 @@
+require "active_support"
+require "active_model"
+require "redis"
+require "oj"
+
+require "findable/version"
+require "findable/errors"
+require "findable/configuration"
+require "findable/serializer"
+require "findable/base"
+require "findable/railtie" if defined?(Rails)
+

data/lib/findable/base.rb

@@ -0,0 +1,134 @@
+require "findable/recordable"
+require "findable/connection"
+require "findable/namespace"
+
+module Findable
+  class Base
+    include ActiveModel::Model
+    include Recordable
+    include Connection
+    include Namespace
+
+    class << self
+      def primary_key
+        "id"
+      end
+
+      def column_names
+        raise NotImplementedError
+      end
+
+      def all
+        all_data.map {|data| new(data) }
+      end
+
+      def find(*ids)
+        ids = ids.first if ids.size == 1
+        values = find_by_id(ids)
+
+        case
+        when values.empty? then nil
+        when ids.is_a?(Array) then values.map {|val| new(val)}
+        else new(values.first)
+        end
+      end
+
+      def find_by(params)
+        params.symbolize_keys!
+        if id = params.delete(:id)
+          values = find_by_id(id)
+          return nil if values.empty?
+          return new(values.first) if params.empty?
+
+          values.each {|val|
+            record = new(val)
+            return record if params.all? {|k,v| record.send(k) == v }
+          }
+        else
+          all_data.each {|val|
+            record = new(val)
+            return record if params.all? {|k,v| record.send(k) == v }
+          }
+        end
+      end
+
+      def where(params)
+        all.select {|record| params.all? {|k,v| record.send(k) == v } }
+      end
+
+      def exists?(record)
+        if record.is_a?(self)
+          _id = record.id
+          return false unless _id
+        else
+          _id = record.to_i
+        end
+
+        redis.hexists data_key, _id
+      end
+
+      delegate :first, :last, to: :all
+
+      def count
+        redis.hlen(data_key)
+      end
+
+      def ids
+        redis.hkeys(data_key).map(&:to_i)
+      end
+
+      def create(attrs = {})
+        record = new(attrs)
+        record.save
+        record
+      end
+
+      def create!(attrs = {})
+        record = new(attrs)
+        record.save!
+        record
+      end
+
+      def delete_all
+        redis.del(data_key)
+      end
+      alias_method :destroy_all, :delete_all
+
+      def transaction(&block)
+        redis.multi &block
+      end
+
+      def import(records)
+        data = records.each_with_object([]) {|record, obj|
+          record.id ||= auto_incremented_id
+          obj << record.id
+          obj << record.to_json
+        }
+        redis.hmset(data_key, *data)
+      end
+
+      def insert(record)
+        record.id ||= auto_incremented_id
+        redis.hset(data_key, record.id, record.to_json)
+      end
+
+      def delete(id)
+        redis.hdel(data_key, id)
+      end
+
+      private
+        def auto_incremented_id
+          redis.hincrby(info_key, :auto_inclement, 1)
+        end
+
+        def all_data
+          redis.hvals(data_key)
+        end
+
+        def find_by_id(id)
+          redis.hmget(data_key, *Array(id)).compact
+        end
+    end
+  end
+end
+

data/lib/findable/configuration.rb

@@ -0,0 +1,46 @@
+module Findable
+  class Configuration
+    VALID_OPTIONS = [
+      :redis_options,
+      :seed_file
+    ].freeze
+
+    attr_accessor *VALID_OPTIONS
+
+    def initialize
+      reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def merge(params)
+      self.dup.merge!(params)
+    end
+
+    def merge!(params)
+      params.keys.each {|key| self.send("#{key}=", params[key]) }
+      self
+    end
+
+    def reset
+      self.redis_options = nil
+      self.seed_file = defined?(Rails) ? Rails.root.join("db", "findable_seeds.rb") : nil
+    end
+
+    module Accessible
+      def configure(options = {}, &block)
+        config.merge!(options) unless options.empty?
+        config.configure(&block) if block_given?
+      end
+
+      def config
+        @_config ||= Configuration.new
+      end
+    end
+  end
+
+  extend Configuration::Accessible
+end
+

data/lib/findable/connection.rb

@@ -0,0 +1,25 @@
+module Findable
+  module Connection
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def redis
+        @_redis ||= generate_redis_connection!
+      end
+
+      private
+        def generate_redis_connection!
+          redis_options ? Redis.new(*redis_options) : Redis.current
+        end
+
+        def redis_options
+          Findable.config.redis_options.presence
+        end
+    end
+
+    def redis
+      self.class.redis
+    end
+  end
+end
+

data/lib/findable/errors.rb

@@ -0,0 +1,5 @@
+module Findable
+  class FindableError < StandardError; end
+  class RecordNotFound < FindableError; end
+end
+

data/lib/findable/namespace.rb

@@ -0,0 +1,23 @@
+module Findable
+  module Namespace
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def info_key
+        namespace[:info]
+      end
+
+      def data_key
+        namespace[:data]
+      end
+
+      private
+        def namespace
+          %i(info data).each_with_object({}) do |name, obj|
+            obj[name] = [self.model_name.plural, name].join(":")
+          end
+        end
+    end
+  end
+end
+

data/lib/findable/railtie.rb

@@ -0,0 +1,8 @@
+module Findable
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load "tasks/findable.rake"
+    end
+  end
+end
+

data/lib/findable/recordable.rb

@@ -0,0 +1,93 @@
+module Findable
+  module Recordable
+    extend ActiveSupport::Concern
+    include Serializer
+
+    included do
+      include ActiveModel::AttributeMethods
+
+      attribute_method_suffix "="
+      attribute_method_suffix "?"
+    end
+
+    module ClassMethods
+      def field(attr, options={})
+        options.symbolize_keys!
+        define_accessor(attr.to_sym, options)
+      end
+
+      def fields(*args)
+        options = args.extract_options!
+        args.each {|arg| field(arg, options) }
+      end
+
+      private
+        def define_accessor(attr, options)
+          unless public_method_defined?(attr)
+            define_attribute_methods attr
+            define_method attr do
+              attributes[attr]
+            end
+          end
+        end
+    end
+
+    def initialize(params={})
+      params = deserialize(params) if params.is_a?(String)
+      params.symbolize_keys!
+      params.keys.each {|attr| self.class.field(attr) }
+      @_attributes = params
+    end
+
+    def id
+      attributes[:id].presence || nil
+    end
+    # alias_method :quoted_id, :id
+
+    def id=(_id)
+      attributes[:id] = _id
+    end
+
+    def save
+      self.class.insert(self)
+    end
+    alias_method :save!, :save
+
+    def delete
+      self.class.delete(id)
+    end
+    alias_method :destroy, :delete
+
+    def new_record?
+      id ? !self.class.exists?(self) : true
+    end
+
+    def persisted?
+      !new_record?
+    end
+
+    def to_json(methods: nil)
+      _attrs = attributes.dup
+      _attrs.merge!(methods.to_sym => self.send(methods)) if methods
+      serialize(_attrs)
+    end
+
+    def hash
+      id.hash
+    end
+
+    def attributes
+      @_attributes ||= {}
+    end
+
+    private
+      def attribute=(attr, val)
+        attributes[attr.to_sym] = val
+      end
+
+      def attribute?(attr)
+        attributes[attr.to_sym].present?
+      end
+  end
+end
+

data/lib/findable/serializer.rb

@@ -0,0 +1,12 @@
+module Findable
+  module Serializer
+    def serialize(string)
+      Oj.dump(string)
+    end
+
+    def deserialize(string)
+      Oj.load(string)
+    end
+  end
+end
+

data/lib/findable/version.rb

@@ -0,0 +1,3 @@
+module Findable
+  VERSION = "0.0.1"
+end

data/lib/generators/findable/install_generator.rb

@@ -0,0 +1,14 @@
+module Findable
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), "templates"))
+
+      desc "Install Findable files"
+      def install_findable_files
+        template "seeds.rb", "db/findable_seeds.rb"
+        template "findable.rb", "config/initializers/findable.rb"
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,8 @@
+Findable.configure do |config|
+  # Redis connection setting. (default: `Redis.current`)
+  # config.redis_options = {host: "localhost", port: 6379, db: 2}
+
+  # Seed file of Findable
+  # config.seed_file = Rails.root.join("db", "findable_seeds.rb")
+end
+

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

@@ -0,0 +1,2 @@
+# Seed file of Findable
+

data/lib/tasks/findable.rake

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

data/spec/findable/base_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe Findable::Base do
+end
+

data/spec/findable/configuration_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+describe Findable::Configuration do
+  let(:storage) { :memory }
+  let(:redis) { {host: "localhost", port: 6379, db: 15} }
+
+  describe "#initialize" do
+    subject { Findable.config  }
+
+    # defined options
+    Findable::Configuration::VALID_OPTIONS.each do |key|
+      it { is_expected.to respond_to(key) }
+    end
+
+    # default settings
+    it { is_expected.to have_attributes(default_storage: :redis) }
+    it { is_expected.to have_attributes(redis_options: nil) }
+  end
+
+  describe "#merge" do
+    subject { Findable.config.merge(default_storage: storage) }
+
+    it { is_expected.to have_attributes(default_storage: storage) }
+    it { is_expected.to be_kind_of(Findable::Configuration) }
+  end
+
+  describe "#merge!" do
+    subject { Findable.config.merge!(default_storage: storage) }
+
+    it { is_expected.to have_attributes(default_storage: storage) }
+    it { is_expected.to be_kind_of(Findable::Configuration) }
+  end
+
+  describe "Accessible" do
+    context "extended" do
+      subject { Module.new { extend Findable::Configuration::Accessible } }
+
+      it { is_expected.to respond_to(:configure) }
+      it { is_expected.to respond_to(:config) }
+    end
+
+    describe "#configure" do
+      before do
+        Findable.configure do |config|
+          config.default_storage = storage
+          config.redis_options = redis
+        end
+      end
+
+      subject { Findable.config }
+
+      it { is_expected.to have_attributes(default_storage: storage) }
+      it { is_expected.to have_attributes(redis_options: redis) }
+
+      it {
+        expect {
+          Findable.configure {|config| config.unknown = :value }
+        }.to raise_error
+      }
+    end
+
+    describe "#config" do
+      it { expect(Findable.config.is_a?(Findable::Configuration)).to be_truthy }
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "simplecov"
+require "coveralls"
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter "spec"
+  add_filter ".bundle"
+end
+
+require "findable"
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.after(:each) { Findable.config.reset }
+end
+

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: findable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- i2bskn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: activemodel
+  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: redis
+  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: 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Static model to behave like ActiveRecord.
+email:
+- i2bskn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- findable.gemspec
+- lib/findable.rb
+- lib/findable/base.rb
+- lib/findable/configuration.rb
+- lib/findable/connection.rb
+- lib/findable/errors.rb
+- lib/findable/namespace.rb
+- lib/findable/railtie.rb
+- lib/findable/recordable.rb
+- lib/findable/serializer.rb
+- lib/findable/version.rb
+- lib/generators/findable/install_generator.rb
+- lib/generators/findable/templates/findable.rb
+- lib/generators/findable/templates/seeds.rb
+- lib/tasks/findable.rake
+- spec/findable/.keep
+- spec/findable/base_spec.rb
+- spec/findable/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/support/.keep
+homepage: https://github.com/i2bskn/findable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Static model to behave like ActiveRecord.
+test_files:
+- spec/findable/.keep
+- spec/findable/base_spec.rb
+- spec/findable/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/support/.keep