arqo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1887e4c98d7848ac3d743b338ea8aeaf26f3d643
-  data.tar.gz: 22d1f86473d4adc3437aedc2401fc64eb040fd70
+  metadata.gz: 4ba2c84fa910379b38e591ab84f766e057c76de6
+  data.tar.gz: b6e2b10c631038d4c766683b1159aebbe44325f9
 SHA512:
-  metadata.gz: 2c0b3222b5b3023d9eb4d16a6bf9d244414523e19dc2e4295e0f1ff963fc08bde610fd55656a8e1881ca63a7e891f48578580f192945cd99b27b92cf5f36af10
-  data.tar.gz: 9214d81840071fd81d134b89006fa4ff99bc50702b0ae9a81137cf089afa3db208553d2f8a88f4ecb451819a60c4677218bc00316d25f87c55897142476c89a3
+  metadata.gz: faa30d5cabb73243dc846d2f71eca8d521b0b3073467039df5350a7e4730096904320c935b1a727ac4f04a1f11b024004756b27dda8da993b5971f60fed271dd
+  data.tar.gz: d7199ec586500009c448606a63454cc29e9c68e121dfd19874b54a5fc7918ec5af737c1b521f76f03d3173c5a09768ab74a09854ad401d513c1f803877836f78

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Santiago Bartesaghi
+Copyright (c) 2020 Rootstrap
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -96,6 +96,22 @@ you can use it like this:
 CustomNamedQuery.new(User.all).active_last_week
 ```
 
+you can also set the model class or relation to query from by overriding a simple method, like:
+
+```ruby
+class CustomNamedQuery < ARQO::Query
+  module Scope
+    # ...
+  end
+
+  private
+
+  def associated_relation
+    User # you can also do something like User.some_scope
+  end
+end
+```
+
 ## Chaining scopes
 Of course you can chain everything together, methods defined in the query object and scopes defined in the model or by Rails.
 ```ruby
@@ -127,7 +143,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/santib/arqo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/santib/arqo/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/arqo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rootstrap/arqo/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -136,7 +152,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ARQO project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/santib/arqo/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ARQO project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rootstrap/arqo/blob/master/CODE_OF_CONDUCT.md).
 
 ## Logo attribution
 Logo made by [iconixar](https://www.flaticon.com/free-icon/archery_3080892) from [www.flaticon.com](https://www.flaticon.com/)

data/lib/arqo/query.rb

@@ -6,18 +6,45 @@ module ARQO
     attr_reader :relation
     delegate_missing_to :relation
 
-    def initialize(relation = derived_relation)
+    def initialize(relation = associated_relation)
       @relation = relation.extending(scope_module)
     end
 
     private
 
-    def derived_relation_name
-      self.class.name.sub(/Query$/, '')
-    end
+    # Returns the model to which the query object is associated.
+    # By default it will infer the name from the query object's class
+    # assuming the name is the name of the model with "Query" as the suffix.
+    #
+    # As an example, UserQuery would be associated with the User model and
+    # Blog::PostQuery would be associated with the Blog::Post namespaced model.
+    #
+    # This method can be overridden to bypass this convention and associate
+    # the query object to another relation by returning it.
+    #
+    # ==== Example
+    #     class PostQuery < ARQO::Query
+    #       # ...
+    #
+    #       private
+    #
+    #       def associated_relation
+    #         Blog::Post
+    #       end
+    #     end
+    #
+    # @return [Class, ActiveRecord::Relation]
+    def associated_relation
+      class_name = self.class.name
+      derived_relation_name = class_name.sub(/Query$/, '')
+
+      unless Object.const_defined?(derived_relation_name)
+        raise NameError, "Could not find model #{derived_relation_name} associated " \
+          "to query #{class_name}.\n Make sure the name is correct or override " \
+          '#associated_relation to provide a custom model'
+      end
 
-    def derived_relation
-      derived_relation_name.constantize.all if Object.const_defined?(derived_relation_name)
+      derived_relation_name.constantize.all
     end
 
     def scope_module

data/lib/arqo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ARQO
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arqo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Santiago Bartesaghi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -130,7 +130,7 @@ dependencies:
         version: 1.4.2
 description: 
 email:
-- sbartesaghi@hotmail.com
+- santib@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -140,12 +140,12 @@ files:
 - lib/arqo.rb
 - lib/arqo/query.rb
 - lib/arqo/version.rb
-homepage: https://github.com/santib/arqo
+homepage: https://github.com/rootstrap/arqo
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/santib/arqo
-  source_code_uri: https://github.com/santib/arqo
+  homepage_uri: https://github.com/rootstrap/arqo
+  source_code_uri: https://github.com/rootstrap/arqo
 post_install_message: 
 rdoc_options: []
 require_paths: