findable 0.0.1 → 0.0.2

checksums.yaml

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

data/.coveralls.yml

@@ -0,0 +1,2 @@
+repo_token: fbWiPxpNWcR8fOyueZ7IWw1pMbl20ZvRN
+

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0
+branches:
+  only:
+    - master
+gemfile:
+  - Gemfile
+script: bundle exec rake spec
+notifications:
+  mails:
+    - i2bskn@gmail.com
+

data/README.md

@@ -1,26 +1,45 @@
 # Findable
 
-TODO: Write a gem description
+[![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)
+[![Code Climate](https://codeclimate.com/github/i2bskn/findable/badges/gpa.svg)](https://codeclimate.com/github/i2bskn/findable)
+
+Redis wrapper with API like ActiveRecord. (While creating...)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'findable'
+gem "findable"
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install findable
-
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+class Company < ActiveRecord::Base
+  has_many :person
+end
+
+class Person < Findable::Base
+  fields :name, :email, :gender, :company_id
+  belongs_to :company
+end
+
+person = Person.new(name: "Ken Iiboshi", gender: "male")
+person.email = "i2bskn@example.com"
+person.save
+
+people = Person.where(gender: "male")
+people.each do |person|
+  puts person.name
+end
+```
 
 ## Contributing
 

data/findable.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Redis wrapper with API like ActiveRecord.}
+  spec.description   = %q{Redis wrapper with API like ActiveRecord.}
   spec.homepage      = "https://github.com/i2bskn/findable"
   spec.license       = "MIT"
 
@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   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 "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"

data/lib/findable.rb

@@ -7,6 +7,7 @@ require "findable/version"
 require "findable/errors"
 require "findable/configuration"
 require "findable/serializer"
+require "findable/association"
 require "findable/base"
 require "findable/railtie" if defined?(Rails)
 

data/lib/findable/association.rb

@@ -0,0 +1,71 @@
+module Findable
+  module Association
+    def has_many(name, scope = nil, options = {})
+      super unless _define_association_methods(:has_many, name, options)
+    end
+
+    def has_one(name, scope = nil, options = {})
+      super unless _define_association_methods(:has_one, name, options)
+    end
+
+    def belongs_to(name, scope = nil, options = {})
+      super unless _define_association_methods(:belongs_to, name, options)
+    end
+
+    private
+      def _define_association_methods(association_type, name, options)
+        model = _model_for(name, options, true)
+        if _findable?(model) || _findable?(self)
+          self.send("_define_findable_#{association_type}", name, options, model)
+        else
+          false
+        end
+      end
+
+      def _model_for(name, options, _raise = false)
+        class_name = _class_name_for(name, options)
+        begin
+          class_name.constantize
+        rescue => e
+          _raise ? (raise Findable::ModelNotFound.new(class_name)) : nil
+        end
+      end
+
+      def _class_name_for(name, options)
+        options[:class].presence || name.to_s.classify
+      end
+
+      def _foreign_key_for(name, options)
+        options[:foreign_key].presence || name.to_s.foreign_key
+      end
+
+      def _findable?(model)
+        model.ancestors.include?(Findable::Base)
+      end
+
+      def _define_findable_has_many(name, options, model)
+        foreign_key = _foreign_key_for(self.model_name.name, options)
+
+        define_method name do
+          model.where(foreign_key.to_sym => id)
+        end
+      end
+
+      def _define_findable_has_one(name, options, model)
+        foreign_key = _foreign_key_for(self.model_name.name, options)
+
+        define_method name do
+          model.find_by(foreign_key.to_sym => id)
+        end
+      end
+
+      def _define_findable_belongs_to(name, options, model)
+        foreign_key = _foreign_key_for(name, options)
+
+        define_method name do
+          model.find(self.send(foreign_key))
+        end
+      end
+  end
+end
+

data/lib/findable/association/reflector.rb

@@ -0,0 +1,5 @@
+module Findable
+  module Association
+  end
+end
+

data/lib/findable/errors.rb

@@ -1,5 +1,11 @@
 module Findable
   class FindableError < StandardError; end
   class RecordNotFound < FindableError; end
+
+  class ModelNotFound < FindableError
+    def initialize(model_name)
+      super("#{model_name} not found!")
+    end
+  end
 end
 

data/lib/findable/railtie.rb

@@ -1,5 +1,11 @@
 module Findable
   class Railtie < ::Rails::Railtie
+    initializer "findable" do
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Base.send(:extend, Findable::Association)
+      end
+    end
+
     rake_tasks do
       load "tasks/findable.rake"
     end

data/lib/findable/seed.rb

@@ -0,0 +1,61 @@
+module Findable
+  class Seed
+    attr_reader :full_path, :namespaced, :ext
+
+    def initialize(path, seed_dir)
+      @_seed_dir = seed_dir
+      self.full_path = path
+    end
+
+    def full_path=(path)
+      @full_path = path
+      _path = path.gsub(@_seed_dir, "")
+      @namespaced = /^\// =~ _path ? _path.from(1) : _path
+      @ext = @namespaced[/^.*(?<ext>\.[^\.]+)$/, :ext] || (raise ArgumentError)
+    end
+
+    def base_name
+      @_base ||= @namespaced.sub(@ext, "")
+    end
+
+    def model
+      base_name.split("/").reverse.map.with_index {|n,i|
+        i.zero? ? n.singularize : n
+      }.reverse.map(&:camelize).join("::").constantize
+    end
+
+    def load_file
+      case @ext
+      when ".yml"
+        YAML.load_file(@full_path).values
+      else
+        raise UnexpectedFormat
+      end
+    end
+
+    def bootstrap!
+      model.transaction do
+        model.delete_all
+        records = load_file.map {|data| model.new(data) }
+        model.import records
+      end
+    end
+
+    class << self
+      def target_files(seed_dir, tables = nil)
+        Dir.glob(patterns(seed_dir)).map {|full_path|
+          Seed.new(full_path, seed_dir)
+        }.select {|seed|
+          tables ? tables.include?(seed.base_name) : true
+        }
+      end
+
+      def patterns(seed_dir)
+        %w(yml).map {|format|
+          Rails.root.join("#{seed_dir}/**/*.#{format}").to_s
+        }
+      end
+    end
+  end
+end
+

data/lib/findable/version.rb

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

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

@@ -1,2 +1,17 @@
 # Seed file of Findable
 
+# Require seed support module
+require "findable/seed"
+
+# Path to the reading of the seed.
+seed_dir = File.expand_path("../findable_seeds", __FILE__)
+
+# Target seed files.
+# Run all in the case of `nil`.
+# Example of if you want to run some only.
+# seed_files = ["products", "customers"] #=> Only products.yml and customers.yml
+seed_files = nil
+
+# Execute
+Findable::Seed.target_files(seed_dir, seed_files).each {|seed| seed.bootstrap! }
+

data/spec/findable/configuration_spec.rb

@@ -1,8 +1,8 @@
 require "spec_helper"
 
 describe Findable::Configuration do
-  let(:storage) { :memory }
   let(:redis) { {host: "localhost", port: 6379, db: 15} }
+  let(:seeds) { "/path/to/seeds.rb" }
 
   describe "#initialize" do
     subject { Findable.config  }
@@ -13,21 +13,21 @@ describe Findable::Configuration do
     end
 
     # default settings
-    it { is_expected.to have_attributes(default_storage: :redis) }
     it { is_expected.to have_attributes(redis_options: nil) }
+    it { is_expected.to have_attributes(seed_file: nil) }
   end
 
   describe "#merge" do
-    subject { Findable.config.merge(default_storage: storage) }
+    subject { Findable.config.merge(seed_file: seeds) }
 
-    it { is_expected.to have_attributes(default_storage: storage) }
+    it { is_expected.to have_attributes(seed_file: seeds) }
     it { is_expected.to be_kind_of(Findable::Configuration) }
   end
 
   describe "#merge!" do
-    subject { Findable.config.merge!(default_storage: storage) }
+    subject { Findable.config.merge!(seed_file: seeds) }
 
-    it { is_expected.to have_attributes(default_storage: storage) }
+    it { is_expected.to have_attributes(seed_file: seeds) }
     it { is_expected.to be_kind_of(Findable::Configuration) }
   end
 
@@ -42,14 +42,14 @@ describe Findable::Configuration do
     describe "#configure" do
       before do
         Findable.configure do |config|
-          config.default_storage = storage
           config.redis_options = redis
+          config.seed_file = seeds
         end
       end
 
       subject { Findable.config }
 
-      it { is_expected.to have_attributes(default_storage: storage) }
+      it { is_expected.to have_attributes(seed_file: seeds) }
       it { is_expected.to have_attributes(redis_options: redis) }
 
       it {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: findable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,30 +70,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -136,20 +136,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Static model to behave like ActiveRecord.
+description: Redis wrapper with API like ActiveRecord.
 email:
 - i2bskn@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - findable.gemspec
 - lib/findable.rb
+- lib/findable/association.rb
+- lib/findable/association/reflector.rb
 - lib/findable/base.rb
 - lib/findable/configuration.rb
 - lib/findable/connection.rb
@@ -157,6 +161,7 @@ files:
 - lib/findable/namespace.rb
 - lib/findable/railtie.rb
 - lib/findable/recordable.rb
+- lib/findable/seed.rb
 - lib/findable/serializer.rb
 - lib/findable/version.rb
 - lib/generators/findable/install_generator.rb
@@ -191,7 +196,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Static model to behave like ActiveRecord.
+summary: Redis wrapper with API like ActiveRecord.
 test_files:
 - spec/findable/.keep
 - spec/findable/base_spec.rb