get 0.1.3.0 → 0.1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65fd187b7fdf6d925755baa22b7a7ce32cebc00e
-  data.tar.gz: 48fa9d577da086b0a6f90986106aa1c9581e8b40
+  metadata.gz: 2d18fd6e0ff97b254927a5dda39633fd3074cc4a
+  data.tar.gz: 93fcab2142e08cdc90f911002211bf519b34b2c5
 SHA512:
-  metadata.gz: 11e0607221f9bb3c6c42770f55eef24d43a5f2bac228fd6e876bccf648394a28e3ed815005a3179930d88077b74f2a7e403c78bd04e775943986ab3bdd66aec9
-  data.tar.gz: 80f305335e0721add5e78c2879849a1e6fed6eaedc4d2cf2fd4ae1a6d240025923dc4e7d3a14fea37c346b86b3ffef66c99061793de2b8e47c45c02abff6df0f
+  metadata.gz: 06a1e30bbe933922db557da9756cca4a273532952b4d3048d15beb536ae48dd537f59ac7a40937dcd0f831ef14f459f8e4c99773c16f9ae946921289803859e4
+  data.tar.gz: 620749e0087939ef868d95e6546cb8ac8dab40849d89ea529fb5dbe043a1c7e902002f8d76f7603d91c5e76c4558201e00a535223e14647b7e43cbd0991a59a5

data/README.md

@@ -139,24 +139,15 @@ but UserFromEmployer will throw `Get::Errors::InvalidAncestry`.
 
 ## Entities
 
-Ironically, one of the "features" of Get is its removal of the ability to query associations from the query response object.
+Ironically, one of the "features" of Get is its removal of the ability to query associations from the ORM response object.
 This choice was made to combat query pollution throughout the app, particularly in the view layer.
 
