discoverer 0.0.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Xavier Via
+
+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,13 @@
+Discoverer
+====
+
+Clases
+------
+
+{Discoverer::Model}
+
+To do
+-----
+
+- For the love of God, add some documentation!!!
+- The exception when the Pattern Classes (Writer, Reader) are not properly implemented should be more verbose about what's actually the problem. Furthermore, testing method for correct Pattern Class implementations should be provided within Core.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/discoverer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/discoverer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Xavier Via"]
+  gem.email         = ["xavierviacanel@gmail.com"]
+  gem.description   = %q{Discoverer functionality with focus in writers and readers}
+  gem.summary       = %q{Discoverer functionality with focus in writers and readers}
+  gem.homepage      = ""
+
+  gem.add_dependency 'virtus'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "discoverer"
+  gem.require_paths = ["lib"]
+  gem.version       = Discoverer::VERSION
+end

data/docs/Discoverer/Model.md

@@ -0,0 +1,11 @@
+Model
+=====
+
+Model is a class to be inherited in every Fetcher Model.
+
+It automagically:
+
+* Includes Virtus
+* Adds the `:_id` attribute
+* Provides a flexible constructor on top of Virtus
+* Defines `#from` and `#to` as [Discoverer Methods](http://xaviervia.com.ar/patterns/discoverer-method) for Readers and Writers

data/lib/discoverer.rb

@@ -0,0 +1,10 @@
+# Vendor
+require 'virtus'
+
+# Internal
+require 'discoverer/version'
+require 'discoverer/reader'
+require 'discoverer/writer'
+require 'discoverer/model'
+
+require 'discoverer/discoverer'

data/lib/discoverer/discoverer.rb

@@ -0,0 +1,29 @@
+module Discoverer
+  def self.has_adapter_for? adapter_constant, the_class
+    return false if the_class.name.nil?
+    namespace = the_class.name.split '::' 
+    current_module = adapter_constant
+    until namespace.empty?
+      if RUBY_VERSION =~ /1.8/
+        return false unless current_module.constants.include? namespace.first 
+      else
+        return false unless current_module.constants.include? namespace.first.to_sym
+      end
+      current_module = current_module.const_get namespace.shift
+    end
+    return true
+  end
+
+  def self.for adapter_constant, the_class
+    the_class.ancestors.length.times do |time|
+      if has_adapter_for? adapter_constant, the_class.ancestors[time]
+        return eval "::#{adapter_constant}::#{the_class.ancestors[time]}"
+      end
+    end
+
+    raise NotFoundError, 
+      "There is no #{adapter_constant.name.downcase} for #{the_class} or any of its ancestors"
+  end
+
+  class NotFoundError < StandardError; end
+end

data/lib/discoverer/model.rb

@@ -0,0 +1,42 @@
+module Discoverer
+  # {include:file:docs/Discoverer/Model.md}
+  class Model
+    include Virtus
+    include Reader
+    include Writer
+
+    # @!attribute _id
+    #   @return [Object] the id of the object as persisted
+    attribute :_id
+
+    # Accepts an attributes Hash as argument. Loads from the default datasource
+    # unless the Hash has an _id setted.
+    #
+    # @return [Model] a new instance
+    def initialize *args
+      super *args
+      #binding.pry
+      from.default if @_id.nil? and not attributes!.empty?
+    end
+
+    # @return [Hash] The attributes which are not set to nil
+    def attributes!
+      the_attributes = {}
+      attributes.each do |key, value|
+        the_attributes[key] = value unless value.nil?
+      end
+      return the_attributes
+    end
+
+    # Static methods
+    # @return [Symbol] the name of the class, pluralized, downcased and made into a Symbol
+    def self.table_name
+      "#{self.downcase}s".to_sym
+    end
+
+    # @return [String] the name of the clasee, downcased and made into a String
+    def self.downcase 
+      "#{self}".split("::").last.downcase
+    end
+  end
+end

data/lib/discoverer/reader.rb

@@ -0,0 +1,20 @@
+module Discoverer
+  
+  # Discoverer Method implementation for Readers
+  # Implements method #from
+  module Reader
+
+    # Discoverer method
+    # @return [Reader] the reader object for this object, initialized
+    def from
+      begin
+        @_reader ||= Discoverer.for( ::Reader, self.class ).new self
+        @_reader
+      rescue Discoverer::NotFoundError => e 
+        raise MissingReaderError, "The reader for #{self.class} (Reader::#{self.class}) wasn't found, please create it"
+      end
+    end
+
+    class MissingReaderError < StandardError; end
+  end
+end

data/lib/discoverer/version.rb

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

data/lib/discoverer/writer.rb

@@ -0,0 +1,16 @@
+module Discoverer
+  module Writer
+
+    def to
+      begin
+        @_writer ||= Discoverer.for(::Writer, self.class).new self
+        @_writer
+      rescue Discoverer::NotFoundError => e 
+        raise MissingWriterError, "The writer for #{self.class} (Writer::#{self.class}) wasn't found, please create it"
+      end
+    end
+
+    class MissingWriterError < StandardError; end
+    class EmptySourceError < StandardError; end
+  end
+end

data/spec/discoverer/discoverer_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe Discoverer do
+  describe '.has_adapter_for?' do
+    context 'an adapter exists matching the given constant and class' do
+      it 'should return true' do
+        module SomeAdaptation; class Klass; end; end
+
+        class Klass; end
+
+        Discoverer.has_adapter_for?(SomeAdaptation, Klass).should == true
+      end
+    end
+
+    context 'no adapter exists for the given constant' do
+      it 'should return false' do
+        module SomeAdaptation; end
+        module Ja; class Kle; end; end
+
+        Discoverer.has_adapter_for?(SomeAdaptation, Ja::Kle).should == false
+      end
+    end
+
+    context 'the constant does not exist' do
+      it 'should raise a relevant error' do 
+        expect { Discoverer.has_adapter_for? DoesNotExist, Object
+          }.to raise_error NameError
+      end
+    end
+
+    context 'the class has not name' do
+      it 'should return false' do
+        module SomeAdaptation; end
+
+        not_name = stub 'not name'
+        not_name.should_receive(:name).and_return nil
+        Discoverer.has_adapter_for?(SomeAdaptation, not_name).should == false
+      end
+    end
+  end
+
+  describe '.for' do
+    context 'this class has an adapter for the constant' do
+      before do 
+        module Some; class End; end; end
+        class End; end
+      end
+
+      it 'should return the adapter class' do
+        Discoverer.for( Some, End ).should == Some::End
+      end
+    end
+
+    context 'the superclass has a adapter_for' do
+      before do 
+        module Some1; class Super1; end; end
+
+        class Super1; end
+        class End1 < Super1; end
+      end
+
+      it 'should return the superclass adapter class' do
+        Discoverer.for( Some1, End1 ).should == Some1::Super1
+      end
+    end
+
+    context 'an implemented module has a adapter_for' do
+      before do 
+        module Some2; class Module1; end; end
+        module Module1; end
+
+        class End2; include Module1; end
+      end
+
+      it 'should return the module adapter class' do
+        Discoverer.for( Some2, End2 ).should == Some2::Module1
+      end
+    end
+
+    context 'the superclass has a adapter_for and its superclass has one too' do
+      before do
+        module Some3; class Super2; end; end
+        module Some3; class Super3; end; end
+
+        class Super2; end
+        class Super3 < Super2; end 
+        class End3 < Super3; end
+      end
+
+      it 'should return the superclass\'s adapter' do
+        Discoverer.for( Some3, End3 ).should == Some3::Super3
+      end
+    end
+
+    # I keep it here for a memento, and a good laught:
+    # Remember, remember the errors and bad practices that stem from going
+    # halfway in abstraction of implementation
+    context 'some ancestor does not have an adapter' do
+      before do
+        module Some5; class Super5; end; end
+        class Super5; end
+        module Module3; end
+        class End5 < Super5; include Module3; end
+      end
+
+      it 'should skip over it' do
+        Discoverer.for( Some5, End5 ).should == Some5::Super5
+      end
+    end
+
+    context 'there is no adapter for the class in the hierarchy' do
+      before do
+        module Some4; end
+        class End4; end
+      end
+
+      it 'should return an exception' do
+        expect { Discoverer.for Some4, End4 
+          }.to raise_error Discoverer::NotFoundError, 
+            "There is no some4 for End4 or any of its ancestors"
+      end
+    end
+  end
+end

data/spec/discoverer/model_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Discoverer::Model do 
+  it 'should include Discoverer::Reader' do
+    Discoverer::Model.ancestors.should include Discoverer::Reader
+  end
+
+  it 'should include Discoverer::Writer' do
+    Discoverer::Model.ancestors.should include Discoverer::Writer
+  end
+
+  it 'should include Virtus' do 
+    Discoverer::Model.ancestors.should include Virtus
+  end
+
+  it 'should include the attribute _id' do 
+    flag = false
+    Discoverer::Model.attribute_set.each do |attribute|
+      flag = true if attribute.name == :_id
+    end
+    flag.should === true
+  end
+
+  describe '.table_name' do
+    it 'should return the class name, downcased, pluralized and made into a Symbol' do 
+      Discoverer::Model.table_name.should == :models
+    end
+  end
+
+  describe '.downcase' do
+    it 'should return the class name downcased and made into a String' do
+      Discoverer::Model.downcase.should == 'model'
+    end
+  end
+
+  describe '#attributes!' do 
+    context 'we have another attribute' do
+      before do
+        module Discoverer
+          class Model
+            attribute :my_attr
+          end
+        end
+      end
+
+      context 'no attribute is set' do
+        it 'should return an empty hash' do 
+          model = Discoverer::Model.new {}
+          model.attributes!.should == {}
+        end
+      end
+
+      context 'only one attribute is set' do
+        context 'my_attr was set' do
+          it 'should return the attribute that was set' do 
+            Discoverer::Model.any_instance.should_receive(:from).and_return stub(:default => nil)
+            model = Discoverer::Model.new :my_attr => "value"
+            model.attributes!.should == { :my_attr => "value" }
+          end
+        end
+
+        context '_id was set' do
+          it 'should return the attribute that was set' do 
+            model = Discoverer::Model.new :_id => "value"
+            model.attributes!.should == { :_id => "value" }
+          end
+        end
+      end
+
+      context 'both attributes are set' do
+        it 'should return both attributes' do
+          model = Discoverer::Model.new :my_attr => 'value', :_id => "123456"
+          model.attributes!.should == { :_id => '123456', :my_attr => 'value' }
+        end
+      end
+    end
+  end
+
+  describe '#initialize' do
+    before do
+      module Discoverer
+        class Model
+          attribute :my_attr
+          attribute :other_attr
+        end
+      end
+    end
+
+    context 'we have an extra attribute' do 
+      context 'no argument is passed' do
+        it 'should return a new instance with no attributes set' do
+          mod = Discoverer::Model.new
+          mod.attributes!.should be_empty
+        end
+
+        it 'should not call the reader #from' do
+          Discoverer::Model.any_instance.should_not_receive :from
+          Discoverer::Model.new
+        end
+      end
+
+      context 'a Hash with _id key is passed' do
+        it 'should return a new instance with the attributes set' do
+          mod = Discoverer::Model.new :_id => "lala", :my_attr => "2354"
+          mod._id.should == "lala"
+          mod.my_attr.should == "2354"
+        end
+
+        it 'should not call the reader #from' do
+          Discoverer::Model.any_instance.should_not_receive :from
+          Discoverer::Model.new :_id => "lala", :my_attr => "2354"
+        end
+      end
+
+      context 'a Hash without _id key is passed' do
+        it 'should return a new instance with the attributes set' do
+          reader = stub 'reader'
+          Discoverer::Model.any_instance.should_receive(:from).and_return reader
+          reader.should_receive :default
+          mod = Discoverer::Model.new :my_attr => "345345"
+          mod.my_attr.should == "345345"
+        end
+
+        it 'should call the reader #from and send the method #default' do
+          reader = stub 'reader'
+          Discoverer::Model.any_instance.should_receive(:from).and_return reader
+          reader.should_receive :default
+          Discoverer::Model.new :my_attr => "234"
+        end
+      end
+    end
+  end
+end

data/spec/discoverer/reader_spec.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Discoverer::Reader do
+  describe "#from" do
+    context "para la clase Klass" do
+      it "should instance the class Reader::Klass" do
+        module Reader
+          class Klass
+          end
+        end
+
+        Reader::Klass.should_receive :new
+
+        class Klass
+          include Discoverer::Reader
+        end
+
+        obj = Klass.new
+        obj.from
+      end
+
+      it "should pass the currect object as argument" do
+        module Reader
+          class Klass
+          end
+        end
+
+        class ::Klass
+          include Discoverer::Reader
+        end
+
+        obj = ::Klass.new
+
+        Reader::Klass.should_receive( :new ).with obj
+
+        obj.from
+      end
+
+      it "should return the same reader if its called twice" do
+        module Reader
+          class Klass
+          end
+        end
+
+        class ::Klass
+          include Discoverer::Reader
+        end
+
+        obj = ::Klass.new
+
+        reader = stub 'reader'
+        Reader::Klass.should_receive( :new ).with( obj ).and_return reader
+
+        obj.from.should === reader
+        obj.from.should === reader
+      end
+    end
+
+    context "for a subclass" do
+      it "should simply work, provided the pattern is right" do
+        module Reader
+          class UserR
+          end
+        end
+
+        class Model
+          include Discoverer::Reader
+        end
+
+        class UserR < Model
+        end
+        obj = UserR.new
+        Reader::UserR.should_receive( :new ).with obj
+        obj.from
+      end
+    end
+
+    context "there is a reader" do
+      it 'should fail with a descriptive error' do
+        class Ponele
+          include Discoverer::Reader
+        end
+
+        obj = Ponele.new
+        expect { obj.from
+        }.to raise_error Discoverer::Reader::MissingReaderError,
+          "The reader for Ponele (Reader::Ponele) wasn't found, please create it"
+      end
+    end
+  end
+end

data/spec/discoverer/writer_spec.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Discoverer::Writer do
+  describe "#to" do
+    before do
+      module Writer
+        class TestClass
+        end
+      end
+      class TestClass
+        include Discoverer::Writer
+      end
+    end
+
+    context "when the method is called" do
+      it "should try to instance the class reader with self(actual class that call the method)" do
+
+        Writer::TestClass.should_receive :new
+
+        obj = TestClass.new
+        obj.to
+      end
+
+      it "should pass as argument self" do
+        obj = TestClass.new
+        Writer::TestClass.should_receive(:new).with(obj)
+        obj.to
+      end
+
+      it "should retrive the same writer if it's called twice" do
+        writer = stub "writer"
+        aux = TestClass.new
+
+        Writer::TestClass.should_receive(:new).with(aux).and_return(writer)
+
+        aux.to.should eq writer
+        aux.to.should eq writer
+
+      end
+    end
+
+    context "for a subclass" do
+      it "should work at once, provided the implementation of the pattern is done" do
+        module Writer
+          class UserW
+          end
+        end
+
+        class UserW < TestClass
+        end
+
+        obj = UserW.new
+        Writer::UserW.should_receive( :new ).with obj
+        obj.to
+      end
+    end
+
+
+    context "there is no writer" do
+      it "should fail with a friendly error" do
+        class Fail
+          include Discoverer::Writer
+        end
+
+        obj = Fail.new
+        expect { 
+          obj.to
+        }.to raise_error Discoverer::Writer::MissingWriterError,
+          "The writer for Fail (Writer::Fail) wasn't found, please create it"
+         
+      end
+    end
+
+
+
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'discoverer'
+require 'pry'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: discoverer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Xavier Via
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Discoverer functionality with focus in writers and readers
+email:
+- xavierviacanel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- discoverer.gemspec
+- docs/Discoverer/Model.md
+- lib/discoverer.rb
+- lib/discoverer/discoverer.rb
+- lib/discoverer/model.rb
+- lib/discoverer/reader.rb
+- lib/discoverer/version.rb
+- lib/discoverer/writer.rb
+- spec/discoverer/discoverer_spec.rb
+- spec/discoverer/model_spec.rb
+- spec/discoverer/reader_spec.rb
+- spec/discoverer/writer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Discoverer functionality with focus in writers and readers
+test_files:
+- spec/discoverer/discoverer_spec.rb
+- spec/discoverer/model_spec.rb
+- spec/discoverer/reader_spec.rb
+- spec/discoverer/writer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: