arqo 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1887e4c98d7848ac3d743b338ea8aeaf26f3d643
-  data.tar.gz: 22d1f86473d4adc3437aedc2401fc64eb040fd70
+SHA256:
+  metadata.gz: fe852ef6a59c623ab71a8ca9ecd5320d3252dece6df5a7421df998f1f096e87c
+  data.tar.gz: 9652f930a2ef38f274c590727cce67284478ddc3db0849b0892c4602bc11d8ea
 SHA512:
-  metadata.gz: 2c0b3222b5b3023d9eb4d16a6bf9d244414523e19dc2e4295e0f1ff963fc08bde610fd55656a8e1881ca63a7e891f48578580f192945cd99b27b92cf5f36af10
-  data.tar.gz: 9214d81840071fd81d134b89006fa4ff99bc50702b0ae9a81137cf089afa3db208553d2f8a88f4ecb451819a60c4677218bc00316d25f87c55897142476c89a3
+  metadata.gz: 321f73a94a640bdf532818263ad32530e69b79d33f86a941b1e1bb7ed0df06c0e5dd14dd25d6ec1477f8f70121773fecb1e3eb8814e9ad322040007b63bdeb0b
+  data.tar.gz: 32ca904418850549f24bf975e0fe8ac59d122ffebc7e3fca4b420cede4d3dd0e31f13602742e3509798d1d5049d90c66ca892a66d72d248813f79c73d6d499de

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