-To achieve this, Get returns **entities** instead of ORM  objects (`ActiveRecord::Base`, etc.).
-These entity classes are generated at runtime with names appropriate to their contents.
-You can also register your own entities in the Get config.
-
-```ruby
->> result = Get::UserById.run(user.id)
->> result.class.name
->> "Get::Entities::GetUser"
-```
+To achieve this, Get returns Horza Entities instead of ORM  objects (`ActiveRecord::Base`, etc.).
+See the [Horza Readme](https://github.com/onfido/horza) for instructions on how to create your own entities.
 
 Individual entities will have all attributes accessible via dot notation and hash notation, but attempts to get associations will fail.
 Collections have all of the common enumerator methods: `first`, `last`, `each`, and `[]`.
 
-Dynamically generated Get::Entities are prefixed with `Get` to avoid colliding with your ORM objects.
-
 ## Testing
 
 A big motivation for this library is to make testing database queries easier.
@@ -178,7 +169,7 @@ def index
 end
 ```
 
-The above methods do the exact same thing. Cool, let's test them:
+The above methods do pretty much the exact same thing (the only difference is that the second example returns a Horza Entity instead of an ORM object). Cool, let's test them:
 
 ```ruby
 # sportscars_controller.rb
@@ -202,7 +193,7 @@ describe SportscarsController, type: :controller do
 
     context 'Get' do
       let(:user) { FactoryGirl.build_stubbed(:user, employer: employer) }
-      let(:sportscars) { 3.times { FactoryGirl.build_stubbed(:sportscars) } }
+      let(:sportscars) { 3.times { Horza::Entities::Single.new(FactoryGirl.attributes_for(:sportscars)) } }
 
       before do
         allow(Get::SportscarsFromUser).to receive(:run).and_return(sportscars)
@@ -229,24 +220,6 @@ _config/initializers/ask.rb_
 ```ruby
 Get.configure { |config| config.adapter = :active_record }
 ```
-
-**Configure custom entities**
-
-The code below will cause Get classes that begin with _Users_ (ie. `UsersByLastName`) to return a MyCustomEntity instead of the default `Get::Entities::User`.
-
-_config/initializers/ask.rb_
-```ruby
-class MyCustomEntity < Get::Entities::Collection
- def east_london_length
-   "#{length}, bruv"
- end
-end
-
-Get.config do |config|
- config.register_entity(:users_by_last_name, MyCustomEntity)
-end
-```
-
 You can reset the config at any time using `Get.reset`.
 
 ## Adapters

data/lib/get/builders/ancestry_builder.rb

@@ -17,10 +17,10 @@ module Get
           include Get
 
           class << self
-            attr_reader :result_key
+            attr_reader :target
           end
 
-          @entity, @result_key, @collection, @store = args[:key], args[:result_entity], args[:collection], args[:store]
+          @entity, @target, @collection, @store = args[:key], args[:result_entity], args[:collection], args[:store]
 
           def initialize(model, options = {})
             @model, @options = model, options
@@ -43,7 +43,7 @@ module Get
             {
               id: id,
               via: via,
-              result_key: self.class.result_key
+              target: self.class.target
             }
           end
 

data/lib/get/builders/base_builder.rb

@@ -2,7 +2,9 @@ module Get
   module Builders
     class BaseBuilder
       def initialize(class_name)
-        parse_class_name(class_name)
+        parser = ::Get::Parser.new(class_name)
+        @result_entity = parser.result_entity
+        @key = parser.key
       end
 
       def class

data/lib/get/builders/query_builder.rb

@@ -30,11 +30,11 @@ module Get
           private
 
           def query_params
-            { query_action => { conditions: conditions } }
+            { query_action => conditions }
           end
 
           def query_action
-            self.class.collection ? :find_all : :find_first
+            self.class.collection ? :find_all : :find_first!
           end
 
           # find_first

data/lib/get/builders.rb

@@ -1,10 +1,7 @@
 module Get
   module Builders
-    String.send(:include, ::Get::CoreExtensions::String)
-
     class << self
-      def generate_class(name)
-        method = name.to_s.match(GET_CLASS_REGEX)[2]
+      def generate_class(name, method)
         Get.const_set(name, builder_for_method(method).new(name).class)
       end
 

data/lib/get/configuration.rb

@@ -17,30 +17,14 @@ module Get
       raise ::Get::Errors::Base.new('Adapter has not been configured') unless configuration.adapter
       @adapter ||= configuration.adapter
     end
-
-    def entity_for(model)
-      configuration.entity_for(model)
-    end
   end
 
   class Config
     attr_accessor :adapter
 
-    def initialize
-      @registered_entities = {}
-    end
-
     def set_adapter(adapter)
       Horza.configure { |config| config.adapter = adapter }
       @adapter = Horza.adapter
     end
-
-    def entity_for(model)
-      @registered_entities[model]
-    end
-
-    def register_entity(model, klass)
-      @registered_entities[model] = klass
-    end
   end
 end

data/lib/get/db.rb

@@ -10,12 +10,11 @@ module Get
 
     def initialize(actions)
       @actions = actions
-      @query = Get.adapter.new(self.class.store)
+      @adapter = Get.adapter.new(self.class.store)
     end
 
     def call
       execute_queries
-      self.class.entity_factory.build(@query)
     rescue Horza::Errors::InvalidAncestry
       raise Get::Errors::InvalidAncestry
     end
@@ -23,9 +22,11 @@ module Get
     private
 
     def execute_queries
+      res = nil
       @actions.each do |action, options|
-        @query.send(action, options)
+        res = @adapter.send(action, options)
       end
+      res
     end
   end
 end

data/lib/get/parser.rb

@@ -0,0 +1,20 @@
+module Get
+  class Parser
+    CLASS_REGEX = /^(.*)(By|From)(.*)/
+    attr_accessor :class_name, :result_entity, :method
+
+    def initialize(class_name)
+      @class_name = class_name
+      @match = class_name.to_s.match(CLASS_REGEX)
+      @result_entity, @method, @key_string = @match.values_at(1, 2, 3) if @match
+    end
+
+    def match?
+      !!@match
+    end
+
+    def key
+      @key_string.present? ? @key_string.symbolize : nil
+    end
+  end
+end

data/lib/get.rb

@@ -1,13 +1,11 @@
 require 'get/builders/base_builder'
 require 'get/builders/ancestry_builder'
 require 'get/builders/query_builder'
-require 'get/core_extensions/string'
 require 'get/builders'
 require 'get/configuration'
 require 'get/db'
-require 'get/entities'
-require 'get/entity_factory'
 require 'get/errors'
+require 'get/parser'
 require 'get/run_methods'
 require 'horza'
 
@@ -26,8 +24,9 @@ module Get
     end
 
     def const_missing(name)
-      return super(name) unless name.to_s.match(GET_CLASS_REGEX)
-      Builders.generate_class(name)
+      parser = ::Get::Parser.new(name)
+      return super(name) unless parser.match?
+      Builders.generate_class(name, parser.method)
     end
   end
 

data/spec/get_spec.rb

@@ -51,50 +51,6 @@ describe Get do
     end
   end
 
-  describe '#configure' do
-    context '#register_entity' do
-      let(:user_count) { 3 }
-
-      before do
-        Get.configure { |config| config.register_entity(:users_by_last_name, MyCustomEntity) }
-        user_count.times { GetSpec::User.create(last_name: last_name) }
-      end
-      after { Get.reset }
-
-      it 'gets registers entity' do
-        expect(Get.configuration.entity_for(:users_by_last_name)).to eq MyCustomEntity
-      end
-
-      it 'returns specified entity type after querying db' do
-        result = Get::UsersByLastName.run(last_name)
-        expect(result.is_a? MyCustomEntity).to be true
-        expect(result.east_london_length).to eq "#{user_count}, bruv"
-      end
-    end
-  end
-
-  context '#entity_for' do
-    context 'when entity has been registered' do
-      before do
-        Get.configure do |config|
-          config.set_adapter(adapter)
-          config.register_entity(:users_by_last_name, MyCustomEntity)
-        end
-      end
-      after { Get.reset }
-
-      it 'registers entity' do
-        expect(Get.entity_for(:users_by_last_name)).to eq MyCustomEntity
-      end
-    end
-
-    context 'when entity has not been registered' do
-      it 'returns nil' do
-        expect(Get.entity_for(:users_by_last_name)).to be nil
-      end
-    end
-  end
-
   context '#adapter' do
     context 'when the adapter is set' do
       it 'returns the correct adapter class' do
@@ -116,13 +72,11 @@ describe Get do
     before do
       Get.configure do |config|
         config.set_adapter('my_adapter')
-        config.register_entity(:users_by_last_name, MyCustomEntity)
       end
       Get.reset
     end
     it 'resets the config' do
       expect(Get.configuration.adapter).to be nil
-      expect(Get.entity_for(:users_by_last_name)).to be nil
     end
   end
 
@@ -165,7 +119,7 @@ describe Get do
       context 'valid ancestry with no saved parent' do
         let(:user2) { GetSpec::User.create }
         it 'returns nil' do
-          expect { Get::EmployerFromUser.run!(user2) }.to raise_error Get::Errors::RecordNotFound
+          expect(Get::EmployerFromUser.run!(user2)).to be nil
         end
       end
     end
@@ -325,7 +279,7 @@ describe Get::Builders::AncestryBuilder do
     end
 
     it 'correctly assigns class-level variables' do
-      [:entity, :query_key, :collection, :store, :result_key].each do |class_var|
+      [:entity, :query_key, :collection, :store, :target].each do |class_var|
         expect(subject.class.respond_to? class_var).to be true
       end
     end
@@ -352,3 +306,31 @@ describe Get::Builders::QueryBuilder do
     end
   end
 end
+
+describe Get::Parser do
+  let(:ancestry_name) { 'UserFromEmployer' }
+  let(:query_name) { 'UserFromEmployer' }
+
+  subject { Get::Parser }
+
+  describe '#match?' do
+    context 'when name is of ancestry type' do
+      it 'returns true' do
+        expect(subject.new(ancestry_name).match?).to be true
+      end
+    end
+
+    context 'when name is of query type' do
+      it 'returns true' do
+        expect(subject.new(query_name).match?).to be true
+      end
+    end
+
+    context 'when name is of no type' do
+      it 'returns false' do
+        expect(subject.new('Blablabla').match?).to be false
+      end
+    end
+
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: get
 version: !ruby/object:Gem::Version
-  version: 0.1.3.0
+  version: 0.1.4.0
 platform: ruby
 authors:
 - Blake Turner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: horza
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,11 +122,9 @@ files:
 - lib/get/builders/base_builder.rb
 - lib/get/builders/query_builder.rb
 - lib/get/configuration.rb
-- lib/get/core_extensions/string.rb
 - lib/get/db.rb
-- lib/get/entities.rb
-- lib/get/entity_factory.rb
 - lib/get/errors.rb
+- lib/get/parser.rb
 - lib/get/run_methods.rb
 - spec/get_spec.rb
 - spec/spec_helper.rb

data/lib/get/core_extensions/string.rb

@@ -1,17 +0,0 @@
-module Get
-  module CoreExtensions
-    module String
-      def singular?
-        singularize == self
-      end
-
-      def plural?
-        pluralize == self
-      end
-
-      def symbolize
-        underscore.to_sym
-      end
-    end
-  end
-end

data/lib/get/entities.rb

@@ -1,14 +0,0 @@
-module Get
-  module Entities
-    CLASS_PREFIX = 'Get'
-
-    class << self
-      def const_missing(name)
-        return super(name) unless name.to_s.match(/^#{CLASS_PREFIX}/)
-
-        parent_klass = name.to_s.plural? ? Horza::Entities::Collection : Horza::Entities::Single
-        Get::Entities.const_set(name, Class.new(parent_klass))
-      end
-    end
-  end
-end

data/lib/get/entity_factory.rb

@@ -1,35 +0,0 @@
-module Get
-  class EntityFactory
-    def initialize(entity, query_class_name, is_collection, result_key)
-      @entity, @query_class_name, @is_collection, @result_key = entity, query_class_name, is_collection, result_key
-    end
-
-    def build(adapter_result)
-      raise ::Get::Errors::RecordNotFound.new unless adapter_result.context
-      klass.new(db_result(adapter_result))
-    end
-
-    private
-
-    def db_result(adapter_result)
-      @is_collection ? adapter_result.context : adapter_result.to_hash
-    end
-
-    def klass
-      Get.entity_for(key) || Get::Entities.const_get(dynamic_class)
-    end
-
-    def key
-      @query_class_name.demodulize.symbolize
-    end
-
-    def dynamic_class
-      "#{::Get::Entities::CLASS_PREFIX}#{dynamic_key.camelize}"
-    end
-
-    def dynamic_key
-      return @result_key.to_s if @result_key # Special case for ancestor queries
-      @is_collection ? @entity.to_s.pluralize : @entity.to_s
-    end
-  end
-end