active_poro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4e43ea9ea78bdde2baab6cdbcac5c6ed70552c3
+  data.tar.gz: 6bac908f0f51f75a7a013044009b1ba8d24d2924
+SHA512:
+  metadata.gz: b4fbe7a1ad8365b16d04c38eeaa692154405d1ce04aab34693367a9967f4aef917f19a372e80c248bce764ad43af133419a347a1e1d4d213d79429582c63957f
+  data.tar.gz: dcac90e161b9c14aeac187afa3e6eec17869a97c00d3da39d2c92eee14cfe7b2981bf8a62e6923317de0428b3e5ff458f765243913b01d3a8cf185850b49fdd8

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.idea/
+
+## UNIX TEMP FILES
+*~

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--tag focus

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Miguel Diaz
+
+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,91 @@
+# active_poro
+Makes possible the use of has_many, has_one, belongs_to relations in POROs as you would expect
+
+Important!
+----------
+
+This project is under active development
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_poro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_poro
+
+## Usage
+
+You may use ActivePoro::Model as a mixin to enable relations/associations to be built between POROs
+Currently supported associations:
+
+- has_many
+- has_one
+- belongs_to
+
+Example:
+
+```ruby
+require 'active_poro'
+
+class Dog
+  include ActivePoro::Model
+  has_many :fleas
+end
+
+class Flea
+  include ActivePoro::Model
+  belongs_to :dog
+end
+```
+
+Now, with that in place you should be able to do
+
+```ruby
+dog = Dog.new
+flea_a = Flew.new
+flea_b = Flew.new
+
+# associate the fleas with the dog
+dog.fleas = [flea_a, flea_b]
+
+# now fleas have the dog associated back
+flea_a.dog == dog
+#=> true
+
+# now fleas have the dog associated back
+flea_b.dog == dog
+#=> true
+
+# if a new dog is created
+another_dog = Dog.new
+
+# and flea_b for example, jumps to it (i.e. is associated to this other dog)
+flea_b.dog = another_dog
+
+# then dog does not have flea_b now
+dog.fleas
+#=> [flea_a] # simplified output, not actual output on the console
+
+# and another_dog gets flea_b
+another_dog.fleas
+
+#=> [flea_b] # simplified output, not actual output on the console
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/codescrum/active_poro/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,2 @@
+require "bundler/gem_tasks"
+

data/active_poro.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_poro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_poro"
+  spec.version       = ActivePoro::VERSION
+  spec.authors       = ["Miguel Diaz"]
+  spec.email         = ["miguel.diaz@codescrum.com"]
+  spec.summary       = %q{Makes possible the use of has_many, has_one, belongs_to relations in POROs as you would expect.}
+  spec.description   = %q{Ever wanted to have active-record like relations in your POROs?, here is a proposed solution.}
+  spec.homepage      = "https://github.com/codescrum/active_poro"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('jazz_hands')
+
+  spec.add_runtime_dependency('activesupport')
+end

data/lib/active_poro.rb

@@ -0,0 +1,6 @@
+require 'active_support'
+require 'active_support/core_ext/string'
+
+require 'active_poro/relations'
+require 'active_poro/model'
+require 'active_poro/version'

data/lib/active_poro/model.rb

@@ -0,0 +1,6 @@
+module ActivePoro
+  module Model
+    extend ActiveSupport::Concern
+    include Relations
+  end
+end

data/lib/active_poro/relations.rb

@@ -0,0 +1,102 @@
+module ActivePoro
+  module Relations
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_many(target_name)
+        # define getter method
+        define_method target_name do
+          instance_variable_get("@#{target_name}") || []
+        end
+
+        # define setter method
+        define_method "#{target_name}=" do |members|
+          # set the instance variable only if I am now the rightful owner
+          instance_variable_set("@#{target_name}", members || [])
+          reflected_association_name = self.class.name.underscore
+          members.each do |member|
+
+            current_owner = member.send(reflected_association_name)
+            if current_owner.nil? # no current assignment
+              member.send "#{reflected_association_name}=", self
+            elsif current_owner != self # current assignment is not me
+              other_members = current_owner.send target_name
+              if other_members.include?(member)
+                # take the element from the other member
+                new_members = other_members - [member]
+                current_owner.send "#{target_name}=", new_members
+              else
+                raise "Unmatching association; Current owner (#{current_owner.class.name}) of #{member.class.name} does not have it as a member"
+              end
+              # add me as associated to the member I am also including
+              member.send "#{reflected_association_name}=", self
+            else
+              # its already me, do not do anything
+            end
+
+          end
+        end
+      end
+
+      def has_one(target_name)
+        # define getter method
+        define_method target_name do
+          instance_variable_get("@#{target_name}") || []
+        end
+
+        # define setter method
+        define_method "#{target_name}=" do |member|
+          reflected_association_name = self.class.name.underscore
+          unless member.send(reflected_association_name) == self
+            member.send "#{reflected_association_name}=", self
+          end
+          instance_variable_set("@#{target_name}", member || [])
+        end
+      end
+
+      def belongs_to(target_name)
+        # define getter method
+        define_method target_name do
+          instance_variable_get("@#{target_name}")
+        end
+
+        # define setter method
+        define_method "#{target_name}=" do |member|
+          previous_member = instance_variable_get("@#{target_name}")
+          instance_variable_set("@#{target_name}", member)
+          reflected_association_name = self.class.name.underscore
+          # add myself to reflected association
+          if member.respond_to? reflected_association_name
+            unless member.send(reflected_association_name) == self
+              member.send("#{reflected_association_name}=", self)
+            end
+          elsif member.respond_to? reflected_association_name.pluralize
+            reflected_members = member.send(reflected_association_name.pluralize)
+            unless reflected_members.include? self
+              member.send("#{reflected_association_name.pluralize}=", reflected_members + [self])
+            end
+          else
+            raise "Association definition missing: no #{reflected_association_name} or #{reflected_association_name.pluralize} association defined in #{member.class}"
+          end
+
+          # remove myself from old reflected association
+          if previous_member.respond_to? reflected_association_name
+            if previous_member.send(reflected_association_name) == self
+              previous_member.send("#{reflected_association_name}=", nil)
+            end
+          elsif previous_member.respond_to? reflected_association_name.pluralize
+            previous_reflected_members = previous_member.send(reflected_association_name.pluralize)
+            if previous_reflected_members.include? self
+              previous_member.send("#{reflected_association_name.pluralize}=", previous_reflected_members - [self])
+            end
+          elsif previous_member.nil?
+            # there was not previous member
+          else # there was a previous member
+            raise "Ghost association definition: no #{reflected_association_name} or #{reflected_association_name.pluralize} association defined in #{member.class}, although it was there previously, dirty contamination"
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/active_poro/version.rb

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

data/spec/active_poro_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe 'ActivePoro' do
+  context 'Model' do
+    context 'relations' do
+      before do
+        class Dog < BaseTestClass
+          include ActivePoro::Model
+          has_many :fleas
+        end
+
+        class Flea < BaseTestClass
+          include ActivePoro::Model
+          belongs_to :dog
+        end
+      end
+
+      let(:big_dog){ Dog.new('Big big_dog') }
+      let(:flea_a){ Flea.new('A') }
+      let(:flea_b){ Flea.new('B') }
+
+      context 'when dog gets fleas' do
+        let(:dog_with_fleas) do
+          big_dog.fleas = [flea_a, flea_b]
+          big_dog
+        end
+
+        it 'initializes with an empty array of fleas' do
+          expect(big_dog.fleas).to eq([])
+        end
+
+        it 'is directly associated with pre-existant fleas' do
+          expect(dog_with_fleas.fleas).to eq([flea_a, flea_b])
+        end
+
+        it 'correctly sets the right big_dog to each flea' do
+          dog_with_fleas.fleas.each do |flea|
+            expect(flea.dog).to eq(big_dog)
+          end
+        end
+      end
+
+      context 'when fleas jump onto big_dog' do
+        it 'fleas have no dog to begin with' do
+          expect(flea_a.dog).to be_nil
+        end
+
+        it 'fleas may have the big_dog associated to them and viceversa' do
+          flea_a.dog = big_dog
+          expect(flea_a.dog).to eq(big_dog)
+          expect(big_dog.fleas).to eq([flea_a])
+
+          flea_b.dog = big_dog
+          expect(flea_b.dog).to eq(big_dog)
+          expect(big_dog.fleas).to eq([flea_a, flea_b])
+        end
+
+      end
+
+      context 'when a flea jumps between dogs' do
+
+        let(:small_dog){ Dog.new('Small dog') }
+
+        it 'cannot be in two dogs at the same time' do
+          flea_a.dog = big_dog
+          expect(flea_a.dog).to eq(big_dog)
+          expect(big_dog.fleas).to eq([flea_a])
+
+          # flea jumps from big dog to small dog
+          flea_a.dog = small_dog
+          expect(flea_a.dog).to eq(small_dog)
+          expect(small_dog.fleas).to eq([flea_a])
+
+          # flea A no longer in big dog
+          expect(big_dog.fleas).to_not include(flea_a)
+          expect(big_dog.fleas).to be_empty # sanity check
+        end
+
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+######################
+require 'active_poro'#
+######################
+
+# require everything in spec/support
+Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/base_test_class.rb

@@ -0,0 +1,17 @@
+# this is just a class that includes convenience methods for testing
+# such as a giving it a name so that is easy to inspect
+class BaseTestClass
+  attr_accessor :name
+
+  def initialize(name)
+    self.name = name
+  end
+
+  def to_s
+    name
+  end
+
+  def inspect
+    "\"#{to_s}\""
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: active_poro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miguel Diaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-05 00:00:00.000000000 Z
+dependencies:
+- !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
+  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: jazz_hands
+  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: 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'
+description: Ever wanted to have active-record like relations in your POROs?, here
+  is a proposed solution.
+email:
+- miguel.diaz@codescrum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_poro.gemspec
+- lib/active_poro.rb
+- lib/active_poro/model.rb
+- lib/active_poro/relations.rb
+- lib/active_poro/version.rb
+- spec/active_poro_spec.rb
+- spec/spec_helper.rb
+- spec/support/base_test_class.rb
+homepage: https://github.com/codescrum/active_poro
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Makes possible the use of has_many, has_one, belongs_to relations in POROs
+  as you would expect.
+test_files:
+- spec/active_poro_spec.rb
+- spec/spec_helper.rb
+- spec/support/base_test_class.rb
+has_rdoc: