belongs_to_remote 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06eb0cf18c4de2c9579aa36b2edccafd303cfe1f
+  data.tar.gz: 86d2d9cd17b7a595fe637984b3fd87ad2a47ddfb
+SHA512:
+  metadata.gz: 97f8b36f4f8694fafe927774084aa6e100a608868770f66116c362280546aa0c85f7c7d30113fb696e9b5223f0df44c1ba4cbb10198d03a9aa98b02ef72d601f
+  data.tar.gz: a8bd5a4a57cc7738a6de511f7a2fade2a154c6f6fe25bf5a3ccd33832dfe492398ae6e7e2609f51014cacfa4e6d7d3fea2c48cd97bfe40a26b0dc66dda5227c6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Avoyants
+
+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,42 @@
+# belongs_to_remote
+
+ActiveRecord belongs to ActiveResource association (e.g. `belongs_to_remote :user`).
+Supports options :class_name, :foreign_key, :polymorphic
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'belongs_to_remote'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install belongs_to_remote
+
+## Usage
+
+Can be used with any object
+
+```ruby
+class Product
+  include BelongsToRemote
+  attr_accessor :user_id, :depot_id, :booking_id, :owner_id, :owner_type
+
+  belongs_to_remote :user # defines method user => User.find(self.user_id)
+  belongs_to_remote :depot, class_name: "Store" # defines method depot => Store.find(self.depot_id)
+  belongs_to_remote :order, foreign_key: :booking_id # defines method order => Order.find(self.booking_id)
+  belongs_to_remote :owner, polymorphic: true # defines method owner, uses self.owner_type and self.owner_id
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/shhavel/belongs_to_remote/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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f documentation", "-r ./spec/spec_helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+task default: :spec

data/belongs_to_remote.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'belongs_to_remote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "belongs_to_remote"
+  spec.version       = BelongsToRemote::VERSION
+  spec.authors       = ["Alex Avoyants"]
+  spec.email         = ["shhavel@gmail.com"]
+  spec.summary       = %q{ActiveRecord belongs to ActiveResource association (e.g. belongs_to_remote :user).}
+  spec.description   = %q{ActiveRecord belongs to ActiveResource association (e.g. belongs_to_remote :user). Supports options :class_name, :foreign_key, :polymorphic}
+  spec.homepage      = ""
+  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", '~> 3.2'
+  spec.add_dependency "activerecord", '~> 3.2'
+  spec.add_dependency "activeresource", '~> 3.2'
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/belongs_to_remote/version.rb

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

data/lib/belongs_to_remote.rb

@@ -0,0 +1,54 @@
+require "belongs_to_remote/version"
+require "active_support/concern"
+require "active_record"
+require "active_resource"
+
+module BelongsToRemote
+  extend ActiveSupport::Concern
+
+    module ClassMethods
+    ##
+    # Defines private instance method for one-to-one association
+    # with ActiveResource::Base (or ActiveRecord::Base).
+    # Model should have the foreign key attribute (default is "#{name}_id").
+    # For polymorphic association model should also have foreign type attribute
+    # (default is "#{name}_type"), which contains class name of association model.
+    #
+    # Params:
+    #   - name {Symbol} of the association
+    #   - options {Hash}, :class_name, :foreign_key, :polymorphic
+    #
+    # Defined method returns nil if none is found.
+    #
+    def belongs_to_remote(name, options = {})
+      if options[:polymorphic]
+        class_eval %(
+          def #{name}
+            return nil unless self.#{name.to_s + "_type"} && self.#{options[:foreign_key] || name.to_s + "_id" }
+            @#{name} ||= self.#{name.to_s + "_type"}.constantize.find(self.#{options[:foreign_key] || name.to_s + "_id" }) rescue nil
+          end
+        )
+      else
+        class_eval %(
+          def #{name}
+            return nil unless self.#{options[:foreign_key] || name.to_s + "_id" }
+            @#{name} ||= #{options[:class_name] || name.to_s.classify}.find(self.#{options[:foreign_key] || name.to_s + "_id" }) rescue nil
+          end
+        )
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include BelongsToRemote
+end
+
+unless ActiveResource::Base.respond_to?(:belongs_to)
+  class ActiveResource::Base
+    include BelongsToRemote
+    class << self
+      alias_method :belongs_to, :belongs_to_remote
+    end
+  end
+end

data/spec/belongs_to_remote_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe BelongsToRemote do
+  subject { Product.new }
+
+  describe "basic usage" do
+    it "has association method which finds belonging object" do
+      user = User.new(4)
+      subject.user_id = 4
+      subject.user.should == user
+    end
+  end
+
+  describe "option :class_name" do
+    it "has association method which finds belonging instance of provided :class_name" do
+      store = Store.new(2)
+      subject.depot_id = 2
+      subject.depot.should == store
+    end
+  end
+
+  describe "option :foreign_key" do
+    it "has association method which finds belonging object by adjusted :foreign_key" do
+      order = Order.new(5)
+      subject.booking_id = 5
+      subject.order.should == order
+    end
+  end
+
+  describe "option :polymorphic" do
+    it "has association method which finds belonging :polymorphic object" do
+      customer = Customer.new(4)
+      subject.owner_id = 4
+      subject.owner_type = 'Customer'
+      subject.owner.should == customer
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "belongs_to_remote"
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/support/base.rb

@@ -0,0 +1,18 @@
+class Base
+  attr_accessor :id
+
+  def initialize(id)
+    self.id = id
+    self.class.initialized_objects[id] = self
+  end
+
+  class << self
+    def initialized_objects
+      @initialized_objects ||= {}
+    end
+
+    def find(id)
+      initialized_objects[id]
+    end
+  end
+end

data/spec/support/customer.rb

@@ -0,0 +1,4 @@
+require_relative "base"
+
+class Customer < Base
+end

data/spec/support/order.rb

@@ -0,0 +1,4 @@
+require_relative "base"
+
+class Order < Base
+end

data/spec/support/product.rb

@@ -0,0 +1,14 @@
+require_relative "user"
+require_relative "store"
+require_relative "order"
+require_relative "customer"
+
+class Product
+  include BelongsToRemote
+  attr_accessor :user_id, :depot_id, :booking_id, :owner_id, :owner_type
+
+  belongs_to_remote :user
+  belongs_to_remote :depot, class_name: "Store"
+  belongs_to_remote :order, foreign_key: :booking_id
+  belongs_to_remote :owner, polymorphic: true
+end

data/spec/support/store.rb

@@ -0,0 +1,4 @@
+require_relative "base"
+
+class Store < Base
+end

data/spec/support/user.rb

@@ -0,0 +1,4 @@
+require_relative "base"
+
+class User < Base
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: belongs_to_remote
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Avoyants
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: ActiveRecord belongs to ActiveResource association (e.g. belongs_to_remote
+  :user). Supports options :class_name, :foreign_key, :polymorphic
+email:
+- shhavel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- belongs_to_remote.gemspec
+- lib/belongs_to_remote.rb
+- lib/belongs_to_remote/version.rb
+- spec/belongs_to_remote_spec.rb
+- spec/spec_helper.rb
+- spec/support/base.rb
+- spec/support/customer.rb
+- spec/support/order.rb
+- spec/support/product.rb
+- spec/support/store.rb
+- spec/support/user.rb
+homepage: ''
+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: ActiveRecord belongs to ActiveResource association (e.g. belongs_to_remote
+  :user).
+test_files:
+- spec/belongs_to_remote_spec.rb
+- spec/spec_helper.rb
+- spec/support/base.rb
+- spec/support/customer.rb
+- spec/support/order.rb
+- spec/support/product.rb
+- spec/support/store.rb
+- spec/support/user.rb