@@ -15,6 +15,7 @@ ARQO (Active Record Query Objects) is a minimal gem that let you use Query Objec
   - [Setting up a query object](#setting-up-a-query-object)
   - [Deriving the model](#deriving-the-model)
   - [Chaining scopes](#chaining-scopes)
+  - [Generators](#generators)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -96,6 +97,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
@@ -119,6 +136,49 @@ And then you chain everything together and it will just work :)
 UserQuery.new.where.not(name: nil).active_last_week.not_deleted.order(:id)
 ```
 
+## Generators
+
+To create the query object we can use the rails generator tool. For that, we just run:
+
+    $ rails generate query User
+
+And it will create your UserQuery object at `app/queries` folder. If you have set Rspec as your test framework, the corresponding spec file will be also created at `spec/queries`.
+
+:warning: Rspec is the only test framework supported for now.
+
+If your query object is based on another class, you can set the `associated_relation` attribute to automatically override the `associated_relation` method.
+
+    $ rails generate query CustomUser --associated_relation=User
+
+### Model Generator
+
+To generate the query object when you create your rails models, enable the query generators at your application config file adding the following line:
+
+```ruby
+# config/application.rb
+
+module App
+  class Application < Rails::Application
+    ...
+
+    config.generators do |g|
+      ...
+      g.query true # Added line
+    end
+  end
+end
+```
+
+Now, if you run the model generator:
+
+    $ rails generate model User
+
+The query object and spec will be created as well as the model, migrations, test files, etc.
+
+Another alternative, it is to add the `--query` option at the end of the command:
+
+    $ rails generate model User --query
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -127,7 +187,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 +196,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

@@ -4,20 +4,48 @@ module ARQO
   # Parent class for query objects
   class Query
     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/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module ARQO
+  class Railtie < Rails::Railtie
+    generators do |app|
+      Rails::Generators.configure! app.config.generators
+      require_relative '../generators/model_generator'
+    end
+  end
+end

data/lib/arqo/version.rb

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

data/lib/arqo.rb

@@ -2,6 +2,7 @@
 
 require 'arqo/query'
 require 'arqo/version'
+require 'arqo/railtie'
 
 module ARQO
   class Error < StandardError; end

data/lib/generators/arqo/named_base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module ARQO
+  module Generators
+    class NamedBase < Rails::Generators::NamedBase
+      class_option :associated_relation, type: :string, default: nil
+
+      private
+
+      def associated_relation
+        @associated_relation ||= options['associated_relation']
+      end
+
+      def associated_relation_class
+        associated_relation&.to_s&.classify
+      end
+    end
+  end
+end

data/lib/generators/model_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/rails/model/model_generator'
+require_relative 'rails/query_generator'
+
+module Rails
+  module Generators
+    class ModelGenerator
+      hook_for :query, type: :boolean, default: false
+    end
+  end
+end

data/lib/generators/rails/USAGE

@@ -0,0 +1,38 @@
+Usage:
+  rails generate query NAME [--associated_relation=model]
+
+Description:
+    Generates a new ARQO query object at app/queries. Pass the generator name
+    as an argument, either CamelCased or snake_cased, and an optional
+    attribute 'associated_relation' as an argument.
+
+    The 'associated_relation' attribute expects an ActiveRecord class as value. This
+    is useful for cases where you want to override the associated relation in
+    the query object.
+
+    This generator invokes your configured ORM and test framework, which Active
+    Record and Rspec are the only ones supported at the moment.
+
+Example:
+    `rails generate query Account`
+
+    Creates a standard account query object and the spec file.
+
+        Query Object:   app/queries/account_query.rb
+        Rspec:          spec/queries/account_query.rb
+
+    `rails generate query Admin::Account`
+
+    Creates an account query object and the spec file following the namespace
+    location.
+
+        Query Object:   app/queries/admin/account_query.rb
+        Rspec:          spec/queries/admin/account_query.rb
+
+    `rails generate query Account associated_relation:User`
+
+    Creates an account query object and the spec file including the
+    specification of the `associated_relation` method.
+
+        app/queries/account_query.rb
+        spec/queries/account_query.rb

data/lib/generators/rails/query_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../arqo/named_base'
+
+module Rails
+  module Generators
+    class QueryGenerator < ARQO::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      check_class_collision suffix: 'Query'
+
+      hook_for :test_framework
+
+      def create_model_query
+        return if class_name.blank?
+
+        template_file = File.join('app/queries', class_path, "#{file_name}_query.rb")
+        template 'query.rb.erb', template_file
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/query.rb.erb

@@ -0,0 +1,15 @@
+<% module_namespacing do -%>
+class <%= class_name %>Query < ARQO::Query
+  module Scope
+    # Add <%= class_name %> scopes here
+  end
+<% if associated_relation -%>
+
+  private
+
+  def associated_relation
+    <%= associated_relation_class %> # you can also do something like <%= associated_relation_class %>.some_scope
+  end
+<% end -%>
+end
+<% end -%>

data/lib/generators/rspec/query_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../arqo/named_base'
+
+module Rspec
+  module Generators
+    class QueryGenerator < ARQO::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      def create_model_query_spec
+        template_file = File.join('spec/queries', class_path, "#{file_name}_query_spec.rb")
+        template 'query_spec.rb.erb', template_file
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/query_spec.rb.erb

@@ -0,0 +1,9 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Query do
+  subject(:query) { described_class.new }
+
+  pending 'add some query object tests here'
+end
+<% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arqo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Santiago Bartesaghi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: 6.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.6.0
+        version: 6.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 1.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.80.0
+        version: 1.24.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +138,7 @@ dependencies:
         version: 1.4.2
 description: 
 email:
-- sbartesaghi@hotmail.com
+- santib@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -139,13 +147,22 @@ files:
 - README.md
 - lib/arqo.rb
 - lib/arqo/query.rb
+- lib/arqo/railtie.rb
 - lib/arqo/version.rb
-homepage: https://github.com/santib/arqo
+- lib/generators/arqo/named_base.rb
+- lib/generators/model_generator.rb
+- lib/generators/rails/USAGE
+- lib/generators/rails/query_generator.rb
+- lib/generators/rails/templates/query.rb.erb
+- lib/generators/rspec/query_generator.rb
+- lib/generators/rspec/templates/query_spec.rb.erb
+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
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -154,15 +171,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Easing the query object pattern in Rails applications.